From 6281caec5b689071db08330ecc282bc59e6bdd64 Mon Sep 17 00:00:00 2001 From: "stainless-sdks[bot]" <167585319+stainless-sdks[bot]@users.noreply.github.com> Date: Sat, 16 Aug 2025 17:05:09 +0000 Subject: [PATCH 001/178] Initial commit --- README.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..098966eb --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# imagekit-ruby \ No newline at end of file From ce0f9cf846ce3f5cc76669bccce5d66ed64f0602 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 16 Aug 2025 17:05:51 +0000 Subject: [PATCH 002/178] chore: configure new SDK language --- .github/workflows/ci.yml | 48 + .gitignore | 10 + .rubocop.yml | 291 ++ .ruby-version | 1 + .solargraph.yml | 11 + .stats.yml | 4 + .yardopts | 6 + CONTRIBUTING.md | 125 + Gemfile | 33 + Gemfile.lock | 212 ++ LICENSE | 201 ++ README.md | 257 +- Rakefile | 160 + SECURITY.md | 27 + Steepfile | 15 + bin/publish-gem | 9 + examples/.keep | 4 + imagekit.gemspec | 28 + lib/imagekit.rb | 129 + lib/imagekit/client.rb | 108 + lib/imagekit/errors.rb | 214 ++ lib/imagekit/file_part.rb | 55 + lib/imagekit/internal.rb | 20 + .../internal/transport/base_client.rb | 563 ++++ .../transport/pooled_net_requester.rb | 209 ++ lib/imagekit/internal/type/array_of.rb | 168 ++ lib/imagekit/internal/type/base_model.rb | 538 ++++ lib/imagekit/internal/type/base_page.rb | 55 + lib/imagekit/internal/type/boolean.rb | 77 + lib/imagekit/internal/type/converter.rb | 327 ++ lib/imagekit/internal/type/enum.rb | 131 + lib/imagekit/internal/type/file_input.rb | 108 + lib/imagekit/internal/type/hash_of.rb | 188 ++ .../internal/type/request_parameters.rb | 42 + lib/imagekit/internal/type/union.rb | 237 ++ lib/imagekit/internal/type/unknown.rb | 81 + lib/imagekit/internal/util.rb | 914 ++++++ lib/imagekit/models.rb | 93 + .../models/account_get_usage_params.rb | 35 + .../models/account_get_usage_response.rb | 49 + .../models/bulk_job_copy_folder_params.rb | 44 + .../models/bulk_job_copy_folder_response.rb | 21 + .../models/bulk_job_move_folder_params.rb | 34 + .../models/bulk_job_move_folder_response.rb | 21 + .../models/bulk_job_retrieve_status_params.rb | 14 + .../bulk_job_retrieve_status_response.rb | 36 + .../custom_metadata_field_create_params.rb | 238 ++ .../custom_metadata_field_create_response.rb | 235 ++ .../custom_metadata_field_delete_params.rb | 14 + .../custom_metadata_field_delete_response.rb | 8 + .../custom_metadata_field_list_params.rb | 26 + .../custom_metadata_field_list_response.rb | 239 ++ .../custom_metadata_field_update_params.rb | 212 ++ .../custom_metadata_field_update_response.rb | 235 ++ lib/imagekit/models/exif_details.rb | 167 ++ lib/imagekit/models/exif_image.rb | 77 + lib/imagekit/models/file_add_tags_params.rb | 33 + lib/imagekit/models/file_add_tags_response.rb | 22 + lib/imagekit/models/file_copy_params.rb | 43 + lib/imagekit/models/file_copy_response.rb | 8 + lib/imagekit/models/file_delete_params.rb | 14 + lib/imagekit/models/file_list_params.rb | 130 + lib/imagekit/models/file_list_response.rb | 247 ++ lib/imagekit/models/file_move_params.rb | 33 + lib/imagekit/models/file_move_response.rb | 8 + .../models/file_remove_ai_tags_params.rb | 33 + .../models/file_remove_ai_tags_response.rb | 22 + .../models/file_remove_tags_params.rb | 33 + .../models/file_remove_tags_response.rb | 22 + lib/imagekit/models/file_rename_params.rb | 61 + lib/imagekit/models/file_rename_response.rb | 21 + lib/imagekit/models/file_upload_v1_params.rb | 384 +++ .../models/file_upload_v1_response.rb | 1706 +++++++++++ lib/imagekit/models/file_upload_v2_params.rb | 345 +++ .../models/file_upload_v2_response.rb | 1706 +++++++++++ .../models/files/batch_delete_params.rb | 27 + .../models/files/batch_delete_response.rb | 24 + .../models/files/detail_retrieve_params.rb | 16 + .../models/files/detail_retrieve_response.rb | 249 ++ .../models/files/detail_update_params.rb | 289 ++ .../models/files/detail_update_response.rb | 321 ++ .../models/files/metadata_from_url_params.rb | 28 + .../files/metadata_from_url_response.rb | 175 ++ .../models/files/metadata_retrieve_params.rb | 16 + .../files/metadata_retrieve_response.rb | 175 ++ .../models/files/purge_execute_params.rb | 27 + .../models/files/purge_execute_response.rb | 23 + .../models/files/purge_status_params.rb | 16 + .../models/files/purge_status_response.rb | 35 + .../models/files/version_delete_params.rb | 22 + .../models/files/version_delete_response.rb | 10 + .../models/files/version_list_params.rb | 16 + .../models/files/version_list_response.rb | 252 ++ .../models/files/version_restore_params.rb | 22 + .../models/files/version_restore_response.rb | 249 ++ .../models/files/version_retrieve_params.rb | 22 + .../models/files/version_retrieve_response.rb | 249 ++ lib/imagekit/models/folder_create_params.rb | 43 + lib/imagekit/models/folder_create_response.rb | 8 + lib/imagekit/models/folder_delete_params.rb | 25 + lib/imagekit/models/folder_delete_response.rb | 8 + lib/imagekit/models/gps.rb | 17 + lib/imagekit/models/interoperability.rb | 23 + lib/imagekit/models/thumbnail.rb | 47 + lib/imagekit/request_options.rb | 77 + lib/imagekit/resources/accounts.rb | 44 + lib/imagekit/resources/bulk_jobs.rb | 100 + .../resources/custom_metadata_fields.rb | 126 + lib/imagekit/resources/files.rb | 467 +++ lib/imagekit/resources/files/batch.rb | 47 + lib/imagekit/resources/files/details.rb | 81 + lib/imagekit/resources/files/metadata.rb | 69 + lib/imagekit/resources/files/purge.rb | 66 + lib/imagekit/resources/files/versions.rb | 132 + lib/imagekit/resources/folder.rb | 68 + lib/imagekit/version.rb | 5 + manifest.yaml | 15 + rbi/imagekit/client.rbi | 75 + rbi/imagekit/errors.rbi | 178 ++ rbi/imagekit/file_part.rbi | 37 + rbi/imagekit/internal.rbi | 16 + .../internal/transport/base_client.rbi | 293 ++ .../transport/pooled_net_requester.rbi | 79 + rbi/imagekit/internal/type/array_of.rbi | 104 + rbi/imagekit/internal/type/base_model.rbi | 302 ++ rbi/imagekit/internal/type/base_page.rbi | 42 + rbi/imagekit/internal/type/boolean.rbi | 58 + rbi/imagekit/internal/type/converter.rbi | 216 ++ rbi/imagekit/internal/type/enum.rbi | 82 + rbi/imagekit/internal/type/file_input.rbi | 59 + rbi/imagekit/internal/type/hash_of.rbi | 104 + .../internal/type/request_parameters.rbi | 29 + rbi/imagekit/internal/type/union.rbi | 128 + rbi/imagekit/internal/type/unknown.rbi | 58 + rbi/imagekit/internal/util.rbi | 487 +++ rbi/imagekit/models.rbi | 59 + .../models/account_get_usage_params.rbi | 55 + .../models/account_get_usage_response.rbi | 87 + .../models/bulk_job_copy_folder_params.rbi | 68 + .../models/bulk_job_copy_folder_response.rbi | 35 + .../models/bulk_job_move_folder_params.rbi | 53 + .../models/bulk_job_move_folder_response.rbi | 35 + .../bulk_job_retrieve_status_params.rbi | 30 + .../bulk_job_retrieve_status_response.rbi | 55 + .../custom_metadata_field_create_params.rbi | 443 +++ .../custom_metadata_field_create_response.rbi | 438 +++ .../custom_metadata_field_delete_params.rbi | 30 + .../custom_metadata_field_delete_response.rbi | 8 + .../custom_metadata_field_list_params.rbi | 51 + .../custom_metadata_field_list_response.rbi | 447 +++ .../custom_metadata_field_update_params.rbi | 376 +++ .../custom_metadata_field_update_response.rbi | 438 +++ rbi/imagekit/models/exif_details.rbi | 264 ++ rbi/imagekit/models/exif_image.rbi | 127 + rbi/imagekit/models/file_add_tags_params.rbi | 51 + .../models/file_add_tags_response.rbi | 39 + rbi/imagekit/models/file_copy_params.rbi | 66 + rbi/imagekit/models/file_copy_response.rbi | 7 + rbi/imagekit/models/file_delete_params.rbi | 27 + rbi/imagekit/models/file_list_params.rbi | 219 ++ rbi/imagekit/models/file_list_response.rbi | 387 +++ rbi/imagekit/models/file_move_params.rbi | 51 + rbi/imagekit/models/file_move_response.rbi | 7 + .../models/file_remove_ai_tags_params.rbi | 51 + .../models/file_remove_ai_tags_response.rbi | 39 + .../models/file_remove_tags_params.rbi | 51 + .../models/file_remove_tags_response.rbi | 39 + rbi/imagekit/models/file_rename_params.rbi | 102 + rbi/imagekit/models/file_rename_response.rbi | 35 + rbi/imagekit/models/file_upload_v1_params.rbi | 722 +++++ .../models/file_upload_v1_response.rbi | 2625 +++++++++++++++++ rbi/imagekit/models/file_upload_v2_params.rbi | 659 +++++ .../models/file_upload_v2_response.rbi | 2625 +++++++++++++++++ .../models/files/batch_delete_params.rbi | 48 + .../models/files/batch_delete_response.rbi | 41 + .../models/files/detail_retrieve_params.rbi | 32 + .../models/files/detail_retrieve_response.rbi | 394 +++ .../models/files/detail_update_params.rbi | 583 ++++ .../models/files/detail_update_response.rbi | 623 ++++ .../models/files/metadata_from_url_params.rbi | 47 + .../files/metadata_from_url_response.rbi | 289 ++ .../models/files/metadata_retrieve_params.rbi | 32 + .../files/metadata_retrieve_response.rbi | 290 ++ .../models/files/purge_execute_params.rbi | 45 + .../models/files/purge_execute_response.rbi | 37 + .../models/files/purge_status_params.rbi | 32 + .../models/files/purge_status_response.rbi | 93 + .../models/files/version_delete_params.rbi | 40 + .../models/files/version_delete_response.rbi | 10 + .../models/files/version_list_params.rbi | 32 + .../models/files/version_list_response.rbi | 402 +++ .../models/files/version_restore_params.rbi | 40 + .../models/files/version_restore_response.rbi | 394 +++ .../models/files/version_retrieve_params.rbi | 40 + .../files/version_retrieve_response.rbi | 394 +++ rbi/imagekit/models/folder_create_params.rbi | 71 + .../models/folder_create_response.rbi | 8 + rbi/imagekit/models/folder_delete_params.rbi | 40 + .../models/folder_delete_response.rbi | 8 + rbi/imagekit/models/gps.rbi | 27 + rbi/imagekit/models/interoperability.rbi | 39 + rbi/imagekit/models/thumbnail.rbi | 82 + rbi/imagekit/request_options.rbi | 59 + rbi/imagekit/resources/accounts.rbi | 34 + rbi/imagekit/resources/bulk_jobs.rbi | 75 + .../resources/custom_metadata_fields.rbi | 98 + rbi/imagekit/resources/files.rbi | 647 ++++ rbi/imagekit/resources/files/batch.rbi | 34 + rbi/imagekit/resources/files/details.rbi | 93 + rbi/imagekit/resources/files/metadata.rbi | 49 + rbi/imagekit/resources/files/purge.rbi | 44 + rbi/imagekit/resources/files/versions.rbi | 89 + rbi/imagekit/resources/folder.rbi | 55 + rbi/imagekit/version.rbi | 5 + scripts/bootstrap | 16 + scripts/format | 9 + scripts/lint | 9 + scripts/mock | 41 + scripts/test | 56 + sig/imagekit/client.rbs | 39 + sig/imagekit/errors.rbs | 110 + sig/imagekit/file_part.rbs | 21 + sig/imagekit/internal.rbs | 9 + .../internal/transport/base_client.rbs | 131 + .../transport/pooled_net_requester.rbs | 45 + sig/imagekit/internal/type/array_of.rbs | 48 + sig/imagekit/internal/type/base_model.rbs | 102 + sig/imagekit/internal/type/base_page.rbs | 24 + sig/imagekit/internal/type/boolean.rbs | 26 + sig/imagekit/internal/type/converter.rbs | 79 + sig/imagekit/internal/type/enum.rbs | 32 + sig/imagekit/internal/type/file_input.rbs | 25 + sig/imagekit/internal/type/hash_of.rbs | 48 + .../internal/type/request_parameters.rbs | 17 + sig/imagekit/internal/type/union.rbs | 52 + sig/imagekit/internal/type/unknown.rbs | 26 + sig/imagekit/internal/util.rbs | 185 ++ sig/imagekit/models.rbs | 53 + .../models/account_get_usage_params.rbs | 28 + .../models/account_get_usage_response.rbs | 50 + .../models/bulk_job_copy_folder_params.rbs | 38 + .../models/bulk_job_copy_folder_response.rbs | 15 + .../models/bulk_job_move_folder_params.rbs | 28 + .../models/bulk_job_move_folder_response.rbs | 15 + .../bulk_job_retrieve_status_params.rbs | 15 + .../bulk_job_retrieve_status_response.rbs | 24 + .../custom_metadata_field_create_params.rbs | 179 ++ .../custom_metadata_field_create_response.rbs | 178 ++ .../custom_metadata_field_delete_params.rbs | 15 + .../custom_metadata_field_delete_response.rbs | 5 + .../custom_metadata_field_list_params.rbs | 25 + .../custom_metadata_field_list_response.rbs | 183 ++ .../custom_metadata_field_update_params.rbs | 152 + .../custom_metadata_field_update_response.rbs | 178 ++ sig/imagekit/models/exif_details.rbs | 197 ++ sig/imagekit/models/exif_image.rbs | 92 + sig/imagekit/models/file_add_tags_params.rbs | 28 + .../models/file_add_tags_response.rbs | 16 + sig/imagekit/models/file_copy_params.rbs | 38 + sig/imagekit/models/file_copy_response.rbs | 5 + sig/imagekit/models/file_delete_params.rbs | 15 + sig/imagekit/models/file_list_params.rbs | 85 + sig/imagekit/models/file_list_response.rbs | 202 ++ sig/imagekit/models/file_move_params.rbs | 28 + sig/imagekit/models/file_move_response.rbs | 5 + .../models/file_remove_ai_tags_params.rbs | 28 + .../models/file_remove_ai_tags_response.rbs | 16 + .../models/file_remove_tags_params.rbs | 28 + .../models/file_remove_tags_response.rbs | 16 + sig/imagekit/models/file_rename_params.rbs | 34 + sig/imagekit/models/file_rename_response.rbs | 15 + sig/imagekit/models/file_upload_v1_params.rbs | 249 ++ .../models/file_upload_v1_response.rbs | 1741 +++++++++++ sig/imagekit/models/file_upload_v2_params.rbs | 228 ++ .../models/file_upload_v2_response.rbs | 1741 +++++++++++ .../models/files/batch_delete_params.rbs | 26 + .../models/files/batch_delete_response.rbs | 20 + .../models/files/detail_retrieve_params.rbs | 17 + .../models/files/detail_retrieve_response.rbs | 200 ++ .../models/files/detail_update_params.rbs | 227 ++ .../models/files/detail_update_response.rbs | 284 ++ .../models/files/metadata_from_url_params.rbs | 25 + .../files/metadata_from_url_response.rbs | 173 ++ .../models/files/metadata_retrieve_params.rbs | 17 + .../files/metadata_retrieve_response.rbs | 173 ++ .../models/files/purge_execute_params.rbs | 25 + .../models/files/purge_execute_response.rbs | 17 + .../models/files/purge_status_params.rbs | 17 + .../models/files/purge_status_response.rbs | 35 + .../models/files/version_delete_params.rbs | 25 + .../models/files/version_delete_response.rbs | 7 + .../models/files/version_list_params.rbs | 17 + .../models/files/version_list_response.rbs | 205 ++ .../models/files/version_restore_params.rbs | 25 + .../models/files/version_restore_response.rbs | 200 ++ .../models/files/version_retrieve_params.rbs | 25 + .../files/version_retrieve_response.rbs | 200 ++ sig/imagekit/models/folder_create_params.rbs | 28 + .../models/folder_create_response.rbs | 5 + sig/imagekit/models/folder_delete_params.rbs | 23 + .../models/folder_delete_response.rbs | 5 + sig/imagekit/models/gps.rbs | 15 + sig/imagekit/models/interoperability.rbs | 19 + sig/imagekit/models/thumbnail.rbs | 57 + sig/imagekit/request_options.rbs | 34 + sig/imagekit/resources/accounts.rbs | 13 + sig/imagekit/resources/bulk_jobs.rbs | 25 + .../resources/custom_metadata_fields.rbs | 28 + sig/imagekit/resources/files.rbs | 120 + sig/imagekit/resources/files/batch.rbs | 14 + sig/imagekit/resources/files/details.rbs | 26 + sig/imagekit/resources/files/metadata.rbs | 19 + sig/imagekit/resources/files/purge.rbs | 19 + sig/imagekit/resources/files/versions.rbs | 32 + sig/imagekit/resources/folder.rbs | 18 + sig/imagekit/version.rbs | 3 + sorbet/config | 2 + sorbet/rbi/.gitignore | 2 + test/imagekit/client_test.rb | 426 +++ test/imagekit/file_part_test.rb | 13 + .../internal/sorbet_runtime_support_test.rb | 52 + .../imagekit/internal/type/base_model_test.rb | 721 +++++ test/imagekit/internal/util_test.rb | 598 ++++ test/imagekit/resource_namespaces.rb | 10 + test/imagekit/resources/accounts_test.rb | 25 + test/imagekit/resources/bulk_jobs_test.rb | 63 + .../resources/custom_metadata_fields_test.rb | 64 + test/imagekit/resources/files/batch_test.rb | 22 + test/imagekit/resources/files/details_test.rb | 78 + .../imagekit/resources/files/metadata_test.rb | 63 + test/imagekit/resources/files/purge_test.rb | 38 + .../imagekit/resources/files/versions_test.rb | 97 + test/imagekit/resources/files_test.rb | 207 ++ test/imagekit/resources/folder_test.rb | 25 + test/imagekit/test_helper.rb | 91 + 335 files changed, 46946 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 .rubocop.yml create mode 100644 .ruby-version create mode 100644 .solargraph.yml create mode 100644 .stats.yml create mode 100644 .yardopts create mode 100644 CONTRIBUTING.md create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 LICENSE create mode 100644 Rakefile create mode 100644 SECURITY.md create mode 100644 Steepfile create mode 100644 bin/publish-gem create mode 100644 examples/.keep create mode 100644 imagekit.gemspec create mode 100644 lib/imagekit.rb create mode 100644 lib/imagekit/client.rb create mode 100644 lib/imagekit/errors.rb create mode 100644 lib/imagekit/file_part.rb create mode 100644 lib/imagekit/internal.rb create mode 100644 lib/imagekit/internal/transport/base_client.rb create mode 100644 lib/imagekit/internal/transport/pooled_net_requester.rb create mode 100644 lib/imagekit/internal/type/array_of.rb create mode 100644 lib/imagekit/internal/type/base_model.rb create mode 100644 lib/imagekit/internal/type/base_page.rb create mode 100644 lib/imagekit/internal/type/boolean.rb create mode 100644 lib/imagekit/internal/type/converter.rb create mode 100644 lib/imagekit/internal/type/enum.rb create mode 100644 lib/imagekit/internal/type/file_input.rb create mode 100644 lib/imagekit/internal/type/hash_of.rb create mode 100644 lib/imagekit/internal/type/request_parameters.rb create mode 100644 lib/imagekit/internal/type/union.rb create mode 100644 lib/imagekit/internal/type/unknown.rb create mode 100644 lib/imagekit/internal/util.rb create mode 100644 lib/imagekit/models.rb create mode 100644 lib/imagekit/models/account_get_usage_params.rb create mode 100644 lib/imagekit/models/account_get_usage_response.rb create mode 100644 lib/imagekit/models/bulk_job_copy_folder_params.rb create mode 100644 lib/imagekit/models/bulk_job_copy_folder_response.rb create mode 100644 lib/imagekit/models/bulk_job_move_folder_params.rb create mode 100644 lib/imagekit/models/bulk_job_move_folder_response.rb create mode 100644 lib/imagekit/models/bulk_job_retrieve_status_params.rb create mode 100644 lib/imagekit/models/bulk_job_retrieve_status_response.rb create mode 100644 lib/imagekit/models/custom_metadata_field_create_params.rb create mode 100644 lib/imagekit/models/custom_metadata_field_create_response.rb create mode 100644 lib/imagekit/models/custom_metadata_field_delete_params.rb create mode 100644 lib/imagekit/models/custom_metadata_field_delete_response.rb create mode 100644 lib/imagekit/models/custom_metadata_field_list_params.rb create mode 100644 lib/imagekit/models/custom_metadata_field_list_response.rb create mode 100644 lib/imagekit/models/custom_metadata_field_update_params.rb create mode 100644 lib/imagekit/models/custom_metadata_field_update_response.rb create mode 100644 lib/imagekit/models/exif_details.rb create mode 100644 lib/imagekit/models/exif_image.rb create mode 100644 lib/imagekit/models/file_add_tags_params.rb create mode 100644 lib/imagekit/models/file_add_tags_response.rb create mode 100644 lib/imagekit/models/file_copy_params.rb create mode 100644 lib/imagekit/models/file_copy_response.rb create mode 100644 lib/imagekit/models/file_delete_params.rb create mode 100644 lib/imagekit/models/file_list_params.rb create mode 100644 lib/imagekit/models/file_list_response.rb create mode 100644 lib/imagekit/models/file_move_params.rb create mode 100644 lib/imagekit/models/file_move_response.rb create mode 100644 lib/imagekit/models/file_remove_ai_tags_params.rb create mode 100644 lib/imagekit/models/file_remove_ai_tags_response.rb create mode 100644 lib/imagekit/models/file_remove_tags_params.rb create mode 100644 lib/imagekit/models/file_remove_tags_response.rb create mode 100644 lib/imagekit/models/file_rename_params.rb create mode 100644 lib/imagekit/models/file_rename_response.rb create mode 100644 lib/imagekit/models/file_upload_v1_params.rb create mode 100644 lib/imagekit/models/file_upload_v1_response.rb create mode 100644 lib/imagekit/models/file_upload_v2_params.rb create mode 100644 lib/imagekit/models/file_upload_v2_response.rb create mode 100644 lib/imagekit/models/files/batch_delete_params.rb create mode 100644 lib/imagekit/models/files/batch_delete_response.rb create mode 100644 lib/imagekit/models/files/detail_retrieve_params.rb create mode 100644 lib/imagekit/models/files/detail_retrieve_response.rb create mode 100644 lib/imagekit/models/files/detail_update_params.rb create mode 100644 lib/imagekit/models/files/detail_update_response.rb create mode 100644 lib/imagekit/models/files/metadata_from_url_params.rb create mode 100644 lib/imagekit/models/files/metadata_from_url_response.rb create mode 100644 lib/imagekit/models/files/metadata_retrieve_params.rb create mode 100644 lib/imagekit/models/files/metadata_retrieve_response.rb create mode 100644 lib/imagekit/models/files/purge_execute_params.rb create mode 100644 lib/imagekit/models/files/purge_execute_response.rb create mode 100644 lib/imagekit/models/files/purge_status_params.rb create mode 100644 lib/imagekit/models/files/purge_status_response.rb create mode 100644 lib/imagekit/models/files/version_delete_params.rb create mode 100644 lib/imagekit/models/files/version_delete_response.rb create mode 100644 lib/imagekit/models/files/version_list_params.rb create mode 100644 lib/imagekit/models/files/version_list_response.rb create mode 100644 lib/imagekit/models/files/version_restore_params.rb create mode 100644 lib/imagekit/models/files/version_restore_response.rb create mode 100644 lib/imagekit/models/files/version_retrieve_params.rb create mode 100644 lib/imagekit/models/files/version_retrieve_response.rb create mode 100644 lib/imagekit/models/folder_create_params.rb create mode 100644 lib/imagekit/models/folder_create_response.rb create mode 100644 lib/imagekit/models/folder_delete_params.rb create mode 100644 lib/imagekit/models/folder_delete_response.rb create mode 100644 lib/imagekit/models/gps.rb create mode 100644 lib/imagekit/models/interoperability.rb create mode 100644 lib/imagekit/models/thumbnail.rb create mode 100644 lib/imagekit/request_options.rb create mode 100644 lib/imagekit/resources/accounts.rb create mode 100644 lib/imagekit/resources/bulk_jobs.rb create mode 100644 lib/imagekit/resources/custom_metadata_fields.rb create mode 100644 lib/imagekit/resources/files.rb create mode 100644 lib/imagekit/resources/files/batch.rb create mode 100644 lib/imagekit/resources/files/details.rb create mode 100644 lib/imagekit/resources/files/metadata.rb create mode 100644 lib/imagekit/resources/files/purge.rb create mode 100644 lib/imagekit/resources/files/versions.rb create mode 100644 lib/imagekit/resources/folder.rb create mode 100644 lib/imagekit/version.rb create mode 100644 manifest.yaml create mode 100644 rbi/imagekit/client.rbi create mode 100644 rbi/imagekit/errors.rbi create mode 100644 rbi/imagekit/file_part.rbi create mode 100644 rbi/imagekit/internal.rbi create mode 100644 rbi/imagekit/internal/transport/base_client.rbi create mode 100644 rbi/imagekit/internal/transport/pooled_net_requester.rbi create mode 100644 rbi/imagekit/internal/type/array_of.rbi create mode 100644 rbi/imagekit/internal/type/base_model.rbi create mode 100644 rbi/imagekit/internal/type/base_page.rbi create mode 100644 rbi/imagekit/internal/type/boolean.rbi create mode 100644 rbi/imagekit/internal/type/converter.rbi create mode 100644 rbi/imagekit/internal/type/enum.rbi create mode 100644 rbi/imagekit/internal/type/file_input.rbi create mode 100644 rbi/imagekit/internal/type/hash_of.rbi create mode 100644 rbi/imagekit/internal/type/request_parameters.rbi create mode 100644 rbi/imagekit/internal/type/union.rbi create mode 100644 rbi/imagekit/internal/type/unknown.rbi create mode 100644 rbi/imagekit/internal/util.rbi create mode 100644 rbi/imagekit/models.rbi create mode 100644 rbi/imagekit/models/account_get_usage_params.rbi create mode 100644 rbi/imagekit/models/account_get_usage_response.rbi create mode 100644 rbi/imagekit/models/bulk_job_copy_folder_params.rbi create mode 100644 rbi/imagekit/models/bulk_job_copy_folder_response.rbi create mode 100644 rbi/imagekit/models/bulk_job_move_folder_params.rbi create mode 100644 rbi/imagekit/models/bulk_job_move_folder_response.rbi create mode 100644 rbi/imagekit/models/bulk_job_retrieve_status_params.rbi create mode 100644 rbi/imagekit/models/bulk_job_retrieve_status_response.rbi create mode 100644 rbi/imagekit/models/custom_metadata_field_create_params.rbi create mode 100644 rbi/imagekit/models/custom_metadata_field_create_response.rbi create mode 100644 rbi/imagekit/models/custom_metadata_field_delete_params.rbi create mode 100644 rbi/imagekit/models/custom_metadata_field_delete_response.rbi create mode 100644 rbi/imagekit/models/custom_metadata_field_list_params.rbi create mode 100644 rbi/imagekit/models/custom_metadata_field_list_response.rbi create mode 100644 rbi/imagekit/models/custom_metadata_field_update_params.rbi create mode 100644 rbi/imagekit/models/custom_metadata_field_update_response.rbi create mode 100644 rbi/imagekit/models/exif_details.rbi create mode 100644 rbi/imagekit/models/exif_image.rbi create mode 100644 rbi/imagekit/models/file_add_tags_params.rbi create mode 100644 rbi/imagekit/models/file_add_tags_response.rbi create mode 100644 rbi/imagekit/models/file_copy_params.rbi create mode 100644 rbi/imagekit/models/file_copy_response.rbi create mode 100644 rbi/imagekit/models/file_delete_params.rbi create mode 100644 rbi/imagekit/models/file_list_params.rbi create mode 100644 rbi/imagekit/models/file_list_response.rbi create mode 100644 rbi/imagekit/models/file_move_params.rbi create mode 100644 rbi/imagekit/models/file_move_response.rbi create mode 100644 rbi/imagekit/models/file_remove_ai_tags_params.rbi create mode 100644 rbi/imagekit/models/file_remove_ai_tags_response.rbi create mode 100644 rbi/imagekit/models/file_remove_tags_params.rbi create mode 100644 rbi/imagekit/models/file_remove_tags_response.rbi create mode 100644 rbi/imagekit/models/file_rename_params.rbi create mode 100644 rbi/imagekit/models/file_rename_response.rbi create mode 100644 rbi/imagekit/models/file_upload_v1_params.rbi create mode 100644 rbi/imagekit/models/file_upload_v1_response.rbi create mode 100644 rbi/imagekit/models/file_upload_v2_params.rbi create mode 100644 rbi/imagekit/models/file_upload_v2_response.rbi create mode 100644 rbi/imagekit/models/files/batch_delete_params.rbi create mode 100644 rbi/imagekit/models/files/batch_delete_response.rbi create mode 100644 rbi/imagekit/models/files/detail_retrieve_params.rbi create mode 100644 rbi/imagekit/models/files/detail_retrieve_response.rbi create mode 100644 rbi/imagekit/models/files/detail_update_params.rbi create mode 100644 rbi/imagekit/models/files/detail_update_response.rbi create mode 100644 rbi/imagekit/models/files/metadata_from_url_params.rbi create mode 100644 rbi/imagekit/models/files/metadata_from_url_response.rbi create mode 100644 rbi/imagekit/models/files/metadata_retrieve_params.rbi create mode 100644 rbi/imagekit/models/files/metadata_retrieve_response.rbi create mode 100644 rbi/imagekit/models/files/purge_execute_params.rbi create mode 100644 rbi/imagekit/models/files/purge_execute_response.rbi create mode 100644 rbi/imagekit/models/files/purge_status_params.rbi create mode 100644 rbi/imagekit/models/files/purge_status_response.rbi create mode 100644 rbi/imagekit/models/files/version_delete_params.rbi create mode 100644 rbi/imagekit/models/files/version_delete_response.rbi create mode 100644 rbi/imagekit/models/files/version_list_params.rbi create mode 100644 rbi/imagekit/models/files/version_list_response.rbi create mode 100644 rbi/imagekit/models/files/version_restore_params.rbi create mode 100644 rbi/imagekit/models/files/version_restore_response.rbi create mode 100644 rbi/imagekit/models/files/version_retrieve_params.rbi create mode 100644 rbi/imagekit/models/files/version_retrieve_response.rbi create mode 100644 rbi/imagekit/models/folder_create_params.rbi create mode 100644 rbi/imagekit/models/folder_create_response.rbi create mode 100644 rbi/imagekit/models/folder_delete_params.rbi create mode 100644 rbi/imagekit/models/folder_delete_response.rbi create mode 100644 rbi/imagekit/models/gps.rbi create mode 100644 rbi/imagekit/models/interoperability.rbi create mode 100644 rbi/imagekit/models/thumbnail.rbi create mode 100644 rbi/imagekit/request_options.rbi create mode 100644 rbi/imagekit/resources/accounts.rbi create mode 100644 rbi/imagekit/resources/bulk_jobs.rbi create mode 100644 rbi/imagekit/resources/custom_metadata_fields.rbi create mode 100644 rbi/imagekit/resources/files.rbi create mode 100644 rbi/imagekit/resources/files/batch.rbi create mode 100644 rbi/imagekit/resources/files/details.rbi create mode 100644 rbi/imagekit/resources/files/metadata.rbi create mode 100644 rbi/imagekit/resources/files/purge.rbi create mode 100644 rbi/imagekit/resources/files/versions.rbi create mode 100644 rbi/imagekit/resources/folder.rbi create mode 100644 rbi/imagekit/version.rbi create mode 100755 scripts/bootstrap create mode 100755 scripts/format create mode 100755 scripts/lint create mode 100755 scripts/mock create mode 100755 scripts/test create mode 100644 sig/imagekit/client.rbs create mode 100644 sig/imagekit/errors.rbs create mode 100644 sig/imagekit/file_part.rbs create mode 100644 sig/imagekit/internal.rbs create mode 100644 sig/imagekit/internal/transport/base_client.rbs create mode 100644 sig/imagekit/internal/transport/pooled_net_requester.rbs create mode 100644 sig/imagekit/internal/type/array_of.rbs create mode 100644 sig/imagekit/internal/type/base_model.rbs create mode 100644 sig/imagekit/internal/type/base_page.rbs create mode 100644 sig/imagekit/internal/type/boolean.rbs create mode 100644 sig/imagekit/internal/type/converter.rbs create mode 100644 sig/imagekit/internal/type/enum.rbs create mode 100644 sig/imagekit/internal/type/file_input.rbs create mode 100644 sig/imagekit/internal/type/hash_of.rbs create mode 100644 sig/imagekit/internal/type/request_parameters.rbs create mode 100644 sig/imagekit/internal/type/union.rbs create mode 100644 sig/imagekit/internal/type/unknown.rbs create mode 100644 sig/imagekit/internal/util.rbs create mode 100644 sig/imagekit/models.rbs create mode 100644 sig/imagekit/models/account_get_usage_params.rbs create mode 100644 sig/imagekit/models/account_get_usage_response.rbs create mode 100644 sig/imagekit/models/bulk_job_copy_folder_params.rbs create mode 100644 sig/imagekit/models/bulk_job_copy_folder_response.rbs create mode 100644 sig/imagekit/models/bulk_job_move_folder_params.rbs create mode 100644 sig/imagekit/models/bulk_job_move_folder_response.rbs create mode 100644 sig/imagekit/models/bulk_job_retrieve_status_params.rbs create mode 100644 sig/imagekit/models/bulk_job_retrieve_status_response.rbs create mode 100644 sig/imagekit/models/custom_metadata_field_create_params.rbs create mode 100644 sig/imagekit/models/custom_metadata_field_create_response.rbs create mode 100644 sig/imagekit/models/custom_metadata_field_delete_params.rbs create mode 100644 sig/imagekit/models/custom_metadata_field_delete_response.rbs create mode 100644 sig/imagekit/models/custom_metadata_field_list_params.rbs create mode 100644 sig/imagekit/models/custom_metadata_field_list_response.rbs create mode 100644 sig/imagekit/models/custom_metadata_field_update_params.rbs create mode 100644 sig/imagekit/models/custom_metadata_field_update_response.rbs create mode 100644 sig/imagekit/models/exif_details.rbs create mode 100644 sig/imagekit/models/exif_image.rbs create mode 100644 sig/imagekit/models/file_add_tags_params.rbs create mode 100644 sig/imagekit/models/file_add_tags_response.rbs create mode 100644 sig/imagekit/models/file_copy_params.rbs create mode 100644 sig/imagekit/models/file_copy_response.rbs create mode 100644 sig/imagekit/models/file_delete_params.rbs create mode 100644 sig/imagekit/models/file_list_params.rbs create mode 100644 sig/imagekit/models/file_list_response.rbs create mode 100644 sig/imagekit/models/file_move_params.rbs create mode 100644 sig/imagekit/models/file_move_response.rbs create mode 100644 sig/imagekit/models/file_remove_ai_tags_params.rbs create mode 100644 sig/imagekit/models/file_remove_ai_tags_response.rbs create mode 100644 sig/imagekit/models/file_remove_tags_params.rbs create mode 100644 sig/imagekit/models/file_remove_tags_response.rbs create mode 100644 sig/imagekit/models/file_rename_params.rbs create mode 100644 sig/imagekit/models/file_rename_response.rbs create mode 100644 sig/imagekit/models/file_upload_v1_params.rbs create mode 100644 sig/imagekit/models/file_upload_v1_response.rbs create mode 100644 sig/imagekit/models/file_upload_v2_params.rbs create mode 100644 sig/imagekit/models/file_upload_v2_response.rbs create mode 100644 sig/imagekit/models/files/batch_delete_params.rbs create mode 100644 sig/imagekit/models/files/batch_delete_response.rbs create mode 100644 sig/imagekit/models/files/detail_retrieve_params.rbs create mode 100644 sig/imagekit/models/files/detail_retrieve_response.rbs create mode 100644 sig/imagekit/models/files/detail_update_params.rbs create mode 100644 sig/imagekit/models/files/detail_update_response.rbs create mode 100644 sig/imagekit/models/files/metadata_from_url_params.rbs create mode 100644 sig/imagekit/models/files/metadata_from_url_response.rbs create mode 100644 sig/imagekit/models/files/metadata_retrieve_params.rbs create mode 100644 sig/imagekit/models/files/metadata_retrieve_response.rbs create mode 100644 sig/imagekit/models/files/purge_execute_params.rbs create mode 100644 sig/imagekit/models/files/purge_execute_response.rbs create mode 100644 sig/imagekit/models/files/purge_status_params.rbs create mode 100644 sig/imagekit/models/files/purge_status_response.rbs create mode 100644 sig/imagekit/models/files/version_delete_params.rbs create mode 100644 sig/imagekit/models/files/version_delete_response.rbs create mode 100644 sig/imagekit/models/files/version_list_params.rbs create mode 100644 sig/imagekit/models/files/version_list_response.rbs create mode 100644 sig/imagekit/models/files/version_restore_params.rbs create mode 100644 sig/imagekit/models/files/version_restore_response.rbs create mode 100644 sig/imagekit/models/files/version_retrieve_params.rbs create mode 100644 sig/imagekit/models/files/version_retrieve_response.rbs create mode 100644 sig/imagekit/models/folder_create_params.rbs create mode 100644 sig/imagekit/models/folder_create_response.rbs create mode 100644 sig/imagekit/models/folder_delete_params.rbs create mode 100644 sig/imagekit/models/folder_delete_response.rbs create mode 100644 sig/imagekit/models/gps.rbs create mode 100644 sig/imagekit/models/interoperability.rbs create mode 100644 sig/imagekit/models/thumbnail.rbs create mode 100644 sig/imagekit/request_options.rbs create mode 100644 sig/imagekit/resources/accounts.rbs create mode 100644 sig/imagekit/resources/bulk_jobs.rbs create mode 100644 sig/imagekit/resources/custom_metadata_fields.rbs create mode 100644 sig/imagekit/resources/files.rbs create mode 100644 sig/imagekit/resources/files/batch.rbs create mode 100644 sig/imagekit/resources/files/details.rbs create mode 100644 sig/imagekit/resources/files/metadata.rbs create mode 100644 sig/imagekit/resources/files/purge.rbs create mode 100644 sig/imagekit/resources/files/versions.rbs create mode 100644 sig/imagekit/resources/folder.rbs create mode 100644 sig/imagekit/version.rbs create mode 100644 sorbet/config create mode 100644 sorbet/rbi/.gitignore create mode 100644 test/imagekit/client_test.rb create mode 100644 test/imagekit/file_part_test.rb create mode 100644 test/imagekit/internal/sorbet_runtime_support_test.rb create mode 100644 test/imagekit/internal/type/base_model_test.rb create mode 100644 test/imagekit/internal/util_test.rb create mode 100644 test/imagekit/resource_namespaces.rb create mode 100644 test/imagekit/resources/accounts_test.rb create mode 100644 test/imagekit/resources/bulk_jobs_test.rb create mode 100644 test/imagekit/resources/custom_metadata_fields_test.rb create mode 100644 test/imagekit/resources/files/batch_test.rb create mode 100644 test/imagekit/resources/files/details_test.rb create mode 100644 test/imagekit/resources/files/metadata_test.rb create mode 100644 test/imagekit/resources/files/purge_test.rb create mode 100644 test/imagekit/resources/files/versions_test.rb create mode 100644 test/imagekit/resources/files_test.rb create mode 100644 test/imagekit/resources/folder_test.rb create mode 100644 test/imagekit/test_helper.rb diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..adb71c87 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,48 @@ +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-ruby' && '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 Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: false + - run: |- + bundle install + + - name: Run lints + run: ./scripts/lint + test: + timeout-minutes: 10 + name: test + runs-on: ${{ github.repository == 'stainless-sdks/imagekit-ruby' && '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 Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: false + - run: |- + bundle install + + - name: Run tests + run: ./scripts/test diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..3d26ceed --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +*.gem +.idea/ +.ignore +.prism.log +.ruby-lsp/ +.yardoc/ +bin/tapioca +Brewfile.lock.json +doc/ +sorbet/tapioca/* diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 00000000..14777052 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,291 @@ +--- +# Explicitly disable pending cops for now. This is the default behaviour but +# this avoids a large warning every time we run it. +# Stop RuboCop nagging about rubocop-rake. +# Ensure that RuboCop validates according to the lowest version of Ruby that we support. +AllCops: + Exclude: + - "bin/*" + NewCops: enable + SuggestExtensions: false + TargetRubyVersion: 3.2.0 + +# Whether MFA is required or not should be left to the token configuration. +Gemspec/RequireMFA: + Enabled: false + +# Don't require this extra line break, it can be excessive. +Layout/EmptyLineAfterGuardClause: + Enabled: false + +# Don't leave complex assignment values hanging off to the right. +Layout/EndAlignment: + EnforcedStyleAlignWith: variable + +Layout/FirstArrayElementLineBreak: + Enabled: true + +Layout/FirstHashElementLineBreak: + Enabled: true + +Layout/FirstMethodArgumentLineBreak: + Enabled: true + +Layout/FirstMethodParameterLineBreak: + Enabled: true + +# Set a reasonable line length; rely on other cops to correct long lines. +Layout/LineLength: + AllowedPatterns: + - "^\\s*#.*$" + - ^require(_relative)? + - "Imagekit::Internal::Type::BaseModel$" + - "^\\s*[A-Z0-9_]+ = :" + - "Imagekit::(Models|Resources|Test)::" + Max: 110 + +Layout/MultilineArrayLineBreaks: + Enabled: true + +# Start the assignment on the same line variable is mentioned. +Layout/MultilineAssignmentLayout: + EnforcedStyle: same_line + +Layout/MultilineHashKeyLineBreaks: + Enabled: true + +Layout/MultilineMethodArgumentLineBreaks: + Enabled: true + +Layout/MultilineMethodParameterLineBreaks: + Enabled: true + +# Prefer compact hash literals. +Layout/SpaceInsideHashLiteralBraces: + EnforcedStyle: no_space + Exclude: + - "**/*.rbi" + +Lint/BooleanSymbol: + Enabled: false + +# This option occasionally mangles identifier names +Lint/DeprecatedConstants: + Exclude: + - "**/*.rbi" + +# We use pattern assertion in tests to ensure correctness. +Lint/DuplicateMatchPattern: + Exclude: + - "test/**/*" + +# Fairly useful in tests for pattern assertions. +Lint/EmptyInPattern: + Exclude: + - "test/**/*" + +Lint/MissingCopEnableDirective: + Exclude: + - "examples/**/*.rb" + +Lint/MissingSuper: + Exclude: + - "**/*.rbi" + +Lint/SymbolConversion: + Exclude: + - "**/*.rbi" + +# Disabled for safety reasons, this option changes code semantics. +Lint/UnusedMethodArgument: + AutoCorrect: false + +# This option is prone to causing accidental bugs. +Lint/UselessAssignment: + AutoCorrect: false + Exclude: + - "examples/**/*.rb" + +Metrics/AbcSize: + Enabled: false + +Metrics/BlockLength: + AllowedPatterns: + - assert_pattern + - type_alias + - define_sorbet_constant! + Exclude: + - "**/*.rbi" + +Metrics/ClassLength: + Enabled: false + +Metrics/CyclomaticComplexity: + Enabled: false + +Metrics/MethodLength: + Enabled: false + +Metrics/ModuleLength: + Enabled: false + +Metrics/ParameterLists: + Enabled: false + +Metrics/PerceivedComplexity: + Enabled: false + +Naming/AccessorMethodName: + Enabled: false + +# Need to preserve block identifier for documentation. +Naming/BlockForwarding: + Enabled: false + +# Underscores are generally useful for disambiguation. +Naming/ClassAndModuleCamelCase: + Enabled: false + +Naming/MethodParameterName: + Enabled: false + +Naming/PredicateName: + Exclude: + - "**/*.rbi" + +Naming/VariableNumber: + Enabled: false + +# Nothing wrong with inline private methods. +Style/AccessModifierDeclarations: + Enabled: false + +Style/AccessorGrouping: + Exclude: + - "**/*.rbi" + +# Behaviour of alias_method is more predictable. +Style/Alias: + EnforcedStyle: prefer_alias_method + +# And/or have confusing precedence, avoid them. +Style/AndOr: + EnforcedStyle: always + +Style/ArgumentsForwarding: + Enabled: false + +Style/BisectedAttrAccessor: + Exclude: + - "**/*.rbi" + +# We prefer nested modules in lib/, but are currently using compact style for tests. +Style/ClassAndModuleChildren: + Exclude: + - "test/**/*" + +Style/CommentAnnotation: + Enabled: false + +# We should go back and add these docs, but ignore for now. +Style/Documentation: + Enabled: false + +# Allow explicit empty elses, for clarity. +Style/EmptyElse: + Enabled: false + +Style/EmptyMethod: + Exclude: + - "**/*.rbi" + +# We commonly use ENV['KEY'], it's OK. +Style/FetchEnvVar: + Enabled: false + +# Just to be safe, ensure nobody is mutating our internal strings. +Style/FrozenStringLiteralComment: + EnforcedStyle: always + Exclude: + - "**/*.rbi" + +# Nothing wrong with clear if statements. +Style/IfUnlessModifier: + Enabled: false + +# Rubocop is pretty bad about mangling single line lambdas. +Style/Lambda: + Enabled: false + +# Prefer consistency in method calling syntax. +Style/MethodCallWithArgsParentheses: + AllowedMethods: + - raise + Enabled: true + Exclude: + - "**/*.gemspec" + +Style/MultilineBlockChain: + Enabled: false + +# Perfectly fine. +Style/MultipleComparison: + Enabled: false + +Style/MutableConstant: + Exclude: + - "**/*.rbi" + +# Not all parameters should be named. +Style/NumberedParameters: + Enabled: false + +Style/NumberedParametersLimit: + Max: 2 + +# Reasonable to use brackets for errors with long messages. +Style/RaiseArgs: + Enabled: false + +# Be explicit about `RuntimeError`s. +Style/RedundantException: + Enabled: false + +Style/RedundantInitialize: + Exclude: + - "**/*.rbi" + +Style/RedundantParentheses: + Exclude: + - "**/*.rbi" + +# Prefer slashes for regex literals. +Style/RegexpLiteral: + EnforcedStyle: slashes + +# Allow explicit ifs, especially for imperative use. +Style/SafeNavigation: + Enabled: false + +Style/SignalException: + Exclude: + - Rakefile + - "**/*.rake" + +# We use these sparingly, where we anticipate future branches for the +# inner conditional. +Style/SoleNestedConditional: + Enabled: false + +# Prefer double quotes so that interpolation can be easily added. +Style/StringLiterals: + EnforcedStyle: double_quotes + +# Prefer explicit symbols for clarity; you can search for `:the_symbol`. +Style/SymbolArray: + EnforcedStyle: brackets + +# This option makes examples harder to read for ruby novices. +Style/SymbolProc: + Exclude: + - "examples/**/*.rb" diff --git a/.ruby-version b/.ruby-version new file mode 100644 index 00000000..944880fa --- /dev/null +++ b/.ruby-version @@ -0,0 +1 @@ +3.2.0 diff --git a/.solargraph.yml b/.solargraph.yml new file mode 100644 index 00000000..b100d90f --- /dev/null +++ b/.solargraph.yml @@ -0,0 +1,11 @@ +--- +max_files: 0 +include: + - '*.gemspec' + - 'Rakefile' + - 'examples/**/*.rb' + - 'lib/**/*.rb' + - 'test/imagekit/resource_namespaces.rb' + - 'test/imagekit/test_helper.rb' +exclude: + - 'rbi/**/*' diff --git a/.stats.yml b/.stats.yml new file mode 100644 index 00000000..eed320bb --- /dev/null +++ b/.stats.yml @@ -0,0 +1,4 @@ +configured_endpoints: 31 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0ffd73f83f6d2c3ad75d943fab8f4511847a7b1f8db10fb26a08f075ec814cc9.yml +openapi_spec_hash: afa5d5b601dc01949e9b9acff127ae0d +config_hash: a1e8435842b619cd75c7718d86640d26 diff --git a/.yardopts b/.yardopts new file mode 100644 index 00000000..84c12f2a --- /dev/null +++ b/.yardopts @@ -0,0 +1,6 @@ +--type-name-tag generic:Generic +--default-return void +--markup markdown +--markup-provider redcarpet +--exclude /rbi +--exclude /sig diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ff57412c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,125 @@ +## Setting up the environment + +This repository contains a `.ruby-version` file, which should work with either [rbenv](https://github.com/rbenv/rbenv) or [asdf](https://github.com/asdf-vm/asdf) with the [ruby plugin](https://github.com/asdf-vm/asdf-ruby). + +Please follow the instructions for your preferred version manager to install the Ruby version specified in the `.ruby-version` file. + +To set up the repository, run: + +```bash +$ ./scripts/bootstrap +``` + +This will install all the required dependencies. + +## Modifying/Adding code + +Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of `lib/imagekit/helpers/` and `examples/` directory. + +## Adding and running examples + +All files in the `examples/` directory are not modified by the generator and can be freely edited or added to. + +```ruby +#!/usr/bin/env ruby +# frozen_string_literal: true + +require_relative "../lib/imagekit" + +# ... +``` + +```bash +$ chmod +x './examples/.rb' + +# run the example against your api +$ ruby './examples/.rb' +``` + +## Using the repository from source + +If you’d like to use the repository from source, you can either install from git or reference a cloned repository: + +To install via git in your `Gemfile`: + +```ruby +gem "imagekit", git: "https://www.github.com/stainless-sdks/imagekit-ruby" +``` + +Alternatively, reference local copy of the repo: + +```bash +$ git clone -- 'https://www.github.com/stainless-sdks/imagekit-ruby' '' +``` + +```ruby +gem "imagekit", path: "" +``` + +## Running commands + +Running `rake` by itself will show all runnable commands. + +```bash +$ bundle exec rake +``` + +## Running tests + +Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests. + +```bash +$ npx prism mock path/to/your/openapi.yml +``` + +```bash +$ bundle exec rake test +``` + +## Linting and formatting + +This repository uses [rubocop](https://github.com/rubocop/rubocop) for linting and formatting of `*.rb` files; And [syntax_tree](https://github.com/ruby-syntax-tree/syntax_tree) is used for formatting of both `*.rbi` and `*.rbs` files. + +There are two separate type checkers supported by this library: [sorbet](https://github.com/sorbet/sorbet) and [steep](https://github.com/soutaro/steep) are used for verifying `*.rbi` and `*.rbs` files respectively. + +To lint and typecheck: + +```bash +$ bundle exec rake lint +``` + +To format and fix all lint issues automatically: + +```bash +$ bundle exec rake format +``` + +## Editor Support + +### Ruby LSP + +[Ruby LSP](https://github.com/Shopify/ruby-lsp) has quite good support for go to definition, but not auto-completion. + +This can be installed along side Solargraph. + +### Solargraph + +[Solargraph](https://solargraph.org) has quite good support for auto-completion, but not go to definition. + +This can be installed along side Ruby LSP. + +### Sorbet + +[Sorbet](https://sorbet.org) should mostly work out of the box when editing this library directly. However, there are a some caveats due to the colocation of `*.rb` and `*.rbi` files in the same project. These issues should not otherwise manifest when this library is used as a dependency. + +1. For go to definition usages, sorbet might get confused and may not always navigate to the correct location. + +2. For each generic type in `*.rbi` files, a spurious "Duplicate type member" error is present. + +## Documentation Preview + +To preview the documentation, run: + +```bash +$ bundle exec rake docs:preview [PORT=8808] +``` diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..0d76364b --- /dev/null +++ b/Gemfile @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +source "https://rubygems.org" + +gemspec + +group :development do + gem "rake" + gem "rbs" + gem "rubocop" + gem "sorbet" + gem "steep" + gem "syntax_tree" + # TODO: using a fork for now, the prettier below has a bug + gem "syntax_tree-rbs", github: "stainless-api/syntax_tree-rbs", branch: "main" + gem "tapioca" +end + +group :development, :test do + gem "async" + gem "minitest" + gem "minitest-focus" + gem "minitest-hooks" + gem "minitest-proveit" + gem "minitest-rg" + gem "webmock" +end + +group :development, :docs do + gem "redcarpet" + gem "webrick" + gem "yard" +end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 00000000..67bdf1d8 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,212 @@ +GIT + remote: https://github.com/stainless-api/syntax_tree-rbs.git + revision: c30b50219918be7cfe3ef803a00b59d1e77fcada + branch: main + specs: + syntax_tree-rbs (1.0.0) + prettier_print + rbs + syntax_tree (>= 2.0.1) + +PATH + remote: . + specs: + imagekit (0.0.1) + connection_pool + +GEM + remote: https://rubygems.org/ + specs: + activesupport (8.0.2) + base64 + benchmark (>= 0.3) + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb + i18n (>= 1.6, < 2) + logger (>= 1.4.2) + minitest (>= 5.1) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + uri (>= 0.13.1) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + ast (2.4.3) + async (2.24.0) + console (~> 1.29) + fiber-annotation + io-event (~> 1.9) + metrics (~> 0.12) + traces (~> 0.15) + base64 (0.2.0) + benchmark (0.4.0) + bigdecimal (3.1.9) + concurrent-ruby (1.3.5) + connection_pool (2.5.3) + console (1.30.2) + fiber-annotation + fiber-local (~> 1.1) + json + crack (1.0.0) + bigdecimal + rexml + csv (3.3.4) + drb (2.2.1) + erubi (1.13.1) + ffi (1.17.2-x86_64-linux-gnu) + fiber-annotation (0.2.0) + fiber-local (1.1.0) + fiber-storage + fiber-storage (1.0.1) + fileutils (1.7.3) + hashdiff (1.1.2) + i18n (1.14.7) + concurrent-ruby (~> 1.0) + io-event (1.10.0) + json (2.11.3) + language_server-protocol (3.17.0.4) + lint_roller (1.1.0) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + logger (1.7.0) + metrics (0.12.2) + minitest (5.25.5) + minitest-focus (1.4.0) + minitest (>= 4, < 6) + minitest-hooks (1.5.2) + minitest (> 5.3) + minitest-proveit (1.0.0) + minitest (> 5, < 7) + minitest-rg (5.3.0) + minitest (~> 5.0) + mutex_m (0.3.0) + netrc (0.11.0) + parallel (1.27.0) + parser (3.3.8.0) + ast (~> 2.4.1) + racc + prettier_print (1.2.1) + prism (1.4.0) + public_suffix (6.0.2) + racc (1.8.1) + rainbow (3.1.1) + rake (13.2.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) + ffi (~> 1.0) + rbi (0.3.2) + prism (~> 1.0) + rbs (>= 3.4.4) + sorbet-runtime (>= 0.5.9204) + rbs (3.9.2) + logger + redcarpet (3.6.1) + regexp_parser (2.10.0) + rexml (3.4.1) + rubocop (1.75.5) + json (~> 2.3) + language_server-protocol (~> 3.17.0.2) + lint_roller (~> 1.1.0) + parallel (~> 1.10) + parser (>= 3.3.0.2) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 2.9.3, < 3.0) + rubocop-ast (>= 1.44.0, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 4.0) + rubocop-ast (1.44.1) + parser (>= 3.3.7.2) + prism (~> 1.4) + ruby-progressbar (1.13.0) + securerandom (0.4.1) + sorbet (0.5.12067) + sorbet-static (= 0.5.12067) + sorbet-runtime (0.5.12067) + sorbet-static (0.5.12067-x86_64-linux) + sorbet-static-and-runtime (0.5.12067) + sorbet (= 0.5.12067) + sorbet-runtime (= 0.5.12067) + spoom (1.6.1) + erubi (>= 1.10.0) + prism (>= 0.28.0) + rbi (>= 0.2.3) + sorbet-static-and-runtime (>= 0.5.10187) + thor (>= 0.19.2) + steep (1.10.0) + activesupport (>= 5.1) + concurrent-ruby (>= 1.1.10) + csv (>= 3.0.9) + fileutils (>= 1.1.0) + json (>= 2.1.0) + language_server-protocol (>= 3.17.0.4, < 4.0) + listen (~> 3.0) + logger (>= 1.3.0) + mutex_m (>= 0.3.0) + parser (>= 3.1) + rainbow (>= 2.2.2, < 4.0) + rbs (~> 3.9) + securerandom (>= 0.1) + strscan (>= 1.0.0) + terminal-table (>= 2, < 5) + uri (>= 0.12.0) + strscan (3.1.5) + syntax_tree (6.2.0) + prettier_print (>= 1.2.0) + tapioca (0.16.11) + benchmark + bundler (>= 2.2.25) + netrc (>= 0.11.0) + parallel (>= 1.21.0) + rbi (~> 0.2) + sorbet-static-and-runtime (>= 0.5.11087) + spoom (>= 1.2.0) + thor (>= 1.2.0) + yard-sorbet + terminal-table (4.0.0) + unicode-display_width (>= 1.1.1, < 4) + thor (1.3.2) + traces (0.15.2) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unicode-display_width (3.1.4) + unicode-emoji (~> 4.0, >= 4.0.4) + unicode-emoji (4.0.4) + uri (1.0.3) + webmock (3.25.1) + addressable (>= 2.8.0) + crack (>= 0.3.2) + hashdiff (>= 0.4.0, < 2.0.0) + webrick (1.9.1) + yard (0.9.37) + yard-sorbet (0.9.0) + sorbet-runtime + yard + +PLATFORMS + x86_64-linux + +DEPENDENCIES + async + imagekit! + minitest + minitest-focus + minitest-hooks + minitest-proveit + minitest-rg + rake + rbs + redcarpet + rubocop + sorbet + steep + syntax_tree + syntax_tree-rbs! + tapioca + webmock + webrick + yard + +BUNDLED WITH + 2.4.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..e7a4d160 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 098966eb..8c16eb1b 100644 --- a/README.md +++ b/README.md @@ -1 +1,256 @@ -# imagekit-ruby \ No newline at end of file +# Image Kit Ruby API library + +The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/stainless-sdks/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. + +It is generated with [Stainless](https://www.stainless.com/). + +## Documentation + +Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/imagekit). + +The REST API documentation can be found on [imagekit.io](https://imagekit.io). + +## Installation + +To use this gem, install via Bundler by adding the following to your application's `Gemfile`: + +```ruby +gem "imagekit", "~> 0.0.1" +``` + +## Usage + +```ruby +require "bundler/setup" +require "imagekit" + +image_kit = Imagekit::Client.new( + private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], # This is the default and can be omitted + password: ENV["ORG_MY_PASSWORD_TOKEN"] # This is the default and can be omitted +) + +response = image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" +) + +puts(response.videoCodec) +``` + +### Handling errors + +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::Errors::APIError` will be thrown: + +```ruby +begin + file = image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) +rescue Imagekit::Errors::APIConnectionError => e + puts("The server could not be reached") + puts(e.cause) # an underlying Exception, likely raised within `net/http` +rescue Imagekit::Errors::RateLimitError => e + puts("A 429 status code was received; we should back off a bit.") +rescue Imagekit::Errors::APIStatusError => e + puts("Another non-200-range status code was received") + puts(e.status) +end +``` + +Error codes are as follows: + +| Cause | Error Type | +| ---------------- | -------------------------- | +| HTTP 400 | `BadRequestError` | +| HTTP 401 | `AuthenticationError` | +| HTTP 403 | `PermissionDeniedError` | +| HTTP 404 | `NotFoundError` | +| HTTP 409 | `ConflictError` | +| HTTP 422 | `UnprocessableEntityError` | +| HTTP 429 | `RateLimitError` | +| HTTP >= 500 | `InternalServerError` | +| Other HTTP error | `APIStatusError` | +| Timeout | `APITimeoutError` | +| Network error | `APIConnectionError` | + +### Retries + +Certain errors will be automatically retried 2 times by default, with a short exponential backoff. + +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. + +You can use the `max_retries` option to configure or disable this: + +```ruby +# Configure the default for all requests: +image_kit = Imagekit::Client.new( + max_retries: 0 # default is 2 +) + +# Or, configure per-request: +image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {max_retries: 5} +) +``` + +### Timeouts + +By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this: + +```ruby +# Configure the default for all requests: +image_kit = Imagekit::Client.new( + timeout: nil # default is 60 +) + +# Or, configure per-request: +image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {timeout: 5} +) +``` + +On timeout, `Imagekit::Errors::APITimeoutError` is raised. + +Note that requests that time out are retried by default. + +## Advanced concepts + +### BaseModel + +All parameter and response objects inherit from `Imagekit::Internal::Type::BaseModel`, which provides several conveniences, including: + +1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax. + +2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true. + +3. Both instances and the classes themselves can be pretty-printed. + +4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`. + +### Making custom or undocumented requests + +#### Undocumented properties + +You can send undocumented parameters to any endpoint, and read undocumented response properties, like so: + +Note: the `extra_` parameters of the same name overrides the documented parameters. + +```ruby +response = + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: { + extra_query: {my_query_parameter: value}, + extra_body: {my_body_parameter: value}, + extra_headers: {"my-header": value} + } + ) + +puts(response[:my_undocumented_property]) +``` + +#### 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. + +#### Undocumented endpoints + +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: + +```ruby +response = client.request( + method: :post, + path: '/undocumented/endpoint', + query: {"dog": "woof"}, + headers: {"useful-header": "interesting-value"}, + body: {"hello": "world"} +) +``` + +### Concurrency & connection pooling + +The `Imagekit::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests. + +Each instance of `Imagekit::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings. + +When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout. + +Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure. + +## Sorbet + +This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime. + +You can provide typesafe request parameters like so: + +```ruby +image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" +) +``` + +Or, equivalently: + +```ruby +# Hashes work, but are not typesafe: +image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" +) + +# You can also splat a full Params class: +params = Imagekit::FileUploadV1Params.new( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" +) +image_kit.files.upload_v1(**params) +``` + +### Enums + +Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime: + +```ruby +# :file +puts(Imagekit::FileListParams::Type::FILE) + +# Revealed type: `T.all(Imagekit::FileListParams::Type, Symbol)` +T.reveal_type(Imagekit::FileListParams::Type::FILE) +``` + +Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value: + +```ruby +# Using the enum constants preserves the tagged type information: +image_kit.files.list( + type: Imagekit::FileListParams::Type::FILE, + # … +) + +# Literal values are also permissible: +image_kit.files.list( + type: :file, + # … +) +``` + +## Versioning + +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. + +This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes. + +## Requirements + +Ruby 3.2.0 or higher. + +## Contributing + +See [the contributing documentation](https://github.com/stainless-sdks/imagekit-ruby/tree/main/CONTRIBUTING.md). diff --git a/Rakefile b/Rakefile new file mode 100644 index 00000000..6b5be685 --- /dev/null +++ b/Rakefile @@ -0,0 +1,160 @@ +# frozen_string_literal: true + +require "pathname" +require "securerandom" +require "shellwords" + +require "minitest/test_task" +require "rake/clean" +require "rubocop/rake_task" + +tapioca = "sorbet/tapioca" +examples = "examples" +ignore_file = ".ignore" + +CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/ doc/], *FileList["*.gem"], ignore_file) + +CLOBBER.push(*%w[sorbet/rbi/annotations/ sorbet/rbi/gems/], tapioca) + +multitask(:default) do + sh(*%w[rake --tasks]) +end + +desc("Preview docs; use `PORT=` to change the port") +multitask(:"docs:preview") do + sh(*%w[yard server --reload --quiet --bind [::] --port], ENV.fetch("PORT", "8808")) +end + +desc("Run test suites; use `TEST=path/to/test.rb` to run a specific test file") +multitask(:test) do + rb = + FileList[ENV.fetch("TEST", "./test/**/*_test.rb")] + .map { "require_relative(#{_1.dump});" } + .join + + ruby(*%w[-w -e], rb, verbose: false) { fail unless _1 } +end + +xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --] +ruby_opt = {"RUBYOPT" => [ENV["RUBYOPT"], "--encoding=UTF-8"].compact.join(" ")} + +desc("Lint `*.rb(i)`") +multitask(:"lint:rubocop") do + find = %w[find ./lib ./test ./rbi ./examples -type f -and ( -name *.rb -or -name *.rbi ) -print0] + + rubocop = %w[rubocop] + rubocop += %w[--format github] if ENV.key?("CI") + + # some lines cannot be shortened + rubocop += %w[--except Lint/RedundantCopDisableDirective,Layout/LineLength] + + lint = xargs + rubocop + sh("#{find.shelljoin} | #{lint.shelljoin}") +end + +desc("Format `*.rb`") +multitask(:"format:rb") do + # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support + find = %w[find ./lib ./test ./examples -type f -and -name *.rb -print0] + fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --] + sh("#{find.shelljoin} | #{fmt.shelljoin}") +end + +desc("Format `*.rbi`") +multitask(:"format:rbi") do + find = %w[find ./rbi -type f -and -name *.rbi -print0] + fmt = xargs + %w[stree write --] + sh(ruby_opt, "#{find.shelljoin} | #{fmt.shelljoin}") +end + +desc("Format `*.rbs`") +multitask(:"format:rbs") do + find = %w[find ./sig -type f -name *.rbs -print0] + inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? ["-i", ""] : %w[-i] + uuid = SecureRandom.uuid + + # `syntax_tree` has trouble with `rbs`'s class & module aliases + + sed_bin = /darwin/ =~ RUBY_PLATFORM ? "/usr/bin/sed" : "sed" + sed = xargs + [sed_bin, "-E", *inplace, "-e"] + # annotate unprocessable aliases with a unique comment + pre = sed + ["s/(class|module) ([^ ]+) = (.+$)/# \\1 #{uuid}\\n\\2: \\3/", "--"] + fmt = xargs + %w[stree write --plugin=rbs --] + # remove the unique comment and unprocessable aliases to type aliases + subst = <<~SED + s/# (class|module) #{uuid}/\\1/ + t l1 + b + + : l1 + N + s/\\n *([^:]+): (.+)$/ \\1 = \\2/ + SED + # for each line: + # 1. try transform the unique comment into `class | module`, if successful, branch to label `l1`. + # 2. at label `l1`, join previously annotated line with `class | module` information. + pst = sed + [subst, "--"] + + success = false + + # transform class aliases to type aliases, which syntax tree has no trouble with + sh("#{find.shelljoin} | #{pre.shelljoin}") + # run syntax tree to format `*.rbs` files + sh(ruby_opt, "#{find.shelljoin} | #{fmt.shelljoin}") do + success = _1 + end + # transform type aliases back to class aliases + sh("#{find.shelljoin} | #{pst.shelljoin}") + + # always run post-processing to remove comment marker + fail unless success +end + +desc("Format everything") +multitask(format: [:"format:rb", :"format:rbi", :"format:rbs"]) + +desc("Typecheck `*.rbs`") +multitask(:"typecheck:steep") do + sh(*%w[steep check]) +end + +directory(examples) + +desc("Typecheck `*.rbi`") +multitask("typecheck:sorbet": examples) do + sh(*%w[srb typecheck --dir], examples) +end + +directory(tapioca) do + sh(*%w[tapioca init]) +end + +desc("Typecheck everything") +multitask(typecheck: [:"typecheck:steep", :"typecheck:sorbet"]) + +desc("Lint and typecheck") +multitask(lint: [:"lint:rubocop", :typecheck]) + +desc("Build yard docs") +multitask(:"build:docs") do + sh(*%w[yard]) +end + +desc("Build ruby gem") +multitask(:"build:gem") do + # optimizing for grepping through the gem bundle: many tools honour `.ignore` files, including VSCode + # + # both `rbi` and `sig` directories are navigable by their respective tool chains and therefore can be ignored by tools such as `rg` + Pathname(ignore_file).write(<<~GLOB) + rbi/* + sig/* + GLOB + + sh(*%w[gem build -- imagekit.gemspec]) + rm_rf(ignore_file) +end + +desc("Release ruby gem") +multitask(release: [:"build:gem"]) do + sh(*%w[gem push], *FileList["*.gem"]) +end 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/Steepfile b/Steepfile new file mode 100644 index 00000000..528b48c3 --- /dev/null +++ b/Steepfile @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +require "yaml" + +target(:lib) do + configure_code_diagnostics(Steep::Diagnostic::Ruby.strict) + + signature("sig") + + YAML.safe_load_file("./manifest.yaml", symbolize_names: true) => {dependencies:} + # currently these libraries lack the `*.rbs` annotations required by `steep` + stdlibs = dependencies - %w[English etc net/http rbconfig set stringio] + + stdlibs.each { library(_1) } +end diff --git a/bin/publish-gem b/bin/publish-gem new file mode 100644 index 00000000..8444af20 --- /dev/null +++ b/bin/publish-gem @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -Eeuo pipefail + +cd -- "$(dirname -- "$0")/.." + +bundle +find . -maxdepth 1 -type f -name "*.gem" -delete +rake release \ No newline at end of file diff --git a/examples/.keep b/examples/.keep new file mode 100644 index 00000000..d8c73e93 --- /dev/null +++ b/examples/.keep @@ -0,0 +1,4 @@ +File generated from our OpenAPI spec by Stainless. + +This directory can be used to store example files demonstrating usage of this SDK. +It is ignored by Stainless code generation and its content (other than this keep file) won't be touched. \ No newline at end of file diff --git a/imagekit.gemspec b/imagekit.gemspec new file mode 100644 index 00000000..a29c6731 --- /dev/null +++ b/imagekit.gemspec @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require_relative "lib/imagekit/version" + +Gem::Specification.new do |s| + s.name = "imagekit" + s.version = Imagekit::VERSION + s.summary = "Ruby library to access the Image Kit API" + s.authors = ["Image Kit"] + s.email = "developer@imagekit.io" + s.homepage = "https://gemdocs.org/gems/imagekit" + s.metadata["homepage_uri"] = s.homepage + s.metadata["source_code_uri"] = "https://github.com/stainless-sdks/imagekit-ruby" + s.metadata["rubygems_mfa_required"] = false.to_s + s.required_ruby_version = ">= 3.2.0" + + s.files = Dir[ + "lib/**/*.rb", + "rbi/**/*.rbi", + "sig/**/*.rbs", + "manifest.yaml", + "SECURITY.md", + "CHANGELOG.md", + ".ignore" + ] + s.extra_rdoc_files = ["README.md"] + s.add_dependency "connection_pool" +end diff --git a/lib/imagekit.rb b/lib/imagekit.rb new file mode 100644 index 00000000..1aa8d0aa --- /dev/null +++ b/lib/imagekit.rb @@ -0,0 +1,129 @@ +# frozen_string_literal: true + +# Standard libraries. +# rubocop:disable Lint/RedundantRequireStatement +require "English" +require "cgi" +require "date" +require "erb" +require "etc" +require "json" +require "net/http" +require "pathname" +require "rbconfig" +require "securerandom" +require "set" +require "stringio" +require "time" +require "uri" +# rubocop:enable Lint/RedundantRequireStatement + +# We already ship the preferred sorbet manifests in the package itself. +# `tapioca` currently does not offer us a way to opt out of unnecessary compilation. +if Object.const_defined?(:Tapioca) && + caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) && + ARGV.none?(/dsl/) + return +end + +# Gems. +require "connection_pool" + +# Package files. +require_relative "imagekit/version" +require_relative "imagekit/internal/util" +require_relative "imagekit/internal/type/converter" +require_relative "imagekit/internal/type/unknown" +require_relative "imagekit/internal/type/boolean" +require_relative "imagekit/internal/type/file_input" +require_relative "imagekit/internal/type/enum" +require_relative "imagekit/internal/type/union" +require_relative "imagekit/internal/type/array_of" +require_relative "imagekit/internal/type/hash_of" +require_relative "imagekit/internal/type/base_model" +require_relative "imagekit/internal/type/base_page" +require_relative "imagekit/internal/type/request_parameters" +require_relative "imagekit/internal" +require_relative "imagekit/request_options" +require_relative "imagekit/file_part" +require_relative "imagekit/errors" +require_relative "imagekit/internal/transport/base_client" +require_relative "imagekit/internal/transport/pooled_net_requester" +require_relative "imagekit/client" +require_relative "imagekit/models/account_get_usage_params" +require_relative "imagekit/models/account_get_usage_response" +require_relative "imagekit/models/bulk_job_copy_folder_params" +require_relative "imagekit/models/bulk_job_copy_folder_response" +require_relative "imagekit/models/bulk_job_move_folder_params" +require_relative "imagekit/models/bulk_job_move_folder_response" +require_relative "imagekit/models/bulk_job_retrieve_status_params" +require_relative "imagekit/models/bulk_job_retrieve_status_response" +require_relative "imagekit/models/custom_metadata_field_create_params" +require_relative "imagekit/models/custom_metadata_field_create_response" +require_relative "imagekit/models/custom_metadata_field_delete_params" +require_relative "imagekit/models/custom_metadata_field_delete_response" +require_relative "imagekit/models/custom_metadata_field_list_params" +require_relative "imagekit/models/custom_metadata_field_list_response" +require_relative "imagekit/models/custom_metadata_field_update_params" +require_relative "imagekit/models/custom_metadata_field_update_response" +require_relative "imagekit/models/exif_details" +require_relative "imagekit/models/exif_image" +require_relative "imagekit/models/file_add_tags_params" +require_relative "imagekit/models/file_add_tags_response" +require_relative "imagekit/models/file_copy_params" +require_relative "imagekit/models/file_copy_response" +require_relative "imagekit/models/file_delete_params" +require_relative "imagekit/models/file_list_params" +require_relative "imagekit/models/file_list_response" +require_relative "imagekit/models/file_move_params" +require_relative "imagekit/models/file_move_response" +require_relative "imagekit/models/file_remove_ai_tags_params" +require_relative "imagekit/models/file_remove_ai_tags_response" +require_relative "imagekit/models/file_remove_tags_params" +require_relative "imagekit/models/file_remove_tags_response" +require_relative "imagekit/models/file_rename_params" +require_relative "imagekit/models/file_rename_response" +require_relative "imagekit/models/files/batch_delete_params" +require_relative "imagekit/models/files/batch_delete_response" +require_relative "imagekit/models/files/detail_retrieve_params" +require_relative "imagekit/models/files/detail_retrieve_response" +require_relative "imagekit/models/files/detail_update_params" +require_relative "imagekit/models/files/detail_update_response" +require_relative "imagekit/models/files/metadata_from_url_params" +require_relative "imagekit/models/files/metadata_from_url_response" +require_relative "imagekit/models/files/metadata_retrieve_params" +require_relative "imagekit/models/files/metadata_retrieve_response" +require_relative "imagekit/models/files/purge_execute_params" +require_relative "imagekit/models/files/purge_execute_response" +require_relative "imagekit/models/files/purge_status_params" +require_relative "imagekit/models/files/purge_status_response" +require_relative "imagekit/models/files/version_delete_params" +require_relative "imagekit/models/files/version_delete_response" +require_relative "imagekit/models/files/version_list_params" +require_relative "imagekit/models/files/version_list_response" +require_relative "imagekit/models/files/version_restore_params" +require_relative "imagekit/models/files/version_restore_response" +require_relative "imagekit/models/files/version_retrieve_params" +require_relative "imagekit/models/files/version_retrieve_response" +require_relative "imagekit/models/file_upload_v1_params" +require_relative "imagekit/models/file_upload_v1_response" +require_relative "imagekit/models/file_upload_v2_params" +require_relative "imagekit/models/file_upload_v2_response" +require_relative "imagekit/models/folder_create_params" +require_relative "imagekit/models/folder_create_response" +require_relative "imagekit/models/folder_delete_params" +require_relative "imagekit/models/folder_delete_response" +require_relative "imagekit/models/gps" +require_relative "imagekit/models/interoperability" +require_relative "imagekit/models/thumbnail" +require_relative "imagekit/models" +require_relative "imagekit/resources/accounts" +require_relative "imagekit/resources/bulk_jobs" +require_relative "imagekit/resources/custom_metadata_fields" +require_relative "imagekit/resources/files" +require_relative "imagekit/resources/files/batch" +require_relative "imagekit/resources/files/details" +require_relative "imagekit/resources/files/metadata" +require_relative "imagekit/resources/files/purge" +require_relative "imagekit/resources/files/versions" +require_relative "imagekit/resources/folder" diff --git a/lib/imagekit/client.rb b/lib/imagekit/client.rb new file mode 100644 index 00000000..0726b8a2 --- /dev/null +++ b/lib/imagekit/client.rb @@ -0,0 +1,108 @@ +# frozen_string_literal: true + +module Imagekit + class Client < Imagekit::Internal::Transport::BaseClient + # Default max number of retries to attempt after a failed retryable request. + DEFAULT_MAX_RETRIES = 2 + + # Default per-request timeout. + DEFAULT_TIMEOUT_IN_SECONDS = 60.0 + + # Default initial retry delay in seconds. + # Overall delay is calculated using exponential backoff + jitter. + DEFAULT_INITIAL_RETRY_DELAY = 0.5 + + # Default max retry delay in seconds. + DEFAULT_MAX_RETRY_DELAY = 8.0 + + # Your ImageKit private key starts with `private_`. + # @return [String] + attr_reader :private_api_key + + # Do not set this, its value is ignored + # @return [String, nil] + attr_reader :password + + # @return [Imagekit::Resources::CustomMetadataFields] + attr_reader :custom_metadata_fields + + # @return [Imagekit::Resources::Files] + attr_reader :files + + # @return [Imagekit::Resources::Folder] + attr_reader :folder + + # @return [Imagekit::Resources::BulkJobs] + attr_reader :bulk_jobs + + # @return [Imagekit::Resources::Accounts] + attr_reader :accounts + + # @api private + # + # @return [Hash{String=>String}] + private def auth_headers + return {} if @private_api_key.nil? || @password.nil? + + base64_credentials = ["#{@private_api_key}:#{@password}"].pack("m0") + {"authorization" => "Basic #{base64_credentials}"} + end + + # @api private + # + # @return [Boolean] + def base_url_overridden? = @base_url_overridden + + # Creates and returns a new client for interacting with the API. + # + # @param private_api_key [String, nil] Your ImageKit private key starts with `private_`. Defaults to + # `ENV["IMAGEKIT_PRIVATE_API_KEY"]` + # + # @param password [String, nil] Do not set this, its value is ignored Defaults to `ENV["ORG_MY_PASSWORD_TOKEN"]` + # + # @param base_url [String, nil] Override the default base URL for the API, e.g., + # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` + # + # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request. + # + # @param timeout [Float] + # + # @param initial_retry_delay [Float] + # + # @param max_retry_delay [Float] + def initialize( + private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], + password: ENV.fetch("ORG_MY_PASSWORD_TOKEN", "does_not_matter"), + base_url: ENV["IMAGE_KIT_BASE_URL"], + max_retries: self.class::DEFAULT_MAX_RETRIES, + timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS, + initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY, + max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY + ) + @base_url_overridden = !base_url.nil? + + base_url ||= "https://api.imagekit.io" + + if private_api_key.nil? + raise ArgumentError.new("private_api_key is required, and can be set via environ: \"IMAGEKIT_PRIVATE_API_KEY\"") + end + + @private_api_key = private_api_key.to_s + @password = password.to_s + + super( + base_url: base_url, + timeout: timeout, + max_retries: max_retries, + initial_retry_delay: initial_retry_delay, + max_retry_delay: max_retry_delay + ) + + @custom_metadata_fields = Imagekit::Resources::CustomMetadataFields.new(client: self) + @files = Imagekit::Resources::Files.new(client: self) + @folder = Imagekit::Resources::Folder.new(client: self) + @bulk_jobs = Imagekit::Resources::BulkJobs.new(client: self) + @accounts = Imagekit::Resources::Accounts.new(client: self) + end + end +end diff --git a/lib/imagekit/errors.rb b/lib/imagekit/errors.rb new file mode 100644 index 00000000..b61fb677 --- /dev/null +++ b/lib/imagekit/errors.rb @@ -0,0 +1,214 @@ +# frozen_string_literal: true + +module Imagekit + module Errors + class Error < StandardError + # @!attribute cause + # + # @return [StandardError, nil] + end + + class ConversionError < Imagekit::Errors::Error + # @return [StandardError, nil] + def cause = @cause.nil? ? super : @cause + + # @api private + # + # @param on [Class] + # @param method [Symbol] + # @param target [Object] + # @param value [Object] + # @param cause [StandardError, nil] + def initialize(on:, method:, target:, value:, cause: nil) + cls = on.name.split("::").last + + message = [ + "Failed to parse #{cls}.#{method} from #{value.class} to #{target.inspect}.", + "To get the unparsed API response, use #{cls}[#{method.inspect}].", + cause && "Cause: #{cause.message}" + ].filter(&:itself).join(" ") + + @cause = cause + super(message) + end + end + + class APIError < Imagekit::Errors::Error + # @return [URI::Generic] + attr_accessor :url + + # @return [Integer, nil] + attr_accessor :status + + # @return [Object, nil] + attr_accessor :body + + # @api private + # + # @param url [URI::Generic] + # @param status [Integer, nil] + # @param body [Object, nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil) + @url = url + @status = status + @body = body + @request = request + @response = response + super(message) + end + end + + class APIConnectionError < Imagekit::Errors::APIError + # @!attribute status + # + # @return [nil] + + # @!attribute body + # + # @return [nil] + + # @api private + # + # @param url [URI::Generic] + # @param status [nil] + # @param body [nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + def initialize( + url:, + status: nil, + body: nil, + request: nil, + response: nil, + message: "Connection error." + ) + super + end + end + + class APITimeoutError < Imagekit::Errors::APIConnectionError + # @api private + # + # @param url [URI::Generic] + # @param status [nil] + # @param body [nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + def initialize( + url:, + status: nil, + body: nil, + request: nil, + response: nil, + message: "Request timed out." + ) + super + end + end + + class APIStatusError < Imagekit::Errors::APIError + # @api private + # + # @param url [URI::Generic] + # @param status [Integer] + # @param body [Object, nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + # + # @return [self] + def self.for(url:, status:, body:, request:, response:, message: nil) + kwargs = { + url: url, + status: status, + body: body, + request: request, + response: response, + message: message + } + + case status + in 400 + Imagekit::Errors::BadRequestError.new(**kwargs) + in 401 + Imagekit::Errors::AuthenticationError.new(**kwargs) + in 403 + Imagekit::Errors::PermissionDeniedError.new(**kwargs) + in 404 + Imagekit::Errors::NotFoundError.new(**kwargs) + in 409 + Imagekit::Errors::ConflictError.new(**kwargs) + in 422 + Imagekit::Errors::UnprocessableEntityError.new(**kwargs) + in 429 + Imagekit::Errors::RateLimitError.new(**kwargs) + in (500..) + Imagekit::Errors::InternalServerError.new(**kwargs) + else + Imagekit::Errors::APIStatusError.new(**kwargs) + end + end + + # @!parse + # # @return [Integer] + # attr_accessor :status + + # @api private + # + # @param url [URI::Generic] + # @param status [Integer] + # @param body [Object, nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + def initialize(url:, status:, body:, request:, response:, message: nil) + message ||= {url: url.to_s, status: status, body: body} + super( + url: url, + status: status, + body: body, + request: request, + response: response, + message: message&.to_s + ) + end + end + + class BadRequestError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 400 + end + + class AuthenticationError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 401 + end + + class PermissionDeniedError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 403 + end + + class NotFoundError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 404 + end + + class ConflictError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 409 + end + + class UnprocessableEntityError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 422 + end + + class RateLimitError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 429 + end + + class InternalServerError < Imagekit::Errors::APIStatusError + HTTP_STATUS = (500..) + end + end +end diff --git a/lib/imagekit/file_part.rb b/lib/imagekit/file_part.rb new file mode 100644 index 00000000..7676aada --- /dev/null +++ b/lib/imagekit/file_part.rb @@ -0,0 +1,55 @@ +# frozen_string_literal: true + +module Imagekit + class FilePart + # @return [Pathname, StringIO, IO, String] + attr_reader :content + + # @return [String, nil] + attr_reader :content_type + + # @return [String, nil] + attr_reader :filename + + # @api private + # + # @return [String] + private def read + case content + in Pathname + content.read(binmode: true) + in StringIO + content.string + in IO + content.read + in String + content + end + end + + # @param a [Object] + # + # @return [String] + def to_json(*a) = read.to_json(*a) + + # @param a [Object] + # + # @return [String] + def to_yaml(*a) = read.to_yaml(*a) + + # @param content [Pathname, StringIO, IO, String] + # @param filename [String, nil] + # @param content_type [String, nil] + def initialize(content, filename: nil, content_type: nil) + @content = content + @filename = + case content + in Pathname + filename.nil? ? content.basename.to_path : ::File.basename(filename) + else + filename.nil? ? nil : ::File.basename(filename) + end + @content_type = content_type + end + end +end diff --git a/lib/imagekit/internal.rb b/lib/imagekit/internal.rb new file mode 100644 index 00000000..450d18b1 --- /dev/null +++ b/lib/imagekit/internal.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + OMIT = + Object.new.tap do + _1.define_singleton_method(:inspect) { "#<#{Imagekit::Internal}::OMIT>" } + end + .freeze + + define_sorbet_constant!(:AnyHash) do + T.type_alias { T::Hash[Symbol, T.anything] } + end + define_sorbet_constant!(:FileInput) do + T.type_alias { T.any(Pathname, StringIO, IO, String, Imagekit::FilePart) } + end + end +end diff --git a/lib/imagekit/internal/transport/base_client.rb b/lib/imagekit/internal/transport/base_client.rb new file mode 100644 index 00000000..3bab4fc6 --- /dev/null +++ b/lib/imagekit/internal/transport/base_client.rb @@ -0,0 +1,563 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Transport + # @api private + # + # @abstract + class BaseClient + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + # from whatwg fetch spec + MAX_REDIRECTS = 20 + + # rubocop:disable Style/MutableConstant + PLATFORM_HEADERS = + { + "x-stainless-arch" => Imagekit::Internal::Util.arch, + "x-stainless-lang" => "ruby", + "x-stainless-os" => Imagekit::Internal::Util.os, + "x-stainless-package-version" => Imagekit::VERSION, + "x-stainless-runtime" => ::RUBY_ENGINE, + "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION + } + # rubocop:enable Style/MutableConstant + + class << self + # @api private + # + # @param req [Hash{Symbol=>Object}] + # + # @raise [ArgumentError] + def validate!(req) + keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :stream, :model, :options] + case req + in Hash + req.each_key do |k| + unless keys.include?(k) + raise ArgumentError.new("Request `req` keys must be one of #{keys}, got #{k.inspect}") + end + end + else + raise ArgumentError.new("Request `req` must be a Hash or RequestOptions, got #{req.inspect}") + end + end + + # @api private + # + # @param status [Integer] + # @param headers [Hash{String=>String}, Net::HTTPHeader] + # + # @return [Boolean] + def should_retry?(status, headers:) + coerced = Imagekit::Internal::Util.coerce_boolean(headers["x-should-retry"]) + case [coerced, status] + in [true | false, _] + coerced + in [_, 408 | 409 | 429 | (500..)] + # retry on: + # 408: timeouts + # 409: locks + # 429: rate limits + # 500+: unknown errors + true + else + false + end + end + + # @api private + # + # @param request [Hash{Symbol=>Object}] . + # + # @option request [Symbol] :method + # + # @option request [URI::Generic] :url + # + # @option request [Hash{String=>String}] :headers + # + # @option request [Object] :body + # + # @option request [Integer] :max_retries + # + # @option request [Float] :timeout + # + # @param status [Integer] + # + # @param response_headers [Hash{String=>String}, Net::HTTPHeader] + # + # @return [Hash{Symbol=>Object}] + def follow_redirect(request, status:, response_headers:) + method, url, headers = request.fetch_values(:method, :url, :headers) + location = + Kernel.then do + URI.join(url, response_headers["location"]) + rescue ArgumentError + message = "Server responded with status #{status} but no valid location header." + raise Imagekit::Errors::APIConnectionError.new( + url: url, + response: response_headers, + message: message + ) + end + + request = {**request, url: location} + + case [url.scheme, location.scheme] + in ["https", "http"] + message = "Tried to redirect to a insecure URL" + raise Imagekit::Errors::APIConnectionError.new( + url: url, + response: response_headers, + message: message + ) + else + nil + end + + # from whatwg fetch spec + case [status, method] + in [301 | 302, :post] | [303, _] + drop = %w[content-encoding content-language content-length content-location content-type] + request = { + **request, + method: method == :head ? :head : :get, + headers: headers.except(*drop), + body: nil + } + else + end + + # from undici + if Imagekit::Internal::Util.uri_origin(url) != Imagekit::Internal::Util.uri_origin(location) + drop = %w[authorization cookie host proxy-authorization] + request = {**request, headers: request.fetch(:headers).except(*drop)} + end + + request + end + + # @api private + # + # @param status [Integer, Imagekit::Errors::APIConnectionError] + # @param stream [Enumerable, nil] + def reap_connection!(status, stream:) + case status + in (..199) | (300..499) + stream&.each { next } + in Imagekit::Errors::APIConnectionError | (500..) + Imagekit::Internal::Util.close_fused!(stream) + else + end + end + end + + # @return [URI::Generic] + attr_reader :base_url + + # @return [Float] + attr_reader :timeout + + # @return [Integer] + attr_reader :max_retries + + # @return [Float] + attr_reader :initial_retry_delay + + # @return [Float] + attr_reader :max_retry_delay + + # @return [Hash{String=>String}] + attr_reader :headers + + # @return [String, nil] + attr_reader :idempotency_header + + # @api private + # @return [Imagekit::Internal::Transport::PooledNetRequester] + attr_reader :requester + + # @api private + # + # @param base_url [String] + # @param timeout [Float] + # @param max_retries [Integer] + # @param initial_retry_delay [Float] + # @param max_retry_delay [Float] + # @param headers [Hash{String=>String, Integer, Array, nil}] + # @param idempotency_header [String, nil] + def initialize( + base_url:, + timeout: 0.0, + max_retries: 0, + initial_retry_delay: 0.0, + max_retry_delay: 0.0, + headers: {}, + idempotency_header: nil + ) + @requester = Imagekit::Internal::Transport::PooledNetRequester.new + @headers = Imagekit::Internal::Util.normalized_headers( + self.class::PLATFORM_HEADERS, + { + "accept" => "application/json", + "content-type" => "application/json" + }, + headers + ) + @base_url_components = Imagekit::Internal::Util.parse_uri(base_url) + @base_url = Imagekit::Internal::Util.unparse_uri(@base_url_components) + @idempotency_header = idempotency_header&.to_s&.downcase + @timeout = timeout + @max_retries = max_retries + @initial_retry_delay = initial_retry_delay + @max_retry_delay = max_retry_delay + end + + # @api private + # + # @return [Hash{String=>String}] + private def auth_headers = {} + + # @api private + # + # @return [String] + private def generate_idempotency_key = "stainless-ruby-retry-#{SecureRandom.uuid}" + + # @api private + # + # @param req [Hash{Symbol=>Object}] . + # + # @option req [Symbol] :method + # + # @option req [String, Array] :path + # + # @option req [Hash{String=>Array, String, nil}, nil] :query + # + # @option req [Hash{String=>String, Integer, Array, nil}, nil] :headers + # + # @option req [Object, nil] :body + # + # @option req [Symbol, Integer, Array, Proc, nil] :unwrap + # + # @option req [Class, nil] :page + # + # @option req [Class, nil] :stream + # + # @option req [Imagekit::Internal::Type::Converter, Class, nil] :model + # + # @param opts [Hash{Symbol=>Object}] . + # + # @option opts [String, nil] :idempotency_key + # + # @option opts [Hash{String=>Array, String, nil}, nil] :extra_query + # + # @option opts [Hash{String=>String, nil}, nil] :extra_headers + # + # @option opts [Object, nil] :extra_body + # + # @option opts [Integer, nil] :max_retries + # + # @option opts [Float, nil] :timeout + # + # @return [Hash{Symbol=>Object}] + private def build_request(req, opts) + method, uninterpolated_path = req.fetch_values(:method, :path) + + path = Imagekit::Internal::Util.interpolate_path(uninterpolated_path) + + query = Imagekit::Internal::Util.deep_merge(req[:query].to_h, opts[:extra_query].to_h) + + headers = Imagekit::Internal::Util.normalized_headers( + @headers, + auth_headers, + req[:headers].to_h, + opts[:extra_headers].to_h + ) + + if @idempotency_header && + !headers.key?(@idempotency_header) && + (!Net::HTTP::IDEMPOTENT_METHODS_.include?(method.to_s.upcase) || opts.key?(:idempotency_key)) + headers[@idempotency_header] = opts.fetch(:idempotency_key) { generate_idempotency_key } + end + + unless headers.key?("x-stainless-retry-count") + headers["x-stainless-retry-count"] = "0" + end + + timeout = opts.fetch(:timeout, @timeout).to_f.clamp(0..) + unless headers.key?("x-stainless-timeout") || timeout.zero? + headers["x-stainless-timeout"] = timeout.to_s + end + + headers.reject! { |_, v| v.to_s.empty? } + + body = + case method + in :get | :head | :options | :trace + nil + else + Imagekit::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact) + end + + url = Imagekit::Internal::Util.join_parsed_uri( + @base_url_components, + {**req, path: path, query: query} + ) + headers, encoded = Imagekit::Internal::Util.encode_content(headers, body) + { + method: method, + url: url, + headers: headers, + body: encoded, + max_retries: opts.fetch(:max_retries, @max_retries), + timeout: timeout + } + end + + # @api private + # + # @param headers [Hash{String=>String}] + # @param retry_count [Integer] + # + # @return [Float] + private def retry_delay(headers, retry_count:) + # Non-standard extension + span = Float(headers["retry-after-ms"], exception: false)&.then { _1 / 1000 } + return span if span + + retry_header = headers["retry-after"] + return span if (span = Float(retry_header, exception: false)) + + span = retry_header&.then do + Time.httpdate(_1) - Time.now + rescue ArgumentError + nil + end + return span if span + + scale = retry_count**2 + jitter = 1 - (0.25 * rand) + (@initial_retry_delay * scale * jitter).clamp(0, @max_retry_delay) + end + + # @api private + # + # @param request [Hash{Symbol=>Object}] . + # + # @option request [Symbol] :method + # + # @option request [URI::Generic] :url + # + # @option request [Hash{String=>String}] :headers + # + # @option request [Object] :body + # + # @option request [Integer] :max_retries + # + # @option request [Float] :timeout + # + # @param redirect_count [Integer] + # + # @param retry_count [Integer] + # + # @param send_retry_header [Boolean] + # + # @raise [Imagekit::Errors::APIError] + # @return [Array(Integer, Net::HTTPResponse, Enumerable)] + def send_request(request, redirect_count:, retry_count:, send_retry_header:) + url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout) + input = {**request.except(:timeout), deadline: Imagekit::Internal::Util.monotonic_secs + timeout} + + if send_retry_header + headers["x-stainless-retry-count"] = retry_count.to_s + end + + begin + status, response, stream = @requester.execute(input) + rescue Imagekit::Errors::APIConnectionError => e + status = e + end + + case status + in ..299 + [status, response, stream] + in 300..399 if redirect_count >= self.class::MAX_REDIRECTS + self.class.reap_connection!(status, stream: stream) + + message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects." + raise Imagekit::Errors::APIConnectionError.new(url: url, response: response, message: message) + in 300..399 + self.class.reap_connection!(status, stream: stream) + + request = self.class.follow_redirect(request, status: status, response_headers: response) + send_request( + request, + redirect_count: redirect_count + 1, + retry_count: retry_count, + send_retry_header: send_retry_header + ) + in Imagekit::Errors::APIConnectionError if retry_count >= max_retries + raise status + in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response) + decoded = Kernel.then do + Imagekit::Internal::Util.decode_content(response, stream: stream, suppress_error: true) + ensure + self.class.reap_connection!(status, stream: stream) + end + + raise Imagekit::Errors::APIStatusError.for( + url: url, + status: status, + body: decoded, + request: nil, + response: response + ) + in (400..) | Imagekit::Errors::APIConnectionError + self.class.reap_connection!(status, stream: stream) + + delay = retry_delay(response || {}, retry_count: retry_count) + sleep(delay) + + send_request( + request, + redirect_count: redirect_count, + retry_count: retry_count + 1, + send_retry_header: send_retry_header + ) + end + end + + # Execute the request specified by `req`. This is the method that all resource + # methods call into. + # + # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Imagekit::Internal::Type::Unknown, options: {}) + # + # @param method [Symbol] + # + # @param path [String, Array] + # + # @param query [Hash{String=>Array, String, nil}, nil] + # + # @param headers [Hash{String=>String, Integer, Array, nil}, nil] + # + # @param body [Object, nil] + # + # @param unwrap [Symbol, Integer, Array, Proc, nil] + # + # @param page [Class, nil] + # + # @param stream [Class, nil] + # + # @param model [Imagekit::Internal::Type::Converter, Class, nil] + # + # @param options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] . + # + # @option options [String, nil] :idempotency_key + # + # @option options [Hash{String=>Array, String, nil}, nil] :extra_query + # + # @option options [Hash{String=>String, nil}, nil] :extra_headers + # + # @option options [Object, nil] :extra_body + # + # @option options [Integer, nil] :max_retries + # + # @option options [Float, nil] :timeout + # + # @raise [Imagekit::Errors::APIError] + # @return [Object] + def request(req) + self.class.validate!(req) + model = req.fetch(:model) { Imagekit::Internal::Type::Unknown } + opts = req[:options].to_h + unwrap = req[:unwrap] + Imagekit::RequestOptions.validate!(opts) + request = build_request(req.except(:options), opts) + url = request.fetch(:url) + + # Don't send the current retry count in the headers if the caller modified the header defaults. + send_retry_header = request.fetch(:headers)["x-stainless-retry-count"] == "0" + status, response, stream = send_request( + request, + redirect_count: 0, + retry_count: 0, + send_retry_header: send_retry_header + ) + + decoded = Imagekit::Internal::Util.decode_content(response, stream: stream) + case req + in {stream: Class => st} + st.new( + model: model, + url: url, + status: status, + response: response, + unwrap: unwrap, + stream: decoded + ) + in {page: Class => page} + page.new(client: self, req: req, headers: response, page_data: decoded) + else + unwrapped = Imagekit::Internal::Util.dig(decoded, unwrap) + Imagekit::Internal::Type::Converter.coerce(model, unwrapped) + end + end + + # @api private + # + # @return [String] + def inspect + # rubocop:disable Layout/LineLength + "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{@base_url} max_retries=#{@max_retries} timeout=#{@timeout}>" + # rubocop:enable Layout/LineLength + end + + define_sorbet_constant!(:RequestComponents) do + T.type_alias do + { + method: Symbol, + path: T.any(String, T::Array[String]), + query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]), + headers: T.nilable( + T::Hash[String, + T.nilable( + T.any( + String, + Integer, + T::Array[T.nilable(T.any(String, Integer))] + ) + )] + ), + body: T.nilable(T.anything), + unwrap: T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), + page: T.nilable(T::Class[Imagekit::Internal::Type::BasePage[Imagekit::Internal::Type::BaseModel]]), + stream: T.nilable(T::Class[T.anything]), + model: T.nilable(Imagekit::Internal::Type::Converter::Input), + options: T.nilable(Imagekit::RequestOptions::OrHash) + } + end + end + define_sorbet_constant!(:RequestInput) do + T.type_alias do + { + method: Symbol, + url: URI::Generic, + headers: T::Hash[String, String], + body: T.anything, + max_retries: Integer, + timeout: Float + } + end + end + end + end + end +end diff --git a/lib/imagekit/internal/transport/pooled_net_requester.rb b/lib/imagekit/internal/transport/pooled_net_requester.rb new file mode 100644 index 00000000..1acc244b --- /dev/null +++ b/lib/imagekit/internal/transport/pooled_net_requester.rb @@ -0,0 +1,209 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Transport + # @api private + class PooledNetRequester + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + # from the golang stdlib + # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 + KEEP_ALIVE_TIMEOUT = 30 + + DEFAULT_MAX_CONNECTIONS = [Etc.nprocessors, 99].max + + class << self + # @api private + # + # @param url [URI::Generic] + # + # @return [Net::HTTP] + def connect(url) + port = + case [url.port, url.scheme] + in [Integer, _] + url.port + in [nil, "http" | "ws"] + Net::HTTP.http_default_port + in [nil, "https" | "wss"] + Net::HTTP.https_default_port + end + + Net::HTTP.new(url.host, port).tap do + _1.use_ssl = %w[https wss].include?(url.scheme) + _1.max_retries = 0 + end + end + + # @api private + # + # @param conn [Net::HTTP] + # @param deadline [Float] + def calibrate_socket_timeout(conn, deadline) + timeout = deadline - Imagekit::Internal::Util.monotonic_secs + conn.open_timeout = conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout + end + + # @api private + # + # @param request [Hash{Symbol=>Object}] . + # + # @option request [Symbol] :method + # + # @option request [URI::Generic] :url + # + # @option request [Hash{String=>String}] :headers + # + # @param blk [Proc] + # + # @yieldparam [String] + # @return [Array(Net::HTTPGenericRequest, Proc)] + def build_request(request, &blk) + method, url, headers, body = request.fetch_values(:method, :url, :headers, :body) + req = Net::HTTPGenericRequest.new( + method.to_s.upcase, + !body.nil?, + method != :head, + URI(url.to_s) # ensure we construct a URI class of the right scheme + ) + + headers.each { req[_1] = _2 } + + case body + in nil + nil + in String + req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"] + req.body_stream = Imagekit::Internal::Util::ReadIOAdapter.new(body, &blk) + in StringIO + req["content-length"] ||= body.size.to_s unless req["transfer-encoding"] + req.body_stream = Imagekit::Internal::Util::ReadIOAdapter.new(body, &blk) + in Pathname | IO | Enumerator + req["transfer-encoding"] ||= "chunked" unless req["content-length"] + req.body_stream = Imagekit::Internal::Util::ReadIOAdapter.new(body, &blk) + end + + [req, req.body_stream&.method(:close)] + end + end + + # @api private + # + # @param url [URI::Generic] + # @param deadline [Float] + # @param blk [Proc] + # + # @raise [Timeout::Error] + # @yieldparam [Net::HTTP] + private def with_pool(url, deadline:, &blk) + origin = Imagekit::Internal::Util.uri_origin(url) + timeout = deadline - Imagekit::Internal::Util.monotonic_secs + pool = + @mutex.synchronize do + @pools[origin] ||= ConnectionPool.new(size: @size) do + self.class.connect(url) + end + end + + pool.with(timeout: timeout, &blk) + end + + # @api private + # + # @param request [Hash{Symbol=>Object}] . + # + # @option request [Symbol] :method + # + # @option request [URI::Generic] :url + # + # @option request [Hash{String=>String}] :headers + # + # @option request [Object] :body + # + # @option request [Float] :deadline + # + # @return [Array(Integer, Net::HTTPResponse, Enumerable)] + def execute(request) + url, deadline = request.fetch_values(:url, :deadline) + + req = nil + eof = false + finished = false + closing = nil + + # rubocop:disable Metrics/BlockLength + enum = Enumerator.new do |y| + with_pool(url, deadline: deadline) do |conn| + next if finished + + req, closing = self.class.build_request(request) do + self.class.calibrate_socket_timeout(conn, deadline) + end + + self.class.calibrate_socket_timeout(conn, deadline) + unless conn.started? + conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT + conn.start + end + + self.class.calibrate_socket_timeout(conn, deadline) + conn.request(req) do |rsp| + y << [conn, req, rsp] + break if finished + + rsp.read_body do |bytes| + y << bytes.force_encoding(Encoding::BINARY) + break if finished + + self.class.calibrate_socket_timeout(conn, deadline) + end + eof = true + end + end + rescue Timeout::Error + raise Imagekit::Errors::APITimeoutError.new(url: url, request: req) + rescue StandardError + raise Imagekit::Errors::APIConnectionError.new(url: url, request: req) + end + # rubocop:enable Metrics/BlockLength + + conn, _, response = enum.next + body = Imagekit::Internal::Util.fused_enum(enum, external: true) do + finished = true + tap do + enum.next + rescue StopIteration + nil + end + ensure + conn.finish if !eof && conn&.started? + closing&.call + end + [Integer(response.code), response, body] + end + + # @api private + # + # @param size [Integer] + def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS) + @mutex = Mutex.new + @size = size + @pools = {} + end + + define_sorbet_constant!(:Request) do + T.type_alias do + { + method: Symbol, + url: URI::Generic, + headers: T::Hash[String, String], + body: T.anything, + deadline: Float + } + end + end + end + end + end +end diff --git a/lib/imagekit/internal/type/array_of.rb b/lib/imagekit/internal/type/array_of.rb new file mode 100644 index 00000000..7e21f934 --- /dev/null +++ b/lib/imagekit/internal/type/array_of.rb @@ -0,0 +1,168 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + # + # @abstract + # + # @generic Elem + # + # Array of items of a given type. + class ArrayOf + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + private_class_method :new + + # @overload [](type_info, spec = {}) + # + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + # + # @return [self] + def self.[](...) = new(...) + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ===(other) = other.is_a?(Array) && other.all?(item_type) + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ==(other) + # rubocop:disable Layout/LineLength + other.is_a?(Imagekit::Internal::Type::ArrayOf) && other.nilable? == nilable? && other.item_type == item_type + # rubocop:enable Layout/LineLength + end + + # @api public + # + # @return [Integer] + def hash = [self.class, item_type].hash + + # @api private + # + # @param value [Array, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [Array, Object] + def coerce(value, state:) + exactness = state.fetch(:exactness) + + unless value.is_a?(Array) + exactness[:no] += 1 + state[:error] = TypeError.new("#{value.class} can't be coerced into #{Array}") + return value + end + + target = item_type + exactness[:yes] += 1 + value + .map do |item| + case [nilable?, item] + in [true, nil] + exactness[:yes] += 1 + nil + else + Imagekit::Internal::Type::Converter.coerce(target, item, state: state) + end + end + end + + # @api private + # + # @param value [Array, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Array, Object] + def dump(value, state:) + target = item_type + if value.is_a?(Array) + value.map do + Imagekit::Internal::Type::Converter.dump(target, _1, state: state) + end + else + super + end + end + + # @api private + # + # @return [Object] + def to_sorbet_type + T::Array[Imagekit::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)] + end + + # @api private + # + # @return [generic] + protected def item_type = @item_type_fn.call + + # @api private + # + # @return [Boolean] + protected def nilable? = @nilable + + # @api private + # + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + def initialize(type_info, spec = {}) + @item_type_fn = Imagekit::Internal::Type::Converter.type_info(type_info || spec) + @meta = Imagekit::Internal::Type::Converter.meta_info(type_info, spec) + @nilable = spec.fetch(:nil?, false) + end + + # @api private + # + # @param depth [Integer] + # + # @return [String] + def inspect(depth: 0) + items = Imagekit::Internal::Type::Converter.inspect(item_type, depth: depth.succ) + + "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]" + end + end + end + end +end diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb new file mode 100644 index 00000000..a9815d55 --- /dev/null +++ b/lib/imagekit/internal/type/base_model.rb @@ -0,0 +1,538 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @abstract + class BaseModel + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + class << self + # @api private + # + # Assumes superclass fields are totally defined before fields are accessed / + # defined on subclasses. + # + # @param child [Class] + def inherited(child) + super + child.known_fields.replace(known_fields.dup) + end + + # @api private + # + # @return [Hash{Symbol=>Hash{Symbol=>Object}}] + def known_fields = @known_fields ||= {} + + # @api private + # + # @return [Hash{Symbol=>Hash{Symbol=>Object}}] + def fields + known_fields.transform_values do |field| + {**field.except(:type_fn), type: field.fetch(:type_fn).call} + end + end + + # @api private + # + # @param name_sym [Symbol] + # + # @param required [Boolean] + # + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + private def add_field(name_sym, required:, type_info:, spec:) + meta = Imagekit::Internal::Type::Converter.meta_info(type_info, spec) + type_fn, info = + case type_info + in Proc | Imagekit::Internal::Type::Converter | Class + [Imagekit::Internal::Type::Converter.type_info({**spec, union: type_info}), spec] + in Hash + [Imagekit::Internal::Type::Converter.type_info(type_info), type_info] + end + + setter = :"#{name_sym}=" + api_name = info.fetch(:api_name, name_sym) + nilable = info.fetch(:nil?, false) + const = if required && !nilable + info.fetch( + :const, + Imagekit::Internal::OMIT + ) + else + Imagekit::Internal::OMIT + end + + [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym) + + known_fields[name_sym] = + { + mode: @mode, + api_name: api_name, + required: required, + nilable: nilable, + const: const, + type_fn: type_fn, + meta: meta + } + + define_method(setter) do |value| + target = type_fn.call + state = Imagekit::Internal::Type::Converter.new_coerce_state(translate_names: false) + coerced = Imagekit::Internal::Type::Converter.coerce(target, value, state: state) + status = @coerced.store(name_sym, state.fetch(:error) || true) + stored = + case [target, status] + in [Imagekit::Internal::Type::Converter | Symbol, true] + coerced + else + value + end + @data.store(name_sym, stored) + end + + # rubocop:disable Style/CaseEquality + # rubocop:disable Metrics/BlockLength + define_method(name_sym) do + target = type_fn.call + + case @coerced[name_sym] + in true | false if Imagekit::Internal::Type::Converter === target + @data.fetch(name_sym) + in ::StandardError => e + raise Imagekit::Errors::ConversionError.new( + on: self.class, + method: __method__, + target: target, + value: @data.fetch(name_sym), + cause: e + ) + else + Kernel.then do + value = @data.fetch(name_sym) { const == Imagekit::Internal::OMIT ? nil : const } + state = Imagekit::Internal::Type::Converter.new_coerce_state(translate_names: false) + if (nilable || !required) && value.nil? + nil + else + Imagekit::Internal::Type::Converter.coerce( + target, value, state: state + ) + end + rescue StandardError => e + raise Imagekit::Errors::ConversionError.new( + on: self.class, + method: __method__, + target: target, + value: value, + cause: e + ) + end + end + end + # rubocop:enable Metrics/BlockLength + # rubocop:enable Style/CaseEquality + end + + # @api private + # + # @param name_sym [Symbol] + # + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + def required(name_sym, type_info, spec = {}) + add_field(name_sym, required: true, type_info: type_info, spec: spec) + end + + # @api private + # + # @param name_sym [Symbol] + # + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + def optional(name_sym, type_info, spec = {}) + add_field(name_sym, required: false, type_info: type_info, spec: spec) + end + + # @api private + # + # `request_only` attributes not excluded from `.#coerce` when receiving responses + # even if well behaved servers should not send them + # + # @param blk [Proc] + private def request_only(&blk) + @mode = :dump + blk.call + ensure + @mode = nil + end + + # @api private + # + # `response_only` attributes are omitted from `.#dump` when making requests + # + # @param blk [Proc] + private def response_only(&blk) + @mode = :coerce + blk.call + ensure + @mode = nil + end + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ==(other) + other.is_a?(Class) && other <= Imagekit::Internal::Type::BaseModel && other.fields == fields + end + + # @api public + # + # @return [Integer] + def hash = fields.hash + end + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ==(other) = self.class == other.class && @data == other.to_h + + # @api public + # + # @return [Integer] + def hash = [self.class, @data].hash + + class << self + # @api private + # + # @param value [Imagekit::Internal::Type::BaseModel, Hash{Object=>Object}, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [self, Object] + def coerce(value, state:) + exactness = state.fetch(:exactness) + + if value.is_a?(self) + exactness[:yes] += 1 + return value + end + + unless (val = Imagekit::Internal::Util.coerce_hash(value)).is_a?(Hash) + exactness[:no] += 1 + state[:error] = TypeError.new("#{value.class} can't be coerced into #{Hash}") + return value + end + exactness[:yes] += 1 + + keys = val.keys.to_set + instance = new + data = instance.to_h + status = instance.instance_variable_get(:@coerced) + + # rubocop:disable Metrics/BlockLength + fields.each do |name, field| + mode, required, target = field.fetch_values(:mode, :required, :type) + api_name, nilable, const = field.fetch_values(:api_name, :nilable, :const) + src_name = state.fetch(:translate_names) ? api_name : name + + unless val.key?(src_name) + if required && mode != :dump && const == Imagekit::Internal::OMIT + exactness[nilable ? :maybe : :no] += 1 + else + exactness[:yes] += 1 + end + next + end + + item = val.fetch(src_name) + keys.delete(src_name) + + state[:error] = nil + converted = + if item.nil? && (nilable || !required) + exactness[nilable ? :yes : :maybe] += 1 + nil + else + coerced = Imagekit::Internal::Type::Converter.coerce(target, item, state: state) + case target + in Imagekit::Internal::Type::Converter | Symbol + coerced + else + item + end + end + + status.store(name, state.fetch(:error) || true) + data.store(name, converted) + end + # rubocop:enable Metrics/BlockLength + + keys.each { data.store(_1, val.fetch(_1)) } + instance + end + + # @api private + # + # @param value [self, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Hash{Object=>Object}, Object] + def dump(value, state:) + unless (coerced = Imagekit::Internal::Util.coerce_hash(value)).is_a?(Hash) + return super + end + + acc = {} + + coerced.each do |key, val| + name = key.is_a?(String) ? key.to_sym : key + case (field = known_fields[name]) + in nil + acc.store(name, super(val, state: state)) + else + api_name, mode, type_fn = field.fetch_values(:api_name, :mode, :type_fn) + case mode + in :coerce + next + else + target = type_fn.call + acc.store(api_name, Imagekit::Internal::Type::Converter.dump(target, val, state: state)) + end + end + end + + known_fields.each_value do |field| + api_name, mode, const = field.fetch_values(:api_name, :mode, :const) + next if mode == :coerce || acc.key?(api_name) || const == Imagekit::Internal::OMIT + acc.store(api_name, const) + end + + acc + end + + # @api private + # + # @return [Object] + def to_sorbet_type + self + end + end + + class << self + # @api private + # + # @param model [Imagekit::Internal::Type::BaseModel] + # @param convert [Boolean] + # + # @return [Hash{Symbol=>Object}] + def recursively_to_h(model, convert:) + rec = ->(x) do + case x + in Imagekit::Internal::Type::BaseModel + if convert + fields = x.class.known_fields + x.to_h.to_h do |key, val| + [key, rec.call(fields.key?(key) ? x.public_send(key) : val)] + rescue Imagekit::Errors::ConversionError + [key, rec.call(val)] + end + else + rec.call(x.to_h) + end + in Hash + x.transform_values(&rec) + in Array + x.map(&rec) + else + x + end + end + rec.call(model) + end + end + + # @api public + # + # Returns the raw value associated with the given key, if found. Otherwise, nil is + # returned. + # + # It is valid to lookup keys that are not in the API spec, for example to access + # undocumented features. This method does not parse response data into + # higher-level types. Lookup by anything other than a Symbol is an ArgumentError. + # + # @param key [Symbol] + # + # @return [Object, nil] + def [](key) + unless key.instance_of?(Symbol) + raise ArgumentError.new("Expected symbol key for lookup, got #{key.inspect}") + end + + @data[key] + end + + # @api public + # + # Returns a Hash of the data underlying this object. O(1) + # + # Keys are Symbols and values are the raw values from the response. The return + # value indicates which values were ever set on the object. i.e. there will be a + # key in this hash if they ever were, even if the set value was nil. + # + # This method is not recursive. The returned value is shared by the object, so it + # should not be mutated. + # + # @return [Hash{Symbol=>Object}] + def to_h = @data + + alias_method :to_hash, :to_h + + # @api public + # + # In addition to the behaviour of `#to_h`, this method will recursively call + # `#to_h` on nested models. + # + # @return [Hash{Symbol=>Object}] + def deep_to_h = self.class.recursively_to_h(@data, convert: false) + + # @param keys [Array, nil] + # + # @return [Hash{Symbol=>Object}] + # + # @example + # # `custom_metadata_field_create_response` is a `Imagekit::Models::CustomMetadataFieldCreateResponse` + # custom_metadata_field_create_response => { + # id: id, + # label: label, + # name: name + # } + def deconstruct_keys(keys) + (keys || self.class.known_fields.keys) + .filter_map do |k| + unless self.class.known_fields.key?(k) + next + end + + [k, public_send(k)] + end + .to_h + end + + # @api public + # + # @param a [Object] + # + # @return [String] + def to_json(*a) = Imagekit::Internal::Type::Converter.dump(self.class, self).to_json(*a) + + # @api public + # + # @param a [Object] + # + # @return [String] + def to_yaml(*a) = Imagekit::Internal::Type::Converter.dump(self.class, self).to_yaml(*a) + + # Create a new instance of a model. + # + # @param data [Hash{Symbol=>Object}, self] + def initialize(data = {}) + @data = {} + @coerced = {} + Imagekit::Internal::Util.coerce_hash!(data).each do + if self.class.known_fields.key?(_1) + public_send(:"#{_1}=", _2) + else + @data.store(_1, _2) + @coerced.store(_1, false) + end + end + end + + class << self + # @api private + # + # @param depth [Integer] + # + # @return [String] + def inspect(depth: 0) + return super() if depth.positive? + + depth = depth.succ + deferred = fields.transform_values do |field| + type, required, nilable = field.fetch_values(:type, :required, :nilable) + inspected = [ + Imagekit::Internal::Type::Converter.inspect(type, depth: depth), + !required || nilable ? "nil" : nil + ].compact.join(" | ") + -> { inspected }.tap { _1.define_singleton_method(:inspect) { call } } + end + + "#{name}[#{deferred.inspect}]" + end + end + + # @api public + # + # @return [String] + def to_s = deep_to_h.to_s + + # @api private + # + # @return [String] + def inspect + converted = self.class.recursively_to_h(self, convert: true) + "#<#{self.class}:0x#{object_id.to_s(16)} #{converted}>" + end + + define_sorbet_constant!(:KnownField) do + T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean} } + end + end + end + end +end diff --git a/lib/imagekit/internal/type/base_page.rb b/lib/imagekit/internal/type/base_page.rb new file mode 100644 index 00000000..f216334d --- /dev/null +++ b/lib/imagekit/internal/type/base_page.rb @@ -0,0 +1,55 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + # + # @generic Elem + # + # This module provides a base implementation for paginated responses in the SDK. + module BasePage + # rubocop:disable Lint/UnusedMethodArgument + + # @api public + # + # @return [Boolean] + def next_page? = (raise NotImplementedError) + + # @api public + # + # @raise [Imagekit::Errors::APIError] + # @return [self] + def next_page = (raise NotImplementedError) + + # @api public + # + # @param blk [Proc] + # + # @yieldparam [generic] + # @return [void] + def auto_paging_each(&blk) = (raise NotImplementedError) + + # @return [Enumerable>] + def to_enum = super(:auto_paging_each) + + alias_method :enum_for, :to_enum + + # @api private + # + # @param client [Imagekit::Internal::Transport::BaseClient] + # @param req [Hash{Symbol=>Object}] + # @param headers [Hash{String=>String}, Net::HTTPHeader] + # @param page_data [Object] + def initialize(client:, req:, headers:, page_data:) + @client = client + @req = req + @model = req.fetch(:model) + super() + end + + # rubocop:enable Lint/UnusedMethodArgument + end + end + end +end diff --git a/lib/imagekit/internal/type/boolean.rb b/lib/imagekit/internal/type/boolean.rb new file mode 100644 index 00000000..52ecc971 --- /dev/null +++ b/lib/imagekit/internal/type/boolean.rb @@ -0,0 +1,77 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + # + # @abstract + # + # Ruby has no Boolean class; this is something for models to refer to. + class Boolean + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + private_class_method :new + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def self.===(other) = other == true || other == false + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def self.==(other) = other.is_a?(Class) && other <= Imagekit::Internal::Type::Boolean + + class << self + # @api private + # + # Coerce value to Boolean if possible, otherwise return the original value. + # + # @param value [Boolean, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [Boolean, Object] + def coerce(value, state:) + state.fetch(:exactness)[value == true || value == false ? :yes : :no] += 1 + value + end + + # @!method dump(value, state:) + # @api private + # + # @param value [Boolean, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Boolean, Object] + + # @api private + # + # @return [Object] + def to_sorbet_type + T::Boolean + end + end + end + end + end +end diff --git a/lib/imagekit/internal/type/converter.rb b/lib/imagekit/internal/type/converter.rb new file mode 100644 index 00000000..90a839c6 --- /dev/null +++ b/lib/imagekit/internal/type/converter.rb @@ -0,0 +1,327 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + module Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + # rubocop:disable Lint/UnusedMethodArgument + + # @api private + # + # @param value [Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [Object] + def coerce(value, state:) = (raise NotImplementedError) + + # @api private + # + # @param value [Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Object] + def dump(value, state:) + case value + in Array + value.map { Imagekit::Internal::Type::Unknown.dump(_1, state: state) } + in Hash + value.transform_values { Imagekit::Internal::Type::Unknown.dump(_1, state: state) } + in Imagekit::Internal::Type::BaseModel + value.class.dump(value, state: state) + in StringIO + value.string + in Pathname | IO + state[:can_retry] = false if value.is_a?(IO) + Imagekit::FilePart.new(value) + in Imagekit::FilePart + state[:can_retry] = false if value.content.is_a?(IO) + value + else + value + end + end + + # @api private + # + # @param depth [Integer] + # + # @return [String] + def inspect(depth: 0) + super() + end + + # rubocop:enable Lint/UnusedMethodArgument + + class << self + # @api private + # + # @param spec [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + # + # @return [Proc] + def type_info(spec) + case spec + in Proc + spec + in Hash + type_info(spec.slice(:const, :enum, :union).first&.last) + in true | false + -> { Imagekit::Internal::Type::Boolean } + in Imagekit::Internal::Type::Converter | Class | Symbol + -> { spec } + in NilClass | Integer | Float + -> { spec.class } + end + end + + # @api private + # + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] . + # + # @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option type_info [Proc] :enum + # + # @option type_info [Proc] :union + # + # @option type_info [Boolean] :"nil?" + # + # @param spec [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + # + # @return [Hash{Symbol=>Object}] + def meta_info(type_info, spec) + [spec, type_info].grep(Hash).first.to_h.except(:const, :enum, :union, :nil?) + end + + # @api private + # + # @param translate_names [Boolean] + # + # @return [Hash{Symbol=>Object}] + def new_coerce_state(translate_names: true) + { + translate_names: translate_names, + strictness: true, + exactness: {yes: 0, no: 0, maybe: 0}, + error: nil, + branched: 0 + } + end + + # @api private + # + # Based on `target`, transform `value` into `target`, to the extent possible: + # + # 1. if the given `value` conforms to `target` already, return the given `value` + # 2. if it's possible and safe to convert the given `value` to `target`, then the + # converted value + # 3. otherwise, the given `value` unaltered + # + # The coercion process is subject to improvement between minor release versions. + # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode + # + # @param target [Imagekit::Internal::Type::Converter, Class] + # + # @param value [Object] + # + # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`. This informs the coercion strategy + # when we have to decide between multiple possible conversion targets: + # + # - `true`: the conversion must be exact, with minimum coercion. + # - `false`: the conversion can be approximate, with some coercion. + # + # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For + # any given conversion attempt, the exactness will be updated based on how closely + # the value recursively matches the target type: + # + # - `yes`: the value can be converted to the target type with minimum coercion. + # - `maybe`: the value can be converted to the target type with some reasonable + # coercion. + # - `no`: the value cannot be converted to the target type. + # + # See implementation below for more details. + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [Object] + def coerce(target, value, state: Imagekit::Internal::Type::Converter.new_coerce_state) + # rubocop:disable Metrics/BlockNesting + exactness = state.fetch(:exactness) + + case target + in Imagekit::Internal::Type::Converter + return target.coerce(value, state: state) + in Class + if value.is_a?(target) + exactness[:yes] += 1 + return value + end + + case target + in -> { _1 <= NilClass } + exactness[value.nil? ? :yes : :maybe] += 1 + return nil + in -> { _1 <= Integer } + case value + in Integer + exactness[:yes] += 1 + return value + else + Kernel.then do + return Integer(value).tap { exactness[:maybe] += 1 } + rescue ArgumentError, TypeError => e + state[:error] = e + end + end + in -> { _1 <= Float } + if value.is_a?(Numeric) + exactness[:yes] += 1 + return Float(value) + else + Kernel.then do + return Float(value).tap { exactness[:maybe] += 1 } + rescue ArgumentError, TypeError => e + state[:error] = e + end + end + in -> { _1 <= String } + case value + in String | Symbol | Numeric + exactness[value.is_a?(Numeric) ? :maybe : :yes] += 1 + return value.to_s + in StringIO + exactness[:yes] += 1 + return value.string + else + state[:error] = TypeError.new("#{value.class} can't be coerced into #{String}") + end + in -> { _1 <= Date || _1 <= Time } + Kernel.then do + return target.parse(value).tap { exactness[:yes] += 1 } + rescue ArgumentError, TypeError => e + state[:error] = e + end + in -> { _1 <= StringIO } if value.is_a?(String) + exactness[:yes] += 1 + return StringIO.new(value.b) + else + end + in Symbol + case value + in Symbol | String + if value.to_sym == target + exactness[:yes] += 1 + return target + else + exactness[:maybe] += 1 + return value + end + else + message = "cannot convert non-matching #{value.class} into #{target.inspect}" + state[:error] = ArgumentError.new(message) + end + else + end + + exactness[:no] += 1 + value + # rubocop:enable Metrics/BlockNesting + end + + # @api private + # + # @param target [Imagekit::Internal::Type::Converter, Class] + # + # @param value [Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Object] + def dump(target, value, state: {can_retry: true}) + case target + in Imagekit::Internal::Type::Converter + target.dump(value, state: state) + else + Imagekit::Internal::Type::Unknown.dump(value, state: state) + end + end + + # @api private + # + # @param target [Object] + # @param depth [Integer] + # + # @return [String] + def inspect(target, depth:) + case target + in Imagekit::Internal::Type::Converter + target.inspect(depth: depth.succ) + else + target.inspect + end + end + end + + define_sorbet_constant!(:Input) do + T.type_alias { T.any(Imagekit::Internal::Type::Converter, T::Class[T.anything]) } + end + define_sorbet_constant!(:CoerceState) do + T.type_alias do + { + translate_names: T::Boolean, + strictness: T::Boolean, + exactness: {yes: Integer, no: Integer, maybe: Integer}, + error: T::Class[StandardError], + branched: Integer + } + end + end + define_sorbet_constant!(:DumpState) do + T.type_alias { {can_retry: T::Boolean} } + end + end + end + end +end diff --git a/lib/imagekit/internal/type/enum.rb b/lib/imagekit/internal/type/enum.rb new file mode 100644 index 00000000..95f74db9 --- /dev/null +++ b/lib/imagekit/internal/type/enum.rb @@ -0,0 +1,131 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + # + # A value from among a specified list of options. OpenAPI enum values map to Ruby + # values in the SDK as follows: + # + # 1. boolean => true | false + # 2. integer => Integer + # 3. float => Float + # 4. string => Symbol + # + # We can therefore convert string values to Symbols, but can't convert other + # values safely. + module Enum + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + # All of the valid Symbol values for this enum. + # + # @return [Array] + def values = constants.map { const_get(_1) } + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ===(other) = values.include?(other) + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ==(other) + # rubocop:disable Style/CaseEquality + Imagekit::Internal::Type::Enum === other && other.values.to_set == values.to_set + # rubocop:enable Style/CaseEquality + end + + # @api public + # + # @return [Integer] + def hash = values.to_set.hash + + # @api private + # + # Unlike with primitives, `Enum` additionally validates that the value is a member + # of the enum. + # + # @param value [String, Symbol, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [Symbol, Object] + def coerce(value, state:) + exactness = state.fetch(:exactness) + val = value.is_a?(String) ? value.to_sym : value + + if values.include?(val) + exactness[:yes] += 1 + val + elsif values.first&.class == val.class + exactness[:maybe] += 1 + value + else + exactness[:no] += 1 + state[:error] = TypeError.new("#{value.class} can't be coerced into #{self}") + value + end + end + + # @!method dump(value, state:) + # @api private + # + # @param value [Symbol, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Symbol, Object] + + # @api private + # + # @return [Object] + def to_sorbet_type + types = values.map { Imagekit::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq + case types + in [] + T.noreturn + in [type] + type + else + T.any(*types) + end + end + + # @api private + # + # @param depth [Integer] + # + # @return [String] + def inspect(depth: 0) + if depth.positive? + return is_a?(Module) ? super() : self.class.name + end + + members = values.map { Imagekit::Internal::Type::Converter.inspect(_1, depth: depth.succ) } + prefix = is_a?(Module) ? name : self.class.name + + "#{prefix}[#{members.join(' | ')}]" + end + end + end + end +end diff --git a/lib/imagekit/internal/type/file_input.rb b/lib/imagekit/internal/type/file_input.rb new file mode 100644 index 00000000..125add8f --- /dev/null +++ b/lib/imagekit/internal/type/file_input.rb @@ -0,0 +1,108 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + # + # @abstract + # + # Either `Pathname` or `StringIO`, or `IO`, or + # `Imagekit::Internal::Type::FileInput`. + # + # Note: when `IO` is used, all retries are disabled, since many IO` streams are + # not rewindable. + class FileInput + extend Imagekit::Internal::Type::Converter + + private_class_method :new + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def self.===(other) + case other + in Pathname | StringIO | IO | String | Imagekit::FilePart + true + else + false + end + end + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def self.==(other) = other.is_a?(Class) && other <= Imagekit::Internal::Type::FileInput + + class << self + # @api private + # + # @param value [StringIO, String, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [StringIO, Object] + def coerce(value, state:) + exactness = state.fetch(:exactness) + case value + in String + exactness[:yes] += 1 + StringIO.new(value) + in StringIO + exactness[:yes] += 1 + value + else + state[:error] = TypeError.new("#{value.class} can't be coerced into #{StringIO}") + exactness[:no] += 1 + value + end + end + + # @api private + # + # @param value [Pathname, StringIO, IO, String, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Pathname, StringIO, IO, String, Object] + def dump(value, state:) + # rubocop:disable Lint/DuplicateBranch + case value + in IO + state[:can_retry] = false + in Imagekit::FilePart if value.content.is_a?(IO) + state[:can_retry] = false + else + end + # rubocop:enable Lint/DuplicateBranch + + value + end + + # @api private + # + # @return [Object] + def to_sorbet_type + T.any(Pathname, StringIO, IO, String, Imagekit::FilePart) + end + end + end + end + end +end diff --git a/lib/imagekit/internal/type/hash_of.rb b/lib/imagekit/internal/type/hash_of.rb new file mode 100644 index 00000000..20a0aa22 --- /dev/null +++ b/lib/imagekit/internal/type/hash_of.rb @@ -0,0 +1,188 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + # + # @abstract + # + # @generic Elem + # + # Hash of items of a given type. + class HashOf + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + private_class_method :new + + # @overload [](type_info, spec = {}) + # + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + # + # @return [self] + def self.[](...) = new(...) + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ===(other) + type = item_type + case other + in Hash + other.all? do |key, val| + case [key, val] + in [Symbol | String, ^type] + true + else + false + end + end + else + false + end + end + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ==(other) + # rubocop:disable Layout/LineLength + other.is_a?(Imagekit::Internal::Type::HashOf) && other.nilable? == nilable? && other.item_type == item_type + # rubocop:enable Layout/LineLength + end + + # @api public + # + # @return [Integer] + def hash = [self.class, item_type].hash + + # @api private + # + # @param value [Hash{Object=>Object}, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [Hash{Symbol=>Object}, Object] + def coerce(value, state:) + exactness = state.fetch(:exactness) + + unless value.is_a?(Hash) + exactness[:no] += 1 + state[:error] = TypeError.new("#{value.class} can't be coerced into #{Hash}") + return value + end + + target = item_type + exactness[:yes] += 1 + value + .to_h do |key, val| + k = key.is_a?(String) ? key.to_sym : key + v = + case [nilable?, val] + in [true, nil] + exactness[:yes] += 1 + nil + else + Imagekit::Internal::Type::Converter.coerce(target, val, state: state) + end + + exactness[:no] += 1 unless k.is_a?(Symbol) + [k, v] + end + end + + # @api private + # + # @param value [Hash{Object=>Object}, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Hash{Symbol=>Object}, Object] + def dump(value, state:) + target = item_type + if value.is_a?(Hash) + value.transform_values do + Imagekit::Internal::Type::Converter.dump(target, _1, state: state) + end + else + super + end + end + + # @api private + # + # @return [Object] + def to_sorbet_type + T::Hash[Imagekit::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)] + end + + # @api private + # + # @return [generic] + protected def item_type = @item_type_fn.call + + # @api private + # + # @return [Boolean] + protected def nilable? = @nilable + + # @api private + # + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + def initialize(type_info, spec = {}) + @item_type_fn = Imagekit::Internal::Type::Converter.type_info(type_info || spec) + @meta = Imagekit::Internal::Type::Converter.meta_info(type_info, spec) + @nilable = spec.fetch(:nil?, false) + end + + # @api private + # + # @param depth [Integer] + # + # @return [String] + def inspect(depth: 0) + items = Imagekit::Internal::Type::Converter.inspect(item_type, depth: depth.succ) + + "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]" + end + end + end + end +end diff --git a/lib/imagekit/internal/type/request_parameters.rb b/lib/imagekit/internal/type/request_parameters.rb new file mode 100644 index 00000000..73dff299 --- /dev/null +++ b/lib/imagekit/internal/type/request_parameters.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + module RequestParameters + # @!attribute request_options + # Options to specify HTTP behaviour for this request. + # + # @return [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # @param mod [Module] + def self.included(mod) + raise ArgumentError.new(mod) unless mod <= Imagekit::Internal::Type::BaseModel + + mod.optional(:request_options, Imagekit::RequestOptions) + end + + # @api private + module Converter + # @api private + # + # @param params [Object] + # + # @return [Array(Object, Hash{Symbol=>Object})] + def dump_request(params) + state = {can_retry: true} + case (dumped = dump(params, state: state)) + in Hash + options = Imagekit::Internal::Util.coerce_hash!(dumped[:request_options]).to_h + request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0} + [dumped.except(:request_options), request_options] + else + [dumped, nil] + end + end + end + end + end + end +end diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb new file mode 100644 index 00000000..57d10523 --- /dev/null +++ b/lib/imagekit/internal/type/union.rb @@ -0,0 +1,237 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + module Union + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + # @api private + # + # All of the specified variant info for this union. + # + # @return [ArrayObject})>] + private def known_variants = (@known_variants ||= []) + + # @api private + # + # @return [ArrayObject})>] + protected def derefed_variants + known_variants.map { |key, variant_fn, meta| [key, variant_fn.call, meta] } + end + + # All of the specified variants for this union. + # + # @return [Array] + def variants = derefed_variants.map { _2 } + + # @api private + # + # @param property [Symbol] + private def discriminator(property) + case property + in Symbol + @discriminator = property + end + end + + # @api private + # + # @param key [Symbol, Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + private def variant(key, spec = nil) + meta = Imagekit::Internal::Type::Converter.meta_info(nil, spec) + variant_info = + case key + in Symbol + [key, Imagekit::Internal::Type::Converter.type_info(spec), meta] + in Proc | Imagekit::Internal::Type::Converter | Class | Hash + [nil, Imagekit::Internal::Type::Converter.type_info(key), meta] + end + + known_variants << variant_info + end + + # @api private + # + # @param value [Object] + # + # @return [Imagekit::Internal::Type::Converter, Class, nil] + private def resolve_variant(value) + case [@discriminator, value] + in [_, Imagekit::Internal::Type::BaseModel] + value.class + in [Symbol, Hash] + key = value.fetch(@discriminator) do + value.fetch(@discriminator.to_s, Imagekit::Internal::OMIT) + end + + return nil if key == Imagekit::Internal::OMIT + + key = key.to_sym if key.is_a?(String) + _, found = known_variants.find { |k,| k == key } + found&.call + else + nil + end + end + + # rubocop:disable Style/HashEachMethods + # rubocop:disable Style/CaseEquality + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ===(other) + known_variants.any? do |_, variant_fn| + variant_fn.call === other + end + end + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def ==(other) + Imagekit::Internal::Type::Union === other && other.derefed_variants == derefed_variants + end + + # @api public + # + # @return [Integer] + def hash = variants.hash + + # @api private + # + # Tries to efficiently coerce the given value to one of the known variants. + # + # If the value cannot match any of the known variants, the coercion is considered + # non-viable and returns the original value. + # + # @param value [Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [Object] + def coerce(value, state:) + if (target = resolve_variant(value)) + return Imagekit::Internal::Type::Converter.coerce(target, value, state: state) + end + + strictness = state.fetch(:strictness) + exactness = state.fetch(:exactness) + + alternatives = [] + known_variants.each do |_, variant_fn| + target = variant_fn.call + exact = state[:exactness] = {yes: 0, no: 0, maybe: 0} + state[:branched] += 1 + + coerced = Imagekit::Internal::Type::Converter.coerce(target, value, state: state) + yes, no, maybe = exact.values + if (no + maybe).zero? || (!strictness && yes.positive?) + exact.each { exactness[_1] += _2 } + state[:exactness] = exactness + return coerced + elsif maybe.positive? + alternatives << [[-yes, -maybe, no], exact, coerced] + end + end + + case alternatives.sort_by!(&:first) + in [] + exactness[:no] += 1 + state[:error] = ArgumentError.new("no matching variant for #{value.inspect}") + value + in [[_, exact, coerced], *] + exact.each { exactness[_1] += _2 } + coerced + end + .tap { state[:exactness] = exactness } + ensure + state[:strictness] = strictness + end + + # @api private + # + # @param value [Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Object] + def dump(value, state:) + if (target = resolve_variant(value)) + return Imagekit::Internal::Type::Converter.dump(target, value, state: state) + end + + known_variants.each do + target = _2.call + return Imagekit::Internal::Type::Converter.dump(target, value, state: state) if target === value + end + + super + end + + # @api private + # + # @return [Object] + def to_sorbet_type + types = variants.map { Imagekit::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq + case types + in [] + T.noreturn + in [type] + type + else + T.any(*types) + end + end + + # rubocop:enable Style/CaseEquality + # rubocop:enable Style/HashEachMethods + + # @api private + # + # @param depth [Integer] + # + # @return [String] + def inspect(depth: 0) + if depth.positive? + return is_a?(Module) ? super() : self.class.name + end + + members = variants.map { Imagekit::Internal::Type::Converter.inspect(_1, depth: depth.succ) } + prefix = is_a?(Module) ? name : self.class.name + + "#{prefix}[#{members.join(' | ')}]" + end + end + end + end +end diff --git a/lib/imagekit/internal/type/unknown.rb b/lib/imagekit/internal/type/unknown.rb new file mode 100644 index 00000000..43a4573a --- /dev/null +++ b/lib/imagekit/internal/type/unknown.rb @@ -0,0 +1,81 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + module Type + # @api private + # + # @abstract + # + # When we don't know what to expect for the value. + class Unknown + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + # rubocop:disable Lint/UnusedMethodArgument + + private_class_method :new + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def self.===(other) = true + + # @api public + # + # @param other [Object] + # + # @return [Boolean] + def self.==(other) = other.is_a?(Class) && other <= Imagekit::Internal::Type::Unknown + + class << self + # @api private + # + # No coercion needed for Unknown type. + # + # @param value [Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :translate_names + # + # @option state [Boolean] :strictness + # + # @option state [Hash{Symbol=>Object}] :exactness + # + # @option state [Class] :error + # + # @option state [Integer] :branched + # + # @return [Object] + def coerce(value, state:) + state.fetch(:exactness)[:yes] += 1 + value + end + + # @!method dump(value, state:) + # @api private + # + # @param value [Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Object] + + # @api private + # + # @return [Object] + def to_sorbet_type + T.anything + end + end + + # rubocop:enable Lint/UnusedMethodArgument + end + end + end +end diff --git a/lib/imagekit/internal/util.rb b/lib/imagekit/internal/util.rb new file mode 100644 index 00000000..f1311ffe --- /dev/null +++ b/lib/imagekit/internal/util.rb @@ -0,0 +1,914 @@ +# frozen_string_literal: true + +module Imagekit + module Internal + # @api private + module Util + # @api private + # + # @return [Float] + def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC) + + # @api private + # + # @param ns [Module, Class] + # + # @return [Enumerable] + def self.walk_namespaces(ns) + ns.constants(false).lazy.flat_map do + case (c = ns.const_get(_1, false)) + in Module | Class + walk_namespaces(c) + else + [] + end + end + .chain([ns]) + end + + class << self + # @api private + # + # @return [String] + def arch + case (arch = RbConfig::CONFIG["arch"])&.downcase + in nil + "unknown" + in /aarch64|arm64/ + "arm64" + in /x86_64/ + "x64" + in /arm/ + "arm" + else + "other:#{arch}" + end + end + + # @api private + # + # @return [String] + def os + case (host = RbConfig::CONFIG["host_os"])&.downcase + in nil + "Unknown" + in /linux/ + "Linux" + in /darwin/ + "MacOS" + in /freebsd/ + "FreeBSD" + in /openbsd/ + "OpenBSD" + in /mswin|mingw|cygwin|ucrt/ + "Windows" + else + "Other:#{host}" + end + end + end + + class << self + # @api private + # + # @param input [Object] + # + # @return [Boolean] + def primitive?(input) + case input + in true | false | Numeric | Symbol | String + true + else + false + end + end + + # @api private + # + # @param input [String, Boolean] + # + # @return [Boolean, Object] + def coerce_boolean(input) + case input.is_a?(String) ? input.downcase : input + in "true" + true + in "false" + false + else + input + end + end + + # @api private + # + # @param input [String, Boolean] + # + # @raise [ArgumentError] + # @return [Boolean, nil] + def coerce_boolean!(input) + case coerce_boolean(input) + in true | false | nil => coerced + coerced + else + raise ArgumentError.new("Unable to coerce #{input.inspect} into boolean value") + end + end + + # @api private + # + # @param input [String, Integer] + # + # @return [Integer, Object] + def coerce_integer(input) + Integer(input, exception: false) || input + end + + # @api private + # + # @param input [String, Integer, Float] + # + # @return [Float, Object] + def coerce_float(input) + Float(input, exception: false) || input + end + + # @api private + # + # @param input [Object] + # + # @return [Hash{Object=>Object}, Object] + def coerce_hash(input) + case input + in NilClass | Array | Set | Enumerator | StringIO | IO + input + else + input.respond_to?(:to_h) ? input.to_h : input + end + end + + # @api private + # + # @param input [Object] + # + # @raise [ArgumentError] + # @return [Hash{Object=>Object}, nil] + def coerce_hash!(input) + case coerce_hash(input) + in Hash | nil => coerced + coerced + else + message = "Expected a #{Hash} or #{Imagekit::Internal::Type::BaseModel}, got #{data.inspect}" + raise ArgumentError.new(message) + end + end + end + + class << self + # @api private + # + # @param lhs [Object] + # @param rhs [Object] + # @param concat [Boolean] + # + # @return [Object] + private def deep_merge_lr(lhs, rhs, concat: false) + case [lhs, rhs, concat] + in [Hash, Hash, _] + lhs.merge(rhs) { deep_merge_lr(_2, _3, concat: concat) } + in [Array, Array, true] + lhs.concat(rhs) + else + rhs + end + end + + # @api private + # + # Recursively merge one hash with another. If the values at a given key are not + # both hashes, just take the new value. + # + # @param values [Array] + # + # @param sentinel [Object, nil] the value to return if no values are provided. + # + # @param concat [Boolean] whether to merge sequences by concatenation. + # + # @return [Object] + def deep_merge(*values, sentinel: nil, concat: false) + case values + in [value, *values] + values.reduce(value) do |acc, val| + deep_merge_lr(acc, val, concat: concat) + end + else + sentinel + end + end + + # @api private + # + # @param data [Hash{Symbol=>Object}, Array, Object] + # @param pick [Symbol, Integer, Array, Proc, nil] + # @param blk [Proc, nil] + # + # @return [Object, nil] + def dig(data, pick, &blk) + case [data, pick] + in [_, nil] + data + in [Hash, Symbol] | [Array, Integer] + data.fetch(pick) { blk&.call } + in [Hash | Array, Array] + pick.reduce(data) do |acc, key| + case acc + in Hash if acc.key?(key) + acc.fetch(key) + in Array if key.is_a?(Integer) && key < acc.length + acc[key] + else + return blk&.call + end + end + in [_, Proc] + pick.call(data) + else + blk&.call + end + end + end + + class << self + # @api private + # + # @param uri [URI::Generic] + # + # @return [String] + def uri_origin(uri) + "#{uri.scheme}://#{uri.host}#{uri.port == uri.default_port ? '' : ":#{uri.port}"}" + end + + # @api private + # + # @param path [String, Array] + # + # @return [String] + def interpolate_path(path) + case path + in String + path + in [] + "" + in [String => p, *interpolations] + encoded = interpolations.map { ERB::Util.url_encode(_1) } + format(p, *encoded) + end + end + end + + class << self + # @api private + # + # @param query [String, nil] + # + # @return [Hash{String=>Array}] + def decode_query(query) + CGI.parse(query.to_s) + end + + # @api private + # + # @param query [Hash{String=>Array, String, nil}, nil] + # + # @return [String, nil] + def encode_query(query) + query.to_h.empty? ? nil : URI.encode_www_form(query) + end + end + + class << self + # @api private + # + # @param url [URI::Generic, String] + # + # @return [Hash{Symbol=>String, Integer, nil}] + def parse_uri(url) + parsed = URI::Generic.component.zip(URI.split(url)).to_h + {**parsed, query: decode_query(parsed.fetch(:query))} + end + + # @api private + # + # @param parsed [Hash{Symbol=>String, Integer, nil}] . + # + # @option parsed [String, nil] :scheme + # + # @option parsed [String, nil] :host + # + # @option parsed [Integer, nil] :port + # + # @option parsed [String, nil] :path + # + # @option parsed [Hash{String=>Array}] :query + # + # @return [URI::Generic] + def unparse_uri(parsed) + URI::Generic.build(**parsed, query: encode_query(parsed.fetch(:query))) + end + + # @api private + # + # @param lhs [Hash{Symbol=>String, Integer, nil}] . + # + # @option lhs [String, nil] :scheme + # + # @option lhs [String, nil] :host + # + # @option lhs [Integer, nil] :port + # + # @option lhs [String, nil] :path + # + # @option lhs [Hash{String=>Array}] :query + # + # @param rhs [Hash{Symbol=>String, Integer, nil}] . + # + # @option rhs [String, nil] :scheme + # + # @option rhs [String, nil] :host + # + # @option rhs [Integer, nil] :port + # + # @option rhs [String, nil] :path + # + # @option rhs [Hash{String=>Array}] :query + # + # @return [URI::Generic] + def join_parsed_uri(lhs, rhs) + base_path, base_query = lhs.fetch_values(:path, :query) + slashed = base_path.end_with?("/") ? base_path : "#{base_path}/" + + parsed_path, parsed_query = parse_uri(rhs.fetch(:path)).fetch_values(:path, :query) + override = URI::Generic.build(**rhs.slice(:scheme, :host, :port), path: parsed_path) + + joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override) + query = deep_merge( + joined.path == base_path ? base_query : {}, + parsed_query, + rhs[:query].to_h, + concat: true + ) + + joined.query = encode_query(query) + joined + end + end + + class << self + # @api private + # + # @param headers [Hash{String=>String, Integer, Array, nil}] + # + # @return [Hash{String=>String}] + def normalized_headers(*headers) + {}.merge(*headers.compact).to_h do |key, val| + value = + case val + in Array + val.filter_map { _1&.to_s&.strip }.join(", ") + else + val&.to_s&.strip + end + [key.downcase, value] + end + end + end + + # @api private + # + # An adapter that satisfies the IO interface required by `::IO.copy_stream` + class ReadIOAdapter + # @api private + # + # @return [Boolean, nil] + def close? = @closing + + # @api private + def close + case @stream + in Enumerator + Imagekit::Internal::Util.close_fused!(@stream) + in IO if close? + @stream.close + else + end + end + + # @api private + # + # @param max_len [Integer, nil] + # + # @return [String] + private def read_enum(max_len) + case max_len + in nil + @stream.to_a.join + in Integer + @buf << @stream.next while @buf.length < max_len + @buf.slice!(..max_len) + end + rescue StopIteration + @stream = nil + @buf.slice!(0..) + end + + # @api private + # + # @param max_len [Integer, nil] + # @param out_string [String, nil] + # + # @return [String, nil] + def read(max_len = nil, out_string = nil) + case @stream + in nil + nil + in IO | StringIO + @stream.read(max_len, out_string) + in Enumerator + read = read_enum(max_len) + case out_string + in String + out_string.replace(read) + in nil + read + end + end + .tap(&@blk) + end + + # @api private + # + # @param src [String, Pathname, StringIO, Enumerable] + # @param blk [Proc] + # + # @yieldparam [String] + def initialize(src, &blk) + @stream = + case src + in String + StringIO.new(src) + in Pathname + @closing = true + src.open(binmode: true) + else + src + end + @buf = String.new + @blk = blk + end + end + + class << self + # @param blk [Proc] + # + # @yieldparam [Enumerator::Yielder] + # @return [Enumerable] + def writable_enum(&blk) + Enumerator.new do |y| + buf = String.new + y.define_singleton_method(:write) do + self << buf.replace(_1) + buf.bytesize + end + + blk.call(y) + end + end + end + + # @type [Regexp] + JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)} + # @type [Regexp] + JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)} + + class << self + # @api private + # + # @param y [Enumerator::Yielder] + # @param val [Object] + # @param closing [Array] + # @param content_type [String, nil] + private def write_multipart_content(y, val:, closing:, content_type: nil) + content_line = "Content-Type: %s\r\n\r\n" + + case val + in Imagekit::FilePart + return write_multipart_content( + y, + val: val.content, + closing: closing, + content_type: val.content_type + ) + in Pathname + y << format(content_line, content_type || "application/octet-stream") + io = val.open(binmode: true) + closing << io.method(:close) + IO.copy_stream(io, y) + in IO + y << format(content_line, content_type || "application/octet-stream") + IO.copy_stream(val, y) + in StringIO + y << format(content_line, content_type || "application/octet-stream") + y << val.string + in -> { primitive?(_1) } + y << format(content_line, content_type || "text/plain") + y << val.to_s + else + y << format(content_line, content_type || "application/json") + y << JSON.generate(val) + end + y << "\r\n" + end + + # @api private + # + # @param y [Enumerator::Yielder] + # @param boundary [String] + # @param key [Symbol, String] + # @param val [Object] + # @param closing [Array] + private def write_multipart_chunk(y, boundary:, key:, val:, closing:) + y << "--#{boundary}\r\n" + y << "Content-Disposition: form-data" + + unless key.nil? + name = ERB::Util.url_encode(key.to_s) + y << "; name=\"#{name}\"" + end + + case val + in Imagekit::FilePart unless val.filename.nil? + filename = ERB::Util.url_encode(val.filename) + y << "; filename=\"#{filename}\"" + in Pathname | IO + filename = ERB::Util.url_encode(::File.basename(val.to_path)) + y << "; filename=\"#{filename}\"" + else + end + y << "\r\n" + + write_multipart_content(y, val: val, closing: closing) + end + + # @api private + # + # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content + # + # @param body [Object] + # + # @return [Array(String, Enumerable)] + private def encode_multipart_streaming(body) + boundary = SecureRandom.urlsafe_base64(60) + + closing = [] + strio = writable_enum do |y| + case body + in Hash + body.each do |key, val| + case val + in Array if val.all? { primitive?(_1) } + val.each do |v| + write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing) + end + else + write_multipart_chunk(y, boundary: boundary, key: key, val: val, closing: closing) + end + end + else + write_multipart_chunk(y, boundary: boundary, key: nil, val: body, closing: closing) + end + y << "--#{boundary}--\r\n" + end + + fused_io = fused_enum(strio) { closing.each(&:call) } + [boundary, fused_io] + end + + # @api private + # + # @param headers [Hash{String=>String}] + # @param body [Object] + # + # @return [Object] + def encode_content(headers, body) + # rubocop:disable Style/CaseEquality + # rubocop:disable Layout/LineLength + content_type = headers["content-type"] + case [content_type, body] + in [Imagekit::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }] + [headers, JSON.generate(body)] + in [Imagekit::Internal::Util::JSONL_CONTENT, Enumerable] unless Imagekit::Internal::Type::FileInput === body + [headers, body.lazy.map { JSON.generate(_1) }] + in [%r{^multipart/form-data}, Hash | Imagekit::Internal::Type::FileInput] + boundary, strio = encode_multipart_streaming(body) + headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"} + [headers, strio] + in [_, Symbol | Numeric] + [headers, body.to_s] + in [_, StringIO] + [headers, body.string] + in [_, Imagekit::FilePart] + [headers, body.content] + else + [headers, body] + end + # rubocop:enable Layout/LineLength + # rubocop:enable Style/CaseEquality + end + + # @api private + # + # https://www.iana.org/assignments/character-sets/character-sets.xhtml + # + # @param content_type [String] + # @param text [String] + def force_charset!(content_type, text:) + charset = /charset=([^;\s]+)/.match(content_type)&.captures&.first + + return unless charset + + begin + encoding = Encoding.find(charset) + text.force_encoding(encoding) + rescue ArgumentError + nil + end + end + + # @api private + # + # Assumes each chunk in stream has `Encoding::BINARY`. + # + # @param headers [Hash{String=>String}, Net::HTTPHeader] + # @param stream [Enumerable] + # @param suppress_error [Boolean] + # + # @raise [JSON::ParserError] + # @return [Object] + def decode_content(headers, stream:, suppress_error: false) + case (content_type = headers["content-type"]) + in Imagekit::Internal::Util::JSON_CONTENT + json = stream.to_a.join + begin + JSON.parse(json, symbolize_names: true) + rescue JSON::ParserError => e + raise e unless suppress_error + json + end + in Imagekit::Internal::Util::JSONL_CONTENT + lines = decode_lines(stream) + chain_fused(lines) do |y| + lines.each { y << JSON.parse(_1, symbolize_names: true) } + end + in %r{^text/event-stream} + lines = decode_lines(stream) + decode_sse(lines) + else + text = stream.to_a.join + force_charset!(content_type, text: text) + StringIO.new(text) + end + end + end + + class << self + # @api private + # + # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html + # + # @param enum [Enumerable] + # @param external [Boolean] + # @param close [Proc] + # + # @return [Enumerable] + def fused_enum(enum, external: false, &close) + fused = false + iter = Enumerator.new do |y| + next if fused + + fused = true + if external + loop { y << enum.next } + else + enum.each(&y) + end + ensure + close&.call + close = nil + end + + iter.define_singleton_method(:rewind) do + fused = true + self + end + iter + end + + # @api private + # + # @param enum [Enumerable, nil] + def close_fused!(enum) + return unless enum.is_a?(Enumerator) + + # rubocop:disable Lint/UnreachableLoop + enum.rewind.each { break } + # rubocop:enable Lint/UnreachableLoop + end + + # @api private + # + # @param enum [Enumerable, nil] + # @param blk [Proc] + # + # @yieldparam [Enumerator::Yielder] + # @return [Enumerable] + def chain_fused(enum, &blk) + iter = Enumerator.new { blk.call(_1) } + fused_enum(iter) { close_fused!(enum) } + end + end + + class << self + # @api private + # + # Assumes Strings have been forced into having `Encoding::BINARY`. + # + # This decoder is responsible for reassembling lines split across multiple + # fragments. + # + # @param enum [Enumerable] + # + # @return [Enumerable] + def decode_lines(enum) + re = /(\r\n|\r|\n)/ + buffer = String.new + cr_seen = nil + + chain_fused(enum) do |y| + enum.each do |row| + offset = buffer.bytesize + buffer << row + while (match = re.match(buffer, cr_seen&.to_i || offset)) + case [match.captures.first, cr_seen] + in ["\r", nil] + cr_seen = match.end(1) + next + in ["\r" | "\r\n", Integer] + y << buffer.slice!(..(cr_seen.pred)) + else + y << buffer.slice!(..(match.end(1).pred)) + end + offset = 0 + cr_seen = nil + end + end + + y << buffer.slice!(..(cr_seen.pred)) unless cr_seen.nil? + y << buffer unless buffer.empty? + end + end + + # @api private + # + # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream + # + # Assumes that `lines` has been decoded with `#decode_lines`. + # + # @param lines [Enumerable] + # + # @return [EnumerableObject}>] + def decode_sse(lines) + # rubocop:disable Metrics/BlockLength + chain_fused(lines) do |y| + blank = {event: nil, data: nil, id: nil, retry: nil} + current = {} + + lines.each do |line| + case line.sub(/\R$/, "") + in "" + next if current.empty? + y << {**blank, **current} + current = {} + in /^:/ + next + in /^([^:]+):\s?(.*)$/ + field, value = Regexp.last_match.captures + case field + in "event" + current.merge!(event: value) + in "data" + (current[:data] ||= String.new) << (value << "\n") + in "id" unless value.include?("\0") + current.merge!(id: value) + in "retry" if /^\d+$/ =~ value + current.merge!(retry: Integer(value)) + else + end + else + end + end + # rubocop:enable Metrics/BlockLength + + y << {**blank, **current} unless current.empty? + end + end + end + + # @api private + module SorbetRuntimeSupport + class MissingSorbetRuntimeError < ::RuntimeError + end + + # @api private + # + # @return [Hash{Symbol=>Object}] + private def sorbet_runtime_constants = @sorbet_runtime_constants ||= {} + + # @api private + # + # @param name [Symbol] + def const_missing(name) + super unless sorbet_runtime_constants.key?(name) + + unless Object.const_defined?(:T) + message = "Trying to access a Sorbet constant #{name.inspect} without `sorbet-runtime`." + raise MissingSorbetRuntimeError.new(message) + end + + sorbet_runtime_constants.fetch(name).call + end + + # @api private + # + # @param name [Symbol] + # + # @return [Boolean] + def sorbet_constant_defined?(name) = sorbet_runtime_constants.key?(name) + + # @api private + # + # @param name [Symbol] + # @param blk [Proc] + def define_sorbet_constant!(name, &blk) = sorbet_runtime_constants.store(name, blk) + + # @api private + # + # @return [Object] + def to_sorbet_type = raise NotImplementedError + + class << self + # @api private + # + # @param type [Imagekit::Internal::Util::SorbetRuntimeSupport, Object] + # + # @return [Object] + def to_sorbet_type(type) + case type + in Imagekit::Internal::Util::SorbetRuntimeSupport + type.to_sorbet_type + in Class | Module + type + in true | false + T::Boolean + else + type.class + end + end + end + end + + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + define_sorbet_constant!(:ParsedUri) do + T.type_alias do + { + scheme: T.nilable(String), + host: T.nilable(String), + port: T.nilable(Integer), + path: T.nilable(String), + query: T::Hash[String, T::Array[String]] + } + end + end + + define_sorbet_constant!(:ServerSentEvent) do + T.type_alias do + { + event: T.nilable(String), + data: T.nilable(String), + id: T.nilable(String), + retry: T.nilable(Integer) + } + end + end + end + end +end diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb new file mode 100644 index 00000000..c069dc8d --- /dev/null +++ b/lib/imagekit/models.rb @@ -0,0 +1,93 @@ +# frozen_string_literal: true + +module Imagekit + [Imagekit::Internal::Type::BaseModel, *Imagekit::Internal::Type::BaseModel.subclasses].each do |cls| + cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Imagekit::Internal::AnyHash) } } + end + + Imagekit::Internal::Util.walk_namespaces(Imagekit::Models).each do |mod| + case mod + in Imagekit::Internal::Type::Enum | Imagekit::Internal::Type::Union + mod.constants.each do |name| + case mod.const_get(name) + in true | false + mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } } + mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } } + in Integer + mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } } + mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } } + in Float + mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } } + mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } } + in Symbol + mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } } + mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } } + else + end + end + else + end + end + + Imagekit::Internal::Util.walk_namespaces(Imagekit::Models) + .lazy + .grep(Imagekit::Internal::Type::Union) + .each do |mod| + const = :Variants + next if mod.sorbet_constant_defined?(const) + + mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } } + end + + AccountGetUsageParams = Imagekit::Models::AccountGetUsageParams + + BulkJobCopyFolderParams = Imagekit::Models::BulkJobCopyFolderParams + + BulkJobMoveFolderParams = Imagekit::Models::BulkJobMoveFolderParams + + BulkJobRetrieveStatusParams = Imagekit::Models::BulkJobRetrieveStatusParams + + CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams + + CustomMetadataFieldDeleteParams = Imagekit::Models::CustomMetadataFieldDeleteParams + + CustomMetadataFieldListParams = Imagekit::Models::CustomMetadataFieldListParams + + CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + + ExifDetails = Imagekit::Models::ExifDetails + + ExifImage = Imagekit::Models::ExifImage + + FileAddTagsParams = Imagekit::Models::FileAddTagsParams + + FileCopyParams = Imagekit::Models::FileCopyParams + + FileDeleteParams = Imagekit::Models::FileDeleteParams + + FileListParams = Imagekit::Models::FileListParams + + FileMoveParams = Imagekit::Models::FileMoveParams + + FileRemoveAITagsParams = Imagekit::Models::FileRemoveAITagsParams + + FileRemoveTagsParams = Imagekit::Models::FileRemoveTagsParams + + FileRenameParams = Imagekit::Models::FileRenameParams + + Files = Imagekit::Models::Files + + FileUploadV1Params = Imagekit::Models::FileUploadV1Params + + FileUploadV2Params = Imagekit::Models::FileUploadV2Params + + FolderCreateParams = Imagekit::Models::FolderCreateParams + + FolderDeleteParams = Imagekit::Models::FolderDeleteParams + + Gps = Imagekit::Models::Gps + + Interoperability = Imagekit::Models::Interoperability + + Thumbnail = Imagekit::Models::Thumbnail +end diff --git a/lib/imagekit/models/account_get_usage_params.rb b/lib/imagekit/models/account_get_usage_params.rb new file mode 100644 index 00000000..4e8a36b2 --- /dev/null +++ b/lib/imagekit/models/account_get_usage_params.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Accounts#get_usage + class AccountGetUsageParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute end_date + # 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. + # + # @return [Date] + required :end_date, Date + + # @!attribute start_date + # 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 [Date] + required :start_date, Date + + # @!method initialize(end_date:, start_date:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::AccountGetUsageParams} for more details. + # + # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. + # + # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/account_get_usage_response.rb b/lib/imagekit/models/account_get_usage_response.rb new file mode 100644 index 00000000..fa485ceb --- /dev/null +++ b/lib/imagekit/models/account_get_usage_response.rb @@ -0,0 +1,49 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Accounts#get_usage + class AccountGetUsageResponse < Imagekit::Internal::Type::BaseModel + # @!attribute bandwidth_bytes + # Amount of bandwidth used in bytes. + # + # @return [Integer, nil] + optional :bandwidth_bytes, Integer, api_name: :bandwidthBytes + + # @!attribute extension_units_count + # Number of extension units used. + # + # @return [Integer, nil] + optional :extension_units_count, Integer, api_name: :extensionUnitsCount + + # @!attribute media_library_storage_bytes + # Storage used by media library in bytes. + # + # @return [Integer, nil] + optional :media_library_storage_bytes, Integer, api_name: :mediaLibraryStorageBytes + + # @!attribute original_cache_storage_bytes + # Storage used by the original cache in bytes. + # + # @return [Integer, nil] + optional :original_cache_storage_bytes, Integer, api_name: :originalCacheStorageBytes + + # @!attribute video_processing_units_count + # Number of video processing units used. + # + # @return [Integer, nil] + optional :video_processing_units_count, Integer, api_name: :videoProcessingUnitsCount + + # @!method initialize(bandwidth_bytes: nil, extension_units_count: nil, media_library_storage_bytes: nil, original_cache_storage_bytes: nil, video_processing_units_count: nil) + # @param bandwidth_bytes [Integer] Amount of bandwidth used in bytes. + # + # @param extension_units_count [Integer] Number of extension units used. + # + # @param media_library_storage_bytes [Integer] Storage used by media library in bytes. + # + # @param original_cache_storage_bytes [Integer] Storage used by the original cache in bytes. + # + # @param video_processing_units_count [Integer] Number of video processing units used. + end + end +end diff --git a/lib/imagekit/models/bulk_job_copy_folder_params.rb b/lib/imagekit/models/bulk_job_copy_folder_params.rb new file mode 100644 index 00000000..d3423e13 --- /dev/null +++ b/lib/imagekit/models/bulk_job_copy_folder_params.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::BulkJobs#copy_folder + class BulkJobCopyFolderParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute destination_path + # Full path to the destination folder where you want to copy the source folder + # into. + # + # @return [String] + required :destination_path, String, api_name: :destinationPath + + # @!attribute source_folder_path + # The full path to the source folder you want to copy. + # + # @return [String] + required :source_folder_path, String, api_name: :sourceFolderPath + + # @!attribute include_versions + # 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 [Boolean, nil] + optional :include_versions, Imagekit::Internal::Type::Boolean, api_name: :includeVersions + + # @!method initialize(destination_path:, source_folder_path:, include_versions: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::BulkJobCopyFolderParams} for more details. + # + # @param destination_path [String] Full path to the destination folder where you want to copy the source folder int + # + # @param source_folder_path [String] The full path to the source folder you want to copy. + # + # @param include_versions [Boolean] Option to copy all versions of files that are nested inside the selected folder. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/bulk_job_copy_folder_response.rb b/lib/imagekit/models/bulk_job_copy_folder_response.rb new file mode 100644 index 00000000..7f90b5b9 --- /dev/null +++ b/lib/imagekit/models/bulk_job_copy_folder_response.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::BulkJobs#copy_folder + class BulkJobCopyFolderResponse < Imagekit::Internal::Type::BaseModel + # @!attribute job_id + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + # + # @return [String, nil] + optional :job_id, String, api_name: :jobId + + # @!method initialize(job_id: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::BulkJobCopyFolderResponse} for more details. + # + # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b + end + end +end diff --git a/lib/imagekit/models/bulk_job_move_folder_params.rb b/lib/imagekit/models/bulk_job_move_folder_params.rb new file mode 100644 index 00000000..7fd5d3b8 --- /dev/null +++ b/lib/imagekit/models/bulk_job_move_folder_params.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::BulkJobs#move_folder + class BulkJobMoveFolderParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute destination_path + # Full path to the destination folder where you want to move the source folder + # into. + # + # @return [String] + required :destination_path, String, api_name: :destinationPath + + # @!attribute source_folder_path + # The full path to the source folder you want to move. + # + # @return [String] + required :source_folder_path, String, api_name: :sourceFolderPath + + # @!method initialize(destination_path:, source_folder_path:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::BulkJobMoveFolderParams} for more details. + # + # @param destination_path [String] Full path to the destination folder where you want to move the source folder int + # + # @param source_folder_path [String] The full path to the source folder you want to move. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/bulk_job_move_folder_response.rb b/lib/imagekit/models/bulk_job_move_folder_response.rb new file mode 100644 index 00000000..a84345e6 --- /dev/null +++ b/lib/imagekit/models/bulk_job_move_folder_response.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::BulkJobs#move_folder + class BulkJobMoveFolderResponse < Imagekit::Internal::Type::BaseModel + # @!attribute job_id + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + # + # @return [String, nil] + optional :job_id, String, api_name: :jobId + + # @!method initialize(job_id: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::BulkJobMoveFolderResponse} for more details. + # + # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b + end + end +end diff --git a/lib/imagekit/models/bulk_job_retrieve_status_params.rb b/lib/imagekit/models/bulk_job_retrieve_status_params.rb new file mode 100644 index 00000000..d9630d07 --- /dev/null +++ b/lib/imagekit/models/bulk_job_retrieve_status_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::BulkJobs#retrieve_status + class BulkJobRetrieveStatusParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/bulk_job_retrieve_status_response.rb b/lib/imagekit/models/bulk_job_retrieve_status_response.rb new file mode 100644 index 00000000..742f9dd8 --- /dev/null +++ b/lib/imagekit/models/bulk_job_retrieve_status_response.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::BulkJobs#retrieve_status + class BulkJobRetrieveStatusResponse < Imagekit::Internal::Type::BaseModel + # @!attribute job_id + # Unique identifier of the bulk job. + # + # @return [String, nil] + optional :job_id, String, api_name: :jobId + + # @!attribute status + # Status of the bulk job. Possible values - `Pending`, `Completed`. + # + # @return [String, nil] + optional :status, String + + # @!attribute type + # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`. + # + # @return [String, nil] + optional :type, String + + # @!method initialize(job_id: nil, status: nil, type: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::BulkJobRetrieveStatusResponse} for more details. + # + # @param job_id [String] Unique identifier of the bulk job. + # + # @param status [String] Status of the bulk job. Possible values - `Pending`, `Completed`. + # + # @param type [String] Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`. + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field_create_params.rb b/lib/imagekit/models/custom_metadata_field_create_params.rb new file mode 100644 index 00000000..eb1ff5a4 --- /dev/null +++ b/lib/imagekit/models/custom_metadata_field_create_params.rb @@ -0,0 +1,238 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::CustomMetadataFields#create + class CustomMetadataFieldCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute 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. + # + # @return [String] + required :label, String + + # @!attribute name + # API name of the custom metadata field. This should be unique across all + # (including deleted) custom metadata fields. + # + # @return [String] + required :name, String + + # @!attribute schema + # + # @return [Imagekit::Models::CustomMetadataFieldCreateParams::Schema] + required :schema, -> { Imagekit::CustomMetadataFieldCreateParams::Schema } + + # @!method initialize(label:, name:, schema:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldCreateParams} for more details. + # + # @param label [String] Human readable name of the custom metadata field. This should be unique across a + # + # @param name [String] API name of the custom metadata field. This should be unique across all (includi + # + # @param schema [Imagekit::Models::CustomMetadataFieldCreateParams::Schema] + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + class Schema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::CustomMetadataFieldCreateParams::Schema::Type] + required :type, enum: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::Type } + + # @!attribute default_value + # 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. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # 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. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue }, + api_name: :minValue + + # @!attribute select_options + # An array of allowed values. This property is only required if `type` property is + # set to `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption] + }, + api_name: :selectOptions + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldCreateParams::Schema} for more details. + # + # @param type [Symbol, Imagekit::Models::CustomMetadataFieldCreateParams::Schema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. This property is only required + # + # @param is_value_required [Boolean] Sets this custom metadata field as required. Setting custom metadata fields on a + # + # @param max_length [Float] Maximum length of string. Only set this property if `type` is set to `Text` or ` + # + # @param max_value [String, Float] Maximum value of the field. Only set this property if field type is `Date` or `N + # + # @param min_length [Float] Minimum length of string. Only set this property if `type` is set to `Text` or ` + # + # @param min_value [String, Float] Minimum value of the field. Only set this property if field type is `Date` or `N + # + # @param select_options [Array] An array of allowed values. This property is only required if `type` property is + + # Type of the custom metadata field. + # + # @see Imagekit::Models::CustomMetadataFieldCreateParams::Schema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXT_AREA = :TextArea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldCreateParams::Schema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3Array } + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + UnionMember3Array = + Imagekit::Internal::Type::ArrayOf[union: -> { + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3 + }] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldCreateParams::Schema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldCreateParams::Schema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field_create_response.rb b/lib/imagekit/models/custom_metadata_field_create_response.rb new file mode 100644 index 00000000..a1531d9f --- /dev/null +++ b/lib/imagekit/models/custom_metadata_field_create_response.rb @@ -0,0 +1,235 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::CustomMetadataFields#create + class CustomMetadataFieldCreateResponse < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the custom metadata field. Use this to update the field. + # + # @return [String] + required :id, String + + # @!attribute label + # 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. + # + # @return [String] + required :label, String + + # @!attribute name + # 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. + # + # @return [String] + required :name, String + + # @!attribute schema + # An object that describes the rules for the custom metadata field value. + # + # @return [Imagekit::Models::CustomMetadataFieldCreateResponse::Schema] + required :schema, -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema } + + # @!method initialize(id:, label:, name:, schema:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldCreateResponse} for more details. + # + # Object containing details of a custom metadata field. + # + # @param id [String] Unique identifier for the custom metadata field. Use this to update the field. + # + # @param label [String] Human readable name of the custom metadata field. This name is displayed as form + # + # @param name [String] API name of the custom metadata field. This becomes the key while setting `custo + # + # @param schema [Imagekit::Models::CustomMetadataFieldCreateResponse::Schema] An object that describes the rules for the custom metadata field value. + + # @see Imagekit::Models::CustomMetadataFieldCreateResponse#schema + class Schema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type] + required :type, enum: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the this custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue }, + api_name: :minValue + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption] }, + api_name: :selectOptions + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldCreateResponse::Schema} for more details. + # + # An object that describes the rules for the custom metadata field value. + # + # @param type [Symbol, Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Date type of default value dep + # + # @param is_value_required [Boolean] Specifies if the this custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + + # Type of the custom metadata field. + # + # @see Imagekit::Models::CustomMetadataFieldCreateResponse::Schema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXT_AREA = :TextArea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + # + # @see Imagekit::Models::CustomMetadataFieldCreateResponse::Schema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3Array } + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + UnionMember3Array = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3 }] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldCreateResponse::Schema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldCreateResponse::Schema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field_delete_params.rb b/lib/imagekit/models/custom_metadata_field_delete_params.rb new file mode 100644 index 00000000..21af3d9c --- /dev/null +++ b/lib/imagekit/models/custom_metadata_field_delete_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::CustomMetadataFields#delete + class CustomMetadataFieldDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field_delete_response.rb b/lib/imagekit/models/custom_metadata_field_delete_response.rb new file mode 100644 index 00000000..2ac7ffbe --- /dev/null +++ b/lib/imagekit/models/custom_metadata_field_delete_response.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @type [Imagekit::Internal::Type::Converter] + CustomMetadataFieldDeleteResponse = Imagekit::Internal::Type::Unknown + end +end diff --git a/lib/imagekit/models/custom_metadata_field_list_params.rb b/lib/imagekit/models/custom_metadata_field_list_params.rb new file mode 100644 index 00000000..96fcabba --- /dev/null +++ b/lib/imagekit/models/custom_metadata_field_list_params.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::CustomMetadataFields#list + class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute include_deleted + # Set it to `true` to include deleted field objects in the API response. Default + # value is `false`. + # + # @return [Boolean, nil] + optional :include_deleted, Imagekit::Internal::Type::Boolean + + # @!method initialize(include_deleted: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldListParams} for more details. + # + # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. Default v + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field_list_response.rb b/lib/imagekit/models/custom_metadata_field_list_response.rb new file mode 100644 index 00000000..5e57b78d --- /dev/null +++ b/lib/imagekit/models/custom_metadata_field_list_response.rb @@ -0,0 +1,239 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class CustomMetadataFieldListResponseItem < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the custom metadata field. Use this to update the field. + # + # @return [String] + required :id, String + + # @!attribute label + # 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. + # + # @return [String] + required :label, String + + # @!attribute name + # 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. + # + # @return [String] + required :name, String + + # @!attribute schema + # An object that describes the rules for the custom metadata field value. + # + # @return [Imagekit::Models::CustomMetadataFieldListResponseItem::Schema] + required :schema, -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema } + + # @!method initialize(id:, label:, name:, schema:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldListResponseItem} for more details. + # + # Object containing details of a custom metadata field. + # + # @param id [String] Unique identifier for the custom metadata field. Use this to update the field. + # + # @param label [String] Human readable name of the custom metadata field. This name is displayed as form + # + # @param name [String] API name of the custom metadata field. This becomes the key while setting `custo + # + # @param schema [Imagekit::Models::CustomMetadataFieldListResponseItem::Schema] An object that describes the rules for the custom metadata field value. + + # @see Imagekit::Models::CustomMetadataFieldListResponseItem#schema + class Schema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type] + required :type, enum: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the this custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue }, + api_name: :minValue + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption] }, + api_name: :selectOptions + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldListResponseItem::Schema} for more + # details. + # + # An object that describes the rules for the custom metadata field value. + # + # @param type [Symbol, Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Date type of default value dep + # + # @param is_value_required [Boolean] Specifies if the this custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + + # Type of the custom metadata field. + # + # @see Imagekit::Models::CustomMetadataFieldListResponseItem::Schema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXT_AREA = :TextArea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + # + # @see Imagekit::Models::CustomMetadataFieldListResponseItem::Schema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3Array } + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + UnionMember3Array = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3 }] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldListResponseItem::Schema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldListResponseItem::Schema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + end + + # @type [Imagekit::Internal::Type::Converter] + CustomMetadataFieldListResponse = + Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Models::CustomMetadataFieldListResponseItem }] + end +end diff --git a/lib/imagekit/models/custom_metadata_field_update_params.rb b/lib/imagekit/models/custom_metadata_field_update_params.rb new file mode 100644 index 00000000..25a71fc3 --- /dev/null +++ b/lib/imagekit/models/custom_metadata_field_update_params.rb @@ -0,0 +1,212 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::CustomMetadataFields#update + class CustomMetadataFieldUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute 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. + # + # @return [String, nil] + optional :label, String + + # @!attribute 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 [Imagekit::Models::CustomMetadataFieldUpdateParams::Schema, nil] + optional :schema, -> { Imagekit::CustomMetadataFieldUpdateParams::Schema } + + # @!method initialize(label: nil, schema: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldUpdateParams} for more details. + # + # @param label [String] Human readable name of the custom metadata field. This should be unique across a + # + # @param schema [Imagekit::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + class Schema < Imagekit::Internal::Type::BaseModel + # @!attribute default_value + # 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. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # 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. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue }, + api_name: :minValue + + # @!attribute select_options + # An array of allowed values. This property is only required if `type` property is + # set to `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption] + }, + api_name: :selectOptions + + # @!method initialize(default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldUpdateParams::Schema} for more details. + # + # 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`. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. This property is only required + # + # @param is_value_required [Boolean] Sets this custom metadata field as required. Setting custom metadata fields on a + # + # @param max_length [Float] Maximum length of string. Only set this property if `type` is set to `Text` or ` + # + # @param max_value [String, Float] Maximum value of the field. Only set this property if field type is `Date` or `N + # + # @param min_length [Float] Minimum length of string. Only set this property if `type` is set to `Text` or ` + # + # @param min_value [String, Float] Minimum value of the field. Only set this property if field type is `Date` or `N + # + # @param select_options [Array] An array of allowed values. This property is only required if `type` property is + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldUpdateParams::Schema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3Array } + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + UnionMember3Array = + Imagekit::Internal::Type::ArrayOf[union: -> { + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3 + }] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldUpdateParams::Schema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldUpdateParams::Schema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field_update_response.rb b/lib/imagekit/models/custom_metadata_field_update_response.rb new file mode 100644 index 00000000..0c8edba4 --- /dev/null +++ b/lib/imagekit/models/custom_metadata_field_update_response.rb @@ -0,0 +1,235 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::CustomMetadataFields#update + class CustomMetadataFieldUpdateResponse < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the custom metadata field. Use this to update the field. + # + # @return [String] + required :id, String + + # @!attribute label + # 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. + # + # @return [String] + required :label, String + + # @!attribute name + # 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. + # + # @return [String] + required :name, String + + # @!attribute schema + # An object that describes the rules for the custom metadata field value. + # + # @return [Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema] + required :schema, -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema } + + # @!method initialize(id:, label:, name:, schema:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldUpdateResponse} for more details. + # + # Object containing details of a custom metadata field. + # + # @param id [String] Unique identifier for the custom metadata field. Use this to update the field. + # + # @param label [String] Human readable name of the custom metadata field. This name is displayed as form + # + # @param name [String] API name of the custom metadata field. This becomes the key while setting `custo + # + # @param schema [Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema] An object that describes the rules for the custom metadata field value. + + # @see Imagekit::Models::CustomMetadataFieldUpdateResponse#schema + class Schema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type] + required :type, enum: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the this custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue }, + api_name: :minValue + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption] }, + api_name: :selectOptions + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema} for more details. + # + # An object that describes the rules for the custom metadata field value. + # + # @param type [Symbol, Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Date type of default value dep + # + # @param is_value_required [Boolean] Specifies if the this custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + + # Type of the custom metadata field. + # + # @see Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXT_AREA = :TextArea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + # + # @see Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3Array } + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + UnionMember3Array = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3 }] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + end + end +end diff --git a/lib/imagekit/models/exif_details.rb b/lib/imagekit/models/exif_details.rb new file mode 100644 index 00000000..e6af5a2c --- /dev/null +++ b/lib/imagekit/models/exif_details.rb @@ -0,0 +1,167 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class ExifDetails < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + end +end diff --git a/lib/imagekit/models/exif_image.rb b/lib/imagekit/models/exif_image.rb new file mode 100644 index 00000000..df6a92ed --- /dev/null +++ b/lib/imagekit/models/exif_image.rb @@ -0,0 +1,77 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class ExifImage < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + end +end diff --git a/lib/imagekit/models/file_add_tags_params.rb b/lib/imagekit/models/file_add_tags_params.rb new file mode 100644 index 00000000..cda4768d --- /dev/null +++ b/lib/imagekit/models/file_add_tags_params.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#add_tags + class FileAddTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_ids + # An array of fileIds to which you want to add tags. + # + # @return [Array] + required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + + # @!attribute tags + # An array of tags that you want to add to the files. + # + # @return [Array] + required :tags, Imagekit::Internal::Type::ArrayOf[String] + + # @!method initialize(file_ids:, tags:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileAddTagsParams} for more details. + # + # @param file_ids [Array] An array of fileIds to which you want to add tags. + # + # @param tags [Array] An array of tags that you want to add to the files. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/file_add_tags_response.rb b/lib/imagekit/models/file_add_tags_response.rb new file mode 100644 index 00000000..9acee917 --- /dev/null +++ b/lib/imagekit/models/file_add_tags_response.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#add_tags + class FileAddTagsResponse < Imagekit::Internal::Type::BaseModel + # @!attribute successfully_updated_file_ids + # An array of fileIds that in which tags were successfully added. + # + # @return [Array, nil] + optional :successfully_updated_file_ids, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :successfullyUpdatedFileIds + + # @!method initialize(successfully_updated_file_ids: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileAddTagsResponse} for more details. + # + # @param successfully_updated_file_ids [Array] An array of fileIds that in which tags were successfully added. + end + end +end diff --git a/lib/imagekit/models/file_copy_params.rb b/lib/imagekit/models/file_copy_params.rb new file mode 100644 index 00000000..3a481b8d --- /dev/null +++ b/lib/imagekit/models/file_copy_params.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#copy + class FileCopyParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute destination_path + # Full path to the folder you want to copy the above file into. + # + # @return [String] + required :destination_path, String, api_name: :destinationPath + + # @!attribute source_file_path + # The full path of the file you want to copy. + # + # @return [String] + required :source_file_path, String, api_name: :sourceFilePath + + # @!attribute include_file_versions + # 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 [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + + # @!method initialize(destination_path:, source_file_path:, include_file_versions: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileCopyParams} for more details. + # + # @param destination_path [String] Full path to the folder you want to copy the above file into. + # + # @param source_file_path [String] The full path of the file you want to copy. + # + # @param include_file_versions [Boolean] Option to copy all versions of a file. By default, only the current version of t + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/file_copy_response.rb b/lib/imagekit/models/file_copy_response.rb new file mode 100644 index 00000000..671bd8a6 --- /dev/null +++ b/lib/imagekit/models/file_copy_response.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @type [Imagekit::Internal::Type::Converter] + FileCopyResponse = Imagekit::Internal::Type::Unknown + end +end diff --git a/lib/imagekit/models/file_delete_params.rb b/lib/imagekit/models/file_delete_params.rb new file mode 100644 index 00000000..7de513c4 --- /dev/null +++ b/lib/imagekit/models/file_delete_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#delete + class FileDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/file_list_params.rb b/lib/imagekit/models/file_list_params.rb new file mode 100644 index 00000000..707faf1d --- /dev/null +++ b/lib/imagekit/models/file_list_params.rb @@ -0,0 +1,130 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#list + class FileListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_type + # Type of files to include in the result set. Accepts three values: + # + # `all` - include all types of files in the result set. `image` - only search in + # image type files. `non-image` - only search in files that are not images, e.g., + # JS or CSS or video files. + # + # Default value - `all` + # + # @return [String, nil] + optional :file_type, String + + # @!attribute limit + # The maximum number of results to return in response: + # + # Minimum value - 1 + # + # Maximum value - 1000 + # + # Default value - 1000 + # + # @return [String, nil] + optional :limit, String + + # @!attribute path + # Folder path if you want to limit the search within a specific folder. For + # example, `/sales-banner/` will only search in folder sales-banner. + # + # @return [String, nil] + optional :path, String + + # @!attribute search_query + # 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. + # + # @return [String, nil] + optional :search_query, String + + # @!attribute skip + # The number of results to skip before returning results: + # + # Minimum value - 0 + # + # Default value - 0 + # + # @return [String, nil] + optional :skip, String + + # @!attribute sort + # You can sort based on the following fields: + # + # 1. name - `ASC_NAME` or `DESC_NAME` + # 2. createdAt - `ASC_CREATED` or `DESC_CREATED` + # 3. updatedAt - `ASC_UPDATED` or `DESC_UPDATED` + # 4. height - `ASC_HEIGHT` or `DESC_HEIGHT` + # 5. width - `ASC_WIDTH` or `DESC_WIDTH` + # 6. size - `ASC_SIZE` or `DESC_SIZE` + # + # Default value - `ASC_CREATED` + # + # @return [String, nil] + optional :sort, String + + # @!attribute type + # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to + # include `files` and `folders` in search results (`file-version` will not be + # included in this case). + # + # Default value - `file` + # + # @return [Symbol, Imagekit::Models::FileListParams::Type, nil] + optional :type, enum: -> { Imagekit::FileListParams::Type } + + # @!method initialize(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileListParams} for more details. + # + # @param file_type [String] Type of files to include in the result set. Accepts three values: + # + # @param limit [String] The maximum number of results to return in response: + # + # @param path [String] Folder path if you want to limit the search within a specific folder. For exampl + # + # @param search_query [String] Query string in a Lucene-like query language e.g. `createdAt > "7d"`. + # + # @param skip [String] The number of results to skip before returning results: + # + # @param sort [String] You can sort based on the following fields: + # + # @param type [Symbol, Imagekit::Models::FileListParams::Type] Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to includ + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to + # include `files` and `folders` in search results (`file-version` will not be + # included in this case). + # + # Default value - `file` + module Type + extend Imagekit::Internal::Type::Enum + + FILE = :file + FILE_VERSION = :"file-version" + FOLDER = :folder + ALL = :all + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/file_list_response.rb b/lib/imagekit/models/file_list_response.rb new file mode 100644 index 00000000..b980eeef --- /dev/null +++ b/lib/imagekit/models/file_list_response.rb @@ -0,0 +1,247 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class FileListResponseItem < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileListResponseItem::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute created_at + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :created_at, String, api_name: :createdAt + + # @!attribute custom_coordinates + # An string with custom coordinates of the file. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # An object with custom metadata for the file. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute file_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # 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`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute has_alpha + # Specifies if the image has an alpha channel. + # + # @return [Boolean, nil] + optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha + + # @!attribute height + # Height of the file. + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # Specifies if the file is private or not. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # Specifies if the file is published or not. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute mime + # MIME type of the file. + # + # @return [String, nil] + optional :mime, String + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the file in bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + # + # @return [String, nil] + optional :thumbnail, String + + # @!attribute type + # Type of the asset. + # + # @return [String, nil] + optional :type, String + + # @!attribute updated_at + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :updated_at, String, api_name: :updatedAt + + # @!attribute url + # URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object with details of the file version. + # + # @return [Imagekit::Models::FileListResponseItem::VersionInfo, nil] + optional :version_info, -> { Imagekit::Models::FileListResponseItem::VersionInfo }, api_name: :versionInfo + + # @!attribute width + # Width of the file. + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileListResponseItem} for more details. + # + # Object containing details of a file or file version. + # + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # + # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # + # @param custom_coordinates [String, nil] An string with custom coordinates of the file. + # + # @param custom_metadata [Object] An object with custom metadata for the file. + # + # @param file_id [String] Unique identifier of the asset. + # + # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. + # + # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. + # + # @param has_alpha [Boolean] Specifies if the image has an alpha channel. + # + # @param height [Float] Height of the file. + # + # @param is_private_file [Boolean] Specifies if the file is private or not. + # + # @param is_published [Boolean] Specifies if the file is published or not. + # + # @param mime [String] MIME type of the file. + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the file in bytes. + # + # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi + # + # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th + # + # @param type [String] Type of the asset. + # + # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # + # @param url [String] URL of the file. + # + # @param version_info [Imagekit::Models::FileListResponseItem::VersionInfo] An object with details of the file version. + # + # @param width [Float] Width of the file. + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileListResponseItem::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi + end + + # @see Imagekit::Models::FileListResponseItem#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object with details of the file version. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + + # @type [Imagekit::Internal::Type::Converter] + FileListResponse = Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Models::FileListResponseItem }] + end +end diff --git a/lib/imagekit/models/file_move_params.rb b/lib/imagekit/models/file_move_params.rb new file mode 100644 index 00000000..7af578f1 --- /dev/null +++ b/lib/imagekit/models/file_move_params.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#move + class FileMoveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute destination_path + # Full path to the folder you want to move the above file into. + # + # @return [String] + required :destination_path, String, api_name: :destinationPath + + # @!attribute source_file_path + # The full path of the file you want to move. + # + # @return [String] + required :source_file_path, String, api_name: :sourceFilePath + + # @!method initialize(destination_path:, source_file_path:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileMoveParams} for more details. + # + # @param destination_path [String] Full path to the folder you want to move the above file into. + # + # @param source_file_path [String] The full path of the file you want to move. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/file_move_response.rb b/lib/imagekit/models/file_move_response.rb new file mode 100644 index 00000000..d854a7e0 --- /dev/null +++ b/lib/imagekit/models/file_move_response.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @type [Imagekit::Internal::Type::Converter] + FileMoveResponse = Imagekit::Internal::Type::Unknown + end +end diff --git a/lib/imagekit/models/file_remove_ai_tags_params.rb b/lib/imagekit/models/file_remove_ai_tags_params.rb new file mode 100644 index 00000000..65abf4da --- /dev/null +++ b/lib/imagekit/models/file_remove_ai_tags_params.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#remove_ai_tags + class FileRemoveAITagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute ai_tags + # An array of AITags that you want to remove from the files. + # + # @return [Array] + required :ai_tags, Imagekit::Internal::Type::ArrayOf[String], api_name: :AITags + + # @!attribute file_ids + # An array of fileIds from which you want to remove AITags. + # + # @return [Array] + required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + + # @!method initialize(ai_tags:, file_ids:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRemoveAITagsParams} for more details. + # + # @param ai_tags [Array] An array of AITags that you want to remove from the files. + # + # @param file_ids [Array] An array of fileIds from which you want to remove AITags. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/file_remove_ai_tags_response.rb b/lib/imagekit/models/file_remove_ai_tags_response.rb new file mode 100644 index 00000000..43146302 --- /dev/null +++ b/lib/imagekit/models/file_remove_ai_tags_response.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#remove_ai_tags + class FileRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + # @!attribute successfully_updated_file_ids + # An array of fileIds that in which AITags were successfully removed. + # + # @return [Array, nil] + optional :successfully_updated_file_ids, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :successfullyUpdatedFileIds + + # @!method initialize(successfully_updated_file_ids: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRemoveAITagsResponse} for more details. + # + # @param successfully_updated_file_ids [Array] An array of fileIds that in which AITags were successfully removed. + end + end +end diff --git a/lib/imagekit/models/file_remove_tags_params.rb b/lib/imagekit/models/file_remove_tags_params.rb new file mode 100644 index 00000000..542ac7ce --- /dev/null +++ b/lib/imagekit/models/file_remove_tags_params.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#remove_tags + class FileRemoveTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_ids + # An array of fileIds from which you want to remove tags. + # + # @return [Array] + required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + + # @!attribute tags + # An array of tags that you want to remove from the files. + # + # @return [Array] + required :tags, Imagekit::Internal::Type::ArrayOf[String] + + # @!method initialize(file_ids:, tags:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRemoveTagsParams} for more details. + # + # @param file_ids [Array] An array of fileIds from which you want to remove tags. + # + # @param tags [Array] An array of tags that you want to remove from the files. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/file_remove_tags_response.rb b/lib/imagekit/models/file_remove_tags_response.rb new file mode 100644 index 00000000..1b230522 --- /dev/null +++ b/lib/imagekit/models/file_remove_tags_response.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#remove_tags + class FileRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + # @!attribute successfully_updated_file_ids + # An array of fileIds that in which tags were successfully removed. + # + # @return [Array, nil] + optional :successfully_updated_file_ids, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :successfullyUpdatedFileIds + + # @!method initialize(successfully_updated_file_ids: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRemoveTagsResponse} for more details. + # + # @param successfully_updated_file_ids [Array] An array of fileIds that in which tags were successfully removed. + end + end +end diff --git a/lib/imagekit/models/file_rename_params.rb b/lib/imagekit/models/file_rename_params.rb new file mode 100644 index 00000000..692440d6 --- /dev/null +++ b/lib/imagekit/models/file_rename_params.rb @@ -0,0 +1,61 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#rename + class FileRenameParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_path + # The full path of the file you want to rename. + # + # @return [String] + required :file_path, String, api_name: :filePath + + # @!attribute new_file_name + # 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 `_`. + # + # @return [String] + required :new_file_name, String, api_name: :newFileName + + # @!attribute purge_cache + # 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` + # + # @return [Boolean, nil] + optional :purge_cache, Imagekit::Internal::Type::Boolean, api_name: :purgeCache + + # @!method initialize(file_path:, new_file_name:, purge_cache: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRenameParams} for more details. + # + # @param file_path [String] The full path of the file you want to rename. + # + # @param new_file_name [String] The new name of the file. A filename can contain: + # + # @param purge_cache [Boolean] Option to purge cache for the old file and its versions' URLs. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/file_rename_response.rb b/lib/imagekit/models/file_rename_response.rb new file mode 100644 index 00000000..96b9be0e --- /dev/null +++ b/lib/imagekit/models/file_rename_response.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#rename + class FileRenameResponse < Imagekit::Internal::Type::BaseModel + # @!attribute purge_request_id + # Unique identifier of the purge request. This can be used to check the status of + # the purge request. + # + # @return [String, nil] + optional :purge_request_id, String, api_name: :purgeRequestId + + # @!method initialize(purge_request_id: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRenameResponse} for more details. + # + # @param purge_request_id [String] Unique identifier of the purge request. This can be used to check the status of + end + end +end diff --git a/lib/imagekit/models/file_upload_v1_params.rb b/lib/imagekit/models/file_upload_v1_params.rb new file mode 100644 index 00000000..75d18edd --- /dev/null +++ b/lib/imagekit/models/file_upload_v1_params.rb @@ -0,0 +1,384 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#upload_v1 + class FileUploadV1Params < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file + # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, + # please ensure that our servers can access the URL. In case ImageKit is unable to + # download the file from the specified URL, a `400` error response is returned. + # This will also result in a `400` error if the file download request is aborted + # if response headers are not received in 8 seconds. + # + # @return [String] + required :file, String + + # @!attribute file_name + # 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 `_` + # + # @return [String] + required :file_name, String, api_name: :fileName + + # @!attribute 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. + # + # @return [String, nil] + optional :token, String + + # @!attribute 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). + # + # @return [String, nil] + optional :checks, String + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates + + # @!attribute custom_metadata + # Stringified JSON key-value data to be associated with the asset. + # + # @return [String, nil] + optional :custom_metadata, String, api_name: :customMetadata + + # @!attribute 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. + # + # @return [String, nil] + optional :expire, String + + # @!attribute extensions + # Stringified JSON object with an array of extensions to be applied to the image. + # Refer to extensions schema in + # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + # + # @return [String, nil] + optional :extensions, String + + # @!attribute 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. + # + # @return [String, nil] + optional :folder, String + + # @!attribute is_private_file + # 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. + # + # @return [Symbol, Imagekit::Models::FileUploadV1Params::IsPrivateFile, nil] + optional :is_private_file, + enum: -> { Imagekit::FileUploadV1Params::IsPrivateFile }, + api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Symbol, Imagekit::Models::FileUploadV1Params::IsPublished, nil] + optional :is_published, enum: -> { Imagekit::FileUploadV1Params::IsPublished }, api_name: :isPublished + + # @!attribute overwrite_ai_tags + # 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. + # + # @return [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteAITags, nil] + optional :overwrite_ai_tags, + enum: -> { Imagekit::FileUploadV1Params::OverwriteAITags }, + api_name: :overwriteAITags + + # @!attribute overwrite_custom_metadata + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + # + # @return [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteCustomMetadata, nil] + optional :overwrite_custom_metadata, + enum: -> { Imagekit::FileUploadV1Params::OverwriteCustomMetadata }, + api_name: :overwriteCustomMetadata + + # @!attribute overwrite_file + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + # + # @return [String, nil] + optional :overwrite_file, String, api_name: :overwriteFile + + # @!attribute overwrite_tags + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + # + # @return [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteTags, nil] + optional :overwrite_tags, + enum: -> { Imagekit::FileUploadV1Params::OverwriteTags }, + api_name: :overwriteTags + + # @!attribute public_key + # Your ImageKit.io public key. This field is only required for authentication when + # uploading a file from the client side. + # + # @return [String, nil] + optional :public_key, String, api_name: :publicKey + + # @!attribute response_fields + # Comma-separated values of the fields that you want the API to return in the + # response. + # + # For example, set the value of this field to + # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, + # `customCoordinates`, and `isPrivateFile` in the response. + # + # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, + # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + # + # @return [String, nil] + optional :response_fields, String, api_name: :responseFields + + # @!attribute 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. + # + # @return [String, nil] + optional :signature, String + + # @!attribute tags + # Set the tags while uploading the file. + # + # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length + # of all characters should not exceed 500. `%` is not allowed. + # + # If this field is not specified and the file is overwritten then the tags will be + # removed. + # + # @return [String, nil] + optional :tags, String + + # @!attribute transformation + # Stringified JSON object with properties for pre and post transformations: + # + # `pre` - Accepts a "string" containing a valid transformation used for requesting + # a pre-transformation for an image or a video file. + # + # `post` - Accepts an array of objects with properties: + # + # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` + # (Adaptive bitrate streaming). + # - `value`: A "string" corresponding to the required transformation. Required if + # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or + # `thumbnail`. + # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # + # Read more about + # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + # + # @return [String, nil] + optional :transformation, String + + # @!attribute use_unique_file_name + # 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. + # + # @return [Symbol, Imagekit::Models::FileUploadV1Params::UseUniqueFileName, nil] + optional :use_unique_file_name, + enum: -> { Imagekit::FileUploadV1Params::UseUniqueFileName }, + api_name: :useUniqueFileName + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadV1Params} for more details. + # + # @param file [String] Pass the HTTP URL or base64 string. When passing a URL in the file parameter, pl + # + # @param file_name [String] The name with which the file has to be uploaded. + # + # @param token [String] A unique value that the ImageKit.io server will use to recognize and prevent sub + # + # @param checks [String] Server-side checks to run on the asset. + # + # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file + # + # @param custom_metadata [String] Stringified JSON key-value data to be associated with the asset. + # + # @param expire [String] The time until your signature is valid. It must be a [Unix time](https://en.wiki + # + # @param extensions [String] Stringified JSON object with an array of extensions to be applied to the image. + # + # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e + # + # @param is_private_file [Symbol, Imagekit::Models::FileUploadV1Params::IsPrivateFile] Whether to mark the file as private or not. + # + # @param is_published [Symbol, Imagekit::Models::FileUploadV1Params::IsPublished] Whether to upload file as published or not. + # + # @param overwrite_ai_tags [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteAITags] If set to `true` and a file already exists at the exact location, its AITags wil + # + # @param overwrite_custom_metadata [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteCustomMetadata] If the request does not have `customMetadata`, and a file already exists at the + # + # @param overwrite_file [String] If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # + # @param overwrite_tags [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteTags] If the request does not have `tags`, and a file already exists at the exact loca + # + # @param public_key [String] Your ImageKit.io public key. This field is only required for authentication when + # + # @param response_fields [String] Comma-separated values of the fields that you want the API to return in the resp + # + # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a + # + # @param tags [String] Set the tags while uploading the file. + # + # @param transformation [String] Stringified JSON object with properties for pre and post transformations: + # + # @param use_unique_file_name [Symbol, Imagekit::Models::FileUploadV1Params::UseUniqueFileName] Whether to use a unique filename for this file or not. + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # 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. + module IsPrivateFile + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # 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. + module IsPublished + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # 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. + module OverwriteAITags + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + module OverwriteCustomMetadata + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + module OverwriteTags + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # 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. + module UseUniqueFileName + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/file_upload_v1_response.rb b/lib/imagekit/models/file_upload_v1_response.rb new file mode 100644 index 00000000..a79613e3 --- /dev/null +++ b/lib/imagekit/models/file_upload_v1_response.rb @@ -0,0 +1,1706 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#upload_v1 + class FileUploadV1Response < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the uploaded file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadV1Response::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # 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. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute embedded_metadata + # 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. + # + # @return [Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, nil] + optional :embedded_metadata, + -> { Imagekit::Models::FileUploadV1Response::EmbeddedMetadata }, + api_name: :embeddedMetadata + + # @!attribute extension_status + # 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. + # + # @return [Imagekit::Models::FileUploadV1Response::ExtensionStatus, nil] + optional :extension_status, + -> { Imagekit::Models::FileUploadV1Response::ExtensionStatus }, + api_name: :extensionStatus + + # @!attribute file_id + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute height + # Height of the image in pixels (Only for images) + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # 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. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute metadata + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @return [Imagekit::Models::FileUploadV1Response::Metadata, nil] + optional :metadata, -> { Imagekit::Models::FileUploadV1Response::Metadata } + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the image file in Bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # 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. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail_url + # In the case of an image, a small thumbnail URL. + # + # @return [String, nil] + optional :thumbnail_url, String, api_name: :thumbnailUrl + + # @!attribute url + # A publicly accessible URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @return [Imagekit::Models::FileUploadV1Response::VersionInfo, nil] + optional :version_info, -> { Imagekit::Models::FileUploadV1Response::VersionInfo }, api_name: :versionInfo + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # Width of the image in pixels (Only for Images) + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadV1Response} for more details. + # + # Object containing details of a successful upload. + # + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h + # + # @param custom_metadata [Object] A key-value data associated with the asset. Use `responseField` in API request t + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param embedded_metadata [Imagekit::Models::FileUploadV1Response::EmbeddedMetadata] Consolidated embedded metadata associated with the file. It includes exif, iptc, + # + # @param extension_status [Imagekit::Models::FileUploadV1Response::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # + # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo + # + # @param file_path [String] The relative path of the file in the media library e.g. `/marketing-assets/new-b + # + # @param file_type [String] Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @param height [Float] Height of the image in pixels (Only for images) + # + # @param is_private_file [Boolean] Is the file marked as private. It can be either `true` or `false`. Send `isPriva + # + # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen + # + # @param metadata [Imagekit::Models::FileUploadV1Response::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the image file in Bytes. + # + # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul + # + # @param thumbnail_url [String] In the case of an image, a small thumbnail URL. + # + # @param url [String] A publicly accessible URL of the file. + # + # @param version_info [Imagekit::Models::FileUploadV1Response::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Float] Width of the image in pixels (Only for Images) + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # 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. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadV1Response::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be + end + + # @see Imagekit::Models::FileUploadV1Response#embedded_metadata + class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel + # @!attribute about_cv_term_cv_id + # + # @return [String, nil] + optional :about_cv_term_cv_id, String, api_name: :AboutCvTermCvId + + # @!attribute about_cv_term_id + # + # @return [String, nil] + optional :about_cv_term_id, String, api_name: :AboutCvTermId + + # @!attribute about_cv_term_name + # + # @return [String, nil] + optional :about_cv_term_name, String, api_name: :AboutCvTermName + + # @!attribute about_cv_term_refined_about + # + # @return [String, nil] + optional :about_cv_term_refined_about, String, api_name: :AboutCvTermRefinedAbout + + # @!attribute additional_model_information + # + # @return [String, nil] + optional :additional_model_information, String, api_name: :AdditionalModelInformation + + # @!attribute application_record_version + # + # @return [Integer, nil] + optional :application_record_version, Integer, api_name: :ApplicationRecordVersion + + # @!attribute artist + # + # @return [String, nil] + optional :artist, String, api_name: :Artist + + # @!attribute artwork_circa_date_created + # + # @return [String, nil] + optional :artwork_circa_date_created, String, api_name: :ArtworkCircaDateCreated + + # @!attribute artwork_content_description + # + # @return [String, nil] + optional :artwork_content_description, String, api_name: :ArtworkContentDescription + + # @!attribute artwork_contribution_description + # + # @return [String, nil] + optional :artwork_contribution_description, String, api_name: :ArtworkContributionDescription + + # @!attribute artwork_copyright_notice + # + # @return [String, nil] + optional :artwork_copyright_notice, String, api_name: :ArtworkCopyrightNotice + + # @!attribute artwork_copyright_owner_id + # + # @return [String, nil] + optional :artwork_copyright_owner_id, String, api_name: :ArtworkCopyrightOwnerID + + # @!attribute artwork_copyright_owner_name + # + # @return [String, nil] + optional :artwork_copyright_owner_name, String, api_name: :ArtworkCopyrightOwnerName + + # @!attribute artwork_creator + # + # @return [Array, nil] + optional :artwork_creator, Imagekit::Internal::Type::ArrayOf[String], api_name: :ArtworkCreator + + # @!attribute artwork_creator_id + # + # @return [Array, nil] + optional :artwork_creator_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ArtworkCreatorID + + # @!attribute artwork_date_created + # + # @return [Time, nil] + optional :artwork_date_created, Time, api_name: :ArtworkDateCreated + + # @!attribute artwork_licensor_id + # + # @return [String, nil] + optional :artwork_licensor_id, String, api_name: :ArtworkLicensorID + + # @!attribute artwork_licensor_name + # + # @return [String, nil] + optional :artwork_licensor_name, String, api_name: :ArtworkLicensorName + + # @!attribute artwork_physical_description + # + # @return [String, nil] + optional :artwork_physical_description, String, api_name: :ArtworkPhysicalDescription + + # @!attribute artwork_source + # + # @return [String, nil] + optional :artwork_source, String, api_name: :ArtworkSource + + # @!attribute artwork_source_inventory_no + # + # @return [String, nil] + optional :artwork_source_inventory_no, String, api_name: :ArtworkSourceInventoryNo + + # @!attribute artwork_source_inv_url + # + # @return [String, nil] + optional :artwork_source_inv_url, String, api_name: :ArtworkSourceInvURL + + # @!attribute artwork_style_period + # + # @return [Array, nil] + optional :artwork_style_period, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ArtworkStylePeriod + + # @!attribute artwork_title + # + # @return [String, nil] + optional :artwork_title, String, api_name: :ArtworkTitle + + # @!attribute authors_position + # + # @return [String, nil] + optional :authors_position, String, api_name: :AuthorsPosition + + # @!attribute byline + # + # @return [String, nil] + optional :byline, String, api_name: :Byline + + # @!attribute byline_title + # + # @return [String, nil] + optional :byline_title, String, api_name: :BylineTitle + + # @!attribute caption + # + # @return [String, nil] + optional :caption, String, api_name: :Caption + + # @!attribute caption_abstract + # + # @return [String, nil] + optional :caption_abstract, String, api_name: :CaptionAbstract + + # @!attribute caption_writer + # + # @return [String, nil] + optional :caption_writer, String, api_name: :CaptionWriter + + # @!attribute city + # + # @return [String, nil] + optional :city, String, api_name: :City + + # @!attribute color_space + # + # @return [String, nil] + optional :color_space, String, api_name: :ColorSpace + + # @!attribute components_configuration + # + # @return [String, nil] + optional :components_configuration, String, api_name: :ComponentsConfiguration + + # @!attribute copyright + # + # @return [String, nil] + optional :copyright, String, api_name: :Copyright + + # @!attribute copyright_notice + # + # @return [String, nil] + optional :copyright_notice, String, api_name: :CopyrightNotice + + # @!attribute copyright_owner_id + # + # @return [Array, nil] + optional :copyright_owner_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :CopyrightOwnerID + + # @!attribute copyright_owner_name + # + # @return [Array, nil] + optional :copyright_owner_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :CopyrightOwnerName + + # @!attribute country + # + # @return [String, nil] + optional :country, String, api_name: :Country + + # @!attribute country_code + # + # @return [String, nil] + optional :country_code, String, api_name: :CountryCode + + # @!attribute country_primary_location_code + # + # @return [String, nil] + optional :country_primary_location_code, String, api_name: :CountryPrimaryLocationCode + + # @!attribute country_primary_location_name + # + # @return [String, nil] + optional :country_primary_location_name, String, api_name: :CountryPrimaryLocationName + + # @!attribute creator + # + # @return [String, nil] + optional :creator, String, api_name: :Creator + + # @!attribute creator_address + # + # @return [String, nil] + optional :creator_address, String, api_name: :CreatorAddress + + # @!attribute creator_city + # + # @return [String, nil] + optional :creator_city, String, api_name: :CreatorCity + + # @!attribute creator_country + # + # @return [String, nil] + optional :creator_country, String, api_name: :CreatorCountry + + # @!attribute creator_postal_code + # + # @return [String, nil] + optional :creator_postal_code, String, api_name: :CreatorPostalCode + + # @!attribute creator_region + # + # @return [String, nil] + optional :creator_region, String, api_name: :CreatorRegion + + # @!attribute creator_work_email + # + # @return [String, nil] + optional :creator_work_email, String, api_name: :CreatorWorkEmail + + # @!attribute creator_work_telephone + # + # @return [String, nil] + optional :creator_work_telephone, String, api_name: :CreatorWorkTelephone + + # @!attribute creator_work_url + # + # @return [String, nil] + optional :creator_work_url, String, api_name: :CreatorWorkURL + + # @!attribute credit + # + # @return [String, nil] + optional :credit, String, api_name: :Credit + + # @!attribute date_created + # + # @return [Time, nil] + optional :date_created, Time, api_name: :DateCreated + + # @!attribute date_time_created + # + # @return [Time, nil] + optional :date_time_created, Time, api_name: :DateTimeCreated + + # @!attribute date_time_original + # + # @return [Time, nil] + optional :date_time_original, Time, api_name: :DateTimeOriginal + + # @!attribute description + # + # @return [String, nil] + optional :description, String, api_name: :Description + + # @!attribute digital_image_guid + # + # @return [String, nil] + optional :digital_image_guid, String, api_name: :DigitalImageGUID + + # @!attribute digital_source_type + # + # @return [String, nil] + optional :digital_source_type, String, api_name: :DigitalSourceType + + # @!attribute embedded_encoded_rights_expr + # + # @return [String, nil] + optional :embedded_encoded_rights_expr, String, api_name: :EmbeddedEncodedRightsExpr + + # @!attribute embedded_encoded_rights_expr_lang_id + # + # @return [String, nil] + optional :embedded_encoded_rights_expr_lang_id, String, api_name: :EmbeddedEncodedRightsExprLangID + + # @!attribute embedded_encoded_rights_expr_type + # + # @return [String, nil] + optional :embedded_encoded_rights_expr_type, String, api_name: :EmbeddedEncodedRightsExprType + + # @!attribute event + # + # @return [String, nil] + optional :event, String, api_name: :Event + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute genre_cv_id + # + # @return [String, nil] + optional :genre_cv_id, String, api_name: :GenreCvId + + # @!attribute genre_cv_term_id + # + # @return [String, nil] + optional :genre_cv_term_id, String, api_name: :GenreCvTermId + + # @!attribute genre_cv_term_name + # + # @return [String, nil] + optional :genre_cv_term_name, String, api_name: :GenreCvTermName + + # @!attribute genre_cv_term_refined_about + # + # @return [String, nil] + optional :genre_cv_term_refined_about, String, api_name: :GenreCvTermRefinedAbout + + # @!attribute headline + # + # @return [String, nil] + optional :headline, String, api_name: :Headline + + # @!attribute image_creator_id + # + # @return [String, nil] + optional :image_creator_id, String, api_name: :ImageCreatorID + + # @!attribute image_creator_image_id + # + # @return [String, nil] + optional :image_creator_image_id, String, api_name: :ImageCreatorImageID + + # @!attribute image_creator_name + # + # @return [String, nil] + optional :image_creator_name, String, api_name: :ImageCreatorName + + # @!attribute image_description + # + # @return [String, nil] + optional :image_description, String, api_name: :ImageDescription + + # @!attribute image_region_boundary_h + # + # @return [Array, nil] + optional :image_region_boundary_h, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryH + + # @!attribute image_region_boundary_rx + # + # @return [Array, nil] + optional :image_region_boundary_rx, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryRx + + # @!attribute image_region_boundary_shape + # + # @return [Array, nil] + optional :image_region_boundary_shape, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionBoundaryShape + + # @!attribute image_region_boundary_unit + # + # @return [Array, nil] + optional :image_region_boundary_unit, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionBoundaryUnit + + # @!attribute image_region_boundary_vertices_x + # + # @return [Array, nil] + optional :image_region_boundary_vertices_x, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryVerticesX + + # @!attribute image_region_boundary_vertices_y + # + # @return [Array, nil] + optional :image_region_boundary_vertices_y, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryVerticesY + + # @!attribute image_region_boundary_w + # + # @return [Array, nil] + optional :image_region_boundary_w, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryW + + # @!attribute image_region_boundary_x + # + # @return [Array, nil] + optional :image_region_boundary_x, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryX + + # @!attribute image_region_boundary_y + # + # @return [Array, nil] + optional :image_region_boundary_y, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryY + + # @!attribute image_region_ctype_identifier + # + # @return [Array, nil] + optional :image_region_ctype_identifier, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionCtypeIdentifier + + # @!attribute image_region_ctype_name + # + # @return [Array, nil] + optional :image_region_ctype_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionCtypeName + + # @!attribute image_region_id + # + # @return [Array, nil] + optional :image_region_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ImageRegionID + + # @!attribute image_region_name + # + # @return [Array, nil] + optional :image_region_name, Imagekit::Internal::Type::ArrayOf[String], api_name: :ImageRegionName + + # @!attribute image_region_organisation_in_image_name + # + # @return [Array, nil] + optional :image_region_organisation_in_image_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionOrganisationInImageName + + # @!attribute image_region_person_in_image + # + # @return [Array, nil] + optional :image_region_person_in_image, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionPersonInImage + + # @!attribute image_region_role_identifier + # + # @return [Array, nil] + optional :image_region_role_identifier, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionRoleIdentifier + + # @!attribute image_region_role_name + # + # @return [Array, nil] + optional :image_region_role_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionRoleName + + # @!attribute image_supplier_id + # + # @return [String, nil] + optional :image_supplier_id, String, api_name: :ImageSupplierID + + # @!attribute image_supplier_image_id + # + # @return [String, nil] + optional :image_supplier_image_id, String, api_name: :ImageSupplierImageID + + # @!attribute image_supplier_name + # + # @return [String, nil] + optional :image_supplier_name, String, api_name: :ImageSupplierName + + # @!attribute instructions + # + # @return [String, nil] + optional :instructions, String, api_name: :Instructions + + # @!attribute intellectual_genre + # + # @return [String, nil] + optional :intellectual_genre, String, api_name: :IntellectualGenre + + # @!attribute keywords + # + # @return [Array, nil] + optional :keywords, Imagekit::Internal::Type::ArrayOf[String], api_name: :Keywords + + # @!attribute licensor_city + # + # @return [Array, nil] + optional :licensor_city, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorCity + + # @!attribute licensor_country + # + # @return [Array, nil] + optional :licensor_country, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorCountry + + # @!attribute licensor_email + # + # @return [Array, nil] + optional :licensor_email, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorEmail + + # @!attribute licensor_extended_address + # + # @return [Array, nil] + optional :licensor_extended_address, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorExtendedAddress + + # @!attribute licensor_id + # + # @return [Array, nil] + optional :licensor_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorID + + # @!attribute licensor_name + # + # @return [Array, nil] + optional :licensor_name, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorName + + # @!attribute licensor_postal_code + # + # @return [Array, nil] + optional :licensor_postal_code, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorPostalCode + + # @!attribute licensor_region + # + # @return [Array, nil] + optional :licensor_region, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorRegion + + # @!attribute licensor_street_address + # + # @return [Array, nil] + optional :licensor_street_address, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorStreetAddress + + # @!attribute licensor_telephone1 + # + # @return [Array, nil] + optional :licensor_telephone1, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorTelephone1 + + # @!attribute licensor_telephone2 + # + # @return [Array, nil] + optional :licensor_telephone2, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorTelephone2 + + # @!attribute licensor_url + # + # @return [Array, nil] + optional :licensor_url, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorURL + + # @!attribute linked_encoded_rights_expr + # + # @return [String, nil] + optional :linked_encoded_rights_expr, String, api_name: :LinkedEncodedRightsExpr + + # @!attribute linked_encoded_rights_expr_lang_id + # + # @return [String, nil] + optional :linked_encoded_rights_expr_lang_id, String, api_name: :LinkedEncodedRightsExprLangID + + # @!attribute linked_encoded_rights_expr_type + # + # @return [String, nil] + optional :linked_encoded_rights_expr_type, String, api_name: :LinkedEncodedRightsExprType + + # @!attribute location + # + # @return [String, nil] + optional :location, String, api_name: :Location + + # @!attribute location_created_city + # + # @return [String, nil] + optional :location_created_city, String, api_name: :LocationCreatedCity + + # @!attribute location_created_country_code + # + # @return [String, nil] + optional :location_created_country_code, String, api_name: :LocationCreatedCountryCode + + # @!attribute location_created_country_name + # + # @return [String, nil] + optional :location_created_country_name, String, api_name: :LocationCreatedCountryName + + # @!attribute location_created_gps_altitude + # + # @return [String, nil] + optional :location_created_gps_altitude, String, api_name: :LocationCreatedGPSAltitude + + # @!attribute location_created_gps_latitude + # + # @return [String, nil] + optional :location_created_gps_latitude, String, api_name: :LocationCreatedGPSLatitude + + # @!attribute location_created_gps_longitude + # + # @return [String, nil] + optional :location_created_gps_longitude, String, api_name: :LocationCreatedGPSLongitude + + # @!attribute location_created_location_id + # + # @return [String, nil] + optional :location_created_location_id, String, api_name: :LocationCreatedLocationId + + # @!attribute location_created_location_name + # + # @return [String, nil] + optional :location_created_location_name, String, api_name: :LocationCreatedLocationName + + # @!attribute location_created_province_state + # + # @return [String, nil] + optional :location_created_province_state, String, api_name: :LocationCreatedProvinceState + + # @!attribute location_created_sublocation + # + # @return [String, nil] + optional :location_created_sublocation, String, api_name: :LocationCreatedSublocation + + # @!attribute location_created_world_region + # + # @return [String, nil] + optional :location_created_world_region, String, api_name: :LocationCreatedWorldRegion + + # @!attribute location_shown_city + # + # @return [Array, nil] + optional :location_shown_city, Imagekit::Internal::Type::ArrayOf[String], api_name: :LocationShownCity + + # @!attribute location_shown_country_code + # + # @return [Array, nil] + optional :location_shown_country_code, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownCountryCode + + # @!attribute location_shown_country_name + # + # @return [Array, nil] + optional :location_shown_country_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownCountryName + + # @!attribute location_shown_gps_altitude + # + # @return [Array, nil] + optional :location_shown_gps_altitude, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownGPSAltitude + + # @!attribute location_shown_gps_latitude + # + # @return [Array, nil] + optional :location_shown_gps_latitude, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownGPSLatitude + + # @!attribute location_shown_gps_longitude + # + # @return [Array, nil] + optional :location_shown_gps_longitude, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownGPSLongitude + + # @!attribute location_shown_location_id + # + # @return [Array, nil] + optional :location_shown_location_id, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownLocationId + + # @!attribute location_shown_location_name + # + # @return [Array, nil] + optional :location_shown_location_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownLocationName + + # @!attribute location_shown_province_state + # + # @return [Array, nil] + optional :location_shown_province_state, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownProvinceState + + # @!attribute location_shown_sublocation + # + # @return [Array, nil] + optional :location_shown_sublocation, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownSublocation + + # @!attribute location_shown_world_region + # + # @return [Array, nil] + optional :location_shown_world_region, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownWorldRegion + + # @!attribute max_avail_height + # + # @return [Float, nil] + optional :max_avail_height, Float, api_name: :MaxAvailHeight + + # @!attribute max_avail_width + # + # @return [Float, nil] + optional :max_avail_width, Float, api_name: :MaxAvailWidth + + # @!attribute model_age + # + # @return [Array, nil] + optional :model_age, Imagekit::Internal::Type::ArrayOf[Float], api_name: :ModelAge + + # @!attribute model_release_id + # + # @return [Array, nil] + optional :model_release_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ModelReleaseID + + # @!attribute object_attribute_reference + # + # @return [String, nil] + optional :object_attribute_reference, String, api_name: :ObjectAttributeReference + + # @!attribute object_name + # + # @return [String, nil] + optional :object_name, String, api_name: :ObjectName + + # @!attribute offset_time_original + # + # @return [String, nil] + optional :offset_time_original, String, api_name: :OffsetTimeOriginal + + # @!attribute organisation_in_image_code + # + # @return [Array, nil] + optional :organisation_in_image_code, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :OrganisationInImageCode + + # @!attribute organisation_in_image_name + # + # @return [Array, nil] + optional :organisation_in_image_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :OrganisationInImageName + + # @!attribute orientation + # + # @return [String, nil] + optional :orientation, String, api_name: :Orientation + + # @!attribute original_transmission_reference + # + # @return [String, nil] + optional :original_transmission_reference, String, api_name: :OriginalTransmissionReference + + # @!attribute person_in_image + # + # @return [Array, nil] + optional :person_in_image, Imagekit::Internal::Type::ArrayOf[String], api_name: :PersonInImage + + # @!attribute person_in_image_cv_term_cv_id + # + # @return [Array, nil] + optional :person_in_image_cv_term_cv_id, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageCvTermCvId + + # @!attribute person_in_image_cv_term_id + # + # @return [Array, nil] + optional :person_in_image_cv_term_id, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageCvTermId + + # @!attribute person_in_image_cv_term_name + # + # @return [Array, nil] + optional :person_in_image_cv_term_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageCvTermName + + # @!attribute person_in_image_cv_term_refined_about + # + # @return [Array, nil] + optional :person_in_image_cv_term_refined_about, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageCvTermRefinedAbout + + # @!attribute person_in_image_description + # + # @return [Array, nil] + optional :person_in_image_description, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageDescription + + # @!attribute person_in_image_id + # + # @return [Array, nil] + optional :person_in_image_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :PersonInImageId + + # @!attribute person_in_image_name + # + # @return [Array, nil] + optional :person_in_image_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageName + + # @!attribute product_in_image_description + # + # @return [Array, nil] + optional :product_in_image_description, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ProductInImageDescription + + # @!attribute product_in_image_gtin + # + # @return [Array, nil] + optional :product_in_image_gtin, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ProductInImageGTIN + + # @!attribute product_in_image_name + # + # @return [Array, nil] + optional :product_in_image_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ProductInImageName + + # @!attribute property_release_id + # + # @return [Array, nil] + optional :property_release_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :PropertyReleaseID + + # @!attribute province_state + # + # @return [String, nil] + optional :province_state, String, api_name: :ProvinceState + + # @!attribute rating + # + # @return [Integer, nil] + optional :rating, Integer, api_name: :Rating + + # @!attribute registry_entry_role + # + # @return [Array, nil] + optional :registry_entry_role, Imagekit::Internal::Type::ArrayOf[String], api_name: :RegistryEntryRole + + # @!attribute registry_item_id + # + # @return [Array, nil] + optional :registry_item_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :RegistryItemID + + # @!attribute registry_organisation_id + # + # @return [Array, nil] + optional :registry_organisation_id, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :RegistryOrganisationID + + # @!attribute resolution_unit + # + # @return [String, nil] + optional :resolution_unit, String, api_name: :ResolutionUnit + + # @!attribute rights + # + # @return [String, nil] + optional :rights, String, api_name: :Rights + + # @!attribute scene + # + # @return [Array, nil] + optional :scene, Imagekit::Internal::Type::ArrayOf[String], api_name: :Scene + + # @!attribute source + # + # @return [String, nil] + optional :source, String, api_name: :Source + + # @!attribute special_instructions + # + # @return [String, nil] + optional :special_instructions, String, api_name: :SpecialInstructions + + # @!attribute state + # + # @return [String, nil] + optional :state, String, api_name: :State + + # @!attribute subject + # + # @return [Array, nil] + optional :subject, Imagekit::Internal::Type::ArrayOf[String], api_name: :Subject + + # @!attribute subject_code + # + # @return [Array, nil] + optional :subject_code, Imagekit::Internal::Type::ArrayOf[String], api_name: :SubjectCode + + # @!attribute subject_reference + # + # @return [Array, nil] + optional :subject_reference, Imagekit::Internal::Type::ArrayOf[String], api_name: :SubjectReference + + # @!attribute sublocation + # + # @return [String, nil] + optional :sublocation, String, api_name: :Sublocation + + # @!attribute time_created + # + # @return [String, nil] + optional :time_created, String, api_name: :TimeCreated + + # @!attribute title + # + # @return [String, nil] + optional :title, String, api_name: :Title + + # @!attribute transmission_reference + # + # @return [String, nil] + optional :transmission_reference, String, api_name: :TransmissionReference + + # @!attribute usage_terms + # + # @return [String, nil] + optional :usage_terms, String, api_name: :UsageTerms + + # @!attribute web_statement + # + # @return [String, nil] + optional :web_statement, String, api_name: :WebStatement + + # @!attribute writer + # + # @return [String, nil] + optional :writer, String, api_name: :Writer + + # @!attribute writer_editor + # + # @return [String, nil] + optional :writer_editor, String, api_name: :WriterEditor + + # @!attribute x_resolution + # + # @return [Float, nil] + optional :x_resolution, Float, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Float, nil] + optional :y_resolution, Float, api_name: :YResolution + + # @!method initialize(about_cv_term_cv_id: nil, about_cv_term_id: nil, about_cv_term_name: nil, about_cv_term_refined_about: nil, additional_model_information: nil, application_record_version: nil, artist: nil, artwork_circa_date_created: nil, artwork_content_description: nil, artwork_contribution_description: nil, artwork_copyright_notice: nil, artwork_copyright_owner_id: nil, artwork_copyright_owner_name: nil, artwork_creator: nil, artwork_creator_id: nil, artwork_date_created: nil, artwork_licensor_id: nil, artwork_licensor_name: nil, artwork_physical_description: nil, artwork_source: nil, artwork_source_inventory_no: nil, artwork_source_inv_url: nil, artwork_style_period: nil, artwork_title: nil, authors_position: nil, byline: nil, byline_title: nil, caption: nil, caption_abstract: nil, caption_writer: nil, city: nil, color_space: nil, components_configuration: nil, copyright: nil, copyright_notice: nil, copyright_owner_id: nil, copyright_owner_name: nil, country: nil, country_code: nil, country_primary_location_code: nil, country_primary_location_name: nil, creator: nil, creator_address: nil, creator_city: nil, creator_country: nil, creator_postal_code: nil, creator_region: nil, creator_work_email: nil, creator_work_telephone: nil, creator_work_url: nil, credit: nil, date_created: nil, date_time_created: nil, date_time_original: nil, description: nil, digital_image_guid: nil, digital_source_type: nil, embedded_encoded_rights_expr: nil, embedded_encoded_rights_expr_lang_id: nil, embedded_encoded_rights_expr_type: nil, event: nil, exif_version: nil, flashpix_version: nil, genre_cv_id: nil, genre_cv_term_id: nil, genre_cv_term_name: nil, genre_cv_term_refined_about: nil, headline: nil, image_creator_id: nil, image_creator_image_id: nil, image_creator_name: nil, image_description: nil, image_region_boundary_h: nil, image_region_boundary_rx: nil, image_region_boundary_shape: nil, image_region_boundary_unit: nil, image_region_boundary_vertices_x: nil, image_region_boundary_vertices_y: nil, image_region_boundary_w: nil, image_region_boundary_x: nil, image_region_boundary_y: nil, image_region_ctype_identifier: nil, image_region_ctype_name: nil, image_region_id: nil, image_region_name: nil, image_region_organisation_in_image_name: nil, image_region_person_in_image: nil, image_region_role_identifier: nil, image_region_role_name: nil, image_supplier_id: nil, image_supplier_image_id: nil, image_supplier_name: nil, instructions: nil, intellectual_genre: nil, keywords: nil, licensor_city: nil, licensor_country: nil, licensor_email: nil, licensor_extended_address: nil, licensor_id: nil, licensor_name: nil, licensor_postal_code: nil, licensor_region: nil, licensor_street_address: nil, licensor_telephone1: nil, licensor_telephone2: nil, licensor_url: nil, linked_encoded_rights_expr: nil, linked_encoded_rights_expr_lang_id: nil, linked_encoded_rights_expr_type: nil, location: nil, location_created_city: nil, location_created_country_code: nil, location_created_country_name: nil, location_created_gps_altitude: nil, location_created_gps_latitude: nil, location_created_gps_longitude: nil, location_created_location_id: nil, location_created_location_name: nil, location_created_province_state: nil, location_created_sublocation: nil, location_created_world_region: nil, location_shown_city: nil, location_shown_country_code: nil, location_shown_country_name: nil, location_shown_gps_altitude: nil, location_shown_gps_latitude: nil, location_shown_gps_longitude: nil, location_shown_location_id: nil, location_shown_location_name: nil, location_shown_province_state: nil, location_shown_sublocation: nil, location_shown_world_region: nil, max_avail_height: nil, max_avail_width: nil, model_age: nil, model_release_id: nil, object_attribute_reference: nil, object_name: nil, offset_time_original: nil, organisation_in_image_code: nil, organisation_in_image_name: nil, orientation: nil, original_transmission_reference: nil, person_in_image: nil, person_in_image_cv_term_cv_id: nil, person_in_image_cv_term_id: nil, person_in_image_cv_term_name: nil, person_in_image_cv_term_refined_about: nil, person_in_image_description: nil, person_in_image_id: nil, person_in_image_name: nil, product_in_image_description: nil, product_in_image_gtin: nil, product_in_image_name: nil, property_release_id: nil, province_state: nil, rating: nil, registry_entry_role: nil, registry_item_id: nil, registry_organisation_id: nil, resolution_unit: nil, rights: nil, scene: nil, source: nil, special_instructions: nil, state: nil, subject: nil, subject_code: nil, subject_reference: nil, sublocation: nil, time_created: nil, title: nil, transmission_reference: nil, usage_terms: nil, web_statement: nil, writer: nil, writer_editor: nil, x_resolution: nil, y_resolution: nil) + # 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 about_cv_term_cv_id [String] + # @param about_cv_term_id [String] + # @param about_cv_term_name [String] + # @param about_cv_term_refined_about [String] + # @param additional_model_information [String] + # @param application_record_version [Integer] + # @param artist [String] + # @param artwork_circa_date_created [String] + # @param artwork_content_description [String] + # @param artwork_contribution_description [String] + # @param artwork_copyright_notice [String] + # @param artwork_copyright_owner_id [String] + # @param artwork_copyright_owner_name [String] + # @param artwork_creator [Array] + # @param artwork_creator_id [Array] + # @param artwork_date_created [Time] + # @param artwork_licensor_id [String] + # @param artwork_licensor_name [String] + # @param artwork_physical_description [String] + # @param artwork_source [String] + # @param artwork_source_inventory_no [String] + # @param artwork_source_inv_url [String] + # @param artwork_style_period [Array] + # @param artwork_title [String] + # @param authors_position [String] + # @param byline [String] + # @param byline_title [String] + # @param caption [String] + # @param caption_abstract [String] + # @param caption_writer [String] + # @param city [String] + # @param color_space [String] + # @param components_configuration [String] + # @param copyright [String] + # @param copyright_notice [String] + # @param copyright_owner_id [Array] + # @param copyright_owner_name [Array] + # @param country [String] + # @param country_code [String] + # @param country_primary_location_code [String] + # @param country_primary_location_name [String] + # @param creator [String] + # @param creator_address [String] + # @param creator_city [String] + # @param creator_country [String] + # @param creator_postal_code [String] + # @param creator_region [String] + # @param creator_work_email [String] + # @param creator_work_telephone [String] + # @param creator_work_url [String] + # @param credit [String] + # @param date_created [Time] + # @param date_time_created [Time] + # @param date_time_original [Time] + # @param description [String] + # @param digital_image_guid [String] + # @param digital_source_type [String] + # @param embedded_encoded_rights_expr [String] + # @param embedded_encoded_rights_expr_lang_id [String] + # @param embedded_encoded_rights_expr_type [String] + # @param event [String] + # @param exif_version [String] + # @param flashpix_version [String] + # @param genre_cv_id [String] + # @param genre_cv_term_id [String] + # @param genre_cv_term_name [String] + # @param genre_cv_term_refined_about [String] + # @param headline [String] + # @param image_creator_id [String] + # @param image_creator_image_id [String] + # @param image_creator_name [String] + # @param image_description [String] + # @param image_region_boundary_h [Array] + # @param image_region_boundary_rx [Array] + # @param image_region_boundary_shape [Array] + # @param image_region_boundary_unit [Array] + # @param image_region_boundary_vertices_x [Array] + # @param image_region_boundary_vertices_y [Array] + # @param image_region_boundary_w [Array] + # @param image_region_boundary_x [Array] + # @param image_region_boundary_y [Array] + # @param image_region_ctype_identifier [Array] + # @param image_region_ctype_name [Array] + # @param image_region_id [Array] + # @param image_region_name [Array] + # @param image_region_organisation_in_image_name [Array] + # @param image_region_person_in_image [Array] + # @param image_region_role_identifier [Array] + # @param image_region_role_name [Array] + # @param image_supplier_id [String] + # @param image_supplier_image_id [String] + # @param image_supplier_name [String] + # @param instructions [String] + # @param intellectual_genre [String] + # @param keywords [Array] + # @param licensor_city [Array] + # @param licensor_country [Array] + # @param licensor_email [Array] + # @param licensor_extended_address [Array] + # @param licensor_id [Array] + # @param licensor_name [Array] + # @param licensor_postal_code [Array] + # @param licensor_region [Array] + # @param licensor_street_address [Array] + # @param licensor_telephone1 [Array] + # @param licensor_telephone2 [Array] + # @param licensor_url [Array] + # @param linked_encoded_rights_expr [String] + # @param linked_encoded_rights_expr_lang_id [String] + # @param linked_encoded_rights_expr_type [String] + # @param location [String] + # @param location_created_city [String] + # @param location_created_country_code [String] + # @param location_created_country_name [String] + # @param location_created_gps_altitude [String] + # @param location_created_gps_latitude [String] + # @param location_created_gps_longitude [String] + # @param location_created_location_id [String] + # @param location_created_location_name [String] + # @param location_created_province_state [String] + # @param location_created_sublocation [String] + # @param location_created_world_region [String] + # @param location_shown_city [Array] + # @param location_shown_country_code [Array] + # @param location_shown_country_name [Array] + # @param location_shown_gps_altitude [Array] + # @param location_shown_gps_latitude [Array] + # @param location_shown_gps_longitude [Array] + # @param location_shown_location_id [Array] + # @param location_shown_location_name [Array] + # @param location_shown_province_state [Array] + # @param location_shown_sublocation [Array] + # @param location_shown_world_region [Array] + # @param max_avail_height [Float] + # @param max_avail_width [Float] + # @param model_age [Array] + # @param model_release_id [Array] + # @param object_attribute_reference [String] + # @param object_name [String] + # @param offset_time_original [String] + # @param organisation_in_image_code [Array] + # @param organisation_in_image_name [Array] + # @param orientation [String] + # @param original_transmission_reference [String] + # @param person_in_image [Array] + # @param person_in_image_cv_term_cv_id [Array] + # @param person_in_image_cv_term_id [Array] + # @param person_in_image_cv_term_name [Array] + # @param person_in_image_cv_term_refined_about [Array] + # @param person_in_image_description [Array] + # @param person_in_image_id [Array] + # @param person_in_image_name [Array] + # @param product_in_image_description [Array] + # @param product_in_image_gtin [Array] + # @param product_in_image_name [Array] + # @param property_release_id [Array] + # @param province_state [String] + # @param rating [Integer] + # @param registry_entry_role [Array] + # @param registry_item_id [Array] + # @param registry_organisation_id [Array] + # @param resolution_unit [String] + # @param rights [String] + # @param scene [Array] + # @param source [String] + # @param special_instructions [String] + # @param state [String] + # @param subject [Array] + # @param subject_code [Array] + # @param subject_reference [Array] + # @param sublocation [String] + # @param time_created [String] + # @param title [String] + # @param transmission_reference [String] + # @param usage_terms [String] + # @param web_statement [String] + # @param writer [String] + # @param writer_editor [String] + # @param x_resolution [Float] + # @param y_resolution [Float] + end + + # @see Imagekit::Models::FileUploadV1Response#extension_status + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute aws_auto_tagging + # + # @return [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging, nil] + optional :aws_auto_tagging, + enum: -> { Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging }, + api_name: :"aws-auto-tagging" + + # @!attribute google_auto_tagging + # + # @return [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging, nil] + optional :google_auto_tagging, + enum: -> { Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging }, + api_name: :"google-auto-tagging" + + # @!attribute remove_bg + # + # @return [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg, nil] + optional :remove_bg, + enum: -> { Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg }, + api_name: :"remove-bg" + + # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # 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. + # + # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg] + + # @see Imagekit::Models::FileUploadV1Response::ExtensionStatus#aws_auto_tagging + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUploadV1Response::ExtensionStatus#google_auto_tagging + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUploadV1Response::ExtensionStatus#remove_bg + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::FileUploadV1Response#metadata + class Metadata < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::FileUploadV1Response::Metadata::Exif, nil] + optional :exif, -> { Imagekit::Models::FileUploadV1Response::Metadata::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::FileUploadV1Response::Metadata::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::FileUploadV1Response::Metadata#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::ExifDetails, nil] + optional :exif, -> { Imagekit::ExifDetails } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::Gps, nil] + optional :gps, -> { Imagekit::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::ExifImage, nil] + optional :image, -> { Imagekit::ExifImage } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::Interoperability, nil] + optional :interoperability, -> { Imagekit::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. + # + # @param gps [Imagekit::Models::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. + end + end + + # @see Imagekit::Models::FileUploadV1Response#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end +end diff --git a/lib/imagekit/models/file_upload_v2_params.rb b/lib/imagekit/models/file_upload_v2_params.rb new file mode 100644 index 00000000..c31f2809 --- /dev/null +++ b/lib/imagekit/models/file_upload_v2_params.rb @@ -0,0 +1,345 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#upload_v2 + class FileUploadV2Params < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file + # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, + # please ensure that our servers can access the URL. In case ImageKit is unable to + # download the file from the specified URL, a `400` error response is returned. + # This will also result in a `400` error if the file download request is aborted + # if response headers are not received in 8 seconds. + # + # @return [String] + required :file, String + + # @!attribute file_name + # The name with which the file has to be uploaded. + # + # @return [String] + required :file_name, String, api_name: :fileName + + # @!attribute token + # 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. + # + # @return [String, nil] + optional :token, String + + # @!attribute checks + # 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). + # + # @return [String, nil] + optional :checks, String + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates + + # @!attribute custom_metadata + # Stringified JSON key-value data to be associated with the asset. + # + # @return [String, nil] + optional :custom_metadata, String, api_name: :customMetadata + + # @!attribute extensions + # Stringified JSON object with an array of extensions to be applied to the image. + # Refer to extensions schema in + # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + # + # @return [String, nil] + optional :extensions, String + + # @!attribute 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. + # + # @return [String, nil] + optional :folder, String + + # @!attribute is_private_file + # 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. + # + # @return [Symbol, Imagekit::Models::FileUploadV2Params::IsPrivateFile, nil] + optional :is_private_file, + enum: -> { Imagekit::FileUploadV2Params::IsPrivateFile }, + api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Symbol, Imagekit::Models::FileUploadV2Params::IsPublished, nil] + optional :is_published, enum: -> { Imagekit::FileUploadV2Params::IsPublished }, api_name: :isPublished + + # @!attribute overwrite_ai_tags + # 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. + # + # @return [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteAITags, nil] + optional :overwrite_ai_tags, + enum: -> { Imagekit::FileUploadV2Params::OverwriteAITags }, + api_name: :overwriteAITags + + # @!attribute overwrite_custom_metadata + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + # + # @return [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteCustomMetadata, nil] + optional :overwrite_custom_metadata, + enum: -> { Imagekit::FileUploadV2Params::OverwriteCustomMetadata }, + api_name: :overwriteCustomMetadata + + # @!attribute overwrite_file + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + # + # @return [String, nil] + optional :overwrite_file, String, api_name: :overwriteFile + + # @!attribute overwrite_tags + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + # + # @return [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteTags, nil] + optional :overwrite_tags, + enum: -> { Imagekit::FileUploadV2Params::OverwriteTags }, + api_name: :overwriteTags + + # @!attribute response_fields + # Comma-separated values of the fields that you want the API to return in the + # response. + # + # For example, set the value of this field to + # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, + # `customCoordinates`, and `isPrivateFile` in the response. + # + # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, + # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + # + # @return [String, nil] + optional :response_fields, String, api_name: :responseFields + + # @!attribute tags + # Set the tags while uploading the file. + # + # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length + # of all characters should not exceed 500. `%` is not allowed. + # + # If this field is not specified and the file is overwritten then the tags will be + # removed. + # + # @return [String, nil] + optional :tags, String + + # @!attribute transformation + # Stringified JSON object with properties for pre and post transformations: + # + # `pre` - Accepts a "string" containing a valid transformation used for requesting + # a pre-transformation for an image or a video file. + # + # `post` - Accepts an array of objects with properties: + # + # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` + # (Adaptive bitrate streaming). + # - `value`: A "string" corresponding to the required transformation. Required if + # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or + # `thumbnail`. + # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # + # Read more about + # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + # + # @return [String, nil] + optional :transformation, String + + # @!attribute use_unique_file_name + # 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. + # + # @return [Symbol, Imagekit::Models::FileUploadV2Params::UseUniqueFileName, nil] + optional :use_unique_file_name, + enum: -> { Imagekit::FileUploadV2Params::UseUniqueFileName }, + api_name: :useUniqueFileName + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadV2Params} for more details. + # + # @param file [String] Pass the HTTP URL or base64 string. When passing a URL in the file parameter, pl + # + # @param file_name [String] The name with which the file has to be uploaded. + # + # @param token [String] This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses i + # + # @param checks [String] Server-side checks to run on the asset. + # + # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file + # + # @param custom_metadata [String] Stringified JSON key-value data to be associated with the asset. + # + # @param extensions [String] Stringified JSON object with an array of extensions to be applied to the image. + # + # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e + # + # @param is_private_file [Symbol, Imagekit::Models::FileUploadV2Params::IsPrivateFile] Whether to mark the file as private or not. + # + # @param is_published [Symbol, Imagekit::Models::FileUploadV2Params::IsPublished] Whether to upload file as published or not. + # + # @param overwrite_ai_tags [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteAITags] If set to `true` and a file already exists at the exact location, its AITags wil + # + # @param overwrite_custom_metadata [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteCustomMetadata] If the request does not have `customMetadata`, and a file already exists at the + # + # @param overwrite_file [String] If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # + # @param overwrite_tags [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteTags] If the request does not have `tags`, and a file already exists at the exact loca + # + # @param response_fields [String] Comma-separated values of the fields that you want the API to return in the resp + # + # @param tags [String] Set the tags while uploading the file. + # + # @param transformation [String] Stringified JSON object with properties for pre and post transformations: + # + # @param use_unique_file_name [Symbol, Imagekit::Models::FileUploadV2Params::UseUniqueFileName] Whether to use a unique filename for this file or not. + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # 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. + module IsPrivateFile + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # 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. + module IsPublished + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # 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. + module OverwriteAITags + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + module OverwriteCustomMetadata + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + module OverwriteTags + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + + # 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. + module UseUniqueFileName + extend Imagekit::Internal::Type::Enum + + TRUE = :true + FALSE = :false + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/file_upload_v2_response.rb b/lib/imagekit/models/file_upload_v2_response.rb new file mode 100644 index 00000000..2c406801 --- /dev/null +++ b/lib/imagekit/models/file_upload_v2_response.rb @@ -0,0 +1,1706 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#upload_v2 + class FileUploadV2Response < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the uploaded file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadV2Response::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # 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. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute embedded_metadata + # 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. + # + # @return [Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, nil] + optional :embedded_metadata, + -> { Imagekit::Models::FileUploadV2Response::EmbeddedMetadata }, + api_name: :embeddedMetadata + + # @!attribute extension_status + # 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. + # + # @return [Imagekit::Models::FileUploadV2Response::ExtensionStatus, nil] + optional :extension_status, + -> { Imagekit::Models::FileUploadV2Response::ExtensionStatus }, + api_name: :extensionStatus + + # @!attribute file_id + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute height + # Height of the image in pixels (Only for images) + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # 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. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute metadata + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @return [Imagekit::Models::FileUploadV2Response::Metadata, nil] + optional :metadata, -> { Imagekit::Models::FileUploadV2Response::Metadata } + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the image file in Bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # 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. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail_url + # In the case of an image, a small thumbnail URL. + # + # @return [String, nil] + optional :thumbnail_url, String, api_name: :thumbnailUrl + + # @!attribute url + # A publicly accessible URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @return [Imagekit::Models::FileUploadV2Response::VersionInfo, nil] + optional :version_info, -> { Imagekit::Models::FileUploadV2Response::VersionInfo }, api_name: :versionInfo + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # Width of the image in pixels (Only for Images) + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadV2Response} for more details. + # + # Object containing details of a successful upload. + # + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h + # + # @param custom_metadata [Object] A key-value data associated with the asset. Use `responseField` in API request t + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param embedded_metadata [Imagekit::Models::FileUploadV2Response::EmbeddedMetadata] Consolidated embedded metadata associated with the file. It includes exif, iptc, + # + # @param extension_status [Imagekit::Models::FileUploadV2Response::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # + # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo + # + # @param file_path [String] The relative path of the file in the media library e.g. `/marketing-assets/new-b + # + # @param file_type [String] Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @param height [Float] Height of the image in pixels (Only for images) + # + # @param is_private_file [Boolean] Is the file marked as private. It can be either `true` or `false`. Send `isPriva + # + # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen + # + # @param metadata [Imagekit::Models::FileUploadV2Response::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the image file in Bytes. + # + # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul + # + # @param thumbnail_url [String] In the case of an image, a small thumbnail URL. + # + # @param url [String] A publicly accessible URL of the file. + # + # @param version_info [Imagekit::Models::FileUploadV2Response::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Float] Width of the image in pixels (Only for Images) + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # 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. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadV2Response::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be + end + + # @see Imagekit::Models::FileUploadV2Response#embedded_metadata + class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel + # @!attribute about_cv_term_cv_id + # + # @return [String, nil] + optional :about_cv_term_cv_id, String, api_name: :AboutCvTermCvId + + # @!attribute about_cv_term_id + # + # @return [String, nil] + optional :about_cv_term_id, String, api_name: :AboutCvTermId + + # @!attribute about_cv_term_name + # + # @return [String, nil] + optional :about_cv_term_name, String, api_name: :AboutCvTermName + + # @!attribute about_cv_term_refined_about + # + # @return [String, nil] + optional :about_cv_term_refined_about, String, api_name: :AboutCvTermRefinedAbout + + # @!attribute additional_model_information + # + # @return [String, nil] + optional :additional_model_information, String, api_name: :AdditionalModelInformation + + # @!attribute application_record_version + # + # @return [Integer, nil] + optional :application_record_version, Integer, api_name: :ApplicationRecordVersion + + # @!attribute artist + # + # @return [String, nil] + optional :artist, String, api_name: :Artist + + # @!attribute artwork_circa_date_created + # + # @return [String, nil] + optional :artwork_circa_date_created, String, api_name: :ArtworkCircaDateCreated + + # @!attribute artwork_content_description + # + # @return [String, nil] + optional :artwork_content_description, String, api_name: :ArtworkContentDescription + + # @!attribute artwork_contribution_description + # + # @return [String, nil] + optional :artwork_contribution_description, String, api_name: :ArtworkContributionDescription + + # @!attribute artwork_copyright_notice + # + # @return [String, nil] + optional :artwork_copyright_notice, String, api_name: :ArtworkCopyrightNotice + + # @!attribute artwork_copyright_owner_id + # + # @return [String, nil] + optional :artwork_copyright_owner_id, String, api_name: :ArtworkCopyrightOwnerID + + # @!attribute artwork_copyright_owner_name + # + # @return [String, nil] + optional :artwork_copyright_owner_name, String, api_name: :ArtworkCopyrightOwnerName + + # @!attribute artwork_creator + # + # @return [Array, nil] + optional :artwork_creator, Imagekit::Internal::Type::ArrayOf[String], api_name: :ArtworkCreator + + # @!attribute artwork_creator_id + # + # @return [Array, nil] + optional :artwork_creator_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ArtworkCreatorID + + # @!attribute artwork_date_created + # + # @return [Time, nil] + optional :artwork_date_created, Time, api_name: :ArtworkDateCreated + + # @!attribute artwork_licensor_id + # + # @return [String, nil] + optional :artwork_licensor_id, String, api_name: :ArtworkLicensorID + + # @!attribute artwork_licensor_name + # + # @return [String, nil] + optional :artwork_licensor_name, String, api_name: :ArtworkLicensorName + + # @!attribute artwork_physical_description + # + # @return [String, nil] + optional :artwork_physical_description, String, api_name: :ArtworkPhysicalDescription + + # @!attribute artwork_source + # + # @return [String, nil] + optional :artwork_source, String, api_name: :ArtworkSource + + # @!attribute artwork_source_inventory_no + # + # @return [String, nil] + optional :artwork_source_inventory_no, String, api_name: :ArtworkSourceInventoryNo + + # @!attribute artwork_source_inv_url + # + # @return [String, nil] + optional :artwork_source_inv_url, String, api_name: :ArtworkSourceInvURL + + # @!attribute artwork_style_period + # + # @return [Array, nil] + optional :artwork_style_period, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ArtworkStylePeriod + + # @!attribute artwork_title + # + # @return [String, nil] + optional :artwork_title, String, api_name: :ArtworkTitle + + # @!attribute authors_position + # + # @return [String, nil] + optional :authors_position, String, api_name: :AuthorsPosition + + # @!attribute byline + # + # @return [String, nil] + optional :byline, String, api_name: :Byline + + # @!attribute byline_title + # + # @return [String, nil] + optional :byline_title, String, api_name: :BylineTitle + + # @!attribute caption + # + # @return [String, nil] + optional :caption, String, api_name: :Caption + + # @!attribute caption_abstract + # + # @return [String, nil] + optional :caption_abstract, String, api_name: :CaptionAbstract + + # @!attribute caption_writer + # + # @return [String, nil] + optional :caption_writer, String, api_name: :CaptionWriter + + # @!attribute city + # + # @return [String, nil] + optional :city, String, api_name: :City + + # @!attribute color_space + # + # @return [String, nil] + optional :color_space, String, api_name: :ColorSpace + + # @!attribute components_configuration + # + # @return [String, nil] + optional :components_configuration, String, api_name: :ComponentsConfiguration + + # @!attribute copyright + # + # @return [String, nil] + optional :copyright, String, api_name: :Copyright + + # @!attribute copyright_notice + # + # @return [String, nil] + optional :copyright_notice, String, api_name: :CopyrightNotice + + # @!attribute copyright_owner_id + # + # @return [Array, nil] + optional :copyright_owner_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :CopyrightOwnerID + + # @!attribute copyright_owner_name + # + # @return [Array, nil] + optional :copyright_owner_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :CopyrightOwnerName + + # @!attribute country + # + # @return [String, nil] + optional :country, String, api_name: :Country + + # @!attribute country_code + # + # @return [String, nil] + optional :country_code, String, api_name: :CountryCode + + # @!attribute country_primary_location_code + # + # @return [String, nil] + optional :country_primary_location_code, String, api_name: :CountryPrimaryLocationCode + + # @!attribute country_primary_location_name + # + # @return [String, nil] + optional :country_primary_location_name, String, api_name: :CountryPrimaryLocationName + + # @!attribute creator + # + # @return [String, nil] + optional :creator, String, api_name: :Creator + + # @!attribute creator_address + # + # @return [String, nil] + optional :creator_address, String, api_name: :CreatorAddress + + # @!attribute creator_city + # + # @return [String, nil] + optional :creator_city, String, api_name: :CreatorCity + + # @!attribute creator_country + # + # @return [String, nil] + optional :creator_country, String, api_name: :CreatorCountry + + # @!attribute creator_postal_code + # + # @return [String, nil] + optional :creator_postal_code, String, api_name: :CreatorPostalCode + + # @!attribute creator_region + # + # @return [String, nil] + optional :creator_region, String, api_name: :CreatorRegion + + # @!attribute creator_work_email + # + # @return [String, nil] + optional :creator_work_email, String, api_name: :CreatorWorkEmail + + # @!attribute creator_work_telephone + # + # @return [String, nil] + optional :creator_work_telephone, String, api_name: :CreatorWorkTelephone + + # @!attribute creator_work_url + # + # @return [String, nil] + optional :creator_work_url, String, api_name: :CreatorWorkURL + + # @!attribute credit + # + # @return [String, nil] + optional :credit, String, api_name: :Credit + + # @!attribute date_created + # + # @return [Time, nil] + optional :date_created, Time, api_name: :DateCreated + + # @!attribute date_time_created + # + # @return [Time, nil] + optional :date_time_created, Time, api_name: :DateTimeCreated + + # @!attribute date_time_original + # + # @return [Time, nil] + optional :date_time_original, Time, api_name: :DateTimeOriginal + + # @!attribute description + # + # @return [String, nil] + optional :description, String, api_name: :Description + + # @!attribute digital_image_guid + # + # @return [String, nil] + optional :digital_image_guid, String, api_name: :DigitalImageGUID + + # @!attribute digital_source_type + # + # @return [String, nil] + optional :digital_source_type, String, api_name: :DigitalSourceType + + # @!attribute embedded_encoded_rights_expr + # + # @return [String, nil] + optional :embedded_encoded_rights_expr, String, api_name: :EmbeddedEncodedRightsExpr + + # @!attribute embedded_encoded_rights_expr_lang_id + # + # @return [String, nil] + optional :embedded_encoded_rights_expr_lang_id, String, api_name: :EmbeddedEncodedRightsExprLangID + + # @!attribute embedded_encoded_rights_expr_type + # + # @return [String, nil] + optional :embedded_encoded_rights_expr_type, String, api_name: :EmbeddedEncodedRightsExprType + + # @!attribute event + # + # @return [String, nil] + optional :event, String, api_name: :Event + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute genre_cv_id + # + # @return [String, nil] + optional :genre_cv_id, String, api_name: :GenreCvId + + # @!attribute genre_cv_term_id + # + # @return [String, nil] + optional :genre_cv_term_id, String, api_name: :GenreCvTermId + + # @!attribute genre_cv_term_name + # + # @return [String, nil] + optional :genre_cv_term_name, String, api_name: :GenreCvTermName + + # @!attribute genre_cv_term_refined_about + # + # @return [String, nil] + optional :genre_cv_term_refined_about, String, api_name: :GenreCvTermRefinedAbout + + # @!attribute headline + # + # @return [String, nil] + optional :headline, String, api_name: :Headline + + # @!attribute image_creator_id + # + # @return [String, nil] + optional :image_creator_id, String, api_name: :ImageCreatorID + + # @!attribute image_creator_image_id + # + # @return [String, nil] + optional :image_creator_image_id, String, api_name: :ImageCreatorImageID + + # @!attribute image_creator_name + # + # @return [String, nil] + optional :image_creator_name, String, api_name: :ImageCreatorName + + # @!attribute image_description + # + # @return [String, nil] + optional :image_description, String, api_name: :ImageDescription + + # @!attribute image_region_boundary_h + # + # @return [Array, nil] + optional :image_region_boundary_h, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryH + + # @!attribute image_region_boundary_rx + # + # @return [Array, nil] + optional :image_region_boundary_rx, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryRx + + # @!attribute image_region_boundary_shape + # + # @return [Array, nil] + optional :image_region_boundary_shape, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionBoundaryShape + + # @!attribute image_region_boundary_unit + # + # @return [Array, nil] + optional :image_region_boundary_unit, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionBoundaryUnit + + # @!attribute image_region_boundary_vertices_x + # + # @return [Array, nil] + optional :image_region_boundary_vertices_x, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryVerticesX + + # @!attribute image_region_boundary_vertices_y + # + # @return [Array, nil] + optional :image_region_boundary_vertices_y, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryVerticesY + + # @!attribute image_region_boundary_w + # + # @return [Array, nil] + optional :image_region_boundary_w, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryW + + # @!attribute image_region_boundary_x + # + # @return [Array, nil] + optional :image_region_boundary_x, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryX + + # @!attribute image_region_boundary_y + # + # @return [Array, nil] + optional :image_region_boundary_y, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ImageRegionBoundaryY + + # @!attribute image_region_ctype_identifier + # + # @return [Array, nil] + optional :image_region_ctype_identifier, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionCtypeIdentifier + + # @!attribute image_region_ctype_name + # + # @return [Array, nil] + optional :image_region_ctype_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionCtypeName + + # @!attribute image_region_id + # + # @return [Array, nil] + optional :image_region_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ImageRegionID + + # @!attribute image_region_name + # + # @return [Array, nil] + optional :image_region_name, Imagekit::Internal::Type::ArrayOf[String], api_name: :ImageRegionName + + # @!attribute image_region_organisation_in_image_name + # + # @return [Array, nil] + optional :image_region_organisation_in_image_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionOrganisationInImageName + + # @!attribute image_region_person_in_image + # + # @return [Array, nil] + optional :image_region_person_in_image, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionPersonInImage + + # @!attribute image_region_role_identifier + # + # @return [Array, nil] + optional :image_region_role_identifier, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionRoleIdentifier + + # @!attribute image_region_role_name + # + # @return [Array, nil] + optional :image_region_role_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ImageRegionRoleName + + # @!attribute image_supplier_id + # + # @return [String, nil] + optional :image_supplier_id, String, api_name: :ImageSupplierID + + # @!attribute image_supplier_image_id + # + # @return [String, nil] + optional :image_supplier_image_id, String, api_name: :ImageSupplierImageID + + # @!attribute image_supplier_name + # + # @return [String, nil] + optional :image_supplier_name, String, api_name: :ImageSupplierName + + # @!attribute instructions + # + # @return [String, nil] + optional :instructions, String, api_name: :Instructions + + # @!attribute intellectual_genre + # + # @return [String, nil] + optional :intellectual_genre, String, api_name: :IntellectualGenre + + # @!attribute keywords + # + # @return [Array, nil] + optional :keywords, Imagekit::Internal::Type::ArrayOf[String], api_name: :Keywords + + # @!attribute licensor_city + # + # @return [Array, nil] + optional :licensor_city, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorCity + + # @!attribute licensor_country + # + # @return [Array, nil] + optional :licensor_country, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorCountry + + # @!attribute licensor_email + # + # @return [Array, nil] + optional :licensor_email, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorEmail + + # @!attribute licensor_extended_address + # + # @return [Array, nil] + optional :licensor_extended_address, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorExtendedAddress + + # @!attribute licensor_id + # + # @return [Array, nil] + optional :licensor_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorID + + # @!attribute licensor_name + # + # @return [Array, nil] + optional :licensor_name, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorName + + # @!attribute licensor_postal_code + # + # @return [Array, nil] + optional :licensor_postal_code, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorPostalCode + + # @!attribute licensor_region + # + # @return [Array, nil] + optional :licensor_region, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorRegion + + # @!attribute licensor_street_address + # + # @return [Array, nil] + optional :licensor_street_address, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorStreetAddress + + # @!attribute licensor_telephone1 + # + # @return [Array, nil] + optional :licensor_telephone1, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorTelephone1 + + # @!attribute licensor_telephone2 + # + # @return [Array, nil] + optional :licensor_telephone2, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LicensorTelephone2 + + # @!attribute licensor_url + # + # @return [Array, nil] + optional :licensor_url, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorURL + + # @!attribute linked_encoded_rights_expr + # + # @return [String, nil] + optional :linked_encoded_rights_expr, String, api_name: :LinkedEncodedRightsExpr + + # @!attribute linked_encoded_rights_expr_lang_id + # + # @return [String, nil] + optional :linked_encoded_rights_expr_lang_id, String, api_name: :LinkedEncodedRightsExprLangID + + # @!attribute linked_encoded_rights_expr_type + # + # @return [String, nil] + optional :linked_encoded_rights_expr_type, String, api_name: :LinkedEncodedRightsExprType + + # @!attribute location + # + # @return [String, nil] + optional :location, String, api_name: :Location + + # @!attribute location_created_city + # + # @return [String, nil] + optional :location_created_city, String, api_name: :LocationCreatedCity + + # @!attribute location_created_country_code + # + # @return [String, nil] + optional :location_created_country_code, String, api_name: :LocationCreatedCountryCode + + # @!attribute location_created_country_name + # + # @return [String, nil] + optional :location_created_country_name, String, api_name: :LocationCreatedCountryName + + # @!attribute location_created_gps_altitude + # + # @return [String, nil] + optional :location_created_gps_altitude, String, api_name: :LocationCreatedGPSAltitude + + # @!attribute location_created_gps_latitude + # + # @return [String, nil] + optional :location_created_gps_latitude, String, api_name: :LocationCreatedGPSLatitude + + # @!attribute location_created_gps_longitude + # + # @return [String, nil] + optional :location_created_gps_longitude, String, api_name: :LocationCreatedGPSLongitude + + # @!attribute location_created_location_id + # + # @return [String, nil] + optional :location_created_location_id, String, api_name: :LocationCreatedLocationId + + # @!attribute location_created_location_name + # + # @return [String, nil] + optional :location_created_location_name, String, api_name: :LocationCreatedLocationName + + # @!attribute location_created_province_state + # + # @return [String, nil] + optional :location_created_province_state, String, api_name: :LocationCreatedProvinceState + + # @!attribute location_created_sublocation + # + # @return [String, nil] + optional :location_created_sublocation, String, api_name: :LocationCreatedSublocation + + # @!attribute location_created_world_region + # + # @return [String, nil] + optional :location_created_world_region, String, api_name: :LocationCreatedWorldRegion + + # @!attribute location_shown_city + # + # @return [Array, nil] + optional :location_shown_city, Imagekit::Internal::Type::ArrayOf[String], api_name: :LocationShownCity + + # @!attribute location_shown_country_code + # + # @return [Array, nil] + optional :location_shown_country_code, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownCountryCode + + # @!attribute location_shown_country_name + # + # @return [Array, nil] + optional :location_shown_country_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownCountryName + + # @!attribute location_shown_gps_altitude + # + # @return [Array, nil] + optional :location_shown_gps_altitude, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownGPSAltitude + + # @!attribute location_shown_gps_latitude + # + # @return [Array, nil] + optional :location_shown_gps_latitude, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownGPSLatitude + + # @!attribute location_shown_gps_longitude + # + # @return [Array, nil] + optional :location_shown_gps_longitude, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownGPSLongitude + + # @!attribute location_shown_location_id + # + # @return [Array, nil] + optional :location_shown_location_id, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownLocationId + + # @!attribute location_shown_location_name + # + # @return [Array, nil] + optional :location_shown_location_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownLocationName + + # @!attribute location_shown_province_state + # + # @return [Array, nil] + optional :location_shown_province_state, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownProvinceState + + # @!attribute location_shown_sublocation + # + # @return [Array, nil] + optional :location_shown_sublocation, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownSublocation + + # @!attribute location_shown_world_region + # + # @return [Array, nil] + optional :location_shown_world_region, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :LocationShownWorldRegion + + # @!attribute max_avail_height + # + # @return [Float, nil] + optional :max_avail_height, Float, api_name: :MaxAvailHeight + + # @!attribute max_avail_width + # + # @return [Float, nil] + optional :max_avail_width, Float, api_name: :MaxAvailWidth + + # @!attribute model_age + # + # @return [Array, nil] + optional :model_age, Imagekit::Internal::Type::ArrayOf[Float], api_name: :ModelAge + + # @!attribute model_release_id + # + # @return [Array, nil] + optional :model_release_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ModelReleaseID + + # @!attribute object_attribute_reference + # + # @return [String, nil] + optional :object_attribute_reference, String, api_name: :ObjectAttributeReference + + # @!attribute object_name + # + # @return [String, nil] + optional :object_name, String, api_name: :ObjectName + + # @!attribute offset_time_original + # + # @return [String, nil] + optional :offset_time_original, String, api_name: :OffsetTimeOriginal + + # @!attribute organisation_in_image_code + # + # @return [Array, nil] + optional :organisation_in_image_code, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :OrganisationInImageCode + + # @!attribute organisation_in_image_name + # + # @return [Array, nil] + optional :organisation_in_image_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :OrganisationInImageName + + # @!attribute orientation + # + # @return [String, nil] + optional :orientation, String, api_name: :Orientation + + # @!attribute original_transmission_reference + # + # @return [String, nil] + optional :original_transmission_reference, String, api_name: :OriginalTransmissionReference + + # @!attribute person_in_image + # + # @return [Array, nil] + optional :person_in_image, Imagekit::Internal::Type::ArrayOf[String], api_name: :PersonInImage + + # @!attribute person_in_image_cv_term_cv_id + # + # @return [Array, nil] + optional :person_in_image_cv_term_cv_id, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageCvTermCvId + + # @!attribute person_in_image_cv_term_id + # + # @return [Array, nil] + optional :person_in_image_cv_term_id, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageCvTermId + + # @!attribute person_in_image_cv_term_name + # + # @return [Array, nil] + optional :person_in_image_cv_term_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageCvTermName + + # @!attribute person_in_image_cv_term_refined_about + # + # @return [Array, nil] + optional :person_in_image_cv_term_refined_about, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageCvTermRefinedAbout + + # @!attribute person_in_image_description + # + # @return [Array, nil] + optional :person_in_image_description, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageDescription + + # @!attribute person_in_image_id + # + # @return [Array, nil] + optional :person_in_image_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :PersonInImageId + + # @!attribute person_in_image_name + # + # @return [Array, nil] + optional :person_in_image_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :PersonInImageName + + # @!attribute product_in_image_description + # + # @return [Array, nil] + optional :product_in_image_description, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ProductInImageDescription + + # @!attribute product_in_image_gtin + # + # @return [Array, nil] + optional :product_in_image_gtin, + Imagekit::Internal::Type::ArrayOf[Float], + api_name: :ProductInImageGTIN + + # @!attribute product_in_image_name + # + # @return [Array, nil] + optional :product_in_image_name, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :ProductInImageName + + # @!attribute property_release_id + # + # @return [Array, nil] + optional :property_release_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :PropertyReleaseID + + # @!attribute province_state + # + # @return [String, nil] + optional :province_state, String, api_name: :ProvinceState + + # @!attribute rating + # + # @return [Integer, nil] + optional :rating, Integer, api_name: :Rating + + # @!attribute registry_entry_role + # + # @return [Array, nil] + optional :registry_entry_role, Imagekit::Internal::Type::ArrayOf[String], api_name: :RegistryEntryRole + + # @!attribute registry_item_id + # + # @return [Array, nil] + optional :registry_item_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :RegistryItemID + + # @!attribute registry_organisation_id + # + # @return [Array, nil] + optional :registry_organisation_id, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :RegistryOrganisationID + + # @!attribute resolution_unit + # + # @return [String, nil] + optional :resolution_unit, String, api_name: :ResolutionUnit + + # @!attribute rights + # + # @return [String, nil] + optional :rights, String, api_name: :Rights + + # @!attribute scene + # + # @return [Array, nil] + optional :scene, Imagekit::Internal::Type::ArrayOf[String], api_name: :Scene + + # @!attribute source + # + # @return [String, nil] + optional :source, String, api_name: :Source + + # @!attribute special_instructions + # + # @return [String, nil] + optional :special_instructions, String, api_name: :SpecialInstructions + + # @!attribute state + # + # @return [String, nil] + optional :state, String, api_name: :State + + # @!attribute subject + # + # @return [Array, nil] + optional :subject, Imagekit::Internal::Type::ArrayOf[String], api_name: :Subject + + # @!attribute subject_code + # + # @return [Array, nil] + optional :subject_code, Imagekit::Internal::Type::ArrayOf[String], api_name: :SubjectCode + + # @!attribute subject_reference + # + # @return [Array, nil] + optional :subject_reference, Imagekit::Internal::Type::ArrayOf[String], api_name: :SubjectReference + + # @!attribute sublocation + # + # @return [String, nil] + optional :sublocation, String, api_name: :Sublocation + + # @!attribute time_created + # + # @return [String, nil] + optional :time_created, String, api_name: :TimeCreated + + # @!attribute title + # + # @return [String, nil] + optional :title, String, api_name: :Title + + # @!attribute transmission_reference + # + # @return [String, nil] + optional :transmission_reference, String, api_name: :TransmissionReference + + # @!attribute usage_terms + # + # @return [String, nil] + optional :usage_terms, String, api_name: :UsageTerms + + # @!attribute web_statement + # + # @return [String, nil] + optional :web_statement, String, api_name: :WebStatement + + # @!attribute writer + # + # @return [String, nil] + optional :writer, String, api_name: :Writer + + # @!attribute writer_editor + # + # @return [String, nil] + optional :writer_editor, String, api_name: :WriterEditor + + # @!attribute x_resolution + # + # @return [Float, nil] + optional :x_resolution, Float, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Float, nil] + optional :y_resolution, Float, api_name: :YResolution + + # @!method initialize(about_cv_term_cv_id: nil, about_cv_term_id: nil, about_cv_term_name: nil, about_cv_term_refined_about: nil, additional_model_information: nil, application_record_version: nil, artist: nil, artwork_circa_date_created: nil, artwork_content_description: nil, artwork_contribution_description: nil, artwork_copyright_notice: nil, artwork_copyright_owner_id: nil, artwork_copyright_owner_name: nil, artwork_creator: nil, artwork_creator_id: nil, artwork_date_created: nil, artwork_licensor_id: nil, artwork_licensor_name: nil, artwork_physical_description: nil, artwork_source: nil, artwork_source_inventory_no: nil, artwork_source_inv_url: nil, artwork_style_period: nil, artwork_title: nil, authors_position: nil, byline: nil, byline_title: nil, caption: nil, caption_abstract: nil, caption_writer: nil, city: nil, color_space: nil, components_configuration: nil, copyright: nil, copyright_notice: nil, copyright_owner_id: nil, copyright_owner_name: nil, country: nil, country_code: nil, country_primary_location_code: nil, country_primary_location_name: nil, creator: nil, creator_address: nil, creator_city: nil, creator_country: nil, creator_postal_code: nil, creator_region: nil, creator_work_email: nil, creator_work_telephone: nil, creator_work_url: nil, credit: nil, date_created: nil, date_time_created: nil, date_time_original: nil, description: nil, digital_image_guid: nil, digital_source_type: nil, embedded_encoded_rights_expr: nil, embedded_encoded_rights_expr_lang_id: nil, embedded_encoded_rights_expr_type: nil, event: nil, exif_version: nil, flashpix_version: nil, genre_cv_id: nil, genre_cv_term_id: nil, genre_cv_term_name: nil, genre_cv_term_refined_about: nil, headline: nil, image_creator_id: nil, image_creator_image_id: nil, image_creator_name: nil, image_description: nil, image_region_boundary_h: nil, image_region_boundary_rx: nil, image_region_boundary_shape: nil, image_region_boundary_unit: nil, image_region_boundary_vertices_x: nil, image_region_boundary_vertices_y: nil, image_region_boundary_w: nil, image_region_boundary_x: nil, image_region_boundary_y: nil, image_region_ctype_identifier: nil, image_region_ctype_name: nil, image_region_id: nil, image_region_name: nil, image_region_organisation_in_image_name: nil, image_region_person_in_image: nil, image_region_role_identifier: nil, image_region_role_name: nil, image_supplier_id: nil, image_supplier_image_id: nil, image_supplier_name: nil, instructions: nil, intellectual_genre: nil, keywords: nil, licensor_city: nil, licensor_country: nil, licensor_email: nil, licensor_extended_address: nil, licensor_id: nil, licensor_name: nil, licensor_postal_code: nil, licensor_region: nil, licensor_street_address: nil, licensor_telephone1: nil, licensor_telephone2: nil, licensor_url: nil, linked_encoded_rights_expr: nil, linked_encoded_rights_expr_lang_id: nil, linked_encoded_rights_expr_type: nil, location: nil, location_created_city: nil, location_created_country_code: nil, location_created_country_name: nil, location_created_gps_altitude: nil, location_created_gps_latitude: nil, location_created_gps_longitude: nil, location_created_location_id: nil, location_created_location_name: nil, location_created_province_state: nil, location_created_sublocation: nil, location_created_world_region: nil, location_shown_city: nil, location_shown_country_code: nil, location_shown_country_name: nil, location_shown_gps_altitude: nil, location_shown_gps_latitude: nil, location_shown_gps_longitude: nil, location_shown_location_id: nil, location_shown_location_name: nil, location_shown_province_state: nil, location_shown_sublocation: nil, location_shown_world_region: nil, max_avail_height: nil, max_avail_width: nil, model_age: nil, model_release_id: nil, object_attribute_reference: nil, object_name: nil, offset_time_original: nil, organisation_in_image_code: nil, organisation_in_image_name: nil, orientation: nil, original_transmission_reference: nil, person_in_image: nil, person_in_image_cv_term_cv_id: nil, person_in_image_cv_term_id: nil, person_in_image_cv_term_name: nil, person_in_image_cv_term_refined_about: nil, person_in_image_description: nil, person_in_image_id: nil, person_in_image_name: nil, product_in_image_description: nil, product_in_image_gtin: nil, product_in_image_name: nil, property_release_id: nil, province_state: nil, rating: nil, registry_entry_role: nil, registry_item_id: nil, registry_organisation_id: nil, resolution_unit: nil, rights: nil, scene: nil, source: nil, special_instructions: nil, state: nil, subject: nil, subject_code: nil, subject_reference: nil, sublocation: nil, time_created: nil, title: nil, transmission_reference: nil, usage_terms: nil, web_statement: nil, writer: nil, writer_editor: nil, x_resolution: nil, y_resolution: nil) + # 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 about_cv_term_cv_id [String] + # @param about_cv_term_id [String] + # @param about_cv_term_name [String] + # @param about_cv_term_refined_about [String] + # @param additional_model_information [String] + # @param application_record_version [Integer] + # @param artist [String] + # @param artwork_circa_date_created [String] + # @param artwork_content_description [String] + # @param artwork_contribution_description [String] + # @param artwork_copyright_notice [String] + # @param artwork_copyright_owner_id [String] + # @param artwork_copyright_owner_name [String] + # @param artwork_creator [Array] + # @param artwork_creator_id [Array] + # @param artwork_date_created [Time] + # @param artwork_licensor_id [String] + # @param artwork_licensor_name [String] + # @param artwork_physical_description [String] + # @param artwork_source [String] + # @param artwork_source_inventory_no [String] + # @param artwork_source_inv_url [String] + # @param artwork_style_period [Array] + # @param artwork_title [String] + # @param authors_position [String] + # @param byline [String] + # @param byline_title [String] + # @param caption [String] + # @param caption_abstract [String] + # @param caption_writer [String] + # @param city [String] + # @param color_space [String] + # @param components_configuration [String] + # @param copyright [String] + # @param copyright_notice [String] + # @param copyright_owner_id [Array] + # @param copyright_owner_name [Array] + # @param country [String] + # @param country_code [String] + # @param country_primary_location_code [String] + # @param country_primary_location_name [String] + # @param creator [String] + # @param creator_address [String] + # @param creator_city [String] + # @param creator_country [String] + # @param creator_postal_code [String] + # @param creator_region [String] + # @param creator_work_email [String] + # @param creator_work_telephone [String] + # @param creator_work_url [String] + # @param credit [String] + # @param date_created [Time] + # @param date_time_created [Time] + # @param date_time_original [Time] + # @param description [String] + # @param digital_image_guid [String] + # @param digital_source_type [String] + # @param embedded_encoded_rights_expr [String] + # @param embedded_encoded_rights_expr_lang_id [String] + # @param embedded_encoded_rights_expr_type [String] + # @param event [String] + # @param exif_version [String] + # @param flashpix_version [String] + # @param genre_cv_id [String] + # @param genre_cv_term_id [String] + # @param genre_cv_term_name [String] + # @param genre_cv_term_refined_about [String] + # @param headline [String] + # @param image_creator_id [String] + # @param image_creator_image_id [String] + # @param image_creator_name [String] + # @param image_description [String] + # @param image_region_boundary_h [Array] + # @param image_region_boundary_rx [Array] + # @param image_region_boundary_shape [Array] + # @param image_region_boundary_unit [Array] + # @param image_region_boundary_vertices_x [Array] + # @param image_region_boundary_vertices_y [Array] + # @param image_region_boundary_w [Array] + # @param image_region_boundary_x [Array] + # @param image_region_boundary_y [Array] + # @param image_region_ctype_identifier [Array] + # @param image_region_ctype_name [Array] + # @param image_region_id [Array] + # @param image_region_name [Array] + # @param image_region_organisation_in_image_name [Array] + # @param image_region_person_in_image [Array] + # @param image_region_role_identifier [Array] + # @param image_region_role_name [Array] + # @param image_supplier_id [String] + # @param image_supplier_image_id [String] + # @param image_supplier_name [String] + # @param instructions [String] + # @param intellectual_genre [String] + # @param keywords [Array] + # @param licensor_city [Array] + # @param licensor_country [Array] + # @param licensor_email [Array] + # @param licensor_extended_address [Array] + # @param licensor_id [Array] + # @param licensor_name [Array] + # @param licensor_postal_code [Array] + # @param licensor_region [Array] + # @param licensor_street_address [Array] + # @param licensor_telephone1 [Array] + # @param licensor_telephone2 [Array] + # @param licensor_url [Array] + # @param linked_encoded_rights_expr [String] + # @param linked_encoded_rights_expr_lang_id [String] + # @param linked_encoded_rights_expr_type [String] + # @param location [String] + # @param location_created_city [String] + # @param location_created_country_code [String] + # @param location_created_country_name [String] + # @param location_created_gps_altitude [String] + # @param location_created_gps_latitude [String] + # @param location_created_gps_longitude [String] + # @param location_created_location_id [String] + # @param location_created_location_name [String] + # @param location_created_province_state [String] + # @param location_created_sublocation [String] + # @param location_created_world_region [String] + # @param location_shown_city [Array] + # @param location_shown_country_code [Array] + # @param location_shown_country_name [Array] + # @param location_shown_gps_altitude [Array] + # @param location_shown_gps_latitude [Array] + # @param location_shown_gps_longitude [Array] + # @param location_shown_location_id [Array] + # @param location_shown_location_name [Array] + # @param location_shown_province_state [Array] + # @param location_shown_sublocation [Array] + # @param location_shown_world_region [Array] + # @param max_avail_height [Float] + # @param max_avail_width [Float] + # @param model_age [Array] + # @param model_release_id [Array] + # @param object_attribute_reference [String] + # @param object_name [String] + # @param offset_time_original [String] + # @param organisation_in_image_code [Array] + # @param organisation_in_image_name [Array] + # @param orientation [String] + # @param original_transmission_reference [String] + # @param person_in_image [Array] + # @param person_in_image_cv_term_cv_id [Array] + # @param person_in_image_cv_term_id [Array] + # @param person_in_image_cv_term_name [Array] + # @param person_in_image_cv_term_refined_about [Array] + # @param person_in_image_description [Array] + # @param person_in_image_id [Array] + # @param person_in_image_name [Array] + # @param product_in_image_description [Array] + # @param product_in_image_gtin [Array] + # @param product_in_image_name [Array] + # @param property_release_id [Array] + # @param province_state [String] + # @param rating [Integer] + # @param registry_entry_role [Array] + # @param registry_item_id [Array] + # @param registry_organisation_id [Array] + # @param resolution_unit [String] + # @param rights [String] + # @param scene [Array] + # @param source [String] + # @param special_instructions [String] + # @param state [String] + # @param subject [Array] + # @param subject_code [Array] + # @param subject_reference [Array] + # @param sublocation [String] + # @param time_created [String] + # @param title [String] + # @param transmission_reference [String] + # @param usage_terms [String] + # @param web_statement [String] + # @param writer [String] + # @param writer_editor [String] + # @param x_resolution [Float] + # @param y_resolution [Float] + end + + # @see Imagekit::Models::FileUploadV2Response#extension_status + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute aws_auto_tagging + # + # @return [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging, nil] + optional :aws_auto_tagging, + enum: -> { Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging }, + api_name: :"aws-auto-tagging" + + # @!attribute google_auto_tagging + # + # @return [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging, nil] + optional :google_auto_tagging, + enum: -> { Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging }, + api_name: :"google-auto-tagging" + + # @!attribute remove_bg + # + # @return [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg, nil] + optional :remove_bg, + enum: -> { Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg }, + api_name: :"remove-bg" + + # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # 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. + # + # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg] + + # @see Imagekit::Models::FileUploadV2Response::ExtensionStatus#aws_auto_tagging + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUploadV2Response::ExtensionStatus#google_auto_tagging + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUploadV2Response::ExtensionStatus#remove_bg + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::FileUploadV2Response#metadata + class Metadata < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::FileUploadV2Response::Metadata::Exif, nil] + optional :exif, -> { Imagekit::Models::FileUploadV2Response::Metadata::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::FileUploadV2Response::Metadata::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::FileUploadV2Response::Metadata#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::ExifDetails, nil] + optional :exif, -> { Imagekit::ExifDetails } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::Gps, nil] + optional :gps, -> { Imagekit::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::ExifImage, nil] + optional :image, -> { Imagekit::ExifImage } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::Interoperability, nil] + optional :interoperability, -> { Imagekit::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. + # + # @param gps [Imagekit::Models::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. + end + end + + # @see Imagekit::Models::FileUploadV2Response#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end +end diff --git a/lib/imagekit/models/files/batch_delete_params.rb b/lib/imagekit/models/files/batch_delete_params.rb new file mode 100644 index 00000000..e69774e9 --- /dev/null +++ b/lib/imagekit/models/files/batch_delete_params.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Batch#delete + class BatchDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_ids + # An array of fileIds which you want to delete. + # + # @return [Array] + required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + + # @!method initialize(file_ids:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BatchDeleteParams} for more details. + # + # @param file_ids [Array] An array of fileIds which you want to delete. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/batch_delete_response.rb b/lib/imagekit/models/files/batch_delete_response.rb new file mode 100644 index 00000000..62d9529d --- /dev/null +++ b/lib/imagekit/models/files/batch_delete_response.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Batch#delete + class BatchDeleteResponse < Imagekit::Internal::Type::BaseModel + # @!attribute successfully_deleted_file_ids + # An array of fileIds that were successfully deleted. + # + # @return [Array, nil] + optional :successfully_deleted_file_ids, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :successfullyDeletedFileIds + + # @!method initialize(successfully_deleted_file_ids: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BatchDeleteResponse} for more details. + # + # @param successfully_deleted_file_ids [Array] An array of fileIds that were successfully deleted. + end + end + end +end diff --git a/lib/imagekit/models/files/detail_retrieve_params.rb b/lib/imagekit/models/files/detail_retrieve_params.rb new file mode 100644 index 00000000..d0273a14 --- /dev/null +++ b/lib/imagekit/models/files/detail_retrieve_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Details#retrieve + class DetailRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/detail_retrieve_response.rb b/lib/imagekit/models/files/detail_retrieve_response.rb new file mode 100644 index 00000000..2626b851 --- /dev/null +++ b/lib/imagekit/models/files/detail_retrieve_response.rb @@ -0,0 +1,249 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Details#retrieve + class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::DetailRetrieveResponse::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute created_at + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :created_at, String, api_name: :createdAt + + # @!attribute custom_coordinates + # An string with custom coordinates of the file. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # An object with custom metadata for the file. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute file_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # 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`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute has_alpha + # Specifies if the image has an alpha channel. + # + # @return [Boolean, nil] + optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha + + # @!attribute height + # Height of the file. + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # Specifies if the file is private or not. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # Specifies if the file is published or not. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute mime + # MIME type of the file. + # + # @return [String, nil] + optional :mime, String + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the file in bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + # + # @return [String, nil] + optional :thumbnail, String + + # @!attribute type + # Type of the asset. + # + # @return [String, nil] + optional :type, String + + # @!attribute updated_at + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :updated_at, String, api_name: :updatedAt + + # @!attribute url + # URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object with details of the file version. + # + # @return [Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, nil] + optional :version_info, + -> { Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo }, + api_name: :versionInfo + + # @!attribute width + # Width of the file. + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailRetrieveResponse} for more details. + # + # Object containing details of a file or file version. + # + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # + # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # + # @param custom_coordinates [String, nil] An string with custom coordinates of the file. + # + # @param custom_metadata [Object] An object with custom metadata for the file. + # + # @param file_id [String] Unique identifier of the asset. + # + # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. + # + # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. + # + # @param has_alpha [Boolean] Specifies if the image has an alpha channel. + # + # @param height [Float] Height of the file. + # + # @param is_private_file [Boolean] Specifies if the file is private or not. + # + # @param is_published [Boolean] Specifies if the file is published or not. + # + # @param mime [String] MIME type of the file. + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the file in bytes. + # + # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi + # + # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th + # + # @param type [String] Type of the asset. + # + # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # + # @param url [String] URL of the file. + # + # @param version_info [Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo] An object with details of the file version. + # + # @param width [Float] Width of the file. + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailRetrieveResponse::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi + end + + # @see Imagekit::Models::Files::DetailRetrieveResponse#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object with details of the file version. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end + end +end diff --git a/lib/imagekit/models/files/detail_update_params.rb b/lib/imagekit/models/files/detail_update_params.rb new file mode 100644 index 00000000..e055c8f7 --- /dev/null +++ b/lib/imagekit/models/files/detail_update_params.rb @@ -0,0 +1,289 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Details#update + class DetailUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # 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. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute extensions + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + # + # @return [Array, nil] + optional :extensions, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::Files::DetailUpdateParams::Extension] + } + + # @!attribute remove_ai_tags + # 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. + # + # @return [Array, Symbol, Imagekit::Models::Files::DetailUpdateParams::RemoveAITags, nil] + optional :remove_ai_tags, + union: -> { Imagekit::Files::DetailUpdateParams::RemoveAITags }, + api_name: :removeAITags + + # @!attribute tags + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!attribute publish + # Configure the publication status of a file and its versions. + # + # @return [Imagekit::Models::Files::DetailUpdateParams::Publish, nil] + optional :publish, -> { Imagekit::Files::DetailUpdateParams::Publish } + + # @!method initialize(custom_coordinates: nil, custom_metadata: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailUpdateParams} for more details. + # + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Object] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, Imagekit::Models::Files::DetailUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param publish [Imagekit::Models::Files::DetailUpdateParams::Publish] Configure the publication status of a file and its versions. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + module Extension + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension } + + variant -> { Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name] + required :name, + enum: -> { + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name + } + + # @!attribute options + # + # @return [Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options, nil] + optional :options, + -> { + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options + } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name] + required :name, + enum: -> { + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name + } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension, Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension)] + end + + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Files::DetailUpdateParams::RemoveAITags::StringArray } + + variant const: -> { Imagekit::Models::Files::DetailUpdateParams::RemoveAITags::ALL } + + # @!method self.variants + # @return [Array(Array, Symbol)] + + define_sorbet_constant!(:Variants) do + T.type_alias do + T.any(T::Array[String], Imagekit::Files::DetailUpdateParams::RemoveAITags::TaggedSymbol) + end + end + + # @type [Imagekit::Internal::Type::Converter] + StringArray = Imagekit::Internal::Type::ArrayOf[String] + + # @!group + + ALL = :all + + # @!endgroup + end + + class Publish < Imagekit::Internal::Type::BaseModel + # @!attribute is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @return [Boolean] + required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + # + # @return [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + + # @!method initialize(is_published:, include_file_versions: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailUpdateParams::Publish} for more details. + # + # Configure the publication status of a file and its versions. + # + # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p + end + end + end + end +end diff --git a/lib/imagekit/models/files/detail_update_response.rb b/lib/imagekit/models/files/detail_update_response.rb new file mode 100644 index 00000000..a5438fa8 --- /dev/null +++ b/lib/imagekit/models/files/detail_update_response.rb @@ -0,0 +1,321 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Details#update + class DetailUpdateResponse < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::DetailUpdateResponse::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute created_at + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :created_at, String, api_name: :createdAt + + # @!attribute custom_coordinates + # An string with custom coordinates of the file. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # An object with custom metadata for the file. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute extension_status + # + # @return [Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, nil] + optional :extension_status, + -> { Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus }, + api_name: :extensionStatus + + # @!attribute file_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # 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`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute has_alpha + # Specifies if the image has an alpha channel. + # + # @return [Boolean, nil] + optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha + + # @!attribute height + # Height of the file. + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # Specifies if the file is private or not. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # Specifies if the file is published or not. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute mime + # MIME type of the file. + # + # @return [String, nil] + optional :mime, String + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the file in bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + # + # @return [String, nil] + optional :thumbnail, String + + # @!attribute type + # Type of the asset. + # + # @return [String, nil] + optional :type, String + + # @!attribute updated_at + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :updated_at, String, api_name: :updatedAt + + # @!attribute url + # URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object with details of the file version. + # + # @return [Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, nil] + optional :version_info, + -> { Imagekit::Models::Files::DetailUpdateResponse::VersionInfo }, + api_name: :versionInfo + + # @!attribute width + # Width of the file. + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailUpdateResponse} for more details. + # + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # + # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # + # @param custom_coordinates [String, nil] An string with custom coordinates of the file. + # + # @param custom_metadata [Object] An object with custom metadata for the file. + # + # @param extension_status [Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus] + # + # @param file_id [String] Unique identifier of the asset. + # + # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. + # + # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. + # + # @param has_alpha [Boolean] Specifies if the image has an alpha channel. + # + # @param height [Float] Height of the file. + # + # @param is_private_file [Boolean] Specifies if the file is private or not. + # + # @param is_published [Boolean] Specifies if the file is published or not. + # + # @param mime [String] MIME type of the file. + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the file in bytes. + # + # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi + # + # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th + # + # @param type [String] Type of the asset. + # + # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # + # @param url [String] URL of the file. + # + # @param version_info [Imagekit::Models::Files::DetailUpdateResponse::VersionInfo] An object with details of the file version. + # + # @param width [Float] Width of the file. + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailUpdateResponse::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi + end + + # @see Imagekit::Models::Files::DetailUpdateResponse#extension_status + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute aws_auto_tagging + # + # @return [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging, nil] + optional :aws_auto_tagging, + enum: -> { Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging }, + api_name: :"aws-auto-tagging" + + # @!attribute google_auto_tagging + # + # @return [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging, nil] + optional :google_auto_tagging, + enum: -> { Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging }, + api_name: :"google-auto-tagging" + + # @!attribute remove_bg + # + # @return [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg, nil] + optional :remove_bg, + enum: -> { Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg }, + api_name: :"remove-bg" + + # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @param aws_auto_tagging [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg] + + # @see Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus#aws_auto_tagging + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus#google_auto_tagging + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus#remove_bg + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::Files::DetailUpdateResponse#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object with details of the file version. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end + end +end diff --git a/lib/imagekit/models/files/metadata_from_url_params.rb b/lib/imagekit/models/files/metadata_from_url_params.rb new file mode 100644 index 00000000..4d9e2c49 --- /dev/null +++ b/lib/imagekit/models/files/metadata_from_url_params.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Metadata#from_url + class MetadataFromURLParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute url + # Should be a valid file URL. It should be accessible using your ImageKit.io + # account. + # + # @return [String] + required :url, String + + # @!method initialize(url:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::MetadataFromURLParams} for more details. + # + # @param url [String] Should be a valid file URL. It should be accessible using your ImageKit.io accou + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/metadata_from_url_response.rb b/lib/imagekit/models/files/metadata_from_url_response.rb new file mode 100644 index 00000000..450e4fa8 --- /dev/null +++ b/lib/imagekit/models/files/metadata_from_url_response.rb @@ -0,0 +1,175 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Metadata#from_url + class MetadataFromURLResponse < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::Files::MetadataFromURLResponse::Exif, nil] + optional :exif, -> { Imagekit::Models::Files::MetadataFromURLResponse::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # JSON object containing metadata. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::Files::MetadataFromURLResponse::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::Files::MetadataFromURLResponse#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::ExifDetails, nil] + optional :exif, -> { Imagekit::ExifDetails } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::Gps, nil] + optional :gps, -> { Imagekit::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::ExifImage, nil] + optional :image, -> { Imagekit::ExifImage } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::Interoperability, nil] + optional :interoperability, -> { Imagekit::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. + # + # @param gps [Imagekit::Models::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. + end + end + end + end +end diff --git a/lib/imagekit/models/files/metadata_retrieve_params.rb b/lib/imagekit/models/files/metadata_retrieve_params.rb new file mode 100644 index 00000000..39ad6940 --- /dev/null +++ b/lib/imagekit/models/files/metadata_retrieve_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Metadata#retrieve + class MetadataRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/metadata_retrieve_response.rb b/lib/imagekit/models/files/metadata_retrieve_response.rb new file mode 100644 index 00000000..4b12c537 --- /dev/null +++ b/lib/imagekit/models/files/metadata_retrieve_response.rb @@ -0,0 +1,175 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Metadata#retrieve + class MetadataRetrieveResponse < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::Files::MetadataRetrieveResponse::Exif, nil] + optional :exif, -> { Imagekit::Models::Files::MetadataRetrieveResponse::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # JSON object containing metadata. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::Files::MetadataRetrieveResponse::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::Files::MetadataRetrieveResponse#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::ExifDetails, nil] + optional :exif, -> { Imagekit::ExifDetails } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::Gps, nil] + optional :gps, -> { Imagekit::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::ExifImage, nil] + optional :image, -> { Imagekit::ExifImage } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::Interoperability, nil] + optional :interoperability, -> { Imagekit::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. + # + # @param gps [Imagekit::Models::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. + end + end + end + end +end diff --git a/lib/imagekit/models/files/purge_execute_params.rb b/lib/imagekit/models/files/purge_execute_params.rb new file mode 100644 index 00000000..cfa8acca --- /dev/null +++ b/lib/imagekit/models/files/purge_execute_params.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Purge#execute + class PurgeExecuteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute url + # The full URL of the file to be purged. + # + # @return [String] + required :url, String + + # @!method initialize(url:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::PurgeExecuteParams} for more details. + # + # @param url [String] The full URL of the file to be purged. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/purge_execute_response.rb b/lib/imagekit/models/files/purge_execute_response.rb new file mode 100644 index 00000000..3d2493fb --- /dev/null +++ b/lib/imagekit/models/files/purge_execute_response.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Purge#execute + class PurgeExecuteResponse < Imagekit::Internal::Type::BaseModel + # @!attribute request_id + # Unique identifier of the purge request. This can be used to check the status of + # the purge request. + # + # @return [String, nil] + optional :request_id, String, api_name: :requestId + + # @!method initialize(request_id: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::PurgeExecuteResponse} for more details. + # + # @param request_id [String] Unique identifier of the purge request. This can be used to check the status of + end + end + end +end diff --git a/lib/imagekit/models/files/purge_status_params.rb b/lib/imagekit/models/files/purge_status_params.rb new file mode 100644 index 00000000..5cdadb69 --- /dev/null +++ b/lib/imagekit/models/files/purge_status_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Purge#status + class PurgeStatusParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/purge_status_response.rb b/lib/imagekit/models/files/purge_status_response.rb new file mode 100644 index 00000000..febe869b --- /dev/null +++ b/lib/imagekit/models/files/purge_status_response.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Purge#status + class PurgeStatusResponse < Imagekit::Internal::Type::BaseModel + # @!attribute status + # Status of the purge request. + # + # @return [Symbol, Imagekit::Models::Files::PurgeStatusResponse::Status, nil] + optional :status, enum: -> { Imagekit::Models::Files::PurgeStatusResponse::Status } + + # @!method initialize(status: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::PurgeStatusResponse} for more details. + # + # @param status [Symbol, Imagekit::Models::Files::PurgeStatusResponse::Status] Status of the purge request. + + # Status of the purge request. + # + # @see Imagekit::Models::Files::PurgeStatusResponse#status + module Status + extend Imagekit::Internal::Type::Enum + + PENDING = :Pending + COMPLETED = :Completed + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/imagekit/models/files/version_delete_params.rb b/lib/imagekit/models/files/version_delete_params.rb new file mode 100644 index 00000000..e17425f1 --- /dev/null +++ b/lib/imagekit/models/files/version_delete_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Versions#delete + class VersionDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_id + # + # @return [String] + required :file_id, String + + # @!method initialize(file_id:, request_options: {}) + # @param file_id [String] + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/version_delete_response.rb b/lib/imagekit/models/files/version_delete_response.rb new file mode 100644 index 00000000..ec0283ba --- /dev/null +++ b/lib/imagekit/models/files/version_delete_response.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @type [Imagekit::Internal::Type::Converter] + VersionDeleteResponse = Imagekit::Internal::Type::Unknown + end + end +end diff --git a/lib/imagekit/models/files/version_list_params.rb b/lib/imagekit/models/files/version_list_params.rb new file mode 100644 index 00000000..82bf2cc3 --- /dev/null +++ b/lib/imagekit/models/files/version_list_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Versions#list + class VersionListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/version_list_response.rb b/lib/imagekit/models/files/version_list_response.rb new file mode 100644 index 00000000..e7afad53 --- /dev/null +++ b/lib/imagekit/models/files/version_list_response.rb @@ -0,0 +1,252 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + class VersionListResponseItem < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionListResponseItem::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute created_at + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :created_at, String, api_name: :createdAt + + # @!attribute custom_coordinates + # An string with custom coordinates of the file. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # An object with custom metadata for the file. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute file_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # 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`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute has_alpha + # Specifies if the image has an alpha channel. + # + # @return [Boolean, nil] + optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha + + # @!attribute height + # Height of the file. + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # Specifies if the file is private or not. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # Specifies if the file is published or not. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute mime + # MIME type of the file. + # + # @return [String, nil] + optional :mime, String + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the file in bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + # + # @return [String, nil] + optional :thumbnail, String + + # @!attribute type + # Type of the asset. + # + # @return [String, nil] + optional :type, String + + # @!attribute updated_at + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :updated_at, String, api_name: :updatedAt + + # @!attribute url + # URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object with details of the file version. + # + # @return [Imagekit::Models::Files::VersionListResponseItem::VersionInfo, nil] + optional :version_info, + -> { Imagekit::Models::Files::VersionListResponseItem::VersionInfo }, + api_name: :versionInfo + + # @!attribute width + # Width of the file. + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionListResponseItem} for more details. + # + # Object containing details of a file or file version. + # + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # + # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # + # @param custom_coordinates [String, nil] An string with custom coordinates of the file. + # + # @param custom_metadata [Object] An object with custom metadata for the file. + # + # @param file_id [String] Unique identifier of the asset. + # + # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. + # + # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. + # + # @param has_alpha [Boolean] Specifies if the image has an alpha channel. + # + # @param height [Float] Height of the file. + # + # @param is_private_file [Boolean] Specifies if the file is private or not. + # + # @param is_published [Boolean] Specifies if the file is published or not. + # + # @param mime [String] MIME type of the file. + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the file in bytes. + # + # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi + # + # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th + # + # @param type [String] Type of the asset. + # + # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # + # @param url [String] URL of the file. + # + # @param version_info [Imagekit::Models::Files::VersionListResponseItem::VersionInfo] An object with details of the file version. + # + # @param width [Float] Width of the file. + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionListResponseItem::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi + end + + # @see Imagekit::Models::Files::VersionListResponseItem#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object with details of the file version. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + + # @type [Imagekit::Internal::Type::Converter] + VersionListResponse = + Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Models::Files::VersionListResponseItem }] + end + end +end diff --git a/lib/imagekit/models/files/version_restore_params.rb b/lib/imagekit/models/files/version_restore_params.rb new file mode 100644 index 00000000..bf1e8c63 --- /dev/null +++ b/lib/imagekit/models/files/version_restore_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Versions#restore + class VersionRestoreParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_id + # + # @return [String] + required :file_id, String + + # @!method initialize(file_id:, request_options: {}) + # @param file_id [String] + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/version_restore_response.rb b/lib/imagekit/models/files/version_restore_response.rb new file mode 100644 index 00000000..641285ea --- /dev/null +++ b/lib/imagekit/models/files/version_restore_response.rb @@ -0,0 +1,249 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Versions#restore + class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRestoreResponse::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute created_at + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :created_at, String, api_name: :createdAt + + # @!attribute custom_coordinates + # An string with custom coordinates of the file. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # An object with custom metadata for the file. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute file_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # 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`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute has_alpha + # Specifies if the image has an alpha channel. + # + # @return [Boolean, nil] + optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha + + # @!attribute height + # Height of the file. + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # Specifies if the file is private or not. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # Specifies if the file is published or not. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute mime + # MIME type of the file. + # + # @return [String, nil] + optional :mime, String + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the file in bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + # + # @return [String, nil] + optional :thumbnail, String + + # @!attribute type + # Type of the asset. + # + # @return [String, nil] + optional :type, String + + # @!attribute updated_at + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :updated_at, String, api_name: :updatedAt + + # @!attribute url + # URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object with details of the file version. + # + # @return [Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, nil] + optional :version_info, + -> { Imagekit::Models::Files::VersionRestoreResponse::VersionInfo }, + api_name: :versionInfo + + # @!attribute width + # Width of the file. + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionRestoreResponse} for more details. + # + # Object containing details of a file or file version. + # + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # + # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # + # @param custom_coordinates [String, nil] An string with custom coordinates of the file. + # + # @param custom_metadata [Object] An object with custom metadata for the file. + # + # @param file_id [String] Unique identifier of the asset. + # + # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. + # + # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. + # + # @param has_alpha [Boolean] Specifies if the image has an alpha channel. + # + # @param height [Float] Height of the file. + # + # @param is_private_file [Boolean] Specifies if the file is private or not. + # + # @param is_published [Boolean] Specifies if the file is published or not. + # + # @param mime [String] MIME type of the file. + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the file in bytes. + # + # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi + # + # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th + # + # @param type [String] Type of the asset. + # + # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # + # @param url [String] URL of the file. + # + # @param version_info [Imagekit::Models::Files::VersionRestoreResponse::VersionInfo] An object with details of the file version. + # + # @param width [Float] Width of the file. + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionRestoreResponse::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi + end + + # @see Imagekit::Models::Files::VersionRestoreResponse#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object with details of the file version. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end + end +end diff --git a/lib/imagekit/models/files/version_retrieve_params.rb b/lib/imagekit/models/files/version_retrieve_params.rb new file mode 100644 index 00000000..7fccc1e5 --- /dev/null +++ b/lib/imagekit/models/files/version_retrieve_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Versions#retrieve + class VersionRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_id + # + # @return [String] + required :file_id, String + + # @!method initialize(file_id:, request_options: {}) + # @param file_id [String] + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/version_retrieve_response.rb b/lib/imagekit/models/files/version_retrieve_response.rb new file mode 100644 index 00000000..5afab187 --- /dev/null +++ b/lib/imagekit/models/files/version_retrieve_response.rb @@ -0,0 +1,249 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Versions#retrieve + class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRetrieveResponse::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute created_at + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :created_at, String, api_name: :createdAt + + # @!attribute custom_coordinates + # An string with custom coordinates of the file. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # An object with custom metadata for the file. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute file_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # 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`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute has_alpha + # Specifies if the image has an alpha channel. + # + # @return [Boolean, nil] + optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha + + # @!attribute height + # Height of the file. + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # Specifies if the file is private or not. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # Specifies if the file is published or not. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute mime + # MIME type of the file. + # + # @return [String, nil] + optional :mime, String + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the file in bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + # + # @return [String, nil] + optional :thumbnail, String + + # @!attribute type + # Type of the asset. + # + # @return [String, nil] + optional :type, String + + # @!attribute updated_at + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :updated_at, String, api_name: :updatedAt + + # @!attribute url + # URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object with details of the file version. + # + # @return [Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, nil] + optional :version_info, + -> { Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo }, + api_name: :versionInfo + + # @!attribute width + # Width of the file. + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionRetrieveResponse} for more details. + # + # Object containing details of a file or file version. + # + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # + # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # + # @param custom_coordinates [String, nil] An string with custom coordinates of the file. + # + # @param custom_metadata [Object] An object with custom metadata for the file. + # + # @param file_id [String] Unique identifier of the asset. + # + # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. + # + # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. + # + # @param has_alpha [Boolean] Specifies if the image has an alpha channel. + # + # @param height [Float] Height of the file. + # + # @param is_private_file [Boolean] Specifies if the file is private or not. + # + # @param is_published [Boolean] Specifies if the file is published or not. + # + # @param mime [String] MIME type of the file. + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the file in bytes. + # + # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi + # + # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th + # + # @param type [String] Type of the asset. + # + # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # + # @param url [String] URL of the file. + # + # @param version_info [Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo] An object with details of the file version. + # + # @param width [Float] Width of the file. + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionRetrieveResponse::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi + end + + # @see Imagekit::Models::Files::VersionRetrieveResponse#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object with details of the file version. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end + end +end diff --git a/lib/imagekit/models/folder_create_params.rb b/lib/imagekit/models/folder_create_params.rb new file mode 100644 index 00000000..637829d2 --- /dev/null +++ b/lib/imagekit/models/folder_create_params.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Folder#create + class FolderCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute folder_name + # 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. + # `_`. + # + # @return [String] + required :folder_name, String, api_name: :folderName + + # @!attribute parent_folder_path + # 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 [String] + required :parent_folder_path, String, api_name: :parentFolderPath + + # @!method initialize(folder_name:, parent_folder_path:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderCreateParams} for more details. + # + # @param folder_name [String] The folder will be created with this name. + # + # @param parent_folder_path [String] The folder where the new folder should be created, for root use `/` else the pat + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/folder_create_response.rb b/lib/imagekit/models/folder_create_response.rb new file mode 100644 index 00000000..9e305c04 --- /dev/null +++ b/lib/imagekit/models/folder_create_response.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @type [Imagekit::Internal::Type::Converter] + FolderCreateResponse = Imagekit::Internal::Type::Unknown + end +end diff --git a/lib/imagekit/models/folder_delete_params.rb b/lib/imagekit/models/folder_delete_params.rb new file mode 100644 index 00000000..b00ca7aa --- /dev/null +++ b/lib/imagekit/models/folder_delete_params.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Folder#delete + class FolderDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute folder_path + # Full path to the folder you want to delete. For example `/folder/to/delete/`. + # + # @return [String] + required :folder_path, String, api_name: :folderPath + + # @!method initialize(folder_path:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderDeleteParams} for more details. + # + # @param folder_path [String] Full path to the folder you want to delete. For example `/folder/to/delete/`. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/folder_delete_response.rb b/lib/imagekit/models/folder_delete_response.rb new file mode 100644 index 00000000..7bd5838b --- /dev/null +++ b/lib/imagekit/models/folder_delete_response.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @type [Imagekit::Internal::Type::Converter] + FolderDeleteResponse = Imagekit::Internal::Type::Unknown + end +end diff --git a/lib/imagekit/models/gps.rb b/lib/imagekit/models/gps.rb new file mode 100644 index 00000000..da477fce --- /dev/null +++ b/lib/imagekit/models/gps.rb @@ -0,0 +1,17 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + end +end diff --git a/lib/imagekit/models/interoperability.rb b/lib/imagekit/models/interoperability.rb new file mode 100644 index 00000000..23925987 --- /dev/null +++ b/lib/imagekit/models/interoperability.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + end +end diff --git a/lib/imagekit/models/thumbnail.rb b/lib/imagekit/models/thumbnail.rb new file mode 100644 index 00000000..8b864ac0 --- /dev/null +++ b/lib/imagekit/models/thumbnail.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end + end +end diff --git a/lib/imagekit/request_options.rb b/lib/imagekit/request_options.rb new file mode 100644 index 00000000..2e8ffb9e --- /dev/null +++ b/lib/imagekit/request_options.rb @@ -0,0 +1,77 @@ +# frozen_string_literal: true + +module Imagekit + # Specify HTTP behaviour to use for a specific request. These options supplement + # or override those provided at the client level. + # + # When making a request, you can pass an actual {RequestOptions} instance, or + # simply pass a Hash with symbol keys matching the attributes on this class. + class RequestOptions < Imagekit::Internal::Type::BaseModel + # @api private + # + # @param opts [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # + # @raise [ArgumentError] + def self.validate!(opts) + case opts + in Imagekit::RequestOptions | Hash + opts.to_h.each_key do |k| + unless fields.include?(k) + raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}") + end + end + else + raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}") + end + end + + # @!attribute idempotency_key + # Idempotency key to send with request and all associated retries. Will only be + # sent for write requests. + # + # @return [String, nil] + optional :idempotency_key, String + + # @!attribute extra_query + # Extra query params to send with the request. These are `.merge`’d into any + # `query` given at the client level. + # + # @return [Hash{String=>Array, String, nil}, nil] + optional :extra_query, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::ArrayOf[String]] + + # @!attribute extra_headers + # Extra headers to send with the request. These are `.merged`’d into any + # `extra_headers` given at the client level. + # + # @return [Hash{String=>String, nil}, nil] + optional :extra_headers, Imagekit::Internal::Type::HashOf[String, nil?: true] + + # @!attribute extra_body + # Extra data to send with the request. These are deep merged into any data + # generated as part of the normal request. + # + # @return [Object, nil] + optional :extra_body, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute max_retries + # Maximum number of retries to attempt after a failed initial request. + # + # @return [Integer, nil] + optional :max_retries, Integer + + # @!attribute timeout + # Request timeout in seconds. + # + # @return [Float, nil] + optional :timeout, Float + + # @!method initialize(values = {}) + # Returns a new instance of RequestOptions. + # + # @param values [Hash{Symbol=>Object}] + + define_sorbet_constant!(:OrHash) do + T.type_alias { T.any(Imagekit::RequestOptions, Imagekit::Internal::AnyHash) } + end + end +end diff --git a/lib/imagekit/resources/accounts.rb b/lib/imagekit/resources/accounts.rb new file mode 100644 index 00000000..c596f110 --- /dev/null +++ b/lib/imagekit/resources/accounts.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Accounts + # Some parameter documentations has been truncated, see + # {Imagekit::Models::AccountGetUsageParams} for more details. + # + # 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. + # + # @overload get_usage(end_date:, start_date:, request_options: {}) + # + # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. + # + # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::AccountGetUsageResponse] + # + # @see Imagekit::Models::AccountGetUsageParams + def get_usage(params) + parsed, options = Imagekit::AccountGetUsageParams.dump_request(params) + @client.request( + method: :get, + path: "v1/accounts/usage", + query: parsed.transform_keys(end_date: "endDate", start_date: "startDate"), + model: Imagekit::Models::AccountGetUsageResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/imagekit/resources/bulk_jobs.rb b/lib/imagekit/resources/bulk_jobs.rb new file mode 100644 index 00000000..b1e27990 --- /dev/null +++ b/lib/imagekit/resources/bulk_jobs.rb @@ -0,0 +1,100 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class BulkJobs + # Some parameter documentations has been truncated, see + # {Imagekit::Models::BulkJobCopyFolderParams} for more details. + # + # 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. + # + # @overload copy_folder(destination_path:, source_folder_path:, include_versions: nil, request_options: {}) + # + # @param destination_path [String] Full path to the destination folder where you want to copy the source folder int + # + # @param source_folder_path [String] The full path to the source folder you want to copy. + # + # @param include_versions [Boolean] Option to copy all versions of files that are nested inside the selected folder. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::BulkJobCopyFolderResponse] + # + # @see Imagekit::Models::BulkJobCopyFolderParams + def copy_folder(params) + parsed, options = Imagekit::BulkJobCopyFolderParams.dump_request(params) + @client.request( + method: :post, + path: "v1/bulkJobs/copyFolder", + body: parsed, + model: Imagekit::Models::BulkJobCopyFolderResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::BulkJobMoveFolderParams} for more details. + # + # 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. + # + # @overload move_folder(destination_path:, source_folder_path:, request_options: {}) + # + # @param destination_path [String] Full path to the destination folder where you want to move the source folder int + # + # @param source_folder_path [String] The full path to the source folder you want to move. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::BulkJobMoveFolderResponse] + # + # @see Imagekit::Models::BulkJobMoveFolderParams + def move_folder(params) + parsed, options = Imagekit::BulkJobMoveFolderParams.dump_request(params) + @client.request( + method: :post, + path: "v1/bulkJobs/moveFolder", + body: parsed, + model: Imagekit::Models::BulkJobMoveFolderResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::BulkJobRetrieveStatusParams} for more details. + # + # This API returns the status of a bulk job like copy and move folder operations. + # + # @overload retrieve_status(job_id, request_options: {}) + # + # @param job_id [String] The `jobId` is returned in the response of bulk job API e.g. copy folder or move + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::BulkJobRetrieveStatusResponse] + # + # @see Imagekit::Models::BulkJobRetrieveStatusParams + def retrieve_status(job_id, params = {}) + @client.request( + method: :get, + path: ["v1/bulkJobs/%1$s", job_id], + model: Imagekit::Models::BulkJobRetrieveStatusResponse, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/imagekit/resources/custom_metadata_fields.rb b/lib/imagekit/resources/custom_metadata_fields.rb new file mode 100644 index 00000000..263973fd --- /dev/null +++ b/lib/imagekit/resources/custom_metadata_fields.rb @@ -0,0 +1,126 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class CustomMetadataFields + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldCreateParams} for more details. + # + # 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. + # + # @overload create(label:, name:, schema:, request_options: {}) + # + # @param label [String] Human readable name of the custom metadata field. This should be unique across a + # + # @param name [String] API name of the custom metadata field. This should be unique across all (includi + # + # @param schema [Imagekit::Models::CustomMetadataFieldCreateParams::Schema] + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::CustomMetadataFieldCreateResponse] + # + # @see Imagekit::Models::CustomMetadataFieldCreateParams + def create(params) + parsed, options = Imagekit::CustomMetadataFieldCreateParams.dump_request(params) + @client.request( + method: :post, + path: "v1/customMetadataFields", + body: parsed, + model: Imagekit::Models::CustomMetadataFieldCreateResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldUpdateParams} for more details. + # + # This API updates the label or schema of an existing custom metadata field. + # + # @overload update(id, label: nil, schema: nil, request_options: {}) + # + # @param id [String] Should be a valid custom metadata field id. + # + # @param label [String] Human readable name of the custom metadata field. This should be unique across a + # + # @param schema [Imagekit::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::CustomMetadataFieldUpdateResponse] + # + # @see Imagekit::Models::CustomMetadataFieldUpdateParams + def update(id, params = {}) + parsed, options = Imagekit::CustomMetadataFieldUpdateParams.dump_request(params) + @client.request( + method: :patch, + path: ["v1/customMetadataFields/%1$s", id], + body: parsed, + model: Imagekit::Models::CustomMetadataFieldUpdateResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldListParams} for more details. + # + # 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. + # + # @overload list(include_deleted: nil, request_options: {}) + # + # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. Default v + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Imagekit::Models::CustomMetadataFieldListParams + def list(params = {}) + parsed, options = Imagekit::CustomMetadataFieldListParams.dump_request(params) + @client.request( + method: :get, + path: "v1/customMetadataFields", + query: parsed.transform_keys(include_deleted: "includeDeleted"), + model: Imagekit::Internal::Type::ArrayOf[Imagekit::Models::CustomMetadataFieldListResponseItem], + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::CustomMetadataFieldDeleteParams} for more details. + # + # 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. + # + # @overload delete(id, request_options: {}) + # + # @param id [String] Should be a valid custom metadata field id. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Imagekit::Models::CustomMetadataFieldDeleteParams + def delete(id, params = {}) + @client.request( + method: :delete, + path: ["v1/customMetadataFields/%1$s", id], + model: Imagekit::Internal::Type::Unknown, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb new file mode 100644 index 00000000..65179134 --- /dev/null +++ b/lib/imagekit/resources/files.rb @@ -0,0 +1,467 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Files + # @return [Imagekit::Resources::Files::Details] + attr_reader :details + + # @return [Imagekit::Resources::Files::Batch] + attr_reader :batch + + # @return [Imagekit::Resources::Files::Versions] + attr_reader :versions + + # @return [Imagekit::Resources::Files::Purge] + attr_reader :purge + + # @return [Imagekit::Resources::Files::Metadata] + attr_reader :metadata + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileListParams} for more details. + # + # 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`. + # + # @overload list(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) + # + # @param file_type [String] Type of files to include in the result set. Accepts three values: + # + # @param limit [String] The maximum number of results to return in response: + # + # @param path [String] Folder path if you want to limit the search within a specific folder. For exampl + # + # @param search_query [String] Query string in a Lucene-like query language e.g. `createdAt > "7d"`. + # + # @param skip [String] The number of results to skip before returning results: + # + # @param sort [String] You can sort based on the following fields: + # + # @param type [Symbol, Imagekit::Models::FileListParams::Type] Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to includ + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Imagekit::Models::FileListParams + def list(params = {}) + parsed, options = Imagekit::FileListParams.dump_request(params) + @client.request( + method: :get, + path: "v1/files", + query: parsed.transform_keys(file_type: "fileType", search_query: "searchQuery"), + model: Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileListResponseItem], + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileDeleteParams} for more details. + # + # 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. + # + # @overload delete(file_id, request_options: {}) + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [nil] + # + # @see Imagekit::Models::FileDeleteParams + def delete(file_id, params = {}) + @client.request( + method: :delete, + path: ["v1/files/%1$s", file_id], + model: NilClass, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileAddTagsParams} for more details. + # + # This API adds tags to multiple files in bulk. A maximum of 50 files can be + # specified at a time. + # + # @overload add_tags(file_ids:, tags:, request_options: {}) + # + # @param file_ids [Array] An array of fileIds to which you want to add tags. + # + # @param tags [Array] An array of tags that you want to add to the files. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FileAddTagsResponse] + # + # @see Imagekit::Models::FileAddTagsParams + def add_tags(params) + parsed, options = Imagekit::FileAddTagsParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/addTags", + body: parsed, + model: Imagekit::Models::FileAddTagsResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileCopyParams} for more details. + # + # 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. + # + # @overload copy(destination_path:, source_file_path:, include_file_versions: nil, request_options: {}) + # + # @param destination_path [String] Full path to the folder you want to copy the above file into. + # + # @param source_file_path [String] The full path of the file you want to copy. + # + # @param include_file_versions [Boolean] Option to copy all versions of a file. By default, only the current version of t + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Imagekit::Models::FileCopyParams + def copy(params) + parsed, options = Imagekit::FileCopyParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/copy", + body: parsed, + model: Imagekit::Internal::Type::Unknown, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileMoveParams} for more details. + # + # 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. + # + # @overload move(destination_path:, source_file_path:, request_options: {}) + # + # @param destination_path [String] Full path to the folder you want to move the above file into. + # + # @param source_file_path [String] The full path of the file you want to move. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Imagekit::Models::FileMoveParams + def move(params) + parsed, options = Imagekit::FileMoveParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/move", + body: parsed, + model: Imagekit::Internal::Type::Unknown, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRemoveAITagsParams} for more details. + # + # This API removes AITags from multiple files in bulk. A maximum of 50 files can + # be specified at a time. + # + # @overload remove_ai_tags(ai_tags:, file_ids:, request_options: {}) + # + # @param ai_tags [Array] An array of AITags that you want to remove from the files. + # + # @param file_ids [Array] An array of fileIds from which you want to remove AITags. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FileRemoveAITagsResponse] + # + # @see Imagekit::Models::FileRemoveAITagsParams + def remove_ai_tags(params) + parsed, options = Imagekit::FileRemoveAITagsParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/removeAITags", + body: parsed, + model: Imagekit::Models::FileRemoveAITagsResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRemoveTagsParams} for more details. + # + # This API removes tags from multiple files in bulk. A maximum of 50 files can be + # specified at a time. + # + # @overload remove_tags(file_ids:, tags:, request_options: {}) + # + # @param file_ids [Array] An array of fileIds from which you want to remove tags. + # + # @param tags [Array] An array of tags that you want to remove from the files. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FileRemoveTagsResponse] + # + # @see Imagekit::Models::FileRemoveTagsParams + def remove_tags(params) + parsed, options = Imagekit::FileRemoveTagsParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/removeTags", + body: parsed, + model: Imagekit::Models::FileRemoveTagsResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileRenameParams} for more details. + # + # 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. + # + # @overload rename(file_path:, new_file_name:, purge_cache: nil, request_options: {}) + # + # @param file_path [String] The full path of the file you want to rename. + # + # @param new_file_name [String] The new name of the file. A filename can contain: + # + # @param purge_cache [Boolean] Option to purge cache for the old file and its versions' URLs. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FileRenameResponse] + # + # @see Imagekit::Models::FileRenameParams + def rename(params) + parsed, options = Imagekit::FileRenameParams.dump_request(params) + @client.request( + method: :put, + path: "v1/files/rename", + body: parsed, + model: Imagekit::Models::FileRenameResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadV1Params} for more details. + # + # 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 `expiration` + # 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. + # + # @overload upload_v1(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # + # @param file [String] Pass the HTTP URL or base64 string. When passing a URL in the file parameter, pl + # + # @param file_name [String] The name with which the file has to be uploaded. + # + # @param token [String] A unique value that the ImageKit.io server will use to recognize and prevent sub + # + # @param checks [String] Server-side checks to run on the asset. + # + # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file + # + # @param custom_metadata [String] Stringified JSON key-value data to be associated with the asset. + # + # @param expire [String] The time until your signature is valid. It must be a [Unix time](https://en.wiki + # + # @param extensions [String] Stringified JSON object with an array of extensions to be applied to the image. + # + # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e + # + # @param is_private_file [Symbol, Imagekit::Models::FileUploadV1Params::IsPrivateFile] Whether to mark the file as private or not. + # + # @param is_published [Symbol, Imagekit::Models::FileUploadV1Params::IsPublished] Whether to upload file as published or not. + # + # @param overwrite_ai_tags [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteAITags] If set to `true` and a file already exists at the exact location, its AITags wil + # + # @param overwrite_custom_metadata [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteCustomMetadata] If the request does not have `customMetadata`, and a file already exists at the + # + # @param overwrite_file [String] If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # + # @param overwrite_tags [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteTags] If the request does not have `tags`, and a file already exists at the exact loca + # + # @param public_key [String] Your ImageKit.io public key. This field is only required for authentication when + # + # @param response_fields [String] Comma-separated values of the fields that you want the API to return in the resp + # + # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a + # + # @param tags [String] Set the tags while uploading the file. + # + # @param transformation [String] Stringified JSON object with properties for pre and post transformations: + # + # @param use_unique_file_name [Symbol, Imagekit::Models::FileUploadV1Params::UseUniqueFileName] Whether to use a unique filename for this file or not. + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FileUploadV1Response] + # + # @see Imagekit::Models::FileUploadV1Params + def upload_v1(params) + parsed, options = Imagekit::FileUploadV1Params.dump_request(params) + path = + @client.base_url_overridden? ? "api/v1/files/upload" : "https://upload.imagekit.io/api/v1/files/upload" + @client.request( + method: :post, + path: path, + headers: {"content-type" => "multipart/form-data"}, + body: parsed, + model: Imagekit::Models::FileUploadV1Response, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadV2Params} for more details. + # + # 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. + # + # **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. + # + # @overload upload_v2(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # + # @param file [String] Pass the HTTP URL or base64 string. When passing a URL in the file parameter, pl + # + # @param file_name [String] The name with which the file has to be uploaded. + # + # @param token [String] This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses i + # + # @param checks [String] Server-side checks to run on the asset. + # + # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file + # + # @param custom_metadata [String] Stringified JSON key-value data to be associated with the asset. + # + # @param extensions [String] Stringified JSON object with an array of extensions to be applied to the image. + # + # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e + # + # @param is_private_file [Symbol, Imagekit::Models::FileUploadV2Params::IsPrivateFile] Whether to mark the file as private or not. + # + # @param is_published [Symbol, Imagekit::Models::FileUploadV2Params::IsPublished] Whether to upload file as published or not. + # + # @param overwrite_ai_tags [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteAITags] If set to `true` and a file already exists at the exact location, its AITags wil + # + # @param overwrite_custom_metadata [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteCustomMetadata] If the request does not have `customMetadata`, and a file already exists at the + # + # @param overwrite_file [String] If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # + # @param overwrite_tags [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteTags] If the request does not have `tags`, and a file already exists at the exact loca + # + # @param response_fields [String] Comma-separated values of the fields that you want the API to return in the resp + # + # @param tags [String] Set the tags while uploading the file. + # + # @param transformation [String] Stringified JSON object with properties for pre and post transformations: + # + # @param use_unique_file_name [Symbol, Imagekit::Models::FileUploadV2Params::UseUniqueFileName] Whether to use a unique filename for this file or not. + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FileUploadV2Response] + # + # @see Imagekit::Models::FileUploadV2Params + def upload_v2(params) + parsed, options = Imagekit::FileUploadV2Params.dump_request(params) + path = + @client.base_url_overridden? ? "api/v2/files/upload" : "https://upload.imagekit.io/api/v2/files/upload" + @client.request( + method: :post, + path: path, + headers: {"content-type" => "multipart/form-data"}, + body: parsed, + model: Imagekit::Models::FileUploadV2Response, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + @details = Imagekit::Resources::Files::Details.new(client: client) + @batch = Imagekit::Resources::Files::Batch.new(client: client) + @versions = Imagekit::Resources::Files::Versions.new(client: client) + @purge = Imagekit::Resources::Files::Purge.new(client: client) + @metadata = Imagekit::Resources::Files::Metadata.new(client: client) + end + end + end +end diff --git a/lib/imagekit/resources/files/batch.rb b/lib/imagekit/resources/files/batch.rb new file mode 100644 index 00000000..16a39c81 --- /dev/null +++ b/lib/imagekit/resources/files/batch.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Files + class Batch + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BatchDeleteParams} for more details. + # + # 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. + # + # @overload delete(file_ids:, request_options: {}) + # + # @param file_ids [Array] An array of fileIds which you want to delete. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::BatchDeleteResponse] + # + # @see Imagekit::Models::Files::BatchDeleteParams + def delete(params) + parsed, options = Imagekit::Files::BatchDeleteParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/batch/deleteByFileIds", + body: parsed, + model: Imagekit::Models::Files::BatchDeleteResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/files/details.rb b/lib/imagekit/resources/files/details.rb new file mode 100644 index 00000000..ad32acd8 --- /dev/null +++ b/lib/imagekit/resources/files/details.rb @@ -0,0 +1,81 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Files + class Details + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailRetrieveParams} for more details. + # + # This API returns an object with details or attributes about the current version + # of the file. + # + # @overload retrieve(file_id, request_options: {}) + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::DetailRetrieveResponse] + # + # @see Imagekit::Models::Files::DetailRetrieveParams + def retrieve(file_id, params = {}) + @client.request( + method: :get, + path: ["v1/files/%1$s/details", file_id], + model: Imagekit::Models::Files::DetailRetrieveResponse, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::DetailUpdateParams} for more details. + # + # 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. + # + # @overload update(file_id, custom_coordinates: nil, custom_metadata: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc + # + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Object] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, Imagekit::Models::Files::DetailUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param publish [Imagekit::Models::Files::DetailUpdateParams::Publish] Configure the publication status of a file and its versions. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::DetailUpdateResponse] + # + # @see Imagekit::Models::Files::DetailUpdateParams + def update(file_id, params = {}) + parsed, options = Imagekit::Files::DetailUpdateParams.dump_request(params) + @client.request( + method: :patch, + path: ["v1/files/%1$s/details", file_id], + body: parsed, + model: Imagekit::Models::Files::DetailUpdateResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/files/metadata.rb b/lib/imagekit/resources/files/metadata.rb new file mode 100644 index 00000000..08992f14 --- /dev/null +++ b/lib/imagekit/resources/files/metadata.rb @@ -0,0 +1,69 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Files + class Metadata + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::MetadataRetrieveParams} for more details. + # + # 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. + # + # @overload retrieve(file_id, request_options: {}) + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::MetadataRetrieveResponse] + # + # @see Imagekit::Models::Files::MetadataRetrieveParams + def retrieve(file_id, params = {}) + @client.request( + method: :get, + path: ["v1/files/%1$s/metadata", file_id], + model: Imagekit::Models::Files::MetadataRetrieveResponse, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::MetadataFromURLParams} for more details. + # + # Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL + # using this API. + # + # @overload from_url(url:, request_options: {}) + # + # @param url [String] Should be a valid file URL. It should be accessible using your ImageKit.io accou + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::MetadataFromURLResponse] + # + # @see Imagekit::Models::Files::MetadataFromURLParams + def from_url(params) + parsed, options = Imagekit::Files::MetadataFromURLParams.dump_request(params) + @client.request( + method: :get, + path: "v1/files/metadata", + query: parsed, + model: Imagekit::Models::Files::MetadataFromURLResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/files/purge.rb b/lib/imagekit/resources/files/purge.rb new file mode 100644 index 00000000..a0d5603d --- /dev/null +++ b/lib/imagekit/resources/files/purge.rb @@ -0,0 +1,66 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Files + class Purge + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::PurgeExecuteParams} for more details. + # + # 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. + # + # @overload execute(url:, request_options: {}) + # + # @param url [String] The full URL of the file to be purged. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::PurgeExecuteResponse] + # + # @see Imagekit::Models::Files::PurgeExecuteParams + def execute(params) + parsed, options = Imagekit::Files::PurgeExecuteParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/purge", + body: parsed, + model: Imagekit::Models::Files::PurgeExecuteResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::PurgeStatusParams} for more details. + # + # This API returns the status of a purge cache request. + # + # @overload status(request_id, request_options: {}) + # + # @param request_id [String] Should be a valid requestId. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::PurgeStatusResponse] + # + # @see Imagekit::Models::Files::PurgeStatusParams + def status(request_id, params = {}) + @client.request( + method: :get, + path: ["v1/files/purge/%1$s", request_id], + model: Imagekit::Models::Files::PurgeStatusResponse, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/files/versions.rb b/lib/imagekit/resources/files/versions.rb new file mode 100644 index 00000000..2a87ed03 --- /dev/null +++ b/lib/imagekit/resources/files/versions.rb @@ -0,0 +1,132 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Files + class Versions + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionRetrieveParams} for more details. + # + # This API returns an object with details or attributes of a file version. + # + # @overload retrieve(version_id, file_id:, request_options: {}) + # + # @param version_id [String] The unique `versionId` of the uploaded file. `versionId` is returned in list and + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::VersionRetrieveResponse] + # + # @see Imagekit::Models::Files::VersionRetrieveParams + def retrieve(version_id, params) + parsed, options = Imagekit::Files::VersionRetrieveParams.dump_request(params) + file_id = + parsed.delete(:file_id) do + raise ArgumentError.new("missing required path argument #{_1}") + end + @client.request( + method: :get, + path: ["v1/files/%1$s/versions/%2$s", file_id, version_id], + model: Imagekit::Models::Files::VersionRetrieveResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionListParams} for more details. + # + # This API returns details of all versions of a file. + # + # @overload list(file_id, request_options: {}) + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Imagekit::Models::Files::VersionListParams + def list(file_id, params = {}) + @client.request( + method: :get, + path: ["v1/files/%1$s/versions", file_id], + model: Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionListResponseItem], + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionDeleteParams} for more details. + # + # 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. + # + # @overload delete(version_id, file_id:, request_options: {}) + # + # @param version_id [String] The unique `versionId` of the uploaded file. `versionId` is returned in list and + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Imagekit::Models::Files::VersionDeleteParams + def delete(version_id, params) + parsed, options = Imagekit::Files::VersionDeleteParams.dump_request(params) + file_id = + parsed.delete(:file_id) do + raise ArgumentError.new("missing required path argument #{_1}") + end + @client.request( + method: :delete, + path: ["v1/files/%1$s/versions/%2$s", file_id, version_id], + model: Imagekit::Internal::Type::Unknown, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionRestoreParams} for more details. + # + # This API restores a file version as the current file version. + # + # @overload restore(version_id, file_id:, request_options: {}) + # + # @param version_id [String] The unique `versionId` of the uploaded file. `versionId` is returned in list and + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::VersionRestoreResponse] + # + # @see Imagekit::Models::Files::VersionRestoreParams + def restore(version_id, params) + parsed, options = Imagekit::Files::VersionRestoreParams.dump_request(params) + file_id = + parsed.delete(:file_id) do + raise ArgumentError.new("missing required path argument #{_1}") + end + @client.request( + method: :put, + path: ["v1/files/%1$s/versions/%2$s/restore", file_id, version_id], + model: Imagekit::Models::Files::VersionRestoreResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/folder.rb b/lib/imagekit/resources/folder.rb new file mode 100644 index 00000000..02ba9cda --- /dev/null +++ b/lib/imagekit/resources/folder.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Folder + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderCreateParams} for more details. + # + # 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. + # + # @overload create(folder_name:, parent_folder_path:, request_options: {}) + # + # @param folder_name [String] The folder will be created with this name. + # + # @param parent_folder_path [String] The folder where the new folder should be created, for root use `/` else the pat + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Imagekit::Models::FolderCreateParams + def create(params) + parsed, options = Imagekit::FolderCreateParams.dump_request(params) + @client.request( + method: :post, + path: "v1/folder", + body: parsed, + model: Imagekit::Internal::Type::Unknown, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderDeleteParams} for more details. + # + # This will delete a folder and all its contents permanently. The API returns an + # empty response. + # + # @overload delete(folder_path:, request_options: {}) + # + # @param folder_path [String] Full path to the folder you want to delete. For example `/folder/to/delete/`. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Imagekit::Models::FolderDeleteParams + def delete(params) + parsed, options = Imagekit::FolderDeleteParams.dump_request(params) + @client.request( + method: :delete, + path: "v1/folder", + body: parsed, + model: Imagekit::Internal::Type::Unknown, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/imagekit/version.rb b/lib/imagekit/version.rb new file mode 100644 index 00000000..2350f394 --- /dev/null +++ b/lib/imagekit/version.rb @@ -0,0 +1,5 @@ +# frozen_string_literal: true + +module Imagekit + VERSION = "0.0.1" +end diff --git a/manifest.yaml b/manifest.yaml new file mode 100644 index 00000000..556686f5 --- /dev/null +++ b/manifest.yaml @@ -0,0 +1,15 @@ +dependencies: + - English + - cgi + - date + - erb + - etc + - json + - net/http + - pathname + - rbconfig + - securerandom + - set + - stringio + - time + - uri diff --git a/rbi/imagekit/client.rbi b/rbi/imagekit/client.rbi new file mode 100644 index 00000000..6546b121 --- /dev/null +++ b/rbi/imagekit/client.rbi @@ -0,0 +1,75 @@ +# typed: strong + +module Imagekit + class Client < Imagekit::Internal::Transport::BaseClient + DEFAULT_MAX_RETRIES = 2 + + DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float) + + DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float) + + DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float) + + # Your ImageKit private key starts with `private_`. + sig { returns(String) } + attr_reader :private_api_key + + # Do not set this, its value is ignored + sig { returns(T.nilable(String)) } + attr_reader :password + + sig { returns(Imagekit::Resources::CustomMetadataFields) } + attr_reader :custom_metadata_fields + + sig { returns(Imagekit::Resources::Files) } + attr_reader :files + + sig { returns(Imagekit::Resources::Folder) } + attr_reader :folder + + sig { returns(Imagekit::Resources::BulkJobs) } + attr_reader :bulk_jobs + + sig { returns(Imagekit::Resources::Accounts) } + attr_reader :accounts + + # @api private + sig { override.returns(T::Hash[String, String]) } + private def auth_headers + end + + # @api private + sig { returns(T::Boolean) } + def base_url_overridden? + end + + # Creates and returns a new client for interacting with the API. + sig do + params( + private_api_key: T.nilable(String), + password: T.nilable(String), + base_url: T.nilable(String), + max_retries: Integer, + timeout: Float, + initial_retry_delay: Float, + max_retry_delay: Float + ).returns(T.attached_class) + end + def self.new( + # Your ImageKit private key starts with `private_`. Defaults to + # `ENV["IMAGEKIT_PRIVATE_API_KEY"]` + private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], + # Do not set this, its value is ignored Defaults to `ENV["ORG_MY_PASSWORD_TOKEN"]` + password: ENV.fetch("ORG_MY_PASSWORD_TOKEN", "does_not_matter"), + # Override the default base URL for the API, e.g., + # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` + base_url: ENV["IMAGE_KIT_BASE_URL"], + # Max number of retries to attempt after a failed retryable request. + max_retries: Imagekit::Client::DEFAULT_MAX_RETRIES, + timeout: Imagekit::Client::DEFAULT_TIMEOUT_IN_SECONDS, + initial_retry_delay: Imagekit::Client::DEFAULT_INITIAL_RETRY_DELAY, + max_retry_delay: Imagekit::Client::DEFAULT_MAX_RETRY_DELAY + ) + end + end +end diff --git a/rbi/imagekit/errors.rbi b/rbi/imagekit/errors.rbi new file mode 100644 index 00000000..62c31cc6 --- /dev/null +++ b/rbi/imagekit/errors.rbi @@ -0,0 +1,178 @@ +# typed: strong + +module Imagekit + module Errors + class Error < StandardError + sig { returns(T.nilable(StandardError)) } + attr_accessor :cause + end + + class ConversionError < Imagekit::Errors::Error + sig { returns(T.nilable(StandardError)) } + def cause + end + + # @api private + sig do + params( + on: T::Class[StandardError], + method: Symbol, + target: T.anything, + value: T.anything, + cause: T.nilable(StandardError) + ).returns(T.attached_class) + end + def self.new(on:, method:, target:, value:, cause: nil) + end + end + + class APIError < Imagekit::Errors::Error + sig { returns(URI::Generic) } + attr_accessor :url + + sig { returns(T.nilable(Integer)) } + attr_accessor :status + + sig { returns(T.nilable(T.anything)) } + attr_accessor :body + + # @api private + sig do + params( + url: URI::Generic, + status: T.nilable(Integer), + body: T.nilable(Object), + request: NilClass, + response: NilClass, + message: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + url:, + status: nil, + body: nil, + request: nil, + response: nil, + message: nil + ) + end + end + + class APIConnectionError < Imagekit::Errors::APIError + sig { void } + attr_accessor :status + + sig { void } + attr_accessor :body + + # @api private + sig do + params( + url: URI::Generic, + status: NilClass, + body: NilClass, + request: NilClass, + response: NilClass, + message: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + url:, + status: nil, + body: nil, + request: nil, + response: nil, + message: "Connection error." + ) + end + end + + class APITimeoutError < Imagekit::Errors::APIConnectionError + # @api private + sig do + params( + url: URI::Generic, + status: NilClass, + body: NilClass, + request: NilClass, + response: NilClass, + message: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + url:, + status: nil, + body: nil, + request: nil, + response: nil, + message: "Request timed out." + ) + end + end + + class APIStatusError < Imagekit::Errors::APIError + # @api private + sig do + params( + url: URI::Generic, + status: Integer, + body: T.nilable(Object), + request: NilClass, + response: NilClass, + message: T.nilable(String) + ).returns(T.attached_class) + end + def self.for(url:, status:, body:, request:, response:, message: nil) + end + + sig { returns(Integer) } + attr_accessor :status + + # @api private + sig do + params( + url: URI::Generic, + status: Integer, + body: T.nilable(Object), + request: NilClass, + response: NilClass, + message: T.nilable(String) + ).returns(T.attached_class) + end + def self.new(url:, status:, body:, request:, response:, message: nil) + end + end + + class BadRequestError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 400 + end + + class AuthenticationError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 401 + end + + class PermissionDeniedError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 403 + end + + class NotFoundError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 404 + end + + class ConflictError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 409 + end + + class UnprocessableEntityError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 422 + end + + class RateLimitError < Imagekit::Errors::APIStatusError + HTTP_STATUS = 429 + end + + class InternalServerError < Imagekit::Errors::APIStatusError + HTTP_STATUS = T.let((500..), T::Range[Integer]) + end + end +end diff --git a/rbi/imagekit/file_part.rbi b/rbi/imagekit/file_part.rbi new file mode 100644 index 00000000..6662978f --- /dev/null +++ b/rbi/imagekit/file_part.rbi @@ -0,0 +1,37 @@ +# typed: strong + +module Imagekit + class FilePart + sig { returns(T.any(Pathname, StringIO, IO, String)) } + attr_reader :content + + sig { returns(T.nilable(String)) } + attr_reader :content_type + + sig { returns(T.nilable(String)) } + attr_reader :filename + + # @api private + sig { returns(String) } + private def read + end + + sig { params(a: T.anything).returns(String) } + def to_json(*a) + end + + sig { params(a: T.anything).returns(String) } + def to_yaml(*a) + end + + sig do + params( + content: T.any(Pathname, StringIO, IO, String), + filename: T.nilable(String), + content_type: T.nilable(String) + ).returns(T.attached_class) + end + def self.new(content, filename: nil, content_type: nil) + end + end +end diff --git a/rbi/imagekit/internal.rbi b/rbi/imagekit/internal.rbi new file mode 100644 index 00000000..a32e13ca --- /dev/null +++ b/rbi/imagekit/internal.rbi @@ -0,0 +1,16 @@ +# typed: strong + +module Imagekit + module Internal + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + # Due to the current WIP status of Shapes support in Sorbet, types referencing + # this alias might be refined in the future. + AnyHash = T.type_alias { T::Hash[Symbol, T.anything] } + + FileInput = + T.type_alias { T.any(Pathname, StringIO, IO, String, Imagekit::FilePart) } + + OMIT = T.let(Object.new.freeze, T.anything) + end +end diff --git a/rbi/imagekit/internal/transport/base_client.rbi b/rbi/imagekit/internal/transport/base_client.rbi new file mode 100644 index 00000000..3e5fda85 --- /dev/null +++ b/rbi/imagekit/internal/transport/base_client.rbi @@ -0,0 +1,293 @@ +# typed: strong + +module Imagekit + module Internal + module Transport + # @api private + class BaseClient + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + abstract! + + RequestComponents = + T.type_alias do + { + method: Symbol, + path: T.any(String, T::Array[String]), + query: + T.nilable( + T::Hash[String, T.nilable(T.any(T::Array[String], String))] + ), + headers: + T.nilable( + T::Hash[ + String, + T.nilable( + T.any( + String, + Integer, + T::Array[T.nilable(T.any(String, Integer))] + ) + ) + ] + ), + body: T.nilable(T.anything), + unwrap: + T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), + page: + T.nilable( + T::Class[ + Imagekit::Internal::Type::BasePage[ + Imagekit::Internal::Type::BaseModel + ] + ] + ), + stream: T.nilable(T::Class[T.anything]), + model: T.nilable(Imagekit::Internal::Type::Converter::Input), + options: T.nilable(Imagekit::RequestOptions::OrHash) + } + end + + RequestInput = + T.type_alias do + { + method: Symbol, + url: URI::Generic, + headers: T::Hash[String, String], + body: T.anything, + max_retries: Integer, + timeout: Float + } + end + + # from whatwg fetch spec + MAX_REDIRECTS = 20 + + PLATFORM_HEADERS = T::Hash[String, String] + + class << self + # @api private + sig do + params( + req: Imagekit::Internal::Transport::BaseClient::RequestComponents + ).void + end + def validate!(req) + end + + # @api private + sig do + params( + status: Integer, + headers: T.any(T::Hash[String, String], Net::HTTPHeader) + ).returns(T::Boolean) + end + def should_retry?(status, headers:) + end + + # @api private + sig do + params( + request: Imagekit::Internal::Transport::BaseClient::RequestInput, + status: Integer, + response_headers: T.any(T::Hash[String, String], Net::HTTPHeader) + ).returns(Imagekit::Internal::Transport::BaseClient::RequestInput) + end + def follow_redirect(request, status:, response_headers:) + end + + # @api private + sig do + params( + status: T.any(Integer, Imagekit::Errors::APIConnectionError), + stream: T.nilable(T::Enumerable[String]) + ).void + end + def reap_connection!(status, stream:) + end + end + + sig { returns(URI::Generic) } + attr_reader :base_url + + sig { returns(Float) } + attr_reader :timeout + + sig { returns(Integer) } + attr_reader :max_retries + + sig { returns(Float) } + attr_reader :initial_retry_delay + + sig { returns(Float) } + attr_reader :max_retry_delay + + sig { returns(T::Hash[String, String]) } + attr_reader :headers + + sig { returns(T.nilable(String)) } + attr_reader :idempotency_header + + # @api private + sig { returns(Imagekit::Internal::Transport::PooledNetRequester) } + attr_reader :requester + + # @api private + sig do + params( + base_url: String, + timeout: Float, + max_retries: Integer, + initial_retry_delay: Float, + max_retry_delay: Float, + headers: + T::Hash[ + String, + T.nilable( + T.any( + String, + Integer, + T::Array[T.nilable(T.any(String, Integer))] + ) + ) + ], + idempotency_header: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + base_url:, + timeout: 0.0, + max_retries: 0, + initial_retry_delay: 0.0, + max_retry_delay: 0.0, + headers: {}, + idempotency_header: nil + ) + end + + # @api private + sig { overridable.returns(T::Hash[String, String]) } + private def auth_headers + end + + # @api private + sig { returns(String) } + private def generate_idempotency_key + end + + # @api private + sig do + overridable + .params( + req: Imagekit::Internal::Transport::BaseClient::RequestComponents, + opts: Imagekit::Internal::AnyHash + ) + .returns(Imagekit::Internal::Transport::BaseClient::RequestInput) + end + private def build_request(req, opts) + end + + # @api private + sig do + params( + headers: T::Hash[String, String], + retry_count: Integer + ).returns(Float) + end + private def retry_delay(headers, retry_count:) + end + + # @api private + sig do + params( + request: Imagekit::Internal::Transport::BaseClient::RequestInput, + redirect_count: Integer, + retry_count: Integer, + send_retry_header: T::Boolean + ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) + end + def send_request( + request, + redirect_count:, + retry_count:, + send_retry_header: + ) + end + + # Execute the request specified by `req`. This is the method that all resource + # methods call into. + # + # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Imagekit::Internal::Type::Unknown, options: {}) + sig do + params( + method: Symbol, + path: T.any(String, T::Array[String]), + query: + T.nilable( + T::Hash[String, T.nilable(T.any(T::Array[String], String))] + ), + headers: + T.nilable( + T::Hash[ + String, + T.nilable( + T.any( + String, + Integer, + T::Array[T.nilable(T.any(String, Integer))] + ) + ) + ] + ), + body: T.nilable(T.anything), + unwrap: + T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), + page: + T.nilable( + T::Class[ + Imagekit::Internal::Type::BasePage[ + Imagekit::Internal::Type::BaseModel + ] + ] + ), + stream: T.nilable(T::Class[T.anything]), + model: T.nilable(Imagekit::Internal::Type::Converter::Input), + options: T.nilable(Imagekit::RequestOptions::OrHash) + ).returns(T.anything) + end + def request( + method, + path, + query: {}, + headers: {}, + body: nil, + unwrap: nil, + page: nil, + stream: nil, + model: Imagekit::Internal::Type::Unknown, + options: {} + ) + end + + # @api private + sig { returns(String) } + def inspect + end + end + end + end +end diff --git a/rbi/imagekit/internal/transport/pooled_net_requester.rbi b/rbi/imagekit/internal/transport/pooled_net_requester.rbi new file mode 100644 index 00000000..f5b90254 --- /dev/null +++ b/rbi/imagekit/internal/transport/pooled_net_requester.rbi @@ -0,0 +1,79 @@ +# typed: strong + +module Imagekit + module Internal + module Transport + # @api private + class PooledNetRequester + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + Request = + T.type_alias do + { + method: Symbol, + url: URI::Generic, + headers: T::Hash[String, String], + body: T.anything, + deadline: Float + } + end + + # from the golang stdlib + # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 + KEEP_ALIVE_TIMEOUT = 30 + + DEFAULT_MAX_CONNECTIONS = T.let(T.unsafe(nil), Integer) + + class << self + # @api private + sig { params(url: URI::Generic).returns(Net::HTTP) } + def connect(url) + end + + # @api private + sig { params(conn: Net::HTTP, deadline: Float).void } + def calibrate_socket_timeout(conn, deadline) + end + + # @api private + sig do + params( + request: + Imagekit::Internal::Transport::PooledNetRequester::Request, + blk: T.proc.params(arg0: String).void + ).returns([Net::HTTPGenericRequest, T.proc.void]) + end + def build_request(request, &blk) + end + end + + # @api private + sig do + params( + url: URI::Generic, + deadline: Float, + blk: T.proc.params(arg0: Net::HTTP).void + ).void + end + private def with_pool(url, deadline:, &blk) + end + + # @api private + sig do + params( + request: Imagekit::Internal::Transport::PooledNetRequester::Request + ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) + end + def execute(request) + end + + # @api private + sig { params(size: Integer).returns(T.attached_class) } + def self.new( + size: Imagekit::Internal::Transport::PooledNetRequester::DEFAULT_MAX_CONNECTIONS + ) + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/array_of.rbi b/rbi/imagekit/internal/type/array_of.rbi new file mode 100644 index 00000000..4c739d92 --- /dev/null +++ b/rbi/imagekit/internal/type/array_of.rbi @@ -0,0 +1,104 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + # + # Array of items of a given type. + class ArrayOf + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + abstract! + + Elem = type_member(:out) + + sig do + params( + type_info: + T.any( + Imagekit::Internal::AnyHash, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ), + spec: Imagekit::Internal::AnyHash + ).returns(T.attached_class) + end + def self.[](type_info, spec = {}) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ===(other) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ==(other) + end + + sig { returns(Integer) } + def hash + end + + # @api private + sig do + override + .params( + value: T.any(T::Array[T.anything], T.anything), + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.any(T::Array[T.anything], T.anything)) + end + def coerce(value, state:) + end + + # @api private + sig do + override + .params( + value: T.any(T::Array[T.anything], T.anything), + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.any(T::Array[T.anything], T.anything)) + end + def dump(value, state:) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + + # @api private + sig { returns(Elem) } + protected def item_type + end + + # @api private + sig { returns(T::Boolean) } + protected def nilable? + end + + # @api private + sig do + params( + type_info: + T.any( + Imagekit::Internal::AnyHash, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ), + spec: Imagekit::Internal::AnyHash + ).void + end + def initialize(type_info, spec = {}) + end + + # @api private + sig { params(depth: Integer).returns(String) } + def inspect(depth: 0) + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/base_model.rbi b/rbi/imagekit/internal/type/base_model.rbi new file mode 100644 index 00000000..b1ae616a --- /dev/null +++ b/rbi/imagekit/internal/type/base_model.rbi @@ -0,0 +1,302 @@ +# typed: strong + +module Imagekit + module Internal + module Type + class BaseModel + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + abstract! + + KnownField = + T.type_alias do + { + mode: T.nilable(Symbol), + required: T::Boolean, + nilable: T::Boolean + } + end + + OrHash = + T.type_alias do + T.any( + Imagekit::Internal::Type::BaseModel, + Imagekit::Internal::AnyHash + ) + end + + class << self + # @api private + # + # Assumes superclass fields are totally defined before fields are accessed / + # defined on subclasses. + sig { params(child: T.self_type).void } + def inherited(child) + end + + # @api private + sig do + returns( + T::Hash[ + Symbol, + T.all( + Imagekit::Internal::Type::BaseModel::KnownField, + { + type_fn: + T.proc.returns(Imagekit::Internal::Type::Converter::Input) + } + ) + ] + ) + end + def known_fields + end + + # @api private + sig do + returns( + T::Hash[ + Symbol, + T.all( + Imagekit::Internal::Type::BaseModel::KnownField, + { type: Imagekit::Internal::Type::Converter::Input } + ) + ] + ) + end + def fields + end + + # @api private + sig do + params( + name_sym: Symbol, + required: T::Boolean, + type_info: + T.any( + { + const: + T.nilable( + T.any(NilClass, T::Boolean, Integer, Float, Symbol) + ), + enum: + T.nilable( + T.proc.returns( + Imagekit::Internal::Type::Converter::Input + ) + ), + union: + T.nilable( + T.proc.returns( + Imagekit::Internal::Type::Converter::Input + ) + ), + api_name: Symbol, + nil?: T::Boolean + }, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ), + spec: Imagekit::Internal::AnyHash + ).void + end + private def add_field(name_sym, required:, type_info:, spec:) + end + + # @api private + sig do + params( + name_sym: Symbol, + type_info: + T.any( + Imagekit::Internal::AnyHash, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ), + spec: Imagekit::Internal::AnyHash + ).void + end + def required(name_sym, type_info, spec = {}) + end + + # @api private + sig do + params( + name_sym: Symbol, + type_info: + T.any( + Imagekit::Internal::AnyHash, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ), + spec: Imagekit::Internal::AnyHash + ).void + end + def optional(name_sym, type_info, spec = {}) + end + + # @api private + # + # `request_only` attributes not excluded from `.#coerce` when receiving responses + # even if well behaved servers should not send them + sig { params(blk: T.proc.void).void } + private def request_only(&blk) + end + + # @api private + # + # `response_only` attributes are omitted from `.#dump` when making requests + sig { params(blk: T.proc.void).void } + private def response_only(&blk) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ==(other) + end + + sig { returns(Integer) } + def hash + end + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ==(other) + end + + sig { returns(Integer) } + def hash + end + + class << self + # @api private + sig do + override + .params( + value: + T.any( + Imagekit::Internal::Type::BaseModel, + T::Hash[T.anything, T.anything], + T.anything + ), + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.any(T.attached_class, T.anything)) + end + def coerce(value, state:) + end + + # @api private + sig do + override + .params( + value: T.any(T.attached_class, T.anything), + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.any(T::Hash[T.anything, T.anything], T.anything)) + end + def dump(value, state:) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + end + + class << self + # @api private + sig do + params( + model: Imagekit::Internal::Type::BaseModel, + convert: T::Boolean + ).returns(Imagekit::Internal::AnyHash) + end + def recursively_to_h(model, convert:) + end + end + + # Returns the raw value associated with the given key, if found. Otherwise, nil is + # returned. + # + # It is valid to lookup keys that are not in the API spec, for example to access + # undocumented features. This method does not parse response data into + # higher-level types. Lookup by anything other than a Symbol is an ArgumentError. + sig { params(key: Symbol).returns(T.nilable(T.anything)) } + def [](key) + end + + # Returns a Hash of the data underlying this object. O(1) + # + # Keys are Symbols and values are the raw values from the response. The return + # value indicates which values were ever set on the object. i.e. there will be a + # key in this hash if they ever were, even if the set value was nil. + # + # This method is not recursive. The returned value is shared by the object, so it + # should not be mutated. + sig { overridable.returns(Imagekit::Internal::AnyHash) } + def to_h + end + + # Returns a Hash of the data underlying this object. O(1) + # + # Keys are Symbols and values are the raw values from the response. The return + # value indicates which values were ever set on the object. i.e. there will be a + # key in this hash if they ever were, even if the set value was nil. + # + # This method is not recursive. The returned value is shared by the object, so it + # should not be mutated. + sig { overridable.returns(Imagekit::Internal::AnyHash) } + def to_hash + end + + # In addition to the behaviour of `#to_h`, this method will recursively call + # `#to_h` on nested models. + sig { overridable.returns(Imagekit::Internal::AnyHash) } + def deep_to_h + end + + sig do + params(keys: T.nilable(T::Array[Symbol])).returns( + Imagekit::Internal::AnyHash + ) + end + def deconstruct_keys(keys) + end + + sig { params(a: T.anything).returns(String) } + def to_json(*a) + end + + sig { params(a: T.anything).returns(String) } + def to_yaml(*a) + end + + # Create a new instance of a model. + sig do + params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns( + T.attached_class + ) + end + def self.new(data = {}) + end + + class << self + # @api private + sig { params(depth: Integer).returns(String) } + def inspect(depth: 0) + end + end + + sig { returns(String) } + def to_s + end + + # @api private + sig { returns(String) } + def inspect + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/base_page.rbi b/rbi/imagekit/internal/type/base_page.rbi new file mode 100644 index 00000000..dab911be --- /dev/null +++ b/rbi/imagekit/internal/type/base_page.rbi @@ -0,0 +1,42 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + # + # This module provides a base implementation for paginated responses in the SDK. + module BasePage + Elem = type_member(:out) + + sig { overridable.returns(T::Boolean) } + def next_page? + end + + sig { overridable.returns(T.self_type) } + def next_page + end + + sig { overridable.params(blk: T.proc.params(arg0: Elem).void).void } + def auto_paging_each(&blk) + end + + sig { returns(T::Enumerable[Elem]) } + def to_enum + end + + # @api private + sig do + params( + client: Imagekit::Internal::Transport::BaseClient, + req: Imagekit::Internal::Transport::BaseClient::RequestComponents, + headers: T.any(T::Hash[String, String], Net::HTTPHeader), + page_data: T.anything + ).void + end + def initialize(client:, req:, headers:, page_data:) + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/boolean.rbi b/rbi/imagekit/internal/type/boolean.rbi new file mode 100644 index 00000000..fd1f5df2 --- /dev/null +++ b/rbi/imagekit/internal/type/boolean.rbi @@ -0,0 +1,58 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + # + # Ruby has no Boolean class; this is something for models to refer to. + class Boolean + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + abstract! + + sig { params(other: T.anything).returns(T::Boolean) } + def self.===(other) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def self.==(other) + end + + class << self + # @api private + # + # Coerce value to Boolean if possible, otherwise return the original value. + sig do + override + .params( + value: T.any(T::Boolean, T.anything), + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.any(T::Boolean, T.anything)) + end + def coerce(value, state:) + end + + # @api private + sig do + override + .params( + value: T.any(T::Boolean, T.anything), + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.any(T::Boolean, T.anything)) + end + def dump(value, state:) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/converter.rbi b/rbi/imagekit/internal/type/converter.rbi new file mode 100644 index 00000000..34341635 --- /dev/null +++ b/rbi/imagekit/internal/type/converter.rbi @@ -0,0 +1,216 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + module Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + Input = + T.type_alias do + T.any(Imagekit::Internal::Type::Converter, T::Class[T.anything]) + end + + CoerceState = + T.type_alias do + { + translate_names: T::Boolean, + strictness: T::Boolean, + exactness: { + yes: Integer, + no: Integer, + maybe: Integer + }, + error: T::Class[StandardError], + branched: Integer + } + end + + DumpState = T.type_alias { { can_retry: T::Boolean } } + + # @api private + sig do + overridable + .params( + value: T.anything, + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.anything) + end + def coerce(value, state:) + end + + # @api private + sig do + overridable + .params( + value: T.anything, + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.anything) + end + def dump(value, state:) + end + + # @api private + sig { params(depth: Integer).returns(String) } + def inspect(depth: 0) + end + + class << self + # @api private + sig do + params( + spec: + T.any( + { + const: + T.nilable( + T.any(NilClass, T::Boolean, Integer, Float, Symbol) + ), + enum: + T.nilable( + T.proc.returns( + Imagekit::Internal::Type::Converter::Input + ) + ), + union: + T.nilable( + T.proc.returns( + Imagekit::Internal::Type::Converter::Input + ) + ) + }, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ) + ).returns(T.proc.returns(T.anything)) + end + def self.type_info(spec) + end + + # @api private + sig do + params( + type_info: + T.any( + { + const: + T.nilable( + T.any(NilClass, T::Boolean, Integer, Float, Symbol) + ), + enum: + T.nilable( + T.proc.returns( + Imagekit::Internal::Type::Converter::Input + ) + ), + union: + T.nilable( + T.proc.returns( + Imagekit::Internal::Type::Converter::Input + ) + ) + }, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ), + spec: + T.any( + { + const: + T.nilable( + T.any(NilClass, T::Boolean, Integer, Float, Symbol) + ), + enum: + T.nilable( + T.proc.returns( + Imagekit::Internal::Type::Converter::Input + ) + ), + union: + T.nilable( + T.proc.returns( + Imagekit::Internal::Type::Converter::Input + ) + ) + }, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ) + ).returns(Imagekit::Internal::AnyHash) + end + def self.meta_info(type_info, spec) + end + + # @api private + sig do + params(translate_names: T::Boolean).returns( + Imagekit::Internal::Type::Converter::CoerceState + ) + end + def self.new_coerce_state(translate_names: true) + end + + # @api private + # + # Based on `target`, transform `value` into `target`, to the extent possible: + # + # 1. if the given `value` conforms to `target` already, return the given `value` + # 2. if it's possible and safe to convert the given `value` to `target`, then the + # converted value + # 3. otherwise, the given `value` unaltered + # + # The coercion process is subject to improvement between minor release versions. + # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode + sig do + params( + target: Imagekit::Internal::Type::Converter::Input, + value: T.anything, + state: Imagekit::Internal::Type::Converter::CoerceState + ).returns(T.anything) + end + def self.coerce( + target, + value, + # The `strictness` is one of `true`, `false`. This informs the coercion strategy + # when we have to decide between multiple possible conversion targets: + # + # - `true`: the conversion must be exact, with minimum coercion. + # - `false`: the conversion can be approximate, with some coercion. + # + # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For + # any given conversion attempt, the exactness will be updated based on how closely + # the value recursively matches the target type: + # + # - `yes`: the value can be converted to the target type with minimum coercion. + # - `maybe`: the value can be converted to the target type with some reasonable + # coercion. + # - `no`: the value cannot be converted to the target type. + # + # See implementation below for more details. + state: Imagekit::Internal::Type::Converter.new_coerce_state + ) + end + + # @api private + sig do + params( + target: Imagekit::Internal::Type::Converter::Input, + value: T.anything, + state: Imagekit::Internal::Type::Converter::DumpState + ).returns(T.anything) + end + def self.dump(target, value, state: { can_retry: true }) + end + + # @api private + sig { params(target: T.anything, depth: Integer).returns(String) } + def self.inspect(target, depth:) + end + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/enum.rbi b/rbi/imagekit/internal/type/enum.rbi new file mode 100644 index 00000000..c7b354ff --- /dev/null +++ b/rbi/imagekit/internal/type/enum.rbi @@ -0,0 +1,82 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + # + # A value from among a specified list of options. OpenAPI enum values map to Ruby + # values in the SDK as follows: + # + # 1. boolean => true | false + # 2. integer => Integer + # 3. float => Float + # 4. string => Symbol + # + # We can therefore convert string values to Symbols, but can't convert other + # values safely. + module Enum + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + # All of the valid Symbol values for this enum. + sig do + overridable.returns( + T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)] + ) + end + def values + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ===(other) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ==(other) + end + + sig { returns(Integer) } + def hash + end + + # @api private + # + # Unlike with primitives, `Enum` additionally validates that the value is a member + # of the enum. + sig do + override + .params( + value: T.any(String, Symbol, T.anything), + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.any(Symbol, T.anything)) + end + def coerce(value, state:) + end + + # @api private + sig do + override + .params( + value: T.any(Symbol, T.anything), + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.any(Symbol, T.anything)) + end + def dump(value, state:) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + + # @api private + sig { params(depth: Integer).returns(String) } + def inspect(depth: 0) + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/file_input.rbi b/rbi/imagekit/internal/type/file_input.rbi new file mode 100644 index 00000000..1982d8a2 --- /dev/null +++ b/rbi/imagekit/internal/type/file_input.rbi @@ -0,0 +1,59 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + # + # Either `Pathname` or `StringIO`, or `IO`, or + # `Imagekit::Internal::Type::FileInput`. + # + # Note: when `IO` is used, all retries are disabled, since many IO` streams are + # not rewindable. + class FileInput + extend Imagekit::Internal::Type::Converter + + abstract! + + sig { params(other: T.anything).returns(T::Boolean) } + def self.===(other) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def self.==(other) + end + + class << self + # @api private + sig do + override + .params( + value: T.any(StringIO, String, T.anything), + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.any(StringIO, T.anything)) + end + def coerce(value, state:) + end + + # @api private + sig do + override + .params( + value: T.any(Pathname, StringIO, IO, String, T.anything), + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.any(Pathname, StringIO, IO, String, T.anything)) + end + def dump(value, state:) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/hash_of.rbi b/rbi/imagekit/internal/type/hash_of.rbi new file mode 100644 index 00000000..0d963136 --- /dev/null +++ b/rbi/imagekit/internal/type/hash_of.rbi @@ -0,0 +1,104 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + # + # Hash of items of a given type. + class HashOf + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + abstract! + + Elem = type_member(:out) + + sig do + params( + type_info: + T.any( + Imagekit::Internal::AnyHash, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ), + spec: Imagekit::Internal::AnyHash + ).returns(T.attached_class) + end + def self.[](type_info, spec = {}) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ===(other) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ==(other) + end + + sig { returns(Integer) } + def hash + end + + # @api private + sig do + override + .params( + value: T.any(T::Hash[T.anything, T.anything], T.anything), + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.any(Imagekit::Internal::AnyHash, T.anything)) + end + def coerce(value, state:) + end + + # @api private + sig do + override + .params( + value: T.any(T::Hash[T.anything, T.anything], T.anything), + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.any(Imagekit::Internal::AnyHash, T.anything)) + end + def dump(value, state:) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + + # @api private + sig { returns(Elem) } + protected def item_type + end + + # @api private + sig { returns(T::Boolean) } + protected def nilable? + end + + # @api private + sig do + params( + type_info: + T.any( + Imagekit::Internal::AnyHash, + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::Type::Converter::Input + ), + spec: Imagekit::Internal::AnyHash + ).void + end + def initialize(type_info, spec = {}) + end + + # @api private + sig { params(depth: Integer).returns(String) } + def inspect(depth: 0) + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/request_parameters.rbi b/rbi/imagekit/internal/type/request_parameters.rbi new file mode 100644 index 00000000..a8f7b350 --- /dev/null +++ b/rbi/imagekit/internal/type/request_parameters.rbi @@ -0,0 +1,29 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + module RequestParameters + # Options to specify HTTP behaviour for this request. + sig { returns(Imagekit::RequestOptions) } + attr_reader :request_options + + sig { params(request_options: Imagekit::RequestOptions::OrHash).void } + attr_writer :request_options + + # @api private + module Converter + # @api private + sig do + params(params: T.anything).returns( + [T.anything, Imagekit::Internal::AnyHash] + ) + end + def dump_request(params) + end + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/union.rbi b/rbi/imagekit/internal/type/union.rbi new file mode 100644 index 00000000..1fd36045 --- /dev/null +++ b/rbi/imagekit/internal/type/union.rbi @@ -0,0 +1,128 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + module Union + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + # @api private + # + # All of the specified variant info for this union. + sig do + returns( + T::Array[ + [ + T.nilable(Symbol), + T.proc.returns(Imagekit::Internal::Type::Converter::Input), + Imagekit::Internal::AnyHash + ] + ] + ) + end + private def known_variants + end + + # @api private + sig do + returns( + T::Array[ + [T.nilable(Symbol), T.anything, Imagekit::Internal::AnyHash] + ] + ) + end + protected def derefed_variants + end + + # All of the specified variants for this union. + sig { overridable.returns(T::Array[T.anything]) } + def variants + end + + # @api private + sig { params(property: Symbol).void } + private def discriminator(property) + end + + # @api private + sig do + params( + key: + T.any( + Symbol, + Imagekit::Internal::AnyHash, + T.proc.returns(T.anything), + T.anything + ), + spec: + T.any( + Imagekit::Internal::AnyHash, + T.proc.returns(T.anything), + T.anything + ) + ).void + end + private def variant(key, spec = nil) + end + + # @api private + sig { params(value: T.anything).returns(T.nilable(T.anything)) } + private def resolve_variant(value) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ===(other) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def ==(other) + end + + sig { returns(Integer) } + def hash + end + + # @api private + # + # Tries to efficiently coerce the given value to one of the known variants. + # + # If the value cannot match any of the known variants, the coercion is considered + # non-viable and returns the original value. + sig do + override + .params( + value: T.anything, + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.anything) + end + def coerce(value, state:) + end + + # @api private + sig do + override + .params( + value: T.anything, + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.anything) + end + def dump(value, state:) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + + # @api private + sig { params(depth: Integer).returns(String) } + def inspect(depth: 0) + end + end + end + end +end diff --git a/rbi/imagekit/internal/type/unknown.rbi b/rbi/imagekit/internal/type/unknown.rbi new file mode 100644 index 00000000..27d7c467 --- /dev/null +++ b/rbi/imagekit/internal/type/unknown.rbi @@ -0,0 +1,58 @@ +# typed: strong + +module Imagekit + module Internal + module Type + # @api private + # + # When we don't know what to expect for the value. + class Unknown + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + abstract! + + sig { params(other: T.anything).returns(T::Boolean) } + def self.===(other) + end + + sig { params(other: T.anything).returns(T::Boolean) } + def self.==(other) + end + + class << self + # @api private + # + # No coercion needed for Unknown type. + sig do + override + .params( + value: T.anything, + state: Imagekit::Internal::Type::Converter::CoerceState + ) + .returns(T.anything) + end + def coerce(value, state:) + end + + # @api private + sig do + override + .params( + value: T.anything, + state: Imagekit::Internal::Type::Converter::DumpState + ) + .returns(T.anything) + end + def dump(value, state:) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + end + end + end + end +end diff --git a/rbi/imagekit/internal/util.rbi b/rbi/imagekit/internal/util.rbi new file mode 100644 index 00000000..268628ae --- /dev/null +++ b/rbi/imagekit/internal/util.rbi @@ -0,0 +1,487 @@ +# typed: strong + +module Imagekit + module Internal + # @api private + module Util + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + # @api private + sig { returns(Float) } + def self.monotonic_secs + end + + # @api private + sig do + params(ns: T.any(Module, T::Class[T.anything])).returns( + T::Enumerable[T.any(Module, T::Class[T.anything])] + ) + end + def self.walk_namespaces(ns) + end + + class << self + # @api private + sig { returns(String) } + def arch + end + + # @api private + sig { returns(String) } + def os + end + end + + class << self + # @api private + sig { params(input: T.anything).returns(T::Boolean) } + def primitive?(input) + end + + # @api private + sig do + params(input: T.any(String, T::Boolean)).returns( + T.any(T::Boolean, T.anything) + ) + end + def coerce_boolean(input) + end + + # @api private + sig do + params(input: T.any(String, T::Boolean)).returns( + T.nilable(T::Boolean) + ) + end + def coerce_boolean!(input) + end + + # @api private + sig do + params(input: T.any(String, Integer)).returns( + T.any(Integer, T.anything) + ) + end + def coerce_integer(input) + end + + # @api private + sig do + params(input: T.any(String, Integer, Float)).returns( + T.any(Float, T.anything) + ) + end + def coerce_float(input) + end + + # @api private + sig do + params(input: T.anything).returns( + T.any(T::Hash[T.anything, T.anything], T.anything) + ) + end + def coerce_hash(input) + end + + # @api private + sig do + params(input: T.anything).returns( + T.nilable(T::Hash[T.anything, T.anything]) + ) + end + def coerce_hash!(input) + end + end + + class << self + # @api private + sig do + params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns( + T.anything + ) + end + private def deep_merge_lr(lhs, rhs, concat: false) + end + + # @api private + # + # Recursively merge one hash with another. If the values at a given key are not + # both hashes, just take the new value. + sig do + params( + values: T::Array[T.anything], + sentinel: T.nilable(T.anything), + concat: T::Boolean + ).returns(T.anything) + end + def deep_merge( + *values, + # the value to return if no values are provided. + sentinel: nil, + # whether to merge sequences by concatenation. + concat: false + ) + end + + # @api private + sig do + params( + data: + T.any( + Imagekit::Internal::AnyHash, + T::Array[T.anything], + T.anything + ), + pick: + T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), + blk: T.nilable(T.proc.returns(T.anything)) + ).returns(T.nilable(T.anything)) + end + def dig(data, pick, &blk) + end + end + + class << self + # @api private + sig { params(uri: URI::Generic).returns(String) } + def uri_origin(uri) + end + + # @api private + sig { params(path: T.any(String, T::Array[String])).returns(String) } + def interpolate_path(path) + end + end + + class << self + # @api private + sig do + params(query: T.nilable(String)).returns( + T::Hash[String, T::Array[String]] + ) + end + def decode_query(query) + end + + # @api private + sig do + params( + query: + T.nilable( + T::Hash[String, T.nilable(T.any(T::Array[String], String))] + ) + ).returns(T.nilable(String)) + end + def encode_query(query) + end + end + + ParsedUri = + T.type_alias do + { + scheme: T.nilable(String), + host: T.nilable(String), + port: T.nilable(Integer), + path: T.nilable(String), + query: T::Hash[String, T::Array[String]] + } + end + + class << self + # @api private + sig do + params(url: T.any(URI::Generic, String)).returns( + Imagekit::Internal::Util::ParsedUri + ) + end + def parse_uri(url) + end + + # @api private + sig do + params(parsed: Imagekit::Internal::Util::ParsedUri).returns( + URI::Generic + ) + end + def unparse_uri(parsed) + end + + # @api private + sig do + params( + lhs: Imagekit::Internal::Util::ParsedUri, + rhs: Imagekit::Internal::Util::ParsedUri + ).returns(URI::Generic) + end + def join_parsed_uri(lhs, rhs) + end + end + + class << self + # @api private + sig do + params( + headers: + T::Hash[ + String, + T.nilable( + T.any( + String, + Integer, + T::Array[T.nilable(T.any(String, Integer))] + ) + ) + ] + ).returns(T::Hash[String, String]) + end + def normalized_headers(*headers) + end + end + + # @api private + # + # An adapter that satisfies the IO interface required by `::IO.copy_stream` + class ReadIOAdapter + # @api private + sig { returns(T.nilable(T::Boolean)) } + def close? + end + + # @api private + sig { void } + def close + end + + # @api private + sig { params(max_len: T.nilable(Integer)).returns(String) } + private def read_enum(max_len) + end + + # @api private + sig do + params( + max_len: T.nilable(Integer), + out_string: T.nilable(String) + ).returns(T.nilable(String)) + end + def read(max_len = nil, out_string = nil) + end + + # @api private + sig do + params( + src: T.any(String, Pathname, StringIO, T::Enumerable[String]), + blk: T.proc.params(arg0: String).void + ).returns(T.attached_class) + end + def self.new(src, &blk) + end + end + + class << self + sig do + params(blk: T.proc.params(y: Enumerator::Yielder).void).returns( + T::Enumerable[String] + ) + end + def writable_enum(&blk) + end + end + + JSON_CONTENT = + T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp) + JSONL_CONTENT = + T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp) + + class << self + # @api private + sig do + params( + y: Enumerator::Yielder, + val: T.anything, + closing: T::Array[T.proc.void], + content_type: T.nilable(String) + ).void + end + private def write_multipart_content( + y, + val:, + closing:, + content_type: nil + ) + end + + # @api private + sig do + params( + y: Enumerator::Yielder, + boundary: String, + key: T.any(Symbol, String), + val: T.anything, + closing: T::Array[T.proc.void] + ).void + end + private def write_multipart_chunk(y, boundary:, key:, val:, closing:) + end + + # @api private + # + # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content + sig do + params(body: T.anything).returns([String, T::Enumerable[String]]) + end + private def encode_multipart_streaming(body) + end + + # @api private + sig do + params(headers: T::Hash[String, String], body: T.anything).returns( + T.anything + ) + end + def encode_content(headers, body) + end + + # @api private + # + # https://www.iana.org/assignments/character-sets/character-sets.xhtml + sig { params(content_type: String, text: String).void } + def force_charset!(content_type, text:) + end + + # @api private + # + # Assumes each chunk in stream has `Encoding::BINARY`. + sig do + params( + headers: T.any(T::Hash[String, String], Net::HTTPHeader), + stream: T::Enumerable[String], + suppress_error: T::Boolean + ).returns(T.anything) + end + def decode_content(headers, stream:, suppress_error: false) + end + end + + class << self + # @api private + # + # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html + sig do + params( + enum: T::Enumerable[T.anything], + external: T::Boolean, + close: T.proc.void + ).returns(T::Enumerable[T.anything]) + end + def fused_enum(enum, external: false, &close) + end + + # @api private + sig { params(enum: T.nilable(T::Enumerable[T.anything])).void } + def close_fused!(enum) + end + + # @api private + sig do + params( + enum: T.nilable(T::Enumerable[T.anything]), + blk: T.proc.params(arg0: Enumerator::Yielder).void + ).returns(T::Enumerable[T.anything]) + end + def chain_fused(enum, &blk) + end + end + + ServerSentEvent = + T.type_alias do + { + event: T.nilable(String), + data: T.nilable(String), + id: T.nilable(String), + retry: T.nilable(Integer) + } + end + + class << self + # @api private + # + # Assumes Strings have been forced into having `Encoding::BINARY`. + # + # This decoder is responsible for reassembling lines split across multiple + # fragments. + sig do + params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) + end + def decode_lines(enum) + end + + # @api private + # + # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream + # + # Assumes that `lines` has been decoded with `#decode_lines`. + sig do + params(lines: T::Enumerable[String]).returns( + T::Enumerable[Imagekit::Internal::Util::ServerSentEvent] + ) + end + def decode_sse(lines) + end + end + + # @api private + module SorbetRuntimeSupport + class MissingSorbetRuntimeError < ::RuntimeError + end + + # @api private + sig { returns(T::Hash[Symbol, T.anything]) } + private def sorbet_runtime_constants + end + + # @api private + sig { params(name: Symbol).void } + def const_missing(name) + end + + # @api private + sig { params(name: Symbol).returns(T::Boolean) } + def sorbet_constant_defined?(name) + end + + # @api private + sig { params(name: Symbol, blk: T.proc.returns(T.anything)).void } + def define_sorbet_constant!(name, &blk) + end + + # @api private + sig { returns(T.anything) } + def to_sorbet_type + end + + class << self + # @api private + sig do + params( + type: + T.any( + Imagekit::Internal::Util::SorbetRuntimeSupport, + T.anything + ) + ).returns(T.anything) + end + def to_sorbet_type(type) + end + end + end + end + end +end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi new file mode 100644 index 00000000..7ab12638 --- /dev/null +++ b/rbi/imagekit/models.rbi @@ -0,0 +1,59 @@ +# typed: strong + +module Imagekit + AccountGetUsageParams = Imagekit::Models::AccountGetUsageParams + + BulkJobCopyFolderParams = Imagekit::Models::BulkJobCopyFolderParams + + BulkJobMoveFolderParams = Imagekit::Models::BulkJobMoveFolderParams + + BulkJobRetrieveStatusParams = Imagekit::Models::BulkJobRetrieveStatusParams + + CustomMetadataFieldCreateParams = + Imagekit::Models::CustomMetadataFieldCreateParams + + CustomMetadataFieldDeleteParams = + Imagekit::Models::CustomMetadataFieldDeleteParams + + CustomMetadataFieldListParams = + Imagekit::Models::CustomMetadataFieldListParams + + CustomMetadataFieldUpdateParams = + Imagekit::Models::CustomMetadataFieldUpdateParams + + ExifDetails = Imagekit::Models::ExifDetails + + ExifImage = Imagekit::Models::ExifImage + + FileAddTagsParams = Imagekit::Models::FileAddTagsParams + + FileCopyParams = Imagekit::Models::FileCopyParams + + FileDeleteParams = Imagekit::Models::FileDeleteParams + + FileListParams = Imagekit::Models::FileListParams + + FileMoveParams = Imagekit::Models::FileMoveParams + + FileRemoveAITagsParams = Imagekit::Models::FileRemoveAITagsParams + + FileRemoveTagsParams = Imagekit::Models::FileRemoveTagsParams + + FileRenameParams = Imagekit::Models::FileRenameParams + + Files = Imagekit::Models::Files + + FileUploadV1Params = Imagekit::Models::FileUploadV1Params + + FileUploadV2Params = Imagekit::Models::FileUploadV2Params + + FolderCreateParams = Imagekit::Models::FolderCreateParams + + FolderDeleteParams = Imagekit::Models::FolderDeleteParams + + Gps = Imagekit::Models::Gps + + Interoperability = Imagekit::Models::Interoperability + + Thumbnail = Imagekit::Models::Thumbnail +end diff --git a/rbi/imagekit/models/account_get_usage_params.rbi b/rbi/imagekit/models/account_get_usage_params.rbi new file mode 100644 index 00000000..50e04f83 --- /dev/null +++ b/rbi/imagekit/models/account_get_usage_params.rbi @@ -0,0 +1,55 @@ +# typed: strong + +module Imagekit + module Models + class AccountGetUsageParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::AccountGetUsageParams, Imagekit::Internal::AnyHash) + end + + # 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. + sig { returns(Date) } + attr_accessor :end_date + + # 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. + sig { returns(Date) } + attr_accessor :start_date + + sig do + params( + end_date: Date, + start_date: Date, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + end_date:, + # 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. + start_date:, + request_options: {} + ) + end + + sig do + override.returns( + { + end_date: Date, + start_date: Date, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/account_get_usage_response.rbi b/rbi/imagekit/models/account_get_usage_response.rbi new file mode 100644 index 00000000..b470cb30 --- /dev/null +++ b/rbi/imagekit/models/account_get_usage_response.rbi @@ -0,0 +1,87 @@ +# typed: strong + +module Imagekit + module Models + class AccountGetUsageResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::AccountGetUsageResponse, + Imagekit::Internal::AnyHash + ) + end + + # Amount of bandwidth used in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :bandwidth_bytes + + sig { params(bandwidth_bytes: Integer).void } + attr_writer :bandwidth_bytes + + # Number of extension units used. + sig { returns(T.nilable(Integer)) } + attr_reader :extension_units_count + + sig { params(extension_units_count: Integer).void } + attr_writer :extension_units_count + + # Storage used by media library in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :media_library_storage_bytes + + sig { params(media_library_storage_bytes: Integer).void } + attr_writer :media_library_storage_bytes + + # Storage used by the original cache in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :original_cache_storage_bytes + + sig { params(original_cache_storage_bytes: Integer).void } + attr_writer :original_cache_storage_bytes + + # Number of video processing units used. + sig { returns(T.nilable(Integer)) } + attr_reader :video_processing_units_count + + sig { params(video_processing_units_count: Integer).void } + attr_writer :video_processing_units_count + + sig do + params( + bandwidth_bytes: Integer, + extension_units_count: Integer, + media_library_storage_bytes: Integer, + original_cache_storage_bytes: Integer, + video_processing_units_count: Integer + ).returns(T.attached_class) + end + def self.new( + # Amount of bandwidth used in bytes. + bandwidth_bytes: nil, + # Number of extension units used. + extension_units_count: nil, + # Storage used by media library in bytes. + media_library_storage_bytes: nil, + # Storage used by the original cache in bytes. + original_cache_storage_bytes: nil, + # Number of video processing units used. + video_processing_units_count: nil + ) + end + + sig do + override.returns( + { + bandwidth_bytes: Integer, + extension_units_count: Integer, + media_library_storage_bytes: Integer, + original_cache_storage_bytes: Integer, + video_processing_units_count: Integer + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/bulk_job_copy_folder_params.rbi b/rbi/imagekit/models/bulk_job_copy_folder_params.rbi new file mode 100644 index 00000000..79256fbb --- /dev/null +++ b/rbi/imagekit/models/bulk_job_copy_folder_params.rbi @@ -0,0 +1,68 @@ +# typed: strong + +module Imagekit + module Models + class BulkJobCopyFolderParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::BulkJobCopyFolderParams, Imagekit::Internal::AnyHash) + end + + # Full path to the destination folder where you want to copy the source folder + # into. + sig { returns(String) } + attr_accessor :destination_path + + # The full path to the source folder you want to copy. + sig { returns(String) } + attr_accessor :source_folder_path + + # 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`. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_versions + + sig { params(include_versions: T::Boolean).void } + attr_writer :include_versions + + sig do + params( + destination_path: String, + source_folder_path: String, + include_versions: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Full path to the destination folder where you want to copy the source folder + # into. + destination_path:, + # The full path to the source folder you want to copy. + source_folder_path:, + # 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`. + include_versions: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + destination_path: String, + source_folder_path: String, + include_versions: T::Boolean, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/bulk_job_copy_folder_response.rbi b/rbi/imagekit/models/bulk_job_copy_folder_response.rbi new file mode 100644 index 00000000..d1c906f2 --- /dev/null +++ b/rbi/imagekit/models/bulk_job_copy_folder_response.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Imagekit + module Models + class BulkJobCopyFolderResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::BulkJobCopyFolderResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + sig { returns(T.nilable(String)) } + attr_reader :job_id + + sig { params(job_id: String).void } + attr_writer :job_id + + sig { params(job_id: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + job_id: nil + ) + end + + sig { override.returns({ job_id: String }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/bulk_job_move_folder_params.rbi b/rbi/imagekit/models/bulk_job_move_folder_params.rbi new file mode 100644 index 00000000..048ceb4f --- /dev/null +++ b/rbi/imagekit/models/bulk_job_move_folder_params.rbi @@ -0,0 +1,53 @@ +# typed: strong + +module Imagekit + module Models + class BulkJobMoveFolderParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::BulkJobMoveFolderParams, Imagekit::Internal::AnyHash) + end + + # Full path to the destination folder where you want to move the source folder + # into. + sig { returns(String) } + attr_accessor :destination_path + + # The full path to the source folder you want to move. + sig { returns(String) } + attr_accessor :source_folder_path + + sig do + params( + destination_path: String, + source_folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Full path to the destination folder where you want to move the source folder + # into. + destination_path:, + # The full path to the source folder you want to move. + source_folder_path:, + request_options: {} + ) + end + + sig do + override.returns( + { + destination_path: String, + source_folder_path: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/bulk_job_move_folder_response.rbi b/rbi/imagekit/models/bulk_job_move_folder_response.rbi new file mode 100644 index 00000000..21984d3f --- /dev/null +++ b/rbi/imagekit/models/bulk_job_move_folder_response.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Imagekit + module Models + class BulkJobMoveFolderResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::BulkJobMoveFolderResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + sig { returns(T.nilable(String)) } + attr_reader :job_id + + sig { params(job_id: String).void } + attr_writer :job_id + + sig { params(job_id: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + job_id: nil + ) + end + + sig { override.returns({ job_id: String }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/bulk_job_retrieve_status_params.rbi b/rbi/imagekit/models/bulk_job_retrieve_status_params.rbi new file mode 100644 index 00000000..069c5123 --- /dev/null +++ b/rbi/imagekit/models/bulk_job_retrieve_status_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Imagekit + module Models + class BulkJobRetrieveStatusParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::BulkJobRetrieveStatusParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/bulk_job_retrieve_status_response.rbi b/rbi/imagekit/models/bulk_job_retrieve_status_response.rbi new file mode 100644 index 00000000..8da0523f --- /dev/null +++ b/rbi/imagekit/models/bulk_job_retrieve_status_response.rbi @@ -0,0 +1,55 @@ +# typed: strong + +module Imagekit + module Models + class BulkJobRetrieveStatusResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::BulkJobRetrieveStatusResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the bulk job. + sig { returns(T.nilable(String)) } + attr_reader :job_id + + sig { params(job_id: String).void } + attr_writer :job_id + + # Status of the bulk job. Possible values - `Pending`, `Completed`. + sig { returns(T.nilable(String)) } + attr_reader :status + + sig { params(status: String).void } + attr_writer :status + + # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + sig do + params(job_id: String, status: String, type: String).returns( + T.attached_class + ) + end + def self.new( + # Unique identifier of the bulk job. + job_id: nil, + # Status of the bulk job. Possible values - `Pending`, `Completed`. + status: nil, + # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`. + type: nil + ) + end + + sig { override.returns({ job_id: String, status: String, type: String }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_create_params.rbi b/rbi/imagekit/models/custom_metadata_field_create_params.rbi new file mode 100644 index 00000000..afb0019f --- /dev/null +++ b/rbi/imagekit/models/custom_metadata_field_create_params.rbi @@ -0,0 +1,443 @@ +# typed: strong + +module Imagekit + module Models + class CustomMetadataFieldCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::CustomMetadataFieldCreateParams, + Imagekit::Internal::AnyHash + ) + end + + # 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. + sig { returns(String) } + attr_accessor :label + + # API name of the custom metadata field. This should be unique across all + # (including deleted) custom metadata fields. + sig { returns(String) } + attr_accessor :name + + sig { returns(Imagekit::CustomMetadataFieldCreateParams::Schema) } + attr_reader :schema + + sig do + params( + schema: Imagekit::CustomMetadataFieldCreateParams::Schema::OrHash + ).void + end + attr_writer :schema + + sig do + params( + label: String, + name: String, + schema: Imagekit::CustomMetadataFieldCreateParams::Schema::OrHash, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + label:, + # API name of the custom metadata field. This should be unique across all + # (including deleted) custom metadata fields. + name:, + schema:, + request_options: {} + ) + end + + sig do + override.returns( + { + label: String, + name: String, + schema: Imagekit::CustomMetadataFieldCreateParams::Schema, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + class Schema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::CustomMetadataFieldCreateParams::Schema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol + ) + end + attr_accessor :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. + sig do + returns( + T.nilable( + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants + ).void + end + attr_writer :min_value + + # An array of allowed values. This property is only required if `type` property is + # set to `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + sig do + params( + type: + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol, + default_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + ] + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + 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. + default_value: nil, + # 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. + is_value_required: nil, + # Maximum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # An array of allowed values. This property is only required if `type` property is + # set to `SingleSelect` or `MultiSelect`. + select_options: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol, + default_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + ] + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::CustomMetadataFieldCreateParams::Schema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + ) + TEXT_AREA = + T.let( + :TextArea, + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # 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. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + UnionMember3Array = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3 + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_create_response.rbi b/rbi/imagekit/models/custom_metadata_field_create_response.rbi new file mode 100644 index 00000000..afd4e3bf --- /dev/null +++ b/rbi/imagekit/models/custom_metadata_field_create_response.rbi @@ -0,0 +1,438 @@ +# typed: strong + +module Imagekit + module Models + class CustomMetadataFieldCreateResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::CustomMetadataFieldCreateResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the custom metadata field. Use this to update the field. + sig { returns(String) } + attr_accessor :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. + sig { returns(String) } + attr_accessor :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. + sig { returns(String) } + attr_accessor :name + + # An object that describes the rules for the custom metadata field value. + sig do + returns(Imagekit::Models::CustomMetadataFieldCreateResponse::Schema) + end + attr_reader :schema + + sig do + params( + schema: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::OrHash + ).void + end + attr_writer :schema + + # Object containing details of a custom metadata field. + sig do + params( + id: String, + label: String, + name: String, + schema: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::OrHash + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the custom metadata field. Use this to update the field. + 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. + 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. + name:, + # An object that describes the rules for the custom metadata field value. + schema: + ) + end + + sig do + override.returns( + { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + } + ) + end + def to_hash + end + + class Schema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ) + end + attr_accessor :type + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the this custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants + ).void + end + attr_writer :min_value + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # An object that describes the rules for the custom metadata field value. + sig do + params( + type: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::OrSymbol, + default_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + ] + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + default_value: nil, + # Specifies if the this custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol, + default_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + ] + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ) + TEXT_AREA = + T.let( + :TextArea, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + UnionMember3Array = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3 + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_delete_params.rbi b/rbi/imagekit/models/custom_metadata_field_delete_params.rbi new file mode 100644 index 00000000..677f0d13 --- /dev/null +++ b/rbi/imagekit/models/custom_metadata_field_delete_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Imagekit + module Models + class CustomMetadataFieldDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::CustomMetadataFieldDeleteParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_delete_response.rbi b/rbi/imagekit/models/custom_metadata_field_delete_response.rbi new file mode 100644 index 00000000..9bd69519 --- /dev/null +++ b/rbi/imagekit/models/custom_metadata_field_delete_response.rbi @@ -0,0 +1,8 @@ +# typed: strong + +module Imagekit + module Models + CustomMetadataFieldDeleteResponse = + T.let(T.anything, Imagekit::Internal::Type::Converter) + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_list_params.rbi b/rbi/imagekit/models/custom_metadata_field_list_params.rbi new file mode 100644 index 00000000..1e59ae91 --- /dev/null +++ b/rbi/imagekit/models/custom_metadata_field_list_params.rbi @@ -0,0 +1,51 @@ +# typed: strong + +module Imagekit + module Models + class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::CustomMetadataFieldListParams, + Imagekit::Internal::AnyHash + ) + end + + # Set it to `true` to include deleted field objects in the API response. Default + # value is `false`. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_deleted + + sig { params(include_deleted: T::Boolean).void } + attr_writer :include_deleted + + sig do + params( + include_deleted: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Set it to `true` to include deleted field objects in the API response. Default + # value is `false`. + include_deleted: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + include_deleted: T::Boolean, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_list_response.rbi b/rbi/imagekit/models/custom_metadata_field_list_response.rbi new file mode 100644 index 00000000..9a5b2895 --- /dev/null +++ b/rbi/imagekit/models/custom_metadata_field_list_response.rbi @@ -0,0 +1,447 @@ +# typed: strong + +module Imagekit + module Models + class CustomMetadataFieldListResponseItem < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::CustomMetadataFieldListResponseItem, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the custom metadata field. Use this to update the field. + sig { returns(String) } + attr_accessor :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. + sig { returns(String) } + attr_accessor :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. + sig { returns(String) } + attr_accessor :name + + # An object that describes the rules for the custom metadata field value. + sig do + returns(Imagekit::Models::CustomMetadataFieldListResponseItem::Schema) + end + attr_reader :schema + + sig do + params( + schema: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::OrHash + ).void + end + attr_writer :schema + + # Object containing details of a custom metadata field. + sig do + params( + id: String, + label: String, + name: String, + schema: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::OrHash + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the custom metadata field. Use this to update the field. + 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. + 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. + name:, + # An object that describes the rules for the custom metadata field value. + schema: + ) + end + + sig do + override.returns( + { + id: String, + label: String, + name: String, + schema: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema + } + ) + end + def to_hash + end + + class Schema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ) + end + attr_accessor :type + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the this custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants + ).void + end + attr_writer :min_value + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # An object that describes the rules for the custom metadata field value. + sig do + params( + type: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::OrSymbol, + default_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants + ] + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + default_value: nil, + # Specifies if the this custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol, + default_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants + ] + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ) + TEXT_AREA = + T.let( + :TextArea, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + UnionMember3Array = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3 + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + end + + CustomMetadataFieldListResponse = + T.let( + Imagekit::Internal::Type::ArrayOf[ + Imagekit::Models::CustomMetadataFieldListResponseItem + ], + Imagekit::Internal::Type::Converter + ) + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_update_params.rbi b/rbi/imagekit/models/custom_metadata_field_update_params.rbi new file mode 100644 index 00000000..72ea1598 --- /dev/null +++ b/rbi/imagekit/models/custom_metadata_field_update_params.rbi @@ -0,0 +1,376 @@ +# typed: strong + +module Imagekit + module Models + class CustomMetadataFieldUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::CustomMetadataFieldUpdateParams, + Imagekit::Internal::AnyHash + ) + end + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :label + + sig { params(label: String).void } + attr_writer :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`. + sig do + returns(T.nilable(Imagekit::CustomMetadataFieldUpdateParams::Schema)) + end + attr_reader :schema + + sig do + params( + schema: Imagekit::CustomMetadataFieldUpdateParams::Schema::OrHash + ).void + end + attr_writer :schema + + sig do + params( + label: String, + schema: Imagekit::CustomMetadataFieldUpdateParams::Schema::OrHash, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + label: nil, + # 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`. + schema: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + label: String, + schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + class Schema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::CustomMetadataFieldUpdateParams::Schema, + Imagekit::Internal::AnyHash + ) + end + + # 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. + sig do + returns( + T.nilable( + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants + ).void + end + attr_writer :min_value + + # An array of allowed values. This property is only required if `type` property is + # set to `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # 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`. + sig do + params( + default_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + ] + ).returns(T.attached_class) + end + def self.new( + # 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. + default_value: nil, + # 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. + is_value_required: nil, + # Maximum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set this property if `type` is set to `Text` or + # `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # An array of allowed values. This property is only required if `type` property is + # set to `SingleSelect` or `MultiSelect`. + select_options: nil + ) + end + + sig do + override.returns( + { + default_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + ] + } + ) + end + def to_hash + end + + # 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. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + UnionMember3Array = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3 + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_update_response.rbi b/rbi/imagekit/models/custom_metadata_field_update_response.rbi new file mode 100644 index 00000000..9769d07a --- /dev/null +++ b/rbi/imagekit/models/custom_metadata_field_update_response.rbi @@ -0,0 +1,438 @@ +# typed: strong + +module Imagekit + module Models + class CustomMetadataFieldUpdateResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::CustomMetadataFieldUpdateResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the custom metadata field. Use this to update the field. + sig { returns(String) } + attr_accessor :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. + sig { returns(String) } + attr_accessor :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. + sig { returns(String) } + attr_accessor :name + + # An object that describes the rules for the custom metadata field value. + sig do + returns(Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema) + end + attr_reader :schema + + sig do + params( + schema: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::OrHash + ).void + end + attr_writer :schema + + # Object containing details of a custom metadata field. + sig do + params( + id: String, + label: String, + name: String, + schema: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::OrHash + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the custom metadata field. Use this to update the field. + 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. + 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. + name:, + # An object that describes the rules for the custom metadata field value. + schema: + ) + end + + sig do + override.returns( + { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema + } + ) + end + def to_hash + end + + class Schema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ) + end + attr_accessor :type + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the this custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants + ).void + end + attr_writer :min_value + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # An object that describes the rules for the custom metadata field value. + sig do + params( + type: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::OrSymbol, + default_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants + ] + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + default_value: nil, + # Specifies if the this custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol, + default_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants, + select_options: + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants + ] + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ) + TEXT_AREA = + T.let( + :TextArea, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. Date type of default value + # depends on the field type. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + UnionMember3Array = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3 + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/exif_details.rbi b/rbi/imagekit/models/exif_details.rbi new file mode 100644 index 00000000..9fa9f276 --- /dev/null +++ b/rbi/imagekit/models/exif_details.rbi @@ -0,0 +1,264 @@ +# typed: strong + +module Imagekit + module Models + class ExifDetails < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::ExifDetails, Imagekit::Internal::AnyHash) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/exif_image.rbi b/rbi/imagekit/models/exif_image.rbi new file mode 100644 index 00000000..cea9754a --- /dev/null +++ b/rbi/imagekit/models/exif_image.rbi @@ -0,0 +1,127 @@ +# typed: strong + +module Imagekit + module Models + class ExifImage < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Imagekit::ExifImage, Imagekit::Internal::AnyHash) } + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_add_tags_params.rbi b/rbi/imagekit/models/file_add_tags_params.rbi new file mode 100644 index 00000000..bf3d293c --- /dev/null +++ b/rbi/imagekit/models/file_add_tags_params.rbi @@ -0,0 +1,51 @@ +# typed: strong + +module Imagekit + module Models + class FileAddTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileAddTagsParams, Imagekit::Internal::AnyHash) + end + + # An array of fileIds to which you want to add tags. + sig { returns(T::Array[String]) } + attr_accessor :file_ids + + # An array of tags that you want to add to the files. + sig { returns(T::Array[String]) } + attr_accessor :tags + + sig do + params( + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # An array of fileIds to which you want to add tags. + file_ids:, + # An array of tags that you want to add to the files. + tags:, + request_options: {} + ) + end + + sig do + override.returns( + { + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_add_tags_response.rbi b/rbi/imagekit/models/file_add_tags_response.rbi new file mode 100644 index 00000000..ef9b6d3e --- /dev/null +++ b/rbi/imagekit/models/file_add_tags_response.rbi @@ -0,0 +1,39 @@ +# typed: strong + +module Imagekit + module Models + class FileAddTagsResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileAddTagsResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds that in which tags were successfully added. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :successfully_updated_file_ids + + sig { params(successfully_updated_file_ids: T::Array[String]).void } + attr_writer :successfully_updated_file_ids + + sig do + params(successfully_updated_file_ids: T::Array[String]).returns( + T.attached_class + ) + end + def self.new( + # An array of fileIds that in which tags were successfully added. + successfully_updated_file_ids: nil + ) + end + + sig do + override.returns({ successfully_updated_file_ids: T::Array[String] }) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_copy_params.rbi b/rbi/imagekit/models/file_copy_params.rbi new file mode 100644 index 00000000..61987f96 --- /dev/null +++ b/rbi/imagekit/models/file_copy_params.rbi @@ -0,0 +1,66 @@ +# typed: strong + +module Imagekit + module Models + class FileCopyParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileCopyParams, Imagekit::Internal::AnyHash) + end + + # Full path to the folder you want to copy the above file into. + sig { returns(String) } + attr_accessor :destination_path + + # The full path of the file you want to copy. + sig { returns(String) } + attr_accessor :source_file_path + + # 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`. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions + + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions + + sig do + params( + destination_path: String, + source_file_path: String, + include_file_versions: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Full path to the folder you want to copy the above file into. + destination_path:, + # The full path of the file you want to copy. + source_file_path:, + # 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`. + include_file_versions: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + destination_path: String, + source_file_path: String, + include_file_versions: T::Boolean, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_copy_response.rbi b/rbi/imagekit/models/file_copy_response.rbi new file mode 100644 index 00000000..9a764a05 --- /dev/null +++ b/rbi/imagekit/models/file_copy_response.rbi @@ -0,0 +1,7 @@ +# typed: strong + +module Imagekit + module Models + FileCopyResponse = T.let(T.anything, Imagekit::Internal::Type::Converter) + end +end diff --git a/rbi/imagekit/models/file_delete_params.rbi b/rbi/imagekit/models/file_delete_params.rbi new file mode 100644 index 00000000..9573cf16 --- /dev/null +++ b/rbi/imagekit/models/file_delete_params.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekit + module Models + class FileDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileDeleteParams, Imagekit::Internal::AnyHash) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_list_params.rbi b/rbi/imagekit/models/file_list_params.rbi new file mode 100644 index 00000000..cc6d218a --- /dev/null +++ b/rbi/imagekit/models/file_list_params.rbi @@ -0,0 +1,219 @@ +# typed: strong + +module Imagekit + module Models + class FileListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileListParams, Imagekit::Internal::AnyHash) + end + + # Type of files to include in the result set. Accepts three values: + # + # `all` - include all types of files in the result set. `image` - only search in + # image type files. `non-image` - only search in files that are not images, e.g., + # JS or CSS or video files. + # + # Default value - `all` + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # The maximum number of results to return in response: + # + # Minimum value - 1 + # + # Maximum value - 1000 + # + # Default value - 1000 + sig { returns(T.nilable(String)) } + attr_reader :limit + + sig { params(limit: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :path + + sig { params(path: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :search_query + + sig { params(search_query: String).void } + attr_writer :search_query + + # The number of results to skip before returning results: + # + # Minimum value - 0 + # + # Default value - 0 + sig { returns(T.nilable(String)) } + attr_reader :skip + + sig { params(skip: String).void } + attr_writer :skip + + # You can sort based on the following fields: + # + # 1. name - `ASC_NAME` or `DESC_NAME` + # 2. createdAt - `ASC_CREATED` or `DESC_CREATED` + # 3. updatedAt - `ASC_UPDATED` or `DESC_UPDATED` + # 4. height - `ASC_HEIGHT` or `DESC_HEIGHT` + # 5. width - `ASC_WIDTH` or `DESC_WIDTH` + # 6. size - `ASC_SIZE` or `DESC_SIZE` + # + # Default value - `ASC_CREATED` + sig { returns(T.nilable(String)) } + attr_reader :sort + + sig { params(sort: String).void } + attr_writer :sort + + # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to + # include `files` and `folders` in search results (`file-version` will not be + # included in this case). + # + # Default value - `file` + sig { returns(T.nilable(Imagekit::FileListParams::Type::OrSymbol)) } + attr_reader :type + + sig { params(type: Imagekit::FileListParams::Type::OrSymbol).void } + attr_writer :type + + sig do + params( + file_type: String, + limit: String, + path: String, + search_query: String, + skip: String, + sort: String, + type: Imagekit::FileListParams::Type::OrSymbol, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Type of files to include in the result set. Accepts three values: + # + # `all` - include all types of files in the result set. `image` - only search in + # image type files. `non-image` - only search in files that are not images, e.g., + # JS or CSS or video files. + # + # Default value - `all` + file_type: nil, + # The maximum number of results to return in response: + # + # Minimum value - 1 + # + # Maximum value - 1000 + # + # Default value - 1000 + limit: nil, + # Folder path if you want to limit the search within a specific folder. For + # example, `/sales-banner/` will only search in folder sales-banner. + path: nil, + # 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. + search_query: nil, + # The number of results to skip before returning results: + # + # Minimum value - 0 + # + # Default value - 0 + skip: nil, + # You can sort based on the following fields: + # + # 1. name - `ASC_NAME` or `DESC_NAME` + # 2. createdAt - `ASC_CREATED` or `DESC_CREATED` + # 3. updatedAt - `ASC_UPDATED` or `DESC_UPDATED` + # 4. height - `ASC_HEIGHT` or `DESC_HEIGHT` + # 5. width - `ASC_WIDTH` or `DESC_WIDTH` + # 6. size - `ASC_SIZE` or `DESC_SIZE` + # + # Default value - `ASC_CREATED` + sort: nil, + # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to + # include `files` and `folders` in search results (`file-version` will not be + # included in this case). + # + # Default value - `file` + type: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + file_type: String, + limit: String, + path: String, + search_query: String, + skip: String, + sort: String, + type: Imagekit::FileListParams::Type::OrSymbol, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to + # include `files` and `folders` in search results (`file-version` will not be + # included in this case). + # + # Default value - `file` + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::FileListParams::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FILE = T.let(:file, Imagekit::FileListParams::Type::TaggedSymbol) + FILE_VERSION = + T.let(:"file-version", Imagekit::FileListParams::Type::TaggedSymbol) + FOLDER = T.let(:folder, Imagekit::FileListParams::Type::TaggedSymbol) + ALL = T.let(:all, Imagekit::FileListParams::Type::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::FileListParams::Type::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/file_list_response.rbi b/rbi/imagekit/models/file_list_response.rbi new file mode 100644 index 00000000..9f41c564 --- /dev/null +++ b/rbi/imagekit/models/file_list_response.rbi @@ -0,0 +1,387 @@ +# typed: strong + +module Imagekit + module Models + class FileListResponseItem < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileListResponseItem, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the file by auto tagging. + sig do + returns( + T.nilable(T::Array[Imagekit::Models::FileListResponseItem::AITag]) + ) + end + attr_accessor :ai_tags + + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :created_at + + sig { params(created_at: String).void } + attr_writer :created_at + + # An string with custom coordinates of the file. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # An object with custom metadata for the file. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # 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`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Specifies if the image has an alpha channel. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_alpha + + sig { params(has_alpha: T::Boolean).void } + attr_writer :has_alpha + + # Height of the file. + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :height + + # Specifies if the file is private or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # Specifies if the file is published or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # MIME type of the file. + sig { returns(T.nilable(String)) } + attr_reader :mime + + sig { params(mime: String).void } + attr_writer :mime + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the file in bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :size + + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail + + sig { params(thumbnail: String).void } + attr_writer :thumbnail + + # Type of the asset. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :updated_at + + sig { params(updated_at: String).void } + attr_writer :updated_at + + # URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object with details of the file version. + sig do + returns(T.nilable(Imagekit::Models::FileListResponseItem::VersionInfo)) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::FileListResponseItem::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # Width of the file. + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a file or file version. + sig do + params( + ai_tags: + T.nilable( + T::Array[Imagekit::Models::FileListResponseItem::AITag::OrHash] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::FileListResponseItem::VersionInfo::OrHash, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the file by auto tagging. + ai_tags: nil, + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + created_at: nil, + # An string with custom coordinates of the file. + custom_coordinates: nil, + # An object with custom metadata for the file. + custom_metadata: nil, + # Unique identifier of the asset. + file_id: nil, + # 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`. + file_path: nil, + # Type of the file. Possible values are `image`, `non-image`. + file_type: nil, + # Specifies if the image has an alpha channel. + has_alpha: nil, + # Height of the file. + height: nil, + # Specifies if the file is private or not. + is_private_file: nil, + # Specifies if the file is published or not. + is_published: nil, + # MIME type of the file. + mime: nil, + # Name of the asset. + name: nil, + # Size of the file in bytes. + size: nil, + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + tags: nil, + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + thumbnail: nil, + # Type of the asset. + type: nil, + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + updated_at: nil, + # URL of the file. + url: nil, + # An object with details of the file version. + version_info: nil, + # Width of the file. + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[Imagekit::Models::FileListResponseItem::AITag] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::FileListResponseItem::VersionInfo, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileListResponseItem::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + source: nil + ) + end + + sig do + override.returns({ confidence: Float, name: String, source: String }) + end + def to_hash + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileListResponseItem::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object with details of the file version. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + + FileListResponse = + T.let( + Imagekit::Internal::Type::ArrayOf[ + Imagekit::Models::FileListResponseItem + ], + Imagekit::Internal::Type::Converter + ) + end +end diff --git a/rbi/imagekit/models/file_move_params.rbi b/rbi/imagekit/models/file_move_params.rbi new file mode 100644 index 00000000..eed54bf2 --- /dev/null +++ b/rbi/imagekit/models/file_move_params.rbi @@ -0,0 +1,51 @@ +# typed: strong + +module Imagekit + module Models + class FileMoveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileMoveParams, Imagekit::Internal::AnyHash) + end + + # Full path to the folder you want to move the above file into. + sig { returns(String) } + attr_accessor :destination_path + + # The full path of the file you want to move. + sig { returns(String) } + attr_accessor :source_file_path + + sig do + params( + destination_path: String, + source_file_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Full path to the folder you want to move the above file into. + destination_path:, + # The full path of the file you want to move. + source_file_path:, + request_options: {} + ) + end + + sig do + override.returns( + { + destination_path: String, + source_file_path: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_move_response.rbi b/rbi/imagekit/models/file_move_response.rbi new file mode 100644 index 00000000..cc47405a --- /dev/null +++ b/rbi/imagekit/models/file_move_response.rbi @@ -0,0 +1,7 @@ +# typed: strong + +module Imagekit + module Models + FileMoveResponse = T.let(T.anything, Imagekit::Internal::Type::Converter) + end +end diff --git a/rbi/imagekit/models/file_remove_ai_tags_params.rbi b/rbi/imagekit/models/file_remove_ai_tags_params.rbi new file mode 100644 index 00000000..a35889f2 --- /dev/null +++ b/rbi/imagekit/models/file_remove_ai_tags_params.rbi @@ -0,0 +1,51 @@ +# typed: strong + +module Imagekit + module Models + class FileRemoveAITagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileRemoveAITagsParams, Imagekit::Internal::AnyHash) + end + + # An array of AITags that you want to remove from the files. + sig { returns(T::Array[String]) } + attr_accessor :ai_tags + + # An array of fileIds from which you want to remove AITags. + sig { returns(T::Array[String]) } + attr_accessor :file_ids + + sig do + params( + ai_tags: T::Array[String], + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # An array of AITags that you want to remove from the files. + ai_tags:, + # An array of fileIds from which you want to remove AITags. + file_ids:, + request_options: {} + ) + end + + sig do + override.returns( + { + ai_tags: T::Array[String], + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_remove_ai_tags_response.rbi b/rbi/imagekit/models/file_remove_ai_tags_response.rbi new file mode 100644 index 00000000..d054f93d --- /dev/null +++ b/rbi/imagekit/models/file_remove_ai_tags_response.rbi @@ -0,0 +1,39 @@ +# typed: strong + +module Imagekit + module Models + class FileRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileRemoveAITagsResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds that in which AITags were successfully removed. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :successfully_updated_file_ids + + sig { params(successfully_updated_file_ids: T::Array[String]).void } + attr_writer :successfully_updated_file_ids + + sig do + params(successfully_updated_file_ids: T::Array[String]).returns( + T.attached_class + ) + end + def self.new( + # An array of fileIds that in which AITags were successfully removed. + successfully_updated_file_ids: nil + ) + end + + sig do + override.returns({ successfully_updated_file_ids: T::Array[String] }) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_remove_tags_params.rbi b/rbi/imagekit/models/file_remove_tags_params.rbi new file mode 100644 index 00000000..6a74ef8e --- /dev/null +++ b/rbi/imagekit/models/file_remove_tags_params.rbi @@ -0,0 +1,51 @@ +# typed: strong + +module Imagekit + module Models + class FileRemoveTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileRemoveTagsParams, Imagekit::Internal::AnyHash) + end + + # An array of fileIds from which you want to remove tags. + sig { returns(T::Array[String]) } + attr_accessor :file_ids + + # An array of tags that you want to remove from the files. + sig { returns(T::Array[String]) } + attr_accessor :tags + + sig do + params( + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # An array of fileIds from which you want to remove tags. + file_ids:, + # An array of tags that you want to remove from the files. + tags:, + request_options: {} + ) + end + + sig do + override.returns( + { + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_remove_tags_response.rbi b/rbi/imagekit/models/file_remove_tags_response.rbi new file mode 100644 index 00000000..114d74c4 --- /dev/null +++ b/rbi/imagekit/models/file_remove_tags_response.rbi @@ -0,0 +1,39 @@ +# typed: strong + +module Imagekit + module Models + class FileRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileRemoveTagsResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds that in which tags were successfully removed. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :successfully_updated_file_ids + + sig { params(successfully_updated_file_ids: T::Array[String]).void } + attr_writer :successfully_updated_file_ids + + sig do + params(successfully_updated_file_ids: T::Array[String]).returns( + T.attached_class + ) + end + def self.new( + # An array of fileIds that in which tags were successfully removed. + successfully_updated_file_ids: nil + ) + end + + sig do + override.returns({ successfully_updated_file_ids: T::Array[String] }) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_rename_params.rbi b/rbi/imagekit/models/file_rename_params.rbi new file mode 100644 index 00000000..a69d0af0 --- /dev/null +++ b/rbi/imagekit/models/file_rename_params.rbi @@ -0,0 +1,102 @@ +# typed: strong + +module Imagekit + module Models + class FileRenameParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileRenameParams, Imagekit::Internal::AnyHash) + end + + # The full path of the file you want to rename. + sig { returns(String) } + attr_accessor :file_path + + # 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 `_`. + sig { returns(String) } + attr_accessor :new_file_name + + # 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` + sig { returns(T.nilable(T::Boolean)) } + attr_reader :purge_cache + + sig { params(purge_cache: T::Boolean).void } + attr_writer :purge_cache + + sig do + params( + file_path: String, + new_file_name: String, + purge_cache: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # The full path of the file you want to rename. + file_path:, + # 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 `_`. + new_file_name:, + # 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` + purge_cache: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + file_path: String, + new_file_name: String, + purge_cache: T::Boolean, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_rename_response.rbi b/rbi/imagekit/models/file_rename_response.rbi new file mode 100644 index 00000000..2140d23b --- /dev/null +++ b/rbi/imagekit/models/file_rename_response.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Imagekit + module Models + class FileRenameResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileRenameResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the purge request. This can be used to check the status of + # the purge request. + sig { returns(T.nilable(String)) } + attr_reader :purge_request_id + + sig { params(purge_request_id: String).void } + attr_writer :purge_request_id + + sig { params(purge_request_id: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the purge request. This can be used to check the status of + # the purge request. + purge_request_id: nil + ) + end + + sig { override.returns({ purge_request_id: String }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_upload_v1_params.rbi b/rbi/imagekit/models/file_upload_v1_params.rbi new file mode 100644 index 00000000..e1a18d50 --- /dev/null +++ b/rbi/imagekit/models/file_upload_v1_params.rbi @@ -0,0 +1,722 @@ +# typed: strong + +module Imagekit + module Models + class FileUploadV1Params < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileUploadV1Params, Imagekit::Internal::AnyHash) + end + + # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, + # please ensure that our servers can access the URL. In case ImageKit is unable to + # download the file from the specified URL, a `400` error response is returned. + # This will also result in a `400` error if the file download request is aborted + # if response headers are not received in 8 seconds. + sig { returns(String) } + attr_accessor :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 `_` + sig { returns(String) } + attr_accessor :file_name + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :token + + sig { params(token: String).void } + attr_writer :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). + sig { returns(T.nilable(String)) } + attr_reader :checks + + sig { params(checks: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :custom_coordinates + + sig { params(custom_coordinates: String).void } + attr_writer :custom_coordinates + + # Stringified JSON key-value data to be associated with the asset. + sig { returns(T.nilable(String)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: String).void } + attr_writer :custom_metadata + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :expire + + sig { params(expire: String).void } + attr_writer :expire + + # Stringified JSON object with an array of extensions to be applied to the image. + # Refer to extensions schema in + # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + sig { returns(T.nilable(String)) } + attr_reader :extensions + + sig { params(extensions: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :folder + + sig { params(folder: String).void } + attr_writer :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. + sig do + returns( + T.nilable(Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol) + ) + end + attr_reader :is_private_file + + sig do + params( + is_private_file: Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol + ).void + end + attr_writer :is_private_file + + # 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. + sig do + returns(T.nilable(Imagekit::FileUploadV1Params::IsPublished::OrSymbol)) + end + attr_reader :is_published + + sig do + params( + is_published: Imagekit::FileUploadV1Params::IsPublished::OrSymbol + ).void + end + attr_writer :is_published + + # 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. + sig do + returns( + T.nilable(Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol) + ) + end + attr_reader :overwrite_ai_tags + + sig do + params( + overwrite_ai_tags: + Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol + ).void + end + attr_writer :overwrite_ai_tags + + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + sig do + returns( + T.nilable( + Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol + ) + ) + end + attr_reader :overwrite_custom_metadata + + sig do + params( + overwrite_custom_metadata: + Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol + ).void + end + attr_writer :overwrite_custom_metadata + + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + sig { returns(T.nilable(String)) } + attr_reader :overwrite_file + + sig { params(overwrite_file: String).void } + attr_writer :overwrite_file + + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + sig do + returns( + T.nilable(Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol) + ) + end + attr_reader :overwrite_tags + + sig do + params( + overwrite_tags: Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol + ).void + end + attr_writer :overwrite_tags + + # Your ImageKit.io public key. This field is only required for authentication when + # uploading a file from the client side. + sig { returns(T.nilable(String)) } + attr_reader :public_key + + sig { params(public_key: String).void } + attr_writer :public_key + + # Comma-separated values of the fields that you want the API to return in the + # response. + # + # For example, set the value of this field to + # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, + # `customCoordinates`, and `isPrivateFile` in the response. + # + # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, + # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + sig { returns(T.nilable(String)) } + attr_reader :response_fields + + sig { params(response_fields: String).void } + attr_writer :response_fields + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :signature + + sig { params(signature: String).void } + attr_writer :signature + + # Set the tags while uploading the file. + # + # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length + # of all characters should not exceed 500. `%` is not allowed. + # + # If this field is not specified and the file is overwritten then the tags will be + # removed. + sig { returns(T.nilable(String)) } + attr_reader :tags + + sig { params(tags: String).void } + attr_writer :tags + + # Stringified JSON object with properties for pre and post transformations: + # + # `pre` - Accepts a "string" containing a valid transformation used for requesting + # a pre-transformation for an image or a video file. + # + # `post` - Accepts an array of objects with properties: + # + # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` + # (Adaptive bitrate streaming). + # - `value`: A "string" corresponding to the required transformation. Required if + # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or + # `thumbnail`. + # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # + # Read more about + # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + sig { returns(T.nilable(String)) } + attr_reader :transformation + + sig { params(transformation: String).void } + attr_writer :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. + sig do + returns( + T.nilable(Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol) + ) + end + attr_reader :use_unique_file_name + + sig do + params( + use_unique_file_name: + Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol + ).void + end + attr_writer :use_unique_file_name + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + sig do + params( + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + expire: String, + extensions: String, + folder: String, + is_private_file: + Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol, + is_published: Imagekit::FileUploadV1Params::IsPublished::OrSymbol, + overwrite_ai_tags: + Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol, + overwrite_custom_metadata: + Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol, + overwrite_file: String, + overwrite_tags: Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol, + public_key: String, + response_fields: String, + signature: String, + tags: String, + transformation: String, + use_unique_file_name: + Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol, + webhook_url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, + # please ensure that our servers can access the URL. In case ImageKit is unable to + # download the file from the specified URL, a `400` error response is returned. + # This will also result in a `400` error if the file download request is aborted + # if response headers are not received in 8 seconds. + 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 `_` + file_name:, + # 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. + token: nil, + # Server-side checks to run on the asset. Read more about + # [Upload API checks](/docs/api-reference/upload-file/upload-file#upload-api-checks). + checks: nil, + # 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. + custom_coordinates: nil, + # Stringified JSON key-value data to be associated with the asset. + custom_metadata: nil, + # 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. + expire: nil, + # Stringified JSON object with an array of extensions to be applied to the image. + # Refer to extensions schema in + # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + extensions: nil, + # 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. + folder: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # 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. + overwrite_ai_tags: nil, + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + overwrite_custom_metadata: nil, + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + overwrite_file: nil, + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + overwrite_tags: nil, + # Your ImageKit.io public key. This field is only required for authentication when + # uploading a file from the client side. + public_key: nil, + # Comma-separated values of the fields that you want the API to return in the + # response. + # + # For example, set the value of this field to + # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, + # `customCoordinates`, and `isPrivateFile` in the response. + # + # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, + # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + response_fields: nil, + # 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. + signature: nil, + # Set the tags while uploading the file. + # + # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length + # of all characters should not exceed 500. `%` is not allowed. + # + # If this field is not specified and the file is overwritten then the tags will be + # removed. + tags: nil, + # Stringified JSON object with properties for pre and post transformations: + # + # `pre` - Accepts a "string" containing a valid transformation used for requesting + # a pre-transformation for an image or a video file. + # + # `post` - Accepts an array of objects with properties: + # + # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` + # (Adaptive bitrate streaming). + # - `value`: A "string" corresponding to the required transformation. Required if + # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or + # `thumbnail`. + # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # + # Read more about + # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + transformation: nil, + # 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. + use_unique_file_name: nil, + # 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. + webhook_url: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + expire: String, + extensions: String, + folder: String, + is_private_file: + Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol, + is_published: Imagekit::FileUploadV1Params::IsPublished::OrSymbol, + overwrite_ai_tags: + Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol, + overwrite_custom_metadata: + Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol, + overwrite_file: String, + overwrite_tags: + Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol, + public_key: String, + response_fields: String, + signature: String, + tags: String, + transformation: String, + use_unique_file_name: + Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol, + webhook_url: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + # 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. + module IsPrivateFile + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV1Params::IsPrivateFile) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV1Params::IsPrivateFile::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV1Params::IsPrivateFile::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::FileUploadV1Params::IsPrivateFile::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module IsPublished + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV1Params::IsPublished) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let(:true, Imagekit::FileUploadV1Params::IsPublished::TaggedSymbol) + FALSE = + T.let(:false, Imagekit::FileUploadV1Params::IsPublished::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::FileUploadV1Params::IsPublished::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module OverwriteAITags + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV1Params::OverwriteAITags) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV1Params::OverwriteAITags::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV1Params::OverwriteAITags::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadV1Params::OverwriteAITags::TaggedSymbol + ] + ) + end + def self.values + end + end + + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + module OverwriteCustomMetadata + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV1Params::OverwriteCustomMetadata) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV1Params::OverwriteCustomMetadata::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV1Params::OverwriteCustomMetadata::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadV1Params::OverwriteCustomMetadata::TaggedSymbol + ] + ) + end + def self.values + end + end + + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + module OverwriteTags + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV1Params::OverwriteTags) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV1Params::OverwriteTags::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV1Params::OverwriteTags::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::FileUploadV1Params::OverwriteTags::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module UseUniqueFileName + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV1Params::UseUniqueFileName) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV1Params::UseUniqueFileName::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV1Params::UseUniqueFileName::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadV1Params::UseUniqueFileName::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/file_upload_v1_response.rbi b/rbi/imagekit/models/file_upload_v1_response.rbi new file mode 100644 index 00000000..766fea1c --- /dev/null +++ b/rbi/imagekit/models/file_upload_v1_response.rbi @@ -0,0 +1,2625 @@ +# typed: strong + +module Imagekit + module Models + class FileUploadV1Response < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV1Response, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the uploaded file by auto tagging. + sig do + returns( + T.nilable(T::Array[Imagekit::Models::FileUploadV1Response::AITag]) + ) + end + attr_accessor :ai_tags + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :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. + sig do + returns( + T.nilable(Imagekit::Models::FileUploadV1Response::EmbeddedMetadata) + ) + end + attr_reader :embedded_metadata + + sig do + params( + embedded_metadata: + Imagekit::Models::FileUploadV1Response::EmbeddedMetadata::OrHash + ).void + end + attr_writer :embedded_metadata + + # 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. + sig do + returns( + T.nilable(Imagekit::Models::FileUploadV1Response::ExtensionStatus) + ) + end + attr_reader :extension_status + + sig do + params( + extension_status: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::OrHash + ).void + end + attr_writer :extension_status + + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the uploaded file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Height of the image in pixels (Only for images) + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig do + returns(T.nilable(Imagekit::Models::FileUploadV1Response::Metadata)) + end + attr_reader :metadata + + sig do + params( + metadata: Imagekit::Models::FileUploadV1Response::Metadata::OrHash + ).void + end + attr_writer :metadata + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the image file in Bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # In the case of an image, a small thumbnail URL. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail_url + + sig { params(thumbnail_url: String).void } + attr_writer :thumbnail_url + + # A publicly accessible URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object containing the file or file version's `id` (versionId) and `name`. + sig do + returns(T.nilable(Imagekit::Models::FileUploadV1Response::VersionInfo)) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::FileUploadV1Response::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # Width of the image in pixels (Only for Images) + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a successful upload. + sig do + params( + ai_tags: + T.nilable( + T::Array[Imagekit::Models::FileUploadV1Response::AITag::OrHash] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + duration: Integer, + embedded_metadata: + Imagekit::Models::FileUploadV1Response::EmbeddedMetadata::OrHash, + extension_status: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::OrHash, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: Imagekit::Models::FileUploadV1Response::Metadata::OrHash, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: + Imagekit::Models::FileUploadV1Response::VersionInfo::OrHash, + video_codec: String, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the uploaded file by auto tagging. + ai_tags: nil, + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # The duration of the video in seconds (only for video). + duration: nil, + # 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. + embedded_metadata: nil, + # 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. + extension_status: nil, + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + file_id: nil, + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + file_path: nil, + # Type of the uploaded file. Possible values are `image`, `non-image`. + file_type: nil, + # Height of the image in pixels (Only for images) + height: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + metadata: nil, + # Name of the asset. + name: nil, + # Size of the image file in Bytes. + size: nil, + # 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. + tags: nil, + # In the case of an image, a small thumbnail URL. + thumbnail_url: nil, + # A publicly accessible URL of the file. + url: nil, + # An object containing the file or file version's `id` (versionId) and `name`. + version_info: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # Width of the image in pixels (Only for Images) + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[Imagekit::Models::FileUploadV1Response::AITag] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + duration: Integer, + embedded_metadata: + Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, + extension_status: + Imagekit::Models::FileUploadV1Response::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: Imagekit::Models::FileUploadV1Response::Metadata, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadV1Response::VersionInfo, + video_codec: String, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV1Response::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # 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. + source: nil + ) + end + + sig do + override.returns({ confidence: Float, name: String, source: String }) + end + def to_hash + end + end + + class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :about_cv_term_cv_id + + sig { params(about_cv_term_cv_id: String).void } + attr_writer :about_cv_term_cv_id + + sig { returns(T.nilable(String)) } + attr_reader :about_cv_term_id + + sig { params(about_cv_term_id: String).void } + attr_writer :about_cv_term_id + + sig { returns(T.nilable(String)) } + attr_reader :about_cv_term_name + + sig { params(about_cv_term_name: String).void } + attr_writer :about_cv_term_name + + sig { returns(T.nilable(String)) } + attr_reader :about_cv_term_refined_about + + sig { params(about_cv_term_refined_about: String).void } + attr_writer :about_cv_term_refined_about + + sig { returns(T.nilable(String)) } + attr_reader :additional_model_information + + sig { params(additional_model_information: String).void } + attr_writer :additional_model_information + + sig { returns(T.nilable(Integer)) } + attr_reader :application_record_version + + sig { params(application_record_version: Integer).void } + attr_writer :application_record_version + + sig { returns(T.nilable(String)) } + attr_reader :artist + + sig { params(artist: String).void } + attr_writer :artist + + sig { returns(T.nilable(String)) } + attr_reader :artwork_circa_date_created + + sig { params(artwork_circa_date_created: String).void } + attr_writer :artwork_circa_date_created + + sig { returns(T.nilable(String)) } + attr_reader :artwork_content_description + + sig { params(artwork_content_description: String).void } + attr_writer :artwork_content_description + + sig { returns(T.nilable(String)) } + attr_reader :artwork_contribution_description + + sig { params(artwork_contribution_description: String).void } + attr_writer :artwork_contribution_description + + sig { returns(T.nilable(String)) } + attr_reader :artwork_copyright_notice + + sig { params(artwork_copyright_notice: String).void } + attr_writer :artwork_copyright_notice + + sig { returns(T.nilable(String)) } + attr_reader :artwork_copyright_owner_id + + sig { params(artwork_copyright_owner_id: String).void } + attr_writer :artwork_copyright_owner_id + + sig { returns(T.nilable(String)) } + attr_reader :artwork_copyright_owner_name + + sig { params(artwork_copyright_owner_name: String).void } + attr_writer :artwork_copyright_owner_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :artwork_creator + + sig { params(artwork_creator: T::Array[String]).void } + attr_writer :artwork_creator + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :artwork_creator_id + + sig { params(artwork_creator_id: T::Array[String]).void } + attr_writer :artwork_creator_id + + sig { returns(T.nilable(Time)) } + attr_reader :artwork_date_created + + sig { params(artwork_date_created: Time).void } + attr_writer :artwork_date_created + + sig { returns(T.nilable(String)) } + attr_reader :artwork_licensor_id + + sig { params(artwork_licensor_id: String).void } + attr_writer :artwork_licensor_id + + sig { returns(T.nilable(String)) } + attr_reader :artwork_licensor_name + + sig { params(artwork_licensor_name: String).void } + attr_writer :artwork_licensor_name + + sig { returns(T.nilable(String)) } + attr_reader :artwork_physical_description + + sig { params(artwork_physical_description: String).void } + attr_writer :artwork_physical_description + + sig { returns(T.nilable(String)) } + attr_reader :artwork_source + + sig { params(artwork_source: String).void } + attr_writer :artwork_source + + sig { returns(T.nilable(String)) } + attr_reader :artwork_source_inventory_no + + sig { params(artwork_source_inventory_no: String).void } + attr_writer :artwork_source_inventory_no + + sig { returns(T.nilable(String)) } + attr_reader :artwork_source_inv_url + + sig { params(artwork_source_inv_url: String).void } + attr_writer :artwork_source_inv_url + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :artwork_style_period + + sig { params(artwork_style_period: T::Array[String]).void } + attr_writer :artwork_style_period + + sig { returns(T.nilable(String)) } + attr_reader :artwork_title + + sig { params(artwork_title: String).void } + attr_writer :artwork_title + + sig { returns(T.nilable(String)) } + attr_reader :authors_position + + sig { params(authors_position: String).void } + attr_writer :authors_position + + sig { returns(T.nilable(String)) } + attr_reader :byline + + sig { params(byline: String).void } + attr_writer :byline + + sig { returns(T.nilable(String)) } + attr_reader :byline_title + + sig { params(byline_title: String).void } + attr_writer :byline_title + + sig { returns(T.nilable(String)) } + attr_reader :caption + + sig { params(caption: String).void } + attr_writer :caption + + sig { returns(T.nilable(String)) } + attr_reader :caption_abstract + + sig { params(caption_abstract: String).void } + attr_writer :caption_abstract + + sig { returns(T.nilable(String)) } + attr_reader :caption_writer + + sig { params(caption_writer: String).void } + attr_writer :caption_writer + + sig { returns(T.nilable(String)) } + attr_reader :city + + sig { params(city: String).void } + attr_writer :city + + sig { returns(T.nilable(String)) } + attr_reader :color_space + + sig { params(color_space: String).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :components_configuration + + sig { params(components_configuration: String).void } + attr_writer :components_configuration + + sig { returns(T.nilable(String)) } + attr_reader :copyright + + sig { params(copyright: String).void } + attr_writer :copyright + + sig { returns(T.nilable(String)) } + attr_reader :copyright_notice + + sig { params(copyright_notice: String).void } + attr_writer :copyright_notice + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :copyright_owner_id + + sig { params(copyright_owner_id: T::Array[String]).void } + attr_writer :copyright_owner_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :copyright_owner_name + + sig { params(copyright_owner_name: T::Array[String]).void } + attr_writer :copyright_owner_name + + sig { returns(T.nilable(String)) } + attr_reader :country + + sig { params(country: String).void } + attr_writer :country + + sig { returns(T.nilable(String)) } + attr_reader :country_code + + sig { params(country_code: String).void } + attr_writer :country_code + + sig { returns(T.nilable(String)) } + attr_reader :country_primary_location_code + + sig { params(country_primary_location_code: String).void } + attr_writer :country_primary_location_code + + sig { returns(T.nilable(String)) } + attr_reader :country_primary_location_name + + sig { params(country_primary_location_name: String).void } + attr_writer :country_primary_location_name + + sig { returns(T.nilable(String)) } + attr_reader :creator + + sig { params(creator: String).void } + attr_writer :creator + + sig { returns(T.nilable(String)) } + attr_reader :creator_address + + sig { params(creator_address: String).void } + attr_writer :creator_address + + sig { returns(T.nilable(String)) } + attr_reader :creator_city + + sig { params(creator_city: String).void } + attr_writer :creator_city + + sig { returns(T.nilable(String)) } + attr_reader :creator_country + + sig { params(creator_country: String).void } + attr_writer :creator_country + + sig { returns(T.nilable(String)) } + attr_reader :creator_postal_code + + sig { params(creator_postal_code: String).void } + attr_writer :creator_postal_code + + sig { returns(T.nilable(String)) } + attr_reader :creator_region + + sig { params(creator_region: String).void } + attr_writer :creator_region + + sig { returns(T.nilable(String)) } + attr_reader :creator_work_email + + sig { params(creator_work_email: String).void } + attr_writer :creator_work_email + + sig { returns(T.nilable(String)) } + attr_reader :creator_work_telephone + + sig { params(creator_work_telephone: String).void } + attr_writer :creator_work_telephone + + sig { returns(T.nilable(String)) } + attr_reader :creator_work_url + + sig { params(creator_work_url: String).void } + attr_writer :creator_work_url + + sig { returns(T.nilable(String)) } + attr_reader :credit + + sig { params(credit: String).void } + attr_writer :credit + + sig { returns(T.nilable(Time)) } + attr_reader :date_created + + sig { params(date_created: Time).void } + attr_writer :date_created + + sig { returns(T.nilable(Time)) } + attr_reader :date_time_created + + sig { params(date_time_created: Time).void } + attr_writer :date_time_created + + sig { returns(T.nilable(Time)) } + attr_reader :date_time_original + + sig { params(date_time_original: Time).void } + attr_writer :date_time_original + + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + sig { returns(T.nilable(String)) } + attr_reader :digital_image_guid + + sig { params(digital_image_guid: String).void } + attr_writer :digital_image_guid + + sig { returns(T.nilable(String)) } + attr_reader :digital_source_type + + sig { params(digital_source_type: String).void } + attr_writer :digital_source_type + + sig { returns(T.nilable(String)) } + attr_reader :embedded_encoded_rights_expr + + sig { params(embedded_encoded_rights_expr: String).void } + attr_writer :embedded_encoded_rights_expr + + sig { returns(T.nilable(String)) } + attr_reader :embedded_encoded_rights_expr_lang_id + + sig { params(embedded_encoded_rights_expr_lang_id: String).void } + attr_writer :embedded_encoded_rights_expr_lang_id + + sig { returns(T.nilable(String)) } + attr_reader :embedded_encoded_rights_expr_type + + sig { params(embedded_encoded_rights_expr_type: String).void } + attr_writer :embedded_encoded_rights_expr_type + + sig { returns(T.nilable(String)) } + attr_reader :event + + sig { params(event: String).void } + attr_writer :event + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(String)) } + attr_reader :genre_cv_id + + sig { params(genre_cv_id: String).void } + attr_writer :genre_cv_id + + sig { returns(T.nilable(String)) } + attr_reader :genre_cv_term_id + + sig { params(genre_cv_term_id: String).void } + attr_writer :genre_cv_term_id + + sig { returns(T.nilable(String)) } + attr_reader :genre_cv_term_name + + sig { params(genre_cv_term_name: String).void } + attr_writer :genre_cv_term_name + + sig { returns(T.nilable(String)) } + attr_reader :genre_cv_term_refined_about + + sig { params(genre_cv_term_refined_about: String).void } + attr_writer :genre_cv_term_refined_about + + sig { returns(T.nilable(String)) } + attr_reader :headline + + sig { params(headline: String).void } + attr_writer :headline + + sig { returns(T.nilable(String)) } + attr_reader :image_creator_id + + sig { params(image_creator_id: String).void } + attr_writer :image_creator_id + + sig { returns(T.nilable(String)) } + attr_reader :image_creator_image_id + + sig { params(image_creator_image_id: String).void } + attr_writer :image_creator_image_id + + sig { returns(T.nilable(String)) } + attr_reader :image_creator_name + + sig { params(image_creator_name: String).void } + attr_writer :image_creator_name + + sig { returns(T.nilable(String)) } + attr_reader :image_description + + sig { params(image_description: String).void } + attr_writer :image_description + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_h + + sig { params(image_region_boundary_h: T::Array[Float]).void } + attr_writer :image_region_boundary_h + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_rx + + sig { params(image_region_boundary_rx: T::Array[Float]).void } + attr_writer :image_region_boundary_rx + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_boundary_shape + + sig { params(image_region_boundary_shape: T::Array[String]).void } + attr_writer :image_region_boundary_shape + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_boundary_unit + + sig { params(image_region_boundary_unit: T::Array[String]).void } + attr_writer :image_region_boundary_unit + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_vertices_x + + sig { params(image_region_boundary_vertices_x: T::Array[Float]).void } + attr_writer :image_region_boundary_vertices_x + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_vertices_y + + sig { params(image_region_boundary_vertices_y: T::Array[Float]).void } + attr_writer :image_region_boundary_vertices_y + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_w + + sig { params(image_region_boundary_w: T::Array[Float]).void } + attr_writer :image_region_boundary_w + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_x + + sig { params(image_region_boundary_x: T::Array[Float]).void } + attr_writer :image_region_boundary_x + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_y + + sig { params(image_region_boundary_y: T::Array[Float]).void } + attr_writer :image_region_boundary_y + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_ctype_identifier + + sig { params(image_region_ctype_identifier: T::Array[String]).void } + attr_writer :image_region_ctype_identifier + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_ctype_name + + sig { params(image_region_ctype_name: T::Array[String]).void } + attr_writer :image_region_ctype_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_id + + sig { params(image_region_id: T::Array[String]).void } + attr_writer :image_region_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_name + + sig { params(image_region_name: T::Array[String]).void } + attr_writer :image_region_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_organisation_in_image_name + + sig do + params(image_region_organisation_in_image_name: T::Array[String]).void + end + attr_writer :image_region_organisation_in_image_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_person_in_image + + sig { params(image_region_person_in_image: T::Array[String]).void } + attr_writer :image_region_person_in_image + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_role_identifier + + sig { params(image_region_role_identifier: T::Array[String]).void } + attr_writer :image_region_role_identifier + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_role_name + + sig { params(image_region_role_name: T::Array[String]).void } + attr_writer :image_region_role_name + + sig { returns(T.nilable(String)) } + attr_reader :image_supplier_id + + sig { params(image_supplier_id: String).void } + attr_writer :image_supplier_id + + sig { returns(T.nilable(String)) } + attr_reader :image_supplier_image_id + + sig { params(image_supplier_image_id: String).void } + attr_writer :image_supplier_image_id + + sig { returns(T.nilable(String)) } + attr_reader :image_supplier_name + + sig { params(image_supplier_name: String).void } + attr_writer :image_supplier_name + + sig { returns(T.nilable(String)) } + attr_reader :instructions + + sig { params(instructions: String).void } + attr_writer :instructions + + sig { returns(T.nilable(String)) } + attr_reader :intellectual_genre + + sig { params(intellectual_genre: String).void } + attr_writer :intellectual_genre + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :keywords + + sig { params(keywords: T::Array[String]).void } + attr_writer :keywords + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_city + + sig { params(licensor_city: T::Array[String]).void } + attr_writer :licensor_city + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_country + + sig { params(licensor_country: T::Array[String]).void } + attr_writer :licensor_country + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_email + + sig { params(licensor_email: T::Array[String]).void } + attr_writer :licensor_email + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_extended_address + + sig { params(licensor_extended_address: T::Array[String]).void } + attr_writer :licensor_extended_address + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_id + + sig { params(licensor_id: T::Array[String]).void } + attr_writer :licensor_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_name + + sig { params(licensor_name: T::Array[String]).void } + attr_writer :licensor_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_postal_code + + sig { params(licensor_postal_code: T::Array[String]).void } + attr_writer :licensor_postal_code + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_region + + sig { params(licensor_region: T::Array[String]).void } + attr_writer :licensor_region + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_street_address + + sig { params(licensor_street_address: T::Array[String]).void } + attr_writer :licensor_street_address + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_telephone1 + + sig { params(licensor_telephone1: T::Array[String]).void } + attr_writer :licensor_telephone1 + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_telephone2 + + sig { params(licensor_telephone2: T::Array[String]).void } + attr_writer :licensor_telephone2 + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_url + + sig { params(licensor_url: T::Array[String]).void } + attr_writer :licensor_url + + sig { returns(T.nilable(String)) } + attr_reader :linked_encoded_rights_expr + + sig { params(linked_encoded_rights_expr: String).void } + attr_writer :linked_encoded_rights_expr + + sig { returns(T.nilable(String)) } + attr_reader :linked_encoded_rights_expr_lang_id + + sig { params(linked_encoded_rights_expr_lang_id: String).void } + attr_writer :linked_encoded_rights_expr_lang_id + + sig { returns(T.nilable(String)) } + attr_reader :linked_encoded_rights_expr_type + + sig { params(linked_encoded_rights_expr_type: String).void } + attr_writer :linked_encoded_rights_expr_type + + sig { returns(T.nilable(String)) } + attr_reader :location + + sig { params(location: String).void } + attr_writer :location + + sig { returns(T.nilable(String)) } + attr_reader :location_created_city + + sig { params(location_created_city: String).void } + attr_writer :location_created_city + + sig { returns(T.nilable(String)) } + attr_reader :location_created_country_code + + sig { params(location_created_country_code: String).void } + attr_writer :location_created_country_code + + sig { returns(T.nilable(String)) } + attr_reader :location_created_country_name + + sig { params(location_created_country_name: String).void } + attr_writer :location_created_country_name + + sig { returns(T.nilable(String)) } + attr_reader :location_created_gps_altitude + + sig { params(location_created_gps_altitude: String).void } + attr_writer :location_created_gps_altitude + + sig { returns(T.nilable(String)) } + attr_reader :location_created_gps_latitude + + sig { params(location_created_gps_latitude: String).void } + attr_writer :location_created_gps_latitude + + sig { returns(T.nilable(String)) } + attr_reader :location_created_gps_longitude + + sig { params(location_created_gps_longitude: String).void } + attr_writer :location_created_gps_longitude + + sig { returns(T.nilable(String)) } + attr_reader :location_created_location_id + + sig { params(location_created_location_id: String).void } + attr_writer :location_created_location_id + + sig { returns(T.nilable(String)) } + attr_reader :location_created_location_name + + sig { params(location_created_location_name: String).void } + attr_writer :location_created_location_name + + sig { returns(T.nilable(String)) } + attr_reader :location_created_province_state + + sig { params(location_created_province_state: String).void } + attr_writer :location_created_province_state + + sig { returns(T.nilable(String)) } + attr_reader :location_created_sublocation + + sig { params(location_created_sublocation: String).void } + attr_writer :location_created_sublocation + + sig { returns(T.nilable(String)) } + attr_reader :location_created_world_region + + sig { params(location_created_world_region: String).void } + attr_writer :location_created_world_region + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_city + + sig { params(location_shown_city: T::Array[String]).void } + attr_writer :location_shown_city + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_country_code + + sig { params(location_shown_country_code: T::Array[String]).void } + attr_writer :location_shown_country_code + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_country_name + + sig { params(location_shown_country_name: T::Array[String]).void } + attr_writer :location_shown_country_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_gps_altitude + + sig { params(location_shown_gps_altitude: T::Array[String]).void } + attr_writer :location_shown_gps_altitude + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_gps_latitude + + sig { params(location_shown_gps_latitude: T::Array[String]).void } + attr_writer :location_shown_gps_latitude + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_gps_longitude + + sig { params(location_shown_gps_longitude: T::Array[String]).void } + attr_writer :location_shown_gps_longitude + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_location_id + + sig { params(location_shown_location_id: T::Array[String]).void } + attr_writer :location_shown_location_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_location_name + + sig { params(location_shown_location_name: T::Array[String]).void } + attr_writer :location_shown_location_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_province_state + + sig { params(location_shown_province_state: T::Array[String]).void } + attr_writer :location_shown_province_state + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_sublocation + + sig { params(location_shown_sublocation: T::Array[String]).void } + attr_writer :location_shown_sublocation + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_world_region + + sig { params(location_shown_world_region: T::Array[String]).void } + attr_writer :location_shown_world_region + + sig { returns(T.nilable(Float)) } + attr_reader :max_avail_height + + sig { params(max_avail_height: Float).void } + attr_writer :max_avail_height + + sig { returns(T.nilable(Float)) } + attr_reader :max_avail_width + + sig { params(max_avail_width: Float).void } + attr_writer :max_avail_width + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :model_age + + sig { params(model_age: T::Array[Float]).void } + attr_writer :model_age + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :model_release_id + + sig { params(model_release_id: T::Array[String]).void } + attr_writer :model_release_id + + sig { returns(T.nilable(String)) } + attr_reader :object_attribute_reference + + sig { params(object_attribute_reference: String).void } + attr_writer :object_attribute_reference + + sig { returns(T.nilable(String)) } + attr_reader :object_name + + sig { params(object_name: String).void } + attr_writer :object_name + + sig { returns(T.nilable(String)) } + attr_reader :offset_time_original + + sig { params(offset_time_original: String).void } + attr_writer :offset_time_original + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :organisation_in_image_code + + sig { params(organisation_in_image_code: T::Array[String]).void } + attr_writer :organisation_in_image_code + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :organisation_in_image_name + + sig { params(organisation_in_image_name: T::Array[String]).void } + attr_writer :organisation_in_image_name + + sig { returns(T.nilable(String)) } + attr_reader :orientation + + sig { params(orientation: String).void } + attr_writer :orientation + + sig { returns(T.nilable(String)) } + attr_reader :original_transmission_reference + + sig { params(original_transmission_reference: String).void } + attr_writer :original_transmission_reference + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image + + sig { params(person_in_image: T::Array[String]).void } + attr_writer :person_in_image + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_cv_term_cv_id + + sig { params(person_in_image_cv_term_cv_id: T::Array[String]).void } + attr_writer :person_in_image_cv_term_cv_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_cv_term_id + + sig { params(person_in_image_cv_term_id: T::Array[String]).void } + attr_writer :person_in_image_cv_term_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_cv_term_name + + sig { params(person_in_image_cv_term_name: T::Array[String]).void } + attr_writer :person_in_image_cv_term_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_cv_term_refined_about + + sig do + params(person_in_image_cv_term_refined_about: T::Array[String]).void + end + attr_writer :person_in_image_cv_term_refined_about + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_description + + sig { params(person_in_image_description: T::Array[String]).void } + attr_writer :person_in_image_description + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_id + + sig { params(person_in_image_id: T::Array[String]).void } + attr_writer :person_in_image_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_name + + sig { params(person_in_image_name: T::Array[String]).void } + attr_writer :person_in_image_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :product_in_image_description + + sig { params(product_in_image_description: T::Array[String]).void } + attr_writer :product_in_image_description + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :product_in_image_gtin + + sig { params(product_in_image_gtin: T::Array[Float]).void } + attr_writer :product_in_image_gtin + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :product_in_image_name + + sig { params(product_in_image_name: T::Array[String]).void } + attr_writer :product_in_image_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :property_release_id + + sig { params(property_release_id: T::Array[String]).void } + attr_writer :property_release_id + + sig { returns(T.nilable(String)) } + attr_reader :province_state + + sig { params(province_state: String).void } + attr_writer :province_state + + sig { returns(T.nilable(Integer)) } + attr_reader :rating + + sig { params(rating: Integer).void } + attr_writer :rating + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :registry_entry_role + + sig { params(registry_entry_role: T::Array[String]).void } + attr_writer :registry_entry_role + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :registry_item_id + + sig { params(registry_item_id: T::Array[String]).void } + attr_writer :registry_item_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :registry_organisation_id + + sig { params(registry_organisation_id: T::Array[String]).void } + attr_writer :registry_organisation_id + + sig { returns(T.nilable(String)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: String).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :rights + + sig { params(rights: String).void } + attr_writer :rights + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :scene + + sig { params(scene: T::Array[String]).void } + attr_writer :scene + + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig { returns(T.nilable(String)) } + attr_reader :special_instructions + + sig { params(special_instructions: String).void } + attr_writer :special_instructions + + sig { returns(T.nilable(String)) } + attr_reader :state + + sig { params(state: String).void } + attr_writer :state + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :subject + + sig { params(subject: T::Array[String]).void } + attr_writer :subject + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :subject_code + + sig { params(subject_code: T::Array[String]).void } + attr_writer :subject_code + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :subject_reference + + sig { params(subject_reference: T::Array[String]).void } + attr_writer :subject_reference + + sig { returns(T.nilable(String)) } + attr_reader :sublocation + + sig { params(sublocation: String).void } + attr_writer :sublocation + + sig { returns(T.nilable(String)) } + attr_reader :time_created + + sig { params(time_created: String).void } + attr_writer :time_created + + sig { returns(T.nilable(String)) } + attr_reader :title + + sig { params(title: String).void } + attr_writer :title + + sig { returns(T.nilable(String)) } + attr_reader :transmission_reference + + sig { params(transmission_reference: String).void } + attr_writer :transmission_reference + + sig { returns(T.nilable(String)) } + attr_reader :usage_terms + + sig { params(usage_terms: String).void } + attr_writer :usage_terms + + sig { returns(T.nilable(String)) } + attr_reader :web_statement + + sig { params(web_statement: String).void } + attr_writer :web_statement + + sig { returns(T.nilable(String)) } + attr_reader :writer + + sig { params(writer: String).void } + attr_writer :writer + + sig { returns(T.nilable(String)) } + attr_reader :writer_editor + + sig { params(writer_editor: String).void } + attr_writer :writer_editor + + sig { returns(T.nilable(Float)) } + attr_reader :x_resolution + + sig { params(x_resolution: Float).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :y_resolution + + sig { params(y_resolution: Float).void } + attr_writer :y_resolution + + # 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. + sig do + params( + about_cv_term_cv_id: String, + about_cv_term_id: String, + about_cv_term_name: String, + about_cv_term_refined_about: String, + additional_model_information: String, + application_record_version: Integer, + artist: String, + artwork_circa_date_created: String, + artwork_content_description: String, + artwork_contribution_description: String, + artwork_copyright_notice: String, + artwork_copyright_owner_id: String, + artwork_copyright_owner_name: String, + artwork_creator: T::Array[String], + artwork_creator_id: T::Array[String], + artwork_date_created: Time, + artwork_licensor_id: String, + artwork_licensor_name: String, + artwork_physical_description: String, + artwork_source: String, + artwork_source_inventory_no: String, + artwork_source_inv_url: String, + artwork_style_period: T::Array[String], + artwork_title: String, + authors_position: String, + byline: String, + byline_title: String, + caption: String, + caption_abstract: String, + caption_writer: String, + city: String, + color_space: String, + components_configuration: String, + copyright: String, + copyright_notice: String, + copyright_owner_id: T::Array[String], + copyright_owner_name: T::Array[String], + country: String, + country_code: String, + country_primary_location_code: String, + country_primary_location_name: String, + creator: String, + creator_address: String, + creator_city: String, + creator_country: String, + creator_postal_code: String, + creator_region: String, + creator_work_email: String, + creator_work_telephone: String, + creator_work_url: String, + credit: String, + date_created: Time, + date_time_created: Time, + date_time_original: Time, + description: String, + digital_image_guid: String, + digital_source_type: String, + embedded_encoded_rights_expr: String, + embedded_encoded_rights_expr_lang_id: String, + embedded_encoded_rights_expr_type: String, + event: String, + exif_version: String, + flashpix_version: String, + genre_cv_id: String, + genre_cv_term_id: String, + genre_cv_term_name: String, + genre_cv_term_refined_about: String, + headline: String, + image_creator_id: String, + image_creator_image_id: String, + image_creator_name: String, + image_description: String, + image_region_boundary_h: T::Array[Float], + image_region_boundary_rx: T::Array[Float], + image_region_boundary_shape: T::Array[String], + image_region_boundary_unit: T::Array[String], + image_region_boundary_vertices_x: T::Array[Float], + image_region_boundary_vertices_y: T::Array[Float], + image_region_boundary_w: T::Array[Float], + image_region_boundary_x: T::Array[Float], + image_region_boundary_y: T::Array[Float], + image_region_ctype_identifier: T::Array[String], + image_region_ctype_name: T::Array[String], + image_region_id: T::Array[String], + image_region_name: T::Array[String], + image_region_organisation_in_image_name: T::Array[String], + image_region_person_in_image: T::Array[String], + image_region_role_identifier: T::Array[String], + image_region_role_name: T::Array[String], + image_supplier_id: String, + image_supplier_image_id: String, + image_supplier_name: String, + instructions: String, + intellectual_genre: String, + keywords: T::Array[String], + licensor_city: T::Array[String], + licensor_country: T::Array[String], + licensor_email: T::Array[String], + licensor_extended_address: T::Array[String], + licensor_id: T::Array[String], + licensor_name: T::Array[String], + licensor_postal_code: T::Array[String], + licensor_region: T::Array[String], + licensor_street_address: T::Array[String], + licensor_telephone1: T::Array[String], + licensor_telephone2: T::Array[String], + licensor_url: T::Array[String], + linked_encoded_rights_expr: String, + linked_encoded_rights_expr_lang_id: String, + linked_encoded_rights_expr_type: String, + location: String, + location_created_city: String, + location_created_country_code: String, + location_created_country_name: String, + location_created_gps_altitude: String, + location_created_gps_latitude: String, + location_created_gps_longitude: String, + location_created_location_id: String, + location_created_location_name: String, + location_created_province_state: String, + location_created_sublocation: String, + location_created_world_region: String, + location_shown_city: T::Array[String], + location_shown_country_code: T::Array[String], + location_shown_country_name: T::Array[String], + location_shown_gps_altitude: T::Array[String], + location_shown_gps_latitude: T::Array[String], + location_shown_gps_longitude: T::Array[String], + location_shown_location_id: T::Array[String], + location_shown_location_name: T::Array[String], + location_shown_province_state: T::Array[String], + location_shown_sublocation: T::Array[String], + location_shown_world_region: T::Array[String], + max_avail_height: Float, + max_avail_width: Float, + model_age: T::Array[Float], + model_release_id: T::Array[String], + object_attribute_reference: String, + object_name: String, + offset_time_original: String, + organisation_in_image_code: T::Array[String], + organisation_in_image_name: T::Array[String], + orientation: String, + original_transmission_reference: String, + person_in_image: T::Array[String], + person_in_image_cv_term_cv_id: T::Array[String], + person_in_image_cv_term_id: T::Array[String], + person_in_image_cv_term_name: T::Array[String], + person_in_image_cv_term_refined_about: T::Array[String], + person_in_image_description: T::Array[String], + person_in_image_id: T::Array[String], + person_in_image_name: T::Array[String], + product_in_image_description: T::Array[String], + product_in_image_gtin: T::Array[Float], + product_in_image_name: T::Array[String], + property_release_id: T::Array[String], + province_state: String, + rating: Integer, + registry_entry_role: T::Array[String], + registry_item_id: T::Array[String], + registry_organisation_id: T::Array[String], + resolution_unit: String, + rights: String, + scene: T::Array[String], + source: String, + special_instructions: String, + state: String, + subject: T::Array[String], + subject_code: T::Array[String], + subject_reference: T::Array[String], + sublocation: String, + time_created: String, + title: String, + transmission_reference: String, + usage_terms: String, + web_statement: String, + writer: String, + writer_editor: String, + x_resolution: Float, + y_resolution: Float + ).returns(T.attached_class) + end + def self.new( + about_cv_term_cv_id: nil, + about_cv_term_id: nil, + about_cv_term_name: nil, + about_cv_term_refined_about: nil, + additional_model_information: nil, + application_record_version: nil, + artist: nil, + artwork_circa_date_created: nil, + artwork_content_description: nil, + artwork_contribution_description: nil, + artwork_copyright_notice: nil, + artwork_copyright_owner_id: nil, + artwork_copyright_owner_name: nil, + artwork_creator: nil, + artwork_creator_id: nil, + artwork_date_created: nil, + artwork_licensor_id: nil, + artwork_licensor_name: nil, + artwork_physical_description: nil, + artwork_source: nil, + artwork_source_inventory_no: nil, + artwork_source_inv_url: nil, + artwork_style_period: nil, + artwork_title: nil, + authors_position: nil, + byline: nil, + byline_title: nil, + caption: nil, + caption_abstract: nil, + caption_writer: nil, + city: nil, + color_space: nil, + components_configuration: nil, + copyright: nil, + copyright_notice: nil, + copyright_owner_id: nil, + copyright_owner_name: nil, + country: nil, + country_code: nil, + country_primary_location_code: nil, + country_primary_location_name: nil, + creator: nil, + creator_address: nil, + creator_city: nil, + creator_country: nil, + creator_postal_code: nil, + creator_region: nil, + creator_work_email: nil, + creator_work_telephone: nil, + creator_work_url: nil, + credit: nil, + date_created: nil, + date_time_created: nil, + date_time_original: nil, + description: nil, + digital_image_guid: nil, + digital_source_type: nil, + embedded_encoded_rights_expr: nil, + embedded_encoded_rights_expr_lang_id: nil, + embedded_encoded_rights_expr_type: nil, + event: nil, + exif_version: nil, + flashpix_version: nil, + genre_cv_id: nil, + genre_cv_term_id: nil, + genre_cv_term_name: nil, + genre_cv_term_refined_about: nil, + headline: nil, + image_creator_id: nil, + image_creator_image_id: nil, + image_creator_name: nil, + image_description: nil, + image_region_boundary_h: nil, + image_region_boundary_rx: nil, + image_region_boundary_shape: nil, + image_region_boundary_unit: nil, + image_region_boundary_vertices_x: nil, + image_region_boundary_vertices_y: nil, + image_region_boundary_w: nil, + image_region_boundary_x: nil, + image_region_boundary_y: nil, + image_region_ctype_identifier: nil, + image_region_ctype_name: nil, + image_region_id: nil, + image_region_name: nil, + image_region_organisation_in_image_name: nil, + image_region_person_in_image: nil, + image_region_role_identifier: nil, + image_region_role_name: nil, + image_supplier_id: nil, + image_supplier_image_id: nil, + image_supplier_name: nil, + instructions: nil, + intellectual_genre: nil, + keywords: nil, + licensor_city: nil, + licensor_country: nil, + licensor_email: nil, + licensor_extended_address: nil, + licensor_id: nil, + licensor_name: nil, + licensor_postal_code: nil, + licensor_region: nil, + licensor_street_address: nil, + licensor_telephone1: nil, + licensor_telephone2: nil, + licensor_url: nil, + linked_encoded_rights_expr: nil, + linked_encoded_rights_expr_lang_id: nil, + linked_encoded_rights_expr_type: nil, + location: nil, + location_created_city: nil, + location_created_country_code: nil, + location_created_country_name: nil, + location_created_gps_altitude: nil, + location_created_gps_latitude: nil, + location_created_gps_longitude: nil, + location_created_location_id: nil, + location_created_location_name: nil, + location_created_province_state: nil, + location_created_sublocation: nil, + location_created_world_region: nil, + location_shown_city: nil, + location_shown_country_code: nil, + location_shown_country_name: nil, + location_shown_gps_altitude: nil, + location_shown_gps_latitude: nil, + location_shown_gps_longitude: nil, + location_shown_location_id: nil, + location_shown_location_name: nil, + location_shown_province_state: nil, + location_shown_sublocation: nil, + location_shown_world_region: nil, + max_avail_height: nil, + max_avail_width: nil, + model_age: nil, + model_release_id: nil, + object_attribute_reference: nil, + object_name: nil, + offset_time_original: nil, + organisation_in_image_code: nil, + organisation_in_image_name: nil, + orientation: nil, + original_transmission_reference: nil, + person_in_image: nil, + person_in_image_cv_term_cv_id: nil, + person_in_image_cv_term_id: nil, + person_in_image_cv_term_name: nil, + person_in_image_cv_term_refined_about: nil, + person_in_image_description: nil, + person_in_image_id: nil, + person_in_image_name: nil, + product_in_image_description: nil, + product_in_image_gtin: nil, + product_in_image_name: nil, + property_release_id: nil, + province_state: nil, + rating: nil, + registry_entry_role: nil, + registry_item_id: nil, + registry_organisation_id: nil, + resolution_unit: nil, + rights: nil, + scene: nil, + source: nil, + special_instructions: nil, + state: nil, + subject: nil, + subject_code: nil, + subject_reference: nil, + sublocation: nil, + time_created: nil, + title: nil, + transmission_reference: nil, + usage_terms: nil, + web_statement: nil, + writer: nil, + writer_editor: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + about_cv_term_cv_id: String, + about_cv_term_id: String, + about_cv_term_name: String, + about_cv_term_refined_about: String, + additional_model_information: String, + application_record_version: Integer, + artist: String, + artwork_circa_date_created: String, + artwork_content_description: String, + artwork_contribution_description: String, + artwork_copyright_notice: String, + artwork_copyright_owner_id: String, + artwork_copyright_owner_name: String, + artwork_creator: T::Array[String], + artwork_creator_id: T::Array[String], + artwork_date_created: Time, + artwork_licensor_id: String, + artwork_licensor_name: String, + artwork_physical_description: String, + artwork_source: String, + artwork_source_inventory_no: String, + artwork_source_inv_url: String, + artwork_style_period: T::Array[String], + artwork_title: String, + authors_position: String, + byline: String, + byline_title: String, + caption: String, + caption_abstract: String, + caption_writer: String, + city: String, + color_space: String, + components_configuration: String, + copyright: String, + copyright_notice: String, + copyright_owner_id: T::Array[String], + copyright_owner_name: T::Array[String], + country: String, + country_code: String, + country_primary_location_code: String, + country_primary_location_name: String, + creator: String, + creator_address: String, + creator_city: String, + creator_country: String, + creator_postal_code: String, + creator_region: String, + creator_work_email: String, + creator_work_telephone: String, + creator_work_url: String, + credit: String, + date_created: Time, + date_time_created: Time, + date_time_original: Time, + description: String, + digital_image_guid: String, + digital_source_type: String, + embedded_encoded_rights_expr: String, + embedded_encoded_rights_expr_lang_id: String, + embedded_encoded_rights_expr_type: String, + event: String, + exif_version: String, + flashpix_version: String, + genre_cv_id: String, + genre_cv_term_id: String, + genre_cv_term_name: String, + genre_cv_term_refined_about: String, + headline: String, + image_creator_id: String, + image_creator_image_id: String, + image_creator_name: String, + image_description: String, + image_region_boundary_h: T::Array[Float], + image_region_boundary_rx: T::Array[Float], + image_region_boundary_shape: T::Array[String], + image_region_boundary_unit: T::Array[String], + image_region_boundary_vertices_x: T::Array[Float], + image_region_boundary_vertices_y: T::Array[Float], + image_region_boundary_w: T::Array[Float], + image_region_boundary_x: T::Array[Float], + image_region_boundary_y: T::Array[Float], + image_region_ctype_identifier: T::Array[String], + image_region_ctype_name: T::Array[String], + image_region_id: T::Array[String], + image_region_name: T::Array[String], + image_region_organisation_in_image_name: T::Array[String], + image_region_person_in_image: T::Array[String], + image_region_role_identifier: T::Array[String], + image_region_role_name: T::Array[String], + image_supplier_id: String, + image_supplier_image_id: String, + image_supplier_name: String, + instructions: String, + intellectual_genre: String, + keywords: T::Array[String], + licensor_city: T::Array[String], + licensor_country: T::Array[String], + licensor_email: T::Array[String], + licensor_extended_address: T::Array[String], + licensor_id: T::Array[String], + licensor_name: T::Array[String], + licensor_postal_code: T::Array[String], + licensor_region: T::Array[String], + licensor_street_address: T::Array[String], + licensor_telephone1: T::Array[String], + licensor_telephone2: T::Array[String], + licensor_url: T::Array[String], + linked_encoded_rights_expr: String, + linked_encoded_rights_expr_lang_id: String, + linked_encoded_rights_expr_type: String, + location: String, + location_created_city: String, + location_created_country_code: String, + location_created_country_name: String, + location_created_gps_altitude: String, + location_created_gps_latitude: String, + location_created_gps_longitude: String, + location_created_location_id: String, + location_created_location_name: String, + location_created_province_state: String, + location_created_sublocation: String, + location_created_world_region: String, + location_shown_city: T::Array[String], + location_shown_country_code: T::Array[String], + location_shown_country_name: T::Array[String], + location_shown_gps_altitude: T::Array[String], + location_shown_gps_latitude: T::Array[String], + location_shown_gps_longitude: T::Array[String], + location_shown_location_id: T::Array[String], + location_shown_location_name: T::Array[String], + location_shown_province_state: T::Array[String], + location_shown_sublocation: T::Array[String], + location_shown_world_region: T::Array[String], + max_avail_height: Float, + max_avail_width: Float, + model_age: T::Array[Float], + model_release_id: T::Array[String], + object_attribute_reference: String, + object_name: String, + offset_time_original: String, + organisation_in_image_code: T::Array[String], + organisation_in_image_name: T::Array[String], + orientation: String, + original_transmission_reference: String, + person_in_image: T::Array[String], + person_in_image_cv_term_cv_id: T::Array[String], + person_in_image_cv_term_id: T::Array[String], + person_in_image_cv_term_name: T::Array[String], + person_in_image_cv_term_refined_about: T::Array[String], + person_in_image_description: T::Array[String], + person_in_image_id: T::Array[String], + person_in_image_name: T::Array[String], + product_in_image_description: T::Array[String], + product_in_image_gtin: T::Array[Float], + product_in_image_name: T::Array[String], + property_release_id: T::Array[String], + province_state: String, + rating: Integer, + registry_entry_role: T::Array[String], + registry_item_id: T::Array[String], + registry_organisation_id: T::Array[String], + resolution_unit: String, + rights: String, + scene: T::Array[String], + source: String, + special_instructions: String, + state: String, + subject: T::Array[String], + subject_code: T::Array[String], + subject_reference: T::Array[String], + sublocation: String, + time_created: String, + title: String, + transmission_reference: String, + usage_terms: String, + web_statement: String, + writer: String, + writer_editor: String, + x_resolution: Float, + y_resolution: Float + } + ) + end + def to_hash + end + end + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV1Response::ExtensionStatus, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :aws_auto_tagging + + sig do + params( + aws_auto_tagging: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::OrSymbol + ).void + end + attr_writer :aws_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :google_auto_tagging + + sig do + params( + google_auto_tagging: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::OrSymbol + ).void + end + attr_writer :google_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol + ) + ) + end + attr_reader :remove_bg + + sig do + params( + remove_bg: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::OrSymbol + ).void + end + attr_writer :remove_bg + + # 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. + sig do + params( + aws_auto_tagging: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::OrSymbol, + google_auto_tagging: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::OrSymbol, + remove_bg: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::OrSymbol + ).returns(T.attached_class) + end + def self.new( + aws_auto_tagging: nil, + google_auto_tagging: nil, + remove_bg: nil + ) + end + + sig do + override.returns( + { + aws_auto_tagging: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + google_auto_tagging: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + remove_bg: + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol + } + ) + end + def to_hash + end + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class Metadata < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV1Response::Metadata, + Imagekit::Internal::AnyHash + ) + end + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig do + returns( + T.nilable(Imagekit::Models::FileUploadV1Response::Metadata::Exif) + ) + end + attr_reader :exif + + sig do + params( + exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif::OrHash + ).void + end + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: + Imagekit::Models::FileUploadV1Response::Metadata::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV1Response::Metadata::Exif, + Imagekit::Internal::AnyHash + ) + end + + # Object containing Exif details. + sig { returns(T.nilable(Imagekit::ExifDetails)) } + attr_reader :exif + + sig { params(exif: Imagekit::ExifDetails::OrHash).void } + attr_writer :exif + + # Object containing GPS information. + sig { returns(T.nilable(Imagekit::Gps)) } + attr_reader :gps + + sig { params(gps: Imagekit::Gps::OrHash).void } + attr_writer :gps + + # Object containing EXIF image information. + sig { returns(T.nilable(Imagekit::ExifImage)) } + attr_reader :image + + sig { params(image: Imagekit::ExifImage::OrHash).void } + attr_writer :image + + # JSON object. + sig { returns(T.nilable(Imagekit::Interoperability)) } + attr_reader :interoperability + + sig do + params(interoperability: Imagekit::Interoperability::OrHash).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig { returns(T.nilable(Imagekit::Thumbnail)) } + attr_reader :thumbnail + + sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } + attr_writer :thumbnail + + sig do + params( + exif: Imagekit::ExifDetails::OrHash, + gps: Imagekit::Gps::OrHash, + image: Imagekit::ExifImage::OrHash, + interoperability: Imagekit::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Thumbnail + } + ) + end + def to_hash + end + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV1Response::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object containing the file or file version's `id` (versionId) and `name`. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/file_upload_v2_params.rbi b/rbi/imagekit/models/file_upload_v2_params.rbi new file mode 100644 index 00000000..06434232 --- /dev/null +++ b/rbi/imagekit/models/file_upload_v2_params.rbi @@ -0,0 +1,659 @@ +# typed: strong + +module Imagekit + module Models + class FileUploadV2Params < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileUploadV2Params, Imagekit::Internal::AnyHash) + end + + # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, + # please ensure that our servers can access the URL. In case ImageKit is unable to + # download the file from the specified URL, a `400` error response is returned. + # This will also result in a `400` error if the file download request is aborted + # if response headers are not received in 8 seconds. + sig { returns(String) } + attr_accessor :file + + # The name with which the file has to be uploaded. + sig { returns(String) } + attr_accessor :file_name + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :token + + sig { params(token: String).void } + attr_writer :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). + sig { returns(T.nilable(String)) } + attr_reader :checks + + sig { params(checks: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :custom_coordinates + + sig { params(custom_coordinates: String).void } + attr_writer :custom_coordinates + + # Stringified JSON key-value data to be associated with the asset. + sig { returns(T.nilable(String)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: String).void } + attr_writer :custom_metadata + + # Stringified JSON object with an array of extensions to be applied to the image. + # Refer to extensions schema in + # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + sig { returns(T.nilable(String)) } + attr_reader :extensions + + sig { params(extensions: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :folder + + sig { params(folder: String).void } + attr_writer :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. + sig do + returns( + T.nilable(Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol) + ) + end + attr_reader :is_private_file + + sig do + params( + is_private_file: Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol + ).void + end + attr_writer :is_private_file + + # 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. + sig do + returns(T.nilable(Imagekit::FileUploadV2Params::IsPublished::OrSymbol)) + end + attr_reader :is_published + + sig do + params( + is_published: Imagekit::FileUploadV2Params::IsPublished::OrSymbol + ).void + end + attr_writer :is_published + + # 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. + sig do + returns( + T.nilable(Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol) + ) + end + attr_reader :overwrite_ai_tags + + sig do + params( + overwrite_ai_tags: + Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol + ).void + end + attr_writer :overwrite_ai_tags + + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + sig do + returns( + T.nilable( + Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol + ) + ) + end + attr_reader :overwrite_custom_metadata + + sig do + params( + overwrite_custom_metadata: + Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol + ).void + end + attr_writer :overwrite_custom_metadata + + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + sig { returns(T.nilable(String)) } + attr_reader :overwrite_file + + sig { params(overwrite_file: String).void } + attr_writer :overwrite_file + + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + sig do + returns( + T.nilable(Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol) + ) + end + attr_reader :overwrite_tags + + sig do + params( + overwrite_tags: Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol + ).void + end + attr_writer :overwrite_tags + + # Comma-separated values of the fields that you want the API to return in the + # response. + # + # For example, set the value of this field to + # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, + # `customCoordinates`, and `isPrivateFile` in the response. + # + # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, + # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + sig { returns(T.nilable(String)) } + attr_reader :response_fields + + sig { params(response_fields: String).void } + attr_writer :response_fields + + # Set the tags while uploading the file. + # + # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length + # of all characters should not exceed 500. `%` is not allowed. + # + # If this field is not specified and the file is overwritten then the tags will be + # removed. + sig { returns(T.nilable(String)) } + attr_reader :tags + + sig { params(tags: String).void } + attr_writer :tags + + # Stringified JSON object with properties for pre and post transformations: + # + # `pre` - Accepts a "string" containing a valid transformation used for requesting + # a pre-transformation for an image or a video file. + # + # `post` - Accepts an array of objects with properties: + # + # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` + # (Adaptive bitrate streaming). + # - `value`: A "string" corresponding to the required transformation. Required if + # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or + # `thumbnail`. + # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # + # Read more about + # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + sig { returns(T.nilable(String)) } + attr_reader :transformation + + sig { params(transformation: String).void } + attr_writer :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. + sig do + returns( + T.nilable(Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol) + ) + end + attr_reader :use_unique_file_name + + sig do + params( + use_unique_file_name: + Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol + ).void + end + attr_writer :use_unique_file_name + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + sig do + params( + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + extensions: String, + folder: String, + is_private_file: + Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol, + is_published: Imagekit::FileUploadV2Params::IsPublished::OrSymbol, + overwrite_ai_tags: + Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol, + overwrite_custom_metadata: + Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol, + overwrite_file: String, + overwrite_tags: Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol, + response_fields: String, + tags: String, + transformation: String, + use_unique_file_name: + Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol, + webhook_url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, + # please ensure that our servers can access the URL. In case ImageKit is unable to + # download the file from the specified URL, a `400` error response is returned. + # This will also result in a `400` error if the file download request is aborted + # if response headers are not received in 8 seconds. + file:, + # The name with which the file has to be uploaded. + file_name:, + # 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. + token: nil, + # 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). + checks: nil, + # 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. + custom_coordinates: nil, + # Stringified JSON key-value data to be associated with the asset. + custom_metadata: nil, + # Stringified JSON object with an array of extensions to be applied to the image. + # Refer to extensions schema in + # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + extensions: nil, + # 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. + folder: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # 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. + overwrite_ai_tags: nil, + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + overwrite_custom_metadata: nil, + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + overwrite_file: nil, + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + overwrite_tags: nil, + # Comma-separated values of the fields that you want the API to return in the + # response. + # + # For example, set the value of this field to + # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, + # `customCoordinates`, and `isPrivateFile` in the response. + # + # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, + # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + response_fields: nil, + # Set the tags while uploading the file. + # + # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length + # of all characters should not exceed 500. `%` is not allowed. + # + # If this field is not specified and the file is overwritten then the tags will be + # removed. + tags: nil, + # Stringified JSON object with properties for pre and post transformations: + # + # `pre` - Accepts a "string" containing a valid transformation used for requesting + # a pre-transformation for an image or a video file. + # + # `post` - Accepts an array of objects with properties: + # + # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` + # (Adaptive bitrate streaming). + # - `value`: A "string" corresponding to the required transformation. Required if + # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or + # `thumbnail`. + # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # + # Read more about + # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + transformation: nil, + # 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. + use_unique_file_name: nil, + # 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. + webhook_url: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + extensions: String, + folder: String, + is_private_file: + Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol, + is_published: Imagekit::FileUploadV2Params::IsPublished::OrSymbol, + overwrite_ai_tags: + Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol, + overwrite_custom_metadata: + Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol, + overwrite_file: String, + overwrite_tags: + Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol, + response_fields: String, + tags: String, + transformation: String, + use_unique_file_name: + Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol, + webhook_url: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + # 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. + module IsPrivateFile + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV2Params::IsPrivateFile) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV2Params::IsPrivateFile::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV2Params::IsPrivateFile::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::FileUploadV2Params::IsPrivateFile::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module IsPublished + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV2Params::IsPublished) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let(:true, Imagekit::FileUploadV2Params::IsPublished::TaggedSymbol) + FALSE = + T.let(:false, Imagekit::FileUploadV2Params::IsPublished::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::FileUploadV2Params::IsPublished::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module OverwriteAITags + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV2Params::OverwriteAITags) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV2Params::OverwriteAITags::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV2Params::OverwriteAITags::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadV2Params::OverwriteAITags::TaggedSymbol + ] + ) + end + def self.values + end + end + + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + module OverwriteCustomMetadata + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV2Params::OverwriteCustomMetadata) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV2Params::OverwriteCustomMetadata::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV2Params::OverwriteCustomMetadata::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadV2Params::OverwriteCustomMetadata::TaggedSymbol + ] + ) + end + def self.values + end + end + + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + module OverwriteTags + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV2Params::OverwriteTags) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV2Params::OverwriteTags::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV2Params::OverwriteTags::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::FileUploadV2Params::OverwriteTags::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module UseUniqueFileName + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadV2Params::UseUniqueFileName) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRUE = + T.let( + :true, + Imagekit::FileUploadV2Params::UseUniqueFileName::TaggedSymbol + ) + FALSE = + T.let( + :false, + Imagekit::FileUploadV2Params::UseUniqueFileName::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadV2Params::UseUniqueFileName::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/file_upload_v2_response.rbi b/rbi/imagekit/models/file_upload_v2_response.rbi new file mode 100644 index 00000000..8611f584 --- /dev/null +++ b/rbi/imagekit/models/file_upload_v2_response.rbi @@ -0,0 +1,2625 @@ +# typed: strong + +module Imagekit + module Models + class FileUploadV2Response < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV2Response, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the uploaded file by auto tagging. + sig do + returns( + T.nilable(T::Array[Imagekit::Models::FileUploadV2Response::AITag]) + ) + end + attr_accessor :ai_tags + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :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. + sig do + returns( + T.nilable(Imagekit::Models::FileUploadV2Response::EmbeddedMetadata) + ) + end + attr_reader :embedded_metadata + + sig do + params( + embedded_metadata: + Imagekit::Models::FileUploadV2Response::EmbeddedMetadata::OrHash + ).void + end + attr_writer :embedded_metadata + + # 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. + sig do + returns( + T.nilable(Imagekit::Models::FileUploadV2Response::ExtensionStatus) + ) + end + attr_reader :extension_status + + sig do + params( + extension_status: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::OrHash + ).void + end + attr_writer :extension_status + + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the uploaded file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Height of the image in pixels (Only for images) + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig do + returns(T.nilable(Imagekit::Models::FileUploadV2Response::Metadata)) + end + attr_reader :metadata + + sig do + params( + metadata: Imagekit::Models::FileUploadV2Response::Metadata::OrHash + ).void + end + attr_writer :metadata + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the image file in Bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # In the case of an image, a small thumbnail URL. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail_url + + sig { params(thumbnail_url: String).void } + attr_writer :thumbnail_url + + # A publicly accessible URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object containing the file or file version's `id` (versionId) and `name`. + sig do + returns(T.nilable(Imagekit::Models::FileUploadV2Response::VersionInfo)) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::FileUploadV2Response::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # Width of the image in pixels (Only for Images) + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a successful upload. + sig do + params( + ai_tags: + T.nilable( + T::Array[Imagekit::Models::FileUploadV2Response::AITag::OrHash] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + duration: Integer, + embedded_metadata: + Imagekit::Models::FileUploadV2Response::EmbeddedMetadata::OrHash, + extension_status: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::OrHash, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: Imagekit::Models::FileUploadV2Response::Metadata::OrHash, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: + Imagekit::Models::FileUploadV2Response::VersionInfo::OrHash, + video_codec: String, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the uploaded file by auto tagging. + ai_tags: nil, + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # The duration of the video in seconds (only for video). + duration: nil, + # 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. + embedded_metadata: nil, + # 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. + extension_status: nil, + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + file_id: nil, + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + file_path: nil, + # Type of the uploaded file. Possible values are `image`, `non-image`. + file_type: nil, + # Height of the image in pixels (Only for images) + height: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + metadata: nil, + # Name of the asset. + name: nil, + # Size of the image file in Bytes. + size: nil, + # 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. + tags: nil, + # In the case of an image, a small thumbnail URL. + thumbnail_url: nil, + # A publicly accessible URL of the file. + url: nil, + # An object containing the file or file version's `id` (versionId) and `name`. + version_info: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # Width of the image in pixels (Only for Images) + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[Imagekit::Models::FileUploadV2Response::AITag] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + duration: Integer, + embedded_metadata: + Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, + extension_status: + Imagekit::Models::FileUploadV2Response::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: Imagekit::Models::FileUploadV2Response::Metadata, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadV2Response::VersionInfo, + video_codec: String, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV2Response::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # 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. + source: nil + ) + end + + sig do + override.returns({ confidence: Float, name: String, source: String }) + end + def to_hash + end + end + + class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :about_cv_term_cv_id + + sig { params(about_cv_term_cv_id: String).void } + attr_writer :about_cv_term_cv_id + + sig { returns(T.nilable(String)) } + attr_reader :about_cv_term_id + + sig { params(about_cv_term_id: String).void } + attr_writer :about_cv_term_id + + sig { returns(T.nilable(String)) } + attr_reader :about_cv_term_name + + sig { params(about_cv_term_name: String).void } + attr_writer :about_cv_term_name + + sig { returns(T.nilable(String)) } + attr_reader :about_cv_term_refined_about + + sig { params(about_cv_term_refined_about: String).void } + attr_writer :about_cv_term_refined_about + + sig { returns(T.nilable(String)) } + attr_reader :additional_model_information + + sig { params(additional_model_information: String).void } + attr_writer :additional_model_information + + sig { returns(T.nilable(Integer)) } + attr_reader :application_record_version + + sig { params(application_record_version: Integer).void } + attr_writer :application_record_version + + sig { returns(T.nilable(String)) } + attr_reader :artist + + sig { params(artist: String).void } + attr_writer :artist + + sig { returns(T.nilable(String)) } + attr_reader :artwork_circa_date_created + + sig { params(artwork_circa_date_created: String).void } + attr_writer :artwork_circa_date_created + + sig { returns(T.nilable(String)) } + attr_reader :artwork_content_description + + sig { params(artwork_content_description: String).void } + attr_writer :artwork_content_description + + sig { returns(T.nilable(String)) } + attr_reader :artwork_contribution_description + + sig { params(artwork_contribution_description: String).void } + attr_writer :artwork_contribution_description + + sig { returns(T.nilable(String)) } + attr_reader :artwork_copyright_notice + + sig { params(artwork_copyright_notice: String).void } + attr_writer :artwork_copyright_notice + + sig { returns(T.nilable(String)) } + attr_reader :artwork_copyright_owner_id + + sig { params(artwork_copyright_owner_id: String).void } + attr_writer :artwork_copyright_owner_id + + sig { returns(T.nilable(String)) } + attr_reader :artwork_copyright_owner_name + + sig { params(artwork_copyright_owner_name: String).void } + attr_writer :artwork_copyright_owner_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :artwork_creator + + sig { params(artwork_creator: T::Array[String]).void } + attr_writer :artwork_creator + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :artwork_creator_id + + sig { params(artwork_creator_id: T::Array[String]).void } + attr_writer :artwork_creator_id + + sig { returns(T.nilable(Time)) } + attr_reader :artwork_date_created + + sig { params(artwork_date_created: Time).void } + attr_writer :artwork_date_created + + sig { returns(T.nilable(String)) } + attr_reader :artwork_licensor_id + + sig { params(artwork_licensor_id: String).void } + attr_writer :artwork_licensor_id + + sig { returns(T.nilable(String)) } + attr_reader :artwork_licensor_name + + sig { params(artwork_licensor_name: String).void } + attr_writer :artwork_licensor_name + + sig { returns(T.nilable(String)) } + attr_reader :artwork_physical_description + + sig { params(artwork_physical_description: String).void } + attr_writer :artwork_physical_description + + sig { returns(T.nilable(String)) } + attr_reader :artwork_source + + sig { params(artwork_source: String).void } + attr_writer :artwork_source + + sig { returns(T.nilable(String)) } + attr_reader :artwork_source_inventory_no + + sig { params(artwork_source_inventory_no: String).void } + attr_writer :artwork_source_inventory_no + + sig { returns(T.nilable(String)) } + attr_reader :artwork_source_inv_url + + sig { params(artwork_source_inv_url: String).void } + attr_writer :artwork_source_inv_url + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :artwork_style_period + + sig { params(artwork_style_period: T::Array[String]).void } + attr_writer :artwork_style_period + + sig { returns(T.nilable(String)) } + attr_reader :artwork_title + + sig { params(artwork_title: String).void } + attr_writer :artwork_title + + sig { returns(T.nilable(String)) } + attr_reader :authors_position + + sig { params(authors_position: String).void } + attr_writer :authors_position + + sig { returns(T.nilable(String)) } + attr_reader :byline + + sig { params(byline: String).void } + attr_writer :byline + + sig { returns(T.nilable(String)) } + attr_reader :byline_title + + sig { params(byline_title: String).void } + attr_writer :byline_title + + sig { returns(T.nilable(String)) } + attr_reader :caption + + sig { params(caption: String).void } + attr_writer :caption + + sig { returns(T.nilable(String)) } + attr_reader :caption_abstract + + sig { params(caption_abstract: String).void } + attr_writer :caption_abstract + + sig { returns(T.nilable(String)) } + attr_reader :caption_writer + + sig { params(caption_writer: String).void } + attr_writer :caption_writer + + sig { returns(T.nilable(String)) } + attr_reader :city + + sig { params(city: String).void } + attr_writer :city + + sig { returns(T.nilable(String)) } + attr_reader :color_space + + sig { params(color_space: String).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :components_configuration + + sig { params(components_configuration: String).void } + attr_writer :components_configuration + + sig { returns(T.nilable(String)) } + attr_reader :copyright + + sig { params(copyright: String).void } + attr_writer :copyright + + sig { returns(T.nilable(String)) } + attr_reader :copyright_notice + + sig { params(copyright_notice: String).void } + attr_writer :copyright_notice + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :copyright_owner_id + + sig { params(copyright_owner_id: T::Array[String]).void } + attr_writer :copyright_owner_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :copyright_owner_name + + sig { params(copyright_owner_name: T::Array[String]).void } + attr_writer :copyright_owner_name + + sig { returns(T.nilable(String)) } + attr_reader :country + + sig { params(country: String).void } + attr_writer :country + + sig { returns(T.nilable(String)) } + attr_reader :country_code + + sig { params(country_code: String).void } + attr_writer :country_code + + sig { returns(T.nilable(String)) } + attr_reader :country_primary_location_code + + sig { params(country_primary_location_code: String).void } + attr_writer :country_primary_location_code + + sig { returns(T.nilable(String)) } + attr_reader :country_primary_location_name + + sig { params(country_primary_location_name: String).void } + attr_writer :country_primary_location_name + + sig { returns(T.nilable(String)) } + attr_reader :creator + + sig { params(creator: String).void } + attr_writer :creator + + sig { returns(T.nilable(String)) } + attr_reader :creator_address + + sig { params(creator_address: String).void } + attr_writer :creator_address + + sig { returns(T.nilable(String)) } + attr_reader :creator_city + + sig { params(creator_city: String).void } + attr_writer :creator_city + + sig { returns(T.nilable(String)) } + attr_reader :creator_country + + sig { params(creator_country: String).void } + attr_writer :creator_country + + sig { returns(T.nilable(String)) } + attr_reader :creator_postal_code + + sig { params(creator_postal_code: String).void } + attr_writer :creator_postal_code + + sig { returns(T.nilable(String)) } + attr_reader :creator_region + + sig { params(creator_region: String).void } + attr_writer :creator_region + + sig { returns(T.nilable(String)) } + attr_reader :creator_work_email + + sig { params(creator_work_email: String).void } + attr_writer :creator_work_email + + sig { returns(T.nilable(String)) } + attr_reader :creator_work_telephone + + sig { params(creator_work_telephone: String).void } + attr_writer :creator_work_telephone + + sig { returns(T.nilable(String)) } + attr_reader :creator_work_url + + sig { params(creator_work_url: String).void } + attr_writer :creator_work_url + + sig { returns(T.nilable(String)) } + attr_reader :credit + + sig { params(credit: String).void } + attr_writer :credit + + sig { returns(T.nilable(Time)) } + attr_reader :date_created + + sig { params(date_created: Time).void } + attr_writer :date_created + + sig { returns(T.nilable(Time)) } + attr_reader :date_time_created + + sig { params(date_time_created: Time).void } + attr_writer :date_time_created + + sig { returns(T.nilable(Time)) } + attr_reader :date_time_original + + sig { params(date_time_original: Time).void } + attr_writer :date_time_original + + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + sig { returns(T.nilable(String)) } + attr_reader :digital_image_guid + + sig { params(digital_image_guid: String).void } + attr_writer :digital_image_guid + + sig { returns(T.nilable(String)) } + attr_reader :digital_source_type + + sig { params(digital_source_type: String).void } + attr_writer :digital_source_type + + sig { returns(T.nilable(String)) } + attr_reader :embedded_encoded_rights_expr + + sig { params(embedded_encoded_rights_expr: String).void } + attr_writer :embedded_encoded_rights_expr + + sig { returns(T.nilable(String)) } + attr_reader :embedded_encoded_rights_expr_lang_id + + sig { params(embedded_encoded_rights_expr_lang_id: String).void } + attr_writer :embedded_encoded_rights_expr_lang_id + + sig { returns(T.nilable(String)) } + attr_reader :embedded_encoded_rights_expr_type + + sig { params(embedded_encoded_rights_expr_type: String).void } + attr_writer :embedded_encoded_rights_expr_type + + sig { returns(T.nilable(String)) } + attr_reader :event + + sig { params(event: String).void } + attr_writer :event + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(String)) } + attr_reader :genre_cv_id + + sig { params(genre_cv_id: String).void } + attr_writer :genre_cv_id + + sig { returns(T.nilable(String)) } + attr_reader :genre_cv_term_id + + sig { params(genre_cv_term_id: String).void } + attr_writer :genre_cv_term_id + + sig { returns(T.nilable(String)) } + attr_reader :genre_cv_term_name + + sig { params(genre_cv_term_name: String).void } + attr_writer :genre_cv_term_name + + sig { returns(T.nilable(String)) } + attr_reader :genre_cv_term_refined_about + + sig { params(genre_cv_term_refined_about: String).void } + attr_writer :genre_cv_term_refined_about + + sig { returns(T.nilable(String)) } + attr_reader :headline + + sig { params(headline: String).void } + attr_writer :headline + + sig { returns(T.nilable(String)) } + attr_reader :image_creator_id + + sig { params(image_creator_id: String).void } + attr_writer :image_creator_id + + sig { returns(T.nilable(String)) } + attr_reader :image_creator_image_id + + sig { params(image_creator_image_id: String).void } + attr_writer :image_creator_image_id + + sig { returns(T.nilable(String)) } + attr_reader :image_creator_name + + sig { params(image_creator_name: String).void } + attr_writer :image_creator_name + + sig { returns(T.nilable(String)) } + attr_reader :image_description + + sig { params(image_description: String).void } + attr_writer :image_description + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_h + + sig { params(image_region_boundary_h: T::Array[Float]).void } + attr_writer :image_region_boundary_h + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_rx + + sig { params(image_region_boundary_rx: T::Array[Float]).void } + attr_writer :image_region_boundary_rx + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_boundary_shape + + sig { params(image_region_boundary_shape: T::Array[String]).void } + attr_writer :image_region_boundary_shape + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_boundary_unit + + sig { params(image_region_boundary_unit: T::Array[String]).void } + attr_writer :image_region_boundary_unit + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_vertices_x + + sig { params(image_region_boundary_vertices_x: T::Array[Float]).void } + attr_writer :image_region_boundary_vertices_x + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_vertices_y + + sig { params(image_region_boundary_vertices_y: T::Array[Float]).void } + attr_writer :image_region_boundary_vertices_y + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_w + + sig { params(image_region_boundary_w: T::Array[Float]).void } + attr_writer :image_region_boundary_w + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_x + + sig { params(image_region_boundary_x: T::Array[Float]).void } + attr_writer :image_region_boundary_x + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_region_boundary_y + + sig { params(image_region_boundary_y: T::Array[Float]).void } + attr_writer :image_region_boundary_y + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_ctype_identifier + + sig { params(image_region_ctype_identifier: T::Array[String]).void } + attr_writer :image_region_ctype_identifier + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_ctype_name + + sig { params(image_region_ctype_name: T::Array[String]).void } + attr_writer :image_region_ctype_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_id + + sig { params(image_region_id: T::Array[String]).void } + attr_writer :image_region_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_name + + sig { params(image_region_name: T::Array[String]).void } + attr_writer :image_region_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_organisation_in_image_name + + sig do + params(image_region_organisation_in_image_name: T::Array[String]).void + end + attr_writer :image_region_organisation_in_image_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_person_in_image + + sig { params(image_region_person_in_image: T::Array[String]).void } + attr_writer :image_region_person_in_image + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_role_identifier + + sig { params(image_region_role_identifier: T::Array[String]).void } + attr_writer :image_region_role_identifier + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :image_region_role_name + + sig { params(image_region_role_name: T::Array[String]).void } + attr_writer :image_region_role_name + + sig { returns(T.nilable(String)) } + attr_reader :image_supplier_id + + sig { params(image_supplier_id: String).void } + attr_writer :image_supplier_id + + sig { returns(T.nilable(String)) } + attr_reader :image_supplier_image_id + + sig { params(image_supplier_image_id: String).void } + attr_writer :image_supplier_image_id + + sig { returns(T.nilable(String)) } + attr_reader :image_supplier_name + + sig { params(image_supplier_name: String).void } + attr_writer :image_supplier_name + + sig { returns(T.nilable(String)) } + attr_reader :instructions + + sig { params(instructions: String).void } + attr_writer :instructions + + sig { returns(T.nilable(String)) } + attr_reader :intellectual_genre + + sig { params(intellectual_genre: String).void } + attr_writer :intellectual_genre + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :keywords + + sig { params(keywords: T::Array[String]).void } + attr_writer :keywords + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_city + + sig { params(licensor_city: T::Array[String]).void } + attr_writer :licensor_city + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_country + + sig { params(licensor_country: T::Array[String]).void } + attr_writer :licensor_country + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_email + + sig { params(licensor_email: T::Array[String]).void } + attr_writer :licensor_email + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_extended_address + + sig { params(licensor_extended_address: T::Array[String]).void } + attr_writer :licensor_extended_address + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_id + + sig { params(licensor_id: T::Array[String]).void } + attr_writer :licensor_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_name + + sig { params(licensor_name: T::Array[String]).void } + attr_writer :licensor_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_postal_code + + sig { params(licensor_postal_code: T::Array[String]).void } + attr_writer :licensor_postal_code + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_region + + sig { params(licensor_region: T::Array[String]).void } + attr_writer :licensor_region + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_street_address + + sig { params(licensor_street_address: T::Array[String]).void } + attr_writer :licensor_street_address + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_telephone1 + + sig { params(licensor_telephone1: T::Array[String]).void } + attr_writer :licensor_telephone1 + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_telephone2 + + sig { params(licensor_telephone2: T::Array[String]).void } + attr_writer :licensor_telephone2 + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :licensor_url + + sig { params(licensor_url: T::Array[String]).void } + attr_writer :licensor_url + + sig { returns(T.nilable(String)) } + attr_reader :linked_encoded_rights_expr + + sig { params(linked_encoded_rights_expr: String).void } + attr_writer :linked_encoded_rights_expr + + sig { returns(T.nilable(String)) } + attr_reader :linked_encoded_rights_expr_lang_id + + sig { params(linked_encoded_rights_expr_lang_id: String).void } + attr_writer :linked_encoded_rights_expr_lang_id + + sig { returns(T.nilable(String)) } + attr_reader :linked_encoded_rights_expr_type + + sig { params(linked_encoded_rights_expr_type: String).void } + attr_writer :linked_encoded_rights_expr_type + + sig { returns(T.nilable(String)) } + attr_reader :location + + sig { params(location: String).void } + attr_writer :location + + sig { returns(T.nilable(String)) } + attr_reader :location_created_city + + sig { params(location_created_city: String).void } + attr_writer :location_created_city + + sig { returns(T.nilable(String)) } + attr_reader :location_created_country_code + + sig { params(location_created_country_code: String).void } + attr_writer :location_created_country_code + + sig { returns(T.nilable(String)) } + attr_reader :location_created_country_name + + sig { params(location_created_country_name: String).void } + attr_writer :location_created_country_name + + sig { returns(T.nilable(String)) } + attr_reader :location_created_gps_altitude + + sig { params(location_created_gps_altitude: String).void } + attr_writer :location_created_gps_altitude + + sig { returns(T.nilable(String)) } + attr_reader :location_created_gps_latitude + + sig { params(location_created_gps_latitude: String).void } + attr_writer :location_created_gps_latitude + + sig { returns(T.nilable(String)) } + attr_reader :location_created_gps_longitude + + sig { params(location_created_gps_longitude: String).void } + attr_writer :location_created_gps_longitude + + sig { returns(T.nilable(String)) } + attr_reader :location_created_location_id + + sig { params(location_created_location_id: String).void } + attr_writer :location_created_location_id + + sig { returns(T.nilable(String)) } + attr_reader :location_created_location_name + + sig { params(location_created_location_name: String).void } + attr_writer :location_created_location_name + + sig { returns(T.nilable(String)) } + attr_reader :location_created_province_state + + sig { params(location_created_province_state: String).void } + attr_writer :location_created_province_state + + sig { returns(T.nilable(String)) } + attr_reader :location_created_sublocation + + sig { params(location_created_sublocation: String).void } + attr_writer :location_created_sublocation + + sig { returns(T.nilable(String)) } + attr_reader :location_created_world_region + + sig { params(location_created_world_region: String).void } + attr_writer :location_created_world_region + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_city + + sig { params(location_shown_city: T::Array[String]).void } + attr_writer :location_shown_city + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_country_code + + sig { params(location_shown_country_code: T::Array[String]).void } + attr_writer :location_shown_country_code + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_country_name + + sig { params(location_shown_country_name: T::Array[String]).void } + attr_writer :location_shown_country_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_gps_altitude + + sig { params(location_shown_gps_altitude: T::Array[String]).void } + attr_writer :location_shown_gps_altitude + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_gps_latitude + + sig { params(location_shown_gps_latitude: T::Array[String]).void } + attr_writer :location_shown_gps_latitude + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_gps_longitude + + sig { params(location_shown_gps_longitude: T::Array[String]).void } + attr_writer :location_shown_gps_longitude + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_location_id + + sig { params(location_shown_location_id: T::Array[String]).void } + attr_writer :location_shown_location_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_location_name + + sig { params(location_shown_location_name: T::Array[String]).void } + attr_writer :location_shown_location_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_province_state + + sig { params(location_shown_province_state: T::Array[String]).void } + attr_writer :location_shown_province_state + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_sublocation + + sig { params(location_shown_sublocation: T::Array[String]).void } + attr_writer :location_shown_sublocation + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :location_shown_world_region + + sig { params(location_shown_world_region: T::Array[String]).void } + attr_writer :location_shown_world_region + + sig { returns(T.nilable(Float)) } + attr_reader :max_avail_height + + sig { params(max_avail_height: Float).void } + attr_writer :max_avail_height + + sig { returns(T.nilable(Float)) } + attr_reader :max_avail_width + + sig { params(max_avail_width: Float).void } + attr_writer :max_avail_width + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :model_age + + sig { params(model_age: T::Array[Float]).void } + attr_writer :model_age + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :model_release_id + + sig { params(model_release_id: T::Array[String]).void } + attr_writer :model_release_id + + sig { returns(T.nilable(String)) } + attr_reader :object_attribute_reference + + sig { params(object_attribute_reference: String).void } + attr_writer :object_attribute_reference + + sig { returns(T.nilable(String)) } + attr_reader :object_name + + sig { params(object_name: String).void } + attr_writer :object_name + + sig { returns(T.nilable(String)) } + attr_reader :offset_time_original + + sig { params(offset_time_original: String).void } + attr_writer :offset_time_original + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :organisation_in_image_code + + sig { params(organisation_in_image_code: T::Array[String]).void } + attr_writer :organisation_in_image_code + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :organisation_in_image_name + + sig { params(organisation_in_image_name: T::Array[String]).void } + attr_writer :organisation_in_image_name + + sig { returns(T.nilable(String)) } + attr_reader :orientation + + sig { params(orientation: String).void } + attr_writer :orientation + + sig { returns(T.nilable(String)) } + attr_reader :original_transmission_reference + + sig { params(original_transmission_reference: String).void } + attr_writer :original_transmission_reference + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image + + sig { params(person_in_image: T::Array[String]).void } + attr_writer :person_in_image + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_cv_term_cv_id + + sig { params(person_in_image_cv_term_cv_id: T::Array[String]).void } + attr_writer :person_in_image_cv_term_cv_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_cv_term_id + + sig { params(person_in_image_cv_term_id: T::Array[String]).void } + attr_writer :person_in_image_cv_term_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_cv_term_name + + sig { params(person_in_image_cv_term_name: T::Array[String]).void } + attr_writer :person_in_image_cv_term_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_cv_term_refined_about + + sig do + params(person_in_image_cv_term_refined_about: T::Array[String]).void + end + attr_writer :person_in_image_cv_term_refined_about + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_description + + sig { params(person_in_image_description: T::Array[String]).void } + attr_writer :person_in_image_description + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_id + + sig { params(person_in_image_id: T::Array[String]).void } + attr_writer :person_in_image_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :person_in_image_name + + sig { params(person_in_image_name: T::Array[String]).void } + attr_writer :person_in_image_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :product_in_image_description + + sig { params(product_in_image_description: T::Array[String]).void } + attr_writer :product_in_image_description + + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :product_in_image_gtin + + sig { params(product_in_image_gtin: T::Array[Float]).void } + attr_writer :product_in_image_gtin + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :product_in_image_name + + sig { params(product_in_image_name: T::Array[String]).void } + attr_writer :product_in_image_name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :property_release_id + + sig { params(property_release_id: T::Array[String]).void } + attr_writer :property_release_id + + sig { returns(T.nilable(String)) } + attr_reader :province_state + + sig { params(province_state: String).void } + attr_writer :province_state + + sig { returns(T.nilable(Integer)) } + attr_reader :rating + + sig { params(rating: Integer).void } + attr_writer :rating + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :registry_entry_role + + sig { params(registry_entry_role: T::Array[String]).void } + attr_writer :registry_entry_role + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :registry_item_id + + sig { params(registry_item_id: T::Array[String]).void } + attr_writer :registry_item_id + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :registry_organisation_id + + sig { params(registry_organisation_id: T::Array[String]).void } + attr_writer :registry_organisation_id + + sig { returns(T.nilable(String)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: String).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :rights + + sig { params(rights: String).void } + attr_writer :rights + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :scene + + sig { params(scene: T::Array[String]).void } + attr_writer :scene + + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig { returns(T.nilable(String)) } + attr_reader :special_instructions + + sig { params(special_instructions: String).void } + attr_writer :special_instructions + + sig { returns(T.nilable(String)) } + attr_reader :state + + sig { params(state: String).void } + attr_writer :state + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :subject + + sig { params(subject: T::Array[String]).void } + attr_writer :subject + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :subject_code + + sig { params(subject_code: T::Array[String]).void } + attr_writer :subject_code + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :subject_reference + + sig { params(subject_reference: T::Array[String]).void } + attr_writer :subject_reference + + sig { returns(T.nilable(String)) } + attr_reader :sublocation + + sig { params(sublocation: String).void } + attr_writer :sublocation + + sig { returns(T.nilable(String)) } + attr_reader :time_created + + sig { params(time_created: String).void } + attr_writer :time_created + + sig { returns(T.nilable(String)) } + attr_reader :title + + sig { params(title: String).void } + attr_writer :title + + sig { returns(T.nilable(String)) } + attr_reader :transmission_reference + + sig { params(transmission_reference: String).void } + attr_writer :transmission_reference + + sig { returns(T.nilable(String)) } + attr_reader :usage_terms + + sig { params(usage_terms: String).void } + attr_writer :usage_terms + + sig { returns(T.nilable(String)) } + attr_reader :web_statement + + sig { params(web_statement: String).void } + attr_writer :web_statement + + sig { returns(T.nilable(String)) } + attr_reader :writer + + sig { params(writer: String).void } + attr_writer :writer + + sig { returns(T.nilable(String)) } + attr_reader :writer_editor + + sig { params(writer_editor: String).void } + attr_writer :writer_editor + + sig { returns(T.nilable(Float)) } + attr_reader :x_resolution + + sig { params(x_resolution: Float).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :y_resolution + + sig { params(y_resolution: Float).void } + attr_writer :y_resolution + + # 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. + sig do + params( + about_cv_term_cv_id: String, + about_cv_term_id: String, + about_cv_term_name: String, + about_cv_term_refined_about: String, + additional_model_information: String, + application_record_version: Integer, + artist: String, + artwork_circa_date_created: String, + artwork_content_description: String, + artwork_contribution_description: String, + artwork_copyright_notice: String, + artwork_copyright_owner_id: String, + artwork_copyright_owner_name: String, + artwork_creator: T::Array[String], + artwork_creator_id: T::Array[String], + artwork_date_created: Time, + artwork_licensor_id: String, + artwork_licensor_name: String, + artwork_physical_description: String, + artwork_source: String, + artwork_source_inventory_no: String, + artwork_source_inv_url: String, + artwork_style_period: T::Array[String], + artwork_title: String, + authors_position: String, + byline: String, + byline_title: String, + caption: String, + caption_abstract: String, + caption_writer: String, + city: String, + color_space: String, + components_configuration: String, + copyright: String, + copyright_notice: String, + copyright_owner_id: T::Array[String], + copyright_owner_name: T::Array[String], + country: String, + country_code: String, + country_primary_location_code: String, + country_primary_location_name: String, + creator: String, + creator_address: String, + creator_city: String, + creator_country: String, + creator_postal_code: String, + creator_region: String, + creator_work_email: String, + creator_work_telephone: String, + creator_work_url: String, + credit: String, + date_created: Time, + date_time_created: Time, + date_time_original: Time, + description: String, + digital_image_guid: String, + digital_source_type: String, + embedded_encoded_rights_expr: String, + embedded_encoded_rights_expr_lang_id: String, + embedded_encoded_rights_expr_type: String, + event: String, + exif_version: String, + flashpix_version: String, + genre_cv_id: String, + genre_cv_term_id: String, + genre_cv_term_name: String, + genre_cv_term_refined_about: String, + headline: String, + image_creator_id: String, + image_creator_image_id: String, + image_creator_name: String, + image_description: String, + image_region_boundary_h: T::Array[Float], + image_region_boundary_rx: T::Array[Float], + image_region_boundary_shape: T::Array[String], + image_region_boundary_unit: T::Array[String], + image_region_boundary_vertices_x: T::Array[Float], + image_region_boundary_vertices_y: T::Array[Float], + image_region_boundary_w: T::Array[Float], + image_region_boundary_x: T::Array[Float], + image_region_boundary_y: T::Array[Float], + image_region_ctype_identifier: T::Array[String], + image_region_ctype_name: T::Array[String], + image_region_id: T::Array[String], + image_region_name: T::Array[String], + image_region_organisation_in_image_name: T::Array[String], + image_region_person_in_image: T::Array[String], + image_region_role_identifier: T::Array[String], + image_region_role_name: T::Array[String], + image_supplier_id: String, + image_supplier_image_id: String, + image_supplier_name: String, + instructions: String, + intellectual_genre: String, + keywords: T::Array[String], + licensor_city: T::Array[String], + licensor_country: T::Array[String], + licensor_email: T::Array[String], + licensor_extended_address: T::Array[String], + licensor_id: T::Array[String], + licensor_name: T::Array[String], + licensor_postal_code: T::Array[String], + licensor_region: T::Array[String], + licensor_street_address: T::Array[String], + licensor_telephone1: T::Array[String], + licensor_telephone2: T::Array[String], + licensor_url: T::Array[String], + linked_encoded_rights_expr: String, + linked_encoded_rights_expr_lang_id: String, + linked_encoded_rights_expr_type: String, + location: String, + location_created_city: String, + location_created_country_code: String, + location_created_country_name: String, + location_created_gps_altitude: String, + location_created_gps_latitude: String, + location_created_gps_longitude: String, + location_created_location_id: String, + location_created_location_name: String, + location_created_province_state: String, + location_created_sublocation: String, + location_created_world_region: String, + location_shown_city: T::Array[String], + location_shown_country_code: T::Array[String], + location_shown_country_name: T::Array[String], + location_shown_gps_altitude: T::Array[String], + location_shown_gps_latitude: T::Array[String], + location_shown_gps_longitude: T::Array[String], + location_shown_location_id: T::Array[String], + location_shown_location_name: T::Array[String], + location_shown_province_state: T::Array[String], + location_shown_sublocation: T::Array[String], + location_shown_world_region: T::Array[String], + max_avail_height: Float, + max_avail_width: Float, + model_age: T::Array[Float], + model_release_id: T::Array[String], + object_attribute_reference: String, + object_name: String, + offset_time_original: String, + organisation_in_image_code: T::Array[String], + organisation_in_image_name: T::Array[String], + orientation: String, + original_transmission_reference: String, + person_in_image: T::Array[String], + person_in_image_cv_term_cv_id: T::Array[String], + person_in_image_cv_term_id: T::Array[String], + person_in_image_cv_term_name: T::Array[String], + person_in_image_cv_term_refined_about: T::Array[String], + person_in_image_description: T::Array[String], + person_in_image_id: T::Array[String], + person_in_image_name: T::Array[String], + product_in_image_description: T::Array[String], + product_in_image_gtin: T::Array[Float], + product_in_image_name: T::Array[String], + property_release_id: T::Array[String], + province_state: String, + rating: Integer, + registry_entry_role: T::Array[String], + registry_item_id: T::Array[String], + registry_organisation_id: T::Array[String], + resolution_unit: String, + rights: String, + scene: T::Array[String], + source: String, + special_instructions: String, + state: String, + subject: T::Array[String], + subject_code: T::Array[String], + subject_reference: T::Array[String], + sublocation: String, + time_created: String, + title: String, + transmission_reference: String, + usage_terms: String, + web_statement: String, + writer: String, + writer_editor: String, + x_resolution: Float, + y_resolution: Float + ).returns(T.attached_class) + end + def self.new( + about_cv_term_cv_id: nil, + about_cv_term_id: nil, + about_cv_term_name: nil, + about_cv_term_refined_about: nil, + additional_model_information: nil, + application_record_version: nil, + artist: nil, + artwork_circa_date_created: nil, + artwork_content_description: nil, + artwork_contribution_description: nil, + artwork_copyright_notice: nil, + artwork_copyright_owner_id: nil, + artwork_copyright_owner_name: nil, + artwork_creator: nil, + artwork_creator_id: nil, + artwork_date_created: nil, + artwork_licensor_id: nil, + artwork_licensor_name: nil, + artwork_physical_description: nil, + artwork_source: nil, + artwork_source_inventory_no: nil, + artwork_source_inv_url: nil, + artwork_style_period: nil, + artwork_title: nil, + authors_position: nil, + byline: nil, + byline_title: nil, + caption: nil, + caption_abstract: nil, + caption_writer: nil, + city: nil, + color_space: nil, + components_configuration: nil, + copyright: nil, + copyright_notice: nil, + copyright_owner_id: nil, + copyright_owner_name: nil, + country: nil, + country_code: nil, + country_primary_location_code: nil, + country_primary_location_name: nil, + creator: nil, + creator_address: nil, + creator_city: nil, + creator_country: nil, + creator_postal_code: nil, + creator_region: nil, + creator_work_email: nil, + creator_work_telephone: nil, + creator_work_url: nil, + credit: nil, + date_created: nil, + date_time_created: nil, + date_time_original: nil, + description: nil, + digital_image_guid: nil, + digital_source_type: nil, + embedded_encoded_rights_expr: nil, + embedded_encoded_rights_expr_lang_id: nil, + embedded_encoded_rights_expr_type: nil, + event: nil, + exif_version: nil, + flashpix_version: nil, + genre_cv_id: nil, + genre_cv_term_id: nil, + genre_cv_term_name: nil, + genre_cv_term_refined_about: nil, + headline: nil, + image_creator_id: nil, + image_creator_image_id: nil, + image_creator_name: nil, + image_description: nil, + image_region_boundary_h: nil, + image_region_boundary_rx: nil, + image_region_boundary_shape: nil, + image_region_boundary_unit: nil, + image_region_boundary_vertices_x: nil, + image_region_boundary_vertices_y: nil, + image_region_boundary_w: nil, + image_region_boundary_x: nil, + image_region_boundary_y: nil, + image_region_ctype_identifier: nil, + image_region_ctype_name: nil, + image_region_id: nil, + image_region_name: nil, + image_region_organisation_in_image_name: nil, + image_region_person_in_image: nil, + image_region_role_identifier: nil, + image_region_role_name: nil, + image_supplier_id: nil, + image_supplier_image_id: nil, + image_supplier_name: nil, + instructions: nil, + intellectual_genre: nil, + keywords: nil, + licensor_city: nil, + licensor_country: nil, + licensor_email: nil, + licensor_extended_address: nil, + licensor_id: nil, + licensor_name: nil, + licensor_postal_code: nil, + licensor_region: nil, + licensor_street_address: nil, + licensor_telephone1: nil, + licensor_telephone2: nil, + licensor_url: nil, + linked_encoded_rights_expr: nil, + linked_encoded_rights_expr_lang_id: nil, + linked_encoded_rights_expr_type: nil, + location: nil, + location_created_city: nil, + location_created_country_code: nil, + location_created_country_name: nil, + location_created_gps_altitude: nil, + location_created_gps_latitude: nil, + location_created_gps_longitude: nil, + location_created_location_id: nil, + location_created_location_name: nil, + location_created_province_state: nil, + location_created_sublocation: nil, + location_created_world_region: nil, + location_shown_city: nil, + location_shown_country_code: nil, + location_shown_country_name: nil, + location_shown_gps_altitude: nil, + location_shown_gps_latitude: nil, + location_shown_gps_longitude: nil, + location_shown_location_id: nil, + location_shown_location_name: nil, + location_shown_province_state: nil, + location_shown_sublocation: nil, + location_shown_world_region: nil, + max_avail_height: nil, + max_avail_width: nil, + model_age: nil, + model_release_id: nil, + object_attribute_reference: nil, + object_name: nil, + offset_time_original: nil, + organisation_in_image_code: nil, + organisation_in_image_name: nil, + orientation: nil, + original_transmission_reference: nil, + person_in_image: nil, + person_in_image_cv_term_cv_id: nil, + person_in_image_cv_term_id: nil, + person_in_image_cv_term_name: nil, + person_in_image_cv_term_refined_about: nil, + person_in_image_description: nil, + person_in_image_id: nil, + person_in_image_name: nil, + product_in_image_description: nil, + product_in_image_gtin: nil, + product_in_image_name: nil, + property_release_id: nil, + province_state: nil, + rating: nil, + registry_entry_role: nil, + registry_item_id: nil, + registry_organisation_id: nil, + resolution_unit: nil, + rights: nil, + scene: nil, + source: nil, + special_instructions: nil, + state: nil, + subject: nil, + subject_code: nil, + subject_reference: nil, + sublocation: nil, + time_created: nil, + title: nil, + transmission_reference: nil, + usage_terms: nil, + web_statement: nil, + writer: nil, + writer_editor: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + about_cv_term_cv_id: String, + about_cv_term_id: String, + about_cv_term_name: String, + about_cv_term_refined_about: String, + additional_model_information: String, + application_record_version: Integer, + artist: String, + artwork_circa_date_created: String, + artwork_content_description: String, + artwork_contribution_description: String, + artwork_copyright_notice: String, + artwork_copyright_owner_id: String, + artwork_copyright_owner_name: String, + artwork_creator: T::Array[String], + artwork_creator_id: T::Array[String], + artwork_date_created: Time, + artwork_licensor_id: String, + artwork_licensor_name: String, + artwork_physical_description: String, + artwork_source: String, + artwork_source_inventory_no: String, + artwork_source_inv_url: String, + artwork_style_period: T::Array[String], + artwork_title: String, + authors_position: String, + byline: String, + byline_title: String, + caption: String, + caption_abstract: String, + caption_writer: String, + city: String, + color_space: String, + components_configuration: String, + copyright: String, + copyright_notice: String, + copyright_owner_id: T::Array[String], + copyright_owner_name: T::Array[String], + country: String, + country_code: String, + country_primary_location_code: String, + country_primary_location_name: String, + creator: String, + creator_address: String, + creator_city: String, + creator_country: String, + creator_postal_code: String, + creator_region: String, + creator_work_email: String, + creator_work_telephone: String, + creator_work_url: String, + credit: String, + date_created: Time, + date_time_created: Time, + date_time_original: Time, + description: String, + digital_image_guid: String, + digital_source_type: String, + embedded_encoded_rights_expr: String, + embedded_encoded_rights_expr_lang_id: String, + embedded_encoded_rights_expr_type: String, + event: String, + exif_version: String, + flashpix_version: String, + genre_cv_id: String, + genre_cv_term_id: String, + genre_cv_term_name: String, + genre_cv_term_refined_about: String, + headline: String, + image_creator_id: String, + image_creator_image_id: String, + image_creator_name: String, + image_description: String, + image_region_boundary_h: T::Array[Float], + image_region_boundary_rx: T::Array[Float], + image_region_boundary_shape: T::Array[String], + image_region_boundary_unit: T::Array[String], + image_region_boundary_vertices_x: T::Array[Float], + image_region_boundary_vertices_y: T::Array[Float], + image_region_boundary_w: T::Array[Float], + image_region_boundary_x: T::Array[Float], + image_region_boundary_y: T::Array[Float], + image_region_ctype_identifier: T::Array[String], + image_region_ctype_name: T::Array[String], + image_region_id: T::Array[String], + image_region_name: T::Array[String], + image_region_organisation_in_image_name: T::Array[String], + image_region_person_in_image: T::Array[String], + image_region_role_identifier: T::Array[String], + image_region_role_name: T::Array[String], + image_supplier_id: String, + image_supplier_image_id: String, + image_supplier_name: String, + instructions: String, + intellectual_genre: String, + keywords: T::Array[String], + licensor_city: T::Array[String], + licensor_country: T::Array[String], + licensor_email: T::Array[String], + licensor_extended_address: T::Array[String], + licensor_id: T::Array[String], + licensor_name: T::Array[String], + licensor_postal_code: T::Array[String], + licensor_region: T::Array[String], + licensor_street_address: T::Array[String], + licensor_telephone1: T::Array[String], + licensor_telephone2: T::Array[String], + licensor_url: T::Array[String], + linked_encoded_rights_expr: String, + linked_encoded_rights_expr_lang_id: String, + linked_encoded_rights_expr_type: String, + location: String, + location_created_city: String, + location_created_country_code: String, + location_created_country_name: String, + location_created_gps_altitude: String, + location_created_gps_latitude: String, + location_created_gps_longitude: String, + location_created_location_id: String, + location_created_location_name: String, + location_created_province_state: String, + location_created_sublocation: String, + location_created_world_region: String, + location_shown_city: T::Array[String], + location_shown_country_code: T::Array[String], + location_shown_country_name: T::Array[String], + location_shown_gps_altitude: T::Array[String], + location_shown_gps_latitude: T::Array[String], + location_shown_gps_longitude: T::Array[String], + location_shown_location_id: T::Array[String], + location_shown_location_name: T::Array[String], + location_shown_province_state: T::Array[String], + location_shown_sublocation: T::Array[String], + location_shown_world_region: T::Array[String], + max_avail_height: Float, + max_avail_width: Float, + model_age: T::Array[Float], + model_release_id: T::Array[String], + object_attribute_reference: String, + object_name: String, + offset_time_original: String, + organisation_in_image_code: T::Array[String], + organisation_in_image_name: T::Array[String], + orientation: String, + original_transmission_reference: String, + person_in_image: T::Array[String], + person_in_image_cv_term_cv_id: T::Array[String], + person_in_image_cv_term_id: T::Array[String], + person_in_image_cv_term_name: T::Array[String], + person_in_image_cv_term_refined_about: T::Array[String], + person_in_image_description: T::Array[String], + person_in_image_id: T::Array[String], + person_in_image_name: T::Array[String], + product_in_image_description: T::Array[String], + product_in_image_gtin: T::Array[Float], + product_in_image_name: T::Array[String], + property_release_id: T::Array[String], + province_state: String, + rating: Integer, + registry_entry_role: T::Array[String], + registry_item_id: T::Array[String], + registry_organisation_id: T::Array[String], + resolution_unit: String, + rights: String, + scene: T::Array[String], + source: String, + special_instructions: String, + state: String, + subject: T::Array[String], + subject_code: T::Array[String], + subject_reference: T::Array[String], + sublocation: String, + time_created: String, + title: String, + transmission_reference: String, + usage_terms: String, + web_statement: String, + writer: String, + writer_editor: String, + x_resolution: Float, + y_resolution: Float + } + ) + end + def to_hash + end + end + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV2Response::ExtensionStatus, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :aws_auto_tagging + + sig do + params( + aws_auto_tagging: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::OrSymbol + ).void + end + attr_writer :aws_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :google_auto_tagging + + sig do + params( + google_auto_tagging: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::OrSymbol + ).void + end + attr_writer :google_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol + ) + ) + end + attr_reader :remove_bg + + sig do + params( + remove_bg: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::OrSymbol + ).void + end + attr_writer :remove_bg + + # 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. + sig do + params( + aws_auto_tagging: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::OrSymbol, + google_auto_tagging: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::OrSymbol, + remove_bg: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::OrSymbol + ).returns(T.attached_class) + end + def self.new( + aws_auto_tagging: nil, + google_auto_tagging: nil, + remove_bg: nil + ) + end + + sig do + override.returns( + { + aws_auto_tagging: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + google_auto_tagging: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + remove_bg: + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol + } + ) + end + def to_hash + end + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class Metadata < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV2Response::Metadata, + Imagekit::Internal::AnyHash + ) + end + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig do + returns( + T.nilable(Imagekit::Models::FileUploadV2Response::Metadata::Exif) + ) + end + attr_reader :exif + + sig do + params( + exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif::OrHash + ).void + end + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: + Imagekit::Models::FileUploadV2Response::Metadata::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV2Response::Metadata::Exif, + Imagekit::Internal::AnyHash + ) + end + + # Object containing Exif details. + sig { returns(T.nilable(Imagekit::ExifDetails)) } + attr_reader :exif + + sig { params(exif: Imagekit::ExifDetails::OrHash).void } + attr_writer :exif + + # Object containing GPS information. + sig { returns(T.nilable(Imagekit::Gps)) } + attr_reader :gps + + sig { params(gps: Imagekit::Gps::OrHash).void } + attr_writer :gps + + # Object containing EXIF image information. + sig { returns(T.nilable(Imagekit::ExifImage)) } + attr_reader :image + + sig { params(image: Imagekit::ExifImage::OrHash).void } + attr_writer :image + + # JSON object. + sig { returns(T.nilable(Imagekit::Interoperability)) } + attr_reader :interoperability + + sig do + params(interoperability: Imagekit::Interoperability::OrHash).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig { returns(T.nilable(Imagekit::Thumbnail)) } + attr_reader :thumbnail + + sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } + attr_writer :thumbnail + + sig do + params( + exif: Imagekit::ExifDetails::OrHash, + gps: Imagekit::Gps::OrHash, + image: Imagekit::ExifImage::OrHash, + interoperability: Imagekit::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Thumbnail + } + ) + end + def to_hash + end + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadV2Response::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object containing the file or file version's `id` (versionId) and `name`. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/batch_delete_params.rbi b/rbi/imagekit/models/files/batch_delete_params.rbi new file mode 100644 index 00000000..8f6b4768 --- /dev/null +++ b/rbi/imagekit/models/files/batch_delete_params.rbi @@ -0,0 +1,48 @@ +# typed: strong + +module Imagekit + module Models + module Files + class BatchDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::BatchDeleteParams, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds which you want to delete. + sig { returns(T::Array[String]) } + attr_accessor :file_ids + + sig do + params( + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # An array of fileIds which you want to delete. + file_ids:, + request_options: {} + ) + end + + sig do + override.returns( + { + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/batch_delete_response.rbi b/rbi/imagekit/models/files/batch_delete_response.rbi new file mode 100644 index 00000000..12ca30c3 --- /dev/null +++ b/rbi/imagekit/models/files/batch_delete_response.rbi @@ -0,0 +1,41 @@ +# typed: strong + +module Imagekit + module Models + module Files + class BatchDeleteResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::BatchDeleteResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds that were successfully deleted. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :successfully_deleted_file_ids + + sig { params(successfully_deleted_file_ids: T::Array[String]).void } + attr_writer :successfully_deleted_file_ids + + sig do + params(successfully_deleted_file_ids: T::Array[String]).returns( + T.attached_class + ) + end + def self.new( + # An array of fileIds that were successfully deleted. + successfully_deleted_file_ids: nil + ) + end + + sig do + override.returns({ successfully_deleted_file_ids: T::Array[String] }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/detail_retrieve_params.rbi b/rbi/imagekit/models/files/detail_retrieve_params.rbi new file mode 100644 index 00000000..752a54e5 --- /dev/null +++ b/rbi/imagekit/models/files/detail_retrieve_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Files + class DetailRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::DetailRetrieveParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/detail_retrieve_response.rbi b/rbi/imagekit/models/files/detail_retrieve_response.rbi new file mode 100644 index 00000000..61a87012 --- /dev/null +++ b/rbi/imagekit/models/files/detail_retrieve_response.rbi @@ -0,0 +1,394 @@ +# typed: strong + +module Imagekit + module Models + module Files + class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::DetailRetrieveResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the file by auto tagging. + sig do + returns( + T.nilable( + T::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag] + ) + ) + end + attr_accessor :ai_tags + + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :created_at + + sig { params(created_at: String).void } + attr_writer :created_at + + # An string with custom coordinates of the file. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # An object with custom metadata for the file. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # 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`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Specifies if the image has an alpha channel. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_alpha + + sig { params(has_alpha: T::Boolean).void } + attr_writer :has_alpha + + # Height of the file. + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :height + + # Specifies if the file is private or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # Specifies if the file is published or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # MIME type of the file. + sig { returns(T.nilable(String)) } + attr_reader :mime + + sig { params(mime: String).void } + attr_writer :mime + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the file in bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :size + + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail + + sig { params(thumbnail: String).void } + attr_writer :thumbnail + + # Type of the asset. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :updated_at + + sig { params(updated_at: String).void } + attr_writer :updated_at + + # URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object with details of the file version. + sig do + returns( + T.nilable( + Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo + ) + ) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # Width of the file. + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a file or file version. + sig do + params( + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::DetailRetrieveResponse::AITag::OrHash + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo::OrHash, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the file by auto tagging. + ai_tags: nil, + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + created_at: nil, + # An string with custom coordinates of the file. + custom_coordinates: nil, + # An object with custom metadata for the file. + custom_metadata: nil, + # Unique identifier of the asset. + file_id: nil, + # 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`. + file_path: nil, + # Type of the file. Possible values are `image`, `non-image`. + file_type: nil, + # Specifies if the image has an alpha channel. + has_alpha: nil, + # Height of the file. + height: nil, + # Specifies if the file is private or not. + is_private_file: nil, + # Specifies if the file is published or not. + is_published: nil, + # MIME type of the file. + mime: nil, + # Name of the asset. + name: nil, + # Size of the file in bytes. + size: nil, + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + tags: nil, + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + thumbnail: nil, + # Type of the asset. + type: nil, + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + updated_at: nil, + # URL of the file. + url: nil, + # An object with details of the file version. + version_info: nil, + # Width of the file. + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::DetailRetrieveResponse::AITag + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::DetailRetrieveResponse::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + source: nil + ) + end + + sig do + override.returns( + { confidence: Float, name: String, source: String } + ) + end + def to_hash + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object with details of the file version. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/detail_update_params.rbi b/rbi/imagekit/models/files/detail_update_params.rbi new file mode 100644 index 00000000..04659912 --- /dev/null +++ b/rbi/imagekit/models/files/detail_update_params.rbi @@ -0,0 +1,583 @@ +# typed: strong + +module Imagekit + module Models + module Files + class DetailUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::DetailUpdateParams, + Imagekit::Internal::AnyHash + ) + end + + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + sig do + returns( + T.nilable( + T::Array[ + T.any( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension, + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension + ) + ] + ) + ) + end + attr_reader :extensions + + sig do + params( + extensions: + T::Array[ + T.any( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::OrHash + ) + ] + ).void + end + attr_writer :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. + sig do + returns( + T.nilable( + T.any( + T::Array[String], + Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol + ) + ) + ) + end + attr_reader :remove_ai_tags + + sig do + params( + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol + ) + ).void + end + attr_writer :remove_ai_tags + + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + # Configure the publication status of a file and its versions. + sig { returns(T.nilable(Imagekit::Files::DetailUpdateParams::Publish)) } + attr_reader :publish + + sig do + params( + publish: Imagekit::Files::DetailUpdateParams::Publish::OrHash + ).void + end + attr_writer :publish + + sig do + params( + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + extensions: + T::Array[ + T.any( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::OrHash + ) + ], + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol + ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::Files::DetailUpdateParams::Publish::OrHash, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, + # Configure the publication status of a file and its versions. + publish: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + extensions: + T::Array[ + T.any( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension, + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension + ) + ], + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol + ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::Files::DetailUpdateParams::Publish, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + module Extension + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension, + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension + ) + end + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig do + returns( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + returns( + T.nilable( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + name: + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil + ) + end + + sig do + override.returns( + { + name: + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options + } + ) + end + def to_hash + end + + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[Imagekit::Files::DetailUpdateParams::Extension::Variants] + ) + end + def self.variants + end + end + + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + T::Array[String], + Imagekit::Files::DetailUpdateParams::RemoveAITags::TaggedSymbol + ) + end + + sig do + override.returns( + T::Array[ + Imagekit::Files::DetailUpdateParams::RemoveAITags::Variants + ] + ) + end + def self.variants + end + + StringArray = + T.let( + Imagekit::Internal::Type::ArrayOf[String], + Imagekit::Internal::Type::Converter + ) + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Files::DetailUpdateParams::RemoveAITags) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ALL = + T.let( + :all, + Imagekit::Files::DetailUpdateParams::RemoveAITags::TaggedSymbol + ) + end + + class Publish < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Files::DetailUpdateParams::Publish, + Imagekit::Internal::AnyHash + ) + end + + # Set to `true` to publish the file. Set to `false` to unpublish the file. + sig { returns(T::Boolean) } + attr_accessor :is_published + + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions + + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions + + # Configure the publication status of a file and its versions. + sig do + params( + is_published: T::Boolean, + include_file_versions: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Set to `true` to publish the file. Set to `false` to unpublish the file. + is_published:, + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + include_file_versions: nil + ) + end + + sig do + override.returns( + { is_published: T::Boolean, include_file_versions: T::Boolean } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/detail_update_response.rbi b/rbi/imagekit/models/files/detail_update_response.rbi new file mode 100644 index 00000000..ac439423 --- /dev/null +++ b/rbi/imagekit/models/files/detail_update_response.rbi @@ -0,0 +1,623 @@ +# typed: strong + +module Imagekit + module Models + module Files + class DetailUpdateResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::DetailUpdateResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the file by auto tagging. + sig do + returns( + T.nilable( + T::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag] + ) + ) + end + attr_accessor :ai_tags + + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :created_at + + sig { params(created_at: String).void } + attr_writer :created_at + + # An string with custom coordinates of the file. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # An object with custom metadata for the file. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + sig do + returns( + T.nilable( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus + ) + ) + end + attr_reader :extension_status + + sig do + params( + extension_status: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::OrHash + ).void + end + attr_writer :extension_status + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # 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`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Specifies if the image has an alpha channel. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_alpha + + sig { params(has_alpha: T::Boolean).void } + attr_writer :has_alpha + + # Height of the file. + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :height + + # Specifies if the file is private or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # Specifies if the file is published or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # MIME type of the file. + sig { returns(T.nilable(String)) } + attr_reader :mime + + sig { params(mime: String).void } + attr_writer :mime + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the file in bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :size + + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail + + sig { params(thumbnail: String).void } + attr_writer :thumbnail + + # Type of the asset. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :updated_at + + sig { params(updated_at: String).void } + attr_writer :updated_at + + # URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object with details of the file version. + sig do + returns( + T.nilable( + Imagekit::Models::Files::DetailUpdateResponse::VersionInfo + ) + ) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::Files::DetailUpdateResponse::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # Width of the file. + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + sig do + params( + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::DetailUpdateResponse::AITag::OrHash + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + extension_status: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::OrHash, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::DetailUpdateResponse::VersionInfo::OrHash, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the file by auto tagging. + ai_tags: nil, + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + created_at: nil, + # An string with custom coordinates of the file. + custom_coordinates: nil, + # An object with custom metadata for the file. + custom_metadata: nil, + extension_status: nil, + # Unique identifier of the asset. + file_id: nil, + # 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`. + file_path: nil, + # Type of the file. Possible values are `image`, `non-image`. + file_type: nil, + # Specifies if the image has an alpha channel. + has_alpha: nil, + # Height of the file. + height: nil, + # Specifies if the file is private or not. + is_private_file: nil, + # Specifies if the file is published or not. + is_published: nil, + # MIME type of the file. + mime: nil, + # Name of the asset. + name: nil, + # Size of the file in bytes. + size: nil, + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + tags: nil, + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + thumbnail: nil, + # Type of the asset. + type: nil, + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + updated_at: nil, + # URL of the file. + url: nil, + # An object with details of the file version. + version_info: nil, + # Width of the file. + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + extension_status: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::DetailUpdateResponse::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + source: nil + ) + end + + sig do + override.returns( + { confidence: Float, name: String, source: String } + ) + end + def to_hash + end + end + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :aws_auto_tagging + + sig do + params( + aws_auto_tagging: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol + ).void + end + attr_writer :aws_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :google_auto_tagging + + sig do + params( + google_auto_tagging: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol + ).void + end + attr_writer :google_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + ) + end + attr_reader :remove_bg + + sig do + params( + remove_bg: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol + ).void + end + attr_writer :remove_bg + + sig do + params( + aws_auto_tagging: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, + google_auto_tagging: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, + remove_bg: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol + ).returns(T.attached_class) + end + def self.new( + aws_auto_tagging: nil, + google_auto_tagging: nil, + remove_bg: nil + ) + end + + sig do + override.returns( + { + aws_auto_tagging: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + google_auto_tagging: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + remove_bg: + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + } + ) + end + def to_hash + end + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object with details of the file version. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/metadata_from_url_params.rbi b/rbi/imagekit/models/files/metadata_from_url_params.rbi new file mode 100644 index 00000000..c0d403f0 --- /dev/null +++ b/rbi/imagekit/models/files/metadata_from_url_params.rbi @@ -0,0 +1,47 @@ +# typed: strong + +module Imagekit + module Models + module Files + class MetadataFromURLParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::MetadataFromURLParams, + Imagekit::Internal::AnyHash + ) + end + + # Should be a valid file URL. It should be accessible using your ImageKit.io + # account. + sig { returns(String) } + attr_accessor :url + + sig do + params( + url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Should be a valid file URL. It should be accessible using your ImageKit.io + # account. + url:, + request_options: {} + ) + end + + sig do + override.returns( + { url: String, request_options: Imagekit::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/metadata_from_url_response.rbi b/rbi/imagekit/models/files/metadata_from_url_response.rbi new file mode 100644 index 00000000..d20408eb --- /dev/null +++ b/rbi/imagekit/models/files/metadata_from_url_response.rbi @@ -0,0 +1,289 @@ +# typed: strong + +module Imagekit + module Models + module Files + class MetadataFromURLResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataFromURLResponse, + Imagekit::Internal::AnyHash + ) + end + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig do + returns( + T.nilable(Imagekit::Models::Files::MetadataFromURLResponse::Exif) + ) + end + attr_reader :exif + + sig do + params( + exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif::OrHash + ).void + end + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # JSON object containing metadata. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: + Imagekit::Models::Files::MetadataFromURLResponse::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataFromURLResponse::Exif, + Imagekit::Internal::AnyHash + ) + end + + # Object containing Exif details. + sig { returns(T.nilable(Imagekit::ExifDetails)) } + attr_reader :exif + + sig { params(exif: Imagekit::ExifDetails::OrHash).void } + attr_writer :exif + + # Object containing GPS information. + sig { returns(T.nilable(Imagekit::Gps)) } + attr_reader :gps + + sig { params(gps: Imagekit::Gps::OrHash).void } + attr_writer :gps + + # Object containing EXIF image information. + sig { returns(T.nilable(Imagekit::ExifImage)) } + attr_reader :image + + sig { params(image: Imagekit::ExifImage::OrHash).void } + attr_writer :image + + # JSON object. + sig { returns(T.nilable(Imagekit::Interoperability)) } + attr_reader :interoperability + + sig do + params(interoperability: Imagekit::Interoperability::OrHash).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig { returns(T.nilable(Imagekit::Thumbnail)) } + attr_reader :thumbnail + + sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } + attr_writer :thumbnail + + sig do + params( + exif: Imagekit::ExifDetails::OrHash, + gps: Imagekit::Gps::OrHash, + image: Imagekit::ExifImage::OrHash, + interoperability: Imagekit::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Thumbnail + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/metadata_retrieve_params.rbi b/rbi/imagekit/models/files/metadata_retrieve_params.rbi new file mode 100644 index 00000000..605abe12 --- /dev/null +++ b/rbi/imagekit/models/files/metadata_retrieve_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Files + class MetadataRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::MetadataRetrieveParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/metadata_retrieve_response.rbi b/rbi/imagekit/models/files/metadata_retrieve_response.rbi new file mode 100644 index 00000000..093668d6 --- /dev/null +++ b/rbi/imagekit/models/files/metadata_retrieve_response.rbi @@ -0,0 +1,290 @@ +# typed: strong + +module Imagekit + module Models + module Files + class MetadataRetrieveResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataRetrieveResponse, + Imagekit::Internal::AnyHash + ) + end + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig do + returns( + T.nilable(Imagekit::Models::Files::MetadataRetrieveResponse::Exif) + ) + end + attr_reader :exif + + sig do + params( + exif: + Imagekit::Models::Files::MetadataRetrieveResponse::Exif::OrHash + ).void + end + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # JSON object containing metadata. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: + Imagekit::Models::Files::MetadataRetrieveResponse::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataRetrieveResponse::Exif, + Imagekit::Internal::AnyHash + ) + end + + # Object containing Exif details. + sig { returns(T.nilable(Imagekit::ExifDetails)) } + attr_reader :exif + + sig { params(exif: Imagekit::ExifDetails::OrHash).void } + attr_writer :exif + + # Object containing GPS information. + sig { returns(T.nilable(Imagekit::Gps)) } + attr_reader :gps + + sig { params(gps: Imagekit::Gps::OrHash).void } + attr_writer :gps + + # Object containing EXIF image information. + sig { returns(T.nilable(Imagekit::ExifImage)) } + attr_reader :image + + sig { params(image: Imagekit::ExifImage::OrHash).void } + attr_writer :image + + # JSON object. + sig { returns(T.nilable(Imagekit::Interoperability)) } + attr_reader :interoperability + + sig do + params(interoperability: Imagekit::Interoperability::OrHash).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig { returns(T.nilable(Imagekit::Thumbnail)) } + attr_reader :thumbnail + + sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } + attr_writer :thumbnail + + sig do + params( + exif: Imagekit::ExifDetails::OrHash, + gps: Imagekit::Gps::OrHash, + image: Imagekit::ExifImage::OrHash, + interoperability: Imagekit::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Thumbnail + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/purge_execute_params.rbi b/rbi/imagekit/models/files/purge_execute_params.rbi new file mode 100644 index 00000000..fbda8a03 --- /dev/null +++ b/rbi/imagekit/models/files/purge_execute_params.rbi @@ -0,0 +1,45 @@ +# typed: strong + +module Imagekit + module Models + module Files + class PurgeExecuteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::PurgeExecuteParams, + Imagekit::Internal::AnyHash + ) + end + + # The full URL of the file to be purged. + sig { returns(String) } + attr_accessor :url + + sig do + params( + url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # The full URL of the file to be purged. + url:, + request_options: {} + ) + end + + sig do + override.returns( + { url: String, request_options: Imagekit::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/purge_execute_response.rbi b/rbi/imagekit/models/files/purge_execute_response.rbi new file mode 100644 index 00000000..da771e69 --- /dev/null +++ b/rbi/imagekit/models/files/purge_execute_response.rbi @@ -0,0 +1,37 @@ +# typed: strong + +module Imagekit + module Models + module Files + class PurgeExecuteResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::PurgeExecuteResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the purge request. This can be used to check the status of + # the purge request. + sig { returns(T.nilable(String)) } + attr_reader :request_id + + sig { params(request_id: String).void } + attr_writer :request_id + + sig { params(request_id: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the purge request. This can be used to check the status of + # the purge request. + request_id: nil + ) + end + + sig { override.returns({ request_id: String }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/purge_status_params.rbi b/rbi/imagekit/models/files/purge_status_params.rbi new file mode 100644 index 00000000..54f3e40c --- /dev/null +++ b/rbi/imagekit/models/files/purge_status_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Files + class PurgeStatusParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::PurgeStatusParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/purge_status_response.rbi b/rbi/imagekit/models/files/purge_status_response.rbi new file mode 100644 index 00000000..3bc42d63 --- /dev/null +++ b/rbi/imagekit/models/files/purge_status_response.rbi @@ -0,0 +1,93 @@ +# typed: strong + +module Imagekit + module Models + module Files + class PurgeStatusResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::PurgeStatusResponse, + Imagekit::Internal::AnyHash + ) + end + + # Status of the purge request. + sig do + returns( + T.nilable( + Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + ) + ) + end + attr_reader :status + + sig do + params( + status: + Imagekit::Models::Files::PurgeStatusResponse::Status::OrSymbol + ).void + end + attr_writer :status + + sig do + params( + status: + Imagekit::Models::Files::PurgeStatusResponse::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Status of the purge request. + status: nil + ) + end + + sig do + override.returns( + { + status: + Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Status of the purge request. + module Status + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Files::PurgeStatusResponse::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PENDING = + T.let( + :Pending, + Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + ) + COMPLETED = + T.let( + :Completed, + Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/version_delete_params.rbi b/rbi/imagekit/models/files/version_delete_params.rbi new file mode 100644 index 00000000..ba925a21 --- /dev/null +++ b/rbi/imagekit/models/files/version_delete_params.rbi @@ -0,0 +1,40 @@ +# typed: strong + +module Imagekit + module Models + module Files + class VersionDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::VersionDeleteParams, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :file_id + + sig do + params( + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(file_id:, request_options: {}) + end + + sig do + override.returns( + { file_id: String, request_options: Imagekit::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/version_delete_response.rbi b/rbi/imagekit/models/files/version_delete_response.rbi new file mode 100644 index 00000000..f1f1c90e --- /dev/null +++ b/rbi/imagekit/models/files/version_delete_response.rbi @@ -0,0 +1,10 @@ +# typed: strong + +module Imagekit + module Models + module Files + VersionDeleteResponse = + T.let(T.anything, Imagekit::Internal::Type::Converter) + end + end +end diff --git a/rbi/imagekit/models/files/version_list_params.rbi b/rbi/imagekit/models/files/version_list_params.rbi new file mode 100644 index 00000000..496f70bb --- /dev/null +++ b/rbi/imagekit/models/files/version_list_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Files + class VersionListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::VersionListParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/version_list_response.rbi b/rbi/imagekit/models/files/version_list_response.rbi new file mode 100644 index 00000000..461b995c --- /dev/null +++ b/rbi/imagekit/models/files/version_list_response.rbi @@ -0,0 +1,402 @@ +# typed: strong + +module Imagekit + module Models + module Files + class VersionListResponseItem < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionListResponseItem, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the file by auto tagging. + sig do + returns( + T.nilable( + T::Array[Imagekit::Models::Files::VersionListResponseItem::AITag] + ) + ) + end + attr_accessor :ai_tags + + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :created_at + + sig { params(created_at: String).void } + attr_writer :created_at + + # An string with custom coordinates of the file. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # An object with custom metadata for the file. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # 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`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Specifies if the image has an alpha channel. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_alpha + + sig { params(has_alpha: T::Boolean).void } + attr_writer :has_alpha + + # Height of the file. + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :height + + # Specifies if the file is private or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # Specifies if the file is published or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # MIME type of the file. + sig { returns(T.nilable(String)) } + attr_reader :mime + + sig { params(mime: String).void } + attr_writer :mime + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the file in bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :size + + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail + + sig { params(thumbnail: String).void } + attr_writer :thumbnail + + # Type of the asset. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :updated_at + + sig { params(updated_at: String).void } + attr_writer :updated_at + + # URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object with details of the file version. + sig do + returns( + T.nilable( + Imagekit::Models::Files::VersionListResponseItem::VersionInfo + ) + ) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::Files::VersionListResponseItem::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # Width of the file. + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a file or file version. + sig do + params( + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::VersionListResponseItem::AITag::OrHash + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::VersionListResponseItem::VersionInfo::OrHash, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the file by auto tagging. + ai_tags: nil, + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + created_at: nil, + # An string with custom coordinates of the file. + custom_coordinates: nil, + # An object with custom metadata for the file. + custom_metadata: nil, + # Unique identifier of the asset. + file_id: nil, + # 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`. + file_path: nil, + # Type of the file. Possible values are `image`, `non-image`. + file_type: nil, + # Specifies if the image has an alpha channel. + has_alpha: nil, + # Height of the file. + height: nil, + # Specifies if the file is private or not. + is_private_file: nil, + # Specifies if the file is published or not. + is_published: nil, + # MIME type of the file. + mime: nil, + # Name of the asset. + name: nil, + # Size of the file in bytes. + size: nil, + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + tags: nil, + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + thumbnail: nil, + # Type of the asset. + type: nil, + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + updated_at: nil, + # URL of the file. + url: nil, + # An object with details of the file version. + version_info: nil, + # Width of the file. + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::VersionListResponseItem::AITag + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::VersionListResponseItem::VersionInfo, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionListResponseItem::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + source: nil + ) + end + + sig do + override.returns( + { confidence: Float, name: String, source: String } + ) + end + def to_hash + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionListResponseItem::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object with details of the file version. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + + VersionListResponse = + T.let( + Imagekit::Internal::Type::ArrayOf[ + Imagekit::Models::Files::VersionListResponseItem + ], + Imagekit::Internal::Type::Converter + ) + end + end +end diff --git a/rbi/imagekit/models/files/version_restore_params.rbi b/rbi/imagekit/models/files/version_restore_params.rbi new file mode 100644 index 00000000..c4b466fd --- /dev/null +++ b/rbi/imagekit/models/files/version_restore_params.rbi @@ -0,0 +1,40 @@ +# typed: strong + +module Imagekit + module Models + module Files + class VersionRestoreParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::VersionRestoreParams, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :file_id + + sig do + params( + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(file_id:, request_options: {}) + end + + sig do + override.returns( + { file_id: String, request_options: Imagekit::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/version_restore_response.rbi b/rbi/imagekit/models/files/version_restore_response.rbi new file mode 100644 index 00000000..2e581928 --- /dev/null +++ b/rbi/imagekit/models/files/version_restore_response.rbi @@ -0,0 +1,394 @@ +# typed: strong + +module Imagekit + module Models + module Files + class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionRestoreResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the file by auto tagging. + sig do + returns( + T.nilable( + T::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag] + ) + ) + end + attr_accessor :ai_tags + + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :created_at + + sig { params(created_at: String).void } + attr_writer :created_at + + # An string with custom coordinates of the file. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # An object with custom metadata for the file. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # 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`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Specifies if the image has an alpha channel. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_alpha + + sig { params(has_alpha: T::Boolean).void } + attr_writer :has_alpha + + # Height of the file. + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :height + + # Specifies if the file is private or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # Specifies if the file is published or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # MIME type of the file. + sig { returns(T.nilable(String)) } + attr_reader :mime + + sig { params(mime: String).void } + attr_writer :mime + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the file in bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :size + + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail + + sig { params(thumbnail: String).void } + attr_writer :thumbnail + + # Type of the asset. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :updated_at + + sig { params(updated_at: String).void } + attr_writer :updated_at + + # URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object with details of the file version. + sig do + returns( + T.nilable( + Imagekit::Models::Files::VersionRestoreResponse::VersionInfo + ) + ) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::Files::VersionRestoreResponse::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # Width of the file. + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a file or file version. + sig do + params( + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::VersionRestoreResponse::AITag::OrHash + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::VersionRestoreResponse::VersionInfo::OrHash, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the file by auto tagging. + ai_tags: nil, + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + created_at: nil, + # An string with custom coordinates of the file. + custom_coordinates: nil, + # An object with custom metadata for the file. + custom_metadata: nil, + # Unique identifier of the asset. + file_id: nil, + # 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`. + file_path: nil, + # Type of the file. Possible values are `image`, `non-image`. + file_type: nil, + # Specifies if the image has an alpha channel. + has_alpha: nil, + # Height of the file. + height: nil, + # Specifies if the file is private or not. + is_private_file: nil, + # Specifies if the file is published or not. + is_published: nil, + # MIME type of the file. + mime: nil, + # Name of the asset. + name: nil, + # Size of the file in bytes. + size: nil, + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + tags: nil, + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + thumbnail: nil, + # Type of the asset. + type: nil, + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + updated_at: nil, + # URL of the file. + url: nil, + # An object with details of the file version. + version_info: nil, + # Width of the file. + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::VersionRestoreResponse::AITag + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionRestoreResponse::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + source: nil + ) + end + + sig do + override.returns( + { confidence: Float, name: String, source: String } + ) + end + def to_hash + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object with details of the file version. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/version_retrieve_params.rbi b/rbi/imagekit/models/files/version_retrieve_params.rbi new file mode 100644 index 00000000..b5d6b948 --- /dev/null +++ b/rbi/imagekit/models/files/version_retrieve_params.rbi @@ -0,0 +1,40 @@ +# typed: strong + +module Imagekit + module Models + module Files + class VersionRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::VersionRetrieveParams, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :file_id + + sig do + params( + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(file_id:, request_options: {}) + end + + sig do + override.returns( + { file_id: String, request_options: Imagekit::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/version_retrieve_response.rbi b/rbi/imagekit/models/files/version_retrieve_response.rbi new file mode 100644 index 00000000..28f36016 --- /dev/null +++ b/rbi/imagekit/models/files/version_retrieve_response.rbi @@ -0,0 +1,394 @@ +# typed: strong + +module Imagekit + module Models + module Files + class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionRetrieveResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the file by auto tagging. + sig do + returns( + T.nilable( + T::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag] + ) + ) + end + attr_accessor :ai_tags + + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :created_at + + sig { params(created_at: String).void } + attr_writer :created_at + + # An string with custom coordinates of the file. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # An object with custom metadata for the file. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # 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`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Specifies if the image has an alpha channel. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_alpha + + sig { params(has_alpha: T::Boolean).void } + attr_writer :has_alpha + + # Height of the file. + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :height + + # Specifies if the file is private or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # Specifies if the file is published or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # MIME type of the file. + sig { returns(T.nilable(String)) } + attr_reader :mime + + sig { params(mime: String).void } + attr_writer :mime + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the file in bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :size + + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail + + sig { params(thumbnail: String).void } + attr_writer :thumbnail + + # Type of the asset. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :updated_at + + sig { params(updated_at: String).void } + attr_writer :updated_at + + # URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object with details of the file version. + sig do + returns( + T.nilable( + Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo + ) + ) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # Width of the file. + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a file or file version. + sig do + params( + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::VersionRetrieveResponse::AITag::OrHash + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo::OrHash, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the file by auto tagging. + ai_tags: nil, + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + created_at: nil, + # An string with custom coordinates of the file. + custom_coordinates: nil, + # An object with custom metadata for the file. + custom_metadata: nil, + # Unique identifier of the asset. + file_id: nil, + # 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`. + file_path: nil, + # Type of the file. Possible values are `image`, `non-image`. + file_type: nil, + # Specifies if the image has an alpha channel. + has_alpha: nil, + # Height of the file. + height: nil, + # Specifies if the file is private or not. + is_private_file: nil, + # Specifies if the file is published or not. + is_published: nil, + # MIME type of the file. + mime: nil, + # Name of the asset. + name: nil, + # Size of the file in bytes. + size: nil, + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + tags: nil, + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + thumbnail: nil, + # Type of the asset. + type: nil, + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + updated_at: nil, + # URL of the file. + url: nil, + # An object with details of the file version. + version_info: nil, + # Width of the file. + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Files::VersionRetrieveResponse::AITag + ] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionRetrieveResponse::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + source: nil + ) + end + + sig do + override.returns( + { confidence: Float, name: String, source: String } + ) + end + def to_hash + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object with details of the file version. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end + end +end diff --git a/rbi/imagekit/models/folder_create_params.rbi b/rbi/imagekit/models/folder_create_params.rbi new file mode 100644 index 00000000..c33e9c28 --- /dev/null +++ b/rbi/imagekit/models/folder_create_params.rbi @@ -0,0 +1,71 @@ +# typed: strong + +module Imagekit + module Models + class FolderCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FolderCreateParams, Imagekit::Internal::AnyHash) + end + + # 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. + # `_`. + sig { returns(String) } + attr_accessor :folder_name + + # 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. + sig { returns(String) } + attr_accessor :parent_folder_path + + sig do + params( + folder_name: String, + parent_folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + # `_`. + folder_name:, + # 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. + parent_folder_path:, + request_options: {} + ) + end + + sig do + override.returns( + { + folder_name: String, + parent_folder_path: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/folder_create_response.rbi b/rbi/imagekit/models/folder_create_response.rbi new file mode 100644 index 00000000..eead7e4e --- /dev/null +++ b/rbi/imagekit/models/folder_create_response.rbi @@ -0,0 +1,8 @@ +# typed: strong + +module Imagekit + module Models + FolderCreateResponse = + T.let(T.anything, Imagekit::Internal::Type::Converter) + end +end diff --git a/rbi/imagekit/models/folder_delete_params.rbi b/rbi/imagekit/models/folder_delete_params.rbi new file mode 100644 index 00000000..09e1c54c --- /dev/null +++ b/rbi/imagekit/models/folder_delete_params.rbi @@ -0,0 +1,40 @@ +# typed: strong + +module Imagekit + module Models + class FolderDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FolderDeleteParams, Imagekit::Internal::AnyHash) + end + + # Full path to the folder you want to delete. For example `/folder/to/delete/`. + sig { returns(String) } + attr_accessor :folder_path + + sig do + params( + folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Full path to the folder you want to delete. For example `/folder/to/delete/`. + folder_path:, + request_options: {} + ) + end + + sig do + override.returns( + { folder_path: String, request_options: Imagekit::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/folder_delete_response.rbi b/rbi/imagekit/models/folder_delete_response.rbi new file mode 100644 index 00000000..1bc93ebe --- /dev/null +++ b/rbi/imagekit/models/folder_delete_response.rbi @@ -0,0 +1,8 @@ +# typed: strong + +module Imagekit + module Models + FolderDeleteResponse = + T.let(T.anything, Imagekit::Internal::Type::Converter) + end +end diff --git a/rbi/imagekit/models/gps.rbi b/rbi/imagekit/models/gps.rbi new file mode 100644 index 00000000..57931ca6 --- /dev/null +++ b/rbi/imagekit/models/gps.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekit + module Models + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Imagekit::Gps, Imagekit::Internal::AnyHash) } + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns(T.attached_class) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/interoperability.rbi b/rbi/imagekit/models/interoperability.rbi new file mode 100644 index 00000000..69123b0b --- /dev/null +++ b/rbi/imagekit/models/interoperability.rbi @@ -0,0 +1,39 @@ +# typed: strong + +module Imagekit + module Models + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Interoperability, Imagekit::Internal::AnyHash) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns({ interop_index: String, interop_version: String }) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/thumbnail.rbi b/rbi/imagekit/models/thumbnail.rbi new file mode 100644 index 00000000..e35978ae --- /dev/null +++ b/rbi/imagekit/models/thumbnail.rbi @@ -0,0 +1,82 @@ +# typed: strong + +module Imagekit + module Models + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Imagekit::Thumbnail, Imagekit::Internal::AnyHash) } + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/request_options.rbi b/rbi/imagekit/request_options.rbi new file mode 100644 index 00000000..8f934bd4 --- /dev/null +++ b/rbi/imagekit/request_options.rbi @@ -0,0 +1,59 @@ +# typed: strong + +module Imagekit + # Specify HTTP behaviour to use for a specific request. These options supplement + # or override those provided at the client level. + # + # When making a request, you can pass an actual {RequestOptions} instance, or + # simply pass a Hash with symbol keys matching the attributes on this class. + class RequestOptions < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::RequestOptions, Imagekit::Internal::AnyHash) + end + + # @api private + sig { params(opts: Imagekit::RequestOptions::OrHash).void } + def self.validate!(opts) + end + + # Idempotency key to send with request and all associated retries. Will only be + # sent for write requests. + sig { returns(T.nilable(String)) } + attr_accessor :idempotency_key + + # Extra query params to send with the request. These are `.merge`’d into any + # `query` given at the client level. + sig do + returns( + T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]) + ) + end + attr_accessor :extra_query + + # Extra headers to send with the request. These are `.merged`’d into any + # `extra_headers` given at the client level. + sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) } + attr_accessor :extra_headers + + # Extra data to send with the request. These are deep merged into any data + # generated as part of the normal request. + sig { returns(T.nilable(T.anything)) } + attr_accessor :extra_body + + # Maximum number of retries to attempt after a failed initial request. + sig { returns(T.nilable(Integer)) } + attr_accessor :max_retries + + # Request timeout in seconds. + sig { returns(T.nilable(Float)) } + attr_accessor :timeout + + # Returns a new instance of RequestOptions. + sig do + params(values: Imagekit::Internal::AnyHash).returns(T.attached_class) + end + def self.new(values = {}) + end + end +end diff --git a/rbi/imagekit/resources/accounts.rbi b/rbi/imagekit/resources/accounts.rbi new file mode 100644 index 00000000..4b2834bb --- /dev/null +++ b/rbi/imagekit/resources/accounts.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekit + module Resources + class Accounts + # 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. + sig do + params( + end_date: Date, + start_date: Date, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::AccountGetUsageResponse) + end + def get_usage( + # 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. + end_date:, + # 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. + start_date:, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/bulk_jobs.rbi b/rbi/imagekit/resources/bulk_jobs.rbi new file mode 100644 index 00000000..66a96c6e --- /dev/null +++ b/rbi/imagekit/resources/bulk_jobs.rbi @@ -0,0 +1,75 @@ +# typed: strong + +module Imagekit + module Resources + class BulkJobs + # 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. + sig do + params( + destination_path: String, + source_folder_path: String, + include_versions: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::BulkJobCopyFolderResponse) + end + def copy_folder( + # Full path to the destination folder where you want to copy the source folder + # into. + destination_path:, + # The full path to the source folder you want to copy. + source_folder_path:, + # 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`. + include_versions: nil, + request_options: {} + ) + end + + # 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. + sig do + params( + destination_path: String, + source_folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::BulkJobMoveFolderResponse) + end + def move_folder( + # Full path to the destination folder where you want to move the source folder + # into. + destination_path:, + # The full path to the source folder you want to move. + source_folder_path:, + request_options: {} + ) + end + + # This API returns the status of a bulk job like copy and move folder operations. + sig do + params( + job_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::BulkJobRetrieveStatusResponse) + end + def retrieve_status( + # The `jobId` is returned in the response of bulk job API e.g. copy folder or move + # folder API. + job_id, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/custom_metadata_fields.rbi b/rbi/imagekit/resources/custom_metadata_fields.rbi new file mode 100644 index 00000000..bd07c8e6 --- /dev/null +++ b/rbi/imagekit/resources/custom_metadata_fields.rbi @@ -0,0 +1,98 @@ +# typed: strong + +module Imagekit + module Resources + class CustomMetadataFields + # 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. + sig do + params( + label: String, + name: String, + schema: Imagekit::CustomMetadataFieldCreateParams::Schema::OrHash, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::CustomMetadataFieldCreateResponse) + end + def create( + # 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. + label:, + # API name of the custom metadata field. This should be unique across all + # (including deleted) custom metadata fields. + name:, + schema:, + request_options: {} + ) + end + + # This API updates the label or schema of an existing custom metadata field. + sig do + params( + id: String, + label: String, + schema: Imagekit::CustomMetadataFieldUpdateParams::Schema::OrHash, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::CustomMetadataFieldUpdateResponse) + end + def update( + # Should be a valid custom metadata field id. + id, + # 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. + label: nil, + # 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`. + schema: nil, + request_options: {} + ) + end + + # 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. + sig do + params( + include_deleted: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns( + T::Array[Imagekit::Models::CustomMetadataFieldListResponseItem] + ) + end + def list( + # Set it to `true` to include deleted field objects in the API response. Default + # value is `false`. + include_deleted: nil, + request_options: {} + ) + end + + # 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. + sig do + params( + id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.anything) + end + def delete( + # Should be a valid custom metadata field id. + id, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi new file mode 100644 index 00000000..47c0541c --- /dev/null +++ b/rbi/imagekit/resources/files.rbi @@ -0,0 +1,647 @@ +# typed: strong + +module Imagekit + module Resources + class Files + sig { returns(Imagekit::Resources::Files::Details) } + attr_reader :details + + sig { returns(Imagekit::Resources::Files::Batch) } + attr_reader :batch + + sig { returns(Imagekit::Resources::Files::Versions) } + attr_reader :versions + + sig { returns(Imagekit::Resources::Files::Purge) } + attr_reader :purge + + sig { returns(Imagekit::Resources::Files::Metadata) } + attr_reader :metadata + + # 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`. + sig do + params( + file_type: String, + limit: String, + path: String, + search_query: String, + skip: String, + sort: String, + type: Imagekit::FileListParams::Type::OrSymbol, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T::Array[Imagekit::Models::FileListResponseItem]) + end + def list( + # Type of files to include in the result set. Accepts three values: + # + # `all` - include all types of files in the result set. `image` - only search in + # image type files. `non-image` - only search in files that are not images, e.g., + # JS or CSS or video files. + # + # Default value - `all` + file_type: nil, + # The maximum number of results to return in response: + # + # Minimum value - 1 + # + # Maximum value - 1000 + # + # Default value - 1000 + limit: nil, + # Folder path if you want to limit the search within a specific folder. For + # example, `/sales-banner/` will only search in folder sales-banner. + path: nil, + # 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. + search_query: nil, + # The number of results to skip before returning results: + # + # Minimum value - 0 + # + # Default value - 0 + skip: nil, + # You can sort based on the following fields: + # + # 1. name - `ASC_NAME` or `DESC_NAME` + # 2. createdAt - `ASC_CREATED` or `DESC_CREATED` + # 3. updatedAt - `ASC_UPDATED` or `DESC_UPDATED` + # 4. height - `ASC_HEIGHT` or `DESC_HEIGHT` + # 5. width - `ASC_WIDTH` or `DESC_WIDTH` + # 6. size - `ASC_SIZE` or `DESC_SIZE` + # + # Default value - `ASC_CREATED` + sort: nil, + # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to + # include `files` and `folders` in search results (`file-version` will not be + # included in this case). + # + # Default value - `file` + type: nil, + request_options: {} + ) + end + + # 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. + sig do + params( + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).void + end + def delete( + # The unique `fileId` of the uploaded file. `fileId` is returned in list and + # search assets API and upload API. + file_id, + request_options: {} + ) + end + + # This API adds tags to multiple files in bulk. A maximum of 50 files can be + # specified at a time. + sig do + params( + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FileAddTagsResponse) + end + def add_tags( + # An array of fileIds to which you want to add tags. + file_ids:, + # An array of tags that you want to add to the files. + tags:, + request_options: {} + ) + end + + # 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. + sig do + params( + destination_path: String, + source_file_path: String, + include_file_versions: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.anything) + end + def copy( + # Full path to the folder you want to copy the above file into. + destination_path:, + # The full path of the file you want to copy. + source_file_path:, + # 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`. + include_file_versions: nil, + request_options: {} + ) + end + + # 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. + sig do + params( + destination_path: String, + source_file_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.anything) + end + def move( + # Full path to the folder you want to move the above file into. + destination_path:, + # The full path of the file you want to move. + source_file_path:, + request_options: {} + ) + end + + # This API removes AITags from multiple files in bulk. A maximum of 50 files can + # be specified at a time. + sig do + params( + ai_tags: T::Array[String], + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FileRemoveAITagsResponse) + end + def remove_ai_tags( + # An array of AITags that you want to remove from the files. + ai_tags:, + # An array of fileIds from which you want to remove AITags. + file_ids:, + request_options: {} + ) + end + + # This API removes tags from multiple files in bulk. A maximum of 50 files can be + # specified at a time. + sig do + params( + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FileRemoveTagsResponse) + end + def remove_tags( + # An array of fileIds from which you want to remove tags. + file_ids:, + # An array of tags that you want to remove from the files. + tags:, + request_options: {} + ) + end + + # 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. + sig do + params( + file_path: String, + new_file_name: String, + purge_cache: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FileRenameResponse) + end + def rename( + # The full path of the file you want to rename. + file_path:, + # 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 `_`. + new_file_name:, + # 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` + purge_cache: nil, + request_options: {} + ) + end + + # 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 `expiration` + # 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. + sig do + params( + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + expire: String, + extensions: String, + folder: String, + is_private_file: + Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol, + is_published: Imagekit::FileUploadV1Params::IsPublished::OrSymbol, + overwrite_ai_tags: + Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol, + overwrite_custom_metadata: + Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol, + overwrite_file: String, + overwrite_tags: Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol, + public_key: String, + response_fields: String, + signature: String, + tags: String, + transformation: String, + use_unique_file_name: + Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol, + webhook_url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FileUploadV1Response) + end + def upload_v1( + # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, + # please ensure that our servers can access the URL. In case ImageKit is unable to + # download the file from the specified URL, a `400` error response is returned. + # This will also result in a `400` error if the file download request is aborted + # if response headers are not received in 8 seconds. + 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 `_` + file_name:, + # 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. + token: nil, + # Server-side checks to run on the asset. Read more about + # [Upload API checks](/docs/api-reference/upload-file/upload-file#upload-api-checks). + checks: nil, + # 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. + custom_coordinates: nil, + # Stringified JSON key-value data to be associated with the asset. + custom_metadata: nil, + # 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. + expire: nil, + # Stringified JSON object with an array of extensions to be applied to the image. + # Refer to extensions schema in + # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + extensions: nil, + # 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. + folder: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # 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. + overwrite_ai_tags: nil, + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + overwrite_custom_metadata: nil, + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + overwrite_file: nil, + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + overwrite_tags: nil, + # Your ImageKit.io public key. This field is only required for authentication when + # uploading a file from the client side. + public_key: nil, + # Comma-separated values of the fields that you want the API to return in the + # response. + # + # For example, set the value of this field to + # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, + # `customCoordinates`, and `isPrivateFile` in the response. + # + # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, + # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + response_fields: nil, + # 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. + signature: nil, + # Set the tags while uploading the file. + # + # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length + # of all characters should not exceed 500. `%` is not allowed. + # + # If this field is not specified and the file is overwritten then the tags will be + # removed. + tags: nil, + # Stringified JSON object with properties for pre and post transformations: + # + # `pre` - Accepts a "string" containing a valid transformation used for requesting + # a pre-transformation for an image or a video file. + # + # `post` - Accepts an array of objects with properties: + # + # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` + # (Adaptive bitrate streaming). + # - `value`: A "string" corresponding to the required transformation. Required if + # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or + # `thumbnail`. + # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # + # Read more about + # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + transformation: nil, + # 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. + use_unique_file_name: nil, + # 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. + webhook_url: nil, + request_options: {} + ) + end + + # 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. + # + # **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. + sig do + params( + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + extensions: String, + folder: String, + is_private_file: + Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol, + is_published: Imagekit::FileUploadV2Params::IsPublished::OrSymbol, + overwrite_ai_tags: + Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol, + overwrite_custom_metadata: + Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol, + overwrite_file: String, + overwrite_tags: Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol, + response_fields: String, + tags: String, + transformation: String, + use_unique_file_name: + Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol, + webhook_url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FileUploadV2Response) + end + def upload_v2( + # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, + # please ensure that our servers can access the URL. In case ImageKit is unable to + # download the file from the specified URL, a `400` error response is returned. + # This will also result in a `400` error if the file download request is aborted + # if response headers are not received in 8 seconds. + file:, + # The name with which the file has to be uploaded. + file_name:, + # 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. + token: nil, + # 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). + checks: nil, + # 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. + custom_coordinates: nil, + # Stringified JSON key-value data to be associated with the asset. + custom_metadata: nil, + # Stringified JSON object with an array of extensions to be applied to the image. + # Refer to extensions schema in + # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + extensions: nil, + # 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. + folder: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # 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. + overwrite_ai_tags: nil, + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + overwrite_custom_metadata: nil, + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + overwrite_file: nil, + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + overwrite_tags: nil, + # Comma-separated values of the fields that you want the API to return in the + # response. + # + # For example, set the value of this field to + # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, + # `customCoordinates`, and `isPrivateFile` in the response. + # + # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, + # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + response_fields: nil, + # Set the tags while uploading the file. + # + # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length + # of all characters should not exceed 500. `%` is not allowed. + # + # If this field is not specified and the file is overwritten then the tags will be + # removed. + tags: nil, + # Stringified JSON object with properties for pre and post transformations: + # + # `pre` - Accepts a "string" containing a valid transformation used for requesting + # a pre-transformation for an image or a video file. + # + # `post` - Accepts an array of objects with properties: + # + # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` + # (Adaptive bitrate streaming). + # - `value`: A "string" corresponding to the required transformation. Required if + # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or + # `thumbnail`. + # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # + # Read more about + # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + transformation: nil, + # 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. + use_unique_file_name: nil, + # 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. + webhook_url: nil, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/files/batch.rbi b/rbi/imagekit/resources/files/batch.rbi new file mode 100644 index 00000000..684f97dd --- /dev/null +++ b/rbi/imagekit/resources/files/batch.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekit + module Resources + class Files + class Batch + # 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. + sig do + params( + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::BatchDeleteResponse) + end + def delete( + # An array of fileIds which you want to delete. + file_ids:, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/files/details.rbi b/rbi/imagekit/resources/files/details.rbi new file mode 100644 index 00000000..88868ad2 --- /dev/null +++ b/rbi/imagekit/resources/files/details.rbi @@ -0,0 +1,93 @@ +# typed: strong + +module Imagekit + module Resources + class Files + class Details + # This API returns an object with details or attributes about the current version + # of the file. + sig do + params( + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::DetailRetrieveResponse) + end + def retrieve( + # The unique `fileId` of the uploaded file. `fileId` is returned in the list and + # search assets API and upload API. + file_id, + request_options: {} + ) + end + + # 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. + sig do + params( + file_id: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + extensions: + T::Array[ + T.any( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::OrHash + ) + ], + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol + ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::Files::DetailUpdateParams::Publish::OrHash, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::DetailUpdateResponse) + end + def update( + # The unique `fileId` of the uploaded file. `fileId` is returned in list and + # search assets API and upload API. + file_id, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, + # Configure the publication status of a file and its versions. + publish: nil, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/files/metadata.rbi b/rbi/imagekit/resources/files/metadata.rbi new file mode 100644 index 00000000..53e8ea45 --- /dev/null +++ b/rbi/imagekit/resources/files/metadata.rbi @@ -0,0 +1,49 @@ +# typed: strong + +module Imagekit + module Resources + class Files + class Metadata + # 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. + sig do + params( + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::MetadataRetrieveResponse) + end + def retrieve( + # The unique `fileId` of the uploaded file. `fileId` is returned in the list and + # search assets API and upload API. + file_id, + request_options: {} + ) + end + + # Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL + # using this API. + sig do + params( + url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::MetadataFromURLResponse) + end + def from_url( + # Should be a valid file URL. It should be accessible using your ImageKit.io + # account. + url:, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/files/purge.rbi b/rbi/imagekit/resources/files/purge.rbi new file mode 100644 index 00000000..8c196172 --- /dev/null +++ b/rbi/imagekit/resources/files/purge.rbi @@ -0,0 +1,44 @@ +# typed: strong + +module Imagekit + module Resources + class Files + class Purge + # 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. + sig do + params( + url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::PurgeExecuteResponse) + end + def execute( + # The full URL of the file to be purged. + url:, + request_options: {} + ) + end + + # This API returns the status of a purge cache request. + sig do + params( + request_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::PurgeStatusResponse) + end + def status( + # Should be a valid requestId. + request_id, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/files/versions.rbi b/rbi/imagekit/resources/files/versions.rbi new file mode 100644 index 00000000..ee36ab8c --- /dev/null +++ b/rbi/imagekit/resources/files/versions.rbi @@ -0,0 +1,89 @@ +# typed: strong + +module Imagekit + module Resources + class Files + class Versions + # This API returns an object with details or attributes of a file version. + sig do + params( + version_id: String, + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::VersionRetrieveResponse) + end + def retrieve( + # The unique `versionId` of the uploaded file. `versionId` is returned in list and + # search assets API and upload API. + version_id, + # The unique `fileId` of the uploaded file. `fileId` is returned in list and + # search assets API and upload API. + file_id:, + request_options: {} + ) + end + + # This API returns details of all versions of a file. + sig do + params( + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T::Array[Imagekit::Models::Files::VersionListResponseItem]) + end + def list( + # The unique `fileId` of the uploaded file. `fileId` is returned in list and + # search assets API and upload API. + file_id, + request_options: {} + ) + end + + # 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. + sig do + params( + version_id: String, + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.anything) + end + def delete( + # The unique `versionId` of the uploaded file. `versionId` is returned in list and + # search assets API and upload API. + version_id, + # The unique `fileId` of the uploaded file. `fileId` is returned in list and + # search assets API and upload API. + file_id:, + request_options: {} + ) + end + + # This API restores a file version as the current file version. + sig do + params( + version_id: String, + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::VersionRestoreResponse) + end + def restore( + # The unique `versionId` of the uploaded file. `versionId` is returned in list and + # search assets API and upload API. + version_id, + # The unique `fileId` of the uploaded file. `fileId` is returned in list and + # search assets API and upload API. + file_id:, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/folder.rbi b/rbi/imagekit/resources/folder.rbi new file mode 100644 index 00000000..f89a3b45 --- /dev/null +++ b/rbi/imagekit/resources/folder.rbi @@ -0,0 +1,55 @@ +# typed: strong + +module Imagekit + module Resources + class Folder + # 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. + sig do + params( + folder_name: String, + parent_folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.anything) + end + def create( + # 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. + # `_`. + folder_name:, + # 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. + parent_folder_path:, + request_options: {} + ) + end + + # This will delete a folder and all its contents permanently. The API returns an + # empty response. + sig do + params( + folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.anything) + end + def delete( + # Full path to the folder you want to delete. For example `/folder/to/delete/`. + folder_path:, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/version.rbi b/rbi/imagekit/version.rbi new file mode 100644 index 00000000..dd908e9e --- /dev/null +++ b/rbi/imagekit/version.rbi @@ -0,0 +1,5 @@ +# typed: strong + +module Imagekit + VERSION = T.let(T.unsafe(nil), String) +end diff --git a/scripts/bootstrap b/scripts/bootstrap new file mode 100755 index 00000000..cc31aa85 --- /dev/null +++ b/scripts/bootstrap @@ -0,0 +1,16 @@ +#!/usr/bin/env bash + +set -e + +cd -- "$(dirname -- "$0")/.." + +if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ]; then + brew bundle check >/dev/null 2>&1 || { + echo "==> Installing Homebrew dependencies…" + brew bundle + } +fi + +echo "==> Installing Ruby dependencies…" + +exec -- bundle install "$@" diff --git a/scripts/format b/scripts/format new file mode 100755 index 00000000..177d1e63 --- /dev/null +++ b/scripts/format @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -e + +cd -- "$(dirname -- "$0")/.." + +echo "==> Running formatters" + +exec -- bundle exec rake format "$@" diff --git a/scripts/lint b/scripts/lint new file mode 100755 index 00000000..08b0dbeb --- /dev/null +++ b/scripts/lint @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -e + +cd -- "$(dirname -- "$0")/.." + +echo "==> Running linters" + +exec -- bundle exec rake lint "$@" 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..e0dc1374 --- /dev/null +++ b/scripts/test @@ -0,0 +1,56 @@ +#!/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 + +echo "==> Running tests" +bundle exec rake test "$@" diff --git a/sig/imagekit/client.rbs b/sig/imagekit/client.rbs new file mode 100644 index 00000000..7dddd06d --- /dev/null +++ b/sig/imagekit/client.rbs @@ -0,0 +1,39 @@ +module Imagekit + class Client < Imagekit::Internal::Transport::BaseClient + DEFAULT_MAX_RETRIES: 2 + + DEFAULT_TIMEOUT_IN_SECONDS: Float + + DEFAULT_INITIAL_RETRY_DELAY: Float + + DEFAULT_MAX_RETRY_DELAY: Float + + attr_reader private_api_key: String + + attr_reader password: String? + + attr_reader custom_metadata_fields: Imagekit::Resources::CustomMetadataFields + + attr_reader files: Imagekit::Resources::Files + + attr_reader folder: Imagekit::Resources::Folder + + attr_reader bulk_jobs: Imagekit::Resources::BulkJobs + + attr_reader accounts: Imagekit::Resources::Accounts + + private def auth_headers: -> ::Hash[String, String] + + def base_url_overridden?: -> bool + + def initialize: ( + ?private_api_key: String?, + ?password: String?, + ?base_url: String?, + ?max_retries: Integer, + ?timeout: Float, + ?initial_retry_delay: Float, + ?max_retry_delay: Float + ) -> void + end +end diff --git a/sig/imagekit/errors.rbs b/sig/imagekit/errors.rbs new file mode 100644 index 00000000..40508602 --- /dev/null +++ b/sig/imagekit/errors.rbs @@ -0,0 +1,110 @@ +module Imagekit + module Errors + class Error < StandardError + attr_accessor cause: StandardError? + end + + class ConversionError < Imagekit::Errors::Error + def cause: -> StandardError? + + def initialize: ( + on: Class, + method: Symbol, + target: top, + value: top, + ?cause: StandardError? + ) -> void + end + + class APIError < Imagekit::Errors::Error + attr_accessor url: URI::Generic + + attr_accessor status: Integer? + + attr_accessor body: top? + + def initialize: ( + url: URI::Generic, + ?status: Integer?, + ?body: Object?, + ?request: nil, + ?response: nil, + ?message: String? + ) -> void + end + + class APIConnectionError < Imagekit::Errors::APIError + def initialize: ( + url: URI::Generic, + ?status: nil, + ?body: nil, + ?request: nil, + ?response: nil, + ?message: String? + ) -> void + end + + class APITimeoutError < Imagekit::Errors::APIConnectionError + def initialize: ( + url: URI::Generic, + ?status: nil, + ?body: nil, + ?request: nil, + ?response: nil, + ?message: String? + ) -> void + end + + class APIStatusError < Imagekit::Errors::APIError + def self.for: ( + url: URI::Generic, + status: Integer, + body: Object?, + request: nil, + response: nil, + ?message: String? + ) -> instance + + def initialize: ( + url: URI::Generic, + status: Integer, + body: Object?, + request: nil, + response: nil, + ?message: String? + ) -> void + end + + class BadRequestError < Imagekit::Errors::APIStatusError + HTTP_STATUS: 400 + end + + class AuthenticationError < Imagekit::Errors::APIStatusError + HTTP_STATUS: 401 + end + + class PermissionDeniedError < Imagekit::Errors::APIStatusError + HTTP_STATUS: 403 + end + + class NotFoundError < Imagekit::Errors::APIStatusError + HTTP_STATUS: 404 + end + + class ConflictError < Imagekit::Errors::APIStatusError + HTTP_STATUS: 409 + end + + class UnprocessableEntityError < Imagekit::Errors::APIStatusError + HTTP_STATUS: 422 + end + + class RateLimitError < Imagekit::Errors::APIStatusError + HTTP_STATUS: 429 + end + + class InternalServerError < Imagekit::Errors::APIStatusError + HTTP_STATUS: Range[Integer] + end + end +end diff --git a/sig/imagekit/file_part.rbs b/sig/imagekit/file_part.rbs new file mode 100644 index 00000000..3a8befa0 --- /dev/null +++ b/sig/imagekit/file_part.rbs @@ -0,0 +1,21 @@ +module Imagekit + class FilePart + attr_reader content: Pathname | StringIO | IO | String + + attr_reader content_type: String? + + attr_reader filename: String? + + private def read: -> String + + def to_json: (*top a) -> String + + def to_yaml: (*top a) -> String + + def initialize: ( + Pathname | StringIO | IO | String content, + ?filename: String?, + ?content_type: String? + ) -> void + end +end diff --git a/sig/imagekit/internal.rbs b/sig/imagekit/internal.rbs new file mode 100644 index 00000000..90664cb4 --- /dev/null +++ b/sig/imagekit/internal.rbs @@ -0,0 +1,9 @@ +module Imagekit + module Internal + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + type file_input = Pathname | StringIO | IO | String | Imagekit::FilePart + + OMIT: Object + end +end diff --git a/sig/imagekit/internal/transport/base_client.rbs b/sig/imagekit/internal/transport/base_client.rbs new file mode 100644 index 00000000..420b711d --- /dev/null +++ b/sig/imagekit/internal/transport/base_client.rbs @@ -0,0 +1,131 @@ +module Imagekit + module Internal + module Transport + class BaseClient + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + type request_components = + { + method: Symbol, + path: String | ::Array[String], + query: ::Hash[String, (::Array[String] | String)?]?, + headers: ::Hash[String, (String + | Integer + | ::Array[(String | Integer)?])?]?, + body: top?, + unwrap: (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))?, + page: Class?, + stream: Class?, + model: Imagekit::Internal::Type::Converter::input?, + options: Imagekit::request_opts? + } + type request_input = + { + method: Symbol, + url: URI::Generic, + headers: ::Hash[String, String], + body: top, + max_retries: Integer, + timeout: Float + } + + MAX_REDIRECTS: 20 + + PLATFORM_HEADERS: ::Hash[String, String] + + def self.validate!: ( + Imagekit::Internal::Transport::BaseClient::request_components req + ) -> void + + def self.should_retry?: ( + Integer status, + headers: ::Hash[String, String] + ) -> bool + + def self.follow_redirect: ( + Imagekit::Internal::Transport::BaseClient::request_input request, + status: Integer, + response_headers: ::Hash[String, String] + ) -> Imagekit::Internal::Transport::BaseClient::request_input + + def self.reap_connection!: ( + Integer | Imagekit::Errors::APIConnectionError status, + stream: Enumerable[String]? + ) -> void + + attr_reader base_url: URI::Generic + + attr_reader timeout: Float + + attr_reader max_retries: Integer + + attr_reader initial_retry_delay: Float + + attr_reader max_retry_delay: Float + + attr_reader headers: ::Hash[String, String] + + attr_reader idempotency_header: String? + + # @api private + attr_reader requester: Imagekit::Internal::Transport::PooledNetRequester + + def initialize: ( + base_url: String, + ?timeout: Float, + ?max_retries: Integer, + ?initial_retry_delay: Float, + ?max_retry_delay: Float, + ?headers: ::Hash[String, (String + | Integer + | ::Array[(String | Integer)?])?], + ?idempotency_header: String? + ) -> void + + private def auth_headers: -> ::Hash[String, String] + + private def generate_idempotency_key: -> String + + private def build_request: ( + Imagekit::Internal::Transport::BaseClient::request_components req, + Imagekit::request_options opts + ) -> Imagekit::Internal::Transport::BaseClient::request_input + + private def retry_delay: ( + ::Hash[String, String] headers, + retry_count: Integer + ) -> Float + + def send_request: ( + Imagekit::Internal::Transport::BaseClient::request_input request, + redirect_count: Integer, + retry_count: Integer, + send_retry_header: bool + ) -> [Integer, top, Enumerable[String]] + + def request: ( + Symbol method, + String | ::Array[String] path, + ?query: ::Hash[String, (::Array[String] | String)?]?, + ?headers: ::Hash[String, (String + | Integer + | ::Array[(String | Integer)?])?]?, + ?body: top?, + ?unwrap: (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))?, + ?page: Class?, + ?stream: Class?, + ?model: Imagekit::Internal::Type::Converter::input?, + ?options: Imagekit::request_opts? + ) -> top + + def inspect: -> String + end + end + end +end diff --git a/sig/imagekit/internal/transport/pooled_net_requester.rbs b/sig/imagekit/internal/transport/pooled_net_requester.rbs new file mode 100644 index 00000000..281ecf51 --- /dev/null +++ b/sig/imagekit/internal/transport/pooled_net_requester.rbs @@ -0,0 +1,45 @@ +module Imagekit + module Internal + module Transport + class PooledNetRequester + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + type request = + { + method: Symbol, + url: URI::Generic, + headers: ::Hash[String, String], + body: top, + deadline: Float + } + + KEEP_ALIVE_TIMEOUT: 30 + + DEFAULT_MAX_CONNECTIONS: Integer + + def self.connect: (URI::Generic url) -> top + + def self.calibrate_socket_timeout: (top conn, Float deadline) -> void + + def self.build_request: ( + Imagekit::Internal::Transport::PooledNetRequester::request request + ) { + (String arg0) -> void + } -> [top, (^-> void)] + + private def with_pool: ( + URI::Generic url, + deadline: Float + ) { + (top arg0) -> void + } -> void + + def execute: ( + Imagekit::Internal::Transport::PooledNetRequester::request request + ) -> [Integer, top, Enumerable[String]] + + def initialize: (?size: Integer) -> void + end + end + end +end diff --git a/sig/imagekit/internal/type/array_of.rbs b/sig/imagekit/internal/type/array_of.rbs new file mode 100644 index 00000000..53ceaa09 --- /dev/null +++ b/sig/imagekit/internal/type/array_of.rbs @@ -0,0 +1,48 @@ +module Imagekit + module Internal + module Type + class ArrayOf[Elem] + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + def self.[]: ( + ::Hash[Symbol, top] + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input type_info, + ?::Hash[Symbol, top] spec + ) -> instance + + def ===: (top other) -> bool + + def ==: (top other) -> bool + + def hash: -> Integer + + def coerce: ( + ::Array[top] | top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> (::Array[top] | top) + + def dump: ( + ::Array[top] | top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> (::Array[top] | top) + + def to_sorbet_type: -> top + + def item_type: -> Elem + + def nilable?: -> bool + + def initialize: ( + ::Hash[Symbol, top] + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input type_info, + ?::Hash[Symbol, top] spec + ) -> void + + def inspect: (?depth: Integer) -> String + end + end + end +end diff --git a/sig/imagekit/internal/type/base_model.rbs b/sig/imagekit/internal/type/base_model.rbs new file mode 100644 index 00000000..81e90505 --- /dev/null +++ b/sig/imagekit/internal/type/base_model.rbs @@ -0,0 +1,102 @@ +module Imagekit + module Internal + module Type + class BaseModel + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + type known_field = + { mode: (:coerce | :dump)?, required: bool, nilable: bool } + + def self.inherited: (self child) -> void + + def self.known_fields: -> ::Hash[Symbol, (Imagekit::Internal::Type::BaseModel::known_field + & { type_fn: (^-> Imagekit::Internal::Type::Converter::input) })] + + def self.fields: -> ::Hash[Symbol, (Imagekit::Internal::Type::BaseModel::known_field + & { type: Imagekit::Internal::Type::Converter::input })] + + private def self.add_field: ( + Symbol name_sym, + required: bool, + type_info: { + const: (nil | bool | Integer | Float | Symbol)?, + enum: ^-> Imagekit::Internal::Type::Converter::input?, + union: ^-> Imagekit::Internal::Type::Converter::input?, + api_name: Symbol + } + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input, + spec: ::Hash[Symbol, top] + ) -> void + + def self.required: ( + Symbol name_sym, + ::Hash[Symbol, top] + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input type_info, + ?::Hash[Symbol, top] spec + ) -> void + + def self.optional: ( + Symbol name_sym, + ::Hash[Symbol, top] + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input type_info, + ?::Hash[Symbol, top] spec + ) -> void + + private def self.request_only: { -> void } -> void + + private def self.response_only: { -> void } -> void + + def self.==: (top other) -> bool + + def self.hash: -> Integer + + def ==: (top other) -> bool + + def hash: -> Integer + + def self.coerce: ( + Imagekit::Internal::Type::BaseModel | ::Hash[top, top] | top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> (instance | top) + + def self.dump: ( + instance | top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> (::Hash[top, top] | top) + + def self.to_sorbet_type: -> top + + def self.recursively_to_h: ( + Imagekit::Internal::Type::BaseModel model, + convert: bool + ) -> ::Hash[Symbol, top] + + def []: (Symbol key) -> top? + + def to_h: -> ::Hash[Symbol, top] + + alias to_hash to_h + + def deep_to_h: -> ::Hash[Symbol, top] + + def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top] + + def to_json: (*top a) -> String + + def to_yaml: (*top a) -> String + + def initialize: (?::Hash[Symbol, top] | instance data) -> void + + def self.inspect: (?depth: Integer) -> String + + def to_s: -> String + + def inspect: -> String + end + end + end +end diff --git a/sig/imagekit/internal/type/base_page.rbs b/sig/imagekit/internal/type/base_page.rbs new file mode 100644 index 00000000..cec13b1b --- /dev/null +++ b/sig/imagekit/internal/type/base_page.rbs @@ -0,0 +1,24 @@ +module Imagekit + module Internal + module Type + module BasePage[Elem] + def next_page?: -> bool + + def next_page: -> instance + + def auto_paging_each: { (Elem arg0) -> void } -> void + + def to_enum: -> Enumerable[Elem] + + alias enum_for to_enum + + def initialize: ( + client: Imagekit::Internal::Transport::BaseClient, + req: Imagekit::Internal::Transport::BaseClient::request_components, + headers: ::Hash[String, String], + page_data: top + ) -> void + end + end + end +end diff --git a/sig/imagekit/internal/type/boolean.rbs b/sig/imagekit/internal/type/boolean.rbs new file mode 100644 index 00000000..8ff7e123 --- /dev/null +++ b/sig/imagekit/internal/type/boolean.rbs @@ -0,0 +1,26 @@ +module Imagekit + module Internal + module Type + class Boolean + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + def self.===: (top other) -> bool + + def self.==: (top other) -> bool + + def self.coerce: ( + bool | top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> (bool | top) + + def self.dump: ( + bool | top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> (bool | top) + + def self.to_sorbet_type: -> top + end + end + end +end diff --git a/sig/imagekit/internal/type/converter.rbs b/sig/imagekit/internal/type/converter.rbs new file mode 100644 index 00000000..30d3221f --- /dev/null +++ b/sig/imagekit/internal/type/converter.rbs @@ -0,0 +1,79 @@ +module Imagekit + module Internal + module Type + module Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + type input = Imagekit::Internal::Type::Converter | Class + + type coerce_state = + { + translate_names: bool, + strictness: bool, + exactness: { yes: Integer, no: Integer, maybe: Integer }, + error: Class, + branched: Integer + } + + type dump_state = { can_retry: bool } + + def coerce: ( + top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> top + + def dump: ( + top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> top + + def inspect: (?depth: Integer) -> String + + def self.type_info: ( + { + const: (nil | bool | Integer | Float | Symbol)?, + enum: ^-> Imagekit::Internal::Type::Converter::input?, + union: ^-> Imagekit::Internal::Type::Converter::input? + } + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input spec + ) -> (^-> top) + + def self.meta_info: ( + { + const: (nil | bool | Integer | Float | Symbol)?, + enum: ^-> Imagekit::Internal::Type::Converter::input?, + union: ^-> Imagekit::Internal::Type::Converter::input? + } + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input type_info, + { + const: (nil | bool | Integer | Float | Symbol)?, + enum: ^-> Imagekit::Internal::Type::Converter::input?, + union: ^-> Imagekit::Internal::Type::Converter::input? + } + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input spec + ) -> ::Hash[Symbol, top] + + def self.new_coerce_state: ( + ?translate_names: bool + ) -> Imagekit::Internal::Type::Converter::coerce_state + + def self.coerce: ( + Imagekit::Internal::Type::Converter::input target, + top value, + ?state: Imagekit::Internal::Type::Converter::coerce_state + ) -> top + + def self.dump: ( + Imagekit::Internal::Type::Converter::input target, + top value, + ?state: Imagekit::Internal::Type::Converter::dump_state + ) -> top + + def self.inspect: (top target, depth: Integer) -> String + end + end + end +end diff --git a/sig/imagekit/internal/type/enum.rbs b/sig/imagekit/internal/type/enum.rbs new file mode 100644 index 00000000..19825e23 --- /dev/null +++ b/sig/imagekit/internal/type/enum.rbs @@ -0,0 +1,32 @@ +module Imagekit + module Internal + module Type + module Enum + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)] + + def ===: (top other) -> bool + + def ==: (top other) -> bool + + def hash: -> Integer + + def coerce: ( + String | Symbol | top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> (Symbol | top) + + def dump: ( + Symbol | top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> (Symbol | top) + + def to_sorbet_type: -> top + + def inspect: (?depth: Integer) -> String + end + end + end +end diff --git a/sig/imagekit/internal/type/file_input.rbs b/sig/imagekit/internal/type/file_input.rbs new file mode 100644 index 00000000..2047a19e --- /dev/null +++ b/sig/imagekit/internal/type/file_input.rbs @@ -0,0 +1,25 @@ +module Imagekit + module Internal + module Type + class FileInput + extend Imagekit::Internal::Type::Converter + + def self.===: (top other) -> bool + + def self.==: (top other) -> bool + + def self.coerce: ( + StringIO | String | top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> (StringIO | top) + + def self.dump: ( + Pathname | StringIO | IO | String | top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> (Pathname | StringIO | IO | String | top) + + def self.to_sorbet_type: -> top + end + end + end +end diff --git a/sig/imagekit/internal/type/hash_of.rbs b/sig/imagekit/internal/type/hash_of.rbs new file mode 100644 index 00000000..898a3566 --- /dev/null +++ b/sig/imagekit/internal/type/hash_of.rbs @@ -0,0 +1,48 @@ +module Imagekit + module Internal + module Type + class HashOf[Elem] + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + def self.[]: ( + ::Hash[Symbol, top] + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input type_info, + ?::Hash[Symbol, top] spec + ) -> instance + + def ===: (top other) -> bool + + def ==: (top other) -> bool + + def hash: -> Integer + + def coerce: ( + ::Hash[top, top] | top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> (::Hash[Symbol, top] | top) + + def dump: ( + ::Hash[top, top] | top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> (::Hash[Symbol, top] | top) + + def to_sorbet_type: -> top + + def item_type: -> Elem + + def nilable?: -> bool + + def initialize: ( + ::Hash[Symbol, top] + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input type_info, + ?::Hash[Symbol, top] spec + ) -> void + + def inspect: (?depth: Integer) -> String + end + end + end +end diff --git a/sig/imagekit/internal/type/request_parameters.rbs b/sig/imagekit/internal/type/request_parameters.rbs new file mode 100644 index 00000000..33e5d91c --- /dev/null +++ b/sig/imagekit/internal/type/request_parameters.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Internal + module Type + type request_parameters = { request_options: Imagekit::request_opts } + + module RequestParameters + attr_reader request_options: Imagekit::request_opts + + def request_options=: (Imagekit::request_opts) -> Imagekit::request_opts + + module Converter + def dump_request: (top params) -> [top, ::Hash[Symbol, top]] + end + end + end + end +end diff --git a/sig/imagekit/internal/type/union.rbs b/sig/imagekit/internal/type/union.rbs new file mode 100644 index 00000000..1dcd9350 --- /dev/null +++ b/sig/imagekit/internal/type/union.rbs @@ -0,0 +1,52 @@ +module Imagekit + module Internal + module Type + module Union + include Imagekit::Internal::Type::Converter + include Imagekit::Internal::Util::SorbetRuntimeSupport + + private def self.known_variants: -> ::Array[[Symbol?, (^-> Imagekit::Internal::Type::Converter::input), ::Hash[Symbol, top]]] + + def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]] + + def self.variants: -> ::Array[top] + + private def self.discriminator: (Symbol property) -> void + + private def self.variant: ( + Symbol + | ::Hash[Symbol, top] + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input key, + ?::Hash[Symbol, top] + | ^-> Imagekit::Internal::Type::Converter::input + | Imagekit::Internal::Type::Converter::input spec + ) -> void + + private def self.resolve_variant: ( + top value + ) -> Imagekit::Internal::Type::Converter::input? + + def ===: (top other) -> bool + + def ==: (top other) -> bool + + def hash: -> Integer + + def coerce: ( + top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> top + + def dump: ( + top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> top + + def to_sorbet_type: -> top + + def inspect: (?depth: Integer) -> String + end + end + end +end diff --git a/sig/imagekit/internal/type/unknown.rbs b/sig/imagekit/internal/type/unknown.rbs new file mode 100644 index 00000000..79647fe7 --- /dev/null +++ b/sig/imagekit/internal/type/unknown.rbs @@ -0,0 +1,26 @@ +module Imagekit + module Internal + module Type + class Unknown + extend Imagekit::Internal::Type::Converter + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + def self.===: (top other) -> bool + + def self.==: (top other) -> bool + + def self.coerce: ( + top value, + state: Imagekit::Internal::Type::Converter::coerce_state + ) -> top + + def self.dump: ( + top value, + state: Imagekit::Internal::Type::Converter::dump_state + ) -> top + + def self.to_sorbet_type: -> top + end + end + end +end diff --git a/sig/imagekit/internal/util.rbs b/sig/imagekit/internal/util.rbs new file mode 100644 index 00000000..4440cd2b --- /dev/null +++ b/sig/imagekit/internal/util.rbs @@ -0,0 +1,185 @@ +module Imagekit + module Internal + module Util + extend Imagekit::Internal::Util::SorbetRuntimeSupport + + def self?.monotonic_secs: -> Float + + def self?.walk_namespaces: ( + Module | Class ns + ) -> Enumerable[(Module | Class)] + + def self?.arch: -> String + + def self?.os: -> String + + def self?.primitive?: (top input) -> bool + + def self?.coerce_boolean: (String | bool input) -> (bool | top) + + def self?.coerce_boolean!: (String | bool input) -> bool? + + def self?.coerce_integer: (String | Integer input) -> (Integer | top) + + def self?.coerce_float: (String | Integer | Float input) -> (Float | top) + + def self?.coerce_hash: (top input) -> (::Hash[top, top] | top) + + def self?.coerce_hash!: (top input) -> ::Hash[top, top]? + + def self?.deep_merge_lr: (top lhs, top rhs, ?concat: bool) -> top + + def self?.deep_merge: ( + *::Array[top] values, + ?sentinel: top?, + ?concat: bool + ) -> top + + def self?.dig: ( + ::Hash[Symbol, top] | ::Array[top] | top data, + (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))? pick + ) { + -> top? + } -> top? + + def self?.uri_origin: (URI::Generic uri) -> String + + def self?.interpolate_path: (String | ::Array[String] path) -> String + + def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]] + + def self?.encode_query: ( + ::Hash[String, (::Array[String] | String)?]? query + ) -> String? + + type parsed_uri = + { + scheme: String?, + host: String?, + port: Integer?, + path: String?, + query: ::Hash[String, ::Array[String]] + } + + def self?.parse_uri: ( + URI::Generic | String url + ) -> Imagekit::Internal::Util::parsed_uri + + def self?.unparse_uri: ( + Imagekit::Internal::Util::parsed_uri parsed + ) -> URI::Generic + + def self?.join_parsed_uri: ( + Imagekit::Internal::Util::parsed_uri lhs, + Imagekit::Internal::Util::parsed_uri rhs + ) -> URI::Generic + + def self?.normalized_headers: ( + *::Hash[String, (String + | Integer + | ::Array[(String | Integer)?])?] headers + ) -> ::Hash[String, String] + + class ReadIOAdapter + def close?: -> bool? + + def close: -> void + + private def read_enum: (Integer? max_len) -> String + + def read: (?Integer? max_len, ?String? out_string) -> String? + + def initialize: ( + String | Pathname | StringIO | Enumerable[String] src + ) { + (String arg0) -> void + } -> void + end + + def self?.writable_enum: { + (Enumerator::Yielder y) -> void + } -> Enumerable[String] + + JSON_CONTENT: Regexp + JSONL_CONTENT: Regexp + + def self?.write_multipart_content: ( + Enumerator::Yielder y, + val: top, + closing: ::Array[^-> void], + ?content_type: String? + ) -> void + + def self?.write_multipart_chunk: ( + Enumerator::Yielder y, + boundary: String, + key: Symbol | String, + val: top, + closing: ::Array[^-> void] + ) -> void + + def self?.encode_multipart_streaming: ( + top body + ) -> [String, Enumerable[String]] + + def self?.encode_content: ( + ::Hash[String, String] headers, + top body + ) -> top + + def self?.force_charset!: (String content_type, text: String) -> void + + def self?.decode_content: ( + ::Hash[String, String] headers, + stream: Enumerable[String], + ?suppress_error: bool + ) -> top + + def self?.fused_enum: ( + Enumerable[top] enum, + ?external: bool + ) { + -> void + } -> Enumerable[top] + + def self?.close_fused!: (Enumerable[top]? enum) -> void + + def self?.chain_fused: ( + Enumerable[top]? enum + ) { + (Enumerator::Yielder arg0) -> void + } -> Enumerable[top] + + type server_sent_event = + { event: String?, data: String?, id: String?, retry: Integer? } + + def self?.decode_lines: (Enumerable[String] enum) -> Enumerable[String] + + def self?.decode_sse: ( + Enumerable[String] lines + ) -> Enumerable[Imagekit::Internal::Util::server_sent_event] + + module SorbetRuntimeSupport + class MissingSorbetRuntimeError < ::RuntimeError + end + + private def sorbet_runtime_constants: -> ::Hash[Symbol, top] + + def const_missing: (Symbol name) -> void + + def sorbet_constant_defined?: (Symbol name) -> bool + + def define_sorbet_constant!: (Symbol name) { -> top } -> void + + def to_sorbet_type: -> top + + def self.to_sorbet_type: ( + Imagekit::Internal::Util::SorbetRuntimeSupport | top `type` + ) -> top + end + end + end +end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs new file mode 100644 index 00000000..01de18de --- /dev/null +++ b/sig/imagekit/models.rbs @@ -0,0 +1,53 @@ +module Imagekit + class AccountGetUsageParams = Imagekit::Models::AccountGetUsageParams + + class BulkJobCopyFolderParams = Imagekit::Models::BulkJobCopyFolderParams + + class BulkJobMoveFolderParams = Imagekit::Models::BulkJobMoveFolderParams + + class BulkJobRetrieveStatusParams = Imagekit::Models::BulkJobRetrieveStatusParams + + class CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams + + class CustomMetadataFieldDeleteParams = Imagekit::Models::CustomMetadataFieldDeleteParams + + class CustomMetadataFieldListParams = Imagekit::Models::CustomMetadataFieldListParams + + class CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + + class ExifDetails = Imagekit::Models::ExifDetails + + class ExifImage = Imagekit::Models::ExifImage + + class FileAddTagsParams = Imagekit::Models::FileAddTagsParams + + class FileCopyParams = Imagekit::Models::FileCopyParams + + class FileDeleteParams = Imagekit::Models::FileDeleteParams + + class FileListParams = Imagekit::Models::FileListParams + + class FileMoveParams = Imagekit::Models::FileMoveParams + + class FileRemoveAITagsParams = Imagekit::Models::FileRemoveAITagsParams + + class FileRemoveTagsParams = Imagekit::Models::FileRemoveTagsParams + + class FileRenameParams = Imagekit::Models::FileRenameParams + + module Files = Imagekit::Models::Files + + class FileUploadV1Params = Imagekit::Models::FileUploadV1Params + + class FileUploadV2Params = Imagekit::Models::FileUploadV2Params + + class FolderCreateParams = Imagekit::Models::FolderCreateParams + + class FolderDeleteParams = Imagekit::Models::FolderDeleteParams + + class Gps = Imagekit::Models::Gps + + class Interoperability = Imagekit::Models::Interoperability + + class Thumbnail = Imagekit::Models::Thumbnail +end diff --git a/sig/imagekit/models/account_get_usage_params.rbs b/sig/imagekit/models/account_get_usage_params.rbs new file mode 100644 index 00000000..156f6bb4 --- /dev/null +++ b/sig/imagekit/models/account_get_usage_params.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Models + type account_get_usage_params = + { end_date: Date, start_date: Date } + & Imagekit::Internal::Type::request_parameters + + class AccountGetUsageParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor end_date: Date + + attr_accessor start_date: Date + + def initialize: ( + end_date: Date, + start_date: Date, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + end_date: Date, + start_date: Date, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/account_get_usage_response.rbs b/sig/imagekit/models/account_get_usage_response.rbs new file mode 100644 index 00000000..5dcaef1d --- /dev/null +++ b/sig/imagekit/models/account_get_usage_response.rbs @@ -0,0 +1,50 @@ +module Imagekit + module Models + type account_get_usage_response = + { + bandwidth_bytes: Integer, + extension_units_count: Integer, + media_library_storage_bytes: Integer, + original_cache_storage_bytes: Integer, + video_processing_units_count: Integer + } + + class AccountGetUsageResponse < Imagekit::Internal::Type::BaseModel + attr_reader bandwidth_bytes: Integer? + + def bandwidth_bytes=: (Integer) -> Integer + + attr_reader extension_units_count: Integer? + + def extension_units_count=: (Integer) -> Integer + + attr_reader media_library_storage_bytes: Integer? + + def media_library_storage_bytes=: (Integer) -> Integer + + attr_reader original_cache_storage_bytes: Integer? + + def original_cache_storage_bytes=: (Integer) -> Integer + + attr_reader video_processing_units_count: Integer? + + def video_processing_units_count=: (Integer) -> Integer + + def initialize: ( + ?bandwidth_bytes: Integer, + ?extension_units_count: Integer, + ?media_library_storage_bytes: Integer, + ?original_cache_storage_bytes: Integer, + ?video_processing_units_count: Integer + ) -> void + + def to_hash: -> { + bandwidth_bytes: Integer, + extension_units_count: Integer, + media_library_storage_bytes: Integer, + original_cache_storage_bytes: Integer, + video_processing_units_count: Integer + } + end + end +end diff --git a/sig/imagekit/models/bulk_job_copy_folder_params.rbs b/sig/imagekit/models/bulk_job_copy_folder_params.rbs new file mode 100644 index 00000000..6eb4383f --- /dev/null +++ b/sig/imagekit/models/bulk_job_copy_folder_params.rbs @@ -0,0 +1,38 @@ +module Imagekit + module Models + type bulk_job_copy_folder_params = + { + destination_path: String, + source_folder_path: String, + include_versions: bool + } + & Imagekit::Internal::Type::request_parameters + + class BulkJobCopyFolderParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor destination_path: String + + attr_accessor source_folder_path: String + + attr_reader include_versions: bool? + + def include_versions=: (bool) -> bool + + def initialize: ( + destination_path: String, + source_folder_path: String, + ?include_versions: bool, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + destination_path: String, + source_folder_path: String, + include_versions: bool, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/bulk_job_copy_folder_response.rbs b/sig/imagekit/models/bulk_job_copy_folder_response.rbs new file mode 100644 index 00000000..6ee9d3cd --- /dev/null +++ b/sig/imagekit/models/bulk_job_copy_folder_response.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type bulk_job_copy_folder_response = { job_id: String } + + class BulkJobCopyFolderResponse < Imagekit::Internal::Type::BaseModel + attr_reader job_id: String? + + def job_id=: (String) -> String + + def initialize: (?job_id: String) -> void + + def to_hash: -> { job_id: String } + end + end +end diff --git a/sig/imagekit/models/bulk_job_move_folder_params.rbs b/sig/imagekit/models/bulk_job_move_folder_params.rbs new file mode 100644 index 00000000..5bf317fc --- /dev/null +++ b/sig/imagekit/models/bulk_job_move_folder_params.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Models + type bulk_job_move_folder_params = + { destination_path: String, source_folder_path: String } + & Imagekit::Internal::Type::request_parameters + + class BulkJobMoveFolderParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor destination_path: String + + attr_accessor source_folder_path: String + + def initialize: ( + destination_path: String, + source_folder_path: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + destination_path: String, + source_folder_path: String, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/bulk_job_move_folder_response.rbs b/sig/imagekit/models/bulk_job_move_folder_response.rbs new file mode 100644 index 00000000..b3eb218f --- /dev/null +++ b/sig/imagekit/models/bulk_job_move_folder_response.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type bulk_job_move_folder_response = { job_id: String } + + class BulkJobMoveFolderResponse < Imagekit::Internal::Type::BaseModel + attr_reader job_id: String? + + def job_id=: (String) -> String + + def initialize: (?job_id: String) -> void + + def to_hash: -> { job_id: String } + end + end +end diff --git a/sig/imagekit/models/bulk_job_retrieve_status_params.rbs b/sig/imagekit/models/bulk_job_retrieve_status_params.rbs new file mode 100644 index 00000000..8743f71f --- /dev/null +++ b/sig/imagekit/models/bulk_job_retrieve_status_params.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type bulk_job_retrieve_status_params = + { } & Imagekit::Internal::Type::request_parameters + + class BulkJobRetrieveStatusParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end +end diff --git a/sig/imagekit/models/bulk_job_retrieve_status_response.rbs b/sig/imagekit/models/bulk_job_retrieve_status_response.rbs new file mode 100644 index 00000000..805c7a28 --- /dev/null +++ b/sig/imagekit/models/bulk_job_retrieve_status_response.rbs @@ -0,0 +1,24 @@ +module Imagekit + module Models + type bulk_job_retrieve_status_response = + { job_id: String, status: String, type: String } + + class BulkJobRetrieveStatusResponse < Imagekit::Internal::Type::BaseModel + attr_reader job_id: String? + + def job_id=: (String) -> String + + attr_reader status: String? + + def status=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + def initialize: (?job_id: String, ?status: String, ?type: String) -> void + + def to_hash: -> { job_id: String, status: String, type: String } + end + end +end diff --git a/sig/imagekit/models/custom_metadata_field_create_params.rbs b/sig/imagekit/models/custom_metadata_field_create_params.rbs new file mode 100644 index 00000000..f3045dd6 --- /dev/null +++ b/sig/imagekit/models/custom_metadata_field_create_params.rbs @@ -0,0 +1,179 @@ +module Imagekit + module Models + type custom_metadata_field_create_params = + { + label: String, + name: String, + schema: Imagekit::CustomMetadataFieldCreateParams::Schema + } + & Imagekit::Internal::Type::request_parameters + + class CustomMetadataFieldCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor label: String + + attr_accessor name: String + + attr_accessor schema: Imagekit::CustomMetadataFieldCreateParams::Schema + + def initialize: ( + label: String, + name: String, + schema: Imagekit::CustomMetadataFieldCreateParams::Schema, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + label: String, + name: String, + schema: Imagekit::CustomMetadataFieldCreateParams::Schema, + request_options: Imagekit::RequestOptions + } + + type schema = + { + type: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_, + default_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] + } + + class Schema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_ + + attr_reader default_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value? + + def default_value=: ( + Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value + ) -> Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value? + + def max_value=: ( + Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value + ) -> Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value? + + def min_value=: ( + Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value + ) -> Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value + + attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] + ) -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] + + def initialize: ( + type: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_, + ?default_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value, + ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] + ) -> void + + def to_hash: -> { + type: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_, + default_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] + } + + type type_ = + :Text + | :TextArea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXT_AREA: :TextArea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member3] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type union_member3 = String | Float | bool + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member3] + end + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value] + + UnionMember3Array: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] + end + end + end + end +end diff --git a/sig/imagekit/models/custom_metadata_field_create_response.rbs b/sig/imagekit/models/custom_metadata_field_create_response.rbs new file mode 100644 index 00000000..3ba41ec2 --- /dev/null +++ b/sig/imagekit/models/custom_metadata_field_create_response.rbs @@ -0,0 +1,178 @@ +module Imagekit + module Models + type custom_metadata_field_create_response = + { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + } + + class CustomMetadataFieldCreateResponse < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor label: String + + attr_accessor name: String + + attr_accessor schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + + def initialize: ( + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + ) -> void + + def to_hash: -> { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + } + + type schema = + { + type: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_, + default_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + } + + class Schema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_ + + attr_reader default_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value? + + def default_value=: ( + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value + ) -> Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value? + + def max_value=: ( + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value + ) -> Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value? + + def min_value=: ( + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value + ) -> Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value + + attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + ) -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + + def initialize: ( + type: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_, + ?default_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value, + ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + ) -> void + + def to_hash: -> { + type: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_, + default_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + } + + type type_ = + :Text + | :TextArea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXT_AREA: :TextArea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member3] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type union_member3 = String | Float | bool + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member3] + end + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value] + + UnionMember3Array: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + end + end + end + end +end diff --git a/sig/imagekit/models/custom_metadata_field_delete_params.rbs b/sig/imagekit/models/custom_metadata_field_delete_params.rbs new file mode 100644 index 00000000..567c6c64 --- /dev/null +++ b/sig/imagekit/models/custom_metadata_field_delete_params.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type custom_metadata_field_delete_params = + { } & Imagekit::Internal::Type::request_parameters + + class CustomMetadataFieldDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end +end diff --git a/sig/imagekit/models/custom_metadata_field_delete_response.rbs b/sig/imagekit/models/custom_metadata_field_delete_response.rbs new file mode 100644 index 00000000..741f48f7 --- /dev/null +++ b/sig/imagekit/models/custom_metadata_field_delete_response.rbs @@ -0,0 +1,5 @@ +module Imagekit + module Models + CustomMetadataFieldDeleteResponse: Imagekit::Internal::Type::Converter + end +end diff --git a/sig/imagekit/models/custom_metadata_field_list_params.rbs b/sig/imagekit/models/custom_metadata_field_list_params.rbs new file mode 100644 index 00000000..314b835e --- /dev/null +++ b/sig/imagekit/models/custom_metadata_field_list_params.rbs @@ -0,0 +1,25 @@ +module Imagekit + module Models + type custom_metadata_field_list_params = + { include_deleted: bool } & Imagekit::Internal::Type::request_parameters + + class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_reader include_deleted: bool? + + def include_deleted=: (bool) -> bool + + def initialize: ( + ?include_deleted: bool, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + include_deleted: bool, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/custom_metadata_field_list_response.rbs b/sig/imagekit/models/custom_metadata_field_list_response.rbs new file mode 100644 index 00000000..bbc4aad5 --- /dev/null +++ b/sig/imagekit/models/custom_metadata_field_list_response.rbs @@ -0,0 +1,183 @@ +module Imagekit + module Models + type custom_metadata_field_list_response_item = + { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema + } + + class CustomMetadataFieldListResponseItem < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor label: String + + attr_accessor name: String + + attr_accessor schema: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema + + def initialize: ( + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema + ) -> void + + def to_hash: -> { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema + } + + type schema = + { + type: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_, + default_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] + } + + class Schema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_ + + attr_reader default_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value? + + def default_value=: ( + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value + ) -> Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value? + + def max_value=: ( + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value + ) -> Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value? + + def min_value=: ( + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value + ) -> Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value + + attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] + ) -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] + + def initialize: ( + type: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_, + ?default_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value, + ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] + ) -> void + + def to_hash: -> { + type: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_, + default_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] + } + + type type_ = + :Text + | :TextArea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXT_AREA: :TextArea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member3] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type union_member3 = String | Float | bool + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member3] + end + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value] + + UnionMember3Array: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] + end + end + end + + type custom_metadata_field_list_response = + ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem] + + CustomMetadataFieldListResponse: Imagekit::Internal::Type::Converter + end +end diff --git a/sig/imagekit/models/custom_metadata_field_update_params.rbs b/sig/imagekit/models/custom_metadata_field_update_params.rbs new file mode 100644 index 00000000..d6f1b888 --- /dev/null +++ b/sig/imagekit/models/custom_metadata_field_update_params.rbs @@ -0,0 +1,152 @@ +module Imagekit + module Models + type custom_metadata_field_update_params = + { + label: String, + schema: Imagekit::CustomMetadataFieldUpdateParams::Schema + } + & Imagekit::Internal::Type::request_parameters + + class CustomMetadataFieldUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_reader label: String? + + def label=: (String) -> String + + attr_reader schema: Imagekit::CustomMetadataFieldUpdateParams::Schema? + + def schema=: ( + Imagekit::CustomMetadataFieldUpdateParams::Schema + ) -> Imagekit::CustomMetadataFieldUpdateParams::Schema + + def initialize: ( + ?label: String, + ?schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + label: String, + schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, + request_options: Imagekit::RequestOptions + } + + type schema = + { + default_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + } + + class Schema < Imagekit::Internal::Type::BaseModel + attr_reader default_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value? + + def default_value=: ( + Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value + ) -> Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value? + + def max_value=: ( + Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value + ) -> Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value? + + def min_value=: ( + Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value + ) -> Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value + + attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + ) -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + + def initialize: ( + ?default_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value, + ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + ) -> void + + def to_hash: -> { + default_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + } + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member3] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type union_member3 = String | Float | bool + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member3] + end + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value] + + UnionMember3Array: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + end + end + end + end +end diff --git a/sig/imagekit/models/custom_metadata_field_update_response.rbs b/sig/imagekit/models/custom_metadata_field_update_response.rbs new file mode 100644 index 00000000..d46979da --- /dev/null +++ b/sig/imagekit/models/custom_metadata_field_update_response.rbs @@ -0,0 +1,178 @@ +module Imagekit + module Models + type custom_metadata_field_update_response = + { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema + } + + class CustomMetadataFieldUpdateResponse < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor label: String + + attr_accessor name: String + + attr_accessor schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema + + def initialize: ( + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema + ) -> void + + def to_hash: -> { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema + } + + type schema = + { + type: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_, + default_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] + } + + class Schema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_ + + attr_reader default_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value? + + def default_value=: ( + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value + ) -> Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value? + + def max_value=: ( + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value + ) -> Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value? + + def min_value=: ( + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value + ) -> Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value + + attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] + ) -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] + + def initialize: ( + type: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_, + ?default_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value, + ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] + ) -> void + + def to_hash: -> { + type: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_, + default_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value, + min_length: Float, + min_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] + } + + type type_ = + :Text + | :TextArea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXT_AREA: :TextArea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member3] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type union_member3 = String | Float | bool + + module UnionMember3 + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member3] + end + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value] + + UnionMember3Array: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] + end + end + end + end +end diff --git a/sig/imagekit/models/exif_details.rbs b/sig/imagekit/models/exif_details.rbs new file mode 100644 index 00000000..76edd041 --- /dev/null +++ b/sig/imagekit/models/exif_details.rbs @@ -0,0 +1,197 @@ +module Imagekit + module Models + type exif_details = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class ExifDetails < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + end +end diff --git a/sig/imagekit/models/exif_image.rbs b/sig/imagekit/models/exif_image.rbs new file mode 100644 index 00000000..684ef926 --- /dev/null +++ b/sig/imagekit/models/exif_image.rbs @@ -0,0 +1,92 @@ +module Imagekit + module Models + type exif_image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class ExifImage < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + end +end diff --git a/sig/imagekit/models/file_add_tags_params.rbs b/sig/imagekit/models/file_add_tags_params.rbs new file mode 100644 index 00000000..bad61da8 --- /dev/null +++ b/sig/imagekit/models/file_add_tags_params.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Models + type file_add_tags_params = + { file_ids: ::Array[String], tags: ::Array[String] } + & Imagekit::Internal::Type::request_parameters + + class FileAddTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_ids: ::Array[String] + + attr_accessor tags: ::Array[String] + + def initialize: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_ids: ::Array[String], + tags: ::Array[String], + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/file_add_tags_response.rbs b/sig/imagekit/models/file_add_tags_response.rbs new file mode 100644 index 00000000..e4b1caf9 --- /dev/null +++ b/sig/imagekit/models/file_add_tags_response.rbs @@ -0,0 +1,16 @@ +module Imagekit + module Models + type file_add_tags_response = + { successfully_updated_file_ids: ::Array[String] } + + class FileAddTagsResponse < Imagekit::Internal::Type::BaseModel + attr_reader successfully_updated_file_ids: ::Array[String]? + + def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] + + def initialize: (?successfully_updated_file_ids: ::Array[String]) -> void + + def to_hash: -> { successfully_updated_file_ids: ::Array[String] } + end + end +end diff --git a/sig/imagekit/models/file_copy_params.rbs b/sig/imagekit/models/file_copy_params.rbs new file mode 100644 index 00000000..46bc8a75 --- /dev/null +++ b/sig/imagekit/models/file_copy_params.rbs @@ -0,0 +1,38 @@ +module Imagekit + module Models + type file_copy_params = + { + destination_path: String, + source_file_path: String, + include_file_versions: bool + } + & Imagekit::Internal::Type::request_parameters + + class FileCopyParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor destination_path: String + + attr_accessor source_file_path: String + + attr_reader include_file_versions: bool? + + def include_file_versions=: (bool) -> bool + + def initialize: ( + destination_path: String, + source_file_path: String, + ?include_file_versions: bool, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + destination_path: String, + source_file_path: String, + include_file_versions: bool, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/file_copy_response.rbs b/sig/imagekit/models/file_copy_response.rbs new file mode 100644 index 00000000..7b6a6f8c --- /dev/null +++ b/sig/imagekit/models/file_copy_response.rbs @@ -0,0 +1,5 @@ +module Imagekit + module Models + FileCopyResponse: Imagekit::Internal::Type::Converter + end +end diff --git a/sig/imagekit/models/file_delete_params.rbs b/sig/imagekit/models/file_delete_params.rbs new file mode 100644 index 00000000..4cd8aaa5 --- /dev/null +++ b/sig/imagekit/models/file_delete_params.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type file_delete_params = + { } & Imagekit::Internal::Type::request_parameters + + class FileDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end +end diff --git a/sig/imagekit/models/file_list_params.rbs b/sig/imagekit/models/file_list_params.rbs new file mode 100644 index 00000000..5a252edd --- /dev/null +++ b/sig/imagekit/models/file_list_params.rbs @@ -0,0 +1,85 @@ +module Imagekit + module Models + type file_list_params = + { + file_type: String, + limit: String, + path: String, + search_query: String, + skip: String, + sort: String, + type: Imagekit::Models::FileListParams::type_ + } + & Imagekit::Internal::Type::request_parameters + + class FileListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader limit: String? + + def limit=: (String) -> String + + attr_reader path: String? + + def path=: (String) -> String + + attr_reader search_query: String? + + def search_query=: (String) -> String + + attr_reader skip: String? + + def skip=: (String) -> String + + attr_reader sort: String? + + def sort=: (String) -> String + + attr_reader type: Imagekit::Models::FileListParams::type_? + + def type=: ( + Imagekit::Models::FileListParams::type_ + ) -> Imagekit::Models::FileListParams::type_ + + def initialize: ( + ?file_type: String, + ?limit: String, + ?path: String, + ?search_query: String, + ?skip: String, + ?sort: String, + ?type: Imagekit::Models::FileListParams::type_, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_type: String, + limit: String, + path: String, + search_query: String, + skip: String, + sort: String, + type: Imagekit::Models::FileListParams::type_, + request_options: Imagekit::RequestOptions + } + + type type_ = :file | :"file-version" | :folder | :all + + module Type + extend Imagekit::Internal::Type::Enum + + FILE: :file + FILE_VERSION: :"file-version" + FOLDER: :folder + ALL: :all + + def self?.values: -> ::Array[Imagekit::Models::FileListParams::type_] + end + end + end +end diff --git a/sig/imagekit/models/file_list_response.rbs b/sig/imagekit/models/file_list_response.rbs new file mode 100644 index 00000000..48121562 --- /dev/null +++ b/sig/imagekit/models/file_list_response.rbs @@ -0,0 +1,202 @@ +module Imagekit + module Models + type file_list_response_item = + { + ai_tags: ::Array[Imagekit::Models::FileListResponseItem::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::FileListResponseItem::VersionInfo, + width: Float + } + + class FileListResponseItem < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::FileListResponseItem::AITag]? + + attr_reader created_at: String? + + def created_at=: (String) -> String + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader has_alpha: bool? + + def has_alpha=: (bool) -> bool + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader mime: String? + + def mime=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail: String? + + def thumbnail=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + attr_reader updated_at: String? + + def updated_at=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::FileListResponseItem::VersionInfo? + + def version_info=: ( + Imagekit::Models::FileListResponseItem::VersionInfo + ) -> Imagekit::Models::FileListResponseItem::VersionInfo + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::FileListResponseItem::AITag]?, + ?created_at: String, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?has_alpha: bool, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?mime: String, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail: String, + ?type: String, + ?updated_at: String, + ?url: String, + ?version_info: Imagekit::Models::FileListResponseItem::VersionInfo, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::FileListResponseItem::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::FileListResponseItem::VersionInfo, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + + type file_list_response = ::Array[Imagekit::Models::FileListResponseItem] + + FileListResponse: Imagekit::Internal::Type::Converter + end +end diff --git a/sig/imagekit/models/file_move_params.rbs b/sig/imagekit/models/file_move_params.rbs new file mode 100644 index 00000000..c0d6f7f6 --- /dev/null +++ b/sig/imagekit/models/file_move_params.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Models + type file_move_params = + { destination_path: String, source_file_path: String } + & Imagekit::Internal::Type::request_parameters + + class FileMoveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor destination_path: String + + attr_accessor source_file_path: String + + def initialize: ( + destination_path: String, + source_file_path: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + destination_path: String, + source_file_path: String, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/file_move_response.rbs b/sig/imagekit/models/file_move_response.rbs new file mode 100644 index 00000000..88d76170 --- /dev/null +++ b/sig/imagekit/models/file_move_response.rbs @@ -0,0 +1,5 @@ +module Imagekit + module Models + FileMoveResponse: Imagekit::Internal::Type::Converter + end +end diff --git a/sig/imagekit/models/file_remove_ai_tags_params.rbs b/sig/imagekit/models/file_remove_ai_tags_params.rbs new file mode 100644 index 00000000..882092e5 --- /dev/null +++ b/sig/imagekit/models/file_remove_ai_tags_params.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Models + type file_remove_ai_tags_params = + { ai_tags: ::Array[String], file_ids: ::Array[String] } + & Imagekit::Internal::Type::request_parameters + + class FileRemoveAITagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor ai_tags: ::Array[String] + + attr_accessor file_ids: ::Array[String] + + def initialize: ( + ai_tags: ::Array[String], + file_ids: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + ai_tags: ::Array[String], + file_ids: ::Array[String], + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/file_remove_ai_tags_response.rbs b/sig/imagekit/models/file_remove_ai_tags_response.rbs new file mode 100644 index 00000000..484935a1 --- /dev/null +++ b/sig/imagekit/models/file_remove_ai_tags_response.rbs @@ -0,0 +1,16 @@ +module Imagekit + module Models + type file_remove_ai_tags_response = + { successfully_updated_file_ids: ::Array[String] } + + class FileRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + attr_reader successfully_updated_file_ids: ::Array[String]? + + def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] + + def initialize: (?successfully_updated_file_ids: ::Array[String]) -> void + + def to_hash: -> { successfully_updated_file_ids: ::Array[String] } + end + end +end diff --git a/sig/imagekit/models/file_remove_tags_params.rbs b/sig/imagekit/models/file_remove_tags_params.rbs new file mode 100644 index 00000000..9e7ca69b --- /dev/null +++ b/sig/imagekit/models/file_remove_tags_params.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Models + type file_remove_tags_params = + { file_ids: ::Array[String], tags: ::Array[String] } + & Imagekit::Internal::Type::request_parameters + + class FileRemoveTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_ids: ::Array[String] + + attr_accessor tags: ::Array[String] + + def initialize: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_ids: ::Array[String], + tags: ::Array[String], + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/file_remove_tags_response.rbs b/sig/imagekit/models/file_remove_tags_response.rbs new file mode 100644 index 00000000..0544e0e6 --- /dev/null +++ b/sig/imagekit/models/file_remove_tags_response.rbs @@ -0,0 +1,16 @@ +module Imagekit + module Models + type file_remove_tags_response = + { successfully_updated_file_ids: ::Array[String] } + + class FileRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + attr_reader successfully_updated_file_ids: ::Array[String]? + + def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] + + def initialize: (?successfully_updated_file_ids: ::Array[String]) -> void + + def to_hash: -> { successfully_updated_file_ids: ::Array[String] } + end + end +end diff --git a/sig/imagekit/models/file_rename_params.rbs b/sig/imagekit/models/file_rename_params.rbs new file mode 100644 index 00000000..f09beefd --- /dev/null +++ b/sig/imagekit/models/file_rename_params.rbs @@ -0,0 +1,34 @@ +module Imagekit + module Models + type file_rename_params = + { file_path: String, new_file_name: String, purge_cache: bool } + & Imagekit::Internal::Type::request_parameters + + class FileRenameParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_path: String + + attr_accessor new_file_name: String + + attr_reader purge_cache: bool? + + def purge_cache=: (bool) -> bool + + def initialize: ( + file_path: String, + new_file_name: String, + ?purge_cache: bool, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_path: String, + new_file_name: String, + purge_cache: bool, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/file_rename_response.rbs b/sig/imagekit/models/file_rename_response.rbs new file mode 100644 index 00000000..f19ba301 --- /dev/null +++ b/sig/imagekit/models/file_rename_response.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type file_rename_response = { purge_request_id: String } + + class FileRenameResponse < Imagekit::Internal::Type::BaseModel + attr_reader purge_request_id: String? + + def purge_request_id=: (String) -> String + + def initialize: (?purge_request_id: String) -> void + + def to_hash: -> { purge_request_id: String } + end + end +end diff --git a/sig/imagekit/models/file_upload_v1_params.rbs b/sig/imagekit/models/file_upload_v1_params.rbs new file mode 100644 index 00000000..2395e995 --- /dev/null +++ b/sig/imagekit/models/file_upload_v1_params.rbs @@ -0,0 +1,249 @@ +module Imagekit + module Models + type file_upload_v1_params = + { + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + expire: String, + extensions: String, + folder: String, + is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file, + is_published: Imagekit::Models::FileUploadV1Params::is_published, + overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags, + overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata, + overwrite_file: String, + overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags, + public_key: String, + response_fields: String, + signature: String, + tags: String, + transformation: String, + use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name, + webhook_url: String + } + & Imagekit::Internal::Type::request_parameters + + class FileUploadV1Params < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file: String + + attr_accessor file_name: String + + attr_reader token: String? + + def token=: (String) -> String + + attr_reader checks: String? + + def checks=: (String) -> String + + attr_reader custom_coordinates: String? + + def custom_coordinates=: (String) -> String + + attr_reader custom_metadata: String? + + def custom_metadata=: (String) -> String + + attr_reader expire: String? + + def expire=: (String) -> String + + attr_reader extensions: String? + + def extensions=: (String) -> String + + attr_reader folder: String? + + def folder=: (String) -> String + + attr_reader is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file? + + def is_private_file=: ( + Imagekit::Models::FileUploadV1Params::is_private_file + ) -> Imagekit::Models::FileUploadV1Params::is_private_file + + attr_reader is_published: Imagekit::Models::FileUploadV1Params::is_published? + + def is_published=: ( + Imagekit::Models::FileUploadV1Params::is_published + ) -> Imagekit::Models::FileUploadV1Params::is_published + + attr_reader overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags? + + def overwrite_ai_tags=: ( + Imagekit::Models::FileUploadV1Params::overwrite_ai_tags + ) -> Imagekit::Models::FileUploadV1Params::overwrite_ai_tags + + attr_reader overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata? + + def overwrite_custom_metadata=: ( + Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata + ) -> Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata + + attr_reader overwrite_file: String? + + def overwrite_file=: (String) -> String + + attr_reader overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags? + + def overwrite_tags=: ( + Imagekit::Models::FileUploadV1Params::overwrite_tags + ) -> Imagekit::Models::FileUploadV1Params::overwrite_tags + + attr_reader public_key: String? + + def public_key=: (String) -> String + + attr_reader response_fields: String? + + def response_fields=: (String) -> String + + attr_reader signature: String? + + def signature=: (String) -> String + + attr_reader tags: String? + + def tags=: (String) -> String + + attr_reader transformation: String? + + def transformation=: (String) -> String + + attr_reader use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name? + + def use_unique_file_name=: ( + Imagekit::Models::FileUploadV1Params::use_unique_file_name + ) -> Imagekit::Models::FileUploadV1Params::use_unique_file_name + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + def initialize: ( + file: String, + file_name: String, + ?token: String, + ?checks: String, + ?custom_coordinates: String, + ?custom_metadata: String, + ?expire: String, + ?extensions: String, + ?folder: String, + ?is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file, + ?is_published: Imagekit::Models::FileUploadV1Params::is_published, + ?overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags, + ?overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata, + ?overwrite_file: String, + ?overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags, + ?public_key: String, + ?response_fields: String, + ?signature: String, + ?tags: String, + ?transformation: String, + ?use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name, + ?webhook_url: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + expire: String, + extensions: String, + folder: String, + is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file, + is_published: Imagekit::Models::FileUploadV1Params::is_published, + overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags, + overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata, + overwrite_file: String, + overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags, + public_key: String, + response_fields: String, + signature: String, + tags: String, + transformation: String, + use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name, + webhook_url: String, + request_options: Imagekit::RequestOptions + } + + type is_private_file = :true | :false + + module IsPrivateFile + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::is_private_file] + end + + type is_published = :true | :false + + module IsPublished + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::is_published] + end + + type overwrite_ai_tags = :true | :false + + module OverwriteAITags + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::overwrite_ai_tags] + end + + type overwrite_custom_metadata = :true | :false + + module OverwriteCustomMetadata + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata] + end + + type overwrite_tags = :true | :false + + module OverwriteTags + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::overwrite_tags] + end + + type use_unique_file_name = :true | :false + + module UseUniqueFileName + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::use_unique_file_name] + end + end + end +end diff --git a/sig/imagekit/models/file_upload_v1_response.rbs b/sig/imagekit/models/file_upload_v1_response.rbs new file mode 100644 index 00000000..951f9136 --- /dev/null +++ b/sig/imagekit/models/file_upload_v1_response.rbs @@ -0,0 +1,1741 @@ +module Imagekit + module Models + type file_upload_v1_response = + { + ai_tags: ::Array[Imagekit::Models::FileUploadV1Response::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: top, + duration: Integer, + embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, + extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Models::FileUploadV1Response::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadV1Response::VersionInfo, + video_codec: String, + width: Float + } + + class FileUploadV1Response < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::FileUploadV1Response::AITag]? + + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata? + + def embedded_metadata=: ( + Imagekit::Models::FileUploadV1Response::EmbeddedMetadata + ) -> Imagekit::Models::FileUploadV1Response::EmbeddedMetadata + + attr_reader extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus? + + def extension_status=: ( + Imagekit::Models::FileUploadV1Response::ExtensionStatus + ) -> Imagekit::Models::FileUploadV1Response::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader metadata: Imagekit::Models::FileUploadV1Response::Metadata? + + def metadata=: ( + Imagekit::Models::FileUploadV1Response::Metadata + ) -> Imagekit::Models::FileUploadV1Response::Metadata + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail_url: String? + + def thumbnail_url=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::FileUploadV1Response::VersionInfo? + + def version_info=: ( + Imagekit::Models::FileUploadV1Response::VersionInfo + ) -> Imagekit::Models::FileUploadV1Response::VersionInfo + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::FileUploadV1Response::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?duration: Integer, + ?embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, + ?extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?metadata: Imagekit::Models::FileUploadV1Response::Metadata, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail_url: String, + ?url: String, + ?version_info: Imagekit::Models::FileUploadV1Response::VersionInfo, + ?video_codec: String, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::FileUploadV1Response::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: top, + duration: Integer, + embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, + extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Models::FileUploadV1Response::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadV1Response::VersionInfo, + video_codec: String, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type embedded_metadata = + { + about_cv_term_cv_id: String, + about_cv_term_id: String, + about_cv_term_name: String, + about_cv_term_refined_about: String, + additional_model_information: String, + application_record_version: Integer, + artist: String, + artwork_circa_date_created: String, + artwork_content_description: String, + artwork_contribution_description: String, + artwork_copyright_notice: String, + artwork_copyright_owner_id: String, + artwork_copyright_owner_name: String, + artwork_creator: ::Array[String], + artwork_creator_id: ::Array[String], + artwork_date_created: Time, + artwork_licensor_id: String, + artwork_licensor_name: String, + artwork_physical_description: String, + artwork_source: String, + artwork_source_inventory_no: String, + artwork_source_inv_url: String, + artwork_style_period: ::Array[String], + artwork_title: String, + authors_position: String, + byline: String, + byline_title: String, + caption: String, + caption_abstract: String, + caption_writer: String, + city: String, + color_space: String, + components_configuration: String, + copyright: String, + copyright_notice: String, + copyright_owner_id: ::Array[String], + copyright_owner_name: ::Array[String], + country: String, + country_code: String, + country_primary_location_code: String, + country_primary_location_name: String, + creator: String, + creator_address: String, + creator_city: String, + creator_country: String, + creator_postal_code: String, + creator_region: String, + creator_work_email: String, + creator_work_telephone: String, + creator_work_url: String, + credit: String, + date_created: Time, + date_time_created: Time, + date_time_original: Time, + description: String, + digital_image_guid: String, + digital_source_type: String, + embedded_encoded_rights_expr: String, + embedded_encoded_rights_expr_lang_id: String, + embedded_encoded_rights_expr_type: String, + event: String, + exif_version: String, + flashpix_version: String, + genre_cv_id: String, + genre_cv_term_id: String, + genre_cv_term_name: String, + genre_cv_term_refined_about: String, + headline: String, + image_creator_id: String, + image_creator_image_id: String, + image_creator_name: String, + image_description: String, + image_region_boundary_h: ::Array[Float], + image_region_boundary_rx: ::Array[Float], + image_region_boundary_shape: ::Array[String], + image_region_boundary_unit: ::Array[String], + image_region_boundary_vertices_x: ::Array[Float], + image_region_boundary_vertices_y: ::Array[Float], + image_region_boundary_w: ::Array[Float], + image_region_boundary_x: ::Array[Float], + image_region_boundary_y: ::Array[Float], + image_region_ctype_identifier: ::Array[String], + image_region_ctype_name: ::Array[String], + image_region_id: ::Array[String], + image_region_name: ::Array[String], + image_region_organisation_in_image_name: ::Array[String], + image_region_person_in_image: ::Array[String], + image_region_role_identifier: ::Array[String], + image_region_role_name: ::Array[String], + image_supplier_id: String, + image_supplier_image_id: String, + image_supplier_name: String, + instructions: String, + intellectual_genre: String, + keywords: ::Array[String], + licensor_city: ::Array[String], + licensor_country: ::Array[String], + licensor_email: ::Array[String], + licensor_extended_address: ::Array[String], + licensor_id: ::Array[String], + licensor_name: ::Array[String], + licensor_postal_code: ::Array[String], + licensor_region: ::Array[String], + licensor_street_address: ::Array[String], + :licensor_telephone1 => ::Array[String], + :licensor_telephone2 => ::Array[String], + licensor_url: ::Array[String], + linked_encoded_rights_expr: String, + linked_encoded_rights_expr_lang_id: String, + linked_encoded_rights_expr_type: String, + location: String, + location_created_city: String, + location_created_country_code: String, + location_created_country_name: String, + location_created_gps_altitude: String, + location_created_gps_latitude: String, + location_created_gps_longitude: String, + location_created_location_id: String, + location_created_location_name: String, + location_created_province_state: String, + location_created_sublocation: String, + location_created_world_region: String, + location_shown_city: ::Array[String], + location_shown_country_code: ::Array[String], + location_shown_country_name: ::Array[String], + location_shown_gps_altitude: ::Array[String], + location_shown_gps_latitude: ::Array[String], + location_shown_gps_longitude: ::Array[String], + location_shown_location_id: ::Array[String], + location_shown_location_name: ::Array[String], + location_shown_province_state: ::Array[String], + location_shown_sublocation: ::Array[String], + location_shown_world_region: ::Array[String], + max_avail_height: Float, + max_avail_width: Float, + model_age: ::Array[Float], + model_release_id: ::Array[String], + object_attribute_reference: String, + object_name: String, + offset_time_original: String, + organisation_in_image_code: ::Array[String], + organisation_in_image_name: ::Array[String], + orientation: String, + original_transmission_reference: String, + person_in_image: ::Array[String], + person_in_image_cv_term_cv_id: ::Array[String], + person_in_image_cv_term_id: ::Array[String], + person_in_image_cv_term_name: ::Array[String], + person_in_image_cv_term_refined_about: ::Array[String], + person_in_image_description: ::Array[String], + person_in_image_id: ::Array[String], + person_in_image_name: ::Array[String], + product_in_image_description: ::Array[String], + product_in_image_gtin: ::Array[Float], + product_in_image_name: ::Array[String], + property_release_id: ::Array[String], + province_state: String, + rating: Integer, + registry_entry_role: ::Array[String], + registry_item_id: ::Array[String], + registry_organisation_id: ::Array[String], + resolution_unit: String, + rights: String, + scene: ::Array[String], + source: String, + special_instructions: String, + state: String, + subject: ::Array[String], + subject_code: ::Array[String], + subject_reference: ::Array[String], + sublocation: String, + time_created: String, + title: String, + transmission_reference: String, + usage_terms: String, + web_statement: String, + writer: String, + writer_editor: String, + x_resolution: Float, + y_resolution: Float + } + + class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel + attr_reader about_cv_term_cv_id: String? + + def about_cv_term_cv_id=: (String) -> String + + attr_reader about_cv_term_id: String? + + def about_cv_term_id=: (String) -> String + + attr_reader about_cv_term_name: String? + + def about_cv_term_name=: (String) -> String + + attr_reader about_cv_term_refined_about: String? + + def about_cv_term_refined_about=: (String) -> String + + attr_reader additional_model_information: String? + + def additional_model_information=: (String) -> String + + attr_reader application_record_version: Integer? + + def application_record_version=: (Integer) -> Integer + + attr_reader artist: String? + + def artist=: (String) -> String + + attr_reader artwork_circa_date_created: String? + + def artwork_circa_date_created=: (String) -> String + + attr_reader artwork_content_description: String? + + def artwork_content_description=: (String) -> String + + attr_reader artwork_contribution_description: String? + + def artwork_contribution_description=: (String) -> String + + attr_reader artwork_copyright_notice: String? + + def artwork_copyright_notice=: (String) -> String + + attr_reader artwork_copyright_owner_id: String? + + def artwork_copyright_owner_id=: (String) -> String + + attr_reader artwork_copyright_owner_name: String? + + def artwork_copyright_owner_name=: (String) -> String + + attr_reader artwork_creator: ::Array[String]? + + def artwork_creator=: (::Array[String]) -> ::Array[String] + + attr_reader artwork_creator_id: ::Array[String]? + + def artwork_creator_id=: (::Array[String]) -> ::Array[String] + + attr_reader artwork_date_created: Time? + + def artwork_date_created=: (Time) -> Time + + attr_reader artwork_licensor_id: String? + + def artwork_licensor_id=: (String) -> String + + attr_reader artwork_licensor_name: String? + + def artwork_licensor_name=: (String) -> String + + attr_reader artwork_physical_description: String? + + def artwork_physical_description=: (String) -> String + + attr_reader artwork_source: String? + + def artwork_source=: (String) -> String + + attr_reader artwork_source_inventory_no: String? + + def artwork_source_inventory_no=: (String) -> String + + attr_reader artwork_source_inv_url: String? + + def artwork_source_inv_url=: (String) -> String + + attr_reader artwork_style_period: ::Array[String]? + + def artwork_style_period=: (::Array[String]) -> ::Array[String] + + attr_reader artwork_title: String? + + def artwork_title=: (String) -> String + + attr_reader authors_position: String? + + def authors_position=: (String) -> String + + attr_reader byline: String? + + def byline=: (String) -> String + + attr_reader byline_title: String? + + def byline_title=: (String) -> String + + attr_reader caption: String? + + def caption=: (String) -> String + + attr_reader caption_abstract: String? + + def caption_abstract=: (String) -> String + + attr_reader caption_writer: String? + + def caption_writer=: (String) -> String + + attr_reader city: String? + + def city=: (String) -> String + + attr_reader color_space: String? + + def color_space=: (String) -> String + + attr_reader components_configuration: String? + + def components_configuration=: (String) -> String + + attr_reader copyright: String? + + def copyright=: (String) -> String + + attr_reader copyright_notice: String? + + def copyright_notice=: (String) -> String + + attr_reader copyright_owner_id: ::Array[String]? + + def copyright_owner_id=: (::Array[String]) -> ::Array[String] + + attr_reader copyright_owner_name: ::Array[String]? + + def copyright_owner_name=: (::Array[String]) -> ::Array[String] + + attr_reader country: String? + + def country=: (String) -> String + + attr_reader country_code: String? + + def country_code=: (String) -> String + + attr_reader country_primary_location_code: String? + + def country_primary_location_code=: (String) -> String + + attr_reader country_primary_location_name: String? + + def country_primary_location_name=: (String) -> String + + attr_reader creator: String? + + def creator=: (String) -> String + + attr_reader creator_address: String? + + def creator_address=: (String) -> String + + attr_reader creator_city: String? + + def creator_city=: (String) -> String + + attr_reader creator_country: String? + + def creator_country=: (String) -> String + + attr_reader creator_postal_code: String? + + def creator_postal_code=: (String) -> String + + attr_reader creator_region: String? + + def creator_region=: (String) -> String + + attr_reader creator_work_email: String? + + def creator_work_email=: (String) -> String + + attr_reader creator_work_telephone: String? + + def creator_work_telephone=: (String) -> String + + attr_reader creator_work_url: String? + + def creator_work_url=: (String) -> String + + attr_reader credit: String? + + def credit=: (String) -> String + + attr_reader date_created: Time? + + def date_created=: (Time) -> Time + + attr_reader date_time_created: Time? + + def date_time_created=: (Time) -> Time + + attr_reader date_time_original: Time? + + def date_time_original=: (Time) -> Time + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader digital_image_guid: String? + + def digital_image_guid=: (String) -> String + + attr_reader digital_source_type: String? + + def digital_source_type=: (String) -> String + + attr_reader embedded_encoded_rights_expr: String? + + def embedded_encoded_rights_expr=: (String) -> String + + attr_reader embedded_encoded_rights_expr_lang_id: String? + + def embedded_encoded_rights_expr_lang_id=: (String) -> String + + attr_reader embedded_encoded_rights_expr_type: String? + + def embedded_encoded_rights_expr_type=: (String) -> String + + attr_reader event: String? + + def event=: (String) -> String + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader genre_cv_id: String? + + def genre_cv_id=: (String) -> String + + attr_reader genre_cv_term_id: String? + + def genre_cv_term_id=: (String) -> String + + attr_reader genre_cv_term_name: String? + + def genre_cv_term_name=: (String) -> String + + attr_reader genre_cv_term_refined_about: String? + + def genre_cv_term_refined_about=: (String) -> String + + attr_reader headline: String? + + def headline=: (String) -> String + + attr_reader image_creator_id: String? + + def image_creator_id=: (String) -> String + + attr_reader image_creator_image_id: String? + + def image_creator_image_id=: (String) -> String + + attr_reader image_creator_name: String? + + def image_creator_name=: (String) -> String + + attr_reader image_description: String? + + def image_description=: (String) -> String + + attr_reader image_region_boundary_h: ::Array[Float]? + + def image_region_boundary_h=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_boundary_rx: ::Array[Float]? + + def image_region_boundary_rx=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_boundary_shape: ::Array[String]? + + def image_region_boundary_shape=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_boundary_unit: ::Array[String]? + + def image_region_boundary_unit=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_boundary_vertices_x: ::Array[Float]? + + def image_region_boundary_vertices_x=: ( + ::Array[Float] + ) -> ::Array[Float] + + attr_reader image_region_boundary_vertices_y: ::Array[Float]? + + def image_region_boundary_vertices_y=: ( + ::Array[Float] + ) -> ::Array[Float] + + attr_reader image_region_boundary_w: ::Array[Float]? + + def image_region_boundary_w=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_boundary_x: ::Array[Float]? + + def image_region_boundary_x=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_boundary_y: ::Array[Float]? + + def image_region_boundary_y=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_ctype_identifier: ::Array[String]? + + def image_region_ctype_identifier=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_ctype_name: ::Array[String]? + + def image_region_ctype_name=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_id: ::Array[String]? + + def image_region_id=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_name: ::Array[String]? + + def image_region_name=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_organisation_in_image_name: ::Array[String]? + + def image_region_organisation_in_image_name=: ( + ::Array[String] + ) -> ::Array[String] + + attr_reader image_region_person_in_image: ::Array[String]? + + def image_region_person_in_image=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_role_identifier: ::Array[String]? + + def image_region_role_identifier=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_role_name: ::Array[String]? + + def image_region_role_name=: (::Array[String]) -> ::Array[String] + + attr_reader image_supplier_id: String? + + def image_supplier_id=: (String) -> String + + attr_reader image_supplier_image_id: String? + + def image_supplier_image_id=: (String) -> String + + attr_reader image_supplier_name: String? + + def image_supplier_name=: (String) -> String + + attr_reader instructions: String? + + def instructions=: (String) -> String + + attr_reader intellectual_genre: String? + + def intellectual_genre=: (String) -> String + + attr_reader keywords: ::Array[String]? + + def keywords=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_city: ::Array[String]? + + def licensor_city=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_country: ::Array[String]? + + def licensor_country=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_email: ::Array[String]? + + def licensor_email=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_extended_address: ::Array[String]? + + def licensor_extended_address=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_id: ::Array[String]? + + def licensor_id=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_name: ::Array[String]? + + def licensor_name=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_postal_code: ::Array[String]? + + def licensor_postal_code=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_region: ::Array[String]? + + def licensor_region=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_street_address: ::Array[String]? + + def licensor_street_address=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_telephone1: ::Array[String]? + + def licensor_telephone1=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_telephone2: ::Array[String]? + + def licensor_telephone2=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_url: ::Array[String]? + + def licensor_url=: (::Array[String]) -> ::Array[String] + + attr_reader linked_encoded_rights_expr: String? + + def linked_encoded_rights_expr=: (String) -> String + + attr_reader linked_encoded_rights_expr_lang_id: String? + + def linked_encoded_rights_expr_lang_id=: (String) -> String + + attr_reader linked_encoded_rights_expr_type: String? + + def linked_encoded_rights_expr_type=: (String) -> String + + attr_reader location: String? + + def location=: (String) -> String + + attr_reader location_created_city: String? + + def location_created_city=: (String) -> String + + attr_reader location_created_country_code: String? + + def location_created_country_code=: (String) -> String + + attr_reader location_created_country_name: String? + + def location_created_country_name=: (String) -> String + + attr_reader location_created_gps_altitude: String? + + def location_created_gps_altitude=: (String) -> String + + attr_reader location_created_gps_latitude: String? + + def location_created_gps_latitude=: (String) -> String + + attr_reader location_created_gps_longitude: String? + + def location_created_gps_longitude=: (String) -> String + + attr_reader location_created_location_id: String? + + def location_created_location_id=: (String) -> String + + attr_reader location_created_location_name: String? + + def location_created_location_name=: (String) -> String + + attr_reader location_created_province_state: String? + + def location_created_province_state=: (String) -> String + + attr_reader location_created_sublocation: String? + + def location_created_sublocation=: (String) -> String + + attr_reader location_created_world_region: String? + + def location_created_world_region=: (String) -> String + + attr_reader location_shown_city: ::Array[String]? + + def location_shown_city=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_country_code: ::Array[String]? + + def location_shown_country_code=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_country_name: ::Array[String]? + + def location_shown_country_name=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_gps_altitude: ::Array[String]? + + def location_shown_gps_altitude=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_gps_latitude: ::Array[String]? + + def location_shown_gps_latitude=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_gps_longitude: ::Array[String]? + + def location_shown_gps_longitude=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_location_id: ::Array[String]? + + def location_shown_location_id=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_location_name: ::Array[String]? + + def location_shown_location_name=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_province_state: ::Array[String]? + + def location_shown_province_state=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_sublocation: ::Array[String]? + + def location_shown_sublocation=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_world_region: ::Array[String]? + + def location_shown_world_region=: (::Array[String]) -> ::Array[String] + + attr_reader max_avail_height: Float? + + def max_avail_height=: (Float) -> Float + + attr_reader max_avail_width: Float? + + def max_avail_width=: (Float) -> Float + + attr_reader model_age: ::Array[Float]? + + def model_age=: (::Array[Float]) -> ::Array[Float] + + attr_reader model_release_id: ::Array[String]? + + def model_release_id=: (::Array[String]) -> ::Array[String] + + attr_reader object_attribute_reference: String? + + def object_attribute_reference=: (String) -> String + + attr_reader object_name: String? + + def object_name=: (String) -> String + + attr_reader offset_time_original: String? + + def offset_time_original=: (String) -> String + + attr_reader organisation_in_image_code: ::Array[String]? + + def organisation_in_image_code=: (::Array[String]) -> ::Array[String] + + attr_reader organisation_in_image_name: ::Array[String]? + + def organisation_in_image_name=: (::Array[String]) -> ::Array[String] + + attr_reader orientation: String? + + def orientation=: (String) -> String + + attr_reader original_transmission_reference: String? + + def original_transmission_reference=: (String) -> String + + attr_reader person_in_image: ::Array[String]? + + def person_in_image=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_cv_term_cv_id: ::Array[String]? + + def person_in_image_cv_term_cv_id=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_cv_term_id: ::Array[String]? + + def person_in_image_cv_term_id=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_cv_term_name: ::Array[String]? + + def person_in_image_cv_term_name=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_cv_term_refined_about: ::Array[String]? + + def person_in_image_cv_term_refined_about=: ( + ::Array[String] + ) -> ::Array[String] + + attr_reader person_in_image_description: ::Array[String]? + + def person_in_image_description=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_id: ::Array[String]? + + def person_in_image_id=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_name: ::Array[String]? + + def person_in_image_name=: (::Array[String]) -> ::Array[String] + + attr_reader product_in_image_description: ::Array[String]? + + def product_in_image_description=: (::Array[String]) -> ::Array[String] + + attr_reader product_in_image_gtin: ::Array[Float]? + + def product_in_image_gtin=: (::Array[Float]) -> ::Array[Float] + + attr_reader product_in_image_name: ::Array[String]? + + def product_in_image_name=: (::Array[String]) -> ::Array[String] + + attr_reader property_release_id: ::Array[String]? + + def property_release_id=: (::Array[String]) -> ::Array[String] + + attr_reader province_state: String? + + def province_state=: (String) -> String + + attr_reader rating: Integer? + + def rating=: (Integer) -> Integer + + attr_reader registry_entry_role: ::Array[String]? + + def registry_entry_role=: (::Array[String]) -> ::Array[String] + + attr_reader registry_item_id: ::Array[String]? + + def registry_item_id=: (::Array[String]) -> ::Array[String] + + attr_reader registry_organisation_id: ::Array[String]? + + def registry_organisation_id=: (::Array[String]) -> ::Array[String] + + attr_reader resolution_unit: String? + + def resolution_unit=: (String) -> String + + attr_reader rights: String? + + def rights=: (String) -> String + + attr_reader scene: ::Array[String]? + + def scene=: (::Array[String]) -> ::Array[String] + + attr_reader source: String? + + def source=: (String) -> String + + attr_reader special_instructions: String? + + def special_instructions=: (String) -> String + + attr_reader state: String? + + def state=: (String) -> String + + attr_reader subject: ::Array[String]? + + def subject=: (::Array[String]) -> ::Array[String] + + attr_reader subject_code: ::Array[String]? + + def subject_code=: (::Array[String]) -> ::Array[String] + + attr_reader subject_reference: ::Array[String]? + + def subject_reference=: (::Array[String]) -> ::Array[String] + + attr_reader sublocation: String? + + def sublocation=: (String) -> String + + attr_reader time_created: String? + + def time_created=: (String) -> String + + attr_reader title: String? + + def title=: (String) -> String + + attr_reader transmission_reference: String? + + def transmission_reference=: (String) -> String + + attr_reader usage_terms: String? + + def usage_terms=: (String) -> String + + attr_reader web_statement: String? + + def web_statement=: (String) -> String + + attr_reader writer: String? + + def writer=: (String) -> String + + attr_reader writer_editor: String? + + def writer_editor=: (String) -> String + + attr_reader x_resolution: Float? + + def x_resolution=: (Float) -> Float + + attr_reader y_resolution: Float? + + def y_resolution=: (Float) -> Float + + def initialize: ( + ?about_cv_term_cv_id: String, + ?about_cv_term_id: String, + ?about_cv_term_name: String, + ?about_cv_term_refined_about: String, + ?additional_model_information: String, + ?application_record_version: Integer, + ?artist: String, + ?artwork_circa_date_created: String, + ?artwork_content_description: String, + ?artwork_contribution_description: String, + ?artwork_copyright_notice: String, + ?artwork_copyright_owner_id: String, + ?artwork_copyright_owner_name: String, + ?artwork_creator: ::Array[String], + ?artwork_creator_id: ::Array[String], + ?artwork_date_created: Time, + ?artwork_licensor_id: String, + ?artwork_licensor_name: String, + ?artwork_physical_description: String, + ?artwork_source: String, + ?artwork_source_inventory_no: String, + ?artwork_source_inv_url: String, + ?artwork_style_period: ::Array[String], + ?artwork_title: String, + ?authors_position: String, + ?byline: String, + ?byline_title: String, + ?caption: String, + ?caption_abstract: String, + ?caption_writer: String, + ?city: String, + ?color_space: String, + ?components_configuration: String, + ?copyright: String, + ?copyright_notice: String, + ?copyright_owner_id: ::Array[String], + ?copyright_owner_name: ::Array[String], + ?country: String, + ?country_code: String, + ?country_primary_location_code: String, + ?country_primary_location_name: String, + ?creator: String, + ?creator_address: String, + ?creator_city: String, + ?creator_country: String, + ?creator_postal_code: String, + ?creator_region: String, + ?creator_work_email: String, + ?creator_work_telephone: String, + ?creator_work_url: String, + ?credit: String, + ?date_created: Time, + ?date_time_created: Time, + ?date_time_original: Time, + ?description: String, + ?digital_image_guid: String, + ?digital_source_type: String, + ?embedded_encoded_rights_expr: String, + ?embedded_encoded_rights_expr_lang_id: String, + ?embedded_encoded_rights_expr_type: String, + ?event: String, + ?exif_version: String, + ?flashpix_version: String, + ?genre_cv_id: String, + ?genre_cv_term_id: String, + ?genre_cv_term_name: String, + ?genre_cv_term_refined_about: String, + ?headline: String, + ?image_creator_id: String, + ?image_creator_image_id: String, + ?image_creator_name: String, + ?image_description: String, + ?image_region_boundary_h: ::Array[Float], + ?image_region_boundary_rx: ::Array[Float], + ?image_region_boundary_shape: ::Array[String], + ?image_region_boundary_unit: ::Array[String], + ?image_region_boundary_vertices_x: ::Array[Float], + ?image_region_boundary_vertices_y: ::Array[Float], + ?image_region_boundary_w: ::Array[Float], + ?image_region_boundary_x: ::Array[Float], + ?image_region_boundary_y: ::Array[Float], + ?image_region_ctype_identifier: ::Array[String], + ?image_region_ctype_name: ::Array[String], + ?image_region_id: ::Array[String], + ?image_region_name: ::Array[String], + ?image_region_organisation_in_image_name: ::Array[String], + ?image_region_person_in_image: ::Array[String], + ?image_region_role_identifier: ::Array[String], + ?image_region_role_name: ::Array[String], + ?image_supplier_id: String, + ?image_supplier_image_id: String, + ?image_supplier_name: String, + ?instructions: String, + ?intellectual_genre: String, + ?keywords: ::Array[String], + ?licensor_city: ::Array[String], + ?licensor_country: ::Array[String], + ?licensor_email: ::Array[String], + ?licensor_extended_address: ::Array[String], + ?licensor_id: ::Array[String], + ?licensor_name: ::Array[String], + ?licensor_postal_code: ::Array[String], + ?licensor_region: ::Array[String], + ?licensor_street_address: ::Array[String], + ?licensor_telephone1: ::Array[String], + ?licensor_telephone2: ::Array[String], + ?licensor_url: ::Array[String], + ?linked_encoded_rights_expr: String, + ?linked_encoded_rights_expr_lang_id: String, + ?linked_encoded_rights_expr_type: String, + ?location: String, + ?location_created_city: String, + ?location_created_country_code: String, + ?location_created_country_name: String, + ?location_created_gps_altitude: String, + ?location_created_gps_latitude: String, + ?location_created_gps_longitude: String, + ?location_created_location_id: String, + ?location_created_location_name: String, + ?location_created_province_state: String, + ?location_created_sublocation: String, + ?location_created_world_region: String, + ?location_shown_city: ::Array[String], + ?location_shown_country_code: ::Array[String], + ?location_shown_country_name: ::Array[String], + ?location_shown_gps_altitude: ::Array[String], + ?location_shown_gps_latitude: ::Array[String], + ?location_shown_gps_longitude: ::Array[String], + ?location_shown_location_id: ::Array[String], + ?location_shown_location_name: ::Array[String], + ?location_shown_province_state: ::Array[String], + ?location_shown_sublocation: ::Array[String], + ?location_shown_world_region: ::Array[String], + ?max_avail_height: Float, + ?max_avail_width: Float, + ?model_age: ::Array[Float], + ?model_release_id: ::Array[String], + ?object_attribute_reference: String, + ?object_name: String, + ?offset_time_original: String, + ?organisation_in_image_code: ::Array[String], + ?organisation_in_image_name: ::Array[String], + ?orientation: String, + ?original_transmission_reference: String, + ?person_in_image: ::Array[String], + ?person_in_image_cv_term_cv_id: ::Array[String], + ?person_in_image_cv_term_id: ::Array[String], + ?person_in_image_cv_term_name: ::Array[String], + ?person_in_image_cv_term_refined_about: ::Array[String], + ?person_in_image_description: ::Array[String], + ?person_in_image_id: ::Array[String], + ?person_in_image_name: ::Array[String], + ?product_in_image_description: ::Array[String], + ?product_in_image_gtin: ::Array[Float], + ?product_in_image_name: ::Array[String], + ?property_release_id: ::Array[String], + ?province_state: String, + ?rating: Integer, + ?registry_entry_role: ::Array[String], + ?registry_item_id: ::Array[String], + ?registry_organisation_id: ::Array[String], + ?resolution_unit: String, + ?rights: String, + ?scene: ::Array[String], + ?source: String, + ?special_instructions: String, + ?state: String, + ?subject: ::Array[String], + ?subject_code: ::Array[String], + ?subject_reference: ::Array[String], + ?sublocation: String, + ?time_created: String, + ?title: String, + ?transmission_reference: String, + ?usage_terms: String, + ?web_statement: String, + ?writer: String, + ?writer_editor: String, + ?x_resolution: Float, + ?y_resolution: Float + ) -> void + + def to_hash: -> { + about_cv_term_cv_id: String, + about_cv_term_id: String, + about_cv_term_name: String, + about_cv_term_refined_about: String, + additional_model_information: String, + application_record_version: Integer, + artist: String, + artwork_circa_date_created: String, + artwork_content_description: String, + artwork_contribution_description: String, + artwork_copyright_notice: String, + artwork_copyright_owner_id: String, + artwork_copyright_owner_name: String, + artwork_creator: ::Array[String], + artwork_creator_id: ::Array[String], + artwork_date_created: Time, + artwork_licensor_id: String, + artwork_licensor_name: String, + artwork_physical_description: String, + artwork_source: String, + artwork_source_inventory_no: String, + artwork_source_inv_url: String, + artwork_style_period: ::Array[String], + artwork_title: String, + authors_position: String, + byline: String, + byline_title: String, + caption: String, + caption_abstract: String, + caption_writer: String, + city: String, + color_space: String, + components_configuration: String, + copyright: String, + copyright_notice: String, + copyright_owner_id: ::Array[String], + copyright_owner_name: ::Array[String], + country: String, + country_code: String, + country_primary_location_code: String, + country_primary_location_name: String, + creator: String, + creator_address: String, + creator_city: String, + creator_country: String, + creator_postal_code: String, + creator_region: String, + creator_work_email: String, + creator_work_telephone: String, + creator_work_url: String, + credit: String, + date_created: Time, + date_time_created: Time, + date_time_original: Time, + description: String, + digital_image_guid: String, + digital_source_type: String, + embedded_encoded_rights_expr: String, + embedded_encoded_rights_expr_lang_id: String, + embedded_encoded_rights_expr_type: String, + event: String, + exif_version: String, + flashpix_version: String, + genre_cv_id: String, + genre_cv_term_id: String, + genre_cv_term_name: String, + genre_cv_term_refined_about: String, + headline: String, + image_creator_id: String, + image_creator_image_id: String, + image_creator_name: String, + image_description: String, + image_region_boundary_h: ::Array[Float], + image_region_boundary_rx: ::Array[Float], + image_region_boundary_shape: ::Array[String], + image_region_boundary_unit: ::Array[String], + image_region_boundary_vertices_x: ::Array[Float], + image_region_boundary_vertices_y: ::Array[Float], + image_region_boundary_w: ::Array[Float], + image_region_boundary_x: ::Array[Float], + image_region_boundary_y: ::Array[Float], + image_region_ctype_identifier: ::Array[String], + image_region_ctype_name: ::Array[String], + image_region_id: ::Array[String], + image_region_name: ::Array[String], + image_region_organisation_in_image_name: ::Array[String], + image_region_person_in_image: ::Array[String], + image_region_role_identifier: ::Array[String], + image_region_role_name: ::Array[String], + image_supplier_id: String, + image_supplier_image_id: String, + image_supplier_name: String, + instructions: String, + intellectual_genre: String, + keywords: ::Array[String], + licensor_city: ::Array[String], + licensor_country: ::Array[String], + licensor_email: ::Array[String], + licensor_extended_address: ::Array[String], + licensor_id: ::Array[String], + licensor_name: ::Array[String], + licensor_postal_code: ::Array[String], + licensor_region: ::Array[String], + licensor_street_address: ::Array[String], + :licensor_telephone1 => ::Array[String], + :licensor_telephone2 => ::Array[String], + licensor_url: ::Array[String], + linked_encoded_rights_expr: String, + linked_encoded_rights_expr_lang_id: String, + linked_encoded_rights_expr_type: String, + location: String, + location_created_city: String, + location_created_country_code: String, + location_created_country_name: String, + location_created_gps_altitude: String, + location_created_gps_latitude: String, + location_created_gps_longitude: String, + location_created_location_id: String, + location_created_location_name: String, + location_created_province_state: String, + location_created_sublocation: String, + location_created_world_region: String, + location_shown_city: ::Array[String], + location_shown_country_code: ::Array[String], + location_shown_country_name: ::Array[String], + location_shown_gps_altitude: ::Array[String], + location_shown_gps_latitude: ::Array[String], + location_shown_gps_longitude: ::Array[String], + location_shown_location_id: ::Array[String], + location_shown_location_name: ::Array[String], + location_shown_province_state: ::Array[String], + location_shown_sublocation: ::Array[String], + location_shown_world_region: ::Array[String], + max_avail_height: Float, + max_avail_width: Float, + model_age: ::Array[Float], + model_release_id: ::Array[String], + object_attribute_reference: String, + object_name: String, + offset_time_original: String, + organisation_in_image_code: ::Array[String], + organisation_in_image_name: ::Array[String], + orientation: String, + original_transmission_reference: String, + person_in_image: ::Array[String], + person_in_image_cv_term_cv_id: ::Array[String], + person_in_image_cv_term_id: ::Array[String], + person_in_image_cv_term_name: ::Array[String], + person_in_image_cv_term_refined_about: ::Array[String], + person_in_image_description: ::Array[String], + person_in_image_id: ::Array[String], + person_in_image_name: ::Array[String], + product_in_image_description: ::Array[String], + product_in_image_gtin: ::Array[Float], + product_in_image_name: ::Array[String], + property_release_id: ::Array[String], + province_state: String, + rating: Integer, + registry_entry_role: ::Array[String], + registry_item_id: ::Array[String], + registry_organisation_id: ::Array[String], + resolution_unit: String, + rights: String, + scene: ::Array[String], + source: String, + special_instructions: String, + state: String, + subject: ::Array[String], + subject_code: ::Array[String], + subject_reference: ::Array[String], + sublocation: String, + time_created: String, + title: String, + transmission_reference: String, + usage_terms: String, + web_statement: String, + writer: String, + writer_editor: String, + x_resolution: Float, + y_resolution: Float + } + end + + type extension_status = + { + aws_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader aws_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging + ) -> Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging + ) -> Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg + ) -> Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg + + def initialize: ( + ?aws_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + aws_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg + } + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg] + end + end + + type metadata = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class Metadata < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif? + + def exif=: ( + Imagekit::Models::FileUploadV1Response::Metadata::Exif + ) -> Imagekit::Models::FileUploadV1Response::Metadata::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::ExifDetails? + + def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails + + attr_reader gps: Imagekit::Gps? + + def gps=: (Imagekit::Gps) -> Imagekit::Gps + + attr_reader image: Imagekit::ExifImage? + + def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage + + attr_reader interoperability: Imagekit::Interoperability? + + def interoperability=: ( + Imagekit::Interoperability + ) -> Imagekit::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Thumbnail? + + def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail + + def initialize: ( + ?exif: Imagekit::ExifDetails, + ?gps: Imagekit::Gps, + ?image: Imagekit::ExifImage, + ?interoperability: Imagekit::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Thumbnail + } + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end +end diff --git a/sig/imagekit/models/file_upload_v2_params.rbs b/sig/imagekit/models/file_upload_v2_params.rbs new file mode 100644 index 00000000..ecb9b725 --- /dev/null +++ b/sig/imagekit/models/file_upload_v2_params.rbs @@ -0,0 +1,228 @@ +module Imagekit + module Models + type file_upload_v2_params = + { + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + extensions: String, + folder: String, + is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file, + is_published: Imagekit::Models::FileUploadV2Params::is_published, + overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags, + overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata, + overwrite_file: String, + overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags, + response_fields: String, + tags: String, + transformation: String, + use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name, + webhook_url: String + } + & Imagekit::Internal::Type::request_parameters + + class FileUploadV2Params < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file: String + + attr_accessor file_name: String + + attr_reader token: String? + + def token=: (String) -> String + + attr_reader checks: String? + + def checks=: (String) -> String + + attr_reader custom_coordinates: String? + + def custom_coordinates=: (String) -> String + + attr_reader custom_metadata: String? + + def custom_metadata=: (String) -> String + + attr_reader extensions: String? + + def extensions=: (String) -> String + + attr_reader folder: String? + + def folder=: (String) -> String + + attr_reader is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file? + + def is_private_file=: ( + Imagekit::Models::FileUploadV2Params::is_private_file + ) -> Imagekit::Models::FileUploadV2Params::is_private_file + + attr_reader is_published: Imagekit::Models::FileUploadV2Params::is_published? + + def is_published=: ( + Imagekit::Models::FileUploadV2Params::is_published + ) -> Imagekit::Models::FileUploadV2Params::is_published + + attr_reader overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags? + + def overwrite_ai_tags=: ( + Imagekit::Models::FileUploadV2Params::overwrite_ai_tags + ) -> Imagekit::Models::FileUploadV2Params::overwrite_ai_tags + + attr_reader overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata? + + def overwrite_custom_metadata=: ( + Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata + ) -> Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata + + attr_reader overwrite_file: String? + + def overwrite_file=: (String) -> String + + attr_reader overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags? + + def overwrite_tags=: ( + Imagekit::Models::FileUploadV2Params::overwrite_tags + ) -> Imagekit::Models::FileUploadV2Params::overwrite_tags + + attr_reader response_fields: String? + + def response_fields=: (String) -> String + + attr_reader tags: String? + + def tags=: (String) -> String + + attr_reader transformation: String? + + def transformation=: (String) -> String + + attr_reader use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name? + + def use_unique_file_name=: ( + Imagekit::Models::FileUploadV2Params::use_unique_file_name + ) -> Imagekit::Models::FileUploadV2Params::use_unique_file_name + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + def initialize: ( + file: String, + file_name: String, + ?token: String, + ?checks: String, + ?custom_coordinates: String, + ?custom_metadata: String, + ?extensions: String, + ?folder: String, + ?is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file, + ?is_published: Imagekit::Models::FileUploadV2Params::is_published, + ?overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags, + ?overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata, + ?overwrite_file: String, + ?overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags, + ?response_fields: String, + ?tags: String, + ?transformation: String, + ?use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name, + ?webhook_url: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file: String, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: String, + extensions: String, + folder: String, + is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file, + is_published: Imagekit::Models::FileUploadV2Params::is_published, + overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags, + overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata, + overwrite_file: String, + overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags, + response_fields: String, + tags: String, + transformation: String, + use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name, + webhook_url: String, + request_options: Imagekit::RequestOptions + } + + type is_private_file = :true | :false + + module IsPrivateFile + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::is_private_file] + end + + type is_published = :true | :false + + module IsPublished + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::is_published] + end + + type overwrite_ai_tags = :true | :false + + module OverwriteAITags + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::overwrite_ai_tags] + end + + type overwrite_custom_metadata = :true | :false + + module OverwriteCustomMetadata + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata] + end + + type overwrite_tags = :true | :false + + module OverwriteTags + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::overwrite_tags] + end + + type use_unique_file_name = :true | :false + + module UseUniqueFileName + extend Imagekit::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::use_unique_file_name] + end + end + end +end diff --git a/sig/imagekit/models/file_upload_v2_response.rbs b/sig/imagekit/models/file_upload_v2_response.rbs new file mode 100644 index 00000000..d72f49b1 --- /dev/null +++ b/sig/imagekit/models/file_upload_v2_response.rbs @@ -0,0 +1,1741 @@ +module Imagekit + module Models + type file_upload_v2_response = + { + ai_tags: ::Array[Imagekit::Models::FileUploadV2Response::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: top, + duration: Integer, + embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, + extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Models::FileUploadV2Response::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadV2Response::VersionInfo, + video_codec: String, + width: Float + } + + class FileUploadV2Response < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::FileUploadV2Response::AITag]? + + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata? + + def embedded_metadata=: ( + Imagekit::Models::FileUploadV2Response::EmbeddedMetadata + ) -> Imagekit::Models::FileUploadV2Response::EmbeddedMetadata + + attr_reader extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus? + + def extension_status=: ( + Imagekit::Models::FileUploadV2Response::ExtensionStatus + ) -> Imagekit::Models::FileUploadV2Response::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader metadata: Imagekit::Models::FileUploadV2Response::Metadata? + + def metadata=: ( + Imagekit::Models::FileUploadV2Response::Metadata + ) -> Imagekit::Models::FileUploadV2Response::Metadata + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail_url: String? + + def thumbnail_url=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::FileUploadV2Response::VersionInfo? + + def version_info=: ( + Imagekit::Models::FileUploadV2Response::VersionInfo + ) -> Imagekit::Models::FileUploadV2Response::VersionInfo + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::FileUploadV2Response::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?duration: Integer, + ?embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, + ?extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?metadata: Imagekit::Models::FileUploadV2Response::Metadata, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail_url: String, + ?url: String, + ?version_info: Imagekit::Models::FileUploadV2Response::VersionInfo, + ?video_codec: String, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::FileUploadV2Response::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: top, + duration: Integer, + embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, + extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Models::FileUploadV2Response::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadV2Response::VersionInfo, + video_codec: String, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type embedded_metadata = + { + about_cv_term_cv_id: String, + about_cv_term_id: String, + about_cv_term_name: String, + about_cv_term_refined_about: String, + additional_model_information: String, + application_record_version: Integer, + artist: String, + artwork_circa_date_created: String, + artwork_content_description: String, + artwork_contribution_description: String, + artwork_copyright_notice: String, + artwork_copyright_owner_id: String, + artwork_copyright_owner_name: String, + artwork_creator: ::Array[String], + artwork_creator_id: ::Array[String], + artwork_date_created: Time, + artwork_licensor_id: String, + artwork_licensor_name: String, + artwork_physical_description: String, + artwork_source: String, + artwork_source_inventory_no: String, + artwork_source_inv_url: String, + artwork_style_period: ::Array[String], + artwork_title: String, + authors_position: String, + byline: String, + byline_title: String, + caption: String, + caption_abstract: String, + caption_writer: String, + city: String, + color_space: String, + components_configuration: String, + copyright: String, + copyright_notice: String, + copyright_owner_id: ::Array[String], + copyright_owner_name: ::Array[String], + country: String, + country_code: String, + country_primary_location_code: String, + country_primary_location_name: String, + creator: String, + creator_address: String, + creator_city: String, + creator_country: String, + creator_postal_code: String, + creator_region: String, + creator_work_email: String, + creator_work_telephone: String, + creator_work_url: String, + credit: String, + date_created: Time, + date_time_created: Time, + date_time_original: Time, + description: String, + digital_image_guid: String, + digital_source_type: String, + embedded_encoded_rights_expr: String, + embedded_encoded_rights_expr_lang_id: String, + embedded_encoded_rights_expr_type: String, + event: String, + exif_version: String, + flashpix_version: String, + genre_cv_id: String, + genre_cv_term_id: String, + genre_cv_term_name: String, + genre_cv_term_refined_about: String, + headline: String, + image_creator_id: String, + image_creator_image_id: String, + image_creator_name: String, + image_description: String, + image_region_boundary_h: ::Array[Float], + image_region_boundary_rx: ::Array[Float], + image_region_boundary_shape: ::Array[String], + image_region_boundary_unit: ::Array[String], + image_region_boundary_vertices_x: ::Array[Float], + image_region_boundary_vertices_y: ::Array[Float], + image_region_boundary_w: ::Array[Float], + image_region_boundary_x: ::Array[Float], + image_region_boundary_y: ::Array[Float], + image_region_ctype_identifier: ::Array[String], + image_region_ctype_name: ::Array[String], + image_region_id: ::Array[String], + image_region_name: ::Array[String], + image_region_organisation_in_image_name: ::Array[String], + image_region_person_in_image: ::Array[String], + image_region_role_identifier: ::Array[String], + image_region_role_name: ::Array[String], + image_supplier_id: String, + image_supplier_image_id: String, + image_supplier_name: String, + instructions: String, + intellectual_genre: String, + keywords: ::Array[String], + licensor_city: ::Array[String], + licensor_country: ::Array[String], + licensor_email: ::Array[String], + licensor_extended_address: ::Array[String], + licensor_id: ::Array[String], + licensor_name: ::Array[String], + licensor_postal_code: ::Array[String], + licensor_region: ::Array[String], + licensor_street_address: ::Array[String], + :licensor_telephone1 => ::Array[String], + :licensor_telephone2 => ::Array[String], + licensor_url: ::Array[String], + linked_encoded_rights_expr: String, + linked_encoded_rights_expr_lang_id: String, + linked_encoded_rights_expr_type: String, + location: String, + location_created_city: String, + location_created_country_code: String, + location_created_country_name: String, + location_created_gps_altitude: String, + location_created_gps_latitude: String, + location_created_gps_longitude: String, + location_created_location_id: String, + location_created_location_name: String, + location_created_province_state: String, + location_created_sublocation: String, + location_created_world_region: String, + location_shown_city: ::Array[String], + location_shown_country_code: ::Array[String], + location_shown_country_name: ::Array[String], + location_shown_gps_altitude: ::Array[String], + location_shown_gps_latitude: ::Array[String], + location_shown_gps_longitude: ::Array[String], + location_shown_location_id: ::Array[String], + location_shown_location_name: ::Array[String], + location_shown_province_state: ::Array[String], + location_shown_sublocation: ::Array[String], + location_shown_world_region: ::Array[String], + max_avail_height: Float, + max_avail_width: Float, + model_age: ::Array[Float], + model_release_id: ::Array[String], + object_attribute_reference: String, + object_name: String, + offset_time_original: String, + organisation_in_image_code: ::Array[String], + organisation_in_image_name: ::Array[String], + orientation: String, + original_transmission_reference: String, + person_in_image: ::Array[String], + person_in_image_cv_term_cv_id: ::Array[String], + person_in_image_cv_term_id: ::Array[String], + person_in_image_cv_term_name: ::Array[String], + person_in_image_cv_term_refined_about: ::Array[String], + person_in_image_description: ::Array[String], + person_in_image_id: ::Array[String], + person_in_image_name: ::Array[String], + product_in_image_description: ::Array[String], + product_in_image_gtin: ::Array[Float], + product_in_image_name: ::Array[String], + property_release_id: ::Array[String], + province_state: String, + rating: Integer, + registry_entry_role: ::Array[String], + registry_item_id: ::Array[String], + registry_organisation_id: ::Array[String], + resolution_unit: String, + rights: String, + scene: ::Array[String], + source: String, + special_instructions: String, + state: String, + subject: ::Array[String], + subject_code: ::Array[String], + subject_reference: ::Array[String], + sublocation: String, + time_created: String, + title: String, + transmission_reference: String, + usage_terms: String, + web_statement: String, + writer: String, + writer_editor: String, + x_resolution: Float, + y_resolution: Float + } + + class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel + attr_reader about_cv_term_cv_id: String? + + def about_cv_term_cv_id=: (String) -> String + + attr_reader about_cv_term_id: String? + + def about_cv_term_id=: (String) -> String + + attr_reader about_cv_term_name: String? + + def about_cv_term_name=: (String) -> String + + attr_reader about_cv_term_refined_about: String? + + def about_cv_term_refined_about=: (String) -> String + + attr_reader additional_model_information: String? + + def additional_model_information=: (String) -> String + + attr_reader application_record_version: Integer? + + def application_record_version=: (Integer) -> Integer + + attr_reader artist: String? + + def artist=: (String) -> String + + attr_reader artwork_circa_date_created: String? + + def artwork_circa_date_created=: (String) -> String + + attr_reader artwork_content_description: String? + + def artwork_content_description=: (String) -> String + + attr_reader artwork_contribution_description: String? + + def artwork_contribution_description=: (String) -> String + + attr_reader artwork_copyright_notice: String? + + def artwork_copyright_notice=: (String) -> String + + attr_reader artwork_copyright_owner_id: String? + + def artwork_copyright_owner_id=: (String) -> String + + attr_reader artwork_copyright_owner_name: String? + + def artwork_copyright_owner_name=: (String) -> String + + attr_reader artwork_creator: ::Array[String]? + + def artwork_creator=: (::Array[String]) -> ::Array[String] + + attr_reader artwork_creator_id: ::Array[String]? + + def artwork_creator_id=: (::Array[String]) -> ::Array[String] + + attr_reader artwork_date_created: Time? + + def artwork_date_created=: (Time) -> Time + + attr_reader artwork_licensor_id: String? + + def artwork_licensor_id=: (String) -> String + + attr_reader artwork_licensor_name: String? + + def artwork_licensor_name=: (String) -> String + + attr_reader artwork_physical_description: String? + + def artwork_physical_description=: (String) -> String + + attr_reader artwork_source: String? + + def artwork_source=: (String) -> String + + attr_reader artwork_source_inventory_no: String? + + def artwork_source_inventory_no=: (String) -> String + + attr_reader artwork_source_inv_url: String? + + def artwork_source_inv_url=: (String) -> String + + attr_reader artwork_style_period: ::Array[String]? + + def artwork_style_period=: (::Array[String]) -> ::Array[String] + + attr_reader artwork_title: String? + + def artwork_title=: (String) -> String + + attr_reader authors_position: String? + + def authors_position=: (String) -> String + + attr_reader byline: String? + + def byline=: (String) -> String + + attr_reader byline_title: String? + + def byline_title=: (String) -> String + + attr_reader caption: String? + + def caption=: (String) -> String + + attr_reader caption_abstract: String? + + def caption_abstract=: (String) -> String + + attr_reader caption_writer: String? + + def caption_writer=: (String) -> String + + attr_reader city: String? + + def city=: (String) -> String + + attr_reader color_space: String? + + def color_space=: (String) -> String + + attr_reader components_configuration: String? + + def components_configuration=: (String) -> String + + attr_reader copyright: String? + + def copyright=: (String) -> String + + attr_reader copyright_notice: String? + + def copyright_notice=: (String) -> String + + attr_reader copyright_owner_id: ::Array[String]? + + def copyright_owner_id=: (::Array[String]) -> ::Array[String] + + attr_reader copyright_owner_name: ::Array[String]? + + def copyright_owner_name=: (::Array[String]) -> ::Array[String] + + attr_reader country: String? + + def country=: (String) -> String + + attr_reader country_code: String? + + def country_code=: (String) -> String + + attr_reader country_primary_location_code: String? + + def country_primary_location_code=: (String) -> String + + attr_reader country_primary_location_name: String? + + def country_primary_location_name=: (String) -> String + + attr_reader creator: String? + + def creator=: (String) -> String + + attr_reader creator_address: String? + + def creator_address=: (String) -> String + + attr_reader creator_city: String? + + def creator_city=: (String) -> String + + attr_reader creator_country: String? + + def creator_country=: (String) -> String + + attr_reader creator_postal_code: String? + + def creator_postal_code=: (String) -> String + + attr_reader creator_region: String? + + def creator_region=: (String) -> String + + attr_reader creator_work_email: String? + + def creator_work_email=: (String) -> String + + attr_reader creator_work_telephone: String? + + def creator_work_telephone=: (String) -> String + + attr_reader creator_work_url: String? + + def creator_work_url=: (String) -> String + + attr_reader credit: String? + + def credit=: (String) -> String + + attr_reader date_created: Time? + + def date_created=: (Time) -> Time + + attr_reader date_time_created: Time? + + def date_time_created=: (Time) -> Time + + attr_reader date_time_original: Time? + + def date_time_original=: (Time) -> Time + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader digital_image_guid: String? + + def digital_image_guid=: (String) -> String + + attr_reader digital_source_type: String? + + def digital_source_type=: (String) -> String + + attr_reader embedded_encoded_rights_expr: String? + + def embedded_encoded_rights_expr=: (String) -> String + + attr_reader embedded_encoded_rights_expr_lang_id: String? + + def embedded_encoded_rights_expr_lang_id=: (String) -> String + + attr_reader embedded_encoded_rights_expr_type: String? + + def embedded_encoded_rights_expr_type=: (String) -> String + + attr_reader event: String? + + def event=: (String) -> String + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader genre_cv_id: String? + + def genre_cv_id=: (String) -> String + + attr_reader genre_cv_term_id: String? + + def genre_cv_term_id=: (String) -> String + + attr_reader genre_cv_term_name: String? + + def genre_cv_term_name=: (String) -> String + + attr_reader genre_cv_term_refined_about: String? + + def genre_cv_term_refined_about=: (String) -> String + + attr_reader headline: String? + + def headline=: (String) -> String + + attr_reader image_creator_id: String? + + def image_creator_id=: (String) -> String + + attr_reader image_creator_image_id: String? + + def image_creator_image_id=: (String) -> String + + attr_reader image_creator_name: String? + + def image_creator_name=: (String) -> String + + attr_reader image_description: String? + + def image_description=: (String) -> String + + attr_reader image_region_boundary_h: ::Array[Float]? + + def image_region_boundary_h=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_boundary_rx: ::Array[Float]? + + def image_region_boundary_rx=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_boundary_shape: ::Array[String]? + + def image_region_boundary_shape=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_boundary_unit: ::Array[String]? + + def image_region_boundary_unit=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_boundary_vertices_x: ::Array[Float]? + + def image_region_boundary_vertices_x=: ( + ::Array[Float] + ) -> ::Array[Float] + + attr_reader image_region_boundary_vertices_y: ::Array[Float]? + + def image_region_boundary_vertices_y=: ( + ::Array[Float] + ) -> ::Array[Float] + + attr_reader image_region_boundary_w: ::Array[Float]? + + def image_region_boundary_w=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_boundary_x: ::Array[Float]? + + def image_region_boundary_x=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_boundary_y: ::Array[Float]? + + def image_region_boundary_y=: (::Array[Float]) -> ::Array[Float] + + attr_reader image_region_ctype_identifier: ::Array[String]? + + def image_region_ctype_identifier=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_ctype_name: ::Array[String]? + + def image_region_ctype_name=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_id: ::Array[String]? + + def image_region_id=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_name: ::Array[String]? + + def image_region_name=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_organisation_in_image_name: ::Array[String]? + + def image_region_organisation_in_image_name=: ( + ::Array[String] + ) -> ::Array[String] + + attr_reader image_region_person_in_image: ::Array[String]? + + def image_region_person_in_image=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_role_identifier: ::Array[String]? + + def image_region_role_identifier=: (::Array[String]) -> ::Array[String] + + attr_reader image_region_role_name: ::Array[String]? + + def image_region_role_name=: (::Array[String]) -> ::Array[String] + + attr_reader image_supplier_id: String? + + def image_supplier_id=: (String) -> String + + attr_reader image_supplier_image_id: String? + + def image_supplier_image_id=: (String) -> String + + attr_reader image_supplier_name: String? + + def image_supplier_name=: (String) -> String + + attr_reader instructions: String? + + def instructions=: (String) -> String + + attr_reader intellectual_genre: String? + + def intellectual_genre=: (String) -> String + + attr_reader keywords: ::Array[String]? + + def keywords=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_city: ::Array[String]? + + def licensor_city=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_country: ::Array[String]? + + def licensor_country=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_email: ::Array[String]? + + def licensor_email=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_extended_address: ::Array[String]? + + def licensor_extended_address=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_id: ::Array[String]? + + def licensor_id=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_name: ::Array[String]? + + def licensor_name=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_postal_code: ::Array[String]? + + def licensor_postal_code=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_region: ::Array[String]? + + def licensor_region=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_street_address: ::Array[String]? + + def licensor_street_address=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_telephone1: ::Array[String]? + + def licensor_telephone1=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_telephone2: ::Array[String]? + + def licensor_telephone2=: (::Array[String]) -> ::Array[String] + + attr_reader licensor_url: ::Array[String]? + + def licensor_url=: (::Array[String]) -> ::Array[String] + + attr_reader linked_encoded_rights_expr: String? + + def linked_encoded_rights_expr=: (String) -> String + + attr_reader linked_encoded_rights_expr_lang_id: String? + + def linked_encoded_rights_expr_lang_id=: (String) -> String + + attr_reader linked_encoded_rights_expr_type: String? + + def linked_encoded_rights_expr_type=: (String) -> String + + attr_reader location: String? + + def location=: (String) -> String + + attr_reader location_created_city: String? + + def location_created_city=: (String) -> String + + attr_reader location_created_country_code: String? + + def location_created_country_code=: (String) -> String + + attr_reader location_created_country_name: String? + + def location_created_country_name=: (String) -> String + + attr_reader location_created_gps_altitude: String? + + def location_created_gps_altitude=: (String) -> String + + attr_reader location_created_gps_latitude: String? + + def location_created_gps_latitude=: (String) -> String + + attr_reader location_created_gps_longitude: String? + + def location_created_gps_longitude=: (String) -> String + + attr_reader location_created_location_id: String? + + def location_created_location_id=: (String) -> String + + attr_reader location_created_location_name: String? + + def location_created_location_name=: (String) -> String + + attr_reader location_created_province_state: String? + + def location_created_province_state=: (String) -> String + + attr_reader location_created_sublocation: String? + + def location_created_sublocation=: (String) -> String + + attr_reader location_created_world_region: String? + + def location_created_world_region=: (String) -> String + + attr_reader location_shown_city: ::Array[String]? + + def location_shown_city=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_country_code: ::Array[String]? + + def location_shown_country_code=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_country_name: ::Array[String]? + + def location_shown_country_name=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_gps_altitude: ::Array[String]? + + def location_shown_gps_altitude=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_gps_latitude: ::Array[String]? + + def location_shown_gps_latitude=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_gps_longitude: ::Array[String]? + + def location_shown_gps_longitude=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_location_id: ::Array[String]? + + def location_shown_location_id=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_location_name: ::Array[String]? + + def location_shown_location_name=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_province_state: ::Array[String]? + + def location_shown_province_state=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_sublocation: ::Array[String]? + + def location_shown_sublocation=: (::Array[String]) -> ::Array[String] + + attr_reader location_shown_world_region: ::Array[String]? + + def location_shown_world_region=: (::Array[String]) -> ::Array[String] + + attr_reader max_avail_height: Float? + + def max_avail_height=: (Float) -> Float + + attr_reader max_avail_width: Float? + + def max_avail_width=: (Float) -> Float + + attr_reader model_age: ::Array[Float]? + + def model_age=: (::Array[Float]) -> ::Array[Float] + + attr_reader model_release_id: ::Array[String]? + + def model_release_id=: (::Array[String]) -> ::Array[String] + + attr_reader object_attribute_reference: String? + + def object_attribute_reference=: (String) -> String + + attr_reader object_name: String? + + def object_name=: (String) -> String + + attr_reader offset_time_original: String? + + def offset_time_original=: (String) -> String + + attr_reader organisation_in_image_code: ::Array[String]? + + def organisation_in_image_code=: (::Array[String]) -> ::Array[String] + + attr_reader organisation_in_image_name: ::Array[String]? + + def organisation_in_image_name=: (::Array[String]) -> ::Array[String] + + attr_reader orientation: String? + + def orientation=: (String) -> String + + attr_reader original_transmission_reference: String? + + def original_transmission_reference=: (String) -> String + + attr_reader person_in_image: ::Array[String]? + + def person_in_image=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_cv_term_cv_id: ::Array[String]? + + def person_in_image_cv_term_cv_id=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_cv_term_id: ::Array[String]? + + def person_in_image_cv_term_id=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_cv_term_name: ::Array[String]? + + def person_in_image_cv_term_name=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_cv_term_refined_about: ::Array[String]? + + def person_in_image_cv_term_refined_about=: ( + ::Array[String] + ) -> ::Array[String] + + attr_reader person_in_image_description: ::Array[String]? + + def person_in_image_description=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_id: ::Array[String]? + + def person_in_image_id=: (::Array[String]) -> ::Array[String] + + attr_reader person_in_image_name: ::Array[String]? + + def person_in_image_name=: (::Array[String]) -> ::Array[String] + + attr_reader product_in_image_description: ::Array[String]? + + def product_in_image_description=: (::Array[String]) -> ::Array[String] + + attr_reader product_in_image_gtin: ::Array[Float]? + + def product_in_image_gtin=: (::Array[Float]) -> ::Array[Float] + + attr_reader product_in_image_name: ::Array[String]? + + def product_in_image_name=: (::Array[String]) -> ::Array[String] + + attr_reader property_release_id: ::Array[String]? + + def property_release_id=: (::Array[String]) -> ::Array[String] + + attr_reader province_state: String? + + def province_state=: (String) -> String + + attr_reader rating: Integer? + + def rating=: (Integer) -> Integer + + attr_reader registry_entry_role: ::Array[String]? + + def registry_entry_role=: (::Array[String]) -> ::Array[String] + + attr_reader registry_item_id: ::Array[String]? + + def registry_item_id=: (::Array[String]) -> ::Array[String] + + attr_reader registry_organisation_id: ::Array[String]? + + def registry_organisation_id=: (::Array[String]) -> ::Array[String] + + attr_reader resolution_unit: String? + + def resolution_unit=: (String) -> String + + attr_reader rights: String? + + def rights=: (String) -> String + + attr_reader scene: ::Array[String]? + + def scene=: (::Array[String]) -> ::Array[String] + + attr_reader source: String? + + def source=: (String) -> String + + attr_reader special_instructions: String? + + def special_instructions=: (String) -> String + + attr_reader state: String? + + def state=: (String) -> String + + attr_reader subject: ::Array[String]? + + def subject=: (::Array[String]) -> ::Array[String] + + attr_reader subject_code: ::Array[String]? + + def subject_code=: (::Array[String]) -> ::Array[String] + + attr_reader subject_reference: ::Array[String]? + + def subject_reference=: (::Array[String]) -> ::Array[String] + + attr_reader sublocation: String? + + def sublocation=: (String) -> String + + attr_reader time_created: String? + + def time_created=: (String) -> String + + attr_reader title: String? + + def title=: (String) -> String + + attr_reader transmission_reference: String? + + def transmission_reference=: (String) -> String + + attr_reader usage_terms: String? + + def usage_terms=: (String) -> String + + attr_reader web_statement: String? + + def web_statement=: (String) -> String + + attr_reader writer: String? + + def writer=: (String) -> String + + attr_reader writer_editor: String? + + def writer_editor=: (String) -> String + + attr_reader x_resolution: Float? + + def x_resolution=: (Float) -> Float + + attr_reader y_resolution: Float? + + def y_resolution=: (Float) -> Float + + def initialize: ( + ?about_cv_term_cv_id: String, + ?about_cv_term_id: String, + ?about_cv_term_name: String, + ?about_cv_term_refined_about: String, + ?additional_model_information: String, + ?application_record_version: Integer, + ?artist: String, + ?artwork_circa_date_created: String, + ?artwork_content_description: String, + ?artwork_contribution_description: String, + ?artwork_copyright_notice: String, + ?artwork_copyright_owner_id: String, + ?artwork_copyright_owner_name: String, + ?artwork_creator: ::Array[String], + ?artwork_creator_id: ::Array[String], + ?artwork_date_created: Time, + ?artwork_licensor_id: String, + ?artwork_licensor_name: String, + ?artwork_physical_description: String, + ?artwork_source: String, + ?artwork_source_inventory_no: String, + ?artwork_source_inv_url: String, + ?artwork_style_period: ::Array[String], + ?artwork_title: String, + ?authors_position: String, + ?byline: String, + ?byline_title: String, + ?caption: String, + ?caption_abstract: String, + ?caption_writer: String, + ?city: String, + ?color_space: String, + ?components_configuration: String, + ?copyright: String, + ?copyright_notice: String, + ?copyright_owner_id: ::Array[String], + ?copyright_owner_name: ::Array[String], + ?country: String, + ?country_code: String, + ?country_primary_location_code: String, + ?country_primary_location_name: String, + ?creator: String, + ?creator_address: String, + ?creator_city: String, + ?creator_country: String, + ?creator_postal_code: String, + ?creator_region: String, + ?creator_work_email: String, + ?creator_work_telephone: String, + ?creator_work_url: String, + ?credit: String, + ?date_created: Time, + ?date_time_created: Time, + ?date_time_original: Time, + ?description: String, + ?digital_image_guid: String, + ?digital_source_type: String, + ?embedded_encoded_rights_expr: String, + ?embedded_encoded_rights_expr_lang_id: String, + ?embedded_encoded_rights_expr_type: String, + ?event: String, + ?exif_version: String, + ?flashpix_version: String, + ?genre_cv_id: String, + ?genre_cv_term_id: String, + ?genre_cv_term_name: String, + ?genre_cv_term_refined_about: String, + ?headline: String, + ?image_creator_id: String, + ?image_creator_image_id: String, + ?image_creator_name: String, + ?image_description: String, + ?image_region_boundary_h: ::Array[Float], + ?image_region_boundary_rx: ::Array[Float], + ?image_region_boundary_shape: ::Array[String], + ?image_region_boundary_unit: ::Array[String], + ?image_region_boundary_vertices_x: ::Array[Float], + ?image_region_boundary_vertices_y: ::Array[Float], + ?image_region_boundary_w: ::Array[Float], + ?image_region_boundary_x: ::Array[Float], + ?image_region_boundary_y: ::Array[Float], + ?image_region_ctype_identifier: ::Array[String], + ?image_region_ctype_name: ::Array[String], + ?image_region_id: ::Array[String], + ?image_region_name: ::Array[String], + ?image_region_organisation_in_image_name: ::Array[String], + ?image_region_person_in_image: ::Array[String], + ?image_region_role_identifier: ::Array[String], + ?image_region_role_name: ::Array[String], + ?image_supplier_id: String, + ?image_supplier_image_id: String, + ?image_supplier_name: String, + ?instructions: String, + ?intellectual_genre: String, + ?keywords: ::Array[String], + ?licensor_city: ::Array[String], + ?licensor_country: ::Array[String], + ?licensor_email: ::Array[String], + ?licensor_extended_address: ::Array[String], + ?licensor_id: ::Array[String], + ?licensor_name: ::Array[String], + ?licensor_postal_code: ::Array[String], + ?licensor_region: ::Array[String], + ?licensor_street_address: ::Array[String], + ?licensor_telephone1: ::Array[String], + ?licensor_telephone2: ::Array[String], + ?licensor_url: ::Array[String], + ?linked_encoded_rights_expr: String, + ?linked_encoded_rights_expr_lang_id: String, + ?linked_encoded_rights_expr_type: String, + ?location: String, + ?location_created_city: String, + ?location_created_country_code: String, + ?location_created_country_name: String, + ?location_created_gps_altitude: String, + ?location_created_gps_latitude: String, + ?location_created_gps_longitude: String, + ?location_created_location_id: String, + ?location_created_location_name: String, + ?location_created_province_state: String, + ?location_created_sublocation: String, + ?location_created_world_region: String, + ?location_shown_city: ::Array[String], + ?location_shown_country_code: ::Array[String], + ?location_shown_country_name: ::Array[String], + ?location_shown_gps_altitude: ::Array[String], + ?location_shown_gps_latitude: ::Array[String], + ?location_shown_gps_longitude: ::Array[String], + ?location_shown_location_id: ::Array[String], + ?location_shown_location_name: ::Array[String], + ?location_shown_province_state: ::Array[String], + ?location_shown_sublocation: ::Array[String], + ?location_shown_world_region: ::Array[String], + ?max_avail_height: Float, + ?max_avail_width: Float, + ?model_age: ::Array[Float], + ?model_release_id: ::Array[String], + ?object_attribute_reference: String, + ?object_name: String, + ?offset_time_original: String, + ?organisation_in_image_code: ::Array[String], + ?organisation_in_image_name: ::Array[String], + ?orientation: String, + ?original_transmission_reference: String, + ?person_in_image: ::Array[String], + ?person_in_image_cv_term_cv_id: ::Array[String], + ?person_in_image_cv_term_id: ::Array[String], + ?person_in_image_cv_term_name: ::Array[String], + ?person_in_image_cv_term_refined_about: ::Array[String], + ?person_in_image_description: ::Array[String], + ?person_in_image_id: ::Array[String], + ?person_in_image_name: ::Array[String], + ?product_in_image_description: ::Array[String], + ?product_in_image_gtin: ::Array[Float], + ?product_in_image_name: ::Array[String], + ?property_release_id: ::Array[String], + ?province_state: String, + ?rating: Integer, + ?registry_entry_role: ::Array[String], + ?registry_item_id: ::Array[String], + ?registry_organisation_id: ::Array[String], + ?resolution_unit: String, + ?rights: String, + ?scene: ::Array[String], + ?source: String, + ?special_instructions: String, + ?state: String, + ?subject: ::Array[String], + ?subject_code: ::Array[String], + ?subject_reference: ::Array[String], + ?sublocation: String, + ?time_created: String, + ?title: String, + ?transmission_reference: String, + ?usage_terms: String, + ?web_statement: String, + ?writer: String, + ?writer_editor: String, + ?x_resolution: Float, + ?y_resolution: Float + ) -> void + + def to_hash: -> { + about_cv_term_cv_id: String, + about_cv_term_id: String, + about_cv_term_name: String, + about_cv_term_refined_about: String, + additional_model_information: String, + application_record_version: Integer, + artist: String, + artwork_circa_date_created: String, + artwork_content_description: String, + artwork_contribution_description: String, + artwork_copyright_notice: String, + artwork_copyright_owner_id: String, + artwork_copyright_owner_name: String, + artwork_creator: ::Array[String], + artwork_creator_id: ::Array[String], + artwork_date_created: Time, + artwork_licensor_id: String, + artwork_licensor_name: String, + artwork_physical_description: String, + artwork_source: String, + artwork_source_inventory_no: String, + artwork_source_inv_url: String, + artwork_style_period: ::Array[String], + artwork_title: String, + authors_position: String, + byline: String, + byline_title: String, + caption: String, + caption_abstract: String, + caption_writer: String, + city: String, + color_space: String, + components_configuration: String, + copyright: String, + copyright_notice: String, + copyright_owner_id: ::Array[String], + copyright_owner_name: ::Array[String], + country: String, + country_code: String, + country_primary_location_code: String, + country_primary_location_name: String, + creator: String, + creator_address: String, + creator_city: String, + creator_country: String, + creator_postal_code: String, + creator_region: String, + creator_work_email: String, + creator_work_telephone: String, + creator_work_url: String, + credit: String, + date_created: Time, + date_time_created: Time, + date_time_original: Time, + description: String, + digital_image_guid: String, + digital_source_type: String, + embedded_encoded_rights_expr: String, + embedded_encoded_rights_expr_lang_id: String, + embedded_encoded_rights_expr_type: String, + event: String, + exif_version: String, + flashpix_version: String, + genre_cv_id: String, + genre_cv_term_id: String, + genre_cv_term_name: String, + genre_cv_term_refined_about: String, + headline: String, + image_creator_id: String, + image_creator_image_id: String, + image_creator_name: String, + image_description: String, + image_region_boundary_h: ::Array[Float], + image_region_boundary_rx: ::Array[Float], + image_region_boundary_shape: ::Array[String], + image_region_boundary_unit: ::Array[String], + image_region_boundary_vertices_x: ::Array[Float], + image_region_boundary_vertices_y: ::Array[Float], + image_region_boundary_w: ::Array[Float], + image_region_boundary_x: ::Array[Float], + image_region_boundary_y: ::Array[Float], + image_region_ctype_identifier: ::Array[String], + image_region_ctype_name: ::Array[String], + image_region_id: ::Array[String], + image_region_name: ::Array[String], + image_region_organisation_in_image_name: ::Array[String], + image_region_person_in_image: ::Array[String], + image_region_role_identifier: ::Array[String], + image_region_role_name: ::Array[String], + image_supplier_id: String, + image_supplier_image_id: String, + image_supplier_name: String, + instructions: String, + intellectual_genre: String, + keywords: ::Array[String], + licensor_city: ::Array[String], + licensor_country: ::Array[String], + licensor_email: ::Array[String], + licensor_extended_address: ::Array[String], + licensor_id: ::Array[String], + licensor_name: ::Array[String], + licensor_postal_code: ::Array[String], + licensor_region: ::Array[String], + licensor_street_address: ::Array[String], + :licensor_telephone1 => ::Array[String], + :licensor_telephone2 => ::Array[String], + licensor_url: ::Array[String], + linked_encoded_rights_expr: String, + linked_encoded_rights_expr_lang_id: String, + linked_encoded_rights_expr_type: String, + location: String, + location_created_city: String, + location_created_country_code: String, + location_created_country_name: String, + location_created_gps_altitude: String, + location_created_gps_latitude: String, + location_created_gps_longitude: String, + location_created_location_id: String, + location_created_location_name: String, + location_created_province_state: String, + location_created_sublocation: String, + location_created_world_region: String, + location_shown_city: ::Array[String], + location_shown_country_code: ::Array[String], + location_shown_country_name: ::Array[String], + location_shown_gps_altitude: ::Array[String], + location_shown_gps_latitude: ::Array[String], + location_shown_gps_longitude: ::Array[String], + location_shown_location_id: ::Array[String], + location_shown_location_name: ::Array[String], + location_shown_province_state: ::Array[String], + location_shown_sublocation: ::Array[String], + location_shown_world_region: ::Array[String], + max_avail_height: Float, + max_avail_width: Float, + model_age: ::Array[Float], + model_release_id: ::Array[String], + object_attribute_reference: String, + object_name: String, + offset_time_original: String, + organisation_in_image_code: ::Array[String], + organisation_in_image_name: ::Array[String], + orientation: String, + original_transmission_reference: String, + person_in_image: ::Array[String], + person_in_image_cv_term_cv_id: ::Array[String], + person_in_image_cv_term_id: ::Array[String], + person_in_image_cv_term_name: ::Array[String], + person_in_image_cv_term_refined_about: ::Array[String], + person_in_image_description: ::Array[String], + person_in_image_id: ::Array[String], + person_in_image_name: ::Array[String], + product_in_image_description: ::Array[String], + product_in_image_gtin: ::Array[Float], + product_in_image_name: ::Array[String], + property_release_id: ::Array[String], + province_state: String, + rating: Integer, + registry_entry_role: ::Array[String], + registry_item_id: ::Array[String], + registry_organisation_id: ::Array[String], + resolution_unit: String, + rights: String, + scene: ::Array[String], + source: String, + special_instructions: String, + state: String, + subject: ::Array[String], + subject_code: ::Array[String], + subject_reference: ::Array[String], + sublocation: String, + time_created: String, + title: String, + transmission_reference: String, + usage_terms: String, + web_statement: String, + writer: String, + writer_editor: String, + x_resolution: Float, + y_resolution: Float + } + end + + type extension_status = + { + aws_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader aws_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging + ) -> Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging + ) -> Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg + ) -> Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg + + def initialize: ( + ?aws_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + aws_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg + } + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg] + end + end + + type metadata = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class Metadata < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif? + + def exif=: ( + Imagekit::Models::FileUploadV2Response::Metadata::Exif + ) -> Imagekit::Models::FileUploadV2Response::Metadata::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::ExifDetails? + + def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails + + attr_reader gps: Imagekit::Gps? + + def gps=: (Imagekit::Gps) -> Imagekit::Gps + + attr_reader image: Imagekit::ExifImage? + + def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage + + attr_reader interoperability: Imagekit::Interoperability? + + def interoperability=: ( + Imagekit::Interoperability + ) -> Imagekit::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Thumbnail? + + def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail + + def initialize: ( + ?exif: Imagekit::ExifDetails, + ?gps: Imagekit::Gps, + ?image: Imagekit::ExifImage, + ?interoperability: Imagekit::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Thumbnail + } + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end +end diff --git a/sig/imagekit/models/files/batch_delete_params.rbs b/sig/imagekit/models/files/batch_delete_params.rbs new file mode 100644 index 00000000..418ed487 --- /dev/null +++ b/sig/imagekit/models/files/batch_delete_params.rbs @@ -0,0 +1,26 @@ +module Imagekit + module Models + module Files + type batch_delete_params = + { file_ids: ::Array[String] } + & Imagekit::Internal::Type::request_parameters + + class BatchDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_ids: ::Array[String] + + def initialize: ( + file_ids: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_ids: ::Array[String], + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/batch_delete_response.rbs b/sig/imagekit/models/files/batch_delete_response.rbs new file mode 100644 index 00000000..654f28aa --- /dev/null +++ b/sig/imagekit/models/files/batch_delete_response.rbs @@ -0,0 +1,20 @@ +module Imagekit + module Models + module Files + type batch_delete_response = + { successfully_deleted_file_ids: ::Array[String] } + + class BatchDeleteResponse < Imagekit::Internal::Type::BaseModel + attr_reader successfully_deleted_file_ids: ::Array[String]? + + def successfully_deleted_file_ids=: (::Array[String]) -> ::Array[String] + + def initialize: ( + ?successfully_deleted_file_ids: ::Array[String] + ) -> void + + def to_hash: -> { successfully_deleted_file_ids: ::Array[String] } + end + end + end +end diff --git a/sig/imagekit/models/files/detail_retrieve_params.rbs b/sig/imagekit/models/files/detail_retrieve_params.rbs new file mode 100644 index 00000000..63b2e0b8 --- /dev/null +++ b/sig/imagekit/models/files/detail_retrieve_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Files + type detail_retrieve_params = + { } & Imagekit::Internal::Type::request_parameters + + class DetailRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/files/detail_retrieve_response.rbs b/sig/imagekit/models/files/detail_retrieve_response.rbs new file mode 100644 index 00000000..71d7872b --- /dev/null +++ b/sig/imagekit/models/files/detail_retrieve_response.rbs @@ -0,0 +1,200 @@ +module Imagekit + module Models + module Files + type detail_retrieve_response = + { + ai_tags: ::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + width: Float + } + + class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag]? + + attr_reader created_at: String? + + def created_at=: (String) -> String + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader has_alpha: bool? + + def has_alpha=: (bool) -> bool + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader mime: String? + + def mime=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail: String? + + def thumbnail=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + attr_reader updated_at: String? + + def updated_at=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo? + + def version_info=: ( + Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo + ) -> Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag]?, + ?created_at: String, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?has_alpha: bool, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?mime: String, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail: String, + ?type: String, + ?updated_at: String, + ?url: String, + ?version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end + end +end diff --git a/sig/imagekit/models/files/detail_update_params.rbs b/sig/imagekit/models/files/detail_update_params.rbs new file mode 100644 index 00000000..d414df76 --- /dev/null +++ b/sig/imagekit/models/files/detail_update_params.rbs @@ -0,0 +1,227 @@ +module Imagekit + module Models + module Files + type detail_update_params = + { + custom_coordinates: String?, + custom_metadata: top, + extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension], + remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String, + publish: Imagekit::Files::DetailUpdateParams::Publish + } + & Imagekit::Internal::Type::request_parameters + + class DetailUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension]? + + def extensions=: ( + ::Array[Imagekit::Models::Files::DetailUpdateParams::extension] + ) -> ::Array[Imagekit::Models::Files::DetailUpdateParams::extension] + + attr_reader remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags? + + def remove_ai_tags=: ( + Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags + ) -> Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags + + attr_accessor tags: ::Array[String]? + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + attr_reader publish: Imagekit::Files::DetailUpdateParams::Publish? + + def publish=: ( + Imagekit::Files::DetailUpdateParams::Publish + ) -> Imagekit::Files::DetailUpdateParams::Publish + + def initialize: ( + ?custom_coordinates: String?, + ?custom_metadata: top, + ?extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension], + ?remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, + ?publish: Imagekit::Files::DetailUpdateParams::Publish, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + custom_coordinates: String?, + custom_metadata: top, + extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension], + remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String, + publish: Imagekit::Files::DetailUpdateParams::Publish, + request_options: Imagekit::RequestOptions + } + + type extension = + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension + | Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension + + module Extension + extend Imagekit::Internal::Type::Union + + type removedot_bg_extension = + { + name: Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options + } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_ + + attr_reader options: Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options? + + def options=: ( + Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options + ) -> Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options + + def initialize: ( + name: Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options + ) -> void + + def to_hash: -> { + name: Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options + } + + type name_ = :"remove-bg" + + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG: :"remove-bg" + + def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_] + end + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Files::DetailUpdateParams::extension] + end + + type remove_ai_tags = ::Array[String] | :all + + module RemoveAITags + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags] + + StringArray: Imagekit::Internal::Type::Converter + + ALL: :all + end + + type publish = { is_published: bool, include_file_versions: bool } + + class Publish < Imagekit::Internal::Type::BaseModel + attr_accessor is_published: bool + + attr_reader include_file_versions: bool? + + def include_file_versions=: (bool) -> bool + + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void + + def to_hash: -> { is_published: bool, include_file_versions: bool } + end + end + end + end +end diff --git a/sig/imagekit/models/files/detail_update_response.rbs b/sig/imagekit/models/files/detail_update_response.rbs new file mode 100644 index 00000000..2f635f1d --- /dev/null +++ b/sig/imagekit/models/files/detail_update_response.rbs @@ -0,0 +1,284 @@ +module Imagekit + module Models + module Files + type detail_update_response = + { + ai_tags: ::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, + width: Float + } + + class DetailUpdateResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag]? + + attr_reader created_at: String? + + def created_at=: (String) -> String + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus? + + def extension_status=: ( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus + ) -> Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader has_alpha: bool? + + def has_alpha=: (bool) -> bool + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader mime: String? + + def mime=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail: String? + + def thumbnail=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + attr_reader updated_at: String? + + def updated_at=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo? + + def version_info=: ( + Imagekit::Models::Files::DetailUpdateResponse::VersionInfo + ) -> Imagekit::Models::Files::DetailUpdateResponse::VersionInfo + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag]?, + ?created_at: String, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?has_alpha: bool, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?mime: String, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail: String, + ?type: String, + ?updated_at: String, + ?url: String, + ?version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type extension_status = + { + aws_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader aws_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging + ) -> Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging + ) -> Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg + ) -> Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg + + def initialize: ( + ?aws_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + aws_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg + } + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg] + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end + end +end diff --git a/sig/imagekit/models/files/metadata_from_url_params.rbs b/sig/imagekit/models/files/metadata_from_url_params.rbs new file mode 100644 index 00000000..654e1d9f --- /dev/null +++ b/sig/imagekit/models/files/metadata_from_url_params.rbs @@ -0,0 +1,25 @@ +module Imagekit + module Models + module Files + type metadata_from_url_params = + { url: String } & Imagekit::Internal::Type::request_parameters + + class MetadataFromURLParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor url: String + + def initialize: ( + url: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + url: String, + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/metadata_from_url_response.rbs b/sig/imagekit/models/files/metadata_from_url_response.rbs new file mode 100644 index 00000000..3b3dd9ed --- /dev/null +++ b/sig/imagekit/models/files/metadata_from_url_response.rbs @@ -0,0 +1,173 @@ +module Imagekit + module Models + module Files + type metadata_from_url_response = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class MetadataFromURLResponse < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif? + + def exif=: ( + Imagekit::Models::Files::MetadataFromURLResponse::Exif + ) -> Imagekit::Models::Files::MetadataFromURLResponse::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::ExifDetails? + + def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails + + attr_reader gps: Imagekit::Gps? + + def gps=: (Imagekit::Gps) -> Imagekit::Gps + + attr_reader image: Imagekit::ExifImage? + + def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage + + attr_reader interoperability: Imagekit::Interoperability? + + def interoperability=: ( + Imagekit::Interoperability + ) -> Imagekit::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Thumbnail? + + def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail + + def initialize: ( + ?exif: Imagekit::ExifDetails, + ?gps: Imagekit::Gps, + ?image: Imagekit::ExifImage, + ?interoperability: Imagekit::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Thumbnail + } + end + end + end + end +end diff --git a/sig/imagekit/models/files/metadata_retrieve_params.rbs b/sig/imagekit/models/files/metadata_retrieve_params.rbs new file mode 100644 index 00000000..5d5bae33 --- /dev/null +++ b/sig/imagekit/models/files/metadata_retrieve_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Files + type metadata_retrieve_params = + { } & Imagekit::Internal::Type::request_parameters + + class MetadataRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/files/metadata_retrieve_response.rbs b/sig/imagekit/models/files/metadata_retrieve_response.rbs new file mode 100644 index 00000000..aed29837 --- /dev/null +++ b/sig/imagekit/models/files/metadata_retrieve_response.rbs @@ -0,0 +1,173 @@ +module Imagekit + module Models + module Files + type metadata_retrieve_response = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class MetadataRetrieveResponse < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif? + + def exif=: ( + Imagekit::Models::Files::MetadataRetrieveResponse::Exif + ) -> Imagekit::Models::Files::MetadataRetrieveResponse::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::ExifDetails? + + def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails + + attr_reader gps: Imagekit::Gps? + + def gps=: (Imagekit::Gps) -> Imagekit::Gps + + attr_reader image: Imagekit::ExifImage? + + def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage + + attr_reader interoperability: Imagekit::Interoperability? + + def interoperability=: ( + Imagekit::Interoperability + ) -> Imagekit::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Thumbnail? + + def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail + + def initialize: ( + ?exif: Imagekit::ExifDetails, + ?gps: Imagekit::Gps, + ?image: Imagekit::ExifImage, + ?interoperability: Imagekit::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Thumbnail + } + end + end + end + end +end diff --git a/sig/imagekit/models/files/purge_execute_params.rbs b/sig/imagekit/models/files/purge_execute_params.rbs new file mode 100644 index 00000000..ce1c6fff --- /dev/null +++ b/sig/imagekit/models/files/purge_execute_params.rbs @@ -0,0 +1,25 @@ +module Imagekit + module Models + module Files + type purge_execute_params = + { url: String } & Imagekit::Internal::Type::request_parameters + + class PurgeExecuteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor url: String + + def initialize: ( + url: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + url: String, + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/purge_execute_response.rbs b/sig/imagekit/models/files/purge_execute_response.rbs new file mode 100644 index 00000000..3defae18 --- /dev/null +++ b/sig/imagekit/models/files/purge_execute_response.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Files + type purge_execute_response = { request_id: String } + + class PurgeExecuteResponse < Imagekit::Internal::Type::BaseModel + attr_reader request_id: String? + + def request_id=: (String) -> String + + def initialize: (?request_id: String) -> void + + def to_hash: -> { request_id: String } + end + end + end +end diff --git a/sig/imagekit/models/files/purge_status_params.rbs b/sig/imagekit/models/files/purge_status_params.rbs new file mode 100644 index 00000000..6a4a291b --- /dev/null +++ b/sig/imagekit/models/files/purge_status_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Files + type purge_status_params = + { } & Imagekit::Internal::Type::request_parameters + + class PurgeStatusParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/files/purge_status_response.rbs b/sig/imagekit/models/files/purge_status_response.rbs new file mode 100644 index 00000000..d1beea8b --- /dev/null +++ b/sig/imagekit/models/files/purge_status_response.rbs @@ -0,0 +1,35 @@ +module Imagekit + module Models + module Files + type purge_status_response = + { status: Imagekit::Models::Files::PurgeStatusResponse::status } + + class PurgeStatusResponse < Imagekit::Internal::Type::BaseModel + attr_reader status: Imagekit::Models::Files::PurgeStatusResponse::status? + + def status=: ( + Imagekit::Models::Files::PurgeStatusResponse::status + ) -> Imagekit::Models::Files::PurgeStatusResponse::status + + def initialize: ( + ?status: Imagekit::Models::Files::PurgeStatusResponse::status + ) -> void + + def to_hash: -> { + status: Imagekit::Models::Files::PurgeStatusResponse::status + } + + type status = :Pending | :Completed + + module Status + extend Imagekit::Internal::Type::Enum + + PENDING: :Pending + COMPLETED: :Completed + + def self?.values: -> ::Array[Imagekit::Models::Files::PurgeStatusResponse::status] + end + end + end + end +end diff --git a/sig/imagekit/models/files/version_delete_params.rbs b/sig/imagekit/models/files/version_delete_params.rbs new file mode 100644 index 00000000..9a480932 --- /dev/null +++ b/sig/imagekit/models/files/version_delete_params.rbs @@ -0,0 +1,25 @@ +module Imagekit + module Models + module Files + type version_delete_params = + { file_id: String } & Imagekit::Internal::Type::request_parameters + + class VersionDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_id: String + + def initialize: ( + file_id: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_id: String, + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/version_delete_response.rbs b/sig/imagekit/models/files/version_delete_response.rbs new file mode 100644 index 00000000..867baddf --- /dev/null +++ b/sig/imagekit/models/files/version_delete_response.rbs @@ -0,0 +1,7 @@ +module Imagekit + module Models + module Files + VersionDeleteResponse: Imagekit::Internal::Type::Converter + end + end +end diff --git a/sig/imagekit/models/files/version_list_params.rbs b/sig/imagekit/models/files/version_list_params.rbs new file mode 100644 index 00000000..2a67793e --- /dev/null +++ b/sig/imagekit/models/files/version_list_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Files + type version_list_params = + { } & Imagekit::Internal::Type::request_parameters + + class VersionListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/files/version_list_response.rbs b/sig/imagekit/models/files/version_list_response.rbs new file mode 100644 index 00000000..65e0e5b7 --- /dev/null +++ b/sig/imagekit/models/files/version_list_response.rbs @@ -0,0 +1,205 @@ +module Imagekit + module Models + module Files + type version_list_response_item = + { + ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, + width: Float + } + + class VersionListResponseItem < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]? + + attr_reader created_at: String? + + def created_at=: (String) -> String + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader has_alpha: bool? + + def has_alpha=: (bool) -> bool + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader mime: String? + + def mime=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail: String? + + def thumbnail=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + attr_reader updated_at: String? + + def updated_at=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo? + + def version_info=: ( + Imagekit::Models::Files::VersionListResponseItem::VersionInfo + ) -> Imagekit::Models::Files::VersionListResponseItem::VersionInfo + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, + ?created_at: String, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?has_alpha: bool, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?mime: String, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail: String, + ?type: String, + ?updated_at: String, + ?url: String, + ?version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + + type version_list_response = + ::Array[Imagekit::Models::Files::VersionListResponseItem] + + VersionListResponse: Imagekit::Internal::Type::Converter + end + end +end diff --git a/sig/imagekit/models/files/version_restore_params.rbs b/sig/imagekit/models/files/version_restore_params.rbs new file mode 100644 index 00000000..22ed3a7e --- /dev/null +++ b/sig/imagekit/models/files/version_restore_params.rbs @@ -0,0 +1,25 @@ +module Imagekit + module Models + module Files + type version_restore_params = + { file_id: String } & Imagekit::Internal::Type::request_parameters + + class VersionRestoreParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_id: String + + def initialize: ( + file_id: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_id: String, + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/version_restore_response.rbs b/sig/imagekit/models/files/version_restore_response.rbs new file mode 100644 index 00000000..ef0b35d8 --- /dev/null +++ b/sig/imagekit/models/files/version_restore_response.rbs @@ -0,0 +1,200 @@ +module Imagekit + module Models + module Files + type version_restore_response = + { + ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, + width: Float + } + + class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]? + + attr_reader created_at: String? + + def created_at=: (String) -> String + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader has_alpha: bool? + + def has_alpha=: (bool) -> bool + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader mime: String? + + def mime=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail: String? + + def thumbnail=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + attr_reader updated_at: String? + + def updated_at=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo? + + def version_info=: ( + Imagekit::Models::Files::VersionRestoreResponse::VersionInfo + ) -> Imagekit::Models::Files::VersionRestoreResponse::VersionInfo + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, + ?created_at: String, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?has_alpha: bool, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?mime: String, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail: String, + ?type: String, + ?updated_at: String, + ?url: String, + ?version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end + end +end diff --git a/sig/imagekit/models/files/version_retrieve_params.rbs b/sig/imagekit/models/files/version_retrieve_params.rbs new file mode 100644 index 00000000..ca629949 --- /dev/null +++ b/sig/imagekit/models/files/version_retrieve_params.rbs @@ -0,0 +1,25 @@ +module Imagekit + module Models + module Files + type version_retrieve_params = + { file_id: String } & Imagekit::Internal::Type::request_parameters + + class VersionRetrieveParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_id: String + + def initialize: ( + file_id: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_id: String, + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/version_retrieve_response.rbs b/sig/imagekit/models/files/version_retrieve_response.rbs new file mode 100644 index 00000000..a1d1e342 --- /dev/null +++ b/sig/imagekit/models/files/version_retrieve_response.rbs @@ -0,0 +1,200 @@ +module Imagekit + module Models + module Files + type version_retrieve_response = + { + ai_tags: ::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + width: Float + } + + class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag]? + + attr_reader created_at: String? + + def created_at=: (String) -> String + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader has_alpha: bool? + + def has_alpha=: (bool) -> bool + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader mime: String? + + def mime=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail: String? + + def thumbnail=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + attr_reader updated_at: String? + + def updated_at=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo? + + def version_info=: ( + Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo + ) -> Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag]?, + ?created_at: String, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?has_alpha: bool, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?mime: String, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail: String, + ?type: String, + ?updated_at: String, + ?url: String, + ?version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end + end +end diff --git a/sig/imagekit/models/folder_create_params.rbs b/sig/imagekit/models/folder_create_params.rbs new file mode 100644 index 00000000..3dff4c00 --- /dev/null +++ b/sig/imagekit/models/folder_create_params.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Models + type folder_create_params = + { folder_name: String, parent_folder_path: String } + & Imagekit::Internal::Type::request_parameters + + class FolderCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor folder_name: String + + attr_accessor parent_folder_path: String + + def initialize: ( + folder_name: String, + parent_folder_path: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + folder_name: String, + parent_folder_path: String, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/folder_create_response.rbs b/sig/imagekit/models/folder_create_response.rbs new file mode 100644 index 00000000..c54daaa5 --- /dev/null +++ b/sig/imagekit/models/folder_create_response.rbs @@ -0,0 +1,5 @@ +module Imagekit + module Models + FolderCreateResponse: Imagekit::Internal::Type::Converter + end +end diff --git a/sig/imagekit/models/folder_delete_params.rbs b/sig/imagekit/models/folder_delete_params.rbs new file mode 100644 index 00000000..ffc943b5 --- /dev/null +++ b/sig/imagekit/models/folder_delete_params.rbs @@ -0,0 +1,23 @@ +module Imagekit + module Models + type folder_delete_params = + { folder_path: String } & Imagekit::Internal::Type::request_parameters + + class FolderDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor folder_path: String + + def initialize: ( + folder_path: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + folder_path: String, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/folder_delete_response.rbs b/sig/imagekit/models/folder_delete_response.rbs new file mode 100644 index 00000000..25459cdc --- /dev/null +++ b/sig/imagekit/models/folder_delete_response.rbs @@ -0,0 +1,5 @@ +module Imagekit + module Models + FolderDeleteResponse: Imagekit::Internal::Type::Converter + end +end diff --git a/sig/imagekit/models/gps.rbs b/sig/imagekit/models/gps.rbs new file mode 100644 index 00000000..d11c6a06 --- /dev/null +++ b/sig/imagekit/models/gps.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + end +end diff --git a/sig/imagekit/models/interoperability.rbs b/sig/imagekit/models/interoperability.rbs new file mode 100644 index 00000000..f653174a --- /dev/null +++ b/sig/imagekit/models/interoperability.rbs @@ -0,0 +1,19 @@ +module Imagekit + module Models + type interoperability = { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: (?interop_index: String, ?interop_version: String) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + end +end diff --git a/sig/imagekit/models/thumbnail.rbs b/sig/imagekit/models/thumbnail.rbs new file mode 100644 index 00000000..0fcbb367 --- /dev/null +++ b/sig/imagekit/models/thumbnail.rbs @@ -0,0 +1,57 @@ +module Imagekit + module Models + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end + end +end diff --git a/sig/imagekit/request_options.rbs b/sig/imagekit/request_options.rbs new file mode 100644 index 00000000..44de316d --- /dev/null +++ b/sig/imagekit/request_options.rbs @@ -0,0 +1,34 @@ +module Imagekit + type request_opts = + Imagekit::RequestOptions | Imagekit::request_options | ::Hash[Symbol, top] + + type request_options = + { + idempotency_key: String?, + extra_query: ::Hash[String, (::Array[String] | String)?]?, + extra_headers: ::Hash[String, String?]?, + extra_body: top?, + max_retries: Integer?, + timeout: Float? + } + + class RequestOptions < Imagekit::Internal::Type::BaseModel + def self.validate!: (Imagekit::request_opts opts) -> void + + attr_accessor idempotency_key: String? + + attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]? + + attr_accessor extra_headers: ::Hash[String, String?]? + + attr_accessor extra_body: top? + + attr_accessor max_retries: Integer? + + attr_accessor timeout: Float? + + def initialize: ( + ?Imagekit::request_options | ::Hash[Symbol, top] values + ) -> void + end +end diff --git a/sig/imagekit/resources/accounts.rbs b/sig/imagekit/resources/accounts.rbs new file mode 100644 index 00000000..7846935f --- /dev/null +++ b/sig/imagekit/resources/accounts.rbs @@ -0,0 +1,13 @@ +module Imagekit + module Resources + class Accounts + def get_usage: ( + end_date: Date, + start_date: Date, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::AccountGetUsageResponse + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/resources/bulk_jobs.rbs b/sig/imagekit/resources/bulk_jobs.rbs new file mode 100644 index 00000000..df4d5a60 --- /dev/null +++ b/sig/imagekit/resources/bulk_jobs.rbs @@ -0,0 +1,25 @@ +module Imagekit + module Resources + class BulkJobs + def copy_folder: ( + destination_path: String, + source_folder_path: String, + ?include_versions: bool, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::BulkJobCopyFolderResponse + + def move_folder: ( + destination_path: String, + source_folder_path: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::BulkJobMoveFolderResponse + + def retrieve_status: ( + String job_id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::BulkJobRetrieveStatusResponse + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/resources/custom_metadata_fields.rbs b/sig/imagekit/resources/custom_metadata_fields.rbs new file mode 100644 index 00000000..3f0a4e3f --- /dev/null +++ b/sig/imagekit/resources/custom_metadata_fields.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Resources + class CustomMetadataFields + def create: ( + label: String, + name: String, + schema: Imagekit::CustomMetadataFieldCreateParams::Schema, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::CustomMetadataFieldCreateResponse + + def update: ( + String id, + ?label: String, + ?schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::CustomMetadataFieldUpdateResponse + + def list: ( + ?include_deleted: bool, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::custom_metadata_field_list_response + + def delete: (String id, ?request_options: Imagekit::request_opts) -> top + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs new file mode 100644 index 00000000..97bdb50b --- /dev/null +++ b/sig/imagekit/resources/files.rbs @@ -0,0 +1,120 @@ +module Imagekit + module Resources + class Files + attr_reader details: Imagekit::Resources::Files::Details + + attr_reader batch: Imagekit::Resources::Files::Batch + + attr_reader versions: Imagekit::Resources::Files::Versions + + attr_reader purge: Imagekit::Resources::Files::Purge + + attr_reader metadata: Imagekit::Resources::Files::Metadata + + def list: ( + ?file_type: String, + ?limit: String, + ?path: String, + ?search_query: String, + ?skip: String, + ?sort: String, + ?type: Imagekit::Models::FileListParams::type_, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::file_list_response + + def delete: ( + String file_id, + ?request_options: Imagekit::request_opts + ) -> nil + + def add_tags: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FileAddTagsResponse + + def copy: ( + destination_path: String, + source_file_path: String, + ?include_file_versions: bool, + ?request_options: Imagekit::request_opts + ) -> top + + def move: ( + destination_path: String, + source_file_path: String, + ?request_options: Imagekit::request_opts + ) -> top + + def remove_ai_tags: ( + ai_tags: ::Array[String], + file_ids: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FileRemoveAITagsResponse + + def remove_tags: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FileRemoveTagsResponse + + def rename: ( + file_path: String, + new_file_name: String, + ?purge_cache: bool, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FileRenameResponse + + def upload_v1: ( + file: String, + file_name: String, + ?token: String, + ?checks: String, + ?custom_coordinates: String, + ?custom_metadata: String, + ?expire: String, + ?extensions: String, + ?folder: String, + ?is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file, + ?is_published: Imagekit::Models::FileUploadV1Params::is_published, + ?overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags, + ?overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata, + ?overwrite_file: String, + ?overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags, + ?public_key: String, + ?response_fields: String, + ?signature: String, + ?tags: String, + ?transformation: String, + ?use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name, + ?webhook_url: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FileUploadV1Response + + def upload_v2: ( + file: String, + file_name: String, + ?token: String, + ?checks: String, + ?custom_coordinates: String, + ?custom_metadata: String, + ?extensions: String, + ?folder: String, + ?is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file, + ?is_published: Imagekit::Models::FileUploadV2Params::is_published, + ?overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags, + ?overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata, + ?overwrite_file: String, + ?overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags, + ?response_fields: String, + ?tags: String, + ?transformation: String, + ?use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name, + ?webhook_url: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FileUploadV2Response + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/resources/files/batch.rbs b/sig/imagekit/resources/files/batch.rbs new file mode 100644 index 00000000..7eef2dda --- /dev/null +++ b/sig/imagekit/resources/files/batch.rbs @@ -0,0 +1,14 @@ +module Imagekit + module Resources + class Files + class Batch + def delete: ( + file_ids: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::BatchDeleteResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/files/details.rbs b/sig/imagekit/resources/files/details.rbs new file mode 100644 index 00000000..da506ae9 --- /dev/null +++ b/sig/imagekit/resources/files/details.rbs @@ -0,0 +1,26 @@ +module Imagekit + module Resources + class Files + class Details + def retrieve: ( + String file_id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::DetailRetrieveResponse + + def update: ( + String file_id, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension], + ?remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, + ?publish: Imagekit::Files::DetailUpdateParams::Publish, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::DetailUpdateResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/files/metadata.rbs b/sig/imagekit/resources/files/metadata.rbs new file mode 100644 index 00000000..dea8d704 --- /dev/null +++ b/sig/imagekit/resources/files/metadata.rbs @@ -0,0 +1,19 @@ +module Imagekit + module Resources + class Files + class Metadata + def retrieve: ( + String file_id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::MetadataRetrieveResponse + + def from_url: ( + url: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::MetadataFromURLResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/files/purge.rbs b/sig/imagekit/resources/files/purge.rbs new file mode 100644 index 00000000..345d9f7b --- /dev/null +++ b/sig/imagekit/resources/files/purge.rbs @@ -0,0 +1,19 @@ +module Imagekit + module Resources + class Files + class Purge + def execute: ( + url: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::PurgeExecuteResponse + + def status: ( + String request_id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::PurgeStatusResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/files/versions.rbs b/sig/imagekit/resources/files/versions.rbs new file mode 100644 index 00000000..02977214 --- /dev/null +++ b/sig/imagekit/resources/files/versions.rbs @@ -0,0 +1,32 @@ +module Imagekit + module Resources + class Files + class Versions + def retrieve: ( + String version_id, + file_id: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::VersionRetrieveResponse + + def list: ( + String file_id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::version_list_response + + def delete: ( + String version_id, + file_id: String, + ?request_options: Imagekit::request_opts + ) -> top + + def restore: ( + String version_id, + file_id: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::VersionRestoreResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/folder.rbs b/sig/imagekit/resources/folder.rbs new file mode 100644 index 00000000..40210acb --- /dev/null +++ b/sig/imagekit/resources/folder.rbs @@ -0,0 +1,18 @@ +module Imagekit + module Resources + class Folder + def create: ( + folder_name: String, + parent_folder_path: String, + ?request_options: Imagekit::request_opts + ) -> top + + def delete: ( + folder_path: String, + ?request_options: Imagekit::request_opts + ) -> top + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/version.rbs b/sig/imagekit/version.rbs new file mode 100644 index 00000000..56afb0ab --- /dev/null +++ b/sig/imagekit/version.rbs @@ -0,0 +1,3 @@ +module Imagekit + VERSION: String +end diff --git a/sorbet/config b/sorbet/config new file mode 100644 index 00000000..6fe84ed8 --- /dev/null +++ b/sorbet/config @@ -0,0 +1,2 @@ +--dir=rbi/ +--ignore=test/ diff --git a/sorbet/rbi/.gitignore b/sorbet/rbi/.gitignore new file mode 100644 index 00000000..d6b7ef32 --- /dev/null +++ b/sorbet/rbi/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore diff --git a/test/imagekit/client_test.rb b/test/imagekit/client_test.rb new file mode 100644 index 00000000..1b55e779 --- /dev/null +++ b/test/imagekit/client_test.rb @@ -0,0 +1,426 @@ +# frozen_string_literal: true + +require_relative "test_helper" + +class ImagekitTest < Minitest::Test + extend Minitest::Serial + include WebMock::API + + def before_all + super + WebMock.enable! + end + + def setup + super + Thread.current.thread_variable_set(:mock_sleep, []) + end + + def teardown + Thread.current.thread_variable_set(:mock_sleep, nil) + WebMock.reset! + super + end + + def after_all + WebMock.disable! + super + end + + def test_raises_on_missing_non_nullable_opts + e = assert_raises(ArgumentError) do + Imagekit::Client.new + end + assert_match(/is required/, e.message) + end + + def test_client_default_request_default_retry_attempts + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + end + + assert_requested(:any, /./, times: 3) + end + + def test_client_given_request_default_retry_attempts + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password", + max_retries: 3 + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + end + + assert_requested(:any, /./, times: 4) + end + + def test_client_default_request_given_retry_attempts + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {max_retries: 3} + ) + end + + assert_requested(:any, /./, times: 4) + end + + def test_client_given_request_given_retry_attempts + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password", + max_retries: 3 + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {max_retries: 4} + ) + end + + assert_requested(:any, /./, times: 5) + end + + def test_client_retry_after_seconds + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json( + status: 500, + headers: {"retry-after" => "1.3"}, + body: {} + ) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password", + max_retries: 1 + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + end + + assert_requested(:any, /./, times: 2) + assert_equal(1.3, Thread.current.thread_variable_get(:mock_sleep).last) + end + + def test_client_retry_after_date + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json( + status: 500, + headers: {"retry-after" => (Time.now + 10).httpdate}, + body: {} + ) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password", + max_retries: 1 + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + Thread.current.thread_variable_set(:time_now, Time.now) + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + Thread.current.thread_variable_set(:time_now, nil) + end + + assert_requested(:any, /./, times: 2) + assert_in_delta(10, Thread.current.thread_variable_get(:mock_sleep).last, 1.0) + end + + def test_client_retry_after_ms + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json( + status: 500, + headers: {"retry-after-ms" => "1300"}, + body: {} + ) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password", + max_retries: 1 + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + end + + assert_requested(:any, /./, times: 2) + assert_equal(1.3, Thread.current.thread_variable_get(:mock_sleep).last) + end + + def test_retry_count_header + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + end + + 3.times do + assert_requested(:any, /./, headers: {"x-stainless-retry-count" => _1}) + end + end + + def test_omit_retry_count_header + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {extra_headers: {"x-stainless-retry-count" => nil}} + ) + end + + assert_requested(:any, /./, times: 3) do + refute_includes(_1.headers.keys.map(&:downcase), "x-stainless-retry-count") + end + end + + def test_overwrite_retry_count_header + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::InternalServerError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {extra_headers: {"x-stainless-retry-count" => "42"}} + ) + end + + assert_requested(:any, /./, headers: {"x-stainless-retry-count" => "42"}, times: 3) + end + + def test_client_redirect_307 + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json( + status: 307, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:any, "http://localhost/redirected").to_return( + status: 307, + headers: {"location" => "/redirected"} + ) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::APIConnectionError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {extra_headers: {}} + ) + end + + recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first + + assert_requested(:any, "http://localhost/redirected", times: Imagekit::Client::MAX_REDIRECTS) do + assert_equal(recorded.method, _1.method) + assert_equal(recorded.body, _1.body) + assert_equal( + recorded.headers.transform_keys(&:downcase).fetch("content-type"), + _1.headers.transform_keys(&:downcase).fetch("content-type") + ) + end + end + + def test_client_redirect_303 + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json( + status: 303, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:get, "http://localhost/redirected").to_return( + status: 303, + headers: {"location" => "/redirected"} + ) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::APIConnectionError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {extra_headers: {}} + ) + end + + assert_requested(:get, "http://localhost/redirected", times: Imagekit::Client::MAX_REDIRECTS) do + headers = _1.headers.keys.map(&:downcase) + refute_includes(headers, "content-type") + assert_nil(_1.body) + end + end + + def test_client_redirect_auth_keep_same_origin + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json( + status: 307, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:any, "http://localhost/redirected").to_return( + status: 307, + headers: {"location" => "/redirected"} + ) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::APIConnectionError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {extra_headers: {"authorization" => "Bearer xyz"}} + ) + end + + recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first + auth_header = recorded.headers.transform_keys(&:downcase).fetch("authorization") + + assert_equal("Bearer xyz", auth_header) + assert_requested(:any, "http://localhost/redirected", times: Imagekit::Client::MAX_REDIRECTS) do + auth_header = _1.headers.transform_keys(&:downcase).fetch("authorization") + assert_equal("Bearer xyz", auth_header) + end + end + + def test_client_redirect_auth_strip_cross_origin + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json( + status: 307, + headers: {"location" => "https://example.com/redirected"}, + body: {} + ) + stub_request(:any, "https://example.com/redirected").to_return( + status: 307, + headers: {"location" => "https://example.com/redirected"} + ) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + assert_raises(Imagekit::Errors::APIConnectionError) do + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName", + request_options: {extra_headers: {"authorization" => "Bearer xyz"}} + ) + end + + assert_requested(:any, "https://example.com/redirected", times: Imagekit::Client::MAX_REDIRECTS) do + headers = _1.headers.keys.map(&:downcase) + refute_includes(headers, "authorization") + end + end + + def test_default_headers + stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 200, body: {}) + + image_kit = + Imagekit::Client.new( + base_url: "http://localhost", + private_api_key: "My Private API Key", + password: "My Password" + ) + + image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + + assert_requested(:any, /./) do |req| + headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type") + headers.each { refute_empty(_1) } + end + end +end diff --git a/test/imagekit/file_part_test.rb b/test/imagekit/file_part_test.rb new file mode 100644 index 00000000..15b7078c --- /dev/null +++ b/test/imagekit/file_part_test.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +require_relative "test_helper" + +class Imagekit::Test::FilePartTest < Minitest::Test + def test_to_json + text = "gray" + filepart = Imagekit::FilePart.new(StringIO.new(text)) + + assert_equal(text.to_json, filepart.to_json) + assert_equal(text.to_yaml, filepart.to_yaml) + end +end diff --git a/test/imagekit/internal/sorbet_runtime_support_test.rb b/test/imagekit/internal/sorbet_runtime_support_test.rb new file mode 100644 index 00000000..4075f247 --- /dev/null +++ b/test/imagekit/internal/sorbet_runtime_support_test.rb @@ -0,0 +1,52 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::SorbetRuntimeSupportTest < Minitest::Test + extend Minitest::Serial + + i_suck_and_my_tests_are_order_dependent! + + module E + extend Imagekit::Internal::Type::Enum + + define_sorbet_constant!(:TaggedSymbol) { 1 } + end + + module U + extend Imagekit::Internal::Type::Union + + define_sorbet_constant!(:Variants) { 2 } + end + + class M < Imagekit::Internal::Type::BaseModel + define_sorbet_constant!(:OrHash) { 3 } + end + + def test_nil_aliases + err = Imagekit::Internal::Util::SorbetRuntimeSupport::MissingSorbetRuntimeError + + assert_raises(err) { Imagekit::Internal::AnyHash } + assert_raises(err) { Imagekit::Internal::FileInput } + assert_raises(err) { Imagekit::Internal::Type::Converter::Input } + assert_raises(err) { Imagekit::Internal::Type::Converter::CoerceState } + assert_raises(err) { Imagekit::Internal::Type::Converter::DumpState } + assert_raises(err) { Imagekit::Internal::Type::BaseModel::KnownField } + assert_raises(err) { Imagekit::Internal::Util::ParsedUri } + assert_raises(err) { Imagekit::Internal::Util::ServerSentEvent } + assert_raises(err) { Imagekit::Internal::Transport::BaseClient::RequestComponents } + assert_raises(err) { Imagekit::Internal::Transport::BaseClient::RequestInput } + assert_raises(err) { Imagekit::Internal::Transport::PooledNetRequester::Request } + assert_raises(err) { E::TaggedSymbol } + assert_raises(err) { U::Variants } + assert_raises(err) { M::OrHash } + end + + def test_stubbed_aliases + Kernel.instance_eval { const_set(:T, nil) } + + assert_equal(1, E::TaggedSymbol) + assert_equal(2, U::Variants) + assert_equal(3, M::OrHash) + end +end diff --git a/test/imagekit/internal/type/base_model_test.rb b/test/imagekit/internal/type/base_model_test.rb new file mode 100644 index 00000000..458e8287 --- /dev/null +++ b/test/imagekit/internal/type/base_model_test.rb @@ -0,0 +1,721 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::PrimitiveModelTest < Minitest::Test + A = Imagekit::Internal::Type::ArrayOf[-> { Integer }] + H = Imagekit::Internal::Type::HashOf[-> { Integer }, nil?: true] + + module E + extend Imagekit::Internal::Type::Enum + end + + module U + extend Imagekit::Internal::Type::Union + end + + class B < Imagekit::Internal::Type::BaseModel + optional :a, Integer + optional :b, B + end + + def test_typing + converters = [ + Imagekit::Internal::Type::Unknown, + Imagekit::Internal::Type::Boolean, + A, + H, + E, + U, + B + ] + + converters.each do |conv| + assert_pattern do + conv => Imagekit::Internal::Type::Converter + end + end + end + + def test_coerce + cases = { + [Imagekit::Internal::Type::Unknown, :a] => [{yes: 1}, :a], + [NilClass, :a] => [{maybe: 1}, nil], + [NilClass, nil] => [{yes: 1}, nil], + [Imagekit::Internal::Type::Boolean, true] => [{yes: 1}, true], + [Imagekit::Internal::Type::Boolean, "true"] => [{no: 1}, "true"], + [Integer, 1] => [{yes: 1}, 1], + [Integer, 1.0] => [{maybe: 1}, 1], + [Integer, "1"] => [{maybe: 1}, 1], + [Integer, "one"] => [{no: 1}, "one"], + [Float, 1] => [{yes: 1}, 1.0], + [Float, "1"] => [{maybe: 1}, 1.0], + [Float, :one] => [{no: 1}, :one], + [String, :str] => [{yes: 1}, "str"], + [String, "str"] => [{yes: 1}, "str"], + [String, 1] => [{maybe: 1}, "1"], + [:a, "a"] => [{yes: 1}, :a], + [Date, "1990-09-19"] => [{yes: 1}, Date.new(1990, 9, 19)], + [Date, Date.new(1990, 9, 19)] => [{yes: 1}, Date.new(1990, 9, 19)], + [Date, "one"] => [{no: 1}, "one"], + [Time, "1990-09-19"] => [{yes: 1}, Time.new(1990, 9, 19)], + [Time, Time.new(1990, 9, 19)] => [{yes: 1}, Time.new(1990, 9, 19)], + [Time, "one"] => [{no: 1}, "one"] + } + + cases.each do |lhs, rhs| + target, input = lhs + exactness, expect = rhs + state = Imagekit::Internal::Type::Converter.new_coerce_state + assert_pattern do + Imagekit::Internal::Type::Converter.coerce(target, input, state: state) => ^expect + state.fetch(:exactness).filter { _2.nonzero? }.to_h => ^exactness + end + end + end + + def test_dump + cases = { + [Imagekit::Internal::Type::Unknown, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [A, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [H, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [E, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [U, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [B, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [String, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [:b, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [nil, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [Imagekit::Internal::Type::Boolean, true] => true, + [Imagekit::Internal::Type::Boolean, "true"] => "true", + [Integer, "1"] => "1", + [Float, 1] => 1, + [String, "one"] => "one", + [String, :one] => :one, + [:a, :b] => :b, + [:a, "a"] => "a", + [String, StringIO.new("one")] => "one", + [String, Pathname(__FILE__)] => Imagekit::FilePart + } + + cases.each do + target, input = _1 + expect = _2 + assert_pattern do + Imagekit::Internal::Type::Converter.dump(target, input) => ^expect + end + end + end + + def test_coerce_errors + cases = { + [Integer, "one"] => ArgumentError, + [Float, "one"] => ArgumentError, + [String, Time] => TypeError, + [Date, "one"] => ArgumentError, + [Time, "one"] => ArgumentError + } + + cases.each do |testcase, expect| + target, input = testcase + state = Imagekit::Internal::Type::Converter.new_coerce_state + Imagekit::Internal::Type::Converter.coerce(target, input, state: state) + assert_pattern do + state => {error: ^expect} + end + end + end + + def test_dump_retry + types = [ + Imagekit::Internal::Type::Unknown, + Imagekit::Internal::Type::Boolean, + A, + H, + E, + U, + B + ] + Pathname(__FILE__).open do |fd| + cases = [ + fd, + [fd], + {a: fd}, + {a: {b: fd}} + ] + types.product(cases).each do |target, input| + state = {can_retry: true} + Imagekit::Internal::Type::Converter.dump(target, input, state: state) + + assert_pattern do + state => {can_retry: false} + end + end + end + end +end + +class Imagekit::Test::EnumModelTest < Minitest::Test + class E0 + include Imagekit::Internal::Type::Enum + attr_reader :values + + def initialize(*values) = (@values = values) + end + + module E1 + extend Imagekit::Internal::Type::Enum + + TRUE = true + end + + module E2 + extend Imagekit::Internal::Type::Enum + + ONE = 1 + TWO = 2 + end + + module E3 + extend Imagekit::Internal::Type::Enum + + ONE = 1.0 + TWO = 2.0 + end + + module E4 + extend Imagekit::Internal::Type::Enum + + ONE = :one + TWO = :two + end + + def test_coerce + cases = { + [E0.new, "one"] => [{no: 1}, "one"], + [E0.new(:one), "one"] => [{yes: 1}, :one], + [E0.new(:two), "one"] => [{maybe: 1}, "one"], + + [E1, true] => [{yes: 1}, true], + [E1, false] => [{no: 1}, false], + [E1, :true] => [{no: 1}, :true], + + [E2, 1] => [{yes: 1}, 1], + [E2, 1.0] => [{yes: 1}, 1], + [E2, 1.2] => [{no: 1}, 1.2], + [E2, "1"] => [{no: 1}, "1"], + + [E3, 1.0] => [{yes: 1}, 1.0], + [E3, 1] => [{yes: 1}, 1.0], + [E3, "one"] => [{no: 1}, "one"], + + [E4, :one] => [{yes: 1}, :one], + [E4, "one"] => [{yes: 1}, :one], + [E4, "1"] => [{maybe: 1}, "1"], + [E4, :"1"] => [{maybe: 1}, :"1"], + [E4, 1] => [{no: 1}, 1] + } + + cases.each do |lhs, rhs| + target, input = lhs + exactness, expect = rhs + state = Imagekit::Internal::Type::Converter.new_coerce_state + assert_pattern do + Imagekit::Internal::Type::Converter.coerce(target, input, state: state) => ^expect + state.fetch(:exactness).filter { _2.nonzero? }.to_h => ^exactness + end + end + end + + def test_dump + cases = { + [E1, true] => true, + [E1, "true"] => "true", + + [E2, 1.0] => 1.0, + [E2, 3] => 3, + [E2, "1.0"] => "1.0", + + [E3, 1.0] => 1.0, + [E3, 3] => 3, + [E3, "1.0"] => "1.0", + + [E4, :one] => :one, + [E4, "one"] => "one", + [E4, "1.0"] => "1.0" + } + + cases.each do + target, input = _1 + expect = _2 + assert_pattern do + Imagekit::Internal::Type::Converter.dump(target, input) => ^expect + end + end + end +end + +class Imagekit::Test::CollectionModelTest < Minitest::Test + A1 = Imagekit::Internal::Type::ArrayOf[-> { Integer }] + H1 = Imagekit::Internal::Type::HashOf[Integer] + + A2 = Imagekit::Internal::Type::ArrayOf[H1] + H2 = Imagekit::Internal::Type::HashOf[-> { A1 }] + + A3 = Imagekit::Internal::Type::ArrayOf[Integer, nil?: true] + H3 = Imagekit::Internal::Type::HashOf[Integer, nil?: true] + + def test_coerce + cases = { + [A1, []] => [{yes: 1}, []], + [A1, {}] => [{no: 1}, {}], + [A1, [1, 2.0]] => [{yes: 2, maybe: 1}, [1, 2]], + [A1, ["1", 2.0]] => [{yes: 1, maybe: 2}, [1, 2]], + [H1, {}] => [{yes: 1}, {}], + [H1, []] => [{no: 1}, []], + [H1, {a: 1, b: 2}] => [{yes: 3}, {a: 1, b: 2}], + [H1, {"a" => 1, "b" => 2}] => [{yes: 3}, {a: 1, b: 2}], + [H1, {[] => 1}] => [{yes: 2, no: 1}, {[] => 1}], + [H1, {a: 1.5}] => [{yes: 1, maybe: 1}, {a: 1}], + + [A2, [{}, {"a" => 1}]] => [{yes: 4}, [{}, {a: 1}]], + [A2, [{"a" => "1"}]] => [{yes: 2, maybe: 1}, [{a: 1}]], + [H2, {a: [1, 2]}] => [{yes: 4}, {a: [1, 2]}], + [H2, {"a" => ["1", 2]}] => [{yes: 3, maybe: 1}, {a: [1, 2]}], + [H2, {"a" => ["one", 2]}] => [{yes: 3, no: 1}, {a: ["one", 2]}], + + [A3, [nil, 1]] => [{yes: 3}, [nil, 1]], + [A3, [nil, "1"]] => [{yes: 2, maybe: 1}, [nil, 1]], + [H3, {a: nil, b: "1"}] => [{yes: 2, maybe: 1}, {a: nil, b: 1}], + [H3, {a: nil}] => [{yes: 2}, {a: nil}] + } + + cases.each do |lhs, rhs| + target, input = lhs + exactness, expect = rhs + state = Imagekit::Internal::Type::Converter.new_coerce_state + assert_pattern do + Imagekit::Internal::Type::Converter.coerce(target, input, state: state) => ^expect + state.fetch(:exactness).filter { _2.nonzero? }.to_h => ^exactness + end + end + end +end + +class Imagekit::Test::BaseModelTest < Minitest::Test + class M1 < Imagekit::Internal::Type::BaseModel + required :a, Integer + end + + class M2 < M1 + required :a, Time + required :b, Integer, nil?: true + optional :c, String + end + + class M3 < Imagekit::Internal::Type::BaseModel + optional :c, const: :c + required :d, const: :d + end + + class M4 < M1 + request_only do + required :a, Integer + optional :b, String + end + + response_only do + required :c, Integer + optional :d, String + end + end + + class M5 < Imagekit::Internal::Type::BaseModel + request_only do + required :c, const: :c + end + + response_only do + required :d, const: :d + end + end + + class M6 < M1 + required :a, Imagekit::Internal::Type::ArrayOf[M6] + optional :b, M6 + end + + def test_coerce + cases = { + [M1, {}] => [{yes: 1, no: 1}, {}], + [M1, :m1] => [{no: 1}, :m1], + + [M2, {}] => [{yes: 2, no: 1, maybe: 1}, {}], + [M2, {a: "1990-09-19", b: nil}] => [{yes: 4}, {a: "1990-09-19", b: nil}], + [M2, {a: "1990-09-19", b: "1"}] => [{yes: 3, maybe: 1}, {a: "1990-09-19", b: "1"}], + [M2, {a: "1990-09-19"}] => [{yes: 3, maybe: 1}, {a: "1990-09-19"}], + [M2, {a: "1990-09-19", c: nil}] => [{yes: 2, maybe: 2}, {a: "1990-09-19", c: nil}], + + [M3, {c: "c", d: "d"}] => [{yes: 3}, {c: :c, d: :d}], + [M3, {c: "d", d: "c"}] => [{yes: 1, maybe: 2}, {c: "d", d: "c"}], + + [M4, {c: 2}] => [{yes: 5}, {c: 2}], + [M4, {a: "1", c: 2}] => [{yes: 4, maybe: 1}, {a: "1", c: 2}], + [M4, {b: nil, c: 2}] => [{yes: 4, maybe: 1}, {b: nil, c: 2}], + + [M5, {}] => [{yes: 3}, {}], + [M5, {c: "c"}] => [{yes: 3}, {c: :c}], + [M5, {d: "d"}] => [{yes: 3}, {d: :d}], + [M5, {d: nil}] => [{yes: 2, no: 1}, {d: nil}], + + [M6, {a: [{a: []}]}] => [{yes: 6}, -> { _1 in {a: [M6]} }], + [M6, {b: {a: []}}] => [{yes: 4, no: 1}, -> { _1 in {b: M6} }] + } + + cases.each do |lhs, rhs| + target, input = lhs + exactness, expect = rhs + state = Imagekit::Internal::Type::Converter.new_coerce_state + assert_pattern do + coerced = Imagekit::Internal::Type::Converter.coerce(target, input, state: state) + assert_equal(coerced, coerced) + if coerced.is_a?(Imagekit::Internal::Type::BaseModel) + coerced.to_h => ^expect + else + coerced => ^expect + end + state.fetch(:exactness).filter { _2.nonzero? }.to_h => ^exactness + end + end + end + + def test_dump + cases = { + [M3, M3.new] => {d: :d}, + [M3, {}] => {d: :d}, + [M3, {d: 1}] => {d: 1}, + + [M4, M4.new(a: 1, b: "b", c: 2, d: "d")] => {a: 1, b: "b"}, + [M4, {a: 1, b: "b", c: 2, d: "d"}] => {a: 1, b: "b"}, + + [M5, M5.new] => {c: :c}, + [M5, {}] => {c: :c}, + [M5, {c: 1}] => {c: 1} + } + + cases.each do + target, input = _1 + expect = _2 + assert_pattern do + Imagekit::Internal::Type::Converter.dump(target, input) => ^expect + end + end + end + + def test_accessors + cases = { + M2.new({a: "1990-09-19", b: "1"}) => [{a: "1990-09-19", b: "1"}, {a: Time.new(1990, 9, 19), b: 1}], + M2.new(a: "one", b: "one") => [{a: "one", b: "one"}, {a: ArgumentError, b: ArgumentError}], + M2.new(a: nil, b: 2.0) => [{a: nil, b: 2.0}, {a: TypeError}], + M2.new(a: nil, b: 2.2) => [{a: nil, b: 2.2}, {a: TypeError, b: 2}], + + M3.new => [{}, {d: :d}], + M3.new(d: 1) => [{d: 1}, {d: ArgumentError}], + + M5.new => [{}, {c: :c, d: :d}] + } + + cases.each do + target = _1 + data, attributes = _2 + + assert_pattern do + target.to_h => ^data + end + + attributes.each do |accessor, expect| + case expect + in Class if expect <= StandardError + tap do + target.public_send(accessor) + flunk + rescue Imagekit::Errors::ConversionError => e + assert_kind_of(expect, e.cause) + end + else + assert_pattern { target.public_send(accessor) => ^expect } + end + end + end + end + + def test_inplace_modification + m1 = M6.new(a: []) + m1.a << M6.new(a: []) + + m2 = M6.new(b: M6.new(a: [])) + m2.b.a << M6.new(a: []) + + m3 = M6.new(a: []) + m4 = M6.new(b: m3) + m3.a << M6.new(a: []) + + assert_pattern do + m1 => {a: [{a: []}]} + m2 => {b: {a: [{a: []}]}} + m4 => {b: {a: [{a: []}]}} + end + end +end + +class Imagekit::Test::UnionTest < Minitest::Test + class U0 + include Imagekit::Internal::Type::Union + + def initialize(*variants) = variants.each { variant(_1) } + end + + module U1 + extend Imagekit::Internal::Type::Union + variant const: :a + variant const: 2 + end + + class M1 < Imagekit::Internal::Type::BaseModel + required :t, const: :a, api_name: :type + optional :c, String + end + + class M2 < Imagekit::Internal::Type::BaseModel + required :type, const: :b + optional :c, String + end + + module U2 + extend Imagekit::Internal::Type::Union + discriminator :type + + variant :a, M1 + variant :b, M2 + end + + module U3 + extend Imagekit::Internal::Type::Union + discriminator :type + + variant :a, M1 + variant String + end + + module U4 + extend Imagekit::Internal::Type::Union + discriminator :type + + variant String + variant :a, M1 + end + + class M3 < Imagekit::Internal::Type::BaseModel + optional :recur, -> { U5 } + required :a, Integer + end + + class M4 < Imagekit::Internal::Type::BaseModel + optional :recur, -> { U5 } + required :a, Imagekit::Internal::Type::ArrayOf[-> { U5 }] + end + + class M5 < Imagekit::Internal::Type::BaseModel + optional :recur, -> { U5 } + required :b, Imagekit::Internal::Type::ArrayOf[-> { U5 }] + end + + module U5 + extend Imagekit::Internal::Type::Union + + variant -> { M3 } + variant -> { M4 } + end + + module U6 + extend Imagekit::Internal::Type::Union + + variant -> { M3 } + variant -> { M5 } + end + + def test_accessors + model = M3.new(recur: []) + tap do + model.recur + flunk + rescue Imagekit::Errors::ConversionError => e + assert_kind_of(ArgumentError, e.cause) + end + end + + def test_coerce + cases = { + [U0, :""] => [{no: 1}, 0, :""], + + [U0.new(Integer, Float), "one"] => [{no: 1}, 2, "one"], + [U0.new(Integer, Float), 1.0] => [{yes: 1}, 2, 1.0], + [U0.new({const: :a}), "a"] => [{yes: 1}, 1, :a], + [U0.new({const: :a}), "2"] => [{maybe: 1}, 1, "2"], + + [U1, "a"] => [{yes: 1}, 1, :a], + [U1, "2"] => [{maybe: 1}, 2, "2"], + [U1, :b] => [{maybe: 1}, 2, :b], + + [U2, {type: :a}] => [{yes: 3}, 0, {t: :a}], + [U2, {type: "b"}] => [{yes: 3}, 0, {type: :b}], + + [U3, "one"] => [{yes: 1}, 2, "one"], + [U4, "one"] => [{yes: 1}, 1, "one"], + + [U5, {a: []}] => [{yes: 3}, 2, {a: []}], + [U6, {b: []}] => [{yes: 3}, 2, {b: []}], + + [U5, {a: [{a: []}]}] => [{yes: 6}, 4, {a: [M4.new(a: [])]}], + [U5, {a: [{a: [{a: []}]}]}] => [{yes: 9}, 6, {a: [M4.new(a: [M4.new(a: [])])]}] + } + + cases.each do |lhs, rhs| + target, input = lhs + exactness, branched, expect = rhs + state = Imagekit::Internal::Type::Converter.new_coerce_state + assert_pattern do + coerced = Imagekit::Internal::Type::Converter.coerce(target, input, state: state) + assert_equal(coerced, coerced) + if coerced.is_a?(Imagekit::Internal::Type::BaseModel) + coerced.to_h => ^expect + else + coerced => ^expect + end + state.fetch(:exactness).filter { _2.nonzero? }.to_h => ^exactness + state => {branched: ^branched} + end + end + end +end + +class Imagekit::Test::BaseModelQoLTest < Minitest::Test + class E0 + include Imagekit::Internal::Type::Enum + attr_reader :values + + def initialize(*values) = (@values = values) + end + + module E1 + extend Imagekit::Internal::Type::Enum + + A = 1 + end + + module E2 + extend Imagekit::Internal::Type::Enum + + A = 1 + end + + module E3 + extend Imagekit::Internal::Type::Enum + + A = 2 + B = 3 + end + + class U0 + include Imagekit::Internal::Type::Union + + def initialize(*variants) = variants.each { variant(_1) } + end + + module U1 + extend Imagekit::Internal::Type::Union + + variant String + variant Integer + end + + module U2 + extend Imagekit::Internal::Type::Union + + variant String + variant Integer + end + + class M1 < Imagekit::Internal::Type::BaseModel + required :a, Integer + end + + class M2 < Imagekit::Internal::Type::BaseModel + required :a, Integer, nil?: true + end + + class M3 < M2 + required :a, Integer + end + + def test_equality + cases = { + [Imagekit::Internal::Type::Unknown, Imagekit::Internal::Type::Unknown] => true, + [Imagekit::Internal::Type::Boolean, Imagekit::Internal::Type::Boolean] => true, + [Imagekit::Internal::Type::Unknown, Imagekit::Internal::Type::Boolean] => false, + [E0.new(:a, :b), E0.new(:a, :b)] => true, + [E0.new(:a, :b), E0.new(:b, :a)] => true, + [E0.new(:a, :b), E0.new(:b, :c)] => false, + [E1, E2] => true, + [E1, E3] => false, + [U0.new(String, Integer), U0.new(String, Integer)] => true, + [U0.new(String, Integer), U0.new(Integer, String)] => false, + [U0.new(String, Float), U0.new(String, Integer)] => false, + [U1, U2] => true, + [M1, M2] => false, + [M1, M3] => true, + [M1.new(a: 1), M1.new(a: 1)] => true + } + + cases.each do + if _2 + assert_equal(*_1) + assert_equal(*_1.map(&:hash)) + else + refute_equal(*_1) + refute_equal(*_1.map(&:hash)) + end + end + end +end + +class Imagekit::Test::MetaInfoTest < Minitest::Test + A1 = Imagekit::Internal::Type::ArrayOf[Integer, nil?: true, doc: "dog"] + H1 = Imagekit::Internal::Type::HashOf[-> { String }, nil?: true, doc: "dawg"] + + class M1 < Imagekit::Internal::Type::BaseModel + required :a, Integer, doc: "dog" + optional :b, -> { String }, nil?: true, doc: "dawg" + end + + module U1 + extend Imagekit::Internal::Type::Union + + variant -> { Integer }, const: 2, doc: "dog" + variant -> { String }, doc: "dawg" + end + + def test_meta_retrieval + m1 = A1.instance_variable_get(:@meta) + m2 = H1.instance_variable_get(:@meta) + assert_equal({doc: "dog"}, m1) + assert_equal({doc: "dawg"}, m2) + + ma, mb = M1.fields.fetch_values(:a, :b) + assert_equal({doc: "dog"}, ma.fetch(:meta)) + assert_equal({doc: "dawg"}, mb.fetch(:meta)) + + ua, ub = U1.send(:known_variants).map(&:last) + assert_equal({doc: "dog"}, ua) + assert_equal({doc: "dawg"}, ub) + end +end diff --git a/test/imagekit/internal/util_test.rb b/test/imagekit/internal/util_test.rb new file mode 100644 index 00000000..ef803a6d --- /dev/null +++ b/test/imagekit/internal/util_test.rb @@ -0,0 +1,598 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::UtilDataHandlingTest < Minitest::Test + def test_left_map + assert_pattern do + Imagekit::Internal::Util.deep_merge({a: 1}, nil) => nil + end + end + + def test_right_map + assert_pattern do + Imagekit::Internal::Util.deep_merge(nil, {a: 1}) => {a: 1} + end + end + + def test_disjoint_maps + assert_pattern do + Imagekit::Internal::Util.deep_merge({b: 2}, {a: 1}) => {a: 1, b: 2} + end + end + + def test_overlapping_maps + assert_pattern do + Imagekit::Internal::Util.deep_merge({b: 2, c: 3}, {a: 1, c: 4}) => {a: 1, b: 2, c: 4} + end + end + + def test_nested + assert_pattern do + Imagekit::Internal::Util.deep_merge({b: {b2: 1}}, {b: {b2: 2}}) => {b: {b2: 2}} + end + end + + def test_nested_left_map + assert_pattern do + Imagekit::Internal::Util.deep_merge({b: {b2: 1}}, {b: 6}) => {b: 6} + end + end + + def test_omission + merged = Imagekit::Internal::Util.deep_merge( + {b: {b2: 1, b3: {c: 4, d: 5}}}, + {b: {b2: 1, b3: {c: Imagekit::Internal::OMIT, d: 5}}} + ) + + assert_pattern do + merged => {b: {b2: 1, b3: {d: 5}}} + end + end + + def test_concat + merged = Imagekit::Internal::Util.deep_merge( + {a: {b: [1, 2]}}, + {a: {b: [3, 4]}}, + concat: true + ) + + assert_pattern do + merged => {a: {b: [1, 2, 3, 4]}} + end + end + + def test_concat_false + merged = Imagekit::Internal::Util.deep_merge( + {a: {b: [1, 2]}}, + {a: {b: [3, 4]}}, + concat: false + ) + + assert_pattern do + merged => {a: {b: [3, 4]}} + end + end + + def test_dig + assert_pattern do + Imagekit::Internal::Util.dig(1, nil) => 1 + Imagekit::Internal::Util.dig({a: 1}, :b) => nil + Imagekit::Internal::Util.dig({a: 1}, :a) => 1 + Imagekit::Internal::Util.dig({a: {b: 1}}, [:a, :b]) => 1 + + Imagekit::Internal::Util.dig([], 1) => nil + Imagekit::Internal::Util.dig([nil, [nil, 1]], [1, 1]) => 1 + Imagekit::Internal::Util.dig({a: [nil, 1]}, [:a, 1]) => 1 + Imagekit::Internal::Util.dig([], 1.0) => nil + + Imagekit::Internal::Util.dig(Object, 1) => nil + Imagekit::Internal::Util.dig([], 1.0) { 2 } => 2 + Imagekit::Internal::Util.dig([], ->(_) { 2 }) => 2 + Imagekit::Internal::Util.dig([1], -> { _1 in [1] }) => true + end + end +end + +class Imagekit::Test::UtilUriHandlingTest < Minitest::Test + def test_parsing + %w[ + http://example.com + https://example.com/ + https://example.com:443/example?e1=e1&e2=e2&e= + ].each do |url| + parsed = Imagekit::Internal::Util.parse_uri(url) + unparsed = Imagekit::Internal::Util.unparse_uri(parsed).to_s + + assert_equal(url, unparsed) + assert_equal(parsed, Imagekit::Internal::Util.parse_uri(unparsed)) + end + end + + def test_joining + cases = [ + [ + "h://a.b/c?d=e", + "h://nope/ignored", + Imagekit::Internal::Util.parse_uri("h://a.b/c?d=e") + ], + [ + "h://a.b/c?d=e", + "h://nope", + { + host: "a.b", + path: "/c", + query: {"d" => ["e"]} + } + ] + ] + + cases.each do |expect, lhs, rhs| + assert_equal( + URI.parse(expect), + Imagekit::Internal::Util.join_parsed_uri( + Imagekit::Internal::Util.parse_uri(lhs), + rhs + ) + ) + end + end + + def test_joining_queries + base_url = "h://a.b/c?d=e" + cases = { + "c2" => "h://a.b/c/c2", + "/c2?f=g" => "h://a.b/c2?f=g", + "/c?f=g" => "h://a.b/c?d=e&f=g" + } + + cases.each do |path, expected| + assert_equal( + URI.parse(expected), + Imagekit::Internal::Util.join_parsed_uri( + Imagekit::Internal::Util.parse_uri(base_url), + {path: path} + ) + ) + end + end +end + +class Imagekit::Test::RegexMatchTest < Minitest::Test + def test_json_content + cases = { + "application/json" => true, + "application/jsonl" => false, + "application/vnd.github.v3+json" => true, + "application/vnd.api+json" => true + } + cases.each do |header, verdict| + assert_pattern do + Imagekit::Internal::Util::JSON_CONTENT.match?(header) => ^verdict + end + end + end + + def test_jsonl_content + cases = { + "application/x-ndjson" => true, + "application/x-ldjson" => true, + "application/jsonl" => true, + "application/x-jsonl" => true, + "application/json" => false, + "application/vnd.api+json" => false + } + cases.each do |header, verdict| + assert_pattern do + Imagekit::Internal::Util::JSONL_CONTENT.match?(header) => ^verdict + end + end + end +end + +class Imagekit::Test::UtilFormDataEncodingTest < Minitest::Test + class FakeCGI < CGI + def initialize(headers, io) + encoded = io.to_a + @ctype = headers["content-type"] + # rubocop:disable Lint/EmptyBlock + @io = Imagekit::Internal::Util::ReadIOAdapter.new(encoded.to_enum) {} + # rubocop:enable Lint/EmptyBlock + @c_len = encoded.join.bytesize.to_s + super() + end + + def stdinput = @io + + def env_table + { + "REQUEST_METHOD" => "POST", + "CONTENT_TYPE" => @ctype, + "CONTENT_LENGTH" => @c_len + } + end + end + + def test_file_encode + file = Pathname(__FILE__) + headers = {"content-type" => "multipart/form-data"} + cases = { + "abc" => "abc", + StringIO.new("abc") => "abc", + Imagekit::FilePart.new("abc") => "abc", + Imagekit::FilePart.new(StringIO.new("abc")) => "abc", + file => /^class Imagekit/, + Imagekit::FilePart.new(file) => /^class Imagekit/ + } + cases.each do |body, val| + encoded = Imagekit::Internal::Util.encode_content(headers, body) + cgi = FakeCGI.new(*encoded) + assert_pattern do + cgi[""].read => ^val + end + end + end + + def test_hash_encode + headers = {"content-type" => "multipart/form-data"} + cases = { + {a: 2, b: 3} => {"a" => "2", "b" => "3"}, + {a: 2, b: nil} => {"a" => "2", "b" => "null"}, + {a: 2, b: [1, 2, 3]} => {"a" => "2", "b" => "1"}, + {strio: StringIO.new("a")} => {"strio" => "a"}, + {strio: Imagekit::FilePart.new("a")} => {"strio" => "a"}, + {pathname: Pathname(__FILE__)} => {"pathname" => -> { _1.read in /^class Imagekit/ }}, + {pathname: Imagekit::FilePart.new(Pathname(__FILE__))} => { + "pathname" => -> { + _1.read in /^class Imagekit/ + } + } + } + cases.each do |body, testcase| + encoded = Imagekit::Internal::Util.encode_content(headers, body) + cgi = FakeCGI.new(*encoded) + testcase.each do |key, val| + assert_pattern do + cgi[key] => ^val + end + end + end + end +end + +class Imagekit::Test::UtilIOAdapterTest < Minitest::Test + def test_copy_read + cases = { + StringIO.new("abc") => "abc", + Enumerator.new { _1 << "abc" } => "abc" + } + cases.each do |input, expected| + io = StringIO.new + # rubocop:disable Lint/EmptyBlock + adapter = Imagekit::Internal::Util::ReadIOAdapter.new(input) {} + # rubocop:enable Lint/EmptyBlock + IO.copy_stream(adapter, io) + assert_equal(expected, io.string) + end + end + + def test_copy_write + cases = { + StringIO.new => "", + StringIO.new("abc") => "abc" + } + cases.each do |input, expected| + enum = Imagekit::Internal::Util.writable_enum do |y| + IO.copy_stream(input, y) + end + assert_equal(expected, enum.to_a.join) + end + end +end + +class Imagekit::Test::UtilFusedEnumTest < Minitest::Test + def test_closing + arr = [1, 2, 3] + once = 0 + fused = Imagekit::Internal::Util.fused_enum(arr.to_enum) do + once = once.succ + end + + enumerated_1 = fused.to_a + assert_equal(arr, enumerated_1) + assert_equal(1, once) + + enumerated_2 = fused.to_a + assert_equal([], enumerated_2) + assert_equal(1, once) + end + + def test_rewind_chain + once = 0 + fused = Imagekit::Internal::Util.fused_enum([1, 2, 3].to_enum) do + once = once.succ + end + .lazy + .map(&:succ) + .filter(&:odd?) + first = fused.next + + assert_equal(3, first) + assert_equal(0, once) + assert_raises(StopIteration) { fused.rewind.next } + assert_equal(1, once) + end + + def test_external_iteration + it = [1, 2, 3].to_enum + first = it.next + fused = Imagekit::Internal::Util.fused_enum(it, external: true) + + assert_equal(1, first) + assert_equal([2, 3], fused.to_a) + end + + def test_close_fused + once = 0 + fused = Imagekit::Internal::Util.fused_enum([1, 2, 3].to_enum) do + once = once.succ + end + + Imagekit::Internal::Util.close_fused!(fused) + + assert_equal(1, once) + assert_equal([], fused.to_a) + assert_equal(1, once) + end + + def test_closed_fused_extern_iteration + taken = 0 + enum = [1, 2, 3].to_enum.lazy.map do + taken = taken.succ + _1 + end + fused = Imagekit::Internal::Util.fused_enum(enum) + first = fused.next + + assert_equal(1, first) + Imagekit::Internal::Util.close_fused!(fused) + assert_equal(1, taken) + end + + def test_closed_fused_taken_count + taken = 0 + enum = [1, 2, 3].to_enum.lazy.map do + taken = taken.succ + _1 + end + .map(&:succ) + .filter(&:odd?) + fused = Imagekit::Internal::Util.fused_enum(enum) + + assert_equal(0, taken) + Imagekit::Internal::Util.close_fused!(fused) + assert_equal(0, taken) + end + + def test_closed_fused_extern_iter_taken_count + taken = 0 + enum = [1, 2, 3].to_enum.lazy.map do + taken = taken.succ + _1 + end + .map(&:succ) + .filter(&:itself) + first = enum.next + assert_equal(2, first) + assert_equal(1, taken) + + fused = Imagekit::Internal::Util.fused_enum(enum) + Imagekit::Internal::Util.close_fused!(fused) + assert_equal(1, taken) + end + + def test_close_fused_sse_chain + taken = 0 + enum = [1, 2, 3].to_enum.lazy.map do + taken = taken.succ + _1 + end + .map(&:succ) + .filter(&:odd?) + .map(&:to_s) + + fused_1 = Imagekit::Internal::Util.fused_enum(enum) + fused_2 = Imagekit::Internal::Util.decode_lines(fused_1) + fused_3 = Imagekit::Internal::Util.decode_sse(fused_2) + + assert_equal(0, taken) + Imagekit::Internal::Util.close_fused!(fused_3) + assert_equal(0, taken) + end +end + +class Imagekit::Test::UtilContentDecodingTest < Minitest::Test + def test_charset + cases = { + "application/json" => Encoding::BINARY, + "application/json; charset=utf-8" => Encoding::UTF_8, + "charset=uTf-8 application/json; " => Encoding::UTF_8, + "charset=UTF-8; application/json; " => Encoding::UTF_8, + "charset=ISO-8859-1 ;application/json; " => Encoding::ISO_8859_1, + "charset=EUC-KR ;application/json; " => Encoding::EUC_KR + } + text = String.new.force_encoding(Encoding::BINARY) + cases.each do |content_type, encoding| + Imagekit::Internal::Util.force_charset!(content_type, text: text) + assert_equal(encoding, text.encoding) + end + end +end + +class Imagekit::Test::UtilSseTest < Minitest::Test + def test_decode_lines + cases = { + %w[] => %w[], + %W[\n\n] => %W[\n \n], + %W[\n \n] => %W[\n \n], + %w[a] => %w[a], + %W[a\nb] => %W[a\n b], + %W[a\nb\n] => %W[a\n b\n], + %W[\na b\n] => %W[\n ab\n], + %W[\na b\n\n] => %W[\n ab\n \n], + %W[\na b] => %W[\n ab], + %W[\u1F62E\u200D\u1F4A8] => %W[\u1F62E\u200D\u1F4A8], + %W[\u1F62E \u200D \u1F4A8] => %W[\u1F62E\u200D\u1F4A8], + ["\xf0\x9f".b, "\xa5\xba".b] => ["\xf0\x9f\xa5\xba".b], + ["\xf0".b, "\x9f".b, "\xa5".b, "\xba".b] => ["\xf0\x9f\xa5\xba".b] + } + eols = %W[\n \r \r\n] + cases.each do |enum, expected| + eols.each do |eol| + lines = Imagekit::Internal::Util.decode_lines(enum.map { _1.gsub("\n", eol) }) + assert_equal(expected.map { _1.gsub("\n", eol) }, lines.to_a, "eol=#{JSON.generate(eol)}") + end + end + end + + def test_mixed_decode_lines + cases = { + %w[] => %w[], + %W[\r\r] => %W[\r \r], + %W[\r \r] => %W[\r \r], + %W[\r\r\r] => %W[\r \r \r], + %W[\r\r \r] => %W[\r \r \r], + %W[\r \n] => %W[\r\n], + %W[\r\r\n] => %W[\r \r\n], + %W[\n\r] => %W[\n \r] + } + cases.each do |enum, expected| + lines = Imagekit::Internal::Util.decode_lines(enum) + assert_equal(expected, lines.to_a) + end + end + + def test_decode_sse + cases = { + "empty input" => { + [] => [] + }, + "single data event" => { + [ + "data: hello world\n", + "\n" + ] => [ + {data: "hello world\n"} + ] + }, + "multiple data lines" => { + [ + "data: line 1\n", + "data: line 2\n", + "\n" + ] => [ + {data: "line 1\nline 2\n"} + ] + }, + "complete event" => { + [ + "id: 123\n", + "event: update\n", + "data: hello world\n", + "retry: 5000\n", + "\n" + ] => [ + { + event: "update", + id: "123", + data: "hello world\n", + retry: 5000 + } + ] + }, + "multiple events" => { + [ + "event: update\n", + "data: first\n", + "\n", + "event: message\n", + "data: second\n", + "\n" + ] => [ + {event: "update", data: "first\n"}, + {event: "message", data: "second\n"} + ] + }, + "comments" => { + [ + ": this is a comment\n", + "data: actual data\n", + "\n" + ] => [ + {data: "actual data\n"} + ] + }, + "invalid retry" => { + [ + "retry: not a number\n", + "data: hello\n", + "\n" + ] => [ + {data: "hello\n"} + ] + }, + "invalid id with null" => { + [ + "id: bad\0id\n", + "data: hello\n", + "\n" + ] => [ + {data: "hello\n"} + ] + }, + "leading space in value" => { + [ + "data: hello world\n", + "data: leading space\n", + "\n" + ] => [ + {data: "hello world\n leading space\n"} + ] + }, + "no final newline" => { + [ + "data: hello\n", + "id: 1" + ] => [ + {data: "hello\n", id: "1"} + ] + }, + "multiple empty lines" => { + [ + "data: first\n", + "\n", + "\n", + "data: second\n", + "\n" + ] => [ + {data: "first\n"}, + {data: "second\n"} + ] + }, + "multibyte unicode" => { + [ + "data: \u1F62E\u200D\u1F4A8\n" + ] => [ + {data: "\u1F62E\u200D\u1F4A8\n"} + ] + } + } + + cases.each do |name, test_cases| + test_cases.each do |input, expected| + actual = Imagekit::Internal::Util.decode_sse(input).map(&:compact) + assert_equal(expected, actual, name) + end + end + end +end diff --git a/test/imagekit/resource_namespaces.rb b/test/imagekit/resource_namespaces.rb new file mode 100644 index 00000000..7f494522 --- /dev/null +++ b/test/imagekit/resource_namespaces.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Imagekit + module Test + module Resources + module Files + end + end + end +end diff --git a/test/imagekit/resources/accounts_test.rb b/test/imagekit/resources/accounts_test.rb new file mode 100644 index 00000000..e501bb77 --- /dev/null +++ b/test/imagekit/resources/accounts_test.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::AccountsTest < Imagekit::Test::ResourceTest + def test_get_usage_required_params + skip("Prism tests are disabled") + + response = @image_kit.accounts.get_usage(end_date: "2019-12-27", start_date: "2019-12-27") + + assert_pattern do + response => Imagekit::Models::AccountGetUsageResponse + end + + assert_pattern do + response => { + bandwidth_bytes: Integer | nil, + extension_units_count: Integer | nil, + media_library_storage_bytes: Integer | nil, + original_cache_storage_bytes: Integer | nil, + video_processing_units_count: Integer | nil + } + end + end +end diff --git a/test/imagekit/resources/bulk_jobs_test.rb b/test/imagekit/resources/bulk_jobs_test.rb new file mode 100644 index 00000000..fd8ac3e0 --- /dev/null +++ b/test/imagekit/resources/bulk_jobs_test.rb @@ -0,0 +1,63 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::BulkJobsTest < Imagekit::Test::ResourceTest + def test_copy_folder_required_params + skip("Prism tests are disabled") + + response = + @image_kit.bulk_jobs.copy_folder( + destination_path: "/path/of/destination/folder", + source_folder_path: "/path/of/source/folder" + ) + + assert_pattern do + response => Imagekit::Models::BulkJobCopyFolderResponse + end + + assert_pattern do + response => { + job_id: String | nil + } + end + end + + def test_move_folder_required_params + skip("Prism tests are disabled") + + response = + @image_kit.bulk_jobs.move_folder( + destination_path: "/path/of/destination/folder", + source_folder_path: "/path/of/source/folder" + ) + + assert_pattern do + response => Imagekit::Models::BulkJobMoveFolderResponse + end + + assert_pattern do + response => { + job_id: String | nil + } + end + end + + def test_retrieve_status + skip("Prism tests are disabled") + + response = @image_kit.bulk_jobs.retrieve_status("jobId") + + assert_pattern do + response => Imagekit::Models::BulkJobRetrieveStatusResponse + end + + assert_pattern do + response => { + job_id: String | nil, + status: String | nil, + type: String | nil + } + end + end +end diff --git a/test/imagekit/resources/custom_metadata_fields_test.rb b/test/imagekit/resources/custom_metadata_fields_test.rb new file mode 100644 index 00000000..03889f65 --- /dev/null +++ b/test/imagekit/resources/custom_metadata_fields_test.rb @@ -0,0 +1,64 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::CustomMetadataFieldsTest < Imagekit::Test::ResourceTest + def test_create_required_params + skip("Prism tests are disabled") + + response = + @image_kit.custom_metadata_fields.create(label: "price", name: "price", schema: {type: :Number}) + + assert_pattern do + response => Imagekit::Models::CustomMetadataFieldCreateResponse + end + + assert_pattern do + response => { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + } + end + end + + def test_update + skip("Prism tests are disabled") + + response = @image_kit.custom_metadata_fields.update("id") + + assert_pattern do + response => Imagekit::Models::CustomMetadataFieldUpdateResponse + end + + assert_pattern do + response => { + id: String, + label: String, + name: String, + schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema + } + end + end + + def test_list + skip("Prism tests are disabled") + + response = @image_kit.custom_metadata_fields.list + + assert_pattern do + response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::CustomMetadataFieldListResponseItem]) + end + end + + def test_delete + skip("Prism tests are disabled") + + response = @image_kit.custom_metadata_fields.delete("id") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end +end diff --git a/test/imagekit/resources/files/batch_test.rb b/test/imagekit/resources/files/batch_test.rb new file mode 100644 index 00000000..76a0f3ea --- /dev/null +++ b/test/imagekit/resources/files/batch_test.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Files::BatchTest < Imagekit::Test::ResourceTest + def test_delete_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.batch.delete(file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be]) + + assert_pattern do + response => Imagekit::Models::Files::BatchDeleteResponse + end + + assert_pattern do + response => { + successfully_deleted_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + } + end + end +end diff --git a/test/imagekit/resources/files/details_test.rb b/test/imagekit/resources/files/details_test.rb new file mode 100644 index 00000000..937a1be5 --- /dev/null +++ b/test/imagekit/resources/files/details_test.rb @@ -0,0 +1,78 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Files::DetailsTest < Imagekit::Test::ResourceTest + def test_retrieve + skip("Prism tests are disabled") + + response = @image_kit.files.details.retrieve("fileId") + + assert_pattern do + response => Imagekit::Models::Files::DetailRetrieveResponse + end + + assert_pattern do + response => { + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::DetailRetrieveResponse::AITag]) | nil, + created_at: String | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + has_alpha: Imagekit::Internal::Type::Boolean | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + mime: String | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail: String | nil, + type: String | nil, + updated_at: String | nil, + url: String | nil, + version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo | nil, + width: Float | nil + } + end + end + + def test_update + skip("Prism tests are disabled") + + response = @image_kit.files.details.update("fileId") + + assert_pattern do + response => Imagekit::Models::Files::DetailUpdateResponse + end + + assert_pattern do + response => { + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::DetailUpdateResponse::AITag]) | nil, + created_at: String | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + has_alpha: Imagekit::Internal::Type::Boolean | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + mime: String | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail: String | nil, + type: String | nil, + updated_at: String | nil, + url: String | nil, + version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo | nil, + width: Float | nil + } + end + end +end diff --git a/test/imagekit/resources/files/metadata_test.rb b/test/imagekit/resources/files/metadata_test.rb new file mode 100644 index 00000000..076c7531 --- /dev/null +++ b/test/imagekit/resources/files/metadata_test.rb @@ -0,0 +1,63 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Files::MetadataTest < Imagekit::Test::ResourceTest + def test_retrieve + skip("Prism tests are disabled") + + response = @image_kit.files.metadata.retrieve("fileId") + + assert_pattern do + response => Imagekit::Models::Files::MetadataRetrieveResponse + end + + assert_pattern do + response => { + audio_codec: String | nil, + bit_rate: Integer | nil, + density: Integer | nil, + duration: Integer | nil, + exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif | nil, + format_: String | nil, + has_color_profile: Imagekit::Internal::Type::Boolean | nil, + has_transparency: Imagekit::Internal::Type::Boolean | nil, + height: Integer | nil, + p_hash: String | nil, + quality: Integer | nil, + size: Integer | nil, + video_codec: String | nil, + width: Integer | nil + } + end + end + + def test_from_url_required_params + skip("Prism tests are disabled") + + response = @image_kit.files.metadata.from_url(url: "url") + + assert_pattern do + response => Imagekit::Models::Files::MetadataFromURLResponse + end + + assert_pattern do + response => { + audio_codec: String | nil, + bit_rate: Integer | nil, + density: Integer | nil, + duration: Integer | nil, + exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif | nil, + format_: String | nil, + has_color_profile: Imagekit::Internal::Type::Boolean | nil, + has_transparency: Imagekit::Internal::Type::Boolean | nil, + height: Integer | nil, + p_hash: String | nil, + quality: Integer | nil, + size: Integer | nil, + video_codec: String | nil, + width: Integer | nil + } + end + end +end diff --git a/test/imagekit/resources/files/purge_test.rb b/test/imagekit/resources/files/purge_test.rb new file mode 100644 index 00000000..10bfe7f5 --- /dev/null +++ b/test/imagekit/resources/files/purge_test.rb @@ -0,0 +1,38 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Files::PurgeTest < Imagekit::Test::ResourceTest + def test_execute_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.purge.execute(url: "https://ik.imagekit.io/your_imagekit_id/default-image.jpg") + + assert_pattern do + response => Imagekit::Models::Files::PurgeExecuteResponse + end + + assert_pattern do + response => { + request_id: String | nil + } + end + end + + def test_status + skip("Prism tests are disabled") + + response = @image_kit.files.purge.status("requestId") + + assert_pattern do + response => Imagekit::Models::Files::PurgeStatusResponse + end + + assert_pattern do + response => { + status: Imagekit::Models::Files::PurgeStatusResponse::Status | nil + } + end + end +end diff --git a/test/imagekit/resources/files/versions_test.rb b/test/imagekit/resources/files/versions_test.rb new file mode 100644 index 00000000..ad2cc5d2 --- /dev/null +++ b/test/imagekit/resources/files/versions_test.rb @@ -0,0 +1,97 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Files::VersionsTest < Imagekit::Test::ResourceTest + def test_retrieve_required_params + skip("Prism tests are disabled") + + response = @image_kit.files.versions.retrieve("versionId", file_id: "fileId") + + assert_pattern do + response => Imagekit::Models::Files::VersionRetrieveResponse + end + + assert_pattern do + response => { + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRetrieveResponse::AITag]) | nil, + created_at: String | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + has_alpha: Imagekit::Internal::Type::Boolean | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + mime: String | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail: String | nil, + type: String | nil, + updated_at: String | nil, + url: String | nil, + version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo | nil, + width: Float | nil + } + end + end + + def test_list + skip("Prism tests are disabled") + + response = @image_kit.files.versions.list("fileId") + + assert_pattern do + response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionListResponseItem]) + end + end + + def test_delete_required_params + skip("Prism tests are disabled") + + response = @image_kit.files.versions.delete("versionId", file_id: "fileId") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end + + def test_restore_required_params + skip("Prism tests are disabled") + + response = @image_kit.files.versions.restore("versionId", file_id: "fileId") + + assert_pattern do + response => Imagekit::Models::Files::VersionRestoreResponse + end + + assert_pattern do + response => { + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRestoreResponse::AITag]) | nil, + created_at: String | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + has_alpha: Imagekit::Internal::Type::Boolean | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + mime: String | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail: String | nil, + type: String | nil, + updated_at: String | nil, + url: String | nil, + version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo | nil, + width: Float | nil + } + end + end +end diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb new file mode 100644 index 00000000..7e678b84 --- /dev/null +++ b/test/imagekit/resources/files_test.rb @@ -0,0 +1,207 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::FilesTest < Imagekit::Test::ResourceTest + def test_list + skip("Prism tests are disabled") + + response = @image_kit.files.list + + assert_pattern do + response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileListResponseItem]) + end + end + + def test_delete + skip("Prism tests are disabled") + + response = @image_kit.files.delete("fileId") + + assert_pattern do + response => nil + end + end + + def test_add_tags_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.add_tags( + file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be], + tags: %w[t-shirt round-neck sale2019] + ) + + assert_pattern do + response => Imagekit::Models::FileAddTagsResponse + end + + assert_pattern do + response => { + successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + } + end + end + + def test_copy_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.copy(destination_path: "/folder/to/copy/into/", source_file_path: "/path/to/file.jpg") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end + + def test_move_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.move(destination_path: "/folder/to/move/into/", source_file_path: "/path/to/file.jpg") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end + + def test_remove_ai_tags_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.remove_ai_tags( + ai_tags: %w[t-shirt round-neck sale2019], + file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be] + ) + + assert_pattern do + response => Imagekit::Models::FileRemoveAITagsResponse + end + + assert_pattern do + response => { + successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + } + end + end + + def test_remove_tags_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.remove_tags( + file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be], + tags: %w[t-shirt round-neck sale2019] + ) + + assert_pattern do + response => Imagekit::Models::FileRemoveTagsResponse + end + + assert_pattern do + response => { + successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + } + end + end + + def test_rename_required_params + skip("Prism tests are disabled") + + response = @image_kit.files.rename(file_path: "/path/to/file.jpg", new_file_name: "newFileName.jpg") + + assert_pattern do + response => Imagekit::Models::FileRenameResponse + end + + assert_pattern do + response => { + purge_request_id: String | nil + } + end + end + + def test_upload_v1_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.upload_v1( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + + assert_pattern do + response => Imagekit::Models::FileUploadV1Response + end + + assert_pattern do + response => { + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadV1Response::AITag]) | nil, + audio_codec: String | nil, + bit_rate: Integer | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + duration: Integer | nil, + embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata | nil, + extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + metadata: Imagekit::Models::FileUploadV1Response::Metadata | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail_url: String | nil, + url: String | nil, + version_info: Imagekit::Models::FileUploadV1Response::VersionInfo | nil, + video_codec: String | nil, + width: Float | nil + } + end + end + + def test_upload_v2_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.upload_v2( + file: "https://www.example.com/rest-of-the-image-path.jpg", + file_name: "fileName" + ) + + assert_pattern do + response => Imagekit::Models::FileUploadV2Response + end + + assert_pattern do + response => { + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadV2Response::AITag]) | nil, + audio_codec: String | nil, + bit_rate: Integer | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + duration: Integer | nil, + embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata | nil, + extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + metadata: Imagekit::Models::FileUploadV2Response::Metadata | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail_url: String | nil, + url: String | nil, + version_info: Imagekit::Models::FileUploadV2Response::VersionInfo | nil, + video_codec: String | nil, + width: Float | nil + } + end + end +end diff --git a/test/imagekit/resources/folder_test.rb b/test/imagekit/resources/folder_test.rb new file mode 100644 index 00000000..dcb8e4fa --- /dev/null +++ b/test/imagekit/resources/folder_test.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::FolderTest < Imagekit::Test::ResourceTest + def test_create_required_params + skip("Prism tests are disabled") + + response = @image_kit.folder.create(folder_name: "summer", parent_folder_path: "/product/images/") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end + + def test_delete_required_params + skip("Prism tests are disabled") + + response = @image_kit.folder.delete(folder_path: "/folder/to/delete/") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end +end diff --git a/test/imagekit/test_helper.rb b/test/imagekit/test_helper.rb new file mode 100644 index 00000000..92dbd107 --- /dev/null +++ b/test/imagekit/test_helper.rb @@ -0,0 +1,91 @@ +# frozen_string_literal: true + +# Requiring this file from each test file ensures we always do the following, even +# when running a single-file test: +# - Load the whole gem (as one would in production) +# - Define shared testing namespace so that we don't need to indent test files as much +# - Setting up testing dependencies + +require "digest" +require "singleton" + +require "async" +require "minitest/autorun" +require "minitest/focus" +require "minitest/hooks/test" +require "minitest/proveit" +require "minitest/rg" +require "webmock" + +require_relative "../../lib/imagekit" +require_relative "resource_namespaces" + +module Kernel + alias_method :_sleep, :sleep + + def sleep(secs) + case Thread.current.thread_variable_get(:mock_sleep) + in Array => counter + counter << secs + secs + else + _sleep(secs) + end + end +end + +class Time + class << self + alias_method :_now, :now + end + + def self.now = Thread.current.thread_variable_get(:time_now) || _now +end + +class Imagekit::Test::SingletonClient < Imagekit::Client + include Singleton + + TEST_API_BASE_URL = ENV.fetch("TEST_API_BASE_URL", "http://localhost:4010") + + def initialize + super( + base_url: Imagekit::Test::SingletonClient::TEST_API_BASE_URL, + private_api_key: "My Private API Key", + password: "My Password" + ) + end +end + +module Minitest::Serial + def test_order = :random + + def run_one_method(...) = Minitest::Runnable.run_one_method(...) +end + +class Minitest::Test + include Minitest::Hooks + + make_my_diffs_pretty! + parallelize_me! + prove_it! +end + +class Imagekit::Test::ResourceTest < Minitest::Test + def async? + return @async unless @async.nil? + @async = Digest::SHA256.hexdigest(self.class.name).to_i(16).odd? + end + + def before_all + super + @image_kit = Imagekit::Test::SingletonClient.instance + end + + def around_all = async? ? Sync { super } : super + + def around = async? ? Async { super }.wait : super +end + +module WebMock + AssertionFailure.error_class = Minitest::Assertion +end From ca0406c47688662fbdaa3a554d1e5bde6f08555a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 17 Aug 2025 06:00:09 +0000 Subject: [PATCH 003/178] feat(api): manual updates --- .stats.yml | 8 +- README.md | 80 +- lib/imagekit.rb | 114 +- lib/imagekit/client.rb | 20 +- lib/imagekit/internal/type/union.rb | 13 + lib/imagekit/models.rb | 32 +- .../models/account_get_usage_params.rb | 35 - .../models/account_get_usage_response.rb | 49 - .../models/accounts/origin_create_params.rb | 189 ++ .../models/accounts/origin_create_response.rb | 649 ++++ .../origin_delete_params.rb} | 6 +- .../models/accounts/origin_get_params.rb | 16 + .../models/accounts/origin_get_response.rb | 648 ++++ .../models/accounts/origin_list_params.rb | 16 + .../models/accounts/origin_list_response.rb | 654 ++++ .../models/accounts/origin_update_params.rb | 189 ++ .../models/accounts/origin_update_response.rb | 649 ++++ .../accounts/url_endpoint_create_params.rb | 149 + .../accounts/url_endpoint_create_response.rb | 154 + .../accounts/url_endpoint_delete_params.rb | 16 + .../url_endpoint_get_params.rb} | 6 +- .../accounts/url_endpoint_get_response.rb | 154 + .../accounts/url_endpoint_list_params.rb | 16 + .../accounts/url_endpoint_list_response.rb | 157 + .../accounts/url_endpoint_update_params.rb | 149 + .../accounts/url_endpoint_update_response.rb | 154 + .../models/accounts/usage_get_params.rb | 37 + .../models/accounts/usage_get_response.rb | 51 + lib/imagekit/models/asset_list_params.rb | 158 + ...eve_response.rb => asset_list_response.rb} | 109 +- .../models/beta/v2/file_upload_params.rb | 677 +++++ .../models/beta/v2/file_upload_response.rb | 847 ++++++ .../bulk_job_retrieve_status_response.rb | 36 - .../invalidation_create_params.rb} | 8 +- .../invalidation_create_response.rb} | 8 +- .../models/cache/invalidation_get_params.rb | 16 + .../models/cache/invalidation_get_response.rb | 35 + .../custom_metadata_field_create_params.rb | 2 +- .../custom_metadata_field_create_response.rb | 2 +- .../custom_metadata_field_list_params.rb | 5 +- .../custom_metadata_field_list_response.rb | 2 +- .../custom_metadata_field_update_response.rb | 2 +- lib/imagekit/models/exif_details.rb | 167 -- lib/imagekit/models/exif_image.rb | 77 - lib/imagekit/models/file_add_tags_params.rb | 33 - lib/imagekit/models/file_add_tags_response.rb | 22 - ...ve_status_params.rb => file_get_params.rb} | 4 +- ..._list_response.rb => file_get_response.rb} | 24 +- lib/imagekit/models/file_list_params.rb | 130 - .../models/file_remove_ai_tags_params.rb | 33 - .../models/file_remove_ai_tags_response.rb | 22 - .../models/file_remove_tags_params.rb | 33 - .../models/file_remove_tags_response.rb | 22 - lib/imagekit/models/file_update_params.rb | 309 ++ lib/imagekit/models/file_update_response.rb | 337 +++ lib/imagekit/models/file_upload_params.rb | 692 +++++ lib/imagekit/models/file_upload_response.rb | 840 ++++++ lib/imagekit/models/file_upload_v1_params.rb | 384 --- .../models/file_upload_v1_response.rb | 1706 ----------- lib/imagekit/models/file_upload_v2_params.rb | 345 --- .../models/file_upload_v2_response.rb | 1706 ----------- .../models/files/bulk_add_tags_params.rb | 35 + .../models/files/bulk_add_tags_response.rb | 24 + ...delete_params.rb => bulk_delete_params.rb} | 6 +- ...te_response.rb => bulk_delete_response.rb} | 6 +- .../files/bulk_remove_ai_tags_params.rb | 35 + .../files/bulk_remove_ai_tags_response.rb | 24 + .../models/files/bulk_remove_tags_params.rb | 35 + .../models/files/bulk_remove_tags_response.rb | 24 + .../models/files/detail_update_params.rb | 289 -- .../models/files/detail_update_response.rb | 321 -- .../files/metadata_from_url_response.rb | 175 -- ...ams.rb => metadata_get_from_url_params.rb} | 6 +- .../files/metadata_get_from_url_response.rb | 487 +++ ...tatus_params.rb => metadata_get_params.rb} | 4 +- .../models/files/metadata_get_response.rb | 486 +++ .../files/metadata_retrieve_response.rb | 175 -- .../models/files/purge_status_response.rb | 35 - ...trieve_params.rb => version_get_params.rb} | 4 +- ...ve_response.rb => version_get_response.rb} | 22 +- ...folder_params.rb => folder_copy_params.rb} | 6 +- ...er_response.rb => folder_copy_response.rb} | 6 +- lib/imagekit/models/folder_create_params.rb | 2 +- lib/imagekit/models/folder_delete_params.rb | 2 +- ...folder_params.rb => folder_move_params.rb} | 6 +- ...er_response.rb => folder_move_response.rb} | 6 +- lib/imagekit/models/folder_rename_params.rb | 59 + lib/imagekit/models/folder_rename_response.rb | 21 + lib/imagekit/models/folders/job_get_params.rb | 16 + .../models/folders/job_get_response.rb | 48 + lib/imagekit/models/gps.rb | 17 - lib/imagekit/models/interoperability.rb | 23 - lib/imagekit/models/thumbnail.rb | 47 - lib/imagekit/resources/accounts.rb | 40 +- lib/imagekit/resources/accounts/origins.rb | 215 ++ .../resources/accounts/url_endpoints.rb | 151 + lib/imagekit/resources/accounts/usage.rb | 46 + lib/imagekit/resources/assets.rb | 54 + lib/imagekit/resources/beta.rb | 18 + lib/imagekit/resources/beta/v2.rb | 20 + lib/imagekit/resources/beta/v2/files.rb | 110 + lib/imagekit/resources/bulk_jobs.rb | 100 - lib/imagekit/resources/cache.rb | 18 + .../{files/purge.rb => cache/invalidation.rb} | 30 +- .../resources/custom_metadata_fields.rb | 2 +- lib/imagekit/resources/files.rb | 301 +- lib/imagekit/resources/files/batch.rb | 47 - lib/imagekit/resources/files/bulk.rb | 131 + lib/imagekit/resources/files/details.rb | 81 - lib/imagekit/resources/files/metadata.rb | 26 +- lib/imagekit/resources/files/versions.rb | 60 +- lib/imagekit/resources/folder.rb | 68 - lib/imagekit/resources/folders.rb | 166 ++ lib/imagekit/resources/folders/job.rb | 39 + rbi/imagekit/client.rbi | 14 +- rbi/imagekit/models.rbi | 32 +- .../models/account_get_usage_params.rbi | 55 - .../models/account_get_usage_response.rbi | 87 - .../models/accounts/origin_create_params.rbi | 233 ++ .../accounts/origin_create_response.rbi | 998 +++++++ .../origin_delete_params.rbi} | 6 +- .../models/accounts/origin_get_params.rbi | 32 + .../models/accounts/origin_get_response.rbi | 998 +++++++ .../models/accounts/origin_list_params.rbi | 32 + .../models/accounts/origin_list_response.rbi | 1008 +++++++ .../models/accounts/origin_update_params.rbi | 233 ++ .../accounts/origin_update_response.rbi | 998 +++++++ .../accounts/url_endpoint_create_params.rbi | 351 +++ .../accounts/url_endpoint_create_response.rbi | 341 +++ .../accounts/url_endpoint_delete_params.rbi | 32 + .../url_endpoint_get_params.rbi} | 6 +- .../accounts/url_endpoint_get_response.rbi | 341 +++ .../accounts/url_endpoint_list_params.rbi | 32 + .../accounts/url_endpoint_list_response.rbi | 349 +++ .../accounts/url_endpoint_update_params.rbi | 351 +++ .../accounts/url_endpoint_update_response.rbi | 341 +++ .../models/accounts/usage_get_params.rbi | 60 + .../models/accounts/usage_get_response.rbi | 89 + rbi/imagekit/models/asset_list_params.rbi | 269 ++ ...e_response.rbi => asset_list_response.rbi} | 199 +- .../models/beta/v2/file_upload_params.rbi | 1390 +++++++++ .../models/beta/v2/file_upload_response.rbi | 1593 ++++++++++ .../bulk_job_retrieve_status_response.rbi | 55 - .../invalidation_create_params.rbi} | 6 +- .../invalidation_create_response.rbi} | 6 +- .../models/cache/invalidation_get_params.rbi | 32 + .../invalidation_get_response.rbi} | 22 +- .../custom_metadata_field_create_params.rbi | 4 +- .../custom_metadata_field_create_response.rbi | 4 +- .../custom_metadata_field_list_params.rbi | 6 +- .../custom_metadata_field_list_response.rbi | 4 +- .../custom_metadata_field_update_response.rbi | 4 +- rbi/imagekit/models/exif_details.rbi | 264 -- rbi/imagekit/models/exif_image.rbi | 127 - rbi/imagekit/models/file_add_tags_params.rbi | 51 - .../models/file_add_tags_response.rbi | 39 - ..._status_params.rbi => file_get_params.rbi} | 7 +- ...ist_response.rbi => file_get_response.rbi} | 41 +- rbi/imagekit/models/file_list_params.rbi | 219 -- .../models/file_remove_ai_tags_params.rbi | 51 - .../models/file_remove_ai_tags_response.rbi | 39 - .../models/file_remove_tags_params.rbi | 51 - .../models/file_remove_tags_response.rbi | 39 - rbi/imagekit/models/file_update_params.rbi | 656 ++++ rbi/imagekit/models/file_update_response.rbi | 667 +++++ rbi/imagekit/models/file_upload_params.rbi | 1421 +++++++++ rbi/imagekit/models/file_upload_response.rbi | 1556 ++++++++++ rbi/imagekit/models/file_upload_v1_params.rbi | 722 ----- .../models/file_upload_v1_response.rbi | 2625 ----------------- rbi/imagekit/models/file_upload_v2_params.rbi | 659 ----- .../models/file_upload_v2_response.rbi | 2625 ----------------- .../models/files/bulk_add_tags_params.rbi | 56 + .../models/files/bulk_add_tags_response.rbi | 41 + ...lete_params.rbi => bulk_delete_params.rbi} | 4 +- ..._response.rbi => bulk_delete_response.rbi} | 4 +- .../files/bulk_remove_ai_tags_params.rbi | 56 + .../files/bulk_remove_ai_tags_response.rbi | 41 + .../models/files/bulk_remove_tags_params.rbi | 56 + .../files/bulk_remove_tags_response.rbi | 41 + .../models/files/detail_update_params.rbi | 583 ---- .../models/files/detail_update_response.rbi | 623 ---- .../files/metadata_from_url_response.rbi | 289 -- ...s.rbi => metadata_get_from_url_params.rbi} | 4 +- .../files/metadata_get_from_url_response.rbi | 892 ++++++ ...tus_params.rbi => metadata_get_params.rbi} | 4 +- .../models/files/metadata_get_response.rbi | 884 ++++++ .../files/metadata_retrieve_response.rbi | 290 -- ...ieve_params.rbi => version_get_params.rbi} | 4 +- ..._response.rbi => version_get_response.rbi} | 26 +- ...lder_params.rbi => folder_copy_params.rbi} | 4 +- ..._response.rbi => folder_copy_response.rbi} | 4 +- ...lder_params.rbi => folder_move_params.rbi} | 4 +- ..._response.rbi => folder_move_response.rbi} | 4 +- rbi/imagekit/models/folder_rename_params.rbi | 98 + .../models/folder_rename_response.rbi | 35 + .../models/folders/job_get_params.rbi | 29 + .../models/folders/job_get_response.rbi | 82 + rbi/imagekit/models/gps.rbi | 27 - rbi/imagekit/models/interoperability.rbi | 39 - rbi/imagekit/models/thumbnail.rbi | 82 - rbi/imagekit/resources/accounts.rbi | 29 +- rbi/imagekit/resources/accounts/origins.rbi | 197 ++ .../resources/accounts/url_endpoints.rbi | 129 + rbi/imagekit/resources/accounts/usage.rbi | 36 + rbi/imagekit/resources/assets.rbi | 74 + rbi/imagekit/resources/beta.rbi | 15 + rbi/imagekit/resources/beta/v2.rbi | 17 + rbi/imagekit/resources/beta/v2/files.rbi | 193 ++ rbi/imagekit/resources/bulk_jobs.rbi | 75 - rbi/imagekit/resources/cache.rbi | 15 + .../purge.rbi => cache/invalidation.rbi} | 12 +- .../resources/custom_metadata_fields.rbi | 3 +- rbi/imagekit/resources/files.rbi | 492 +-- rbi/imagekit/resources/files/batch.rbi | 34 - rbi/imagekit/resources/files/bulk.rbi | 88 + rbi/imagekit/resources/files/details.rbi | 93 - rbi/imagekit/resources/files/metadata.rbi | 8 +- rbi/imagekit/resources/files/versions.rbi | 36 +- rbi/imagekit/resources/folder.rbi | 55 - rbi/imagekit/resources/folders.rbi | 146 + rbi/imagekit/resources/folders/job.rbi | 29 + sig/imagekit/client.rbs | 8 +- sig/imagekit/models.rbs | 32 +- .../models/account_get_usage_params.rbs | 28 - .../models/account_get_usage_response.rbs | 50 - .../models/accounts/origin_create_params.rbs | 148 + .../accounts/origin_create_response.rbs | 498 ++++ .../origin_delete_params.rbs} | 6 +- .../models/accounts/origin_get_params.rbs | 17 + .../models/accounts/origin_get_response.rbs | 498 ++++ .../models/accounts/origin_list_params.rbs | 17 + .../models/accounts/origin_list_response.rbs | 503 ++++ .../models/accounts/origin_update_params.rbs | 148 + .../accounts/origin_update_response.rbs | 498 ++++ .../accounts/url_endpoint_create_params.rbs | 150 + .../accounts/url_endpoint_create_response.rbs | 143 + .../accounts/url_endpoint_delete_params.rbs | 17 + .../url_endpoint_get_params.rbs} | 6 +- .../accounts/url_endpoint_get_response.rbs | 143 + .../accounts/url_endpoint_list_params.rbs | 17 + .../accounts/url_endpoint_list_response.rbs | 148 + .../accounts/url_endpoint_update_params.rbs | 150 + .../accounts/url_endpoint_update_response.rbs | 143 + .../models/accounts/usage_get_params.rbs | 30 + .../models/accounts/usage_get_response.rbs | 52 + sig/imagekit/models/asset_list_params.rbs | 138 + ...e_response.rbs => asset_list_response.rbs} | 105 +- .../models/beta/v2/file_upload_params.rbs | 530 ++++ .../models/beta/v2/file_upload_response.rbs | 843 ++++++ .../bulk_job_retrieve_status_response.rbs | 24 - .../invalidation_create_params.rbs} | 6 +- .../invalidation_create_response.rbs} | 6 +- .../models/cache/invalidation_get_params.rbs | 17 + .../cache/invalidation_get_response.rbs | 35 + .../custom_metadata_field_create_params.rbs | 4 +- .../custom_metadata_field_create_response.rbs | 4 +- .../custom_metadata_field_list_response.rbs | 4 +- .../custom_metadata_field_update_response.rbs | 4 +- sig/imagekit/models/exif_details.rbs | 197 -- sig/imagekit/models/exif_image.rbs | 92 - sig/imagekit/models/file_add_tags_params.rbs | 28 - .../models/file_add_tags_response.rbs | 16 - ..._status_params.rbs => file_get_params.rbs} | 5 +- ...ist_response.rbs => file_get_response.rbs} | 28 +- sig/imagekit/models/file_list_params.rbs | 85 - .../models/file_remove_ai_tags_params.rbs | 28 - .../models/file_remove_ai_tags_response.rbs | 16 - .../models/file_remove_tags_params.rbs | 28 - .../models/file_remove_tags_response.rbs | 16 - sig/imagekit/models/file_update_params.rbs | 260 ++ sig/imagekit/models/file_update_response.rbs | 303 ++ sig/imagekit/models/file_upload_params.rbs | 547 ++++ sig/imagekit/models/file_upload_response.rbs | 836 ++++++ sig/imagekit/models/file_upload_v1_params.rbs | 249 -- .../models/file_upload_v1_response.rbs | 1741 ----------- sig/imagekit/models/file_upload_v2_params.rbs | 228 -- .../models/file_upload_v2_response.rbs | 1741 ----------- .../models/files/bulk_add_tags_params.rbs | 30 + .../models/files/bulk_add_tags_response.rbs | 20 + ...lete_params.rbs => bulk_delete_params.rbs} | 4 +- ..._response.rbs => bulk_delete_response.rbs} | 4 +- .../files/bulk_remove_ai_tags_params.rbs | 30 + .../files/bulk_remove_ai_tags_response.rbs | 20 + .../models/files/bulk_remove_tags_params.rbs | 30 + .../files/bulk_remove_tags_response.rbs | 20 + .../models/files/detail_update_params.rbs | 227 -- .../models/files/detail_update_response.rbs | 284 -- .../files/metadata_from_url_response.rbs | 173 -- ...s.rbs => metadata_get_from_url_params.rbs} | 4 +- .../files/metadata_get_from_url_response.rbs | 550 ++++ ...tus_params.rbs => metadata_get_params.rbs} | 4 +- .../models/files/metadata_get_response.rbs | 550 ++++ .../files/metadata_retrieve_response.rbs | 173 -- .../models/files/purge_status_response.rbs | 35 - ...ieve_params.rbs => version_get_params.rbs} | 4 +- ..._response.rbs => version_get_response.rbs} | 24 +- ...lder_params.rbs => folder_copy_params.rbs} | 4 +- ..._response.rbs => folder_copy_response.rbs} | 4 +- ...lder_params.rbs => folder_move_params.rbs} | 4 +- ..._response.rbs => folder_move_response.rbs} | 4 +- sig/imagekit/models/folder_rename_params.rbs | 34 + .../models/folder_rename_response.rbs | 15 + .../models/folders/job_get_params.rbs | 16 + .../models/folders/job_get_response.rbs | 45 + sig/imagekit/models/gps.rbs | 15 - sig/imagekit/models/interoperability.rbs | 19 - sig/imagekit/models/thumbnail.rbs | 57 - sig/imagekit/resources/accounts.rbs | 10 +- sig/imagekit/resources/accounts/origins.rbs | 71 + .../resources/accounts/url_endpoints.rbs | 37 + sig/imagekit/resources/accounts/usage.rbs | 15 + sig/imagekit/resources/assets.rbs | 18 + sig/imagekit/resources/beta.rbs | 9 + sig/imagekit/resources/beta/v2.rbs | 11 + sig/imagekit/resources/beta/v2/files.rbs | 35 + sig/imagekit/resources/bulk_jobs.rbs | 25 - sig/imagekit/resources/cache.rbs | 9 + .../purge.rbs => cache/invalidation.rbs} | 12 +- sig/imagekit/resources/files.rbs | 105 +- sig/imagekit/resources/files/bulk.rbs | 32 + sig/imagekit/resources/files/details.rbs | 26 - sig/imagekit/resources/files/metadata.rbs | 8 +- sig/imagekit/resources/files/versions.rbs | 12 +- sig/imagekit/resources/folder.rbs | 18 - sig/imagekit/resources/folders.rbs | 40 + .../{files/batch.rbs => folders/job.rbs} | 10 +- test/imagekit/client_test.rb | 67 +- test/imagekit/resource_namespaces.rb | 17 + .../resources/accounts/origins_test.rb | 113 + .../resources/accounts/url_endpoints_test.rb | 85 + .../imagekit/resources/accounts/usage_test.rb | 25 + test/imagekit/resources/accounts_test.rb | 19 - test/imagekit/resources/assets_test.rb | 15 + test/imagekit/resources/beta/v2/files_test.rb | 43 + test/imagekit/resources/beta/v2_test.rb | 6 + test/imagekit/resources/beta_test.rb | 6 + test/imagekit/resources/bulk_jobs_test.rb | 63 - .../resources/cache/invalidation_test.rb | 38 + test/imagekit/resources/cache_test.rb | 6 + test/imagekit/resources/files/batch_test.rb | 22 - test/imagekit/resources/files/bulk_test.rb | 82 + test/imagekit/resources/files/details_test.rb | 78 - .../imagekit/resources/files/metadata_test.rb | 16 +- test/imagekit/resources/files/purge_test.rb | 38 - .../imagekit/resources/files/versions_test.rb | 50 +- test/imagekit/resources/files_test.rb | 173 +- test/imagekit/resources/folder_test.rb | 25 - test/imagekit/resources/folders/job_test.rb | 24 + test/imagekit/resources/folders_test.rb | 81 + 349 files changed, 38146 insertions(+), 23398 deletions(-) delete mode 100644 lib/imagekit/models/account_get_usage_params.rb delete mode 100644 lib/imagekit/models/account_get_usage_response.rb create mode 100644 lib/imagekit/models/accounts/origin_create_params.rb create mode 100644 lib/imagekit/models/accounts/origin_create_response.rb rename lib/imagekit/models/{files/metadata_retrieve_params.rb => accounts/origin_delete_params.rb} (70%) create mode 100644 lib/imagekit/models/accounts/origin_get_params.rb create mode 100644 lib/imagekit/models/accounts/origin_get_response.rb create mode 100644 lib/imagekit/models/accounts/origin_list_params.rb create mode 100644 lib/imagekit/models/accounts/origin_list_response.rb create mode 100644 lib/imagekit/models/accounts/origin_update_params.rb create mode 100644 lib/imagekit/models/accounts/origin_update_response.rb create mode 100644 lib/imagekit/models/accounts/url_endpoint_create_params.rb create mode 100644 lib/imagekit/models/accounts/url_endpoint_create_response.rb create mode 100644 lib/imagekit/models/accounts/url_endpoint_delete_params.rb rename lib/imagekit/models/{files/detail_retrieve_params.rb => accounts/url_endpoint_get_params.rb} (71%) create mode 100644 lib/imagekit/models/accounts/url_endpoint_get_response.rb create mode 100644 lib/imagekit/models/accounts/url_endpoint_list_params.rb create mode 100644 lib/imagekit/models/accounts/url_endpoint_list_response.rb create mode 100644 lib/imagekit/models/accounts/url_endpoint_update_params.rb create mode 100644 lib/imagekit/models/accounts/url_endpoint_update_response.rb create mode 100644 lib/imagekit/models/accounts/usage_get_params.rb create mode 100644 lib/imagekit/models/accounts/usage_get_response.rb create mode 100644 lib/imagekit/models/asset_list_params.rb rename lib/imagekit/models/{files/detail_retrieve_response.rb => asset_list_response.rb} (65%) create mode 100644 lib/imagekit/models/beta/v2/file_upload_params.rb create mode 100644 lib/imagekit/models/beta/v2/file_upload_response.rb delete mode 100644 lib/imagekit/models/bulk_job_retrieve_status_response.rb rename lib/imagekit/models/{files/purge_execute_params.rb => cache/invalidation_create_params.rb} (73%) rename lib/imagekit/models/{files/purge_execute_response.rb => cache/invalidation_create_response.rb} (71%) create mode 100644 lib/imagekit/models/cache/invalidation_get_params.rb create mode 100644 lib/imagekit/models/cache/invalidation_get_response.rb delete mode 100644 lib/imagekit/models/exif_details.rb delete mode 100644 lib/imagekit/models/exif_image.rb delete mode 100644 lib/imagekit/models/file_add_tags_params.rb delete mode 100644 lib/imagekit/models/file_add_tags_response.rb rename lib/imagekit/models/{bulk_job_retrieve_status_params.rb => file_get_params.rb} (71%) rename lib/imagekit/models/{file_list_response.rb => file_get_response.rb} (88%) delete mode 100644 lib/imagekit/models/file_list_params.rb delete mode 100644 lib/imagekit/models/file_remove_ai_tags_params.rb delete mode 100644 lib/imagekit/models/file_remove_ai_tags_response.rb delete mode 100644 lib/imagekit/models/file_remove_tags_params.rb delete mode 100644 lib/imagekit/models/file_remove_tags_response.rb create mode 100644 lib/imagekit/models/file_update_params.rb create mode 100644 lib/imagekit/models/file_update_response.rb create mode 100644 lib/imagekit/models/file_upload_params.rb create mode 100644 lib/imagekit/models/file_upload_response.rb delete mode 100644 lib/imagekit/models/file_upload_v1_params.rb delete mode 100644 lib/imagekit/models/file_upload_v1_response.rb delete mode 100644 lib/imagekit/models/file_upload_v2_params.rb delete mode 100644 lib/imagekit/models/file_upload_v2_response.rb create mode 100644 lib/imagekit/models/files/bulk_add_tags_params.rb create mode 100644 lib/imagekit/models/files/bulk_add_tags_response.rb rename lib/imagekit/models/files/{batch_delete_params.rb => bulk_delete_params.rb} (79%) rename lib/imagekit/models/files/{batch_delete_response.rb => bulk_delete_response.rb} (77%) create mode 100644 lib/imagekit/models/files/bulk_remove_ai_tags_params.rb create mode 100644 lib/imagekit/models/files/bulk_remove_ai_tags_response.rb create mode 100644 lib/imagekit/models/files/bulk_remove_tags_params.rb create mode 100644 lib/imagekit/models/files/bulk_remove_tags_response.rb delete mode 100644 lib/imagekit/models/files/detail_update_params.rb delete mode 100644 lib/imagekit/models/files/detail_update_response.rb delete mode 100644 lib/imagekit/models/files/metadata_from_url_response.rb rename lib/imagekit/models/files/{metadata_from_url_params.rb => metadata_get_from_url_params.rb} (78%) create mode 100644 lib/imagekit/models/files/metadata_get_from_url_response.rb rename lib/imagekit/models/files/{purge_status_params.rb => metadata_get_params.rb} (76%) create mode 100644 lib/imagekit/models/files/metadata_get_response.rb delete mode 100644 lib/imagekit/models/files/metadata_retrieve_response.rb delete mode 100644 lib/imagekit/models/files/purge_status_response.rb rename lib/imagekit/models/files/{version_retrieve_params.rb => version_get_params.rb} (80%) rename lib/imagekit/models/files/{version_retrieve_response.rb => version_get_response.rb} (90%) rename lib/imagekit/models/{bulk_job_copy_folder_params.rb => folder_copy_params.rb} (89%) rename lib/imagekit/models/{bulk_job_move_folder_response.rb => folder_copy_response.rb} (72%) rename lib/imagekit/models/{bulk_job_move_folder_params.rb => folder_move_params.rb} (85%) rename lib/imagekit/models/{bulk_job_copy_folder_response.rb => folder_move_response.rb} (72%) create mode 100644 lib/imagekit/models/folder_rename_params.rb create mode 100644 lib/imagekit/models/folder_rename_response.rb create mode 100644 lib/imagekit/models/folders/job_get_params.rb create mode 100644 lib/imagekit/models/folders/job_get_response.rb delete mode 100644 lib/imagekit/models/gps.rb delete mode 100644 lib/imagekit/models/interoperability.rb delete mode 100644 lib/imagekit/models/thumbnail.rb create mode 100644 lib/imagekit/resources/accounts/origins.rb create mode 100644 lib/imagekit/resources/accounts/url_endpoints.rb create mode 100644 lib/imagekit/resources/accounts/usage.rb create mode 100644 lib/imagekit/resources/assets.rb create mode 100644 lib/imagekit/resources/beta.rb create mode 100644 lib/imagekit/resources/beta/v2.rb create mode 100644 lib/imagekit/resources/beta/v2/files.rb delete mode 100644 lib/imagekit/resources/bulk_jobs.rb create mode 100644 lib/imagekit/resources/cache.rb rename lib/imagekit/resources/{files/purge.rb => cache/invalidation.rb} (61%) delete mode 100644 lib/imagekit/resources/files/batch.rb create mode 100644 lib/imagekit/resources/files/bulk.rb delete mode 100644 lib/imagekit/resources/files/details.rb delete mode 100644 lib/imagekit/resources/folder.rb create mode 100644 lib/imagekit/resources/folders.rb create mode 100644 lib/imagekit/resources/folders/job.rb delete mode 100644 rbi/imagekit/models/account_get_usage_params.rbi delete mode 100644 rbi/imagekit/models/account_get_usage_response.rbi create mode 100644 rbi/imagekit/models/accounts/origin_create_params.rbi create mode 100644 rbi/imagekit/models/accounts/origin_create_response.rbi rename rbi/imagekit/models/{files/metadata_retrieve_params.rbi => accounts/origin_delete_params.rbi} (81%) create mode 100644 rbi/imagekit/models/accounts/origin_get_params.rbi create mode 100644 rbi/imagekit/models/accounts/origin_get_response.rbi create mode 100644 rbi/imagekit/models/accounts/origin_list_params.rbi create mode 100644 rbi/imagekit/models/accounts/origin_list_response.rbi create mode 100644 rbi/imagekit/models/accounts/origin_update_params.rbi create mode 100644 rbi/imagekit/models/accounts/origin_update_response.rbi create mode 100644 rbi/imagekit/models/accounts/url_endpoint_create_params.rbi create mode 100644 rbi/imagekit/models/accounts/url_endpoint_create_response.rbi create mode 100644 rbi/imagekit/models/accounts/url_endpoint_delete_params.rbi rename rbi/imagekit/models/{files/detail_retrieve_params.rbi => accounts/url_endpoint_get_params.rbi} (82%) create mode 100644 rbi/imagekit/models/accounts/url_endpoint_get_response.rbi create mode 100644 rbi/imagekit/models/accounts/url_endpoint_list_params.rbi create mode 100644 rbi/imagekit/models/accounts/url_endpoint_list_response.rbi create mode 100644 rbi/imagekit/models/accounts/url_endpoint_update_params.rbi create mode 100644 rbi/imagekit/models/accounts/url_endpoint_update_response.rbi create mode 100644 rbi/imagekit/models/accounts/usage_get_params.rbi create mode 100644 rbi/imagekit/models/accounts/usage_get_response.rbi create mode 100644 rbi/imagekit/models/asset_list_params.rbi rename rbi/imagekit/models/{files/version_retrieve_response.rbi => asset_list_response.rbi} (65%) create mode 100644 rbi/imagekit/models/beta/v2/file_upload_params.rbi create mode 100644 rbi/imagekit/models/beta/v2/file_upload_response.rbi delete mode 100644 rbi/imagekit/models/bulk_job_retrieve_status_response.rbi rename rbi/imagekit/models/{files/purge_execute_params.rbi => cache/invalidation_create_params.rbi} (86%) rename rbi/imagekit/models/{files/purge_execute_response.rbi => cache/invalidation_create_response.rbi} (83%) create mode 100644 rbi/imagekit/models/cache/invalidation_get_params.rbi rename rbi/imagekit/models/{files/purge_status_response.rbi => cache/invalidation_get_response.rbi} (64%) delete mode 100644 rbi/imagekit/models/exif_details.rbi delete mode 100644 rbi/imagekit/models/exif_image.rbi delete mode 100644 rbi/imagekit/models/file_add_tags_params.rbi delete mode 100644 rbi/imagekit/models/file_add_tags_response.rbi rename rbi/imagekit/models/{bulk_job_retrieve_status_params.rbi => file_get_params.rbi} (73%) rename rbi/imagekit/models/{file_list_response.rbi => file_get_response.rbi} (89%) delete mode 100644 rbi/imagekit/models/file_list_params.rbi delete mode 100644 rbi/imagekit/models/file_remove_ai_tags_params.rbi delete mode 100644 rbi/imagekit/models/file_remove_ai_tags_response.rbi delete mode 100644 rbi/imagekit/models/file_remove_tags_params.rbi delete mode 100644 rbi/imagekit/models/file_remove_tags_response.rbi create mode 100644 rbi/imagekit/models/file_update_params.rbi create mode 100644 rbi/imagekit/models/file_update_response.rbi create mode 100644 rbi/imagekit/models/file_upload_params.rbi create mode 100644 rbi/imagekit/models/file_upload_response.rbi delete mode 100644 rbi/imagekit/models/file_upload_v1_params.rbi delete mode 100644 rbi/imagekit/models/file_upload_v1_response.rbi delete mode 100644 rbi/imagekit/models/file_upload_v2_params.rbi delete mode 100644 rbi/imagekit/models/file_upload_v2_response.rbi create mode 100644 rbi/imagekit/models/files/bulk_add_tags_params.rbi create mode 100644 rbi/imagekit/models/files/bulk_add_tags_response.rbi rename rbi/imagekit/models/files/{batch_delete_params.rbi => bulk_delete_params.rbi} (89%) rename rbi/imagekit/models/files/{batch_delete_response.rbi => bulk_delete_response.rbi} (88%) create mode 100644 rbi/imagekit/models/files/bulk_remove_ai_tags_params.rbi create mode 100644 rbi/imagekit/models/files/bulk_remove_ai_tags_response.rbi create mode 100644 rbi/imagekit/models/files/bulk_remove_tags_params.rbi create mode 100644 rbi/imagekit/models/files/bulk_remove_tags_response.rbi delete mode 100644 rbi/imagekit/models/files/detail_update_params.rbi delete mode 100644 rbi/imagekit/models/files/detail_update_response.rbi delete mode 100644 rbi/imagekit/models/files/metadata_from_url_response.rbi rename rbi/imagekit/models/files/{metadata_from_url_params.rbi => metadata_get_from_url_params.rbi} (88%) create mode 100644 rbi/imagekit/models/files/metadata_get_from_url_response.rbi rename rbi/imagekit/models/files/{purge_status_params.rbi => metadata_get_params.rbi} (85%) create mode 100644 rbi/imagekit/models/files/metadata_get_response.rbi delete mode 100644 rbi/imagekit/models/files/metadata_retrieve_response.rbi rename rbi/imagekit/models/files/{version_retrieve_params.rbi => version_get_params.rbi} (86%) rename rbi/imagekit/models/files/{detail_retrieve_response.rbi => version_get_response.rbi} (92%) rename rbi/imagekit/models/{bulk_job_copy_folder_params.rbi => folder_copy_params.rbi} (93%) rename rbi/imagekit/models/{bulk_job_copy_folder_response.rbi => folder_copy_response.rbi} (84%) rename rbi/imagekit/models/{bulk_job_move_folder_params.rbi => folder_move_params.rbi} (89%) rename rbi/imagekit/models/{bulk_job_move_folder_response.rbi => folder_move_response.rbi} (84%) create mode 100644 rbi/imagekit/models/folder_rename_params.rbi create mode 100644 rbi/imagekit/models/folder_rename_response.rbi create mode 100644 rbi/imagekit/models/folders/job_get_params.rbi create mode 100644 rbi/imagekit/models/folders/job_get_response.rbi delete mode 100644 rbi/imagekit/models/gps.rbi delete mode 100644 rbi/imagekit/models/interoperability.rbi delete mode 100644 rbi/imagekit/models/thumbnail.rbi create mode 100644 rbi/imagekit/resources/accounts/origins.rbi create mode 100644 rbi/imagekit/resources/accounts/url_endpoints.rbi create mode 100644 rbi/imagekit/resources/accounts/usage.rbi create mode 100644 rbi/imagekit/resources/assets.rbi create mode 100644 rbi/imagekit/resources/beta.rbi create mode 100644 rbi/imagekit/resources/beta/v2.rbi create mode 100644 rbi/imagekit/resources/beta/v2/files.rbi delete mode 100644 rbi/imagekit/resources/bulk_jobs.rbi create mode 100644 rbi/imagekit/resources/cache.rbi rename rbi/imagekit/resources/{files/purge.rbi => cache/invalidation.rbi} (81%) delete mode 100644 rbi/imagekit/resources/files/batch.rbi create mode 100644 rbi/imagekit/resources/files/bulk.rbi delete mode 100644 rbi/imagekit/resources/files/details.rbi delete mode 100644 rbi/imagekit/resources/folder.rbi create mode 100644 rbi/imagekit/resources/folders.rbi create mode 100644 rbi/imagekit/resources/folders/job.rbi delete mode 100644 sig/imagekit/models/account_get_usage_params.rbs delete mode 100644 sig/imagekit/models/account_get_usage_response.rbs create mode 100644 sig/imagekit/models/accounts/origin_create_params.rbs create mode 100644 sig/imagekit/models/accounts/origin_create_response.rbs rename sig/imagekit/models/{files/metadata_retrieve_params.rbs => accounts/origin_delete_params.rbs} (75%) create mode 100644 sig/imagekit/models/accounts/origin_get_params.rbs create mode 100644 sig/imagekit/models/accounts/origin_get_response.rbs create mode 100644 sig/imagekit/models/accounts/origin_list_params.rbs create mode 100644 sig/imagekit/models/accounts/origin_list_response.rbs create mode 100644 sig/imagekit/models/accounts/origin_update_params.rbs create mode 100644 sig/imagekit/models/accounts/origin_update_response.rbs create mode 100644 sig/imagekit/models/accounts/url_endpoint_create_params.rbs create mode 100644 sig/imagekit/models/accounts/url_endpoint_create_response.rbs create mode 100644 sig/imagekit/models/accounts/url_endpoint_delete_params.rbs rename sig/imagekit/models/{files/detail_retrieve_params.rbs => accounts/url_endpoint_get_params.rbs} (76%) create mode 100644 sig/imagekit/models/accounts/url_endpoint_get_response.rbs create mode 100644 sig/imagekit/models/accounts/url_endpoint_list_params.rbs create mode 100644 sig/imagekit/models/accounts/url_endpoint_list_response.rbs create mode 100644 sig/imagekit/models/accounts/url_endpoint_update_params.rbs create mode 100644 sig/imagekit/models/accounts/url_endpoint_update_response.rbs create mode 100644 sig/imagekit/models/accounts/usage_get_params.rbs create mode 100644 sig/imagekit/models/accounts/usage_get_response.rbs create mode 100644 sig/imagekit/models/asset_list_params.rbs rename sig/imagekit/models/{files/detail_retrieve_response.rbs => asset_list_response.rbs} (56%) create mode 100644 sig/imagekit/models/beta/v2/file_upload_params.rbs create mode 100644 sig/imagekit/models/beta/v2/file_upload_response.rbs delete mode 100644 sig/imagekit/models/bulk_job_retrieve_status_response.rbs rename sig/imagekit/models/{files/metadata_from_url_params.rbs => cache/invalidation_create_params.rbs} (80%) rename sig/imagekit/models/{files/purge_execute_response.rbs => cache/invalidation_create_response.rbs} (61%) create mode 100644 sig/imagekit/models/cache/invalidation_get_params.rbs create mode 100644 sig/imagekit/models/cache/invalidation_get_response.rbs delete mode 100644 sig/imagekit/models/exif_details.rbs delete mode 100644 sig/imagekit/models/exif_image.rbs delete mode 100644 sig/imagekit/models/file_add_tags_params.rbs delete mode 100644 sig/imagekit/models/file_add_tags_response.rbs rename sig/imagekit/models/{bulk_job_retrieve_status_params.rbs => file_get_params.rbs} (64%) rename sig/imagekit/models/{file_list_response.rbs => file_get_response.rbs} (80%) delete mode 100644 sig/imagekit/models/file_list_params.rbs delete mode 100644 sig/imagekit/models/file_remove_ai_tags_params.rbs delete mode 100644 sig/imagekit/models/file_remove_ai_tags_response.rbs delete mode 100644 sig/imagekit/models/file_remove_tags_params.rbs delete mode 100644 sig/imagekit/models/file_remove_tags_response.rbs create mode 100644 sig/imagekit/models/file_update_params.rbs create mode 100644 sig/imagekit/models/file_update_response.rbs create mode 100644 sig/imagekit/models/file_upload_params.rbs create mode 100644 sig/imagekit/models/file_upload_response.rbs delete mode 100644 sig/imagekit/models/file_upload_v1_params.rbs delete mode 100644 sig/imagekit/models/file_upload_v1_response.rbs delete mode 100644 sig/imagekit/models/file_upload_v2_params.rbs delete mode 100644 sig/imagekit/models/file_upload_v2_response.rbs create mode 100644 sig/imagekit/models/files/bulk_add_tags_params.rbs create mode 100644 sig/imagekit/models/files/bulk_add_tags_response.rbs rename sig/imagekit/models/files/{batch_delete_params.rbs => bulk_delete_params.rbs} (85%) rename sig/imagekit/models/files/{batch_delete_response.rbs => bulk_delete_response.rbs} (81%) create mode 100644 sig/imagekit/models/files/bulk_remove_ai_tags_params.rbs create mode 100644 sig/imagekit/models/files/bulk_remove_ai_tags_response.rbs create mode 100644 sig/imagekit/models/files/bulk_remove_tags_params.rbs create mode 100644 sig/imagekit/models/files/bulk_remove_tags_response.rbs delete mode 100644 sig/imagekit/models/files/detail_update_params.rbs delete mode 100644 sig/imagekit/models/files/detail_update_response.rbs delete mode 100644 sig/imagekit/models/files/metadata_from_url_response.rbs rename sig/imagekit/models/files/{purge_execute_params.rbs => metadata_get_from_url_params.rbs} (82%) create mode 100644 sig/imagekit/models/files/metadata_get_from_url_response.rbs rename sig/imagekit/models/files/{purge_status_params.rbs => metadata_get_params.rbs} (81%) create mode 100644 sig/imagekit/models/files/metadata_get_response.rbs delete mode 100644 sig/imagekit/models/files/metadata_retrieve_response.rbs delete mode 100644 sig/imagekit/models/files/purge_status_response.rbs rename sig/imagekit/models/files/{version_retrieve_params.rbs => version_get_params.rbs} (83%) rename sig/imagekit/models/files/{version_retrieve_response.rbs => version_get_response.rbs} (83%) rename sig/imagekit/models/{bulk_job_copy_folder_params.rbs => folder_copy_params.rbs} (89%) rename sig/imagekit/models/{bulk_job_copy_folder_response.rbs => folder_copy_response.rbs} (61%) rename sig/imagekit/models/{bulk_job_move_folder_params.rbs => folder_move_params.rbs} (86%) rename sig/imagekit/models/{bulk_job_move_folder_response.rbs => folder_move_response.rbs} (61%) create mode 100644 sig/imagekit/models/folder_rename_params.rbs create mode 100644 sig/imagekit/models/folder_rename_response.rbs create mode 100644 sig/imagekit/models/folders/job_get_params.rbs create mode 100644 sig/imagekit/models/folders/job_get_response.rbs delete mode 100644 sig/imagekit/models/gps.rbs delete mode 100644 sig/imagekit/models/interoperability.rbs delete mode 100644 sig/imagekit/models/thumbnail.rbs create mode 100644 sig/imagekit/resources/accounts/origins.rbs create mode 100644 sig/imagekit/resources/accounts/url_endpoints.rbs create mode 100644 sig/imagekit/resources/accounts/usage.rbs create mode 100644 sig/imagekit/resources/assets.rbs create mode 100644 sig/imagekit/resources/beta.rbs create mode 100644 sig/imagekit/resources/beta/v2.rbs create mode 100644 sig/imagekit/resources/beta/v2/files.rbs delete mode 100644 sig/imagekit/resources/bulk_jobs.rbs create mode 100644 sig/imagekit/resources/cache.rbs rename sig/imagekit/resources/{files/purge.rbs => cache/invalidation.rbs} (57%) create mode 100644 sig/imagekit/resources/files/bulk.rbs delete mode 100644 sig/imagekit/resources/files/details.rbs delete mode 100644 sig/imagekit/resources/folder.rbs create mode 100644 sig/imagekit/resources/folders.rbs rename sig/imagekit/resources/{files/batch.rbs => folders/job.rbs} (53%) create mode 100644 test/imagekit/resources/accounts/origins_test.rb create mode 100644 test/imagekit/resources/accounts/url_endpoints_test.rb create mode 100644 test/imagekit/resources/accounts/usage_test.rb create mode 100644 test/imagekit/resources/assets_test.rb create mode 100644 test/imagekit/resources/beta/v2/files_test.rb create mode 100644 test/imagekit/resources/beta/v2_test.rb create mode 100644 test/imagekit/resources/beta_test.rb delete mode 100644 test/imagekit/resources/bulk_jobs_test.rb create mode 100644 test/imagekit/resources/cache/invalidation_test.rb create mode 100644 test/imagekit/resources/cache_test.rb delete mode 100644 test/imagekit/resources/files/batch_test.rb create mode 100644 test/imagekit/resources/files/bulk_test.rb delete mode 100644 test/imagekit/resources/files/details_test.rb delete mode 100644 test/imagekit/resources/files/purge_test.rb delete mode 100644 test/imagekit/resources/folder_test.rb create mode 100644 test/imagekit/resources/folders/job_test.rb create mode 100644 test/imagekit/resources/folders_test.rb diff --git a/.stats.yml b/.stats.yml index eed320bb..ee7ab859 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 31 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0ffd73f83f6d2c3ad75d943fab8f4511847a7b1f8db10fb26a08f075ec814cc9.yml -openapi_spec_hash: afa5d5b601dc01949e9b9acff127ae0d -config_hash: a1e8435842b619cd75c7718d86640d26 +configured_endpoints: 42 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-c01164d5dc8f8c9ab2b7c1a1c793ac522d565f96e569b0e56a4e9353e39bab85.yml +openapi_spec_hash: ac7b3a2b968fe86bf7bb81192209123f +config_hash: 8a4138f8d02720b4736ab63effb7fa2d diff --git a/README.md b/README.md index 8c16eb1b..35b67f2e 100644 --- a/README.md +++ b/README.md @@ -29,24 +29,40 @@ image_kit = Imagekit::Client.new( password: ENV["ORG_MY_PASSWORD_TOKEN"] # This is the default and can be omitted ) -response = image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" -) +response = image_kit.files.upload(file_name: "fileName") + +puts(response.videoCodec) +``` + +### File uploads + +Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more. + +```ruby +require "pathname" + +# Use `Pathname` to send the filename and/or avoid paging a large file into memory: +response = image_kit.files.upload(file: Pathname("/path/to/file")) + +# Alternatively, pass file contents or a `StringIO` directly: +response = image_kit.files.upload(file: File.read("/path/to/file")) + +# Or, to control the filename and/or content type: +file = Imagekit::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…") +response = image_kit.files.upload(file: file) puts(response.videoCodec) ``` +Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound). + ### Handling errors 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::Errors::APIError` will be thrown: ```ruby begin - file = image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + file = image_kit.files.upload(file_name: "fileName") rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -89,11 +105,7 @@ image_kit = Imagekit::Client.new( ) # Or, configure per-request: -image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName", - request_options: {max_retries: 5} -) +image_kit.files.upload(file_name: "fileName", request_options: {max_retries: 5}) ``` ### Timeouts @@ -107,11 +119,7 @@ image_kit = Imagekit::Client.new( ) # Or, configure per-request: -image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName", - request_options: {timeout: 5} -) +image_kit.files.upload(file_name: "fileName", request_options: {timeout: 5}) ``` On timeout, `Imagekit::Errors::APITimeoutError` is raised. @@ -142,8 +150,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( file_name: "fileName", request_options: { extra_query: {my_query_parameter: value}, @@ -190,27 +197,18 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" -) +image_kit.files.upload(file_name: "fileName") ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" -) +image_kit.files.upload(file_name: "fileName") # You can also splat a full Params class: -params = Imagekit::FileUploadV1Params.new( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" -) -image_kit.files.upload_v1(**params) +params = Imagekit::FileUploadParams.new(file_name: "fileName") +image_kit.files.upload(**params) ``` ### Enums @@ -218,25 +216,25 @@ image_kit.files.upload_v1(**params) Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime: ```ruby -# :file -puts(Imagekit::FileListParams::Type::FILE) +# :all +puts(Imagekit::AssetListParams::FileType::ALL) -# Revealed type: `T.all(Imagekit::FileListParams::Type, Symbol)` -T.reveal_type(Imagekit::FileListParams::Type::FILE) +# Revealed type: `T.all(Imagekit::AssetListParams::FileType, Symbol)` +T.reveal_type(Imagekit::AssetListParams::FileType::ALL) ``` Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value: ```ruby # Using the enum constants preserves the tagged type information: -image_kit.files.list( - type: Imagekit::FileListParams::Type::FILE, +image_kit.assets.list( + file_type: Imagekit::AssetListParams::FileType::ALL, # … ) # Literal values are also permissible: -image_kit.files.list( - type: :file, +image_kit.assets.list( + file_type: :all, # … ) ``` diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 1aa8d0aa..b4124510 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -50,14 +50,34 @@ require_relative "imagekit/internal/transport/base_client" require_relative "imagekit/internal/transport/pooled_net_requester" require_relative "imagekit/client" -require_relative "imagekit/models/account_get_usage_params" -require_relative "imagekit/models/account_get_usage_response" -require_relative "imagekit/models/bulk_job_copy_folder_params" -require_relative "imagekit/models/bulk_job_copy_folder_response" -require_relative "imagekit/models/bulk_job_move_folder_params" -require_relative "imagekit/models/bulk_job_move_folder_response" -require_relative "imagekit/models/bulk_job_retrieve_status_params" -require_relative "imagekit/models/bulk_job_retrieve_status_response" +require_relative "imagekit/models/accounts/origin_create_params" +require_relative "imagekit/models/accounts/origin_create_response" +require_relative "imagekit/models/accounts/origin_delete_params" +require_relative "imagekit/models/accounts/origin_get_params" +require_relative "imagekit/models/accounts/origin_get_response" +require_relative "imagekit/models/accounts/origin_list_params" +require_relative "imagekit/models/accounts/origin_list_response" +require_relative "imagekit/models/accounts/origin_update_params" +require_relative "imagekit/models/accounts/origin_update_response" +require_relative "imagekit/models/accounts/url_endpoint_create_params" +require_relative "imagekit/models/accounts/url_endpoint_create_response" +require_relative "imagekit/models/accounts/url_endpoint_delete_params" +require_relative "imagekit/models/accounts/url_endpoint_get_params" +require_relative "imagekit/models/accounts/url_endpoint_get_response" +require_relative "imagekit/models/accounts/url_endpoint_list_params" +require_relative "imagekit/models/accounts/url_endpoint_list_response" +require_relative "imagekit/models/accounts/url_endpoint_update_params" +require_relative "imagekit/models/accounts/url_endpoint_update_response" +require_relative "imagekit/models/accounts/usage_get_params" +require_relative "imagekit/models/accounts/usage_get_response" +require_relative "imagekit/models/asset_list_params" +require_relative "imagekit/models/asset_list_response" +require_relative "imagekit/models/beta/v2/file_upload_params" +require_relative "imagekit/models/beta/v2/file_upload_response" +require_relative "imagekit/models/cache/invalidation_create_params" +require_relative "imagekit/models/cache/invalidation_create_response" +require_relative "imagekit/models/cache/invalidation_get_params" +require_relative "imagekit/models/cache/invalidation_get_response" require_relative "imagekit/models/custom_metadata_field_create_params" require_relative "imagekit/models/custom_metadata_field_create_response" require_relative "imagekit/models/custom_metadata_field_delete_params" @@ -66,64 +86,66 @@ require_relative "imagekit/models/custom_metadata_field_list_response" require_relative "imagekit/models/custom_metadata_field_update_params" require_relative "imagekit/models/custom_metadata_field_update_response" -require_relative "imagekit/models/exif_details" -require_relative "imagekit/models/exif_image" -require_relative "imagekit/models/file_add_tags_params" -require_relative "imagekit/models/file_add_tags_response" require_relative "imagekit/models/file_copy_params" require_relative "imagekit/models/file_copy_response" require_relative "imagekit/models/file_delete_params" -require_relative "imagekit/models/file_list_params" -require_relative "imagekit/models/file_list_response" +require_relative "imagekit/models/file_get_params" +require_relative "imagekit/models/file_get_response" require_relative "imagekit/models/file_move_params" require_relative "imagekit/models/file_move_response" -require_relative "imagekit/models/file_remove_ai_tags_params" -require_relative "imagekit/models/file_remove_ai_tags_response" -require_relative "imagekit/models/file_remove_tags_params" -require_relative "imagekit/models/file_remove_tags_response" require_relative "imagekit/models/file_rename_params" require_relative "imagekit/models/file_rename_response" -require_relative "imagekit/models/files/batch_delete_params" -require_relative "imagekit/models/files/batch_delete_response" -require_relative "imagekit/models/files/detail_retrieve_params" -require_relative "imagekit/models/files/detail_retrieve_response" -require_relative "imagekit/models/files/detail_update_params" -require_relative "imagekit/models/files/detail_update_response" -require_relative "imagekit/models/files/metadata_from_url_params" -require_relative "imagekit/models/files/metadata_from_url_response" -require_relative "imagekit/models/files/metadata_retrieve_params" -require_relative "imagekit/models/files/metadata_retrieve_response" -require_relative "imagekit/models/files/purge_execute_params" -require_relative "imagekit/models/files/purge_execute_response" -require_relative "imagekit/models/files/purge_status_params" -require_relative "imagekit/models/files/purge_status_response" +require_relative "imagekit/models/files/bulk_add_tags_params" +require_relative "imagekit/models/files/bulk_add_tags_response" +require_relative "imagekit/models/files/bulk_delete_params" +require_relative "imagekit/models/files/bulk_delete_response" +require_relative "imagekit/models/files/bulk_remove_ai_tags_params" +require_relative "imagekit/models/files/bulk_remove_ai_tags_response" +require_relative "imagekit/models/files/bulk_remove_tags_params" +require_relative "imagekit/models/files/bulk_remove_tags_response" +require_relative "imagekit/models/files/metadata_get_from_url_params" +require_relative "imagekit/models/files/metadata_get_from_url_response" +require_relative "imagekit/models/files/metadata_get_params" +require_relative "imagekit/models/files/metadata_get_response" require_relative "imagekit/models/files/version_delete_params" require_relative "imagekit/models/files/version_delete_response" +require_relative "imagekit/models/files/version_get_params" +require_relative "imagekit/models/files/version_get_response" require_relative "imagekit/models/files/version_list_params" require_relative "imagekit/models/files/version_list_response" require_relative "imagekit/models/files/version_restore_params" require_relative "imagekit/models/files/version_restore_response" -require_relative "imagekit/models/files/version_retrieve_params" -require_relative "imagekit/models/files/version_retrieve_response" -require_relative "imagekit/models/file_upload_v1_params" -require_relative "imagekit/models/file_upload_v1_response" -require_relative "imagekit/models/file_upload_v2_params" -require_relative "imagekit/models/file_upload_v2_response" +require_relative "imagekit/models/file_update_params" +require_relative "imagekit/models/file_update_response" +require_relative "imagekit/models/file_upload_params" +require_relative "imagekit/models/file_upload_response" +require_relative "imagekit/models/folder_copy_params" +require_relative "imagekit/models/folder_copy_response" require_relative "imagekit/models/folder_create_params" require_relative "imagekit/models/folder_create_response" require_relative "imagekit/models/folder_delete_params" require_relative "imagekit/models/folder_delete_response" -require_relative "imagekit/models/gps" -require_relative "imagekit/models/interoperability" -require_relative "imagekit/models/thumbnail" +require_relative "imagekit/models/folder_move_params" +require_relative "imagekit/models/folder_move_response" +require_relative "imagekit/models/folder_rename_params" +require_relative "imagekit/models/folder_rename_response" +require_relative "imagekit/models/folders/job_get_params" +require_relative "imagekit/models/folders/job_get_response" require_relative "imagekit/models" require_relative "imagekit/resources/accounts" -require_relative "imagekit/resources/bulk_jobs" +require_relative "imagekit/resources/accounts/origins" +require_relative "imagekit/resources/accounts/url_endpoints" +require_relative "imagekit/resources/accounts/usage" +require_relative "imagekit/resources/assets" +require_relative "imagekit/resources/beta" +require_relative "imagekit/resources/beta/v2" +require_relative "imagekit/resources/beta/v2/files" +require_relative "imagekit/resources/cache" +require_relative "imagekit/resources/cache/invalidation" require_relative "imagekit/resources/custom_metadata_fields" require_relative "imagekit/resources/files" -require_relative "imagekit/resources/files/batch" -require_relative "imagekit/resources/files/details" +require_relative "imagekit/resources/files/bulk" require_relative "imagekit/resources/files/metadata" -require_relative "imagekit/resources/files/purge" require_relative "imagekit/resources/files/versions" -require_relative "imagekit/resources/folder" +require_relative "imagekit/resources/folders" +require_relative "imagekit/resources/folders/job" diff --git a/lib/imagekit/client.rb b/lib/imagekit/client.rb index 0726b8a2..d14fcfbe 100644 --- a/lib/imagekit/client.rb +++ b/lib/imagekit/client.rb @@ -29,15 +29,21 @@ class Client < Imagekit::Internal::Transport::BaseClient # @return [Imagekit::Resources::Files] attr_reader :files - # @return [Imagekit::Resources::Folder] - attr_reader :folder + # @return [Imagekit::Resources::Assets] + attr_reader :assets - # @return [Imagekit::Resources::BulkJobs] - attr_reader :bulk_jobs + # @return [Imagekit::Resources::Cache] + attr_reader :cache + + # @return [Imagekit::Resources::Folders] + attr_reader :folders # @return [Imagekit::Resources::Accounts] attr_reader :accounts + # @return [Imagekit::Resources::Beta] + attr_reader :beta + # @api private # # @return [Hash{String=>String}] @@ -100,9 +106,11 @@ def initialize( @custom_metadata_fields = Imagekit::Resources::CustomMetadataFields.new(client: self) @files = Imagekit::Resources::Files.new(client: self) - @folder = Imagekit::Resources::Folder.new(client: self) - @bulk_jobs = Imagekit::Resources::BulkJobs.new(client: self) + @assets = Imagekit::Resources::Assets.new(client: self) + @cache = Imagekit::Resources::Cache.new(client: self) + @folders = Imagekit::Resources::Folders.new(client: self) @accounts = Imagekit::Resources::Accounts.new(client: self) + @beta = Imagekit::Resources::Beta.new(client: self) end end end diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb index 57d10523..dba16007 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekit/internal/type/union.rb @@ -4,6 +4,19 @@ module Imagekit module Internal module Type # @api private + # + # @example + # # `origin_create_response` is a `Imagekit::Models::Accounts::OriginCreateResponse` + # case origin_create_response + # when Imagekit::Models::Accounts::OriginCreateResponse::S3 + # puts(origin_create_response.id) + # when Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible + # puts(origin_create_response.bucket) + # when Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup + # puts(origin_create_response.include_canonical_header) + # else + # puts(origin_create_response) + # end module Union include Imagekit::Internal::Type::Converter include Imagekit::Internal::Util::SorbetRuntimeSupport diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index c069dc8d..3cca3149 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -39,13 +39,13 @@ module Imagekit mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } } end - AccountGetUsageParams = Imagekit::Models::AccountGetUsageParams + Accounts = Imagekit::Models::Accounts - BulkJobCopyFolderParams = Imagekit::Models::BulkJobCopyFolderParams + AssetListParams = Imagekit::Models::AssetListParams - BulkJobMoveFolderParams = Imagekit::Models::BulkJobMoveFolderParams + Beta = Imagekit::Models::Beta - BulkJobRetrieveStatusParams = Imagekit::Models::BulkJobRetrieveStatusParams + Cache = Imagekit::Models::Cache CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams @@ -55,39 +55,31 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams - ExifDetails = Imagekit::Models::ExifDetails - - ExifImage = Imagekit::Models::ExifImage - - FileAddTagsParams = Imagekit::Models::FileAddTagsParams - FileCopyParams = Imagekit::Models::FileCopyParams FileDeleteParams = Imagekit::Models::FileDeleteParams - FileListParams = Imagekit::Models::FileListParams + FileGetParams = Imagekit::Models::FileGetParams FileMoveParams = Imagekit::Models::FileMoveParams - FileRemoveAITagsParams = Imagekit::Models::FileRemoveAITagsParams - - FileRemoveTagsParams = Imagekit::Models::FileRemoveTagsParams - FileRenameParams = Imagekit::Models::FileRenameParams Files = Imagekit::Models::Files - FileUploadV1Params = Imagekit::Models::FileUploadV1Params + FileUpdateParams = Imagekit::Models::FileUpdateParams + + FileUploadParams = Imagekit::Models::FileUploadParams - FileUploadV2Params = Imagekit::Models::FileUploadV2Params + FolderCopyParams = Imagekit::Models::FolderCopyParams FolderCreateParams = Imagekit::Models::FolderCreateParams FolderDeleteParams = Imagekit::Models::FolderDeleteParams - Gps = Imagekit::Models::Gps + FolderMoveParams = Imagekit::Models::FolderMoveParams - Interoperability = Imagekit::Models::Interoperability + FolderRenameParams = Imagekit::Models::FolderRenameParams - Thumbnail = Imagekit::Models::Thumbnail + Folders = Imagekit::Models::Folders end diff --git a/lib/imagekit/models/account_get_usage_params.rb b/lib/imagekit/models/account_get_usage_params.rb deleted file mode 100644 index 4e8a36b2..00000000 --- a/lib/imagekit/models/account_get_usage_params.rb +++ /dev/null @@ -1,35 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Accounts#get_usage - class AccountGetUsageParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute end_date - # 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. - # - # @return [Date] - required :end_date, Date - - # @!attribute start_date - # 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 [Date] - required :start_date, Date - - # @!method initialize(end_date:, start_date:, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::AccountGetUsageParams} for more details. - # - # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. - # - # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/account_get_usage_response.rb b/lib/imagekit/models/account_get_usage_response.rb deleted file mode 100644 index fa485ceb..00000000 --- a/lib/imagekit/models/account_get_usage_response.rb +++ /dev/null @@ -1,49 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Accounts#get_usage - class AccountGetUsageResponse < Imagekit::Internal::Type::BaseModel - # @!attribute bandwidth_bytes - # Amount of bandwidth used in bytes. - # - # @return [Integer, nil] - optional :bandwidth_bytes, Integer, api_name: :bandwidthBytes - - # @!attribute extension_units_count - # Number of extension units used. - # - # @return [Integer, nil] - optional :extension_units_count, Integer, api_name: :extensionUnitsCount - - # @!attribute media_library_storage_bytes - # Storage used by media library in bytes. - # - # @return [Integer, nil] - optional :media_library_storage_bytes, Integer, api_name: :mediaLibraryStorageBytes - - # @!attribute original_cache_storage_bytes - # Storage used by the original cache in bytes. - # - # @return [Integer, nil] - optional :original_cache_storage_bytes, Integer, api_name: :originalCacheStorageBytes - - # @!attribute video_processing_units_count - # Number of video processing units used. - # - # @return [Integer, nil] - optional :video_processing_units_count, Integer, api_name: :videoProcessingUnitsCount - - # @!method initialize(bandwidth_bytes: nil, extension_units_count: nil, media_library_storage_bytes: nil, original_cache_storage_bytes: nil, video_processing_units_count: nil) - # @param bandwidth_bytes [Integer] Amount of bandwidth used in bytes. - # - # @param extension_units_count [Integer] Number of extension units used. - # - # @param media_library_storage_bytes [Integer] Storage used by media library in bytes. - # - # @param original_cache_storage_bytes [Integer] Storage used by the original cache in bytes. - # - # @param video_processing_units_count [Integer] Number of video processing units used. - end - end -end diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb new file mode 100644 index 00000000..493d614a --- /dev/null +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -0,0 +1,189 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::Origins#create + class OriginCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] + required :type, enum: -> { Imagekit::Accounts::OriginCreateParams::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param base_url [String] Akeneo instance base URL. + # + # @param client_email [String] + # + # @param private_key [String] + # + # @param account_name [String] + # + # @param container [String] + # + # @param sas_token [String] + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM = :AKENEO_PIM + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/imagekit/models/accounts/origin_create_response.rb b/lib/imagekit/models/accounts/origin_create_response.rb new file mode 100644 index 00000000..9e6fc80d --- /dev/null +++ b/lib/imagekit/models/accounts/origin_create_response.rb @@ -0,0 +1,649 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # Origin object as returned by the API (sensitive fields removed). + # + # @see Imagekit::Resources::Accounts::Origins#create + module OriginCreateResponse + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::S3 } + + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible } + + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup } + + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder } + + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy } + + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs } + + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage } + + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::S3::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::S3} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginCreateResponse::S3#type + module Type + extend Imagekit::Internal::Type::Enum + + S3 = :S3 + + # @!method self.values + # @return [Array] + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible#type + module Type + extend Imagekit::Internal::Type::Enum + + S3_COMPATIBLE = :S3_COMPATIBLE + + # @!method self.values + # @return [Array] + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP + + # @!method self.values + # @return [Array] + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [Object] + required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::WebFolder} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param base_url [Object] Root URL for the web folder origin. + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginCreateResponse::WebFolder#type + module Type + extend Imagekit::Internal::Type::Enum + + WEB_FOLDER = :WEB_FOLDER + + # @!method self.values + # @return [Array] + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::WebProxy} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginCreateResponse::WebProxy#type + module Type + extend Imagekit::Internal::Type::Enum + + WEB_PROXY = :WEB_PROXY + + # @!method self.values + # @return [Array] + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs} for + # more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] + # + # @param client_email [String] + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs#type + module Type + extend Imagekit::Internal::Type::Enum + + GCS = :GCS + + # @!method self.values + # @return [Array] + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param account_name [String] + # + # @param container [String] + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage#type + module Type + extend Imagekit::Internal::Type::Enum + + AZURE_BLOB = :AZURE_BLOB + + # @!method self.values + # @return [Array] + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [Object] + required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, base_url:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param base_url [Object] Akeneo instance base URL. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim#type + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM = :AKENEO_PIM + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim)] + end + end + end +end diff --git a/lib/imagekit/models/files/metadata_retrieve_params.rb b/lib/imagekit/models/accounts/origin_delete_params.rb similarity index 70% rename from lib/imagekit/models/files/metadata_retrieve_params.rb rename to lib/imagekit/models/accounts/origin_delete_params.rb index 39ad6940..013eedd5 100644 --- a/lib/imagekit/models/files/metadata_retrieve_params.rb +++ b/lib/imagekit/models/accounts/origin_delete_params.rb @@ -2,9 +2,9 @@ module Imagekit module Models - module Files - # @see Imagekit::Resources::Files::Metadata#retrieve - class MetadataRetrieveParams < Imagekit::Internal::Type::BaseModel + module Accounts + # @see Imagekit::Resources::Accounts::Origins#delete + class OriginDeleteParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/accounts/origin_get_params.rb b/lib/imagekit/models/accounts/origin_get_params.rb new file mode 100644 index 00000000..97a63638 --- /dev/null +++ b/lib/imagekit/models/accounts/origin_get_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::Origins#get + class OriginGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/accounts/origin_get_response.rb b/lib/imagekit/models/accounts/origin_get_response.rb new file mode 100644 index 00000000..10323deb --- /dev/null +++ b/lib/imagekit/models/accounts/origin_get_response.rb @@ -0,0 +1,648 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # Origin object as returned by the API (sensitive fields removed). + # + # @see Imagekit::Resources::Accounts::Origins#get + module OriginGetResponse + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Accounts::OriginGetResponse::S3 } + + variant -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible } + + variant -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup } + + variant -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder } + + variant -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy } + + variant -> { Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs } + + variant -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage } + + variant -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::S3::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::S3} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginGetResponse::S3#type + module Type + extend Imagekit::Internal::Type::Enum + + S3 = :S3 + + # @!method self.values + # @return [Array] + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::S3Compatible} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginGetResponse::S3Compatible#type + module Type + extend Imagekit::Internal::Type::Enum + + S3_COMPATIBLE = :S3_COMPATIBLE + + # @!method self.values + # @return [Array] + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP + + # @!method self.values + # @return [Array] + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [Object] + required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::WebFolder} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param base_url [Object] Root URL for the web folder origin. + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginGetResponse::WebFolder#type + module Type + extend Imagekit::Internal::Type::Enum + + WEB_FOLDER = :WEB_FOLDER + + # @!method self.values + # @return [Array] + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::WebProxy} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginGetResponse::WebProxy#type + module Type + extend Imagekit::Internal::Type::Enum + + WEB_PROXY = :WEB_PROXY + + # @!method self.values + # @return [Array] + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] + # + # @param client_email [String] + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs#type + module Type + extend Imagekit::Internal::Type::Enum + + GCS = :GCS + + # @!method self.values + # @return [Array] + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param account_name [String] + # + # @param container [String] + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage#type + module Type + extend Imagekit::Internal::Type::Enum + + AZURE_BLOB = :AZURE_BLOB + + # @!method self.values + # @return [Array] + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [Object] + required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, base_url:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param base_url [Object] Akeneo instance base URL. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim#type + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM = :AKENEO_PIM + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim)] + end + end + end +end diff --git a/lib/imagekit/models/accounts/origin_list_params.rb b/lib/imagekit/models/accounts/origin_list_params.rb new file mode 100644 index 00000000..8435e2f8 --- /dev/null +++ b/lib/imagekit/models/accounts/origin_list_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::Origins#list + class OriginListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb new file mode 100644 index 00000000..3c9271bf --- /dev/null +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -0,0 +1,654 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # Origin object as returned by the API (sensitive fields removed). + module OriginListResponseItem + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::S3 } + + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible } + + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup } + + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder } + + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy } + + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs } + + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage } + + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::S3::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::S3} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginListResponseItem::S3#type + module Type + extend Imagekit::Internal::Type::Enum + + S3 = :S3 + + # @!method self.values + # @return [Array] + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible#type + module Type + extend Imagekit::Internal::Type::Enum + + S3_COMPATIBLE = :S3_COMPATIBLE + + # @!method self.values + # @return [Array] + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP + + # @!method self.values + # @return [Array] + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [Object] + required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::WebFolder} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param base_url [Object] Root URL for the web folder origin. + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginListResponseItem::WebFolder#type + module Type + extend Imagekit::Internal::Type::Enum + + WEB_FOLDER = :WEB_FOLDER + + # @!method self.values + # @return [Array] + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::WebProxy} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginListResponseItem::WebProxy#type + module Type + extend Imagekit::Internal::Type::Enum + + WEB_PROXY = :WEB_PROXY + + # @!method self.values + # @return [Array] + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs} for + # more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] + # + # @param client_email [String] + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs#type + module Type + extend Imagekit::Internal::Type::Enum + + GCS = :GCS + + # @!method self.values + # @return [Array] + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param account_name [String] + # + # @param container [String] + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage#type + module Type + extend Imagekit::Internal::Type::Enum + + AZURE_BLOB = :AZURE_BLOB + + # @!method self.values + # @return [Array] + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [Object] + required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, base_url:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param base_url [Object] Akeneo instance base URL. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim#type + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM = :AKENEO_PIM + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginListResponseItem::S3, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim)] + end + + # @type [Imagekit::Internal::Type::Converter] + OriginListResponse = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::Accounts::OriginListResponseItem }] + end + end +end diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb new file mode 100644 index 00000000..f4d05699 --- /dev/null +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -0,0 +1,189 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::Origins#update + class OriginUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] + required :type, enum: -> { Imagekit::Accounts::OriginUpdateParams::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param base_url [String] Akeneo instance base URL. + # + # @param client_email [String] + # + # @param private_key [String] + # + # @param account_name [String] + # + # @param container [String] + # + # @param sas_token [String] + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM = :AKENEO_PIM + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/imagekit/models/accounts/origin_update_response.rb b/lib/imagekit/models/accounts/origin_update_response.rb new file mode 100644 index 00000000..88d8b216 --- /dev/null +++ b/lib/imagekit/models/accounts/origin_update_response.rb @@ -0,0 +1,649 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # Origin object as returned by the API (sensitive fields removed). + # + # @see Imagekit::Resources::Accounts::Origins#update + module OriginUpdateResponse + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3 } + + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible } + + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup } + + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder } + + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy } + + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs } + + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage } + + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::S3} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginUpdateResponse::S3#type + module Type + extend Imagekit::Internal::Type::Enum + + S3 = :S3 + + # @!method self.values + # @return [Array] + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible#type + module Type + extend Imagekit::Internal::Type::Enum + + S3_COMPATIBLE = :S3_COMPATIBLE + + # @!method self.values + # @return [Array] + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] S3 bucket name. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] Path prefix inside the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP + + # @!method self.values + # @return [Array] + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [Object] + required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param base_url [Object] Root URL for the web folder origin. + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder#type + module Type + extend Imagekit::Internal::Type::Enum + + WEB_FOLDER = :WEB_FOLDER + + # @!method self.values + # @return [Array] + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy#type + module Type + extend Imagekit::Internal::Type::Enum + + WEB_PROXY = :WEB_PROXY + + # @!method self.values + # @return [Array] + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs} for + # more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param bucket [String] + # + # @param client_email [String] + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs#type + module Type + extend Imagekit::Internal::Type::Enum + + GCS = :GCS + + # @!method self.values + # @return [Array] + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute prefix + # + # @return [Object] + required :prefix, Imagekit::Internal::Type::Unknown + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param account_name [String] + # + # @param container [String] + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param prefix [Object] + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage#type + module Type + extend Imagekit::Internal::Type::Enum + + AZURE_BLOB = :AZURE_BLOB + + # @!method self.values + # @return [Array] + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [Object] + required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type] + required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type } + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, base_url:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param base_url [Object] Akeneo instance base URL. + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param name [String] Display name of the origin. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + + # @see Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim#type + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM = :AKENEO_PIM + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim)] + end + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_create_params.rb b/lib/imagekit/models/accounts/url_endpoint_create_params.rb new file mode 100644 index 00000000..dcdf5068 --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint_create_params.rb @@ -0,0 +1,149 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::URLEndpoints#create + class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute description + # Description of the URL endpoint. + # + # @return [String] + required :description, String + + # @!attribute 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. + # + # @return [Array, nil] + optional :origins, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute url_prefix + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + # + # @return [String, nil] + optional :url_prefix, String, api_name: :urlPrefix + + # @!attribute url_rewriter + # Configuration for third-party URL rewriting. + # + # @return [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter, nil] + optional :url_rewriter, + union: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter }, + api_name: :urlRewriter + + # @!method initialize(description:, origins: nil, url_prefix: nil, url_rewriter: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointCreateParams} for more details. + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter } + + variant -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter } + + variant -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type] + required :type, + enum: -> { + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type + } + + # @!attribute preserve_asset_delivery_types + # Whether to preserve `/` in the rewritten URL. + # + # @return [Boolean, nil] + optional :preserve_asset_delivery_types, + Imagekit::Internal::Type::Boolean, + api_name: :preserveAssetDeliveryTypes + + # @!method initialize(type:, preserve_asset_delivery_types: nil) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type] + # + # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. + + # @see Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY = :CLOUDINARY + + # @!method self.values + # @return [Array] + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type] + required :type, + enum: -> { + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type + } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX = :IMGIX + + # @!method self.values + # @return [Array] + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type] + required :type, + enum: -> { + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type + } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI = :AKAMAI + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter)] + end + end + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_create_response.rb b/lib/imagekit/models/accounts/url_endpoint_create_response.rb new file mode 100644 index 00000000..2420347f --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint_create_response.rb @@ -0,0 +1,154 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::URLEndpoints#create + class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel + # @!attribute description + # Description of the URL endpoint. + # + # @return [String] + required :description, String + + # @!attribute 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. + # + # @return [Array] + required :origins, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute url_prefix + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + # + # @return [String] + required :url_prefix, String, api_name: :urlPrefix + + # @!attribute url_rewriter + # Configuration for third-party URL rewriting. + # + # @return [Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter, nil] + optional :url_rewriter, + union: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter }, + api_name: :urlRewriter + + response_only do + # @!attribute id + # 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`. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointCreateResponse} for more details. + # + # URL‑endpoint object as returned by the API. + # + # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + + # Configuration for third-party URL rewriting. + # + # @see Imagekit::Models::Accounts::URLEndpointCreateResponse#url_rewriter + module URLRewriter + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter } + + variant -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter } + + variant -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute preserve_asset_delivery_types + # Whether to preserve `/` in the rewritten URL. + # + # @return [Boolean] + required :preserve_asset_delivery_types, + Imagekit::Internal::Type::Boolean, + api_name: :preserveAssetDeliveryTypes + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type } + + # @!method initialize(preserve_asset_delivery_types:, type:) + # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. + # + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY = :CLOUDINARY + + # @!method self.values + # @return [Array] + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX = :IMGIX + + # @!method self.values + # @return [Array] + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI = :AKAMAI + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter)] + end + end + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_delete_params.rb b/lib/imagekit/models/accounts/url_endpoint_delete_params.rb new file mode 100644 index 00000000..484bea81 --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint_delete_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::URLEndpoints#delete + class URLEndpointDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/detail_retrieve_params.rb b/lib/imagekit/models/accounts/url_endpoint_get_params.rb similarity index 71% rename from lib/imagekit/models/files/detail_retrieve_params.rb rename to lib/imagekit/models/accounts/url_endpoint_get_params.rb index d0273a14..d5d4461b 100644 --- a/lib/imagekit/models/files/detail_retrieve_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_get_params.rb @@ -2,9 +2,9 @@ module Imagekit module Models - module Files - # @see Imagekit::Resources::Files::Details#retrieve - class DetailRetrieveParams < Imagekit::Internal::Type::BaseModel + module Accounts + # @see Imagekit::Resources::Accounts::URLEndpoints#get + class URLEndpointGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/accounts/url_endpoint_get_response.rb b/lib/imagekit/models/accounts/url_endpoint_get_response.rb new file mode 100644 index 00000000..a9846424 --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint_get_response.rb @@ -0,0 +1,154 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::URLEndpoints#get + class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel + # @!attribute description + # Description of the URL endpoint. + # + # @return [String] + required :description, String + + # @!attribute 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. + # + # @return [Array] + required :origins, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute url_prefix + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + # + # @return [String] + required :url_prefix, String, api_name: :urlPrefix + + # @!attribute url_rewriter + # Configuration for third-party URL rewriting. + # + # @return [Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter, nil] + optional :url_rewriter, + union: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter }, + api_name: :urlRewriter + + response_only do + # @!attribute id + # 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`. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointGetResponse} for more details. + # + # URL‑endpoint object as returned by the API. + # + # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + + # Configuration for third-party URL rewriting. + # + # @see Imagekit::Models::Accounts::URLEndpointGetResponse#url_rewriter + module URLRewriter + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter } + + variant -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter } + + variant -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute preserve_asset_delivery_types + # Whether to preserve `/` in the rewritten URL. + # + # @return [Boolean] + required :preserve_asset_delivery_types, + Imagekit::Internal::Type::Boolean, + api_name: :preserveAssetDeliveryTypes + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type } + + # @!method initialize(preserve_asset_delivery_types:, type:) + # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. + # + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY = :CLOUDINARY + + # @!method self.values + # @return [Array] + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX = :IMGIX + + # @!method self.values + # @return [Array] + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI = :AKAMAI + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter)] + end + end + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_list_params.rb b/lib/imagekit/models/accounts/url_endpoint_list_params.rb new file mode 100644 index 00000000..ec77107c --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint_list_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::URLEndpoints#list + class URLEndpointListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_list_response.rb b/lib/imagekit/models/accounts/url_endpoint_list_response.rb new file mode 100644 index 00000000..5d026596 --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint_list_response.rb @@ -0,0 +1,157 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel + # @!attribute description + # Description of the URL endpoint. + # + # @return [String] + required :description, String + + # @!attribute 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. + # + # @return [Array] + required :origins, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute url_prefix + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + # + # @return [String] + required :url_prefix, String, api_name: :urlPrefix + + # @!attribute url_rewriter + # Configuration for third-party URL rewriting. + # + # @return [Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter, nil] + optional :url_rewriter, + union: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter }, + api_name: :urlRewriter + + response_only do + # @!attribute id + # 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`. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointListResponseItem} for more details. + # + # URL‑endpoint object as returned by the API. + # + # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + + # Configuration for third-party URL rewriting. + # + # @see Imagekit::Models::Accounts::URLEndpointListResponseItem#url_rewriter + module URLRewriter + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter } + + variant -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter } + + variant -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute preserve_asset_delivery_types + # Whether to preserve `/` in the rewritten URL. + # + # @return [Boolean] + required :preserve_asset_delivery_types, + Imagekit::Internal::Type::Boolean, + api_name: :preserveAssetDeliveryTypes + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type } + + # @!method initialize(preserve_asset_delivery_types:, type:) + # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. + # + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY = :CLOUDINARY + + # @!method self.values + # @return [Array] + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX = :IMGIX + + # @!method self.values + # @return [Array] + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI = :AKAMAI + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter)] + end + end + + # @type [Imagekit::Internal::Type::Converter] + URLEndpointListResponse = + Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Models::Accounts::URLEndpointListResponseItem }] + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_update_params.rb b/lib/imagekit/models/accounts/url_endpoint_update_params.rb new file mode 100644 index 00000000..9cc44637 --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint_update_params.rb @@ -0,0 +1,149 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::URLEndpoints#update + class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute description + # Description of the URL endpoint. + # + # @return [String] + required :description, String + + # @!attribute 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. + # + # @return [Array, nil] + optional :origins, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute url_prefix + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + # + # @return [String, nil] + optional :url_prefix, String, api_name: :urlPrefix + + # @!attribute url_rewriter + # Configuration for third-party URL rewriting. + # + # @return [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter, nil] + optional :url_rewriter, + union: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter }, + api_name: :urlRewriter + + # @!method initialize(description:, origins: nil, url_prefix: nil, url_rewriter: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointUpdateParams} for more details. + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter } + + variant -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter } + + variant -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type] + required :type, + enum: -> { + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type + } + + # @!attribute preserve_asset_delivery_types + # Whether to preserve `/` in the rewritten URL. + # + # @return [Boolean, nil] + optional :preserve_asset_delivery_types, + Imagekit::Internal::Type::Boolean, + api_name: :preserveAssetDeliveryTypes + + # @!method initialize(type:, preserve_asset_delivery_types: nil) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type] + # + # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. + + # @see Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY = :CLOUDINARY + + # @!method self.values + # @return [Array] + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type] + required :type, + enum: -> { + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type + } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX = :IMGIX + + # @!method self.values + # @return [Array] + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type] + required :type, + enum: -> { + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type + } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI = :AKAMAI + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter)] + end + end + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_update_response.rb b/lib/imagekit/models/accounts/url_endpoint_update_response.rb new file mode 100644 index 00000000..0feeb937 --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint_update_response.rb @@ -0,0 +1,154 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::URLEndpoints#update + class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel + # @!attribute description + # Description of the URL endpoint. + # + # @return [String] + required :description, String + + # @!attribute 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. + # + # @return [Array] + required :origins, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute url_prefix + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + # + # @return [String] + required :url_prefix, String, api_name: :urlPrefix + + # @!attribute url_rewriter + # Configuration for third-party URL rewriting. + # + # @return [Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter, nil] + optional :url_rewriter, + union: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter }, + api_name: :urlRewriter + + response_only do + # @!attribute id + # 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`. + # + # @return [String] + required :id, String + end + + # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointUpdateResponse} for more details. + # + # URL‑endpoint object as returned by the API. + # + # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + + # Configuration for third-party URL rewriting. + # + # @see Imagekit::Models::Accounts::URLEndpointUpdateResponse#url_rewriter + module URLRewriter + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter } + + variant -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter } + + variant -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute preserve_asset_delivery_types + # Whether to preserve `/` in the rewritten URL. + # + # @return [Boolean] + required :preserve_asset_delivery_types, + Imagekit::Internal::Type::Boolean, + api_name: :preserveAssetDeliveryTypes + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type } + + # @!method initialize(preserve_asset_delivery_types:, type:) + # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. + # + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY = :CLOUDINARY + + # @!method self.values + # @return [Array] + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX = :IMGIX + + # @!method self.values + # @return [Array] + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type] + required :type, + enum: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type } + + # @!method initialize(type:) + # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type] + + # @see Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter#type + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI = :AKAMAI + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter)] + end + end + end + end +end diff --git a/lib/imagekit/models/accounts/usage_get_params.rb b/lib/imagekit/models/accounts/usage_get_params.rb new file mode 100644 index 00000000..61664b99 --- /dev/null +++ b/lib/imagekit/models/accounts/usage_get_params.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::Usage#get + class UsageGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute end_date + # 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. + # + # @return [Date] + required :end_date, Date + + # @!attribute start_date + # 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 [Date] + required :start_date, Date + + # @!method initialize(end_date:, start_date:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::UsageGetParams} for more details. + # + # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. + # + # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/accounts/usage_get_response.rb b/lib/imagekit/models/accounts/usage_get_response.rb new file mode 100644 index 00000000..7ac95137 --- /dev/null +++ b/lib/imagekit/models/accounts/usage_get_response.rb @@ -0,0 +1,51 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # @see Imagekit::Resources::Accounts::Usage#get + class UsageGetResponse < Imagekit::Internal::Type::BaseModel + # @!attribute bandwidth_bytes + # Amount of bandwidth used in bytes. + # + # @return [Integer, nil] + optional :bandwidth_bytes, Integer, api_name: :bandwidthBytes + + # @!attribute extension_units_count + # Number of extension units used. + # + # @return [Integer, nil] + optional :extension_units_count, Integer, api_name: :extensionUnitsCount + + # @!attribute media_library_storage_bytes + # Storage used by media library in bytes. + # + # @return [Integer, nil] + optional :media_library_storage_bytes, Integer, api_name: :mediaLibraryStorageBytes + + # @!attribute original_cache_storage_bytes + # Storage used by the original cache in bytes. + # + # @return [Integer, nil] + optional :original_cache_storage_bytes, Integer, api_name: :originalCacheStorageBytes + + # @!attribute video_processing_units_count + # Number of video processing units used. + # + # @return [Integer, nil] + optional :video_processing_units_count, Integer, api_name: :videoProcessingUnitsCount + + # @!method initialize(bandwidth_bytes: nil, extension_units_count: nil, media_library_storage_bytes: nil, original_cache_storage_bytes: nil, video_processing_units_count: nil) + # @param bandwidth_bytes [Integer] Amount of bandwidth used in bytes. + # + # @param extension_units_count [Integer] Number of extension units used. + # + # @param media_library_storage_bytes [Integer] Storage used by media library in bytes. + # + # @param original_cache_storage_bytes [Integer] Storage used by the original cache in bytes. + # + # @param video_processing_units_count [Integer] Number of video processing units used. + end + end + end +end diff --git a/lib/imagekit/models/asset_list_params.rb b/lib/imagekit/models/asset_list_params.rb new file mode 100644 index 00000000..11eb0ea3 --- /dev/null +++ b/lib/imagekit/models/asset_list_params.rb @@ -0,0 +1,158 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Assets#list + class AssetListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_type + # 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) + # + # @return [Symbol, Imagekit::Models::AssetListParams::FileType, nil] + optional :file_type, enum: -> { Imagekit::AssetListParams::FileType } + + # @!attribute limit + # The maximum number of results to return in response. + # + # @return [Integer, nil] + optional :limit, Integer + + # @!attribute path + # 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. + # + # @return [String, nil] + optional :path, String + + # @!attribute search_query + # 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. + # + # @return [String, nil] + optional :search_query, String + + # @!attribute skip + # The number of results to skip before returning results. + # + # @return [Integer, nil] + optional :skip, Integer + + # @!attribute sort + # Sort the results by one of the supported fields in ascending or descending + # order. + # + # @return [Symbol, Imagekit::Models::AssetListParams::Sort, nil] + optional :sort, enum: -> { Imagekit::AssetListParams::Sort } + + # @!attribute 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 [Symbol, Imagekit::Models::AssetListParams::Type, nil] + optional :type, enum: -> { Imagekit::AssetListParams::Type } + + # @!method initialize(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::AssetListParams} for more details. + # + # @param file_type [Symbol, Imagekit::Models::AssetListParams::FileType] Filter results by file type. + # + # @param limit [Integer] The maximum number of results to return in response. + # + # @param path [String] Folder path if you want to limit the search within a specific folder. For exampl + # + # @param search_query [String] Query string in a Lucene-like query language e.g. `createdAt > "7d"`. + # + # @param skip [Integer] The number of results to skip before returning results. + # + # @param sort [Symbol, Imagekit::Models::AssetListParams::Sort] Sort the results by one of the supported fields in ascending or descending order + # + # @param type [Symbol, Imagekit::Models::AssetListParams::Type] Filter results by asset type. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # 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) + module FileType + extend Imagekit::Internal::Type::Enum + + ALL = :all + IMAGE = :image + NON_IMAGE = :"non-image" + + # @!method self.values + # @return [Array] + end + + # Sort the results by one of the supported fields in ascending or descending + # order. + module Sort + extend Imagekit::Internal::Type::Enum + + ASC_NAME = :ASC_NAME + DESC_NAME = :DESC_NAME + ASC_CREATED = :ASC_CREATED + DESC_CREATED = :DESC_CREATED + ASC_UPDATED = :ASC_UPDATED + DESC_UPDATED = :DESC_UPDATED + ASC_HEIGHT = :ASC_HEIGHT + DESC_HEIGHT = :DESC_HEIGHT + ASC_WIDTH = :ASC_WIDTH + DESC_WIDTH = :DESC_WIDTH + ASC_SIZE = :ASC_SIZE + DESC_SIZE = :DESC_SIZE + ASC_RELEVANCE = :ASC_RELEVANCE + DESC_RELEVANCE = :DESC_RELEVANCE + + # @!method self.values + # @return [Array] + end + + # 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`) + module Type + extend Imagekit::Internal::Type::Enum + + FILE = :file + FILE_VERSION = :"file-version" + FOLDER = :folder + ALL = :all + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/files/detail_retrieve_response.rb b/lib/imagekit/models/asset_list_response.rb similarity index 65% rename from lib/imagekit/models/files/detail_retrieve_response.rb rename to lib/imagekit/models/asset_list_response.rb index 2626b851..e7b39c4e 100644 --- a/lib/imagekit/models/files/detail_retrieve_response.rb +++ b/lib/imagekit/models/asset_list_response.rb @@ -2,15 +2,22 @@ module Imagekit module Models - module Files - # @see Imagekit::Resources::Files::Details#retrieve - class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel + # Object containing details of a file or file version. + module AssetListResponseItem + extend Imagekit::Internal::Type::Union + + # Object containing details of a file or file version. + variant -> { Imagekit::Models::AssetListResponseItem::FileDetails } + + variant -> { Imagekit::Models::AssetListResponseItem::FolderDetails } + + class FileDetails < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::DetailRetrieveResponse::AITag] }, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::AssetListResponseItem::FileDetails::AITag] }, api_name: :AITags, nil?: true @@ -132,9 +139,9 @@ class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object with details of the file version. # - # @return [Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, nil] + # @return [Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, nil] optional :version_info, - -> { Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo }, + -> { Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo }, api_name: :versionInfo # @!attribute width @@ -145,11 +152,11 @@ class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailRetrieveResponse} for more details. + # {Imagekit::Models::AssetListResponseItem::FileDetails} for more details. # # Object containing details of a file or file version. # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format # @@ -187,7 +194,7 @@ class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel # # @param url [String] URL of the file. # - # @param version_info [Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo] An object with details of the file version. + # @param version_info [Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo] An object with details of the file version. # # @param width [Float] Width of the file. @@ -213,7 +220,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailRetrieveResponse::AITag} for more details. + # {Imagekit::Models::AssetListResponseItem::FileDetails::AITag} for more details. # # @param confidence [Float] Confidence score of the tag. # @@ -222,7 +229,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end - # @see Imagekit::Models::Files::DetailRetrieveResponse#version_info + # @see Imagekit::Models::AssetListResponseItem::FileDetails#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. @@ -244,6 +251,84 @@ class VersionInfo < Imagekit::Internal::Type::BaseModel # @param name [String] Name of the file version. end end + + class FolderDetails < Imagekit::Internal::Type::BaseModel + # @!attribute created_at + # Date and time when the folder was created. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :created_at, String, api_name: :createdAt + + # @!attribute folder_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :folder_id, String, api_name: :folderId + + # @!attribute folder_path + # 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. + # + # @return [String, nil] + optional :folder_path, String, api_name: :folderPath + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute type + # Type of the asset. + # + # @return [Symbol, Imagekit::Models::AssetListResponseItem::FolderDetails::Type, nil] + optional :type, enum: -> { Imagekit::Models::AssetListResponseItem::FolderDetails::Type } + + # @!attribute updated_at + # Date and time when the folder was last updated. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :updated_at, String, api_name: :updatedAt + + # @!method initialize(created_at: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::AssetListResponseItem::FolderDetails} for more details. + # + # @param created_at [String] Date and time when the folder was created. The date and time is in ISO8601 forma + # + # @param folder_id [String] Unique identifier of the asset. + # + # @param folder_path [String] Path of the folder. This is the path you would use in the URL to access the fold + # + # @param name [String] Name of the asset. + # + # @param type [Symbol, Imagekit::Models::AssetListResponseItem::FolderDetails::Type] Type of the asset. + # + # @param updated_at [String] Date and time when the folder was last updated. The date and time is in ISO8601 + + # Type of the asset. + # + # @see Imagekit::Models::AssetListResponseItem::FolderDetails#type + module Type + extend Imagekit::Internal::Type::Enum + + FOLDER = :folder + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::AssetListResponseItem::FileDetails, Imagekit::Models::AssetListResponseItem::FolderDetails)] end + + # @type [Imagekit::Internal::Type::Converter] + AssetListResponse = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::AssetListResponseItem }] end end diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb new file mode 100644 index 00000000..e3d87a97 --- /dev/null +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -0,0 +1,677 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Beta + module V2 + # @see Imagekit::Resources::Beta::V2::Files#upload + class FileUploadParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute 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. + # + # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] + required :file, Imagekit::Internal::Type::FileInput + + # @!attribute file_name + # The name with which the file has to be uploaded. + # + # @return [String] + required :file_name, String, api_name: :fileName + + # @!attribute token + # 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. + # + # @return [String, nil] + optional :token, String + + # @!attribute checks + # 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). + # + # @return [String, nil] + optional :checks, String + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates + + # @!attribute custom_metadata + # JSON key-value pairs to associate with the asset. Create the custom metadata + # fields before setting these values. + # + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata + + # @!attribute description + # Optional text to describe the contents of the file. + # + # @return [String, nil] + optional :description, String + + # @!attribute extensions + # Array of extensions to be applied to the image. Each extension can be configured + # with specific parameters based on the extension type. + # + # @return [Array, nil] + optional :extensions, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Extension] + } + + # @!attribute 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. + # + # @return [String, nil] + optional :folder, String + + # @!attribute is_private_file + # 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. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute overwrite_ai_tags + # 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. + # + # @return [Boolean, nil] + optional :overwrite_ai_tags, Imagekit::Internal::Type::Boolean, api_name: :overwriteAITags + + # @!attribute overwrite_custom_metadata + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + # + # @return [Boolean, nil] + optional :overwrite_custom_metadata, + Imagekit::Internal::Type::Boolean, + api_name: :overwriteCustomMetadata + + # @!attribute overwrite_file + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + # + # @return [Boolean, nil] + optional :overwrite_file, Imagekit::Internal::Type::Boolean, api_name: :overwriteFile + + # @!attribute overwrite_tags + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + # + # @return [Boolean, nil] + optional :overwrite_tags, Imagekit::Internal::Type::Boolean, api_name: :overwriteTags + + # @!attribute response_fields + # Array of response field keys to include in the API response body. + # + # @return [Array, nil] + optional :response_fields, + -> { + Imagekit::Internal::Type::ArrayOf[enum: Imagekit::Beta::V2::FileUploadParams::ResponseField] + }, + api_name: :responseFields + + # @!attribute 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. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute 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. + # + # @return [Imagekit::Models::Beta::V2::FileUploadParams::Transformation, nil] + optional :transformation, -> { Imagekit::Beta::V2::FileUploadParams::Transformation } + + # @!attribute use_unique_file_name + # 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. + # + # @return [Boolean, nil] + optional :use_unique_file_name, Imagekit::Internal::Type::Boolean, api_name: :useUniqueFileName + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams} for more details. + # + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # + # @param file_name [String] The name with which the file has to be uploaded. + # + # @param token [String] This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses i + # + # @param checks [String] Server-side checks to run on the asset. + # + # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file + # + # @param custom_metadata [Hash{Symbol=>Object}] JSON key-value pairs to associate with the asset. Create the custom metadata fie + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # + # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e + # + # @param is_private_file [Boolean] Whether to mark the file as private or not. + # + # @param is_published [Boolean] Whether to upload file as published or not. + # + # @param overwrite_ai_tags [Boolean] If set to `true` and a file already exists at the exact location, its AITags wil + # + # @param overwrite_custom_metadata [Boolean] If the request does not have `customMetadata`, and a file already exists at the + # + # @param overwrite_file [Boolean] If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # + # @param overwrite_tags [Boolean] If the request does not have `tags`, and a file already exists at the exact loca + # + # @param response_fields [Array] Array of response field keys to include in the API response body. + # + # @param tags [Array] Set the tags while uploading the file. + # + # @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. + # + # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not. + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + module Extension + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension } + + variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension } + + variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name] + required :name, + enum: -> { + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name + } + + # @!attribute options + # + # @return [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options, nil] + optional :options, + -> { + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name] + required :name, + enum: -> { + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name + } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name] + required :name, + enum: -> { + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name + } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION = :"ai-auto-description" + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension)] + end + + module ResponseField + extend Imagekit::Internal::Type::Enum + + TAGS = :tags + CUSTOM_COORDINATES = :customCoordinates + IS_PRIVATE_FILE = :isPrivateFile + EMBEDDED_METADATA = :embeddedMetadata + IS_PUBLISHED = :isPublished + CUSTOM_METADATA = :customMetadata + METADATA = :metadata + + # @!method self.values + # @return [Array] + end + + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute post + # 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`. + # + # @return [Array, nil] + optional :post, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Transformation::Post] + } + + # @!attribute pre + # Transformation string to apply before uploading the file to the Media Library. + # Useful for optimizing files at ingestion. + # + # @return [String, nil] + optional :pre, String + + # @!method initialize(post: nil, pre: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation} for more details. + # + # 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 post [Array] List of transformations to apply _after_ the file is uploaded. + # + # @param pre [String] Transformation string to apply before uploading the file to the Media Library. U + + module Post + extend Imagekit::Internal::Type::Union + + variant -> { + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation + } + + variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo } + + variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail } + + variant -> { + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + } + + class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Transformation type. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] + required :type, + enum: -> { + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type + } + + # @!attribute value + # Transformation string (e.g. `w-200,h-200`). + # Same syntax as ImageKit URL-based transformations. + # + # @return [String] + required :value, String + + # @!method initialize(type:, value:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation} + # for more details. + # + # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] Transformation type. + # + # @param value [String] Transformation string (e.g. `w-200,h-200`). + + # Transformation type. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation#type + module Type + extend Imagekit::Internal::Type::Enum + + TRANSFORMATION = :transformation + + # @!method self.values + # @return [Array] + end + end + + class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Converts an animated GIF into an MP4. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] + required :type, + enum: -> { + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type + } + + # @!attribute value + # Optional transformation string to apply to the output video. + # **Example**: `q-80` + # + # @return [String, nil] + optional :value, String + + # @!method initialize(type:, value: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo} + # for more details. + # + # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] Converts an animated GIF into an MP4. + # + # @param value [String] Optional transformation string to apply to the output video. + + # Converts an animated GIF into an MP4. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo#type + module Type + extend Imagekit::Internal::Type::Enum + + GIF_TO_VIDEO = :"gif-to-video" + + # @!method self.values + # @return [Array] + end + end + + class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Generates a thumbnail image. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] + required :type, + enum: -> { + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type + } + + # @!attribute value + # Optional transformation string. + # **Example**: `w-150,h-150` + # + # @return [String, nil] + optional :value, String + + # @!method initialize(type:, value: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail} + # for more details. + # + # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] Generates a thumbnail image. + # + # @param value [String] Optional transformation string. + + # Generates a thumbnail image. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail#type + module Type + extend Imagekit::Internal::Type::Enum + + THUMBNAIL = :thumbnail + + # @!method self.values + # @return [Array] + end + end + + class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + # @!attribute protocol + # Streaming protocol to use (`hls` or `dash`). + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] + required :protocol, + enum: -> { + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol + } + + # @!attribute type + # Adaptive Bitrate Streaming (ABS) setup. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] + required :type, + enum: -> { + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type + } + + # @!attribute value + # List of different representations you want to create separated by an underscore. + # + # @return [String] + required :value, String + + # @!method initialize(protocol:, type:, value:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming} + # for more details. + # + # @param protocol [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] Streaming protocol to use (`hls` or `dash`). + # + # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] Adaptive Bitrate Streaming (ABS) setup. + # + # @param value [String] List of different representations you want to create separated by an underscore. + + # Streaming protocol to use (`hls` or `dash`). + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming#protocol + module Protocol + extend Imagekit::Internal::Type::Enum + + HLS = :hls + DASH = :dash + + # @!method self.values + # @return [Array] + end + + # Adaptive Bitrate Streaming (ABS) setup. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming#type + module Type + extend Imagekit::Internal::Type::Enum + + ABS = :abs + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming)] + end + end + end + end + end + end +end diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekit/models/beta/v2/file_upload_response.rb new file mode 100644 index 00000000..16ccd3a9 --- /dev/null +++ b/lib/imagekit/models/beta/v2/file_upload_response.rb @@ -0,0 +1,847 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Beta + module V2 + # @see Imagekit::Resources::Beta::V2::Files#upload + class FileUploadResponse < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the uploaded file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Beta::V2::FileUploadResponse::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # 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. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute embedded_metadata + # 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. + # + # @return [Hash{Symbol=>Object}, nil] + optional :embedded_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :embeddedMetadata + + # @!attribute extension_status + # 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. + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, nil] + optional :extension_status, + -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus }, + api_name: :extensionStatus + + # @!attribute file_id + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute height + # Height of the image in pixels (Only for images) + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # 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. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute metadata + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, nil] + optional :metadata, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata } + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the image file in Bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # 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. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail_url + # In the case of an image, a small thumbnail URL. + # + # @return [String, nil] + optional :thumbnail_url, String, api_name: :thumbnailUrl + + # @!attribute url + # A publicly accessible URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, nil] + optional :version_info, + -> { Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo }, + api_name: :versionInfo + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # Width of the image in pixels (Only for Images) + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadResponse} for more details. + # + # Object containing details of a successful upload. + # + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h + # + # @param custom_metadata [Object] A key-value data associated with the asset. Use `responseField` in API request t + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, + # + # @param extension_status [Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # + # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo + # + # @param file_path [String] The relative path of the file in the media library e.g. `/marketing-assets/new-b + # + # @param file_type [String] Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @param height [Float] Height of the image in pixels (Only for images) + # + # @param is_private_file [Boolean] Is the file marked as private. It can be either `true` or `false`. Send `isPriva + # + # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen + # + # @param metadata [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the image file in Bytes. + # + # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul + # + # @param thumbnail_url [String] In the case of an image, a small thumbnail URL. + # + # @param url [String] A publicly accessible URL of the file. + # + # @param version_info [Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Float] Width of the image in pixels (Only for Images) + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # 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. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadResponse::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse#extension_status + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute aws_auto_tagging + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] + optional :aws_auto_tagging, + enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging }, + api_name: :"aws-auto-tagging" + + # @!attribute google_auto_tagging + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging, nil] + optional :google_auto_tagging, + enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging }, + api_name: :"google-auto-tagging" + + # @!attribute remove_bg + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg, nil] + optional :remove_bg, + enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg }, + api_name: :"remove-bg" + + # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # 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. + # + # @param aws_auto_tagging [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg] + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#aws_auto_tagging + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#google_auto_tagging + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#remove_bg + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse#metadata + class Metadata < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, nil] + optional :exif, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, nil] + optional :exif, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, nil] + optional :gps, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, nil] + optional :image, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, nil] + optional :interoperability, + -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif] Object containing Exif details. + # + # @param gps [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end + end + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end + end + end +end diff --git a/lib/imagekit/models/bulk_job_retrieve_status_response.rb b/lib/imagekit/models/bulk_job_retrieve_status_response.rb deleted file mode 100644 index 742f9dd8..00000000 --- a/lib/imagekit/models/bulk_job_retrieve_status_response.rb +++ /dev/null @@ -1,36 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::BulkJobs#retrieve_status - class BulkJobRetrieveStatusResponse < Imagekit::Internal::Type::BaseModel - # @!attribute job_id - # Unique identifier of the bulk job. - # - # @return [String, nil] - optional :job_id, String, api_name: :jobId - - # @!attribute status - # Status of the bulk job. Possible values - `Pending`, `Completed`. - # - # @return [String, nil] - optional :status, String - - # @!attribute type - # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`. - # - # @return [String, nil] - optional :type, String - - # @!method initialize(job_id: nil, status: nil, type: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::BulkJobRetrieveStatusResponse} for more details. - # - # @param job_id [String] Unique identifier of the bulk job. - # - # @param status [String] Status of the bulk job. Possible values - `Pending`, `Completed`. - # - # @param type [String] Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`. - end - end -end diff --git a/lib/imagekit/models/files/purge_execute_params.rb b/lib/imagekit/models/cache/invalidation_create_params.rb similarity index 73% rename from lib/imagekit/models/files/purge_execute_params.rb rename to lib/imagekit/models/cache/invalidation_create_params.rb index cfa8acca..47e252a8 100644 --- a/lib/imagekit/models/files/purge_execute_params.rb +++ b/lib/imagekit/models/cache/invalidation_create_params.rb @@ -2,9 +2,9 @@ module Imagekit module Models - module Files - # @see Imagekit::Resources::Files::Purge#execute - class PurgeExecuteParams < Imagekit::Internal::Type::BaseModel + module Cache + # @see Imagekit::Resources::Cache::Invalidation#create + class InvalidationCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -16,7 +16,7 @@ class PurgeExecuteParams < Imagekit::Internal::Type::BaseModel # @!method initialize(url:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::PurgeExecuteParams} for more details. + # {Imagekit::Models::Cache::InvalidationCreateParams} for more details. # # @param url [String] The full URL of the file to be purged. # diff --git a/lib/imagekit/models/files/purge_execute_response.rb b/lib/imagekit/models/cache/invalidation_create_response.rb similarity index 71% rename from lib/imagekit/models/files/purge_execute_response.rb rename to lib/imagekit/models/cache/invalidation_create_response.rb index 3d2493fb..ceb1f1d0 100644 --- a/lib/imagekit/models/files/purge_execute_response.rb +++ b/lib/imagekit/models/cache/invalidation_create_response.rb @@ -2,9 +2,9 @@ module Imagekit module Models - module Files - # @see Imagekit::Resources::Files::Purge#execute - class PurgeExecuteResponse < Imagekit::Internal::Type::BaseModel + module Cache + # @see Imagekit::Resources::Cache::Invalidation#create + class InvalidationCreateResponse < Imagekit::Internal::Type::BaseModel # @!attribute request_id # Unique identifier of the purge request. This can be used to check the status of # the purge request. @@ -14,7 +14,7 @@ class PurgeExecuteResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(request_id: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::PurgeExecuteResponse} for more details. + # {Imagekit::Models::Cache::InvalidationCreateResponse} for more details. # # @param request_id [String] Unique identifier of the purge request. This can be used to check the status of end diff --git a/lib/imagekit/models/cache/invalidation_get_params.rb b/lib/imagekit/models/cache/invalidation_get_params.rb new file mode 100644 index 00000000..d25ae6f5 --- /dev/null +++ b/lib/imagekit/models/cache/invalidation_get_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Cache + # @see Imagekit::Resources::Cache::Invalidation#get + class InvalidationGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/cache/invalidation_get_response.rb b/lib/imagekit/models/cache/invalidation_get_response.rb new file mode 100644 index 00000000..0a5d99c0 --- /dev/null +++ b/lib/imagekit/models/cache/invalidation_get_response.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Cache + # @see Imagekit::Resources::Cache::Invalidation#get + class InvalidationGetResponse < Imagekit::Internal::Type::BaseModel + # @!attribute status + # Status of the purge request. + # + # @return [Symbol, Imagekit::Models::Cache::InvalidationGetResponse::Status, nil] + optional :status, enum: -> { Imagekit::Models::Cache::InvalidationGetResponse::Status } + + # @!method initialize(status: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Cache::InvalidationGetResponse} for more details. + # + # @param status [Symbol, Imagekit::Models::Cache::InvalidationGetResponse::Status] Status of the purge request. + + # Status of the purge request. + # + # @see Imagekit::Models::Cache::InvalidationGetResponse#status + module Status + extend Imagekit::Internal::Type::Enum + + PENDING = :Pending + COMPLETED = :Completed + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field_create_params.rb b/lib/imagekit/models/custom_metadata_field_create_params.rb index eb1ff5a4..4d9dc5f4 100644 --- a/lib/imagekit/models/custom_metadata_field_create_params.rb +++ b/lib/imagekit/models/custom_metadata_field_create_params.rb @@ -137,7 +137,7 @@ module Type extend Imagekit::Internal::Type::Enum TEXT = :Text - TEXT_AREA = :TextArea + TEXTAREA = :Textarea NUMBER = :Number DATE = :Date BOOLEAN = :Boolean diff --git a/lib/imagekit/models/custom_metadata_field_create_response.rb b/lib/imagekit/models/custom_metadata_field_create_response.rb index a1531d9f..9c4703af 100644 --- a/lib/imagekit/models/custom_metadata_field_create_response.rb +++ b/lib/imagekit/models/custom_metadata_field_create_response.rb @@ -137,7 +137,7 @@ module Type extend Imagekit::Internal::Type::Enum TEXT = :Text - TEXT_AREA = :TextArea + TEXTAREA = :Textarea NUMBER = :Number DATE = :Date BOOLEAN = :Boolean diff --git a/lib/imagekit/models/custom_metadata_field_list_params.rb b/lib/imagekit/models/custom_metadata_field_list_params.rb index 96fcabba..f2c94cec 100644 --- a/lib/imagekit/models/custom_metadata_field_list_params.rb +++ b/lib/imagekit/models/custom_metadata_field_list_params.rb @@ -8,8 +8,7 @@ class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel include Imagekit::Internal::Type::RequestParameters # @!attribute include_deleted - # Set it to `true` to include deleted field objects in the API response. Default - # value is `false`. + # Set it to `true` to include deleted field objects in the API response. # # @return [Boolean, nil] optional :include_deleted, Imagekit::Internal::Type::Boolean @@ -18,7 +17,7 @@ class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekit::Models::CustomMetadataFieldListParams} for more details. # - # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. Default v + # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/imagekit/models/custom_metadata_field_list_response.rb b/lib/imagekit/models/custom_metadata_field_list_response.rb index 5e57b78d..68723e84 100644 --- a/lib/imagekit/models/custom_metadata_field_list_response.rb +++ b/lib/imagekit/models/custom_metadata_field_list_response.rb @@ -137,7 +137,7 @@ module Type extend Imagekit::Internal::Type::Enum TEXT = :Text - TEXT_AREA = :TextArea + TEXTAREA = :Textarea NUMBER = :Number DATE = :Date BOOLEAN = :Boolean diff --git a/lib/imagekit/models/custom_metadata_field_update_response.rb b/lib/imagekit/models/custom_metadata_field_update_response.rb index 0c8edba4..3d7c18ee 100644 --- a/lib/imagekit/models/custom_metadata_field_update_response.rb +++ b/lib/imagekit/models/custom_metadata_field_update_response.rb @@ -137,7 +137,7 @@ module Type extend Imagekit::Internal::Type::Enum TEXT = :Text - TEXT_AREA = :TextArea + TEXTAREA = :Textarea NUMBER = :Number DATE = :Date BOOLEAN = :Boolean diff --git a/lib/imagekit/models/exif_details.rb b/lib/imagekit/models/exif_details.rb deleted file mode 100644 index e6af5a2c..00000000 --- a/lib/imagekit/models/exif_details.rb +++ /dev/null @@ -1,167 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class ExifDetails < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - end -end diff --git a/lib/imagekit/models/exif_image.rb b/lib/imagekit/models/exif_image.rb deleted file mode 100644 index df6a92ed..00000000 --- a/lib/imagekit/models/exif_image.rb +++ /dev/null @@ -1,77 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class ExifImage < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - end -end diff --git a/lib/imagekit/models/file_add_tags_params.rb b/lib/imagekit/models/file_add_tags_params.rb deleted file mode 100644 index cda4768d..00000000 --- a/lib/imagekit/models/file_add_tags_params.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#add_tags - class FileAddTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file_ids - # An array of fileIds to which you want to add tags. - # - # @return [Array] - required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds - - # @!attribute tags - # An array of tags that you want to add to the files. - # - # @return [Array] - required :tags, Imagekit::Internal::Type::ArrayOf[String] - - # @!method initialize(file_ids:, tags:, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileAddTagsParams} for more details. - # - # @param file_ids [Array] An array of fileIds to which you want to add tags. - # - # @param tags [Array] An array of tags that you want to add to the files. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/file_add_tags_response.rb b/lib/imagekit/models/file_add_tags_response.rb deleted file mode 100644 index 9acee917..00000000 --- a/lib/imagekit/models/file_add_tags_response.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#add_tags - class FileAddTagsResponse < Imagekit::Internal::Type::BaseModel - # @!attribute successfully_updated_file_ids - # An array of fileIds that in which tags were successfully added. - # - # @return [Array, nil] - optional :successfully_updated_file_ids, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :successfullyUpdatedFileIds - - # @!method initialize(successfully_updated_file_ids: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileAddTagsResponse} for more details. - # - # @param successfully_updated_file_ids [Array] An array of fileIds that in which tags were successfully added. - end - end -end diff --git a/lib/imagekit/models/bulk_job_retrieve_status_params.rb b/lib/imagekit/models/file_get_params.rb similarity index 71% rename from lib/imagekit/models/bulk_job_retrieve_status_params.rb rename to lib/imagekit/models/file_get_params.rb index d9630d07..65525d6b 100644 --- a/lib/imagekit/models/bulk_job_retrieve_status_params.rb +++ b/lib/imagekit/models/file_get_params.rb @@ -2,8 +2,8 @@ module Imagekit module Models - # @see Imagekit::Resources::BulkJobs#retrieve_status - class BulkJobRetrieveStatusParams < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Files#get + class FileGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/file_list_response.rb b/lib/imagekit/models/file_get_response.rb similarity index 88% rename from lib/imagekit/models/file_list_response.rb rename to lib/imagekit/models/file_get_response.rb index b980eeef..66cca3b6 100644 --- a/lib/imagekit/models/file_list_response.rb +++ b/lib/imagekit/models/file_get_response.rb @@ -2,13 +2,14 @@ module Imagekit module Models - class FileListResponseItem < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Files#get + class FileGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileListResponseItem::AITag] }, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileGetResponse::AITag] }, api_name: :AITags, nil?: true @@ -130,8 +131,8 @@ class FileListResponseItem < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object with details of the file version. # - # @return [Imagekit::Models::FileListResponseItem::VersionInfo, nil] - optional :version_info, -> { Imagekit::Models::FileListResponseItem::VersionInfo }, api_name: :versionInfo + # @return [Imagekit::Models::FileGetResponse::VersionInfo, nil] + optional :version_info, -> { Imagekit::Models::FileGetResponse::VersionInfo }, api_name: :versionInfo # @!attribute width # Width of the file. @@ -141,11 +142,11 @@ class FileListResponseItem < Imagekit::Internal::Type::BaseModel # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileListResponseItem} for more details. + # {Imagekit::Models::FileGetResponse} for more details. # # Object containing details of a file or file version. # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format # @@ -183,7 +184,7 @@ class FileListResponseItem < Imagekit::Internal::Type::BaseModel # # @param url [String] URL of the file. # - # @param version_info [Imagekit::Models::FileListResponseItem::VersionInfo] An object with details of the file version. + # @param version_info [Imagekit::Models::FileGetResponse::VersionInfo] An object with details of the file version. # # @param width [Float] Width of the file. @@ -209,7 +210,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileListResponseItem::AITag} for more details. + # {Imagekit::Models::FileGetResponse::AITag} for more details. # # @param confidence [Float] Confidence score of the tag. # @@ -218,7 +219,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end - # @see Imagekit::Models::FileListResponseItem#version_info + # @see Imagekit::Models::FileGetResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. @@ -240,8 +241,5 @@ class VersionInfo < Imagekit::Internal::Type::BaseModel # @param name [String] Name of the file version. end end - - # @type [Imagekit::Internal::Type::Converter] - FileListResponse = Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Models::FileListResponseItem }] end end diff --git a/lib/imagekit/models/file_list_params.rb b/lib/imagekit/models/file_list_params.rb deleted file mode 100644 index 707faf1d..00000000 --- a/lib/imagekit/models/file_list_params.rb +++ /dev/null @@ -1,130 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#list - class FileListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file_type - # Type of files to include in the result set. Accepts three values: - # - # `all` - include all types of files in the result set. `image` - only search in - # image type files. `non-image` - only search in files that are not images, e.g., - # JS or CSS or video files. - # - # Default value - `all` - # - # @return [String, nil] - optional :file_type, String - - # @!attribute limit - # The maximum number of results to return in response: - # - # Minimum value - 1 - # - # Maximum value - 1000 - # - # Default value - 1000 - # - # @return [String, nil] - optional :limit, String - - # @!attribute path - # Folder path if you want to limit the search within a specific folder. For - # example, `/sales-banner/` will only search in folder sales-banner. - # - # @return [String, nil] - optional :path, String - - # @!attribute search_query - # 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. - # - # @return [String, nil] - optional :search_query, String - - # @!attribute skip - # The number of results to skip before returning results: - # - # Minimum value - 0 - # - # Default value - 0 - # - # @return [String, nil] - optional :skip, String - - # @!attribute sort - # You can sort based on the following fields: - # - # 1. name - `ASC_NAME` or `DESC_NAME` - # 2. createdAt - `ASC_CREATED` or `DESC_CREATED` - # 3. updatedAt - `ASC_UPDATED` or `DESC_UPDATED` - # 4. height - `ASC_HEIGHT` or `DESC_HEIGHT` - # 5. width - `ASC_WIDTH` or `DESC_WIDTH` - # 6. size - `ASC_SIZE` or `DESC_SIZE` - # - # Default value - `ASC_CREATED` - # - # @return [String, nil] - optional :sort, String - - # @!attribute type - # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to - # include `files` and `folders` in search results (`file-version` will not be - # included in this case). - # - # Default value - `file` - # - # @return [Symbol, Imagekit::Models::FileListParams::Type, nil] - optional :type, enum: -> { Imagekit::FileListParams::Type } - - # @!method initialize(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileListParams} for more details. - # - # @param file_type [String] Type of files to include in the result set. Accepts three values: - # - # @param limit [String] The maximum number of results to return in response: - # - # @param path [String] Folder path if you want to limit the search within a specific folder. For exampl - # - # @param search_query [String] Query string in a Lucene-like query language e.g. `createdAt > "7d"`. - # - # @param skip [String] The number of results to skip before returning results: - # - # @param sort [String] You can sort based on the following fields: - # - # @param type [Symbol, Imagekit::Models::FileListParams::Type] Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to includ - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to - # include `files` and `folders` in search results (`file-version` will not be - # included in this case). - # - # Default value - `file` - module Type - extend Imagekit::Internal::Type::Enum - - FILE = :file - FILE_VERSION = :"file-version" - FOLDER = :folder - ALL = :all - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/imagekit/models/file_remove_ai_tags_params.rb b/lib/imagekit/models/file_remove_ai_tags_params.rb deleted file mode 100644 index 65abf4da..00000000 --- a/lib/imagekit/models/file_remove_ai_tags_params.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#remove_ai_tags - class FileRemoveAITagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute ai_tags - # An array of AITags that you want to remove from the files. - # - # @return [Array] - required :ai_tags, Imagekit::Internal::Type::ArrayOf[String], api_name: :AITags - - # @!attribute file_ids - # An array of fileIds from which you want to remove AITags. - # - # @return [Array] - required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds - - # @!method initialize(ai_tags:, file_ids:, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRemoveAITagsParams} for more details. - # - # @param ai_tags [Array] An array of AITags that you want to remove from the files. - # - # @param file_ids [Array] An array of fileIds from which you want to remove AITags. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/file_remove_ai_tags_response.rb b/lib/imagekit/models/file_remove_ai_tags_response.rb deleted file mode 100644 index 43146302..00000000 --- a/lib/imagekit/models/file_remove_ai_tags_response.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#remove_ai_tags - class FileRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel - # @!attribute successfully_updated_file_ids - # An array of fileIds that in which AITags were successfully removed. - # - # @return [Array, nil] - optional :successfully_updated_file_ids, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :successfullyUpdatedFileIds - - # @!method initialize(successfully_updated_file_ids: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRemoveAITagsResponse} for more details. - # - # @param successfully_updated_file_ids [Array] An array of fileIds that in which AITags were successfully removed. - end - end -end diff --git a/lib/imagekit/models/file_remove_tags_params.rb b/lib/imagekit/models/file_remove_tags_params.rb deleted file mode 100644 index 542ac7ce..00000000 --- a/lib/imagekit/models/file_remove_tags_params.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#remove_tags - class FileRemoveTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file_ids - # An array of fileIds from which you want to remove tags. - # - # @return [Array] - required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds - - # @!attribute tags - # An array of tags that you want to remove from the files. - # - # @return [Array] - required :tags, Imagekit::Internal::Type::ArrayOf[String] - - # @!method initialize(file_ids:, tags:, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRemoveTagsParams} for more details. - # - # @param file_ids [Array] An array of fileIds from which you want to remove tags. - # - # @param tags [Array] An array of tags that you want to remove from the files. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/file_remove_tags_response.rb b/lib/imagekit/models/file_remove_tags_response.rb deleted file mode 100644 index 1b230522..00000000 --- a/lib/imagekit/models/file_remove_tags_response.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#remove_tags - class FileRemoveTagsResponse < Imagekit::Internal::Type::BaseModel - # @!attribute successfully_updated_file_ids - # An array of fileIds that in which tags were successfully removed. - # - # @return [Array, nil] - optional :successfully_updated_file_ids, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :successfullyUpdatedFileIds - - # @!method initialize(successfully_updated_file_ids: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRemoveTagsResponse} for more details. - # - # @param successfully_updated_file_ids [Array] An array of fileIds that in which tags were successfully removed. - end - end -end diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb new file mode 100644 index 00000000..f165a717 --- /dev/null +++ b/lib/imagekit/models/file_update_params.rb @@ -0,0 +1,309 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#update + class FileUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # 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. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute description + # Optional text to describe the contents of the file. + # + # @return [String, nil] + optional :description, String + + # @!attribute extensions + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + # + # @return [Array, nil] + optional :extensions, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Extension] } + + # @!attribute remove_ai_tags + # 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. + # + # @return [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags, nil] + optional :remove_ai_tags, + union: -> { + Imagekit::FileUpdateParams::RemoveAITags + }, + api_name: :removeAITags + + # @!attribute tags + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!attribute publish + # Configure the publication status of a file and its versions. + # + # @return [Imagekit::Models::FileUpdateParams::Publish, nil] + optional :publish, -> { Imagekit::FileUpdateParams::Publish } + + # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams} for more details. + # + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Object] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + module Extension + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension } + + variant -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension } + + variant -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name } + + # @!attribute options + # + # @return [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options, nil] + optional :options, -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. + # + # @see Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION = :"ai-auto-description" + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension)] + end + + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::FileUpdateParams::RemoveAITags::StringArray } + + variant const: -> { Imagekit::Models::FileUpdateParams::RemoveAITags::ALL } + + # @!method self.variants + # @return [Array(Array, Symbol)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(T::Array[String], Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol) } + end + + # @type [Imagekit::Internal::Type::Converter] + StringArray = Imagekit::Internal::Type::ArrayOf[String] + + # @!group + + ALL = :all + + # @!endgroup + end + + class Publish < Imagekit::Internal::Type::BaseModel + # @!attribute is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @return [Boolean] + required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + # + # @return [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + + # @!method initialize(is_published:, include_file_versions: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Publish} for more details. + # + # Configure the publication status of a file and its versions. + # + # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p + end + end + end +end diff --git a/lib/imagekit/models/file_update_response.rb b/lib/imagekit/models/file_update_response.rb new file mode 100644 index 00000000..d38d47d7 --- /dev/null +++ b/lib/imagekit/models/file_update_response.rb @@ -0,0 +1,337 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#update + class FileUpdateResponse < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUpdateResponse::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute created_at + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :created_at, String, api_name: :createdAt + + # @!attribute custom_coordinates + # An string with custom coordinates of the file. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # An object with custom metadata for the file. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute extension_status + # + # @return [Imagekit::Models::FileUpdateResponse::ExtensionStatus, nil] + optional :extension_status, + -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus }, + api_name: :extensionStatus + + # @!attribute file_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # 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`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute has_alpha + # Specifies if the image has an alpha channel. + # + # @return [Boolean, nil] + optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha + + # @!attribute height + # Height of the file. + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # Specifies if the file is private or not. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # Specifies if the file is published or not. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute mime + # MIME type of the file. + # + # @return [String, nil] + optional :mime, String + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the file in bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + # + # @return [String, nil] + optional :thumbnail, String + + # @!attribute type + # Type of the asset. + # + # @return [String, nil] + optional :type, String + + # @!attribute updated_at + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + # + # @return [String, nil] + optional :updated_at, String, api_name: :updatedAt + + # @!attribute url + # URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object with details of the file version. + # + # @return [Imagekit::Models::FileUpdateResponse::VersionInfo, nil] + optional :version_info, -> { Imagekit::Models::FileUpdateResponse::VersionInfo }, api_name: :versionInfo + + # @!attribute width + # Width of the file. + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateResponse} for more details. + # + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # + # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # + # @param custom_coordinates [String, nil] An string with custom coordinates of the file. + # + # @param custom_metadata [Object] An object with custom metadata for the file. + # + # @param extension_status [Imagekit::Models::FileUpdateResponse::ExtensionStatus] + # + # @param file_id [String] Unique identifier of the asset. + # + # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. + # + # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. + # + # @param has_alpha [Boolean] Specifies if the image has an alpha channel. + # + # @param height [Float] Height of the file. + # + # @param is_private_file [Boolean] Specifies if the file is private or not. + # + # @param is_published [Boolean] Specifies if the file is published or not. + # + # @param mime [String] MIME type of the file. + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the file in bytes. + # + # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi + # + # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th + # + # @param type [String] Type of the asset. + # + # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # + # @param url [String] URL of the file. + # + # @param version_info [Imagekit::Models::FileUpdateResponse::VersionInfo] An object with details of the file version. + # + # @param width [Float] Width of the file. + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateResponse::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi + end + + # @see Imagekit::Models::FileUpdateResponse#extension_status + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute ai_auto_description + # + # @return [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription, nil] + optional :ai_auto_description, + enum: -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription }, + api_name: :"ai-auto-description" + + # @!attribute aws_auto_tagging + # + # @return [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging, nil] + optional :aws_auto_tagging, + enum: -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging }, + api_name: :"aws-auto-tagging" + + # @!attribute google_auto_tagging + # + # @return [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging, nil] + optional :google_auto_tagging, + enum: -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging }, + api_name: :"google-auto-tagging" + + # @!attribute remove_bg + # + # @return [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg, nil] + optional :remove_bg, + enum: -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg }, + api_name: :"remove-bg" + + # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @param ai_auto_description [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription] + # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg] + + # @see Imagekit::Models::FileUpdateResponse::ExtensionStatus#ai_auto_description + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUpdateResponse::ExtensionStatus#aws_auto_tagging + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUpdateResponse::ExtensionStatus#google_auto_tagging + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUpdateResponse::ExtensionStatus#remove_bg + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::FileUpdateResponse#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object with details of the file version. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end +end diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb new file mode 100644 index 00000000..e6a25494 --- /dev/null +++ b/lib/imagekit/models/file_upload_params.rb @@ -0,0 +1,692 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#upload + class FileUploadParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute 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. + # + # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] + required :file, Imagekit::Internal::Type::FileInput + + # @!attribute file_name + # 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 `_` + # + # @return [String] + required :file_name, String, api_name: :fileName + + # @!attribute 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. + # + # @return [String, nil] + optional :token, String + + # @!attribute 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). + # + # @return [String, nil] + optional :checks, String + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates + + # @!attribute custom_metadata + # JSON key-value pairs to associate with the asset. Create the custom metadata + # fields before setting these values. + # + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata + + # @!attribute description + # Optional text to describe the contents of the file. + # + # @return [String, nil] + optional :description, String + + # @!attribute 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. + # + # @return [Integer, nil] + optional :expire, Integer + + # @!attribute extensions + # Array of extensions to be applied to the image. Each extension can be configured + # with specific parameters based on the extension type. + # + # @return [Array, nil] + optional :extensions, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Extension] } + + # @!attribute 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. + # + # @return [String, nil] + optional :folder, String + + # @!attribute is_private_file + # 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. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute overwrite_ai_tags + # 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. + # + # @return [Boolean, nil] + optional :overwrite_ai_tags, Imagekit::Internal::Type::Boolean, api_name: :overwriteAITags + + # @!attribute overwrite_custom_metadata + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + # + # @return [Boolean, nil] + optional :overwrite_custom_metadata, + Imagekit::Internal::Type::Boolean, + api_name: :overwriteCustomMetadata + + # @!attribute overwrite_file + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + # + # @return [Boolean, nil] + optional :overwrite_file, Imagekit::Internal::Type::Boolean, api_name: :overwriteFile + + # @!attribute overwrite_tags + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + # + # @return [Boolean, nil] + optional :overwrite_tags, Imagekit::Internal::Type::Boolean, api_name: :overwriteTags + + # @!attribute public_key + # Your ImageKit.io public key. This field is only required for authentication when + # uploading a file from the client side. + # + # @return [String, nil] + optional :public_key, String, api_name: :publicKey + + # @!attribute response_fields + # Array of response field keys to include in the API response body. + # + # @return [Array, nil] + optional :response_fields, + -> { Imagekit::Internal::Type::ArrayOf[enum: Imagekit::FileUploadParams::ResponseField] }, + api_name: :responseFields + + # @!attribute 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. + # + # @return [String, nil] + optional :signature, String + + # @!attribute 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. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute 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. + # + # @return [Imagekit::Models::FileUploadParams::Transformation, nil] + optional :transformation, -> { Imagekit::FileUploadParams::Transformation } + + # @!attribute use_unique_file_name + # 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. + # + # @return [Boolean, nil] + optional :use_unique_file_name, Imagekit::Internal::Type::Boolean, api_name: :useUniqueFileName + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams} for more details. + # + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # + # @param file_name [String] The name with which the file has to be uploaded. + # + # @param token [String] A unique value that the ImageKit.io server will use to recognize and prevent sub + # + # @param checks [String] Server-side checks to run on the asset. + # + # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file + # + # @param custom_metadata [Hash{Symbol=>Object}] JSON key-value pairs to associate with the asset. Create the custom metadata fie + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki + # + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # + # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e + # + # @param is_private_file [Boolean] Whether to mark the file as private or not. + # + # @param is_published [Boolean] Whether to upload file as published or not. + # + # @param overwrite_ai_tags [Boolean] If set to `true` and a file already exists at the exact location, its AITags wil + # + # @param overwrite_custom_metadata [Boolean] If the request does not have `customMetadata`, and a file already exists at the + # + # @param overwrite_file [Boolean] If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # + # @param overwrite_tags [Boolean] If the request does not have `tags`, and a file already exists at the exact loca + # + # @param public_key [String] Your ImageKit.io public key. This field is only required for authentication when + # + # @param response_fields [Array] Array of response field keys to include in the API response body. + # + # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a + # + # @param tags [Array] Set the tags while uploading the file. + # + # @param transformation [Imagekit::Models::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. + # + # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not. + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + module Extension + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension } + + variant -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension } + + variant -> { Imagekit::FileUploadParams::Extension::AutoDescriptionExtension } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Name] + required :name, enum: -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name } + + # @!attribute options + # + # @return [Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options, nil] + optional :options, -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::Name] + required :name, enum: -> { Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. + # + # @see Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION = :"ai-auto-description" + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension)] + end + + module ResponseField + extend Imagekit::Internal::Type::Enum + + TAGS = :tags + CUSTOM_COORDINATES = :customCoordinates + IS_PRIVATE_FILE = :isPrivateFile + EMBEDDED_METADATA = :embeddedMetadata + IS_PUBLISHED = :isPublished + CUSTOM_METADATA = :customMetadata + METADATA = :metadata + + # @!method self.values + # @return [Array] + end + + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute post + # 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`. + # + # @return [Array, nil] + optional :post, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Transformation::Post] + } + + # @!attribute pre + # Transformation string to apply before uploading the file to the Media Library. + # Useful for optimizing files at ingestion. + # + # @return [String, nil] + optional :pre, String + + # @!method initialize(post: nil, pre: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams::Transformation} for more details. + # + # 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 post [Array] List of transformations to apply _after_ the file is uploaded. + # + # @param pre [String] Transformation string to apply before uploading the file to the Media Library. U + + module Post + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation } + + variant -> { Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo } + + variant -> { Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail } + + variant -> { Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming } + + class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Transformation type. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] + required :type, + enum: -> { + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type + } + + # @!attribute value + # Transformation string (e.g. `w-200,h-200`). + # Same syntax as ImageKit URL-based transformations. + # + # @return [String] + required :value, String + + # @!method initialize(type:, value:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation} + # for more details. + # + # @param type [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] Transformation type. + # + # @param value [String] Transformation string (e.g. `w-200,h-200`). + + # Transformation type. + # + # @see Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation#type + module Type + extend Imagekit::Internal::Type::Enum + + TRANSFORMATION = :transformation + + # @!method self.values + # @return [Array] + end + end + + class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Converts an animated GIF into an MP4. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] + required :type, + enum: -> { + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type + } + + # @!attribute value + # Optional transformation string to apply to the output video. + # **Example**: `q-80` + # + # @return [String, nil] + optional :value, String + + # @!method initialize(type:, value: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo} + # for more details. + # + # @param type [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] Converts an animated GIF into an MP4. + # + # @param value [String] Optional transformation string to apply to the output video. + + # Converts an animated GIF into an MP4. + # + # @see Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo#type + module Type + extend Imagekit::Internal::Type::Enum + + GIF_TO_VIDEO = :"gif-to-video" + + # @!method self.values + # @return [Array] + end + end + + class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Generates a thumbnail image. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] + required :type, + enum: -> { + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type + } + + # @!attribute value + # Optional transformation string. + # **Example**: `w-150,h-150` + # + # @return [String, nil] + optional :value, String + + # @!method initialize(type:, value: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail} + # for more details. + # + # @param type [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] Generates a thumbnail image. + # + # @param value [String] Optional transformation string. + + # Generates a thumbnail image. + # + # @see Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail#type + module Type + extend Imagekit::Internal::Type::Enum + + THUMBNAIL = :thumbnail + + # @!method self.values + # @return [Array] + end + end + + class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + # @!attribute protocol + # Streaming protocol to use (`hls` or `dash`). + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] + required :protocol, + enum: -> { + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol + } + + # @!attribute type + # Adaptive Bitrate Streaming (ABS) setup. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] + required :type, + enum: -> { + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type + } + + # @!attribute value + # List of different representations you want to create separated by an underscore. + # + # @return [String] + required :value, String + + # @!method initialize(protocol:, type:, value:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming} + # for more details. + # + # @param protocol [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] Streaming protocol to use (`hls` or `dash`). + # + # @param type [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] Adaptive Bitrate Streaming (ABS) setup. + # + # @param value [String] List of different representations you want to create separated by an underscore. + + # Streaming protocol to use (`hls` or `dash`). + # + # @see Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming#protocol + module Protocol + extend Imagekit::Internal::Type::Enum + + HLS = :hls + DASH = :dash + + # @!method self.values + # @return [Array] + end + + # Adaptive Bitrate Streaming (ABS) setup. + # + # @see Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming#type + module Type + extend Imagekit::Internal::Type::Enum + + ABS = :abs + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation, Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo, Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming)] + end + end + end + end +end diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekit/models/file_upload_response.rb new file mode 100644 index 00000000..918672ec --- /dev/null +++ b/lib/imagekit/models/file_upload_response.rb @@ -0,0 +1,840 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Files#upload + class FileUploadResponse < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the uploaded file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadResponse::AITag] }, + api_name: :AITags, + nil?: true + + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # 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. + # + # @return [Object, nil] + optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute embedded_metadata + # 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. + # + # @return [Hash{Symbol=>Object}, nil] + optional :embedded_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :embeddedMetadata + + # @!attribute extension_status + # 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. + # + # @return [Imagekit::Models::FileUploadResponse::ExtensionStatus, nil] + optional :extension_status, + -> { Imagekit::Models::FileUploadResponse::ExtensionStatus }, + api_name: :extensionStatus + + # @!attribute file_id + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute height + # Height of the image in pixels (Only for images) + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # 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. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute metadata + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @return [Imagekit::Models::FileUploadResponse::Metadata, nil] + optional :metadata, -> { Imagekit::Models::FileUploadResponse::Metadata } + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the image file in Bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # 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. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail_url + # In the case of an image, a small thumbnail URL. + # + # @return [String, nil] + optional :thumbnail_url, String, api_name: :thumbnailUrl + + # @!attribute url + # A publicly accessible URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @return [Imagekit::Models::FileUploadResponse::VersionInfo, nil] + optional :version_info, -> { Imagekit::Models::FileUploadResponse::VersionInfo }, api_name: :versionInfo + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # Width of the image in pixels (Only for Images) + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadResponse} for more details. + # + # Object containing details of a successful upload. + # + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h + # + # @param custom_metadata [Object] A key-value data associated with the asset. Use `responseField` in API request t + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, + # + # @param extension_status [Imagekit::Models::FileUploadResponse::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # + # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo + # + # @param file_path [String] The relative path of the file in the media library e.g. `/marketing-assets/new-b + # + # @param file_type [String] Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @param height [Float] Height of the image in pixels (Only for images) + # + # @param is_private_file [Boolean] Is the file marked as private. It can be either `true` or `false`. Send `isPriva + # + # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen + # + # @param metadata [Imagekit::Models::FileUploadResponse::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the image file in Bytes. + # + # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul + # + # @param thumbnail_url [String] In the case of an image, a small thumbnail URL. + # + # @param url [String] A publicly accessible URL of the file. + # + # @param version_info [Imagekit::Models::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Float] Width of the image in pixels (Only for Images) + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # 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. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadResponse::AITag} for more details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be + end + + # @see Imagekit::Models::FileUploadResponse#extension_status + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute aws_auto_tagging + # + # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] + optional :aws_auto_tagging, + enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging }, + api_name: :"aws-auto-tagging" + + # @!attribute google_auto_tagging + # + # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging, nil] + optional :google_auto_tagging, + enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging }, + api_name: :"google-auto-tagging" + + # @!attribute remove_bg + # + # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg, nil] + optional :remove_bg, + enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg }, + api_name: :"remove-bg" + + # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # 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. + # + # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg] + + # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#aws_auto_tagging + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#google_auto_tagging + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#remove_bg + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::FileUploadResponse#metadata + class Metadata < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif, nil] + optional :exif, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::FileUploadResponse::Metadata::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::FileUploadResponse::Metadata#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, nil] + optional :exif, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, nil] + optional :gps, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, nil] + optional :image, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Image } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, nil] + optional :interoperability, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif] Object containing Exif details. + # + # @param gps [Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::FileUploadResponse::Metadata::Exif::Image] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end + end + end + + # @see Imagekit::Models::FileUploadResponse#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + end +end diff --git a/lib/imagekit/models/file_upload_v1_params.rb b/lib/imagekit/models/file_upload_v1_params.rb deleted file mode 100644 index 75d18edd..00000000 --- a/lib/imagekit/models/file_upload_v1_params.rb +++ /dev/null @@ -1,384 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#upload_v1 - class FileUploadV1Params < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file - # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, - # please ensure that our servers can access the URL. In case ImageKit is unable to - # download the file from the specified URL, a `400` error response is returned. - # This will also result in a `400` error if the file download request is aborted - # if response headers are not received in 8 seconds. - # - # @return [String] - required :file, String - - # @!attribute file_name - # 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 `_` - # - # @return [String] - required :file_name, String, api_name: :fileName - - # @!attribute 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. - # - # @return [String, nil] - optional :token, String - - # @!attribute 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). - # - # @return [String, nil] - optional :checks, String - - # @!attribute custom_coordinates - # 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. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates - - # @!attribute custom_metadata - # Stringified JSON key-value data to be associated with the asset. - # - # @return [String, nil] - optional :custom_metadata, String, api_name: :customMetadata - - # @!attribute 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. - # - # @return [String, nil] - optional :expire, String - - # @!attribute extensions - # Stringified JSON object with an array of extensions to be applied to the image. - # Refer to extensions schema in - # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). - # - # @return [String, nil] - optional :extensions, String - - # @!attribute 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. - # - # @return [String, nil] - optional :folder, String - - # @!attribute is_private_file - # 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. - # - # @return [Symbol, Imagekit::Models::FileUploadV1Params::IsPrivateFile, nil] - optional :is_private_file, - enum: -> { Imagekit::FileUploadV1Params::IsPrivateFile }, - api_name: :isPrivateFile - - # @!attribute is_published - # 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. - # - # @return [Symbol, Imagekit::Models::FileUploadV1Params::IsPublished, nil] - optional :is_published, enum: -> { Imagekit::FileUploadV1Params::IsPublished }, api_name: :isPublished - - # @!attribute overwrite_ai_tags - # 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. - # - # @return [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteAITags, nil] - optional :overwrite_ai_tags, - enum: -> { Imagekit::FileUploadV1Params::OverwriteAITags }, - api_name: :overwriteAITags - - # @!attribute overwrite_custom_metadata - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - # - # @return [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteCustomMetadata, nil] - optional :overwrite_custom_metadata, - enum: -> { Imagekit::FileUploadV1Params::OverwriteCustomMetadata }, - api_name: :overwriteCustomMetadata - - # @!attribute overwrite_file - # If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # the exact location, upload API will return an error immediately. - # - # @return [String, nil] - optional :overwrite_file, String, api_name: :overwriteFile - - # @!attribute overwrite_tags - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - # - # @return [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteTags, nil] - optional :overwrite_tags, - enum: -> { Imagekit::FileUploadV1Params::OverwriteTags }, - api_name: :overwriteTags - - # @!attribute public_key - # Your ImageKit.io public key. This field is only required for authentication when - # uploading a file from the client side. - # - # @return [String, nil] - optional :public_key, String, api_name: :publicKey - - # @!attribute response_fields - # Comma-separated values of the fields that you want the API to return in the - # response. - # - # For example, set the value of this field to - # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, - # `customCoordinates`, and `isPrivateFile` in the response. - # - # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, - # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. - # - # @return [String, nil] - optional :response_fields, String, api_name: :responseFields - - # @!attribute 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. - # - # @return [String, nil] - optional :signature, String - - # @!attribute tags - # Set the tags while uploading the file. - # - # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length - # of all characters should not exceed 500. `%` is not allowed. - # - # If this field is not specified and the file is overwritten then the tags will be - # removed. - # - # @return [String, nil] - optional :tags, String - - # @!attribute transformation - # Stringified JSON object with properties for pre and post transformations: - # - # `pre` - Accepts a "string" containing a valid transformation used for requesting - # a pre-transformation for an image or a video file. - # - # `post` - Accepts an array of objects with properties: - # - # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` - # (Adaptive bitrate streaming). - # - `value`: A "string" corresponding to the required transformation. Required if - # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or - # `thumbnail`. - # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. - # - # Read more about - # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). - # - # @return [String, nil] - optional :transformation, String - - # @!attribute use_unique_file_name - # 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. - # - # @return [Symbol, Imagekit::Models::FileUploadV1Params::UseUniqueFileName, nil] - optional :use_unique_file_name, - enum: -> { Imagekit::FileUploadV1Params::UseUniqueFileName }, - api_name: :useUniqueFileName - - # @!attribute webhook_url - # 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 [String, nil] - optional :webhook_url, String, api_name: :webhookUrl - - # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadV1Params} for more details. - # - # @param file [String] Pass the HTTP URL or base64 string. When passing a URL in the file parameter, pl - # - # @param file_name [String] The name with which the file has to be uploaded. - # - # @param token [String] A unique value that the ImageKit.io server will use to recognize and prevent sub - # - # @param checks [String] Server-side checks to run on the asset. - # - # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file - # - # @param custom_metadata [String] Stringified JSON key-value data to be associated with the asset. - # - # @param expire [String] The time until your signature is valid. It must be a [Unix time](https://en.wiki - # - # @param extensions [String] Stringified JSON object with an array of extensions to be applied to the image. - # - # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e - # - # @param is_private_file [Symbol, Imagekit::Models::FileUploadV1Params::IsPrivateFile] Whether to mark the file as private or not. - # - # @param is_published [Symbol, Imagekit::Models::FileUploadV1Params::IsPublished] Whether to upload file as published or not. - # - # @param overwrite_ai_tags [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteAITags] If set to `true` and a file already exists at the exact location, its AITags wil - # - # @param overwrite_custom_metadata [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteCustomMetadata] If the request does not have `customMetadata`, and a file already exists at the - # - # @param overwrite_file [String] If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # - # @param overwrite_tags [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteTags] If the request does not have `tags`, and a file already exists at the exact loca - # - # @param public_key [String] Your ImageKit.io public key. This field is only required for authentication when - # - # @param response_fields [String] Comma-separated values of the fields that you want the API to return in the resp - # - # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a - # - # @param tags [String] Set the tags while uploading the file. - # - # @param transformation [String] Stringified JSON object with properties for pre and post transformations: - # - # @param use_unique_file_name [Symbol, Imagekit::Models::FileUploadV1Params::UseUniqueFileName] Whether to use a unique filename for this file or not. - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # 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. - module IsPrivateFile - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # 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. - module IsPublished - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # 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. - module OverwriteAITags - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - module OverwriteCustomMetadata - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - module OverwriteTags - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # 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. - module UseUniqueFileName - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/imagekit/models/file_upload_v1_response.rb b/lib/imagekit/models/file_upload_v1_response.rb deleted file mode 100644 index a79613e3..00000000 --- a/lib/imagekit/models/file_upload_v1_response.rb +++ /dev/null @@ -1,1706 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#upload_v1 - class FileUploadV1Response < Imagekit::Internal::Type::BaseModel - # @!attribute ai_tags - # An array of tags assigned to the uploaded file by auto tagging. - # - # @return [Array, nil] - optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadV1Response::AITag] }, - api_name: :AITags, - nil?: true - - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute custom_coordinates - # 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. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # 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. - # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute embedded_metadata - # 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. - # - # @return [Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, nil] - optional :embedded_metadata, - -> { Imagekit::Models::FileUploadV1Response::EmbeddedMetadata }, - api_name: :embeddedMetadata - - # @!attribute extension_status - # 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. - # - # @return [Imagekit::Models::FileUploadV1Response::ExtensionStatus, nil] - optional :extension_status, - -> { Imagekit::Models::FileUploadV1Response::ExtensionStatus }, - api_name: :extensionStatus - - # @!attribute file_id - # Unique fileId. Store this fileld in your database, as this will be used to - # perform update action on this file. - # - # @return [String, nil] - optional :file_id, String, api_name: :fileId - - # @!attribute file_path - # The relative path of the file in the media library e.g. - # `/marketing-assets/new-banner.jpg`. - # - # @return [String, nil] - optional :file_path, String, api_name: :filePath - - # @!attribute file_type - # Type of the uploaded file. Possible values are `image`, `non-image`. - # - # @return [String, nil] - optional :file_type, String, api_name: :fileType - - # @!attribute height - # Height of the image in pixels (Only for images) - # - # @return [Float, nil] - optional :height, Float - - # @!attribute is_private_file - # 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. - # - # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile - - # @!attribute is_published - # 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. - # - # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute metadata - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - # - # @return [Imagekit::Models::FileUploadV1Response::Metadata, nil] - optional :metadata, -> { Imagekit::Models::FileUploadV1Response::Metadata } - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute size - # Size of the image file in Bytes. - # - # @return [Float, nil] - optional :size, Float - - # @!attribute tags - # 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. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute thumbnail_url - # In the case of an image, a small thumbnail URL. - # - # @return [String, nil] - optional :thumbnail_url, String, api_name: :thumbnailUrl - - # @!attribute url - # A publicly accessible URL of the file. - # - # @return [String, nil] - optional :url, String - - # @!attribute version_info - # An object containing the file or file version's `id` (versionId) and `name`. - # - # @return [Imagekit::Models::FileUploadV1Response::VersionInfo, nil] - optional :version_info, -> { Imagekit::Models::FileUploadV1Response::VersionInfo }, api_name: :versionInfo - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # Width of the image in pixels (Only for Images) - # - # @return [Float, nil] - optional :width, Float - - # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadV1Response} for more details. - # - # Object containing details of a successful upload. - # - # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h - # - # @param custom_metadata [Object] A key-value data associated with the asset. Use `responseField` in API request t - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param embedded_metadata [Imagekit::Models::FileUploadV1Response::EmbeddedMetadata] Consolidated embedded metadata associated with the file. It includes exif, iptc, - # - # @param extension_status [Imagekit::Models::FileUploadV1Response::ExtensionStatus] Extension names with their processing status at the time of completion of the re - # - # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo - # - # @param file_path [String] The relative path of the file in the media library e.g. `/marketing-assets/new-b - # - # @param file_type [String] Type of the uploaded file. Possible values are `image`, `non-image`. - # - # @param height [Float] Height of the image in pixels (Only for images) - # - # @param is_private_file [Boolean] Is the file marked as private. It can be either `true` or `false`. Send `isPriva - # - # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen - # - # @param metadata [Imagekit::Models::FileUploadV1Response::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad - # - # @param name [String] Name of the asset. - # - # @param size [Float] Size of the image file in Bytes. - # - # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul - # - # @param thumbnail_url [String] In the case of an image, a small thumbnail URL. - # - # @param url [String] A publicly accessible URL of the file. - # - # @param version_info [Imagekit::Models::FileUploadV1Response::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Float] Width of the image in pixels (Only for Images) - - class AITag < Imagekit::Internal::Type::BaseModel - # @!attribute confidence - # Confidence score of the tag. - # - # @return [Float, nil] - optional :confidence, Float - - # @!attribute name - # Name of the tag. - # - # @return [String, nil] - optional :name, String - - # @!attribute source - # 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. - # - # @return [String, nil] - optional :source, String - - # @!method initialize(confidence: nil, name: nil, source: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadV1Response::AITag} for more details. - # - # @param confidence [Float] Confidence score of the tag. - # - # @param name [String] Name of the tag. - # - # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be - end - - # @see Imagekit::Models::FileUploadV1Response#embedded_metadata - class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel - # @!attribute about_cv_term_cv_id - # - # @return [String, nil] - optional :about_cv_term_cv_id, String, api_name: :AboutCvTermCvId - - # @!attribute about_cv_term_id - # - # @return [String, nil] - optional :about_cv_term_id, String, api_name: :AboutCvTermId - - # @!attribute about_cv_term_name - # - # @return [String, nil] - optional :about_cv_term_name, String, api_name: :AboutCvTermName - - # @!attribute about_cv_term_refined_about - # - # @return [String, nil] - optional :about_cv_term_refined_about, String, api_name: :AboutCvTermRefinedAbout - - # @!attribute additional_model_information - # - # @return [String, nil] - optional :additional_model_information, String, api_name: :AdditionalModelInformation - - # @!attribute application_record_version - # - # @return [Integer, nil] - optional :application_record_version, Integer, api_name: :ApplicationRecordVersion - - # @!attribute artist - # - # @return [String, nil] - optional :artist, String, api_name: :Artist - - # @!attribute artwork_circa_date_created - # - # @return [String, nil] - optional :artwork_circa_date_created, String, api_name: :ArtworkCircaDateCreated - - # @!attribute artwork_content_description - # - # @return [String, nil] - optional :artwork_content_description, String, api_name: :ArtworkContentDescription - - # @!attribute artwork_contribution_description - # - # @return [String, nil] - optional :artwork_contribution_description, String, api_name: :ArtworkContributionDescription - - # @!attribute artwork_copyright_notice - # - # @return [String, nil] - optional :artwork_copyright_notice, String, api_name: :ArtworkCopyrightNotice - - # @!attribute artwork_copyright_owner_id - # - # @return [String, nil] - optional :artwork_copyright_owner_id, String, api_name: :ArtworkCopyrightOwnerID - - # @!attribute artwork_copyright_owner_name - # - # @return [String, nil] - optional :artwork_copyright_owner_name, String, api_name: :ArtworkCopyrightOwnerName - - # @!attribute artwork_creator - # - # @return [Array, nil] - optional :artwork_creator, Imagekit::Internal::Type::ArrayOf[String], api_name: :ArtworkCreator - - # @!attribute artwork_creator_id - # - # @return [Array, nil] - optional :artwork_creator_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ArtworkCreatorID - - # @!attribute artwork_date_created - # - # @return [Time, nil] - optional :artwork_date_created, Time, api_name: :ArtworkDateCreated - - # @!attribute artwork_licensor_id - # - # @return [String, nil] - optional :artwork_licensor_id, String, api_name: :ArtworkLicensorID - - # @!attribute artwork_licensor_name - # - # @return [String, nil] - optional :artwork_licensor_name, String, api_name: :ArtworkLicensorName - - # @!attribute artwork_physical_description - # - # @return [String, nil] - optional :artwork_physical_description, String, api_name: :ArtworkPhysicalDescription - - # @!attribute artwork_source - # - # @return [String, nil] - optional :artwork_source, String, api_name: :ArtworkSource - - # @!attribute artwork_source_inventory_no - # - # @return [String, nil] - optional :artwork_source_inventory_no, String, api_name: :ArtworkSourceInventoryNo - - # @!attribute artwork_source_inv_url - # - # @return [String, nil] - optional :artwork_source_inv_url, String, api_name: :ArtworkSourceInvURL - - # @!attribute artwork_style_period - # - # @return [Array, nil] - optional :artwork_style_period, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ArtworkStylePeriod - - # @!attribute artwork_title - # - # @return [String, nil] - optional :artwork_title, String, api_name: :ArtworkTitle - - # @!attribute authors_position - # - # @return [String, nil] - optional :authors_position, String, api_name: :AuthorsPosition - - # @!attribute byline - # - # @return [String, nil] - optional :byline, String, api_name: :Byline - - # @!attribute byline_title - # - # @return [String, nil] - optional :byline_title, String, api_name: :BylineTitle - - # @!attribute caption - # - # @return [String, nil] - optional :caption, String, api_name: :Caption - - # @!attribute caption_abstract - # - # @return [String, nil] - optional :caption_abstract, String, api_name: :CaptionAbstract - - # @!attribute caption_writer - # - # @return [String, nil] - optional :caption_writer, String, api_name: :CaptionWriter - - # @!attribute city - # - # @return [String, nil] - optional :city, String, api_name: :City - - # @!attribute color_space - # - # @return [String, nil] - optional :color_space, String, api_name: :ColorSpace - - # @!attribute components_configuration - # - # @return [String, nil] - optional :components_configuration, String, api_name: :ComponentsConfiguration - - # @!attribute copyright - # - # @return [String, nil] - optional :copyright, String, api_name: :Copyright - - # @!attribute copyright_notice - # - # @return [String, nil] - optional :copyright_notice, String, api_name: :CopyrightNotice - - # @!attribute copyright_owner_id - # - # @return [Array, nil] - optional :copyright_owner_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :CopyrightOwnerID - - # @!attribute copyright_owner_name - # - # @return [Array, nil] - optional :copyright_owner_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :CopyrightOwnerName - - # @!attribute country - # - # @return [String, nil] - optional :country, String, api_name: :Country - - # @!attribute country_code - # - # @return [String, nil] - optional :country_code, String, api_name: :CountryCode - - # @!attribute country_primary_location_code - # - # @return [String, nil] - optional :country_primary_location_code, String, api_name: :CountryPrimaryLocationCode - - # @!attribute country_primary_location_name - # - # @return [String, nil] - optional :country_primary_location_name, String, api_name: :CountryPrimaryLocationName - - # @!attribute creator - # - # @return [String, nil] - optional :creator, String, api_name: :Creator - - # @!attribute creator_address - # - # @return [String, nil] - optional :creator_address, String, api_name: :CreatorAddress - - # @!attribute creator_city - # - # @return [String, nil] - optional :creator_city, String, api_name: :CreatorCity - - # @!attribute creator_country - # - # @return [String, nil] - optional :creator_country, String, api_name: :CreatorCountry - - # @!attribute creator_postal_code - # - # @return [String, nil] - optional :creator_postal_code, String, api_name: :CreatorPostalCode - - # @!attribute creator_region - # - # @return [String, nil] - optional :creator_region, String, api_name: :CreatorRegion - - # @!attribute creator_work_email - # - # @return [String, nil] - optional :creator_work_email, String, api_name: :CreatorWorkEmail - - # @!attribute creator_work_telephone - # - # @return [String, nil] - optional :creator_work_telephone, String, api_name: :CreatorWorkTelephone - - # @!attribute creator_work_url - # - # @return [String, nil] - optional :creator_work_url, String, api_name: :CreatorWorkURL - - # @!attribute credit - # - # @return [String, nil] - optional :credit, String, api_name: :Credit - - # @!attribute date_created - # - # @return [Time, nil] - optional :date_created, Time, api_name: :DateCreated - - # @!attribute date_time_created - # - # @return [Time, nil] - optional :date_time_created, Time, api_name: :DateTimeCreated - - # @!attribute date_time_original - # - # @return [Time, nil] - optional :date_time_original, Time, api_name: :DateTimeOriginal - - # @!attribute description - # - # @return [String, nil] - optional :description, String, api_name: :Description - - # @!attribute digital_image_guid - # - # @return [String, nil] - optional :digital_image_guid, String, api_name: :DigitalImageGUID - - # @!attribute digital_source_type - # - # @return [String, nil] - optional :digital_source_type, String, api_name: :DigitalSourceType - - # @!attribute embedded_encoded_rights_expr - # - # @return [String, nil] - optional :embedded_encoded_rights_expr, String, api_name: :EmbeddedEncodedRightsExpr - - # @!attribute embedded_encoded_rights_expr_lang_id - # - # @return [String, nil] - optional :embedded_encoded_rights_expr_lang_id, String, api_name: :EmbeddedEncodedRightsExprLangID - - # @!attribute embedded_encoded_rights_expr_type - # - # @return [String, nil] - optional :embedded_encoded_rights_expr_type, String, api_name: :EmbeddedEncodedRightsExprType - - # @!attribute event - # - # @return [String, nil] - optional :event, String, api_name: :Event - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute genre_cv_id - # - # @return [String, nil] - optional :genre_cv_id, String, api_name: :GenreCvId - - # @!attribute genre_cv_term_id - # - # @return [String, nil] - optional :genre_cv_term_id, String, api_name: :GenreCvTermId - - # @!attribute genre_cv_term_name - # - # @return [String, nil] - optional :genre_cv_term_name, String, api_name: :GenreCvTermName - - # @!attribute genre_cv_term_refined_about - # - # @return [String, nil] - optional :genre_cv_term_refined_about, String, api_name: :GenreCvTermRefinedAbout - - # @!attribute headline - # - # @return [String, nil] - optional :headline, String, api_name: :Headline - - # @!attribute image_creator_id - # - # @return [String, nil] - optional :image_creator_id, String, api_name: :ImageCreatorID - - # @!attribute image_creator_image_id - # - # @return [String, nil] - optional :image_creator_image_id, String, api_name: :ImageCreatorImageID - - # @!attribute image_creator_name - # - # @return [String, nil] - optional :image_creator_name, String, api_name: :ImageCreatorName - - # @!attribute image_description - # - # @return [String, nil] - optional :image_description, String, api_name: :ImageDescription - - # @!attribute image_region_boundary_h - # - # @return [Array, nil] - optional :image_region_boundary_h, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryH - - # @!attribute image_region_boundary_rx - # - # @return [Array, nil] - optional :image_region_boundary_rx, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryRx - - # @!attribute image_region_boundary_shape - # - # @return [Array, nil] - optional :image_region_boundary_shape, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionBoundaryShape - - # @!attribute image_region_boundary_unit - # - # @return [Array, nil] - optional :image_region_boundary_unit, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionBoundaryUnit - - # @!attribute image_region_boundary_vertices_x - # - # @return [Array, nil] - optional :image_region_boundary_vertices_x, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryVerticesX - - # @!attribute image_region_boundary_vertices_y - # - # @return [Array, nil] - optional :image_region_boundary_vertices_y, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryVerticesY - - # @!attribute image_region_boundary_w - # - # @return [Array, nil] - optional :image_region_boundary_w, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryW - - # @!attribute image_region_boundary_x - # - # @return [Array, nil] - optional :image_region_boundary_x, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryX - - # @!attribute image_region_boundary_y - # - # @return [Array, nil] - optional :image_region_boundary_y, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryY - - # @!attribute image_region_ctype_identifier - # - # @return [Array, nil] - optional :image_region_ctype_identifier, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionCtypeIdentifier - - # @!attribute image_region_ctype_name - # - # @return [Array, nil] - optional :image_region_ctype_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionCtypeName - - # @!attribute image_region_id - # - # @return [Array, nil] - optional :image_region_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ImageRegionID - - # @!attribute image_region_name - # - # @return [Array, nil] - optional :image_region_name, Imagekit::Internal::Type::ArrayOf[String], api_name: :ImageRegionName - - # @!attribute image_region_organisation_in_image_name - # - # @return [Array, nil] - optional :image_region_organisation_in_image_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionOrganisationInImageName - - # @!attribute image_region_person_in_image - # - # @return [Array, nil] - optional :image_region_person_in_image, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionPersonInImage - - # @!attribute image_region_role_identifier - # - # @return [Array, nil] - optional :image_region_role_identifier, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionRoleIdentifier - - # @!attribute image_region_role_name - # - # @return [Array, nil] - optional :image_region_role_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionRoleName - - # @!attribute image_supplier_id - # - # @return [String, nil] - optional :image_supplier_id, String, api_name: :ImageSupplierID - - # @!attribute image_supplier_image_id - # - # @return [String, nil] - optional :image_supplier_image_id, String, api_name: :ImageSupplierImageID - - # @!attribute image_supplier_name - # - # @return [String, nil] - optional :image_supplier_name, String, api_name: :ImageSupplierName - - # @!attribute instructions - # - # @return [String, nil] - optional :instructions, String, api_name: :Instructions - - # @!attribute intellectual_genre - # - # @return [String, nil] - optional :intellectual_genre, String, api_name: :IntellectualGenre - - # @!attribute keywords - # - # @return [Array, nil] - optional :keywords, Imagekit::Internal::Type::ArrayOf[String], api_name: :Keywords - - # @!attribute licensor_city - # - # @return [Array, nil] - optional :licensor_city, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorCity - - # @!attribute licensor_country - # - # @return [Array, nil] - optional :licensor_country, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorCountry - - # @!attribute licensor_email - # - # @return [Array, nil] - optional :licensor_email, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorEmail - - # @!attribute licensor_extended_address - # - # @return [Array, nil] - optional :licensor_extended_address, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorExtendedAddress - - # @!attribute licensor_id - # - # @return [Array, nil] - optional :licensor_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorID - - # @!attribute licensor_name - # - # @return [Array, nil] - optional :licensor_name, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorName - - # @!attribute licensor_postal_code - # - # @return [Array, nil] - optional :licensor_postal_code, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorPostalCode - - # @!attribute licensor_region - # - # @return [Array, nil] - optional :licensor_region, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorRegion - - # @!attribute licensor_street_address - # - # @return [Array, nil] - optional :licensor_street_address, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorStreetAddress - - # @!attribute licensor_telephone1 - # - # @return [Array, nil] - optional :licensor_telephone1, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorTelephone1 - - # @!attribute licensor_telephone2 - # - # @return [Array, nil] - optional :licensor_telephone2, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorTelephone2 - - # @!attribute licensor_url - # - # @return [Array, nil] - optional :licensor_url, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorURL - - # @!attribute linked_encoded_rights_expr - # - # @return [String, nil] - optional :linked_encoded_rights_expr, String, api_name: :LinkedEncodedRightsExpr - - # @!attribute linked_encoded_rights_expr_lang_id - # - # @return [String, nil] - optional :linked_encoded_rights_expr_lang_id, String, api_name: :LinkedEncodedRightsExprLangID - - # @!attribute linked_encoded_rights_expr_type - # - # @return [String, nil] - optional :linked_encoded_rights_expr_type, String, api_name: :LinkedEncodedRightsExprType - - # @!attribute location - # - # @return [String, nil] - optional :location, String, api_name: :Location - - # @!attribute location_created_city - # - # @return [String, nil] - optional :location_created_city, String, api_name: :LocationCreatedCity - - # @!attribute location_created_country_code - # - # @return [String, nil] - optional :location_created_country_code, String, api_name: :LocationCreatedCountryCode - - # @!attribute location_created_country_name - # - # @return [String, nil] - optional :location_created_country_name, String, api_name: :LocationCreatedCountryName - - # @!attribute location_created_gps_altitude - # - # @return [String, nil] - optional :location_created_gps_altitude, String, api_name: :LocationCreatedGPSAltitude - - # @!attribute location_created_gps_latitude - # - # @return [String, nil] - optional :location_created_gps_latitude, String, api_name: :LocationCreatedGPSLatitude - - # @!attribute location_created_gps_longitude - # - # @return [String, nil] - optional :location_created_gps_longitude, String, api_name: :LocationCreatedGPSLongitude - - # @!attribute location_created_location_id - # - # @return [String, nil] - optional :location_created_location_id, String, api_name: :LocationCreatedLocationId - - # @!attribute location_created_location_name - # - # @return [String, nil] - optional :location_created_location_name, String, api_name: :LocationCreatedLocationName - - # @!attribute location_created_province_state - # - # @return [String, nil] - optional :location_created_province_state, String, api_name: :LocationCreatedProvinceState - - # @!attribute location_created_sublocation - # - # @return [String, nil] - optional :location_created_sublocation, String, api_name: :LocationCreatedSublocation - - # @!attribute location_created_world_region - # - # @return [String, nil] - optional :location_created_world_region, String, api_name: :LocationCreatedWorldRegion - - # @!attribute location_shown_city - # - # @return [Array, nil] - optional :location_shown_city, Imagekit::Internal::Type::ArrayOf[String], api_name: :LocationShownCity - - # @!attribute location_shown_country_code - # - # @return [Array, nil] - optional :location_shown_country_code, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownCountryCode - - # @!attribute location_shown_country_name - # - # @return [Array, nil] - optional :location_shown_country_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownCountryName - - # @!attribute location_shown_gps_altitude - # - # @return [Array, nil] - optional :location_shown_gps_altitude, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownGPSAltitude - - # @!attribute location_shown_gps_latitude - # - # @return [Array, nil] - optional :location_shown_gps_latitude, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownGPSLatitude - - # @!attribute location_shown_gps_longitude - # - # @return [Array, nil] - optional :location_shown_gps_longitude, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownGPSLongitude - - # @!attribute location_shown_location_id - # - # @return [Array, nil] - optional :location_shown_location_id, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownLocationId - - # @!attribute location_shown_location_name - # - # @return [Array, nil] - optional :location_shown_location_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownLocationName - - # @!attribute location_shown_province_state - # - # @return [Array, nil] - optional :location_shown_province_state, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownProvinceState - - # @!attribute location_shown_sublocation - # - # @return [Array, nil] - optional :location_shown_sublocation, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownSublocation - - # @!attribute location_shown_world_region - # - # @return [Array, nil] - optional :location_shown_world_region, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownWorldRegion - - # @!attribute max_avail_height - # - # @return [Float, nil] - optional :max_avail_height, Float, api_name: :MaxAvailHeight - - # @!attribute max_avail_width - # - # @return [Float, nil] - optional :max_avail_width, Float, api_name: :MaxAvailWidth - - # @!attribute model_age - # - # @return [Array, nil] - optional :model_age, Imagekit::Internal::Type::ArrayOf[Float], api_name: :ModelAge - - # @!attribute model_release_id - # - # @return [Array, nil] - optional :model_release_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ModelReleaseID - - # @!attribute object_attribute_reference - # - # @return [String, nil] - optional :object_attribute_reference, String, api_name: :ObjectAttributeReference - - # @!attribute object_name - # - # @return [String, nil] - optional :object_name, String, api_name: :ObjectName - - # @!attribute offset_time_original - # - # @return [String, nil] - optional :offset_time_original, String, api_name: :OffsetTimeOriginal - - # @!attribute organisation_in_image_code - # - # @return [Array, nil] - optional :organisation_in_image_code, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :OrganisationInImageCode - - # @!attribute organisation_in_image_name - # - # @return [Array, nil] - optional :organisation_in_image_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :OrganisationInImageName - - # @!attribute orientation - # - # @return [String, nil] - optional :orientation, String, api_name: :Orientation - - # @!attribute original_transmission_reference - # - # @return [String, nil] - optional :original_transmission_reference, String, api_name: :OriginalTransmissionReference - - # @!attribute person_in_image - # - # @return [Array, nil] - optional :person_in_image, Imagekit::Internal::Type::ArrayOf[String], api_name: :PersonInImage - - # @!attribute person_in_image_cv_term_cv_id - # - # @return [Array, nil] - optional :person_in_image_cv_term_cv_id, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageCvTermCvId - - # @!attribute person_in_image_cv_term_id - # - # @return [Array, nil] - optional :person_in_image_cv_term_id, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageCvTermId - - # @!attribute person_in_image_cv_term_name - # - # @return [Array, nil] - optional :person_in_image_cv_term_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageCvTermName - - # @!attribute person_in_image_cv_term_refined_about - # - # @return [Array, nil] - optional :person_in_image_cv_term_refined_about, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageCvTermRefinedAbout - - # @!attribute person_in_image_description - # - # @return [Array, nil] - optional :person_in_image_description, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageDescription - - # @!attribute person_in_image_id - # - # @return [Array, nil] - optional :person_in_image_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :PersonInImageId - - # @!attribute person_in_image_name - # - # @return [Array, nil] - optional :person_in_image_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageName - - # @!attribute product_in_image_description - # - # @return [Array, nil] - optional :product_in_image_description, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ProductInImageDescription - - # @!attribute product_in_image_gtin - # - # @return [Array, nil] - optional :product_in_image_gtin, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ProductInImageGTIN - - # @!attribute product_in_image_name - # - # @return [Array, nil] - optional :product_in_image_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ProductInImageName - - # @!attribute property_release_id - # - # @return [Array, nil] - optional :property_release_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :PropertyReleaseID - - # @!attribute province_state - # - # @return [String, nil] - optional :province_state, String, api_name: :ProvinceState - - # @!attribute rating - # - # @return [Integer, nil] - optional :rating, Integer, api_name: :Rating - - # @!attribute registry_entry_role - # - # @return [Array, nil] - optional :registry_entry_role, Imagekit::Internal::Type::ArrayOf[String], api_name: :RegistryEntryRole - - # @!attribute registry_item_id - # - # @return [Array, nil] - optional :registry_item_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :RegistryItemID - - # @!attribute registry_organisation_id - # - # @return [Array, nil] - optional :registry_organisation_id, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :RegistryOrganisationID - - # @!attribute resolution_unit - # - # @return [String, nil] - optional :resolution_unit, String, api_name: :ResolutionUnit - - # @!attribute rights - # - # @return [String, nil] - optional :rights, String, api_name: :Rights - - # @!attribute scene - # - # @return [Array, nil] - optional :scene, Imagekit::Internal::Type::ArrayOf[String], api_name: :Scene - - # @!attribute source - # - # @return [String, nil] - optional :source, String, api_name: :Source - - # @!attribute special_instructions - # - # @return [String, nil] - optional :special_instructions, String, api_name: :SpecialInstructions - - # @!attribute state - # - # @return [String, nil] - optional :state, String, api_name: :State - - # @!attribute subject - # - # @return [Array, nil] - optional :subject, Imagekit::Internal::Type::ArrayOf[String], api_name: :Subject - - # @!attribute subject_code - # - # @return [Array, nil] - optional :subject_code, Imagekit::Internal::Type::ArrayOf[String], api_name: :SubjectCode - - # @!attribute subject_reference - # - # @return [Array, nil] - optional :subject_reference, Imagekit::Internal::Type::ArrayOf[String], api_name: :SubjectReference - - # @!attribute sublocation - # - # @return [String, nil] - optional :sublocation, String, api_name: :Sublocation - - # @!attribute time_created - # - # @return [String, nil] - optional :time_created, String, api_name: :TimeCreated - - # @!attribute title - # - # @return [String, nil] - optional :title, String, api_name: :Title - - # @!attribute transmission_reference - # - # @return [String, nil] - optional :transmission_reference, String, api_name: :TransmissionReference - - # @!attribute usage_terms - # - # @return [String, nil] - optional :usage_terms, String, api_name: :UsageTerms - - # @!attribute web_statement - # - # @return [String, nil] - optional :web_statement, String, api_name: :WebStatement - - # @!attribute writer - # - # @return [String, nil] - optional :writer, String, api_name: :Writer - - # @!attribute writer_editor - # - # @return [String, nil] - optional :writer_editor, String, api_name: :WriterEditor - - # @!attribute x_resolution - # - # @return [Float, nil] - optional :x_resolution, Float, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Float, nil] - optional :y_resolution, Float, api_name: :YResolution - - # @!method initialize(about_cv_term_cv_id: nil, about_cv_term_id: nil, about_cv_term_name: nil, about_cv_term_refined_about: nil, additional_model_information: nil, application_record_version: nil, artist: nil, artwork_circa_date_created: nil, artwork_content_description: nil, artwork_contribution_description: nil, artwork_copyright_notice: nil, artwork_copyright_owner_id: nil, artwork_copyright_owner_name: nil, artwork_creator: nil, artwork_creator_id: nil, artwork_date_created: nil, artwork_licensor_id: nil, artwork_licensor_name: nil, artwork_physical_description: nil, artwork_source: nil, artwork_source_inventory_no: nil, artwork_source_inv_url: nil, artwork_style_period: nil, artwork_title: nil, authors_position: nil, byline: nil, byline_title: nil, caption: nil, caption_abstract: nil, caption_writer: nil, city: nil, color_space: nil, components_configuration: nil, copyright: nil, copyright_notice: nil, copyright_owner_id: nil, copyright_owner_name: nil, country: nil, country_code: nil, country_primary_location_code: nil, country_primary_location_name: nil, creator: nil, creator_address: nil, creator_city: nil, creator_country: nil, creator_postal_code: nil, creator_region: nil, creator_work_email: nil, creator_work_telephone: nil, creator_work_url: nil, credit: nil, date_created: nil, date_time_created: nil, date_time_original: nil, description: nil, digital_image_guid: nil, digital_source_type: nil, embedded_encoded_rights_expr: nil, embedded_encoded_rights_expr_lang_id: nil, embedded_encoded_rights_expr_type: nil, event: nil, exif_version: nil, flashpix_version: nil, genre_cv_id: nil, genre_cv_term_id: nil, genre_cv_term_name: nil, genre_cv_term_refined_about: nil, headline: nil, image_creator_id: nil, image_creator_image_id: nil, image_creator_name: nil, image_description: nil, image_region_boundary_h: nil, image_region_boundary_rx: nil, image_region_boundary_shape: nil, image_region_boundary_unit: nil, image_region_boundary_vertices_x: nil, image_region_boundary_vertices_y: nil, image_region_boundary_w: nil, image_region_boundary_x: nil, image_region_boundary_y: nil, image_region_ctype_identifier: nil, image_region_ctype_name: nil, image_region_id: nil, image_region_name: nil, image_region_organisation_in_image_name: nil, image_region_person_in_image: nil, image_region_role_identifier: nil, image_region_role_name: nil, image_supplier_id: nil, image_supplier_image_id: nil, image_supplier_name: nil, instructions: nil, intellectual_genre: nil, keywords: nil, licensor_city: nil, licensor_country: nil, licensor_email: nil, licensor_extended_address: nil, licensor_id: nil, licensor_name: nil, licensor_postal_code: nil, licensor_region: nil, licensor_street_address: nil, licensor_telephone1: nil, licensor_telephone2: nil, licensor_url: nil, linked_encoded_rights_expr: nil, linked_encoded_rights_expr_lang_id: nil, linked_encoded_rights_expr_type: nil, location: nil, location_created_city: nil, location_created_country_code: nil, location_created_country_name: nil, location_created_gps_altitude: nil, location_created_gps_latitude: nil, location_created_gps_longitude: nil, location_created_location_id: nil, location_created_location_name: nil, location_created_province_state: nil, location_created_sublocation: nil, location_created_world_region: nil, location_shown_city: nil, location_shown_country_code: nil, location_shown_country_name: nil, location_shown_gps_altitude: nil, location_shown_gps_latitude: nil, location_shown_gps_longitude: nil, location_shown_location_id: nil, location_shown_location_name: nil, location_shown_province_state: nil, location_shown_sublocation: nil, location_shown_world_region: nil, max_avail_height: nil, max_avail_width: nil, model_age: nil, model_release_id: nil, object_attribute_reference: nil, object_name: nil, offset_time_original: nil, organisation_in_image_code: nil, organisation_in_image_name: nil, orientation: nil, original_transmission_reference: nil, person_in_image: nil, person_in_image_cv_term_cv_id: nil, person_in_image_cv_term_id: nil, person_in_image_cv_term_name: nil, person_in_image_cv_term_refined_about: nil, person_in_image_description: nil, person_in_image_id: nil, person_in_image_name: nil, product_in_image_description: nil, product_in_image_gtin: nil, product_in_image_name: nil, property_release_id: nil, province_state: nil, rating: nil, registry_entry_role: nil, registry_item_id: nil, registry_organisation_id: nil, resolution_unit: nil, rights: nil, scene: nil, source: nil, special_instructions: nil, state: nil, subject: nil, subject_code: nil, subject_reference: nil, sublocation: nil, time_created: nil, title: nil, transmission_reference: nil, usage_terms: nil, web_statement: nil, writer: nil, writer_editor: nil, x_resolution: nil, y_resolution: nil) - # 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 about_cv_term_cv_id [String] - # @param about_cv_term_id [String] - # @param about_cv_term_name [String] - # @param about_cv_term_refined_about [String] - # @param additional_model_information [String] - # @param application_record_version [Integer] - # @param artist [String] - # @param artwork_circa_date_created [String] - # @param artwork_content_description [String] - # @param artwork_contribution_description [String] - # @param artwork_copyright_notice [String] - # @param artwork_copyright_owner_id [String] - # @param artwork_copyright_owner_name [String] - # @param artwork_creator [Array] - # @param artwork_creator_id [Array] - # @param artwork_date_created [Time] - # @param artwork_licensor_id [String] - # @param artwork_licensor_name [String] - # @param artwork_physical_description [String] - # @param artwork_source [String] - # @param artwork_source_inventory_no [String] - # @param artwork_source_inv_url [String] - # @param artwork_style_period [Array] - # @param artwork_title [String] - # @param authors_position [String] - # @param byline [String] - # @param byline_title [String] - # @param caption [String] - # @param caption_abstract [String] - # @param caption_writer [String] - # @param city [String] - # @param color_space [String] - # @param components_configuration [String] - # @param copyright [String] - # @param copyright_notice [String] - # @param copyright_owner_id [Array] - # @param copyright_owner_name [Array] - # @param country [String] - # @param country_code [String] - # @param country_primary_location_code [String] - # @param country_primary_location_name [String] - # @param creator [String] - # @param creator_address [String] - # @param creator_city [String] - # @param creator_country [String] - # @param creator_postal_code [String] - # @param creator_region [String] - # @param creator_work_email [String] - # @param creator_work_telephone [String] - # @param creator_work_url [String] - # @param credit [String] - # @param date_created [Time] - # @param date_time_created [Time] - # @param date_time_original [Time] - # @param description [String] - # @param digital_image_guid [String] - # @param digital_source_type [String] - # @param embedded_encoded_rights_expr [String] - # @param embedded_encoded_rights_expr_lang_id [String] - # @param embedded_encoded_rights_expr_type [String] - # @param event [String] - # @param exif_version [String] - # @param flashpix_version [String] - # @param genre_cv_id [String] - # @param genre_cv_term_id [String] - # @param genre_cv_term_name [String] - # @param genre_cv_term_refined_about [String] - # @param headline [String] - # @param image_creator_id [String] - # @param image_creator_image_id [String] - # @param image_creator_name [String] - # @param image_description [String] - # @param image_region_boundary_h [Array] - # @param image_region_boundary_rx [Array] - # @param image_region_boundary_shape [Array] - # @param image_region_boundary_unit [Array] - # @param image_region_boundary_vertices_x [Array] - # @param image_region_boundary_vertices_y [Array] - # @param image_region_boundary_w [Array] - # @param image_region_boundary_x [Array] - # @param image_region_boundary_y [Array] - # @param image_region_ctype_identifier [Array] - # @param image_region_ctype_name [Array] - # @param image_region_id [Array] - # @param image_region_name [Array] - # @param image_region_organisation_in_image_name [Array] - # @param image_region_person_in_image [Array] - # @param image_region_role_identifier [Array] - # @param image_region_role_name [Array] - # @param image_supplier_id [String] - # @param image_supplier_image_id [String] - # @param image_supplier_name [String] - # @param instructions [String] - # @param intellectual_genre [String] - # @param keywords [Array] - # @param licensor_city [Array] - # @param licensor_country [Array] - # @param licensor_email [Array] - # @param licensor_extended_address [Array] - # @param licensor_id [Array] - # @param licensor_name [Array] - # @param licensor_postal_code [Array] - # @param licensor_region [Array] - # @param licensor_street_address [Array] - # @param licensor_telephone1 [Array] - # @param licensor_telephone2 [Array] - # @param licensor_url [Array] - # @param linked_encoded_rights_expr [String] - # @param linked_encoded_rights_expr_lang_id [String] - # @param linked_encoded_rights_expr_type [String] - # @param location [String] - # @param location_created_city [String] - # @param location_created_country_code [String] - # @param location_created_country_name [String] - # @param location_created_gps_altitude [String] - # @param location_created_gps_latitude [String] - # @param location_created_gps_longitude [String] - # @param location_created_location_id [String] - # @param location_created_location_name [String] - # @param location_created_province_state [String] - # @param location_created_sublocation [String] - # @param location_created_world_region [String] - # @param location_shown_city [Array] - # @param location_shown_country_code [Array] - # @param location_shown_country_name [Array] - # @param location_shown_gps_altitude [Array] - # @param location_shown_gps_latitude [Array] - # @param location_shown_gps_longitude [Array] - # @param location_shown_location_id [Array] - # @param location_shown_location_name [Array] - # @param location_shown_province_state [Array] - # @param location_shown_sublocation [Array] - # @param location_shown_world_region [Array] - # @param max_avail_height [Float] - # @param max_avail_width [Float] - # @param model_age [Array] - # @param model_release_id [Array] - # @param object_attribute_reference [String] - # @param object_name [String] - # @param offset_time_original [String] - # @param organisation_in_image_code [Array] - # @param organisation_in_image_name [Array] - # @param orientation [String] - # @param original_transmission_reference [String] - # @param person_in_image [Array] - # @param person_in_image_cv_term_cv_id [Array] - # @param person_in_image_cv_term_id [Array] - # @param person_in_image_cv_term_name [Array] - # @param person_in_image_cv_term_refined_about [Array] - # @param person_in_image_description [Array] - # @param person_in_image_id [Array] - # @param person_in_image_name [Array] - # @param product_in_image_description [Array] - # @param product_in_image_gtin [Array] - # @param product_in_image_name [Array] - # @param property_release_id [Array] - # @param province_state [String] - # @param rating [Integer] - # @param registry_entry_role [Array] - # @param registry_item_id [Array] - # @param registry_organisation_id [Array] - # @param resolution_unit [String] - # @param rights [String] - # @param scene [Array] - # @param source [String] - # @param special_instructions [String] - # @param state [String] - # @param subject [Array] - # @param subject_code [Array] - # @param subject_reference [Array] - # @param sublocation [String] - # @param time_created [String] - # @param title [String] - # @param transmission_reference [String] - # @param usage_terms [String] - # @param web_statement [String] - # @param writer [String] - # @param writer_editor [String] - # @param x_resolution [Float] - # @param y_resolution [Float] - end - - # @see Imagekit::Models::FileUploadV1Response#extension_status - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - # @!attribute aws_auto_tagging - # - # @return [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging, nil] - optional :aws_auto_tagging, - enum: -> { Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging }, - api_name: :"aws-auto-tagging" - - # @!attribute google_auto_tagging - # - # @return [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging, nil] - optional :google_auto_tagging, - enum: -> { Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging }, - api_name: :"google-auto-tagging" - - # @!attribute remove_bg - # - # @return [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg, nil] - optional :remove_bg, - enum: -> { Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg }, - api_name: :"remove-bg" - - # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) - # 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. - # - # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging] - # @param google_auto_tagging [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging] - # @param remove_bg [Symbol, Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg] - - # @see Imagekit::Models::FileUploadV1Response::ExtensionStatus#aws_auto_tagging - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUploadV1Response::ExtensionStatus#google_auto_tagging - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUploadV1Response::ExtensionStatus#remove_bg - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - end - - # @see Imagekit::Models::FileUploadV1Response#metadata - class Metadata < Imagekit::Internal::Type::BaseModel - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute density - # The density of the image in DPI. - # - # @return [Integer, nil] - optional :density, Integer - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute exif - # - # @return [Imagekit::Models::FileUploadV1Response::Metadata::Exif, nil] - optional :exif, -> { Imagekit::Models::FileUploadV1Response::Metadata::Exif } - - # @!attribute format_ - # The format of the file (e.g., 'jpg', 'mp4'). - # - # @return [String, nil] - optional :format_, String, api_name: :format - - # @!attribute has_color_profile - # Indicates if the image has a color profile. - # - # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile - - # @!attribute has_transparency - # Indicates if the image contains transparent areas. - # - # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency - - # @!attribute height - # The height of the image or video in pixels. - # - # @return [Integer, nil] - optional :height, Integer - - # @!attribute p_hash - # Perceptual hash of the image. - # - # @return [String, nil] - optional :p_hash, String, api_name: :pHash - - # @!attribute quality - # The quality indicator of the image. - # - # @return [Integer, nil] - optional :quality, Integer - - # @!attribute size - # The file size in bytes. - # - # @return [Integer, nil] - optional :size, Integer - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # The width of the image or video in pixels. - # - # @return [Integer, nil] - optional :width, Integer - - # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param density [Integer] The density of the image in DPI. - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param exif [Imagekit::Models::FileUploadV1Response::Metadata::Exif] - # - # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). - # - # @param has_color_profile [Boolean] Indicates if the image has a color profile. - # - # @param has_transparency [Boolean] Indicates if the image contains transparent areas. - # - # @param height [Integer] The height of the image or video in pixels. - # - # @param p_hash [String] Perceptual hash of the image. - # - # @param quality [Integer] The quality indicator of the image. - # - # @param size [Integer] The file size in bytes. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Integer] The width of the image or video in pixels. - - # @see Imagekit::Models::FileUploadV1Response::Metadata#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute exif - # Object containing Exif details. - # - # @return [Imagekit::Models::ExifDetails, nil] - optional :exif, -> { Imagekit::ExifDetails } - - # @!attribute gps - # Object containing GPS information. - # - # @return [Imagekit::Models::Gps, nil] - optional :gps, -> { Imagekit::Gps } - - # @!attribute image - # Object containing EXIF image information. - # - # @return [Imagekit::Models::ExifImage, nil] - optional :image, -> { Imagekit::ExifImage } - - # @!attribute interoperability - # JSON object. - # - # @return [Imagekit::Models::Interoperability, nil] - optional :interoperability, -> { Imagekit::Interoperability } - - # @!attribute makernote - # - # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] - - # @!attribute thumbnail - # Object containing Thumbnail information. - # - # @return [Imagekit::Models::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Thumbnail } - - # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. - # - # @param gps [Imagekit::Models::Gps] Object containing GPS information. - # - # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. - # - # @param interoperability [Imagekit::Models::Interoperability] JSON object. - # - # @param makernote [Hash{Symbol=>Object}] - # - # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. - end - end - - # @see Imagekit::Models::FileUploadV1Response#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier of the file version. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # Name of the file version. - # - # @return [String, nil] - optional :name, String - - # @!method initialize(id: nil, name: nil) - # An object containing the file or file version's `id` (versionId) and `name`. - # - # @param id [String] Unique identifier of the file version. - # - # @param name [String] Name of the file version. - end - end - end -end diff --git a/lib/imagekit/models/file_upload_v2_params.rb b/lib/imagekit/models/file_upload_v2_params.rb deleted file mode 100644 index c31f2809..00000000 --- a/lib/imagekit/models/file_upload_v2_params.rb +++ /dev/null @@ -1,345 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#upload_v2 - class FileUploadV2Params < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file - # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, - # please ensure that our servers can access the URL. In case ImageKit is unable to - # download the file from the specified URL, a `400` error response is returned. - # This will also result in a `400` error if the file download request is aborted - # if response headers are not received in 8 seconds. - # - # @return [String] - required :file, String - - # @!attribute file_name - # The name with which the file has to be uploaded. - # - # @return [String] - required :file_name, String, api_name: :fileName - - # @!attribute token - # 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. - # - # @return [String, nil] - optional :token, String - - # @!attribute checks - # 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). - # - # @return [String, nil] - optional :checks, String - - # @!attribute custom_coordinates - # 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. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates - - # @!attribute custom_metadata - # Stringified JSON key-value data to be associated with the asset. - # - # @return [String, nil] - optional :custom_metadata, String, api_name: :customMetadata - - # @!attribute extensions - # Stringified JSON object with an array of extensions to be applied to the image. - # Refer to extensions schema in - # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). - # - # @return [String, nil] - optional :extensions, String - - # @!attribute 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. - # - # @return [String, nil] - optional :folder, String - - # @!attribute is_private_file - # 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. - # - # @return [Symbol, Imagekit::Models::FileUploadV2Params::IsPrivateFile, nil] - optional :is_private_file, - enum: -> { Imagekit::FileUploadV2Params::IsPrivateFile }, - api_name: :isPrivateFile - - # @!attribute is_published - # 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. - # - # @return [Symbol, Imagekit::Models::FileUploadV2Params::IsPublished, nil] - optional :is_published, enum: -> { Imagekit::FileUploadV2Params::IsPublished }, api_name: :isPublished - - # @!attribute overwrite_ai_tags - # 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. - # - # @return [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteAITags, nil] - optional :overwrite_ai_tags, - enum: -> { Imagekit::FileUploadV2Params::OverwriteAITags }, - api_name: :overwriteAITags - - # @!attribute overwrite_custom_metadata - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - # - # @return [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteCustomMetadata, nil] - optional :overwrite_custom_metadata, - enum: -> { Imagekit::FileUploadV2Params::OverwriteCustomMetadata }, - api_name: :overwriteCustomMetadata - - # @!attribute overwrite_file - # If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # the exact location, upload API will return an error immediately. - # - # @return [String, nil] - optional :overwrite_file, String, api_name: :overwriteFile - - # @!attribute overwrite_tags - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - # - # @return [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteTags, nil] - optional :overwrite_tags, - enum: -> { Imagekit::FileUploadV2Params::OverwriteTags }, - api_name: :overwriteTags - - # @!attribute response_fields - # Comma-separated values of the fields that you want the API to return in the - # response. - # - # For example, set the value of this field to - # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, - # `customCoordinates`, and `isPrivateFile` in the response. - # - # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, - # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. - # - # @return [String, nil] - optional :response_fields, String, api_name: :responseFields - - # @!attribute tags - # Set the tags while uploading the file. - # - # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length - # of all characters should not exceed 500. `%` is not allowed. - # - # If this field is not specified and the file is overwritten then the tags will be - # removed. - # - # @return [String, nil] - optional :tags, String - - # @!attribute transformation - # Stringified JSON object with properties for pre and post transformations: - # - # `pre` - Accepts a "string" containing a valid transformation used for requesting - # a pre-transformation for an image or a video file. - # - # `post` - Accepts an array of objects with properties: - # - # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` - # (Adaptive bitrate streaming). - # - `value`: A "string" corresponding to the required transformation. Required if - # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or - # `thumbnail`. - # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. - # - # Read more about - # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). - # - # @return [String, nil] - optional :transformation, String - - # @!attribute use_unique_file_name - # 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. - # - # @return [Symbol, Imagekit::Models::FileUploadV2Params::UseUniqueFileName, nil] - optional :use_unique_file_name, - enum: -> { Imagekit::FileUploadV2Params::UseUniqueFileName }, - api_name: :useUniqueFileName - - # @!attribute webhook_url - # 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 [String, nil] - optional :webhook_url, String, api_name: :webhookUrl - - # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadV2Params} for more details. - # - # @param file [String] Pass the HTTP URL or base64 string. When passing a URL in the file parameter, pl - # - # @param file_name [String] The name with which the file has to be uploaded. - # - # @param token [String] This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses i - # - # @param checks [String] Server-side checks to run on the asset. - # - # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file - # - # @param custom_metadata [String] Stringified JSON key-value data to be associated with the asset. - # - # @param extensions [String] Stringified JSON object with an array of extensions to be applied to the image. - # - # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e - # - # @param is_private_file [Symbol, Imagekit::Models::FileUploadV2Params::IsPrivateFile] Whether to mark the file as private or not. - # - # @param is_published [Symbol, Imagekit::Models::FileUploadV2Params::IsPublished] Whether to upload file as published or not. - # - # @param overwrite_ai_tags [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteAITags] If set to `true` and a file already exists at the exact location, its AITags wil - # - # @param overwrite_custom_metadata [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteCustomMetadata] If the request does not have `customMetadata`, and a file already exists at the - # - # @param overwrite_file [String] If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # - # @param overwrite_tags [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteTags] If the request does not have `tags`, and a file already exists at the exact loca - # - # @param response_fields [String] Comma-separated values of the fields that you want the API to return in the resp - # - # @param tags [String] Set the tags while uploading the file. - # - # @param transformation [String] Stringified JSON object with properties for pre and post transformations: - # - # @param use_unique_file_name [Symbol, Imagekit::Models::FileUploadV2Params::UseUniqueFileName] Whether to use a unique filename for this file or not. - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # 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. - module IsPrivateFile - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # 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. - module IsPublished - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # 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. - module OverwriteAITags - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - module OverwriteCustomMetadata - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - module OverwriteTags - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # 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. - module UseUniqueFileName - extend Imagekit::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/imagekit/models/file_upload_v2_response.rb b/lib/imagekit/models/file_upload_v2_response.rb deleted file mode 100644 index 2c406801..00000000 --- a/lib/imagekit/models/file_upload_v2_response.rb +++ /dev/null @@ -1,1706 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#upload_v2 - class FileUploadV2Response < Imagekit::Internal::Type::BaseModel - # @!attribute ai_tags - # An array of tags assigned to the uploaded file by auto tagging. - # - # @return [Array, nil] - optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadV2Response::AITag] }, - api_name: :AITags, - nil?: true - - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute custom_coordinates - # 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. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # 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. - # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute embedded_metadata - # 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. - # - # @return [Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, nil] - optional :embedded_metadata, - -> { Imagekit::Models::FileUploadV2Response::EmbeddedMetadata }, - api_name: :embeddedMetadata - - # @!attribute extension_status - # 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. - # - # @return [Imagekit::Models::FileUploadV2Response::ExtensionStatus, nil] - optional :extension_status, - -> { Imagekit::Models::FileUploadV2Response::ExtensionStatus }, - api_name: :extensionStatus - - # @!attribute file_id - # Unique fileId. Store this fileld in your database, as this will be used to - # perform update action on this file. - # - # @return [String, nil] - optional :file_id, String, api_name: :fileId - - # @!attribute file_path - # The relative path of the file in the media library e.g. - # `/marketing-assets/new-banner.jpg`. - # - # @return [String, nil] - optional :file_path, String, api_name: :filePath - - # @!attribute file_type - # Type of the uploaded file. Possible values are `image`, `non-image`. - # - # @return [String, nil] - optional :file_type, String, api_name: :fileType - - # @!attribute height - # Height of the image in pixels (Only for images) - # - # @return [Float, nil] - optional :height, Float - - # @!attribute is_private_file - # 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. - # - # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile - - # @!attribute is_published - # 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. - # - # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute metadata - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - # - # @return [Imagekit::Models::FileUploadV2Response::Metadata, nil] - optional :metadata, -> { Imagekit::Models::FileUploadV2Response::Metadata } - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute size - # Size of the image file in Bytes. - # - # @return [Float, nil] - optional :size, Float - - # @!attribute tags - # 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. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute thumbnail_url - # In the case of an image, a small thumbnail URL. - # - # @return [String, nil] - optional :thumbnail_url, String, api_name: :thumbnailUrl - - # @!attribute url - # A publicly accessible URL of the file. - # - # @return [String, nil] - optional :url, String - - # @!attribute version_info - # An object containing the file or file version's `id` (versionId) and `name`. - # - # @return [Imagekit::Models::FileUploadV2Response::VersionInfo, nil] - optional :version_info, -> { Imagekit::Models::FileUploadV2Response::VersionInfo }, api_name: :versionInfo - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # Width of the image in pixels (Only for Images) - # - # @return [Float, nil] - optional :width, Float - - # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadV2Response} for more details. - # - # Object containing details of a successful upload. - # - # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h - # - # @param custom_metadata [Object] A key-value data associated with the asset. Use `responseField` in API request t - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param embedded_metadata [Imagekit::Models::FileUploadV2Response::EmbeddedMetadata] Consolidated embedded metadata associated with the file. It includes exif, iptc, - # - # @param extension_status [Imagekit::Models::FileUploadV2Response::ExtensionStatus] Extension names with their processing status at the time of completion of the re - # - # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo - # - # @param file_path [String] The relative path of the file in the media library e.g. `/marketing-assets/new-b - # - # @param file_type [String] Type of the uploaded file. Possible values are `image`, `non-image`. - # - # @param height [Float] Height of the image in pixels (Only for images) - # - # @param is_private_file [Boolean] Is the file marked as private. It can be either `true` or `false`. Send `isPriva - # - # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen - # - # @param metadata [Imagekit::Models::FileUploadV2Response::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad - # - # @param name [String] Name of the asset. - # - # @param size [Float] Size of the image file in Bytes. - # - # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul - # - # @param thumbnail_url [String] In the case of an image, a small thumbnail URL. - # - # @param url [String] A publicly accessible URL of the file. - # - # @param version_info [Imagekit::Models::FileUploadV2Response::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Float] Width of the image in pixels (Only for Images) - - class AITag < Imagekit::Internal::Type::BaseModel - # @!attribute confidence - # Confidence score of the tag. - # - # @return [Float, nil] - optional :confidence, Float - - # @!attribute name - # Name of the tag. - # - # @return [String, nil] - optional :name, String - - # @!attribute source - # 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. - # - # @return [String, nil] - optional :source, String - - # @!method initialize(confidence: nil, name: nil, source: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadV2Response::AITag} for more details. - # - # @param confidence [Float] Confidence score of the tag. - # - # @param name [String] Name of the tag. - # - # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be - end - - # @see Imagekit::Models::FileUploadV2Response#embedded_metadata - class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel - # @!attribute about_cv_term_cv_id - # - # @return [String, nil] - optional :about_cv_term_cv_id, String, api_name: :AboutCvTermCvId - - # @!attribute about_cv_term_id - # - # @return [String, nil] - optional :about_cv_term_id, String, api_name: :AboutCvTermId - - # @!attribute about_cv_term_name - # - # @return [String, nil] - optional :about_cv_term_name, String, api_name: :AboutCvTermName - - # @!attribute about_cv_term_refined_about - # - # @return [String, nil] - optional :about_cv_term_refined_about, String, api_name: :AboutCvTermRefinedAbout - - # @!attribute additional_model_information - # - # @return [String, nil] - optional :additional_model_information, String, api_name: :AdditionalModelInformation - - # @!attribute application_record_version - # - # @return [Integer, nil] - optional :application_record_version, Integer, api_name: :ApplicationRecordVersion - - # @!attribute artist - # - # @return [String, nil] - optional :artist, String, api_name: :Artist - - # @!attribute artwork_circa_date_created - # - # @return [String, nil] - optional :artwork_circa_date_created, String, api_name: :ArtworkCircaDateCreated - - # @!attribute artwork_content_description - # - # @return [String, nil] - optional :artwork_content_description, String, api_name: :ArtworkContentDescription - - # @!attribute artwork_contribution_description - # - # @return [String, nil] - optional :artwork_contribution_description, String, api_name: :ArtworkContributionDescription - - # @!attribute artwork_copyright_notice - # - # @return [String, nil] - optional :artwork_copyright_notice, String, api_name: :ArtworkCopyrightNotice - - # @!attribute artwork_copyright_owner_id - # - # @return [String, nil] - optional :artwork_copyright_owner_id, String, api_name: :ArtworkCopyrightOwnerID - - # @!attribute artwork_copyright_owner_name - # - # @return [String, nil] - optional :artwork_copyright_owner_name, String, api_name: :ArtworkCopyrightOwnerName - - # @!attribute artwork_creator - # - # @return [Array, nil] - optional :artwork_creator, Imagekit::Internal::Type::ArrayOf[String], api_name: :ArtworkCreator - - # @!attribute artwork_creator_id - # - # @return [Array, nil] - optional :artwork_creator_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ArtworkCreatorID - - # @!attribute artwork_date_created - # - # @return [Time, nil] - optional :artwork_date_created, Time, api_name: :ArtworkDateCreated - - # @!attribute artwork_licensor_id - # - # @return [String, nil] - optional :artwork_licensor_id, String, api_name: :ArtworkLicensorID - - # @!attribute artwork_licensor_name - # - # @return [String, nil] - optional :artwork_licensor_name, String, api_name: :ArtworkLicensorName - - # @!attribute artwork_physical_description - # - # @return [String, nil] - optional :artwork_physical_description, String, api_name: :ArtworkPhysicalDescription - - # @!attribute artwork_source - # - # @return [String, nil] - optional :artwork_source, String, api_name: :ArtworkSource - - # @!attribute artwork_source_inventory_no - # - # @return [String, nil] - optional :artwork_source_inventory_no, String, api_name: :ArtworkSourceInventoryNo - - # @!attribute artwork_source_inv_url - # - # @return [String, nil] - optional :artwork_source_inv_url, String, api_name: :ArtworkSourceInvURL - - # @!attribute artwork_style_period - # - # @return [Array, nil] - optional :artwork_style_period, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ArtworkStylePeriod - - # @!attribute artwork_title - # - # @return [String, nil] - optional :artwork_title, String, api_name: :ArtworkTitle - - # @!attribute authors_position - # - # @return [String, nil] - optional :authors_position, String, api_name: :AuthorsPosition - - # @!attribute byline - # - # @return [String, nil] - optional :byline, String, api_name: :Byline - - # @!attribute byline_title - # - # @return [String, nil] - optional :byline_title, String, api_name: :BylineTitle - - # @!attribute caption - # - # @return [String, nil] - optional :caption, String, api_name: :Caption - - # @!attribute caption_abstract - # - # @return [String, nil] - optional :caption_abstract, String, api_name: :CaptionAbstract - - # @!attribute caption_writer - # - # @return [String, nil] - optional :caption_writer, String, api_name: :CaptionWriter - - # @!attribute city - # - # @return [String, nil] - optional :city, String, api_name: :City - - # @!attribute color_space - # - # @return [String, nil] - optional :color_space, String, api_name: :ColorSpace - - # @!attribute components_configuration - # - # @return [String, nil] - optional :components_configuration, String, api_name: :ComponentsConfiguration - - # @!attribute copyright - # - # @return [String, nil] - optional :copyright, String, api_name: :Copyright - - # @!attribute copyright_notice - # - # @return [String, nil] - optional :copyright_notice, String, api_name: :CopyrightNotice - - # @!attribute copyright_owner_id - # - # @return [Array, nil] - optional :copyright_owner_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :CopyrightOwnerID - - # @!attribute copyright_owner_name - # - # @return [Array, nil] - optional :copyright_owner_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :CopyrightOwnerName - - # @!attribute country - # - # @return [String, nil] - optional :country, String, api_name: :Country - - # @!attribute country_code - # - # @return [String, nil] - optional :country_code, String, api_name: :CountryCode - - # @!attribute country_primary_location_code - # - # @return [String, nil] - optional :country_primary_location_code, String, api_name: :CountryPrimaryLocationCode - - # @!attribute country_primary_location_name - # - # @return [String, nil] - optional :country_primary_location_name, String, api_name: :CountryPrimaryLocationName - - # @!attribute creator - # - # @return [String, nil] - optional :creator, String, api_name: :Creator - - # @!attribute creator_address - # - # @return [String, nil] - optional :creator_address, String, api_name: :CreatorAddress - - # @!attribute creator_city - # - # @return [String, nil] - optional :creator_city, String, api_name: :CreatorCity - - # @!attribute creator_country - # - # @return [String, nil] - optional :creator_country, String, api_name: :CreatorCountry - - # @!attribute creator_postal_code - # - # @return [String, nil] - optional :creator_postal_code, String, api_name: :CreatorPostalCode - - # @!attribute creator_region - # - # @return [String, nil] - optional :creator_region, String, api_name: :CreatorRegion - - # @!attribute creator_work_email - # - # @return [String, nil] - optional :creator_work_email, String, api_name: :CreatorWorkEmail - - # @!attribute creator_work_telephone - # - # @return [String, nil] - optional :creator_work_telephone, String, api_name: :CreatorWorkTelephone - - # @!attribute creator_work_url - # - # @return [String, nil] - optional :creator_work_url, String, api_name: :CreatorWorkURL - - # @!attribute credit - # - # @return [String, nil] - optional :credit, String, api_name: :Credit - - # @!attribute date_created - # - # @return [Time, nil] - optional :date_created, Time, api_name: :DateCreated - - # @!attribute date_time_created - # - # @return [Time, nil] - optional :date_time_created, Time, api_name: :DateTimeCreated - - # @!attribute date_time_original - # - # @return [Time, nil] - optional :date_time_original, Time, api_name: :DateTimeOriginal - - # @!attribute description - # - # @return [String, nil] - optional :description, String, api_name: :Description - - # @!attribute digital_image_guid - # - # @return [String, nil] - optional :digital_image_guid, String, api_name: :DigitalImageGUID - - # @!attribute digital_source_type - # - # @return [String, nil] - optional :digital_source_type, String, api_name: :DigitalSourceType - - # @!attribute embedded_encoded_rights_expr - # - # @return [String, nil] - optional :embedded_encoded_rights_expr, String, api_name: :EmbeddedEncodedRightsExpr - - # @!attribute embedded_encoded_rights_expr_lang_id - # - # @return [String, nil] - optional :embedded_encoded_rights_expr_lang_id, String, api_name: :EmbeddedEncodedRightsExprLangID - - # @!attribute embedded_encoded_rights_expr_type - # - # @return [String, nil] - optional :embedded_encoded_rights_expr_type, String, api_name: :EmbeddedEncodedRightsExprType - - # @!attribute event - # - # @return [String, nil] - optional :event, String, api_name: :Event - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute genre_cv_id - # - # @return [String, nil] - optional :genre_cv_id, String, api_name: :GenreCvId - - # @!attribute genre_cv_term_id - # - # @return [String, nil] - optional :genre_cv_term_id, String, api_name: :GenreCvTermId - - # @!attribute genre_cv_term_name - # - # @return [String, nil] - optional :genre_cv_term_name, String, api_name: :GenreCvTermName - - # @!attribute genre_cv_term_refined_about - # - # @return [String, nil] - optional :genre_cv_term_refined_about, String, api_name: :GenreCvTermRefinedAbout - - # @!attribute headline - # - # @return [String, nil] - optional :headline, String, api_name: :Headline - - # @!attribute image_creator_id - # - # @return [String, nil] - optional :image_creator_id, String, api_name: :ImageCreatorID - - # @!attribute image_creator_image_id - # - # @return [String, nil] - optional :image_creator_image_id, String, api_name: :ImageCreatorImageID - - # @!attribute image_creator_name - # - # @return [String, nil] - optional :image_creator_name, String, api_name: :ImageCreatorName - - # @!attribute image_description - # - # @return [String, nil] - optional :image_description, String, api_name: :ImageDescription - - # @!attribute image_region_boundary_h - # - # @return [Array, nil] - optional :image_region_boundary_h, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryH - - # @!attribute image_region_boundary_rx - # - # @return [Array, nil] - optional :image_region_boundary_rx, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryRx - - # @!attribute image_region_boundary_shape - # - # @return [Array, nil] - optional :image_region_boundary_shape, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionBoundaryShape - - # @!attribute image_region_boundary_unit - # - # @return [Array, nil] - optional :image_region_boundary_unit, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionBoundaryUnit - - # @!attribute image_region_boundary_vertices_x - # - # @return [Array, nil] - optional :image_region_boundary_vertices_x, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryVerticesX - - # @!attribute image_region_boundary_vertices_y - # - # @return [Array, nil] - optional :image_region_boundary_vertices_y, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryVerticesY - - # @!attribute image_region_boundary_w - # - # @return [Array, nil] - optional :image_region_boundary_w, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryW - - # @!attribute image_region_boundary_x - # - # @return [Array, nil] - optional :image_region_boundary_x, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryX - - # @!attribute image_region_boundary_y - # - # @return [Array, nil] - optional :image_region_boundary_y, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ImageRegionBoundaryY - - # @!attribute image_region_ctype_identifier - # - # @return [Array, nil] - optional :image_region_ctype_identifier, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionCtypeIdentifier - - # @!attribute image_region_ctype_name - # - # @return [Array, nil] - optional :image_region_ctype_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionCtypeName - - # @!attribute image_region_id - # - # @return [Array, nil] - optional :image_region_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ImageRegionID - - # @!attribute image_region_name - # - # @return [Array, nil] - optional :image_region_name, Imagekit::Internal::Type::ArrayOf[String], api_name: :ImageRegionName - - # @!attribute image_region_organisation_in_image_name - # - # @return [Array, nil] - optional :image_region_organisation_in_image_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionOrganisationInImageName - - # @!attribute image_region_person_in_image - # - # @return [Array, nil] - optional :image_region_person_in_image, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionPersonInImage - - # @!attribute image_region_role_identifier - # - # @return [Array, nil] - optional :image_region_role_identifier, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionRoleIdentifier - - # @!attribute image_region_role_name - # - # @return [Array, nil] - optional :image_region_role_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ImageRegionRoleName - - # @!attribute image_supplier_id - # - # @return [String, nil] - optional :image_supplier_id, String, api_name: :ImageSupplierID - - # @!attribute image_supplier_image_id - # - # @return [String, nil] - optional :image_supplier_image_id, String, api_name: :ImageSupplierImageID - - # @!attribute image_supplier_name - # - # @return [String, nil] - optional :image_supplier_name, String, api_name: :ImageSupplierName - - # @!attribute instructions - # - # @return [String, nil] - optional :instructions, String, api_name: :Instructions - - # @!attribute intellectual_genre - # - # @return [String, nil] - optional :intellectual_genre, String, api_name: :IntellectualGenre - - # @!attribute keywords - # - # @return [Array, nil] - optional :keywords, Imagekit::Internal::Type::ArrayOf[String], api_name: :Keywords - - # @!attribute licensor_city - # - # @return [Array, nil] - optional :licensor_city, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorCity - - # @!attribute licensor_country - # - # @return [Array, nil] - optional :licensor_country, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorCountry - - # @!attribute licensor_email - # - # @return [Array, nil] - optional :licensor_email, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorEmail - - # @!attribute licensor_extended_address - # - # @return [Array, nil] - optional :licensor_extended_address, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorExtendedAddress - - # @!attribute licensor_id - # - # @return [Array, nil] - optional :licensor_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorID - - # @!attribute licensor_name - # - # @return [Array, nil] - optional :licensor_name, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorName - - # @!attribute licensor_postal_code - # - # @return [Array, nil] - optional :licensor_postal_code, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorPostalCode - - # @!attribute licensor_region - # - # @return [Array, nil] - optional :licensor_region, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorRegion - - # @!attribute licensor_street_address - # - # @return [Array, nil] - optional :licensor_street_address, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorStreetAddress - - # @!attribute licensor_telephone1 - # - # @return [Array, nil] - optional :licensor_telephone1, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorTelephone1 - - # @!attribute licensor_telephone2 - # - # @return [Array, nil] - optional :licensor_telephone2, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LicensorTelephone2 - - # @!attribute licensor_url - # - # @return [Array, nil] - optional :licensor_url, Imagekit::Internal::Type::ArrayOf[String], api_name: :LicensorURL - - # @!attribute linked_encoded_rights_expr - # - # @return [String, nil] - optional :linked_encoded_rights_expr, String, api_name: :LinkedEncodedRightsExpr - - # @!attribute linked_encoded_rights_expr_lang_id - # - # @return [String, nil] - optional :linked_encoded_rights_expr_lang_id, String, api_name: :LinkedEncodedRightsExprLangID - - # @!attribute linked_encoded_rights_expr_type - # - # @return [String, nil] - optional :linked_encoded_rights_expr_type, String, api_name: :LinkedEncodedRightsExprType - - # @!attribute location - # - # @return [String, nil] - optional :location, String, api_name: :Location - - # @!attribute location_created_city - # - # @return [String, nil] - optional :location_created_city, String, api_name: :LocationCreatedCity - - # @!attribute location_created_country_code - # - # @return [String, nil] - optional :location_created_country_code, String, api_name: :LocationCreatedCountryCode - - # @!attribute location_created_country_name - # - # @return [String, nil] - optional :location_created_country_name, String, api_name: :LocationCreatedCountryName - - # @!attribute location_created_gps_altitude - # - # @return [String, nil] - optional :location_created_gps_altitude, String, api_name: :LocationCreatedGPSAltitude - - # @!attribute location_created_gps_latitude - # - # @return [String, nil] - optional :location_created_gps_latitude, String, api_name: :LocationCreatedGPSLatitude - - # @!attribute location_created_gps_longitude - # - # @return [String, nil] - optional :location_created_gps_longitude, String, api_name: :LocationCreatedGPSLongitude - - # @!attribute location_created_location_id - # - # @return [String, nil] - optional :location_created_location_id, String, api_name: :LocationCreatedLocationId - - # @!attribute location_created_location_name - # - # @return [String, nil] - optional :location_created_location_name, String, api_name: :LocationCreatedLocationName - - # @!attribute location_created_province_state - # - # @return [String, nil] - optional :location_created_province_state, String, api_name: :LocationCreatedProvinceState - - # @!attribute location_created_sublocation - # - # @return [String, nil] - optional :location_created_sublocation, String, api_name: :LocationCreatedSublocation - - # @!attribute location_created_world_region - # - # @return [String, nil] - optional :location_created_world_region, String, api_name: :LocationCreatedWorldRegion - - # @!attribute location_shown_city - # - # @return [Array, nil] - optional :location_shown_city, Imagekit::Internal::Type::ArrayOf[String], api_name: :LocationShownCity - - # @!attribute location_shown_country_code - # - # @return [Array, nil] - optional :location_shown_country_code, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownCountryCode - - # @!attribute location_shown_country_name - # - # @return [Array, nil] - optional :location_shown_country_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownCountryName - - # @!attribute location_shown_gps_altitude - # - # @return [Array, nil] - optional :location_shown_gps_altitude, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownGPSAltitude - - # @!attribute location_shown_gps_latitude - # - # @return [Array, nil] - optional :location_shown_gps_latitude, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownGPSLatitude - - # @!attribute location_shown_gps_longitude - # - # @return [Array, nil] - optional :location_shown_gps_longitude, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownGPSLongitude - - # @!attribute location_shown_location_id - # - # @return [Array, nil] - optional :location_shown_location_id, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownLocationId - - # @!attribute location_shown_location_name - # - # @return [Array, nil] - optional :location_shown_location_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownLocationName - - # @!attribute location_shown_province_state - # - # @return [Array, nil] - optional :location_shown_province_state, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownProvinceState - - # @!attribute location_shown_sublocation - # - # @return [Array, nil] - optional :location_shown_sublocation, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownSublocation - - # @!attribute location_shown_world_region - # - # @return [Array, nil] - optional :location_shown_world_region, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :LocationShownWorldRegion - - # @!attribute max_avail_height - # - # @return [Float, nil] - optional :max_avail_height, Float, api_name: :MaxAvailHeight - - # @!attribute max_avail_width - # - # @return [Float, nil] - optional :max_avail_width, Float, api_name: :MaxAvailWidth - - # @!attribute model_age - # - # @return [Array, nil] - optional :model_age, Imagekit::Internal::Type::ArrayOf[Float], api_name: :ModelAge - - # @!attribute model_release_id - # - # @return [Array, nil] - optional :model_release_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :ModelReleaseID - - # @!attribute object_attribute_reference - # - # @return [String, nil] - optional :object_attribute_reference, String, api_name: :ObjectAttributeReference - - # @!attribute object_name - # - # @return [String, nil] - optional :object_name, String, api_name: :ObjectName - - # @!attribute offset_time_original - # - # @return [String, nil] - optional :offset_time_original, String, api_name: :OffsetTimeOriginal - - # @!attribute organisation_in_image_code - # - # @return [Array, nil] - optional :organisation_in_image_code, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :OrganisationInImageCode - - # @!attribute organisation_in_image_name - # - # @return [Array, nil] - optional :organisation_in_image_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :OrganisationInImageName - - # @!attribute orientation - # - # @return [String, nil] - optional :orientation, String, api_name: :Orientation - - # @!attribute original_transmission_reference - # - # @return [String, nil] - optional :original_transmission_reference, String, api_name: :OriginalTransmissionReference - - # @!attribute person_in_image - # - # @return [Array, nil] - optional :person_in_image, Imagekit::Internal::Type::ArrayOf[String], api_name: :PersonInImage - - # @!attribute person_in_image_cv_term_cv_id - # - # @return [Array, nil] - optional :person_in_image_cv_term_cv_id, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageCvTermCvId - - # @!attribute person_in_image_cv_term_id - # - # @return [Array, nil] - optional :person_in_image_cv_term_id, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageCvTermId - - # @!attribute person_in_image_cv_term_name - # - # @return [Array, nil] - optional :person_in_image_cv_term_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageCvTermName - - # @!attribute person_in_image_cv_term_refined_about - # - # @return [Array, nil] - optional :person_in_image_cv_term_refined_about, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageCvTermRefinedAbout - - # @!attribute person_in_image_description - # - # @return [Array, nil] - optional :person_in_image_description, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageDescription - - # @!attribute person_in_image_id - # - # @return [Array, nil] - optional :person_in_image_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :PersonInImageId - - # @!attribute person_in_image_name - # - # @return [Array, nil] - optional :person_in_image_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :PersonInImageName - - # @!attribute product_in_image_description - # - # @return [Array, nil] - optional :product_in_image_description, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ProductInImageDescription - - # @!attribute product_in_image_gtin - # - # @return [Array, nil] - optional :product_in_image_gtin, - Imagekit::Internal::Type::ArrayOf[Float], - api_name: :ProductInImageGTIN - - # @!attribute product_in_image_name - # - # @return [Array, nil] - optional :product_in_image_name, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :ProductInImageName - - # @!attribute property_release_id - # - # @return [Array, nil] - optional :property_release_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :PropertyReleaseID - - # @!attribute province_state - # - # @return [String, nil] - optional :province_state, String, api_name: :ProvinceState - - # @!attribute rating - # - # @return [Integer, nil] - optional :rating, Integer, api_name: :Rating - - # @!attribute registry_entry_role - # - # @return [Array, nil] - optional :registry_entry_role, Imagekit::Internal::Type::ArrayOf[String], api_name: :RegistryEntryRole - - # @!attribute registry_item_id - # - # @return [Array, nil] - optional :registry_item_id, Imagekit::Internal::Type::ArrayOf[String], api_name: :RegistryItemID - - # @!attribute registry_organisation_id - # - # @return [Array, nil] - optional :registry_organisation_id, - Imagekit::Internal::Type::ArrayOf[String], - api_name: :RegistryOrganisationID - - # @!attribute resolution_unit - # - # @return [String, nil] - optional :resolution_unit, String, api_name: :ResolutionUnit - - # @!attribute rights - # - # @return [String, nil] - optional :rights, String, api_name: :Rights - - # @!attribute scene - # - # @return [Array, nil] - optional :scene, Imagekit::Internal::Type::ArrayOf[String], api_name: :Scene - - # @!attribute source - # - # @return [String, nil] - optional :source, String, api_name: :Source - - # @!attribute special_instructions - # - # @return [String, nil] - optional :special_instructions, String, api_name: :SpecialInstructions - - # @!attribute state - # - # @return [String, nil] - optional :state, String, api_name: :State - - # @!attribute subject - # - # @return [Array, nil] - optional :subject, Imagekit::Internal::Type::ArrayOf[String], api_name: :Subject - - # @!attribute subject_code - # - # @return [Array, nil] - optional :subject_code, Imagekit::Internal::Type::ArrayOf[String], api_name: :SubjectCode - - # @!attribute subject_reference - # - # @return [Array, nil] - optional :subject_reference, Imagekit::Internal::Type::ArrayOf[String], api_name: :SubjectReference - - # @!attribute sublocation - # - # @return [String, nil] - optional :sublocation, String, api_name: :Sublocation - - # @!attribute time_created - # - # @return [String, nil] - optional :time_created, String, api_name: :TimeCreated - - # @!attribute title - # - # @return [String, nil] - optional :title, String, api_name: :Title - - # @!attribute transmission_reference - # - # @return [String, nil] - optional :transmission_reference, String, api_name: :TransmissionReference - - # @!attribute usage_terms - # - # @return [String, nil] - optional :usage_terms, String, api_name: :UsageTerms - - # @!attribute web_statement - # - # @return [String, nil] - optional :web_statement, String, api_name: :WebStatement - - # @!attribute writer - # - # @return [String, nil] - optional :writer, String, api_name: :Writer - - # @!attribute writer_editor - # - # @return [String, nil] - optional :writer_editor, String, api_name: :WriterEditor - - # @!attribute x_resolution - # - # @return [Float, nil] - optional :x_resolution, Float, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Float, nil] - optional :y_resolution, Float, api_name: :YResolution - - # @!method initialize(about_cv_term_cv_id: nil, about_cv_term_id: nil, about_cv_term_name: nil, about_cv_term_refined_about: nil, additional_model_information: nil, application_record_version: nil, artist: nil, artwork_circa_date_created: nil, artwork_content_description: nil, artwork_contribution_description: nil, artwork_copyright_notice: nil, artwork_copyright_owner_id: nil, artwork_copyright_owner_name: nil, artwork_creator: nil, artwork_creator_id: nil, artwork_date_created: nil, artwork_licensor_id: nil, artwork_licensor_name: nil, artwork_physical_description: nil, artwork_source: nil, artwork_source_inventory_no: nil, artwork_source_inv_url: nil, artwork_style_period: nil, artwork_title: nil, authors_position: nil, byline: nil, byline_title: nil, caption: nil, caption_abstract: nil, caption_writer: nil, city: nil, color_space: nil, components_configuration: nil, copyright: nil, copyright_notice: nil, copyright_owner_id: nil, copyright_owner_name: nil, country: nil, country_code: nil, country_primary_location_code: nil, country_primary_location_name: nil, creator: nil, creator_address: nil, creator_city: nil, creator_country: nil, creator_postal_code: nil, creator_region: nil, creator_work_email: nil, creator_work_telephone: nil, creator_work_url: nil, credit: nil, date_created: nil, date_time_created: nil, date_time_original: nil, description: nil, digital_image_guid: nil, digital_source_type: nil, embedded_encoded_rights_expr: nil, embedded_encoded_rights_expr_lang_id: nil, embedded_encoded_rights_expr_type: nil, event: nil, exif_version: nil, flashpix_version: nil, genre_cv_id: nil, genre_cv_term_id: nil, genre_cv_term_name: nil, genre_cv_term_refined_about: nil, headline: nil, image_creator_id: nil, image_creator_image_id: nil, image_creator_name: nil, image_description: nil, image_region_boundary_h: nil, image_region_boundary_rx: nil, image_region_boundary_shape: nil, image_region_boundary_unit: nil, image_region_boundary_vertices_x: nil, image_region_boundary_vertices_y: nil, image_region_boundary_w: nil, image_region_boundary_x: nil, image_region_boundary_y: nil, image_region_ctype_identifier: nil, image_region_ctype_name: nil, image_region_id: nil, image_region_name: nil, image_region_organisation_in_image_name: nil, image_region_person_in_image: nil, image_region_role_identifier: nil, image_region_role_name: nil, image_supplier_id: nil, image_supplier_image_id: nil, image_supplier_name: nil, instructions: nil, intellectual_genre: nil, keywords: nil, licensor_city: nil, licensor_country: nil, licensor_email: nil, licensor_extended_address: nil, licensor_id: nil, licensor_name: nil, licensor_postal_code: nil, licensor_region: nil, licensor_street_address: nil, licensor_telephone1: nil, licensor_telephone2: nil, licensor_url: nil, linked_encoded_rights_expr: nil, linked_encoded_rights_expr_lang_id: nil, linked_encoded_rights_expr_type: nil, location: nil, location_created_city: nil, location_created_country_code: nil, location_created_country_name: nil, location_created_gps_altitude: nil, location_created_gps_latitude: nil, location_created_gps_longitude: nil, location_created_location_id: nil, location_created_location_name: nil, location_created_province_state: nil, location_created_sublocation: nil, location_created_world_region: nil, location_shown_city: nil, location_shown_country_code: nil, location_shown_country_name: nil, location_shown_gps_altitude: nil, location_shown_gps_latitude: nil, location_shown_gps_longitude: nil, location_shown_location_id: nil, location_shown_location_name: nil, location_shown_province_state: nil, location_shown_sublocation: nil, location_shown_world_region: nil, max_avail_height: nil, max_avail_width: nil, model_age: nil, model_release_id: nil, object_attribute_reference: nil, object_name: nil, offset_time_original: nil, organisation_in_image_code: nil, organisation_in_image_name: nil, orientation: nil, original_transmission_reference: nil, person_in_image: nil, person_in_image_cv_term_cv_id: nil, person_in_image_cv_term_id: nil, person_in_image_cv_term_name: nil, person_in_image_cv_term_refined_about: nil, person_in_image_description: nil, person_in_image_id: nil, person_in_image_name: nil, product_in_image_description: nil, product_in_image_gtin: nil, product_in_image_name: nil, property_release_id: nil, province_state: nil, rating: nil, registry_entry_role: nil, registry_item_id: nil, registry_organisation_id: nil, resolution_unit: nil, rights: nil, scene: nil, source: nil, special_instructions: nil, state: nil, subject: nil, subject_code: nil, subject_reference: nil, sublocation: nil, time_created: nil, title: nil, transmission_reference: nil, usage_terms: nil, web_statement: nil, writer: nil, writer_editor: nil, x_resolution: nil, y_resolution: nil) - # 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 about_cv_term_cv_id [String] - # @param about_cv_term_id [String] - # @param about_cv_term_name [String] - # @param about_cv_term_refined_about [String] - # @param additional_model_information [String] - # @param application_record_version [Integer] - # @param artist [String] - # @param artwork_circa_date_created [String] - # @param artwork_content_description [String] - # @param artwork_contribution_description [String] - # @param artwork_copyright_notice [String] - # @param artwork_copyright_owner_id [String] - # @param artwork_copyright_owner_name [String] - # @param artwork_creator [Array] - # @param artwork_creator_id [Array] - # @param artwork_date_created [Time] - # @param artwork_licensor_id [String] - # @param artwork_licensor_name [String] - # @param artwork_physical_description [String] - # @param artwork_source [String] - # @param artwork_source_inventory_no [String] - # @param artwork_source_inv_url [String] - # @param artwork_style_period [Array] - # @param artwork_title [String] - # @param authors_position [String] - # @param byline [String] - # @param byline_title [String] - # @param caption [String] - # @param caption_abstract [String] - # @param caption_writer [String] - # @param city [String] - # @param color_space [String] - # @param components_configuration [String] - # @param copyright [String] - # @param copyright_notice [String] - # @param copyright_owner_id [Array] - # @param copyright_owner_name [Array] - # @param country [String] - # @param country_code [String] - # @param country_primary_location_code [String] - # @param country_primary_location_name [String] - # @param creator [String] - # @param creator_address [String] - # @param creator_city [String] - # @param creator_country [String] - # @param creator_postal_code [String] - # @param creator_region [String] - # @param creator_work_email [String] - # @param creator_work_telephone [String] - # @param creator_work_url [String] - # @param credit [String] - # @param date_created [Time] - # @param date_time_created [Time] - # @param date_time_original [Time] - # @param description [String] - # @param digital_image_guid [String] - # @param digital_source_type [String] - # @param embedded_encoded_rights_expr [String] - # @param embedded_encoded_rights_expr_lang_id [String] - # @param embedded_encoded_rights_expr_type [String] - # @param event [String] - # @param exif_version [String] - # @param flashpix_version [String] - # @param genre_cv_id [String] - # @param genre_cv_term_id [String] - # @param genre_cv_term_name [String] - # @param genre_cv_term_refined_about [String] - # @param headline [String] - # @param image_creator_id [String] - # @param image_creator_image_id [String] - # @param image_creator_name [String] - # @param image_description [String] - # @param image_region_boundary_h [Array] - # @param image_region_boundary_rx [Array] - # @param image_region_boundary_shape [Array] - # @param image_region_boundary_unit [Array] - # @param image_region_boundary_vertices_x [Array] - # @param image_region_boundary_vertices_y [Array] - # @param image_region_boundary_w [Array] - # @param image_region_boundary_x [Array] - # @param image_region_boundary_y [Array] - # @param image_region_ctype_identifier [Array] - # @param image_region_ctype_name [Array] - # @param image_region_id [Array] - # @param image_region_name [Array] - # @param image_region_organisation_in_image_name [Array] - # @param image_region_person_in_image [Array] - # @param image_region_role_identifier [Array] - # @param image_region_role_name [Array] - # @param image_supplier_id [String] - # @param image_supplier_image_id [String] - # @param image_supplier_name [String] - # @param instructions [String] - # @param intellectual_genre [String] - # @param keywords [Array] - # @param licensor_city [Array] - # @param licensor_country [Array] - # @param licensor_email [Array] - # @param licensor_extended_address [Array] - # @param licensor_id [Array] - # @param licensor_name [Array] - # @param licensor_postal_code [Array] - # @param licensor_region [Array] - # @param licensor_street_address [Array] - # @param licensor_telephone1 [Array] - # @param licensor_telephone2 [Array] - # @param licensor_url [Array] - # @param linked_encoded_rights_expr [String] - # @param linked_encoded_rights_expr_lang_id [String] - # @param linked_encoded_rights_expr_type [String] - # @param location [String] - # @param location_created_city [String] - # @param location_created_country_code [String] - # @param location_created_country_name [String] - # @param location_created_gps_altitude [String] - # @param location_created_gps_latitude [String] - # @param location_created_gps_longitude [String] - # @param location_created_location_id [String] - # @param location_created_location_name [String] - # @param location_created_province_state [String] - # @param location_created_sublocation [String] - # @param location_created_world_region [String] - # @param location_shown_city [Array] - # @param location_shown_country_code [Array] - # @param location_shown_country_name [Array] - # @param location_shown_gps_altitude [Array] - # @param location_shown_gps_latitude [Array] - # @param location_shown_gps_longitude [Array] - # @param location_shown_location_id [Array] - # @param location_shown_location_name [Array] - # @param location_shown_province_state [Array] - # @param location_shown_sublocation [Array] - # @param location_shown_world_region [Array] - # @param max_avail_height [Float] - # @param max_avail_width [Float] - # @param model_age [Array] - # @param model_release_id [Array] - # @param object_attribute_reference [String] - # @param object_name [String] - # @param offset_time_original [String] - # @param organisation_in_image_code [Array] - # @param organisation_in_image_name [Array] - # @param orientation [String] - # @param original_transmission_reference [String] - # @param person_in_image [Array] - # @param person_in_image_cv_term_cv_id [Array] - # @param person_in_image_cv_term_id [Array] - # @param person_in_image_cv_term_name [Array] - # @param person_in_image_cv_term_refined_about [Array] - # @param person_in_image_description [Array] - # @param person_in_image_id [Array] - # @param person_in_image_name [Array] - # @param product_in_image_description [Array] - # @param product_in_image_gtin [Array] - # @param product_in_image_name [Array] - # @param property_release_id [Array] - # @param province_state [String] - # @param rating [Integer] - # @param registry_entry_role [Array] - # @param registry_item_id [Array] - # @param registry_organisation_id [Array] - # @param resolution_unit [String] - # @param rights [String] - # @param scene [Array] - # @param source [String] - # @param special_instructions [String] - # @param state [String] - # @param subject [Array] - # @param subject_code [Array] - # @param subject_reference [Array] - # @param sublocation [String] - # @param time_created [String] - # @param title [String] - # @param transmission_reference [String] - # @param usage_terms [String] - # @param web_statement [String] - # @param writer [String] - # @param writer_editor [String] - # @param x_resolution [Float] - # @param y_resolution [Float] - end - - # @see Imagekit::Models::FileUploadV2Response#extension_status - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - # @!attribute aws_auto_tagging - # - # @return [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging, nil] - optional :aws_auto_tagging, - enum: -> { Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging }, - api_name: :"aws-auto-tagging" - - # @!attribute google_auto_tagging - # - # @return [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging, nil] - optional :google_auto_tagging, - enum: -> { Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging }, - api_name: :"google-auto-tagging" - - # @!attribute remove_bg - # - # @return [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg, nil] - optional :remove_bg, - enum: -> { Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg }, - api_name: :"remove-bg" - - # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) - # 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. - # - # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging] - # @param google_auto_tagging [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging] - # @param remove_bg [Symbol, Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg] - - # @see Imagekit::Models::FileUploadV2Response::ExtensionStatus#aws_auto_tagging - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUploadV2Response::ExtensionStatus#google_auto_tagging - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUploadV2Response::ExtensionStatus#remove_bg - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - end - - # @see Imagekit::Models::FileUploadV2Response#metadata - class Metadata < Imagekit::Internal::Type::BaseModel - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute density - # The density of the image in DPI. - # - # @return [Integer, nil] - optional :density, Integer - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute exif - # - # @return [Imagekit::Models::FileUploadV2Response::Metadata::Exif, nil] - optional :exif, -> { Imagekit::Models::FileUploadV2Response::Metadata::Exif } - - # @!attribute format_ - # The format of the file (e.g., 'jpg', 'mp4'). - # - # @return [String, nil] - optional :format_, String, api_name: :format - - # @!attribute has_color_profile - # Indicates if the image has a color profile. - # - # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile - - # @!attribute has_transparency - # Indicates if the image contains transparent areas. - # - # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency - - # @!attribute height - # The height of the image or video in pixels. - # - # @return [Integer, nil] - optional :height, Integer - - # @!attribute p_hash - # Perceptual hash of the image. - # - # @return [String, nil] - optional :p_hash, String, api_name: :pHash - - # @!attribute quality - # The quality indicator of the image. - # - # @return [Integer, nil] - optional :quality, Integer - - # @!attribute size - # The file size in bytes. - # - # @return [Integer, nil] - optional :size, Integer - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # The width of the image or video in pixels. - # - # @return [Integer, nil] - optional :width, Integer - - # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param density [Integer] The density of the image in DPI. - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param exif [Imagekit::Models::FileUploadV2Response::Metadata::Exif] - # - # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). - # - # @param has_color_profile [Boolean] Indicates if the image has a color profile. - # - # @param has_transparency [Boolean] Indicates if the image contains transparent areas. - # - # @param height [Integer] The height of the image or video in pixels. - # - # @param p_hash [String] Perceptual hash of the image. - # - # @param quality [Integer] The quality indicator of the image. - # - # @param size [Integer] The file size in bytes. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Integer] The width of the image or video in pixels. - - # @see Imagekit::Models::FileUploadV2Response::Metadata#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute exif - # Object containing Exif details. - # - # @return [Imagekit::Models::ExifDetails, nil] - optional :exif, -> { Imagekit::ExifDetails } - - # @!attribute gps - # Object containing GPS information. - # - # @return [Imagekit::Models::Gps, nil] - optional :gps, -> { Imagekit::Gps } - - # @!attribute image - # Object containing EXIF image information. - # - # @return [Imagekit::Models::ExifImage, nil] - optional :image, -> { Imagekit::ExifImage } - - # @!attribute interoperability - # JSON object. - # - # @return [Imagekit::Models::Interoperability, nil] - optional :interoperability, -> { Imagekit::Interoperability } - - # @!attribute makernote - # - # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] - - # @!attribute thumbnail - # Object containing Thumbnail information. - # - # @return [Imagekit::Models::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Thumbnail } - - # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. - # - # @param gps [Imagekit::Models::Gps] Object containing GPS information. - # - # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. - # - # @param interoperability [Imagekit::Models::Interoperability] JSON object. - # - # @param makernote [Hash{Symbol=>Object}] - # - # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. - end - end - - # @see Imagekit::Models::FileUploadV2Response#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier of the file version. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # Name of the file version. - # - # @return [String, nil] - optional :name, String - - # @!method initialize(id: nil, name: nil) - # An object containing the file or file version's `id` (versionId) and `name`. - # - # @param id [String] Unique identifier of the file version. - # - # @param name [String] Name of the file version. - end - end - end -end diff --git a/lib/imagekit/models/files/bulk_add_tags_params.rb b/lib/imagekit/models/files/bulk_add_tags_params.rb new file mode 100644 index 00000000..9c85f747 --- /dev/null +++ b/lib/imagekit/models/files/bulk_add_tags_params.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Bulk#add_tags + class BulkAddTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_ids + # An array of fileIds to which you want to add tags. + # + # @return [Array] + required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + + # @!attribute tags + # An array of tags that you want to add to the files. + # + # @return [Array] + required :tags, Imagekit::Internal::Type::ArrayOf[String] + + # @!method initialize(file_ids:, tags:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkAddTagsParams} for more details. + # + # @param file_ids [Array] An array of fileIds to which you want to add tags. + # + # @param tags [Array] An array of tags that you want to add to the files. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/bulk_add_tags_response.rb b/lib/imagekit/models/files/bulk_add_tags_response.rb new file mode 100644 index 00000000..6bd30f2c --- /dev/null +++ b/lib/imagekit/models/files/bulk_add_tags_response.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Bulk#add_tags + class BulkAddTagsResponse < Imagekit::Internal::Type::BaseModel + # @!attribute successfully_updated_file_ids + # An array of fileIds that in which tags were successfully added. + # + # @return [Array, nil] + optional :successfully_updated_file_ids, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :successfullyUpdatedFileIds + + # @!method initialize(successfully_updated_file_ids: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkAddTagsResponse} for more details. + # + # @param successfully_updated_file_ids [Array] An array of fileIds that in which tags were successfully added. + end + end + end +end diff --git a/lib/imagekit/models/files/batch_delete_params.rb b/lib/imagekit/models/files/bulk_delete_params.rb similarity index 79% rename from lib/imagekit/models/files/batch_delete_params.rb rename to lib/imagekit/models/files/bulk_delete_params.rb index e69774e9..02bffc69 100644 --- a/lib/imagekit/models/files/batch_delete_params.rb +++ b/lib/imagekit/models/files/bulk_delete_params.rb @@ -3,8 +3,8 @@ module Imagekit module Models module Files - # @see Imagekit::Resources::Files::Batch#delete - class BatchDeleteParams < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Files::Bulk#delete + class BulkDeleteParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -16,7 +16,7 @@ class BatchDeleteParams < Imagekit::Internal::Type::BaseModel # @!method initialize(file_ids:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BatchDeleteParams} for more details. + # {Imagekit::Models::Files::BulkDeleteParams} for more details. # # @param file_ids [Array] An array of fileIds which you want to delete. # diff --git a/lib/imagekit/models/files/batch_delete_response.rb b/lib/imagekit/models/files/bulk_delete_response.rb similarity index 77% rename from lib/imagekit/models/files/batch_delete_response.rb rename to lib/imagekit/models/files/bulk_delete_response.rb index 62d9529d..e2fabbfc 100644 --- a/lib/imagekit/models/files/batch_delete_response.rb +++ b/lib/imagekit/models/files/bulk_delete_response.rb @@ -3,8 +3,8 @@ module Imagekit module Models module Files - # @see Imagekit::Resources::Files::Batch#delete - class BatchDeleteResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Files::Bulk#delete + class BulkDeleteResponse < Imagekit::Internal::Type::BaseModel # @!attribute successfully_deleted_file_ids # An array of fileIds that were successfully deleted. # @@ -15,7 +15,7 @@ class BatchDeleteResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(successfully_deleted_file_ids: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BatchDeleteResponse} for more details. + # {Imagekit::Models::Files::BulkDeleteResponse} for more details. # # @param successfully_deleted_file_ids [Array] An array of fileIds that were successfully deleted. end diff --git a/lib/imagekit/models/files/bulk_remove_ai_tags_params.rb b/lib/imagekit/models/files/bulk_remove_ai_tags_params.rb new file mode 100644 index 00000000..b050162f --- /dev/null +++ b/lib/imagekit/models/files/bulk_remove_ai_tags_params.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Bulk#remove_ai_tags + class BulkRemoveAITagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute ai_tags + # An array of AITags that you want to remove from the files. + # + # @return [Array] + required :ai_tags, Imagekit::Internal::Type::ArrayOf[String], api_name: :AITags + + # @!attribute file_ids + # An array of fileIds from which you want to remove AITags. + # + # @return [Array] + required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + + # @!method initialize(ai_tags:, file_ids:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkRemoveAITagsParams} for more details. + # + # @param ai_tags [Array] An array of AITags that you want to remove from the files. + # + # @param file_ids [Array] An array of fileIds from which you want to remove AITags. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/bulk_remove_ai_tags_response.rb b/lib/imagekit/models/files/bulk_remove_ai_tags_response.rb new file mode 100644 index 00000000..49fb07de --- /dev/null +++ b/lib/imagekit/models/files/bulk_remove_ai_tags_response.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Bulk#remove_ai_tags + class BulkRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + # @!attribute successfully_updated_file_ids + # An array of fileIds that in which AITags were successfully removed. + # + # @return [Array, nil] + optional :successfully_updated_file_ids, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :successfullyUpdatedFileIds + + # @!method initialize(successfully_updated_file_ids: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkRemoveAITagsResponse} for more details. + # + # @param successfully_updated_file_ids [Array] An array of fileIds that in which AITags were successfully removed. + end + end + end +end diff --git a/lib/imagekit/models/files/bulk_remove_tags_params.rb b/lib/imagekit/models/files/bulk_remove_tags_params.rb new file mode 100644 index 00000000..e5a2bbea --- /dev/null +++ b/lib/imagekit/models/files/bulk_remove_tags_params.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Bulk#remove_tags + class BulkRemoveTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute file_ids + # An array of fileIds from which you want to remove tags. + # + # @return [Array] + required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + + # @!attribute tags + # An array of tags that you want to remove from the files. + # + # @return [Array] + required :tags, Imagekit::Internal::Type::ArrayOf[String] + + # @!method initialize(file_ids:, tags:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkRemoveTagsParams} for more details. + # + # @param file_ids [Array] An array of fileIds from which you want to remove tags. + # + # @param tags [Array] An array of tags that you want to remove from the files. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/bulk_remove_tags_response.rb b/lib/imagekit/models/files/bulk_remove_tags_response.rb new file mode 100644 index 00000000..a36571e3 --- /dev/null +++ b/lib/imagekit/models/files/bulk_remove_tags_response.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Bulk#remove_tags + class BulkRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + # @!attribute successfully_updated_file_ids + # An array of fileIds that in which tags were successfully removed. + # + # @return [Array, nil] + optional :successfully_updated_file_ids, + Imagekit::Internal::Type::ArrayOf[String], + api_name: :successfullyUpdatedFileIds + + # @!method initialize(successfully_updated_file_ids: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkRemoveTagsResponse} for more details. + # + # @param successfully_updated_file_ids [Array] An array of fileIds that in which tags were successfully removed. + end + end + end +end diff --git a/lib/imagekit/models/files/detail_update_params.rb b/lib/imagekit/models/files/detail_update_params.rb deleted file mode 100644 index e055c8f7..00000000 --- a/lib/imagekit/models/files/detail_update_params.rb +++ /dev/null @@ -1,289 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Details#update - class DetailUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute custom_coordinates - # 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. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # 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. - # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata - - # @!attribute extensions - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - # - # @return [Array, nil] - optional :extensions, - -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::Files::DetailUpdateParams::Extension] - } - - # @!attribute remove_ai_tags - # 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. - # - # @return [Array, Symbol, Imagekit::Models::Files::DetailUpdateParams::RemoveAITags, nil] - optional :remove_ai_tags, - union: -> { Imagekit::Files::DetailUpdateParams::RemoveAITags }, - api_name: :removeAITags - - # @!attribute tags - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute webhook_url - # 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 [String, nil] - optional :webhook_url, String, api_name: :webhookUrl - - # @!attribute publish - # Configure the publication status of a file and its versions. - # - # @return [Imagekit::Models::Files::DetailUpdateParams::Publish, nil] - optional :publish, -> { Imagekit::Files::DetailUpdateParams::Publish } - - # @!method initialize(custom_coordinates: nil, custom_metadata: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailUpdateParams} for more details. - # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Object] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, Imagekit::Models::Files::DetailUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param publish [Imagekit::Models::Files::DetailUpdateParams::Publish] Configure the publication status of a file and its versions. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - module Extension - extend Imagekit::Internal::Type::Union - - variant -> { Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension } - - variant -> { Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name] - required :name, - enum: -> { - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name - } - - # @!attribute options - # - # @return [Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options, nil] - optional :options, - -> { - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options - } - - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. - # - # @param options [Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options] - - # Specifies the background removal extension. - # - # @see Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options} - # for more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name] - required :name, - enum: -> { - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name - } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension, Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension)] - end - - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union - - variant -> { Imagekit::Models::Files::DetailUpdateParams::RemoveAITags::StringArray } - - variant const: -> { Imagekit::Models::Files::DetailUpdateParams::RemoveAITags::ALL } - - # @!method self.variants - # @return [Array(Array, Symbol)] - - define_sorbet_constant!(:Variants) do - T.type_alias do - T.any(T::Array[String], Imagekit::Files::DetailUpdateParams::RemoveAITags::TaggedSymbol) - end - end - - # @type [Imagekit::Internal::Type::Converter] - StringArray = Imagekit::Internal::Type::ArrayOf[String] - - # @!group - - ALL = :all - - # @!endgroup - end - - class Publish < Imagekit::Internal::Type::BaseModel - # @!attribute is_published - # Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @return [Boolean] - required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute include_file_versions - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - # - # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions - - # @!method initialize(is_published:, include_file_versions: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailUpdateParams::Publish} for more details. - # - # Configure the publication status of a file and its versions. - # - # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p - end - end - end - end -end diff --git a/lib/imagekit/models/files/detail_update_response.rb b/lib/imagekit/models/files/detail_update_response.rb deleted file mode 100644 index a5438fa8..00000000 --- a/lib/imagekit/models/files/detail_update_response.rb +++ /dev/null @@ -1,321 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Details#update - class DetailUpdateResponse < Imagekit::Internal::Type::BaseModel - # @!attribute ai_tags - # An array of tags assigned to the file by auto tagging. - # - # @return [Array, nil] - optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::DetailUpdateResponse::AITag] }, - api_name: :AITags, - nil?: true - - # @!attribute created_at - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - # - # @return [String, nil] - optional :created_at, String, api_name: :createdAt - - # @!attribute custom_coordinates - # An string with custom coordinates of the file. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # An object with custom metadata for the file. - # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata - - # @!attribute extension_status - # - # @return [Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, nil] - optional :extension_status, - -> { Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus }, - api_name: :extensionStatus - - # @!attribute file_id - # Unique identifier of the asset. - # - # @return [String, nil] - optional :file_id, String, api_name: :fileId - - # @!attribute file_path - # 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`. - # - # @return [String, nil] - optional :file_path, String, api_name: :filePath - - # @!attribute file_type - # Type of the file. Possible values are `image`, `non-image`. - # - # @return [String, nil] - optional :file_type, String, api_name: :fileType - - # @!attribute has_alpha - # Specifies if the image has an alpha channel. - # - # @return [Boolean, nil] - optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha - - # @!attribute height - # Height of the file. - # - # @return [Float, nil] - optional :height, Float - - # @!attribute is_private_file - # Specifies if the file is private or not. - # - # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile - - # @!attribute is_published - # Specifies if the file is published or not. - # - # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute mime - # MIME type of the file. - # - # @return [String, nil] - optional :mime, String - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute size - # Size of the file in bytes. - # - # @return [Float, nil] - optional :size, Float - - # @!attribute tags - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute thumbnail - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - # - # @return [String, nil] - optional :thumbnail, String - - # @!attribute type - # Type of the asset. - # - # @return [String, nil] - optional :type, String - - # @!attribute updated_at - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - # - # @return [String, nil] - optional :updated_at, String, api_name: :updatedAt - - # @!attribute url - # URL of the file. - # - # @return [String, nil] - optional :url, String - - # @!attribute version_info - # An object with details of the file version. - # - # @return [Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, nil] - optional :version_info, - -> { Imagekit::Models::Files::DetailUpdateResponse::VersionInfo }, - api_name: :versionInfo - - # @!attribute width - # Width of the file. - # - # @return [Float, nil] - optional :width, Float - - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailUpdateResponse} for more details. - # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. - # - # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format - # - # @param custom_coordinates [String, nil] An string with custom coordinates of the file. - # - # @param custom_metadata [Object] An object with custom metadata for the file. - # - # @param extension_status [Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus] - # - # @param file_id [String] Unique identifier of the asset. - # - # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. - # - # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. - # - # @param has_alpha [Boolean] Specifies if the image has an alpha channel. - # - # @param height [Float] Height of the file. - # - # @param is_private_file [Boolean] Specifies if the file is private or not. - # - # @param is_published [Boolean] Specifies if the file is published or not. - # - # @param mime [String] MIME type of the file. - # - # @param name [String] Name of the asset. - # - # @param size [Float] Size of the file in bytes. - # - # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi - # - # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th - # - # @param type [String] Type of the asset. - # - # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo - # - # @param url [String] URL of the file. - # - # @param version_info [Imagekit::Models::Files::DetailUpdateResponse::VersionInfo] An object with details of the file version. - # - # @param width [Float] Width of the file. - - class AITag < Imagekit::Internal::Type::BaseModel - # @!attribute confidence - # Confidence score of the tag. - # - # @return [Float, nil] - optional :confidence, Float - - # @!attribute name - # Name of the tag. - # - # @return [String, nil] - optional :name, String - - # @!attribute source - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - # - # @return [String, nil] - optional :source, String - - # @!method initialize(confidence: nil, name: nil, source: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailUpdateResponse::AITag} for more details. - # - # @param confidence [Float] Confidence score of the tag. - # - # @param name [String] Name of the tag. - # - # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi - end - - # @see Imagekit::Models::Files::DetailUpdateResponse#extension_status - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - # @!attribute aws_auto_tagging - # - # @return [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging, nil] - optional :aws_auto_tagging, - enum: -> { Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging }, - api_name: :"aws-auto-tagging" - - # @!attribute google_auto_tagging - # - # @return [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging, nil] - optional :google_auto_tagging, - enum: -> { Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging }, - api_name: :"google-auto-tagging" - - # @!attribute remove_bg - # - # @return [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg, nil] - optional :remove_bg, - enum: -> { Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg }, - api_name: :"remove-bg" - - # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) - # @param aws_auto_tagging [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging] - # @param google_auto_tagging [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging] - # @param remove_bg [Symbol, Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg] - - # @see Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus#aws_auto_tagging - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus#google_auto_tagging - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus#remove_bg - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - end - - # @see Imagekit::Models::Files::DetailUpdateResponse#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier of the file version. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # Name of the file version. - # - # @return [String, nil] - optional :name, String - - # @!method initialize(id: nil, name: nil) - # An object with details of the file version. - # - # @param id [String] Unique identifier of the file version. - # - # @param name [String] Name of the file version. - end - end - end - end -end diff --git a/lib/imagekit/models/files/metadata_from_url_response.rb b/lib/imagekit/models/files/metadata_from_url_response.rb deleted file mode 100644 index 450e4fa8..00000000 --- a/lib/imagekit/models/files/metadata_from_url_response.rb +++ /dev/null @@ -1,175 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Metadata#from_url - class MetadataFromURLResponse < Imagekit::Internal::Type::BaseModel - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute density - # The density of the image in DPI. - # - # @return [Integer, nil] - optional :density, Integer - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute exif - # - # @return [Imagekit::Models::Files::MetadataFromURLResponse::Exif, nil] - optional :exif, -> { Imagekit::Models::Files::MetadataFromURLResponse::Exif } - - # @!attribute format_ - # The format of the file (e.g., 'jpg', 'mp4'). - # - # @return [String, nil] - optional :format_, String, api_name: :format - - # @!attribute has_color_profile - # Indicates if the image has a color profile. - # - # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile - - # @!attribute has_transparency - # Indicates if the image contains transparent areas. - # - # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency - - # @!attribute height - # The height of the image or video in pixels. - # - # @return [Integer, nil] - optional :height, Integer - - # @!attribute p_hash - # Perceptual hash of the image. - # - # @return [String, nil] - optional :p_hash, String, api_name: :pHash - - # @!attribute quality - # The quality indicator of the image. - # - # @return [Integer, nil] - optional :quality, Integer - - # @!attribute size - # The file size in bytes. - # - # @return [Integer, nil] - optional :size, Integer - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # The width of the image or video in pixels. - # - # @return [Integer, nil] - optional :width, Integer - - # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) - # JSON object containing metadata. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param density [Integer] The density of the image in DPI. - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param exif [Imagekit::Models::Files::MetadataFromURLResponse::Exif] - # - # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). - # - # @param has_color_profile [Boolean] Indicates if the image has a color profile. - # - # @param has_transparency [Boolean] Indicates if the image contains transparent areas. - # - # @param height [Integer] The height of the image or video in pixels. - # - # @param p_hash [String] Perceptual hash of the image. - # - # @param quality [Integer] The quality indicator of the image. - # - # @param size [Integer] The file size in bytes. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Integer] The width of the image or video in pixels. - - # @see Imagekit::Models::Files::MetadataFromURLResponse#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute exif - # Object containing Exif details. - # - # @return [Imagekit::Models::ExifDetails, nil] - optional :exif, -> { Imagekit::ExifDetails } - - # @!attribute gps - # Object containing GPS information. - # - # @return [Imagekit::Models::Gps, nil] - optional :gps, -> { Imagekit::Gps } - - # @!attribute image - # Object containing EXIF image information. - # - # @return [Imagekit::Models::ExifImage, nil] - optional :image, -> { Imagekit::ExifImage } - - # @!attribute interoperability - # JSON object. - # - # @return [Imagekit::Models::Interoperability, nil] - optional :interoperability, -> { Imagekit::Interoperability } - - # @!attribute makernote - # - # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] - - # @!attribute thumbnail - # Object containing Thumbnail information. - # - # @return [Imagekit::Models::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Thumbnail } - - # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. - # - # @param gps [Imagekit::Models::Gps] Object containing GPS information. - # - # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. - # - # @param interoperability [Imagekit::Models::Interoperability] JSON object. - # - # @param makernote [Hash{Symbol=>Object}] - # - # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. - end - end - end - end -end diff --git a/lib/imagekit/models/files/metadata_from_url_params.rb b/lib/imagekit/models/files/metadata_get_from_url_params.rb similarity index 78% rename from lib/imagekit/models/files/metadata_from_url_params.rb rename to lib/imagekit/models/files/metadata_get_from_url_params.rb index 4d9e2c49..805ec5b6 100644 --- a/lib/imagekit/models/files/metadata_from_url_params.rb +++ b/lib/imagekit/models/files/metadata_get_from_url_params.rb @@ -3,8 +3,8 @@ module Imagekit module Models module Files - # @see Imagekit::Resources::Files::Metadata#from_url - class MetadataFromURLParams < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Files::Metadata#get_from_url + class MetadataGetFromURLParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -17,7 +17,7 @@ class MetadataFromURLParams < Imagekit::Internal::Type::BaseModel # @!method initialize(url:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::MetadataFromURLParams} for more details. + # {Imagekit::Models::Files::MetadataGetFromURLParams} for more details. # # @param url [String] Should be a valid file URL. It should be accessible using your ImageKit.io accou # diff --git a/lib/imagekit/models/files/metadata_get_from_url_response.rb b/lib/imagekit/models/files/metadata_get_from_url_response.rb new file mode 100644 index 00000000..02c5b3b5 --- /dev/null +++ b/lib/imagekit/models/files/metadata_get_from_url_response.rb @@ -0,0 +1,487 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Metadata#get_from_url + class MetadataGetFromURLResponse < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, nil] + optional :exif, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # JSON object containing metadata. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, nil] + optional :exif, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, nil] + optional :gps, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, nil] + optional :image, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, nil] + optional :interoperability, + -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif] Object containing Exif details. + # + # @param gps [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end + end + end + end + end +end diff --git a/lib/imagekit/models/files/purge_status_params.rb b/lib/imagekit/models/files/metadata_get_params.rb similarity index 76% rename from lib/imagekit/models/files/purge_status_params.rb rename to lib/imagekit/models/files/metadata_get_params.rb index 5cdadb69..c95a81e5 100644 --- a/lib/imagekit/models/files/purge_status_params.rb +++ b/lib/imagekit/models/files/metadata_get_params.rb @@ -3,8 +3,8 @@ module Imagekit module Models module Files - # @see Imagekit::Resources::Files::Purge#status - class PurgeStatusParams < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Files::Metadata#get + class MetadataGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/files/metadata_get_response.rb b/lib/imagekit/models/files/metadata_get_response.rb new file mode 100644 index 00000000..aa974f73 --- /dev/null +++ b/lib/imagekit/models/files/metadata_get_response.rb @@ -0,0 +1,486 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Files + # @see Imagekit::Resources::Files::Metadata#get + class MetadataGetResponse < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif, nil] + optional :exif, -> { Imagekit::Models::Files::MetadataGetResponse::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # JSON object containing metadata. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::Files::MetadataGetResponse::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::Files::MetadataGetResponse#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, nil] + optional :exif, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Exif } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, nil] + optional :gps, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Image, nil] + optional :image, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Image } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, nil] + optional :interoperability, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::Files::MetadataGetResponse::Exif::Exif] Object containing Exif details. + # + # @param gps [Imagekit::Models::Files::MetadataGetResponse::Exif::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::Files::MetadataGetResponse::Exif::Image] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end + end + end + end + end +end diff --git a/lib/imagekit/models/files/metadata_retrieve_response.rb b/lib/imagekit/models/files/metadata_retrieve_response.rb deleted file mode 100644 index 4b12c537..00000000 --- a/lib/imagekit/models/files/metadata_retrieve_response.rb +++ /dev/null @@ -1,175 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Metadata#retrieve - class MetadataRetrieveResponse < Imagekit::Internal::Type::BaseModel - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute density - # The density of the image in DPI. - # - # @return [Integer, nil] - optional :density, Integer - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute exif - # - # @return [Imagekit::Models::Files::MetadataRetrieveResponse::Exif, nil] - optional :exif, -> { Imagekit::Models::Files::MetadataRetrieveResponse::Exif } - - # @!attribute format_ - # The format of the file (e.g., 'jpg', 'mp4'). - # - # @return [String, nil] - optional :format_, String, api_name: :format - - # @!attribute has_color_profile - # Indicates if the image has a color profile. - # - # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile - - # @!attribute has_transparency - # Indicates if the image contains transparent areas. - # - # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency - - # @!attribute height - # The height of the image or video in pixels. - # - # @return [Integer, nil] - optional :height, Integer - - # @!attribute p_hash - # Perceptual hash of the image. - # - # @return [String, nil] - optional :p_hash, String, api_name: :pHash - - # @!attribute quality - # The quality indicator of the image. - # - # @return [Integer, nil] - optional :quality, Integer - - # @!attribute size - # The file size in bytes. - # - # @return [Integer, nil] - optional :size, Integer - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # The width of the image or video in pixels. - # - # @return [Integer, nil] - optional :width, Integer - - # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) - # JSON object containing metadata. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param density [Integer] The density of the image in DPI. - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param exif [Imagekit::Models::Files::MetadataRetrieveResponse::Exif] - # - # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). - # - # @param has_color_profile [Boolean] Indicates if the image has a color profile. - # - # @param has_transparency [Boolean] Indicates if the image contains transparent areas. - # - # @param height [Integer] The height of the image or video in pixels. - # - # @param p_hash [String] Perceptual hash of the image. - # - # @param quality [Integer] The quality indicator of the image. - # - # @param size [Integer] The file size in bytes. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Integer] The width of the image or video in pixels. - - # @see Imagekit::Models::Files::MetadataRetrieveResponse#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute exif - # Object containing Exif details. - # - # @return [Imagekit::Models::ExifDetails, nil] - optional :exif, -> { Imagekit::ExifDetails } - - # @!attribute gps - # Object containing GPS information. - # - # @return [Imagekit::Models::Gps, nil] - optional :gps, -> { Imagekit::Gps } - - # @!attribute image - # Object containing EXIF image information. - # - # @return [Imagekit::Models::ExifImage, nil] - optional :image, -> { Imagekit::ExifImage } - - # @!attribute interoperability - # JSON object. - # - # @return [Imagekit::Models::Interoperability, nil] - optional :interoperability, -> { Imagekit::Interoperability } - - # @!attribute makernote - # - # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] - - # @!attribute thumbnail - # Object containing Thumbnail information. - # - # @return [Imagekit::Models::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Thumbnail } - - # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. - # - # @param gps [Imagekit::Models::Gps] Object containing GPS information. - # - # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. - # - # @param interoperability [Imagekit::Models::Interoperability] JSON object. - # - # @param makernote [Hash{Symbol=>Object}] - # - # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. - end - end - end - end -end diff --git a/lib/imagekit/models/files/purge_status_response.rb b/lib/imagekit/models/files/purge_status_response.rb deleted file mode 100644 index febe869b..00000000 --- a/lib/imagekit/models/files/purge_status_response.rb +++ /dev/null @@ -1,35 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Purge#status - class PurgeStatusResponse < Imagekit::Internal::Type::BaseModel - # @!attribute status - # Status of the purge request. - # - # @return [Symbol, Imagekit::Models::Files::PurgeStatusResponse::Status, nil] - optional :status, enum: -> { Imagekit::Models::Files::PurgeStatusResponse::Status } - - # @!method initialize(status: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::PurgeStatusResponse} for more details. - # - # @param status [Symbol, Imagekit::Models::Files::PurgeStatusResponse::Status] Status of the purge request. - - # Status of the purge request. - # - # @see Imagekit::Models::Files::PurgeStatusResponse#status - module Status - extend Imagekit::Internal::Type::Enum - - PENDING = :Pending - COMPLETED = :Completed - - # @!method self.values - # @return [Array] - end - end - end - end -end diff --git a/lib/imagekit/models/files/version_retrieve_params.rb b/lib/imagekit/models/files/version_get_params.rb similarity index 80% rename from lib/imagekit/models/files/version_retrieve_params.rb rename to lib/imagekit/models/files/version_get_params.rb index 7fccc1e5..b4c7ae98 100644 --- a/lib/imagekit/models/files/version_retrieve_params.rb +++ b/lib/imagekit/models/files/version_get_params.rb @@ -3,8 +3,8 @@ module Imagekit module Models module Files - # @see Imagekit::Resources::Files::Versions#retrieve - class VersionRetrieveParams < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Files::Versions#get + class VersionGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/files/version_retrieve_response.rb b/lib/imagekit/models/files/version_get_response.rb similarity index 90% rename from lib/imagekit/models/files/version_retrieve_response.rb rename to lib/imagekit/models/files/version_get_response.rb index 5afab187..c49897e4 100644 --- a/lib/imagekit/models/files/version_retrieve_response.rb +++ b/lib/imagekit/models/files/version_get_response.rb @@ -3,14 +3,14 @@ module Imagekit module Models module Files - # @see Imagekit::Resources::Files::Versions#retrieve - class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Files::Versions#get + class VersionGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRetrieveResponse::AITag] }, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionGetResponse::AITag] }, api_name: :AITags, nil?: true @@ -132,9 +132,9 @@ class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object with details of the file version. # - # @return [Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, nil] + # @return [Imagekit::Models::Files::VersionGetResponse::VersionInfo, nil] optional :version_info, - -> { Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo }, + -> { Imagekit::Models::Files::VersionGetResponse::VersionInfo }, api_name: :versionInfo # @!attribute width @@ -145,11 +145,11 @@ class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionRetrieveResponse} for more details. + # {Imagekit::Models::Files::VersionGetResponse} for more details. # # Object containing details of a file or file version. # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format # @@ -187,7 +187,7 @@ class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel # # @param url [String] URL of the file. # - # @param version_info [Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo] An object with details of the file version. + # @param version_info [Imagekit::Models::Files::VersionGetResponse::VersionInfo] An object with details of the file version. # # @param width [Float] Width of the file. @@ -213,7 +213,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionRetrieveResponse::AITag} for more details. + # {Imagekit::Models::Files::VersionGetResponse::AITag} for more details. # # @param confidence [Float] Confidence score of the tag. # @@ -222,7 +222,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end - # @see Imagekit::Models::Files::VersionRetrieveResponse#version_info + # @see Imagekit::Models::Files::VersionGetResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. diff --git a/lib/imagekit/models/bulk_job_copy_folder_params.rb b/lib/imagekit/models/folder_copy_params.rb similarity index 89% rename from lib/imagekit/models/bulk_job_copy_folder_params.rb rename to lib/imagekit/models/folder_copy_params.rb index d3423e13..fabc4272 100644 --- a/lib/imagekit/models/bulk_job_copy_folder_params.rb +++ b/lib/imagekit/models/folder_copy_params.rb @@ -2,8 +2,8 @@ module Imagekit module Models - # @see Imagekit::Resources::BulkJobs#copy_folder - class BulkJobCopyFolderParams < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Folders#copy + class FolderCopyParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -30,7 +30,7 @@ class BulkJobCopyFolderParams < Imagekit::Internal::Type::BaseModel # @!method initialize(destination_path:, source_folder_path:, include_versions: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::BulkJobCopyFolderParams} for more details. + # {Imagekit::Models::FolderCopyParams} for more details. # # @param destination_path [String] Full path to the destination folder where you want to copy the source folder int # diff --git a/lib/imagekit/models/bulk_job_move_folder_response.rb b/lib/imagekit/models/folder_copy_response.rb similarity index 72% rename from lib/imagekit/models/bulk_job_move_folder_response.rb rename to lib/imagekit/models/folder_copy_response.rb index a84345e6..62978384 100644 --- a/lib/imagekit/models/bulk_job_move_folder_response.rb +++ b/lib/imagekit/models/folder_copy_response.rb @@ -2,8 +2,8 @@ module Imagekit module Models - # @see Imagekit::Resources::BulkJobs#move_folder - class BulkJobMoveFolderResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Folders#copy + class FolderCopyResponse < Imagekit::Internal::Type::BaseModel # @!attribute job_id # Unique identifier of the bulk job. This can be used to check the status of the # bulk job. @@ -13,7 +13,7 @@ class BulkJobMoveFolderResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(job_id: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::BulkJobMoveFolderResponse} for more details. + # {Imagekit::Models::FolderCopyResponse} for more details. # # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b end diff --git a/lib/imagekit/models/folder_create_params.rb b/lib/imagekit/models/folder_create_params.rb index 637829d2..05138b5b 100644 --- a/lib/imagekit/models/folder_create_params.rb +++ b/lib/imagekit/models/folder_create_params.rb @@ -2,7 +2,7 @@ module Imagekit module Models - # @see Imagekit::Resources::Folder#create + # @see Imagekit::Resources::Folders#create class FolderCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/folder_delete_params.rb b/lib/imagekit/models/folder_delete_params.rb index b00ca7aa..8f4480d7 100644 --- a/lib/imagekit/models/folder_delete_params.rb +++ b/lib/imagekit/models/folder_delete_params.rb @@ -2,7 +2,7 @@ module Imagekit module Models - # @see Imagekit::Resources::Folder#delete + # @see Imagekit::Resources::Folders#delete class FolderDeleteParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/bulk_job_move_folder_params.rb b/lib/imagekit/models/folder_move_params.rb similarity index 85% rename from lib/imagekit/models/bulk_job_move_folder_params.rb rename to lib/imagekit/models/folder_move_params.rb index 7fd5d3b8..86d6ccc9 100644 --- a/lib/imagekit/models/bulk_job_move_folder_params.rb +++ b/lib/imagekit/models/folder_move_params.rb @@ -2,8 +2,8 @@ module Imagekit module Models - # @see Imagekit::Resources::BulkJobs#move_folder - class BulkJobMoveFolderParams < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Folders#move + class FolderMoveParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -22,7 +22,7 @@ class BulkJobMoveFolderParams < Imagekit::Internal::Type::BaseModel # @!method initialize(destination_path:, source_folder_path:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::BulkJobMoveFolderParams} for more details. + # {Imagekit::Models::FolderMoveParams} for more details. # # @param destination_path [String] Full path to the destination folder where you want to move the source folder int # diff --git a/lib/imagekit/models/bulk_job_copy_folder_response.rb b/lib/imagekit/models/folder_move_response.rb similarity index 72% rename from lib/imagekit/models/bulk_job_copy_folder_response.rb rename to lib/imagekit/models/folder_move_response.rb index 7f90b5b9..46451324 100644 --- a/lib/imagekit/models/bulk_job_copy_folder_response.rb +++ b/lib/imagekit/models/folder_move_response.rb @@ -2,8 +2,8 @@ module Imagekit module Models - # @see Imagekit::Resources::BulkJobs#copy_folder - class BulkJobCopyFolderResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekit::Resources::Folders#move + class FolderMoveResponse < Imagekit::Internal::Type::BaseModel # @!attribute job_id # Unique identifier of the bulk job. This can be used to check the status of the # bulk job. @@ -13,7 +13,7 @@ class BulkJobCopyFolderResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(job_id: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::BulkJobCopyFolderResponse} for more details. + # {Imagekit::Models::FolderMoveResponse} for more details. # # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b end diff --git a/lib/imagekit/models/folder_rename_params.rb b/lib/imagekit/models/folder_rename_params.rb new file mode 100644 index 00000000..071d74c4 --- /dev/null +++ b/lib/imagekit/models/folder_rename_params.rb @@ -0,0 +1,59 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Folders#rename + class FolderRenameParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!attribute folder_path + # The full path to the folder you want to rename. + # + # @return [String] + required :folder_path, String, api_name: :folderPath + + # @!attribute new_folder_name + # 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. `_`. + # + # @return [String] + required :new_folder_name, String, api_name: :newFolderName + + # @!attribute purge_cache + # 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` + # + # @return [Boolean, nil] + optional :purge_cache, Imagekit::Internal::Type::Boolean, api_name: :purgeCache + + # @!method initialize(folder_path:, new_folder_name:, purge_cache: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderRenameParams} for more details. + # + # @param folder_path [String] The full path to the folder you want to rename. + # + # @param new_folder_name [String] The new name for the folder. + # + # @param purge_cache [Boolean] Option to purge cache for the old nested files and their versions' URLs. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/folder_rename_response.rb b/lib/imagekit/models/folder_rename_response.rb new file mode 100644 index 00000000..aeee24a8 --- /dev/null +++ b/lib/imagekit/models/folder_rename_response.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Folders#rename + class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + # @!attribute job_id + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + # + # @return [String, nil] + optional :job_id, String, api_name: :jobId + + # @!method initialize(job_id: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderRenameResponse} for more details. + # + # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b + end + end +end diff --git a/lib/imagekit/models/folders/job_get_params.rb b/lib/imagekit/models/folders/job_get_params.rb new file mode 100644 index 00000000..916f9213 --- /dev/null +++ b/lib/imagekit/models/folders/job_get_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Folders + # @see Imagekit::Resources::Folders::Job#get + class JobGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/folders/job_get_response.rb b/lib/imagekit/models/folders/job_get_response.rb new file mode 100644 index 00000000..833fa36c --- /dev/null +++ b/lib/imagekit/models/folders/job_get_response.rb @@ -0,0 +1,48 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Folders + # @see Imagekit::Resources::Folders::Job#get + class JobGetResponse < Imagekit::Internal::Type::BaseModel + # @!attribute job_id + # Unique identifier of the bulk job. + # + # @return [String, nil] + optional :job_id, String, api_name: :jobId + + # @!attribute purge_request_id + # Unique identifier of the purge request. This will be present only if + # `purgeCache` is set to `true` in the rename folder API request. + # + # @return [String, nil] + optional :purge_request_id, String, api_name: :purgeRequestId + + # @!attribute status + # Status of the bulk job. Possible values - `Pending`, `Completed`. + # + # @return [String, nil] + optional :status, String + + # @!attribute type + # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`, + # `RENAME_FOLDER`. + # + # @return [String, nil] + optional :type, String + + # @!method initialize(job_id: nil, purge_request_id: nil, status: nil, type: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Folders::JobGetResponse} for more details. + # + # @param job_id [String] Unique identifier of the bulk job. + # + # @param purge_request_id [String] Unique identifier of the purge request. This will be present only if `purgeCache + # + # @param status [String] Status of the bulk job. Possible values - `Pending`, `Completed`. + # + # @param type [String] Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`, `RENAME_FO + end + end + end +end diff --git a/lib/imagekit/models/gps.rb b/lib/imagekit/models/gps.rb deleted file mode 100644 index da477fce..00000000 --- a/lib/imagekit/models/gps.rb +++ /dev/null @@ -1,17 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - end -end diff --git a/lib/imagekit/models/interoperability.rb b/lib/imagekit/models/interoperability.rb deleted file mode 100644 index 23925987..00000000 --- a/lib/imagekit/models/interoperability.rb +++ /dev/null @@ -1,23 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - end -end diff --git a/lib/imagekit/models/thumbnail.rb b/lib/imagekit/models/thumbnail.rb deleted file mode 100644 index 8b864ac0..00000000 --- a/lib/imagekit/models/thumbnail.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end - end -end diff --git a/lib/imagekit/resources/accounts.rb b/lib/imagekit/resources/accounts.rb index c596f110..5946d26e 100644 --- a/lib/imagekit/resources/accounts.rb +++ b/lib/imagekit/resources/accounts.rb @@ -3,41 +3,23 @@ module Imagekit module Resources class Accounts - # Some parameter documentations has been truncated, see - # {Imagekit::Models::AccountGetUsageParams} for more details. - # - # 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. - # - # @overload get_usage(end_date:, start_date:, request_options: {}) - # - # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. - # - # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::AccountGetUsageResponse] - # - # @see Imagekit::Models::AccountGetUsageParams - def get_usage(params) - parsed, options = Imagekit::AccountGetUsageParams.dump_request(params) - @client.request( - method: :get, - path: "v1/accounts/usage", - query: parsed.transform_keys(end_date: "endDate", start_date: "startDate"), - model: Imagekit::Models::AccountGetUsageResponse, - options: options - ) - end + # @return [Imagekit::Resources::Accounts::Usage] + attr_reader :usage + + # @return [Imagekit::Resources::Accounts::Origins] + attr_reader :origins + + # @return [Imagekit::Resources::Accounts::URLEndpoints] + attr_reader :url_endpoints # @api private # # @param client [Imagekit::Client] def initialize(client:) @client = client + @usage = Imagekit::Resources::Accounts::Usage.new(client: client) + @origins = Imagekit::Resources::Accounts::Origins.new(client: client) + @url_endpoints = Imagekit::Resources::Accounts::URLEndpoints.new(client: client) end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb new file mode 100644 index 00000000..5f58e195 --- /dev/null +++ b/lib/imagekit/resources/accounts/origins.rb @@ -0,0 +1,215 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Accounts + class Origins + # **Note:** This API is currently in beta. + # Creates a new origin and returns the origin object. + # + # @overload create(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param base_url [String] Akeneo instance base URL. + # + # @param client_email [String] + # + # @param private_key [String] + # + # @param account_name [String] + # + # @param container [String] + # + # @param sas_token [String] + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] + # + # @see Imagekit::Models::Accounts::OriginCreateParams + def create(params) + parsed, options = Imagekit::Accounts::OriginCreateParams.dump_request(params) + @client.request( + method: :post, + path: "v1/accounts/origins", + body: parsed, + model: Imagekit::Models::Accounts::OriginCreateResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateParams} for more details. + # + # **Note:** This API is currently in beta. + # Updates the origin identified by `id` and returns the updated origin object. + # + # @overload update(id, access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param base_url [String] Akeneo instance base URL. + # + # @param client_email [String] + # + # @param private_key [String] + # + # @param account_name [String] + # + # @param container [String] + # + # @param sas_token [String] + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] + # + # @see Imagekit::Models::Accounts::OriginUpdateParams + def update(id, params) + parsed, options = Imagekit::Accounts::OriginUpdateParams.dump_request(params) + @client.request( + method: :put, + path: ["v1/accounts/origins/%1$s", id], + body: parsed, + model: Imagekit::Models::Accounts::OriginUpdateResponse, + options: options + ) + end + + # **Note:** This API is currently in beta. + # Returns an array of all configured origins for the current account. + # + # @overload list(request_options: {}) + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Imagekit::Models::Accounts::OriginListParams + def list(params = {}) + @client.request( + method: :get, + path: "v1/accounts/origins", + model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::Accounts::OriginListResponseItem], + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginDeleteParams} for more details. + # + # **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. + # + # @overload delete(id, request_options: {}) + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [nil] + # + # @see Imagekit::Models::Accounts::OriginDeleteParams + def delete(id, params = {}) + @client.request( + method: :delete, + path: ["v1/accounts/origins/%1$s", id], + model: NilClass, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetParams} for more details. + # + # **Note:** This API is currently in beta. + # Retrieves the origin identified by `id`. + # + # @overload get(id, request_options: {}) + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim] + # + # @see Imagekit::Models::Accounts::OriginGetParams + def get(id, params = {}) + @client.request( + method: :get, + path: ["v1/accounts/origins/%1$s", id], + model: Imagekit::Models::Accounts::OriginGetResponse, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/accounts/url_endpoints.rb b/lib/imagekit/resources/accounts/url_endpoints.rb new file mode 100644 index 00000000..a65ea4e7 --- /dev/null +++ b/lib/imagekit/resources/accounts/url_endpoints.rb @@ -0,0 +1,151 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Accounts + class URLEndpoints + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointCreateParams} for more details. + # + # **Note:** This API is currently in beta. + # Creates a new URL‑endpoint and returns the resulting object. + # + # @overload create(description:, origins: nil, url_prefix: nil, url_rewriter: nil, request_options: {}) + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Accounts::URLEndpointCreateResponse] + # + # @see Imagekit::Models::Accounts::URLEndpointCreateParams + def create(params) + parsed, options = Imagekit::Accounts::URLEndpointCreateParams.dump_request(params) + @client.request( + method: :post, + path: "v1/accounts/url-endpoints", + body: parsed, + model: Imagekit::Models::Accounts::URLEndpointCreateResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointUpdateParams} for more details. + # + # **Note:** This API is currently in beta. + # Updates the URL‑endpoint identified by `id` and returns the updated object. + # + # @overload update(id, description:, origins: nil, url_prefix: nil, url_rewriter: nil, request_options: {}) + # + # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Accounts::URLEndpointUpdateResponse] + # + # @see Imagekit::Models::Accounts::URLEndpointUpdateParams + def update(id, params) + parsed, options = Imagekit::Accounts::URLEndpointUpdateParams.dump_request(params) + @client.request( + method: :put, + path: ["v1/accounts/url-endpoints/%1$s", id], + body: parsed, + model: Imagekit::Models::Accounts::URLEndpointUpdateResponse, + options: options + ) + end + + # **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. + # + # @overload list(request_options: {}) + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Imagekit::Models::Accounts::URLEndpointListParams + def list(params = {}) + @client.request( + method: :get, + path: "v1/accounts/url-endpoints", + model: Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Accounts::URLEndpointListResponseItem], + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointDeleteParams} for more details. + # + # **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. + # + # @overload delete(id, request_options: {}) + # + # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [nil] + # + # @see Imagekit::Models::Accounts::URLEndpointDeleteParams + def delete(id, params = {}) + @client.request( + method: :delete, + path: ["v1/accounts/url-endpoints/%1$s", id], + model: NilClass, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpointGetParams} for more details. + # + # **Note:** This API is currently in beta. + # Retrieves the URL‑endpoint identified by `id`. + # + # @overload get(id, request_options: {}) + # + # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Accounts::URLEndpointGetResponse] + # + # @see Imagekit::Models::Accounts::URLEndpointGetParams + def get(id, params = {}) + @client.request( + method: :get, + path: ["v1/accounts/url-endpoints/%1$s", id], + model: Imagekit::Models::Accounts::URLEndpointGetResponse, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/accounts/usage.rb b/lib/imagekit/resources/accounts/usage.rb new file mode 100644 index 00000000..ed062095 --- /dev/null +++ b/lib/imagekit/resources/accounts/usage.rb @@ -0,0 +1,46 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Accounts + class Usage + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::UsageGetParams} for more details. + # + # 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. + # + # @overload get(end_date:, start_date:, request_options: {}) + # + # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. + # + # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Accounts::UsageGetResponse] + # + # @see Imagekit::Models::Accounts::UsageGetParams + def get(params) + parsed, options = Imagekit::Accounts::UsageGetParams.dump_request(params) + @client.request( + method: :get, + path: "v1/accounts/usage", + query: parsed.transform_keys(end_date: "endDate", start_date: "startDate"), + model: Imagekit::Models::Accounts::UsageGetResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/assets.rb b/lib/imagekit/resources/assets.rb new file mode 100644 index 00000000..25634fa5 --- /dev/null +++ b/lib/imagekit/resources/assets.rb @@ -0,0 +1,54 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Assets + # Some parameter documentations has been truncated, see + # {Imagekit::Models::AssetListParams} for more details. + # + # 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`. + # + # @overload list(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) + # + # @param file_type [Symbol, Imagekit::Models::AssetListParams::FileType] Filter results by file type. + # + # @param limit [Integer] The maximum number of results to return in response. + # + # @param path [String] Folder path if you want to limit the search within a specific folder. For exampl + # + # @param search_query [String] Query string in a Lucene-like query language e.g. `createdAt > "7d"`. + # + # @param skip [Integer] The number of results to skip before returning results. + # + # @param sort [Symbol, Imagekit::Models::AssetListParams::Sort] Sort the results by one of the supported fields in ascending or descending order + # + # @param type [Symbol, Imagekit::Models::AssetListParams::Type] Filter results by asset type. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Imagekit::Models::AssetListParams + def list(params = {}) + parsed, options = Imagekit::AssetListParams.dump_request(params) + @client.request( + method: :get, + path: "v1/files", + query: parsed.transform_keys(file_type: "fileType", search_query: "searchQuery"), + model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::AssetListResponseItem], + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/imagekit/resources/beta.rb b/lib/imagekit/resources/beta.rb new file mode 100644 index 00000000..b7d7a5ea --- /dev/null +++ b/lib/imagekit/resources/beta.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Beta + # @return [Imagekit::Resources::Beta::V2] + attr_reader :v2 + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + @v2 = Imagekit::Resources::Beta::V2.new(client: client) + end + end + end +end diff --git a/lib/imagekit/resources/beta/v2.rb b/lib/imagekit/resources/beta/v2.rb new file mode 100644 index 00000000..8510456c --- /dev/null +++ b/lib/imagekit/resources/beta/v2.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Beta + class V2 + # @return [Imagekit::Resources::Beta::V2::Files] + attr_reader :files + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + @files = Imagekit::Resources::Beta::V2::Files.new(client: client) + end + end + end + end +end diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekit/resources/beta/v2/files.rb new file mode 100644 index 00000000..03370c95 --- /dev/null +++ b/lib/imagekit/resources/beta/v2/files.rb @@ -0,0 +1,110 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Beta + class V2 + class Files + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams} for more details. + # + # 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. + # + # **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. + # + # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # + # @param file_name [String] The name with which the file has to be uploaded. + # + # @param token [String] This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses i + # + # @param checks [String] Server-side checks to run on the asset. + # + # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file + # + # @param custom_metadata [Hash{Symbol=>Object}] JSON key-value pairs to associate with the asset. Create the custom metadata fie + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # + # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e + # + # @param is_private_file [Boolean] Whether to mark the file as private or not. + # + # @param is_published [Boolean] Whether to upload file as published or not. + # + # @param overwrite_ai_tags [Boolean] If set to `true` and a file already exists at the exact location, its AITags wil + # + # @param overwrite_custom_metadata [Boolean] If the request does not have `customMetadata`, and a file already exists at the + # + # @param overwrite_file [Boolean] If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # + # @param overwrite_tags [Boolean] If the request does not have `tags`, and a file already exists at the exact loca + # + # @param response_fields [Array] Array of response field keys to include in the API response body. + # + # @param tags [Array] Set the tags while uploading the file. + # + # @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. + # + # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not. + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Beta::V2::FileUploadResponse] + # + # @see Imagekit::Models::Beta::V2::FileUploadParams + def upload(params) + parsed, options = Imagekit::Beta::V2::FileUploadParams.dump_request(params) + path = + @client.base_url_overridden? ? "api/v2/files/upload" : "https://upload.imagekit.io/api/v2/files/upload" + @client.request( + method: :post, + path: path, + headers: {"content-type" => "multipart/form-data"}, + body: parsed, + model: Imagekit::Models::Beta::V2::FileUploadResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end + end +end diff --git a/lib/imagekit/resources/bulk_jobs.rb b/lib/imagekit/resources/bulk_jobs.rb deleted file mode 100644 index b1e27990..00000000 --- a/lib/imagekit/resources/bulk_jobs.rb +++ /dev/null @@ -1,100 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Resources - class BulkJobs - # Some parameter documentations has been truncated, see - # {Imagekit::Models::BulkJobCopyFolderParams} for more details. - # - # 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. - # - # @overload copy_folder(destination_path:, source_folder_path:, include_versions: nil, request_options: {}) - # - # @param destination_path [String] Full path to the destination folder where you want to copy the source folder int - # - # @param source_folder_path [String] The full path to the source folder you want to copy. - # - # @param include_versions [Boolean] Option to copy all versions of files that are nested inside the selected folder. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::BulkJobCopyFolderResponse] - # - # @see Imagekit::Models::BulkJobCopyFolderParams - def copy_folder(params) - parsed, options = Imagekit::BulkJobCopyFolderParams.dump_request(params) - @client.request( - method: :post, - path: "v1/bulkJobs/copyFolder", - body: parsed, - model: Imagekit::Models::BulkJobCopyFolderResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::BulkJobMoveFolderParams} for more details. - # - # 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. - # - # @overload move_folder(destination_path:, source_folder_path:, request_options: {}) - # - # @param destination_path [String] Full path to the destination folder where you want to move the source folder int - # - # @param source_folder_path [String] The full path to the source folder you want to move. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::BulkJobMoveFolderResponse] - # - # @see Imagekit::Models::BulkJobMoveFolderParams - def move_folder(params) - parsed, options = Imagekit::BulkJobMoveFolderParams.dump_request(params) - @client.request( - method: :post, - path: "v1/bulkJobs/moveFolder", - body: parsed, - model: Imagekit::Models::BulkJobMoveFolderResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::BulkJobRetrieveStatusParams} for more details. - # - # This API returns the status of a bulk job like copy and move folder operations. - # - # @overload retrieve_status(job_id, request_options: {}) - # - # @param job_id [String] The `jobId` is returned in the response of bulk job API e.g. copy folder or move - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::BulkJobRetrieveStatusResponse] - # - # @see Imagekit::Models::BulkJobRetrieveStatusParams - def retrieve_status(job_id, params = {}) - @client.request( - method: :get, - path: ["v1/bulkJobs/%1$s", job_id], - model: Imagekit::Models::BulkJobRetrieveStatusResponse, - options: params[:request_options] - ) - end - - # @api private - # - # @param client [Imagekit::Client] - def initialize(client:) - @client = client - end - end - end -end diff --git a/lib/imagekit/resources/cache.rb b/lib/imagekit/resources/cache.rb new file mode 100644 index 00000000..1b666377 --- /dev/null +++ b/lib/imagekit/resources/cache.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Cache + # @return [Imagekit::Resources::Cache::Invalidation] + attr_reader :invalidation + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + @invalidation = Imagekit::Resources::Cache::Invalidation.new(client: client) + end + end + end +end diff --git a/lib/imagekit/resources/files/purge.rb b/lib/imagekit/resources/cache/invalidation.rb similarity index 61% rename from lib/imagekit/resources/files/purge.rb rename to lib/imagekit/resources/cache/invalidation.rb index a0d5603d..a084abea 100644 --- a/lib/imagekit/resources/files/purge.rb +++ b/lib/imagekit/resources/cache/invalidation.rb @@ -2,54 +2,54 @@ module Imagekit module Resources - class Files - class Purge + class Cache + class Invalidation # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::PurgeExecuteParams} for more details. + # {Imagekit::Models::Cache::InvalidationCreateParams} for more details. # # 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. # - # @overload execute(url:, request_options: {}) + # @overload create(url:, request_options: {}) # # @param url [String] The full URL of the file to be purged. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::PurgeExecuteResponse] + # @return [Imagekit::Models::Cache::InvalidationCreateResponse] # - # @see Imagekit::Models::Files::PurgeExecuteParams - def execute(params) - parsed, options = Imagekit::Files::PurgeExecuteParams.dump_request(params) + # @see Imagekit::Models::Cache::InvalidationCreateParams + def create(params) + parsed, options = Imagekit::Cache::InvalidationCreateParams.dump_request(params) @client.request( method: :post, path: "v1/files/purge", body: parsed, - model: Imagekit::Models::Files::PurgeExecuteResponse, + model: Imagekit::Models::Cache::InvalidationCreateResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::PurgeStatusParams} for more details. + # {Imagekit::Models::Cache::InvalidationGetParams} for more details. # # This API returns the status of a purge cache request. # - # @overload status(request_id, request_options: {}) + # @overload get(request_id, request_options: {}) # # @param request_id [String] Should be a valid requestId. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::PurgeStatusResponse] + # @return [Imagekit::Models::Cache::InvalidationGetResponse] # - # @see Imagekit::Models::Files::PurgeStatusParams - def status(request_id, params = {}) + # @see Imagekit::Models::Cache::InvalidationGetParams + def get(request_id, params = {}) @client.request( method: :get, path: ["v1/files/purge/%1$s", request_id], - model: Imagekit::Models::Files::PurgeStatusResponse, + model: Imagekit::Models::Cache::InvalidationGetResponse, options: params[:request_options] ) end diff --git a/lib/imagekit/resources/custom_metadata_fields.rb b/lib/imagekit/resources/custom_metadata_fields.rb index 263973fd..cec7db76 100644 --- a/lib/imagekit/resources/custom_metadata_fields.rb +++ b/lib/imagekit/resources/custom_metadata_fields.rb @@ -73,7 +73,7 @@ def update(id, params = {}) # # @overload list(include_deleted: nil, request_options: {}) # - # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. Default v + # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 65179134..2841eabd 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -3,57 +3,54 @@ module Imagekit module Resources class Files - # @return [Imagekit::Resources::Files::Details] - attr_reader :details - - # @return [Imagekit::Resources::Files::Batch] - attr_reader :batch + # @return [Imagekit::Resources::Files::Bulk] + attr_reader :bulk # @return [Imagekit::Resources::Files::Versions] attr_reader :versions - # @return [Imagekit::Resources::Files::Purge] - attr_reader :purge - # @return [Imagekit::Resources::Files::Metadata] attr_reader :metadata # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileListParams} for more details. + # {Imagekit::Models::FileUpdateParams} for more details. # - # 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`. + # 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. # - # @overload list(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) + # @overload update(file_id, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) # - # @param file_type [String] Type of files to include in the result set. Accepts three values: + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param limit [String] The maximum number of results to return in response: + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, # - # @param path [String] Folder path if you want to limit the search within a specific folder. For exampl + # @param custom_metadata [Object] A key-value data to be associated with the asset. To unset a key, send `null` va # - # @param search_query [String] Query string in a Lucene-like query language e.g. `createdAt > "7d"`. + # @param description [String] Optional text to describe the contents of the file. # - # @param skip [String] The number of results to skip before returning results: + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # - # @param sort [String] You can sort based on the following fields: + # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car # - # @param type [Symbol, Imagekit::Models::FileListParams::Type] Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to includ + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Imagekit::Models::FileUpdateResponse] # - # @see Imagekit::Models::FileListParams - def list(params = {}) - parsed, options = Imagekit::FileListParams.dump_request(params) + # @see Imagekit::Models::FileUpdateParams + def update(file_id, params = {}) + parsed, options = Imagekit::FileUpdateParams.dump_request(params) @client.request( - method: :get, - path: "v1/files", - query: parsed.transform_keys(file_type: "fileType", search_query: "searchQuery"), - model: Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileListResponseItem], + method: :patch, + path: ["v1/files/%1$s/details", file_id], + body: parsed, + model: Imagekit::Models::FileUpdateResponse, options: options ) end @@ -85,34 +82,6 @@ def delete(file_id, params = {}) ) end - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileAddTagsParams} for more details. - # - # This API adds tags to multiple files in bulk. A maximum of 50 files can be - # specified at a time. - # - # @overload add_tags(file_ids:, tags:, request_options: {}) - # - # @param file_ids [Array] An array of fileIds to which you want to add tags. - # - # @param tags [Array] An array of tags that you want to add to the files. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::FileAddTagsResponse] - # - # @see Imagekit::Models::FileAddTagsParams - def add_tags(params) - parsed, options = Imagekit::FileAddTagsParams.dump_request(params) - @client.request( - method: :post, - path: "v1/files/addTags", - body: parsed, - model: Imagekit::Models::FileAddTagsResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {Imagekit::Models::FileCopyParams} for more details. # @@ -146,6 +115,30 @@ def copy(params) ) end + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileGetParams} for more details. + # + # This API returns an object with details or attributes about the current version + # of the file. + # + # @overload get(file_id, request_options: {}) + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FileGetResponse] + # + # @see Imagekit::Models::FileGetParams + def get(file_id, params = {}) + @client.request( + method: :get, + path: ["v1/files/%1$s/details", file_id], + model: Imagekit::Models::FileGetResponse, + options: params[:request_options] + ) + end + # Some parameter documentations has been truncated, see # {Imagekit::Models::FileMoveParams} for more details. # @@ -176,62 +169,6 @@ def move(params) ) end - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRemoveAITagsParams} for more details. - # - # This API removes AITags from multiple files in bulk. A maximum of 50 files can - # be specified at a time. - # - # @overload remove_ai_tags(ai_tags:, file_ids:, request_options: {}) - # - # @param ai_tags [Array] An array of AITags that you want to remove from the files. - # - # @param file_ids [Array] An array of fileIds from which you want to remove AITags. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::FileRemoveAITagsResponse] - # - # @see Imagekit::Models::FileRemoveAITagsParams - def remove_ai_tags(params) - parsed, options = Imagekit::FileRemoveAITagsParams.dump_request(params) - @client.request( - method: :post, - path: "v1/files/removeAITags", - body: parsed, - model: Imagekit::Models::FileRemoveAITagsResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRemoveTagsParams} for more details. - # - # This API removes tags from multiple files in bulk. A maximum of 50 files can be - # specified at a time. - # - # @overload remove_tags(file_ids:, tags:, request_options: {}) - # - # @param file_ids [Array] An array of fileIds from which you want to remove tags. - # - # @param tags [Array] An array of tags that you want to remove from the files. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::FileRemoveTagsResponse] - # - # @see Imagekit::Models::FileRemoveTagsParams - def remove_tags(params) - parsed, options = Imagekit::FileRemoveTagsParams.dump_request(params) - @client.request( - method: :post, - path: "v1/files/removeTags", - body: parsed, - model: Imagekit::Models::FileRemoveTagsResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {Imagekit::Models::FileRenameParams} for more details. # @@ -266,7 +203,7 @@ def rename(params) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadV1Params} for more details. + # {Imagekit::Models::FileUploadParams} for more details. # # 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 @@ -296,9 +233,9 @@ def rename(params) # - [Quick start guides](/docs/quick-start-guides) for various frameworks and # technologies. # - # @overload upload_v1(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [String] Pass the HTTP URL or base64 string. When passing a URL in the file parameter, pl + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # @@ -308,47 +245,49 @@ def rename(params) # # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file # - # @param custom_metadata [String] Stringified JSON key-value data to be associated with the asset. + # @param custom_metadata [Hash{Symbol=>Object}] JSON key-value pairs to associate with the asset. Create the custom metadata fie # - # @param expire [String] The time until your signature is valid. It must be a [Unix time](https://en.wiki + # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [String] Stringified JSON object with an array of extensions to be applied to the image. + # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki + # + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # - # @param is_private_file [Symbol, Imagekit::Models::FileUploadV1Params::IsPrivateFile] Whether to mark the file as private or not. + # @param is_private_file [Boolean] Whether to mark the file as private or not. # - # @param is_published [Symbol, Imagekit::Models::FileUploadV1Params::IsPublished] Whether to upload file as published or not. + # @param is_published [Boolean] Whether to upload file as published or not. # - # @param overwrite_ai_tags [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteAITags] If set to `true` and a file already exists at the exact location, its AITags wil + # @param overwrite_ai_tags [Boolean] If set to `true` and a file already exists at the exact location, its AITags wil # - # @param overwrite_custom_metadata [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteCustomMetadata] If the request does not have `customMetadata`, and a file already exists at the + # @param overwrite_custom_metadata [Boolean] If the request does not have `customMetadata`, and a file already exists at the # - # @param overwrite_file [String] If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # @param overwrite_file [Boolean] If `false` and `useUniqueFileName` is also `false`, and a file already exists at # - # @param overwrite_tags [Symbol, Imagekit::Models::FileUploadV1Params::OverwriteTags] If the request does not have `tags`, and a file already exists at the exact loca + # @param overwrite_tags [Boolean] If the request does not have `tags`, and a file already exists at the exact loca # # @param public_key [String] Your ImageKit.io public key. This field is only required for authentication when # - # @param response_fields [String] Comma-separated values of the fields that you want the API to return in the resp + # @param response_fields [Array] Array of response field keys to include in the API response body. # # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a # - # @param tags [String] Set the tags while uploading the file. + # @param tags [Array] Set the tags while uploading the file. # - # @param transformation [String] Stringified JSON object with properties for pre and post transformations: + # @param transformation [Imagekit::Models::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. # - # @param use_unique_file_name [Symbol, Imagekit::Models::FileUploadV1Params::UseUniqueFileName] Whether to use a unique filename for this file or not. + # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not. # # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FileUploadV1Response] + # @return [Imagekit::Models::FileUploadResponse] # - # @see Imagekit::Models::FileUploadV1Params - def upload_v1(params) - parsed, options = Imagekit::FileUploadV1Params.dump_request(params) + # @see Imagekit::Models::FileUploadParams + def upload(params) + parsed, options = Imagekit::FileUploadParams.dump_request(params) path = @client.base_url_overridden? ? "api/v1/files/upload" : "https://upload.imagekit.io/api/v1/files/upload" @client.request( @@ -356,97 +295,7 @@ def upload_v1(params) path: path, headers: {"content-type" => "multipart/form-data"}, body: parsed, - model: Imagekit::Models::FileUploadV1Response, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadV2Params} for more details. - # - # 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. - # - # **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. - # - # @overload upload_v2(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) - # - # @param file [String] Pass the HTTP URL or base64 string. When passing a URL in the file parameter, pl - # - # @param file_name [String] The name with which the file has to be uploaded. - # - # @param token [String] This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses i - # - # @param checks [String] Server-side checks to run on the asset. - # - # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file - # - # @param custom_metadata [String] Stringified JSON key-value data to be associated with the asset. - # - # @param extensions [String] Stringified JSON object with an array of extensions to be applied to the image. - # - # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e - # - # @param is_private_file [Symbol, Imagekit::Models::FileUploadV2Params::IsPrivateFile] Whether to mark the file as private or not. - # - # @param is_published [Symbol, Imagekit::Models::FileUploadV2Params::IsPublished] Whether to upload file as published or not. - # - # @param overwrite_ai_tags [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteAITags] If set to `true` and a file already exists at the exact location, its AITags wil - # - # @param overwrite_custom_metadata [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteCustomMetadata] If the request does not have `customMetadata`, and a file already exists at the - # - # @param overwrite_file [String] If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # - # @param overwrite_tags [Symbol, Imagekit::Models::FileUploadV2Params::OverwriteTags] If the request does not have `tags`, and a file already exists at the exact loca - # - # @param response_fields [String] Comma-separated values of the fields that you want the API to return in the resp - # - # @param tags [String] Set the tags while uploading the file. - # - # @param transformation [String] Stringified JSON object with properties for pre and post transformations: - # - # @param use_unique_file_name [Symbol, Imagekit::Models::FileUploadV2Params::UseUniqueFileName] Whether to use a unique filename for this file or not. - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::FileUploadV2Response] - # - # @see Imagekit::Models::FileUploadV2Params - def upload_v2(params) - parsed, options = Imagekit::FileUploadV2Params.dump_request(params) - path = - @client.base_url_overridden? ? "api/v2/files/upload" : "https://upload.imagekit.io/api/v2/files/upload" - @client.request( - method: :post, - path: path, - headers: {"content-type" => "multipart/form-data"}, - body: parsed, - model: Imagekit::Models::FileUploadV2Response, + model: Imagekit::Models::FileUploadResponse, options: options ) end @@ -456,10 +305,8 @@ def upload_v2(params) # @param client [Imagekit::Client] def initialize(client:) @client = client - @details = Imagekit::Resources::Files::Details.new(client: client) - @batch = Imagekit::Resources::Files::Batch.new(client: client) + @bulk = Imagekit::Resources::Files::Bulk.new(client: client) @versions = Imagekit::Resources::Files::Versions.new(client: client) - @purge = Imagekit::Resources::Files::Purge.new(client: client) @metadata = Imagekit::Resources::Files::Metadata.new(client: client) end end diff --git a/lib/imagekit/resources/files/batch.rb b/lib/imagekit/resources/files/batch.rb deleted file mode 100644 index 16a39c81..00000000 --- a/lib/imagekit/resources/files/batch.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Resources - class Files - class Batch - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BatchDeleteParams} for more details. - # - # 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. - # - # @overload delete(file_ids:, request_options: {}) - # - # @param file_ids [Array] An array of fileIds which you want to delete. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::Files::BatchDeleteResponse] - # - # @see Imagekit::Models::Files::BatchDeleteParams - def delete(params) - parsed, options = Imagekit::Files::BatchDeleteParams.dump_request(params) - @client.request( - method: :post, - path: "v1/files/batch/deleteByFileIds", - body: parsed, - model: Imagekit::Models::Files::BatchDeleteResponse, - options: options - ) - end - - # @api private - # - # @param client [Imagekit::Client] - def initialize(client:) - @client = client - end - end - end - end -end diff --git a/lib/imagekit/resources/files/bulk.rb b/lib/imagekit/resources/files/bulk.rb new file mode 100644 index 00000000..1f09cdbe --- /dev/null +++ b/lib/imagekit/resources/files/bulk.rb @@ -0,0 +1,131 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Files + class Bulk + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkDeleteParams} for more details. + # + # 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. + # + # @overload delete(file_ids:, request_options: {}) + # + # @param file_ids [Array] An array of fileIds which you want to delete. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::BulkDeleteResponse] + # + # @see Imagekit::Models::Files::BulkDeleteParams + def delete(params) + parsed, options = Imagekit::Files::BulkDeleteParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/batch/deleteByFileIds", + body: parsed, + model: Imagekit::Models::Files::BulkDeleteResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkAddTagsParams} for more details. + # + # This API adds tags to multiple files in bulk. A maximum of 50 files can be + # specified at a time. + # + # @overload add_tags(file_ids:, tags:, request_options: {}) + # + # @param file_ids [Array] An array of fileIds to which you want to add tags. + # + # @param tags [Array] An array of tags that you want to add to the files. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::BulkAddTagsResponse] + # + # @see Imagekit::Models::Files::BulkAddTagsParams + def add_tags(params) + parsed, options = Imagekit::Files::BulkAddTagsParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/addTags", + body: parsed, + model: Imagekit::Models::Files::BulkAddTagsResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkRemoveAITagsParams} for more details. + # + # This API removes AITags from multiple files in bulk. A maximum of 50 files can + # be specified at a time. + # + # @overload remove_ai_tags(ai_tags:, file_ids:, request_options: {}) + # + # @param ai_tags [Array] An array of AITags that you want to remove from the files. + # + # @param file_ids [Array] An array of fileIds from which you want to remove AITags. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::BulkRemoveAITagsResponse] + # + # @see Imagekit::Models::Files::BulkRemoveAITagsParams + def remove_ai_tags(params) + parsed, options = Imagekit::Files::BulkRemoveAITagsParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/removeAITags", + body: parsed, + model: Imagekit::Models::Files::BulkRemoveAITagsResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::BulkRemoveTagsParams} for more details. + # + # This API removes tags from multiple files in bulk. A maximum of 50 files can be + # specified at a time. + # + # @overload remove_tags(file_ids:, tags:, request_options: {}) + # + # @param file_ids [Array] An array of fileIds from which you want to remove tags. + # + # @param tags [Array] An array of tags that you want to remove from the files. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::BulkRemoveTagsResponse] + # + # @see Imagekit::Models::Files::BulkRemoveTagsParams + def remove_tags(params) + parsed, options = Imagekit::Files::BulkRemoveTagsParams.dump_request(params) + @client.request( + method: :post, + path: "v1/files/removeTags", + body: parsed, + model: Imagekit::Models::Files::BulkRemoveTagsResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/files/details.rb b/lib/imagekit/resources/files/details.rb deleted file mode 100644 index ad32acd8..00000000 --- a/lib/imagekit/resources/files/details.rb +++ /dev/null @@ -1,81 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Resources - class Files - class Details - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailRetrieveParams} for more details. - # - # This API returns an object with details or attributes about the current version - # of the file. - # - # @overload retrieve(file_id, request_options: {}) - # - # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::Files::DetailRetrieveResponse] - # - # @see Imagekit::Models::Files::DetailRetrieveParams - def retrieve(file_id, params = {}) - @client.request( - method: :get, - path: ["v1/files/%1$s/details", file_id], - model: Imagekit::Models::Files::DetailRetrieveResponse, - options: params[:request_options] - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::DetailUpdateParams} for more details. - # - # 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. - # - # @overload update(file_id, custom_coordinates: nil, custom_metadata: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) - # - # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc - # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Object] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, Imagekit::Models::Files::DetailUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param publish [Imagekit::Models::Files::DetailUpdateParams::Publish] Configure the publication status of a file and its versions. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::Files::DetailUpdateResponse] - # - # @see Imagekit::Models::Files::DetailUpdateParams - def update(file_id, params = {}) - parsed, options = Imagekit::Files::DetailUpdateParams.dump_request(params) - @client.request( - method: :patch, - path: ["v1/files/%1$s/details", file_id], - body: parsed, - model: Imagekit::Models::Files::DetailUpdateResponse, - options: options - ) - end - - # @api private - # - # @param client [Imagekit::Client] - def initialize(client:) - @client = client - end - end - end - end -end diff --git a/lib/imagekit/resources/files/metadata.rb b/lib/imagekit/resources/files/metadata.rb index 08992f14..ea04498b 100644 --- a/lib/imagekit/resources/files/metadata.rb +++ b/lib/imagekit/resources/files/metadata.rb @@ -5,7 +5,7 @@ module Resources class Files class Metadata # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::MetadataRetrieveParams} for more details. + # {Imagekit::Models::Files::MetadataGetParams} for more details. # # You can programmatically get image EXIF, pHash, and other metadata for uploaded # files in the ImageKit.io media library using this API. @@ -13,46 +13,46 @@ class Metadata # You can also get the metadata in upload API response by passing `metadata` in # `responseFields` parameter. # - # @overload retrieve(file_id, request_options: {}) + # @overload get(file_id, request_options: {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::MetadataRetrieveResponse] + # @return [Imagekit::Models::Files::MetadataGetResponse] # - # @see Imagekit::Models::Files::MetadataRetrieveParams - def retrieve(file_id, params = {}) + # @see Imagekit::Models::Files::MetadataGetParams + def get(file_id, params = {}) @client.request( method: :get, path: ["v1/files/%1$s/metadata", file_id], - model: Imagekit::Models::Files::MetadataRetrieveResponse, + model: Imagekit::Models::Files::MetadataGetResponse, options: params[:request_options] ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::MetadataFromURLParams} for more details. + # {Imagekit::Models::Files::MetadataGetFromURLParams} for more details. # # Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL # using this API. # - # @overload from_url(url:, request_options: {}) + # @overload get_from_url(url:, request_options: {}) # # @param url [String] Should be a valid file URL. It should be accessible using your ImageKit.io accou # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::MetadataFromURLResponse] + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse] # - # @see Imagekit::Models::Files::MetadataFromURLParams - def from_url(params) - parsed, options = Imagekit::Files::MetadataFromURLParams.dump_request(params) + # @see Imagekit::Models::Files::MetadataGetFromURLParams + def get_from_url(params) + parsed, options = Imagekit::Files::MetadataGetFromURLParams.dump_request(params) @client.request( method: :get, path: "v1/files/metadata", query: parsed, - model: Imagekit::Models::Files::MetadataFromURLResponse, + model: Imagekit::Models::Files::MetadataGetFromURLResponse, options: options ) end diff --git a/lib/imagekit/resources/files/versions.rb b/lib/imagekit/resources/files/versions.rb index 2a87ed03..31d7f743 100644 --- a/lib/imagekit/resources/files/versions.rb +++ b/lib/imagekit/resources/files/versions.rb @@ -4,36 +4,6 @@ module Imagekit module Resources class Files class Versions - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionRetrieveParams} for more details. - # - # This API returns an object with details or attributes of a file version. - # - # @overload retrieve(version_id, file_id:, request_options: {}) - # - # @param version_id [String] The unique `versionId` of the uploaded file. `versionId` is returned in list and - # - # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::Files::VersionRetrieveResponse] - # - # @see Imagekit::Models::Files::VersionRetrieveParams - def retrieve(version_id, params) - parsed, options = Imagekit::Files::VersionRetrieveParams.dump_request(params) - file_id = - parsed.delete(:file_id) do - raise ArgumentError.new("missing required path argument #{_1}") - end - @client.request( - method: :get, - path: ["v1/files/%1$s/versions/%2$s", file_id, version_id], - model: Imagekit::Models::Files::VersionRetrieveResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {Imagekit::Models::Files::VersionListParams} for more details. # @@ -90,6 +60,36 @@ def delete(version_id, params) ) end + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Files::VersionGetParams} for more details. + # + # This API returns an object with details or attributes of a file version. + # + # @overload get(version_id, file_id:, request_options: {}) + # + # @param version_id [String] The unique `versionId` of the uploaded file. `versionId` is returned in list and + # + # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Files::VersionGetResponse] + # + # @see Imagekit::Models::Files::VersionGetParams + def get(version_id, params) + parsed, options = Imagekit::Files::VersionGetParams.dump_request(params) + file_id = + parsed.delete(:file_id) do + raise ArgumentError.new("missing required path argument #{_1}") + end + @client.request( + method: :get, + path: ["v1/files/%1$s/versions/%2$s", file_id, version_id], + model: Imagekit::Models::Files::VersionGetResponse, + options: options + ) + end + # Some parameter documentations has been truncated, see # {Imagekit::Models::Files::VersionRestoreParams} for more details. # diff --git a/lib/imagekit/resources/folder.rb b/lib/imagekit/resources/folder.rb deleted file mode 100644 index 02ba9cda..00000000 --- a/lib/imagekit/resources/folder.rb +++ /dev/null @@ -1,68 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Resources - class Folder - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderCreateParams} for more details. - # - # 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. - # - # @overload create(folder_name:, parent_folder_path:, request_options: {}) - # - # @param folder_name [String] The folder will be created with this name. - # - # @param parent_folder_path [String] The folder where the new folder should be created, for root use `/` else the pat - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Object] - # - # @see Imagekit::Models::FolderCreateParams - def create(params) - parsed, options = Imagekit::FolderCreateParams.dump_request(params) - @client.request( - method: :post, - path: "v1/folder", - body: parsed, - model: Imagekit::Internal::Type::Unknown, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderDeleteParams} for more details. - # - # This will delete a folder and all its contents permanently. The API returns an - # empty response. - # - # @overload delete(folder_path:, request_options: {}) - # - # @param folder_path [String] Full path to the folder you want to delete. For example `/folder/to/delete/`. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Object] - # - # @see Imagekit::Models::FolderDeleteParams - def delete(params) - parsed, options = Imagekit::FolderDeleteParams.dump_request(params) - @client.request( - method: :delete, - path: "v1/folder", - body: parsed, - model: Imagekit::Internal::Type::Unknown, - options: options - ) - end - - # @api private - # - # @param client [Imagekit::Client] - def initialize(client:) - @client = client - end - end - end -end diff --git a/lib/imagekit/resources/folders.rb b/lib/imagekit/resources/folders.rb new file mode 100644 index 00000000..1fd9304b --- /dev/null +++ b/lib/imagekit/resources/folders.rb @@ -0,0 +1,166 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Folders + # @return [Imagekit::Resources::Folders::Job] + attr_reader :job + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderCreateParams} for more details. + # + # 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. + # + # @overload create(folder_name:, parent_folder_path:, request_options: {}) + # + # @param folder_name [String] The folder will be created with this name. + # + # @param parent_folder_path [String] The folder where the new folder should be created, for root use `/` else the pat + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Imagekit::Models::FolderCreateParams + def create(params) + parsed, options = Imagekit::FolderCreateParams.dump_request(params) + @client.request( + method: :post, + path: "v1/folder", + body: parsed, + model: Imagekit::Internal::Type::Unknown, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderDeleteParams} for more details. + # + # This will delete a folder and all its contents permanently. The API returns an + # empty response. + # + # @overload delete(folder_path:, request_options: {}) + # + # @param folder_path [String] Full path to the folder you want to delete. For example `/folder/to/delete/`. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Imagekit::Models::FolderDeleteParams + def delete(params) + parsed, options = Imagekit::FolderDeleteParams.dump_request(params) + @client.request( + method: :delete, + path: "v1/folder", + body: parsed, + model: Imagekit::Internal::Type::Unknown, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderCopyParams} for more details. + # + # 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. + # + # @overload copy(destination_path:, source_folder_path:, include_versions: nil, request_options: {}) + # + # @param destination_path [String] Full path to the destination folder where you want to copy the source folder int + # + # @param source_folder_path [String] The full path to the source folder you want to copy. + # + # @param include_versions [Boolean] Option to copy all versions of files that are nested inside the selected folder. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FolderCopyResponse] + # + # @see Imagekit::Models::FolderCopyParams + def copy(params) + parsed, options = Imagekit::FolderCopyParams.dump_request(params) + @client.request( + method: :post, + path: "v1/bulkJobs/copyFolder", + body: parsed, + model: Imagekit::Models::FolderCopyResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderMoveParams} for more details. + # + # 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. + # + # @overload move(destination_path:, source_folder_path:, request_options: {}) + # + # @param destination_path [String] Full path to the destination folder where you want to move the source folder int + # + # @param source_folder_path [String] The full path to the source folder you want to move. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FolderMoveResponse] + # + # @see Imagekit::Models::FolderMoveParams + def move(params) + parsed, options = Imagekit::FolderMoveParams.dump_request(params) + @client.request( + method: :post, + path: "v1/bulkJobs/moveFolder", + body: parsed, + model: Imagekit::Models::FolderMoveResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderRenameParams} for more details. + # + # 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. + # + # @overload rename(folder_path:, new_folder_name:, purge_cache: nil, request_options: {}) + # + # @param folder_path [String] The full path to the folder you want to rename. + # + # @param new_folder_name [String] The new name for the folder. + # + # @param purge_cache [Boolean] Option to purge cache for the old nested files and their versions' URLs. + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::FolderRenameResponse] + # + # @see Imagekit::Models::FolderRenameParams + def rename(params) + parsed, options = Imagekit::FolderRenameParams.dump_request(params) + @client.request( + method: :post, + path: "v1/bulkJobs/renameFolder", + body: parsed, + model: Imagekit::Models::FolderRenameResponse, + options: options + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + @job = Imagekit::Resources::Folders::Job.new(client: client) + end + end + end +end diff --git a/lib/imagekit/resources/folders/job.rb b/lib/imagekit/resources/folders/job.rb new file mode 100644 index 00000000..8c900133 --- /dev/null +++ b/lib/imagekit/resources/folders/job.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Folders + class Job + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Folders::JobGetParams} for more details. + # + # This API returns the status of a bulk job like copy and move folder operations. + # + # @overload get(job_id, request_options: {}) + # + # @param job_id [String] The `jobId` is returned in the response of bulk job API e.g. copy folder or move + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekit::Models::Folders::JobGetResponse] + # + # @see Imagekit::Models::Folders::JobGetParams + def get(job_id, params = {}) + @client.request( + method: :get, + path: ["v1/bulkJobs/%1$s", job_id], + model: Imagekit::Models::Folders::JobGetResponse, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/rbi/imagekit/client.rbi b/rbi/imagekit/client.rbi index 6546b121..07b9089f 100644 --- a/rbi/imagekit/client.rbi +++ b/rbi/imagekit/client.rbi @@ -24,15 +24,21 @@ module Imagekit sig { returns(Imagekit::Resources::Files) } attr_reader :files - sig { returns(Imagekit::Resources::Folder) } - attr_reader :folder + sig { returns(Imagekit::Resources::Assets) } + attr_reader :assets - sig { returns(Imagekit::Resources::BulkJobs) } - attr_reader :bulk_jobs + sig { returns(Imagekit::Resources::Cache) } + attr_reader :cache + + sig { returns(Imagekit::Resources::Folders) } + attr_reader :folders sig { returns(Imagekit::Resources::Accounts) } attr_reader :accounts + sig { returns(Imagekit::Resources::Beta) } + attr_reader :beta + # @api private sig { override.returns(T::Hash[String, String]) } private def auth_headers diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 7ab12638..63a6bf4a 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -1,13 +1,13 @@ # typed: strong module Imagekit - AccountGetUsageParams = Imagekit::Models::AccountGetUsageParams + Accounts = Imagekit::Models::Accounts - BulkJobCopyFolderParams = Imagekit::Models::BulkJobCopyFolderParams + AssetListParams = Imagekit::Models::AssetListParams - BulkJobMoveFolderParams = Imagekit::Models::BulkJobMoveFolderParams + Beta = Imagekit::Models::Beta - BulkJobRetrieveStatusParams = Imagekit::Models::BulkJobRetrieveStatusParams + Cache = Imagekit::Models::Cache CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams @@ -21,39 +21,31 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams - ExifDetails = Imagekit::Models::ExifDetails - - ExifImage = Imagekit::Models::ExifImage - - FileAddTagsParams = Imagekit::Models::FileAddTagsParams - FileCopyParams = Imagekit::Models::FileCopyParams FileDeleteParams = Imagekit::Models::FileDeleteParams - FileListParams = Imagekit::Models::FileListParams + FileGetParams = Imagekit::Models::FileGetParams FileMoveParams = Imagekit::Models::FileMoveParams - FileRemoveAITagsParams = Imagekit::Models::FileRemoveAITagsParams - - FileRemoveTagsParams = Imagekit::Models::FileRemoveTagsParams - FileRenameParams = Imagekit::Models::FileRenameParams Files = Imagekit::Models::Files - FileUploadV1Params = Imagekit::Models::FileUploadV1Params + FileUpdateParams = Imagekit::Models::FileUpdateParams + + FileUploadParams = Imagekit::Models::FileUploadParams - FileUploadV2Params = Imagekit::Models::FileUploadV2Params + FolderCopyParams = Imagekit::Models::FolderCopyParams FolderCreateParams = Imagekit::Models::FolderCreateParams FolderDeleteParams = Imagekit::Models::FolderDeleteParams - Gps = Imagekit::Models::Gps + FolderMoveParams = Imagekit::Models::FolderMoveParams - Interoperability = Imagekit::Models::Interoperability + FolderRenameParams = Imagekit::Models::FolderRenameParams - Thumbnail = Imagekit::Models::Thumbnail + Folders = Imagekit::Models::Folders end diff --git a/rbi/imagekit/models/account_get_usage_params.rbi b/rbi/imagekit/models/account_get_usage_params.rbi deleted file mode 100644 index 50e04f83..00000000 --- a/rbi/imagekit/models/account_get_usage_params.rbi +++ /dev/null @@ -1,55 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class AccountGetUsageParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::AccountGetUsageParams, Imagekit::Internal::AnyHash) - end - - # 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. - sig { returns(Date) } - attr_accessor :end_date - - # 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. - sig { returns(Date) } - attr_accessor :start_date - - sig do - params( - end_date: Date, - start_date: Date, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # 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. - end_date:, - # 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. - start_date:, - request_options: {} - ) - end - - sig do - override.returns( - { - end_date: Date, - start_date: Date, - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/account_get_usage_response.rbi b/rbi/imagekit/models/account_get_usage_response.rbi deleted file mode 100644 index b470cb30..00000000 --- a/rbi/imagekit/models/account_get_usage_response.rbi +++ /dev/null @@ -1,87 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class AccountGetUsageResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::AccountGetUsageResponse, - Imagekit::Internal::AnyHash - ) - end - - # Amount of bandwidth used in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :bandwidth_bytes - - sig { params(bandwidth_bytes: Integer).void } - attr_writer :bandwidth_bytes - - # Number of extension units used. - sig { returns(T.nilable(Integer)) } - attr_reader :extension_units_count - - sig { params(extension_units_count: Integer).void } - attr_writer :extension_units_count - - # Storage used by media library in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :media_library_storage_bytes - - sig { params(media_library_storage_bytes: Integer).void } - attr_writer :media_library_storage_bytes - - # Storage used by the original cache in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :original_cache_storage_bytes - - sig { params(original_cache_storage_bytes: Integer).void } - attr_writer :original_cache_storage_bytes - - # Number of video processing units used. - sig { returns(T.nilable(Integer)) } - attr_reader :video_processing_units_count - - sig { params(video_processing_units_count: Integer).void } - attr_writer :video_processing_units_count - - sig do - params( - bandwidth_bytes: Integer, - extension_units_count: Integer, - media_library_storage_bytes: Integer, - original_cache_storage_bytes: Integer, - video_processing_units_count: Integer - ).returns(T.attached_class) - end - def self.new( - # Amount of bandwidth used in bytes. - bandwidth_bytes: nil, - # Number of extension units used. - extension_units_count: nil, - # Storage used by media library in bytes. - media_library_storage_bytes: nil, - # Storage used by the original cache in bytes. - original_cache_storage_bytes: nil, - # Number of video processing units used. - video_processing_units_count: nil - ) - end - - sig do - override.returns( - { - bandwidth_bytes: Integer, - extension_units_count: Integer, - media_library_storage_bytes: Integer, - original_cache_storage_bytes: Integer, - video_processing_units_count: Integer - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi new file mode 100644 index 00000000..9f3c9806 --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -0,0 +1,233 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class OriginCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Imagekit::Accounts::OriginCreateParams::Type::OrSymbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + sig { returns(String) } + attr_accessor :client_email + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + sig { returns(String) } + attr_accessor :sas_token + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + forward_host_header_to_origin: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + type:, + # Custom S3-compatible endpoint. + endpoint:, + # Akeneo instance base URL. + base_url:, + client_email:, + private_key:, + account_name:, + container:, + sas_token:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + endpoint: String, + s3_force_path_style: T::Boolean, + base_url: String, + forward_host_header_to_origin: T::Boolean, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Accounts::OriginCreateParams::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKENEO_PIM = + T.let( + :AKENEO_PIM, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_create_response.rbi b/rbi/imagekit/models/accounts/origin_create_response.rbi new file mode 100644 index 00000000..3fdd0694 --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_create_response.rbi @@ -0,0 +1,998 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + # Origin object as returned by the API (sensitive fields removed). + module OriginCreateResponse + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::S3, + Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, + Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, + Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, + Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::S3, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginCreateResponse::S3::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + S3 = + T.let( + :S3, + Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style + + sig do + returns( + Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + endpoint: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + s3_force_path_style: T::Boolean, + type: + Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + # Use path-style S3 URLs? + s3_force_path_style:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + s3_force_path_style: T::Boolean, + type: + Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + S3_COMPATIBLE = + T.let( + :S3_COMPATIBLE, + Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY_BACKUP = + T.let( + :CLOUDINARY_BACKUP, + Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(T.anything) } + attr_accessor :base_url + + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + base_url: T.anything, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Root URL for the web folder origin. + base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + base_url: T.anything, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WEB_FOLDER = + T.let( + :WEB_FOLDER, + Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WEB_PROXY = + T.let( + :WEB_PROXY, + Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + client_email: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + bucket:, + client_email:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + client_email: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GCS = + T.let( + :GCS, + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + account_name: String, + container: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + account_name:, + container:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + account_name: String, + container: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AZURE_BLOB = + T.let( + :AZURE_BLOB, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(T.anything) } + attr_accessor :base_url + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + base_url: T.anything, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Akeneo instance base URL. + base_url:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + base_url: T.anything, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKENEO_PIM = + T.let( + :AKENEO_PIM, + Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[Imagekit::Models::Accounts::OriginCreateResponse::Variants] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/files/metadata_retrieve_params.rbi b/rbi/imagekit/models/accounts/origin_delete_params.rbi similarity index 81% rename from rbi/imagekit/models/files/metadata_retrieve_params.rbi rename to rbi/imagekit/models/accounts/origin_delete_params.rbi index 605abe12..02d3f036 100644 --- a/rbi/imagekit/models/files/metadata_retrieve_params.rbi +++ b/rbi/imagekit/models/accounts/origin_delete_params.rbi @@ -2,15 +2,15 @@ module Imagekit module Models - module Files - class MetadataRetrieveParams < Imagekit::Internal::Type::BaseModel + module Accounts + class OriginDeleteParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::MetadataRetrieveParams, + Imagekit::Accounts::OriginDeleteParams, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/origin_get_params.rbi b/rbi/imagekit/models/accounts/origin_get_params.rbi new file mode 100644 index 00000000..6ffd3f1a --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_get_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class OriginGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginGetParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_get_response.rbi b/rbi/imagekit/models/accounts/origin_get_response.rbi new file mode 100644 index 00000000..16d88f4a --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_get_response.rbi @@ -0,0 +1,998 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + # Origin object as returned by the API (sensitive fields removed). + module OriginGetResponse + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::S3, + Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, + Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, + Imagekit::Models::Accounts::OriginGetResponse::WebFolder, + Imagekit::Models::Accounts::OriginGetResponse::WebProxy, + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::S3, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginGetResponse::S3::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginGetResponse::S3::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + S3 = + T.let( + :S3, + Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style + + sig do + returns( + Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + endpoint: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + s3_force_path_style: T::Boolean, + type: + Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + # Use path-style S3 URLs? + s3_force_path_style:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + s3_force_path_style: T::Boolean, + type: + Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + S3_COMPATIBLE = + T.let( + :S3_COMPATIBLE, + Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY_BACKUP = + T.let( + :CLOUDINARY_BACKUP, + Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(T.anything) } + attr_accessor :base_url + + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + base_url: T.anything, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Root URL for the web folder origin. + base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + base_url: T.anything, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WEB_FOLDER = + T.let( + :WEB_FOLDER, + Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WEB_PROXY = + T.let( + :WEB_PROXY, + Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + client_email: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + bucket:, + client_email:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + client_email: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GCS = + T.let( + :GCS, + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + account_name: String, + container: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + account_name:, + container:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + account_name: String, + container: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AZURE_BLOB = + T.let( + :AZURE_BLOB, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(T.anything) } + attr_accessor :base_url + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + base_url: T.anything, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Akeneo instance base URL. + base_url:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + base_url: T.anything, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKENEO_PIM = + T.let( + :AKENEO_PIM, + Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[Imagekit::Models::Accounts::OriginGetResponse::Variants] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_list_params.rbi b/rbi/imagekit/models/accounts/origin_list_params.rbi new file mode 100644 index 00000000..8179eab0 --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_list_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class OriginListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginListParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi new file mode 100644 index 00000000..5b0b3c35 --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -0,0 +1,1008 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + # Origin object as returned by the API (sensitive fields removed). + module OriginListResponseItem + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::S3, + Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, + Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, + Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, + Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, + Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::S3, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginListResponseItem::S3::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + S3 = + T.let( + :S3, + Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style + + sig do + returns( + Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + endpoint: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + s3_force_path_style: T::Boolean, + type: + Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + # Use path-style S3 URLs? + s3_force_path_style:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + s3_force_path_style: T::Boolean, + type: + Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + S3_COMPATIBLE = + T.let( + :S3_COMPATIBLE, + Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY_BACKUP = + T.let( + :CLOUDINARY_BACKUP, + Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(T.anything) } + attr_accessor :base_url + + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + base_url: T.anything, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Root URL for the web folder origin. + base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + base_url: T.anything, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WEB_FOLDER = + T.let( + :WEB_FOLDER, + Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WEB_PROXY = + T.let( + :WEB_PROXY, + Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + client_email: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + bucket:, + client_email:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + client_email: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GCS = + T.let( + :GCS, + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + account_name: String, + container: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + account_name:, + container:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + account_name: String, + container: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AZURE_BLOB = + T.let( + :AZURE_BLOB, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(T.anything) } + attr_accessor :base_url + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + base_url: T.anything, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Akeneo instance base URL. + base_url:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + base_url: T.anything, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKENEO_PIM = + T.let( + :AKENEO_PIM, + Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::Variants + ] + ) + end + def self.variants + end + end + + OriginListResponse = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: Imagekit::Models::Accounts::OriginListResponseItem + ], + Imagekit::Internal::Type::Converter + ) + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi new file mode 100644 index 00000000..589c337f --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -0,0 +1,233 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class OriginUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + sig { returns(String) } + attr_accessor :client_email + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + sig { returns(String) } + attr_accessor :sas_token + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + forward_host_header_to_origin: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + type:, + # Custom S3-compatible endpoint. + endpoint:, + # Akeneo instance base URL. + base_url:, + client_email:, + private_key:, + account_name:, + container:, + sas_token:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + endpoint: String, + s3_force_path_style: T::Boolean, + base_url: String, + forward_host_header_to_origin: T::Boolean, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Accounts::OriginUpdateParams::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKENEO_PIM = + T.let( + :AKENEO_PIM, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_update_response.rbi b/rbi/imagekit/models/accounts/origin_update_response.rbi new file mode 100644 index 00000000..57a8a3bc --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_update_response.rbi @@ -0,0 +1,998 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + # Origin object as returned by the API (sensitive fields removed). + module OriginUpdateResponse + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::S3, + Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, + Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, + Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, + Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::S3, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + S3 = + T.let( + :S3, + Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style + + sig do + returns( + Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + endpoint: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + s3_force_path_style: T::Boolean, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + # Use path-style S3 URLs? + s3_force_path_style:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + s3_force_path_style: T::Boolean, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + S3_COMPATIBLE = + T.let( + :S3_COMPATIBLE, + Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Path prefix inside the bucket. + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # S3 bucket name. + bucket:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + # Path prefix inside the bucket. + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY_BACKUP = + T.let( + :CLOUDINARY_BACKUP, + Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(T.anything) } + attr_accessor :base_url + + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + base_url: T.anything, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Root URL for the web folder origin. + base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + base_url: T.anything, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WEB_FOLDER = + T.let( + :WEB_FOLDER, + Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WEB_PROXY = + T.let( + :WEB_PROXY, + Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + bucket: String, + client_email: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + bucket:, + client_email:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + bucket: String, + client_email: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GCS = + T.let( + :GCS, + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(T.anything) } + attr_accessor :prefix + + sig do + returns( + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + account_name: String, + container: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + account_name:, + container:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + prefix:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + account_name: String, + container: String, + include_canonical_header: T::Boolean, + name: String, + prefix: T.anything, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AZURE_BLOB = + T.let( + :AZURE_BLOB, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(T.anything) } + attr_accessor :base_url + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig do + returns( + Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::TaggedSymbol + ) + end + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + base_url: T.anything, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::OrSymbol, + base_url_for_canonical_header: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Akeneo instance base URL. + base_url:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, + type:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil + ) + end + + sig do + override.returns( + { + id: String, + base_url: T.anything, + include_canonical_header: T::Boolean, + name: String, + type: + Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::TaggedSymbol, + base_url_for_canonical_header: String + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKENEO_PIM = + T.let( + :AKENEO_PIM, + Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[Imagekit::Models::Accounts::OriginUpdateResponse::Variants] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi new file mode 100644 index 00000000..3cc8ddff --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi @@ -0,0 +1,351 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointCreateParams, + Imagekit::Internal::AnyHash + ) + end + + # Description of the URL endpoint. + sig { returns(String) } + attr_accessor :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. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :origins + + sig { params(origins: T::Array[String]).void } + attr_writer :origins + + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + sig { returns(T.nilable(String)) } + attr_reader :url_prefix + + sig { params(url_prefix: String).void } + attr_writer :url_prefix + + # Configuration for third-party URL rewriting. + sig do + returns( + T.nilable( + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter + ) + ) + ) + end + attr_reader :url_rewriter + + sig do + params( + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).void + end + attr_writer :url_rewriter + + sig do + params( + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Description of the URL endpoint. + 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. + origins: nil, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix: nil, + # Configuration for third-party URL rewriting. + url_rewriter: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter + ), + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter + ) + end + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + ) + end + attr_accessor :type + + # Whether to preserve `/` in the rewritten URL. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :preserve_asset_delivery_types + + sig { params(preserve_asset_delivery_types: T::Boolean).void } + attr_writer :preserve_asset_delivery_types + + sig do + params( + type: + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol, + preserve_asset_delivery_types: T::Boolean + ).returns(T.attached_class) + end + def self.new( + type:, + # Whether to preserve `/` in the rewritten URL. + preserve_asset_delivery_types: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol, + preserve_asset_delivery_types: T::Boolean + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY = + T.let( + :CLOUDINARY, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + IMGIX = + T.let( + :IMGIX, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKAMAI = + T.let( + :AKAMAI, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi new file mode 100644 index 00000000..e2df38b0 --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi @@ -0,0 +1,341 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointCreateResponse, + Imagekit::Internal::AnyHash + ) + end + + # Description of the URL endpoint. + sig { returns(String) } + attr_accessor :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. + sig { returns(T::Array[String]) } + attr_accessor :origins + + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + sig { returns(String) } + attr_accessor :url_prefix + + # Configuration for third-party URL rewriting. + sig do + returns( + T.nilable( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Variants + ) + ) + end + attr_reader :url_rewriter + + sig do + params( + url_rewriter: + T.any( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).void + end + attr_writer :url_rewriter + + # 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`. + sig { returns(String) } + attr_accessor :id + + # URL‑endpoint object as returned by the API. + sig do + params( + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).returns(T.attached_class) + end + def self.new( + # 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`. + id:, + # Description of the URL endpoint. + 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. + origins:, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix:, + # Configuration for third-party URL rewriting. + url_rewriter: nil + ) + end + + sig do + override.returns( + { + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Variants + } + ) + end + def to_hash + end + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter + ) + end + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + # Whether to preserve `/` in the rewritten URL. + sig { returns(T::Boolean) } + attr_accessor :preserve_asset_delivery_types + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + preserve_asset_delivery_types: T::Boolean, + type: + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Whether to preserve `/` in the rewritten URL. + preserve_asset_delivery_types:, + type: + ) + end + + sig do + override.returns( + { + preserve_asset_delivery_types: T::Boolean, + type: + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY = + T.let( + :CLOUDINARY, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + IMGIX = + T.let( + :IMGIX, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKAMAI = + T.let( + :AKAMAI, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_delete_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_delete_params.rbi new file mode 100644 index 00000000..c8952d88 --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint_delete_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpointDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointDeleteParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/detail_retrieve_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_get_params.rbi similarity index 82% rename from rbi/imagekit/models/files/detail_retrieve_params.rbi rename to rbi/imagekit/models/accounts/url_endpoint_get_params.rbi index 752a54e5..2d965592 100644 --- a/rbi/imagekit/models/files/detail_retrieve_params.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_get_params.rbi @@ -2,15 +2,15 @@ module Imagekit module Models - module Files - class DetailRetrieveParams < Imagekit::Internal::Type::BaseModel + module Accounts + class URLEndpointGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::DetailRetrieveParams, + Imagekit::Accounts::URLEndpointGetParams, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi new file mode 100644 index 00000000..5dcfb6a1 --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi @@ -0,0 +1,341 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointGetResponse, + Imagekit::Internal::AnyHash + ) + end + + # Description of the URL endpoint. + sig { returns(String) } + attr_accessor :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. + sig { returns(T::Array[String]) } + attr_accessor :origins + + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + sig { returns(String) } + attr_accessor :url_prefix + + # Configuration for third-party URL rewriting. + sig do + returns( + T.nilable( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Variants + ) + ) + end + attr_reader :url_rewriter + + sig do + params( + url_rewriter: + T.any( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).void + end + attr_writer :url_rewriter + + # 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`. + sig { returns(String) } + attr_accessor :id + + # URL‑endpoint object as returned by the API. + sig do + params( + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).returns(T.attached_class) + end + def self.new( + # 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`. + id:, + # Description of the URL endpoint. + 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. + origins:, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix:, + # Configuration for third-party URL rewriting. + url_rewriter: nil + ) + end + + sig do + override.returns( + { + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Variants + } + ) + end + def to_hash + end + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter + ) + end + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + # Whether to preserve `/` in the rewritten URL. + sig { returns(T::Boolean) } + attr_accessor :preserve_asset_delivery_types + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + preserve_asset_delivery_types: T::Boolean, + type: + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Whether to preserve `/` in the rewritten URL. + preserve_asset_delivery_types:, + type: + ) + end + + sig do + override.returns( + { + preserve_asset_delivery_types: T::Boolean, + type: + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY = + T.let( + :CLOUDINARY, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + IMGIX = + T.let( + :IMGIX, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKAMAI = + T.let( + :AKAMAI, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_list_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_list_params.rbi new file mode 100644 index 00000000..fbf7b441 --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint_list_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpointListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointListParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi new file mode 100644 index 00000000..49979644 --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi @@ -0,0 +1,349 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointListResponseItem, + Imagekit::Internal::AnyHash + ) + end + + # Description of the URL endpoint. + sig { returns(String) } + attr_accessor :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. + sig { returns(T::Array[String]) } + attr_accessor :origins + + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + sig { returns(String) } + attr_accessor :url_prefix + + # Configuration for third-party URL rewriting. + sig do + returns( + T.nilable( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Variants + ) + ) + end + attr_reader :url_rewriter + + sig do + params( + url_rewriter: + T.any( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).void + end + attr_writer :url_rewriter + + # 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`. + sig { returns(String) } + attr_accessor :id + + # URL‑endpoint object as returned by the API. + sig do + params( + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).returns(T.attached_class) + end + def self.new( + # 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`. + id:, + # Description of the URL endpoint. + 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. + origins:, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix:, + # Configuration for third-party URL rewriting. + url_rewriter: nil + ) + end + + sig do + override.returns( + { + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Variants + } + ) + end + def to_hash + end + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter + ) + end + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + # Whether to preserve `/` in the rewritten URL. + sig { returns(T::Boolean) } + attr_accessor :preserve_asset_delivery_types + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + preserve_asset_delivery_types: T::Boolean, + type: + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Whether to preserve `/` in the rewritten URL. + preserve_asset_delivery_types:, + type: + ) + end + + sig do + override.returns( + { + preserve_asset_delivery_types: T::Boolean, + type: + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY = + T.let( + :CLOUDINARY, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + IMGIX = + T.let( + :IMGIX, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKAMAI = + T.let( + :AKAMAI, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Variants + ] + ) + end + def self.variants + end + end + end + + URLEndpointListResponse = + T.let( + Imagekit::Internal::Type::ArrayOf[ + Imagekit::Models::Accounts::URLEndpointListResponseItem + ], + Imagekit::Internal::Type::Converter + ) + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi new file mode 100644 index 00000000..f5e6d031 --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi @@ -0,0 +1,351 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointUpdateParams, + Imagekit::Internal::AnyHash + ) + end + + # Description of the URL endpoint. + sig { returns(String) } + attr_accessor :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. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :origins + + sig { params(origins: T::Array[String]).void } + attr_writer :origins + + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + sig { returns(T.nilable(String)) } + attr_reader :url_prefix + + sig { params(url_prefix: String).void } + attr_writer :url_prefix + + # Configuration for third-party URL rewriting. + sig do + returns( + T.nilable( + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter + ) + ) + ) + end + attr_reader :url_rewriter + + sig do + params( + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).void + end + attr_writer :url_rewriter + + sig do + params( + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Description of the URL endpoint. + 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. + origins: nil, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix: nil, + # Configuration for third-party URL rewriting. + url_rewriter: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter + ), + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter + ) + end + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + ) + end + attr_accessor :type + + # Whether to preserve `/` in the rewritten URL. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :preserve_asset_delivery_types + + sig { params(preserve_asset_delivery_types: T::Boolean).void } + attr_writer :preserve_asset_delivery_types + + sig do + params( + type: + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol, + preserve_asset_delivery_types: T::Boolean + ).returns(T.attached_class) + end + def self.new( + type:, + # Whether to preserve `/` in the rewritten URL. + preserve_asset_delivery_types: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol, + preserve_asset_delivery_types: T::Boolean + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY = + T.let( + :CLOUDINARY, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + IMGIX = + T.let( + :IMGIX, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKAMAI = + T.let( + :AKAMAI, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi new file mode 100644 index 00000000..9b9871a4 --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi @@ -0,0 +1,341 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointUpdateResponse, + Imagekit::Internal::AnyHash + ) + end + + # Description of the URL endpoint. + sig { returns(String) } + attr_accessor :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. + sig { returns(T::Array[String]) } + attr_accessor :origins + + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + sig { returns(String) } + attr_accessor :url_prefix + + # Configuration for third-party URL rewriting. + sig do + returns( + T.nilable( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Variants + ) + ) + end + attr_reader :url_rewriter + + sig do + params( + url_rewriter: + T.any( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).void + end + attr_writer :url_rewriter + + # 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`. + sig { returns(String) } + attr_accessor :id + + # URL‑endpoint object as returned by the API. + sig do + params( + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::OrHash + ) + ).returns(T.attached_class) + end + def self.new( + # 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`. + id:, + # Description of the URL endpoint. + 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. + origins:, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix:, + # Configuration for third-party URL rewriting. + url_rewriter: nil + ) + end + + sig do + override.returns( + { + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Variants + } + ) + end + def to_hash + end + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter + ) + end + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + # Whether to preserve `/` in the rewritten URL. + sig { returns(T::Boolean) } + attr_accessor :preserve_asset_delivery_types + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + preserve_asset_delivery_types: T::Boolean, + type: + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Whether to preserve `/` in the rewritten URL. + preserve_asset_delivery_types:, + type: + ) + end + + sig do + override.returns( + { + preserve_asset_delivery_types: T::Boolean, + type: + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLOUDINARY = + T.let( + :CLOUDINARY, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + IMGIX = + T.let( + :IMGIX, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(type:) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKAMAI = + T.let( + :AKAMAI, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/usage_get_params.rbi b/rbi/imagekit/models/accounts/usage_get_params.rbi new file mode 100644 index 00000000..271e2759 --- /dev/null +++ b/rbi/imagekit/models/accounts/usage_get_params.rbi @@ -0,0 +1,60 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class UsageGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::UsageGetParams, + Imagekit::Internal::AnyHash + ) + end + + # 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. + sig { returns(Date) } + attr_accessor :end_date + + # 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. + sig { returns(Date) } + attr_accessor :start_date + + sig do + params( + end_date: Date, + start_date: Date, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + end_date:, + # 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. + start_date:, + request_options: {} + ) + end + + sig do + override.returns( + { + end_date: Date, + start_date: Date, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/usage_get_response.rbi b/rbi/imagekit/models/accounts/usage_get_response.rbi new file mode 100644 index 00000000..b3af7603 --- /dev/null +++ b/rbi/imagekit/models/accounts/usage_get_response.rbi @@ -0,0 +1,89 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class UsageGetResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Accounts::UsageGetResponse, + Imagekit::Internal::AnyHash + ) + end + + # Amount of bandwidth used in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :bandwidth_bytes + + sig { params(bandwidth_bytes: Integer).void } + attr_writer :bandwidth_bytes + + # Number of extension units used. + sig { returns(T.nilable(Integer)) } + attr_reader :extension_units_count + + sig { params(extension_units_count: Integer).void } + attr_writer :extension_units_count + + # Storage used by media library in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :media_library_storage_bytes + + sig { params(media_library_storage_bytes: Integer).void } + attr_writer :media_library_storage_bytes + + # Storage used by the original cache in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :original_cache_storage_bytes + + sig { params(original_cache_storage_bytes: Integer).void } + attr_writer :original_cache_storage_bytes + + # Number of video processing units used. + sig { returns(T.nilable(Integer)) } + attr_reader :video_processing_units_count + + sig { params(video_processing_units_count: Integer).void } + attr_writer :video_processing_units_count + + sig do + params( + bandwidth_bytes: Integer, + extension_units_count: Integer, + media_library_storage_bytes: Integer, + original_cache_storage_bytes: Integer, + video_processing_units_count: Integer + ).returns(T.attached_class) + end + def self.new( + # Amount of bandwidth used in bytes. + bandwidth_bytes: nil, + # Number of extension units used. + extension_units_count: nil, + # Storage used by media library in bytes. + media_library_storage_bytes: nil, + # Storage used by the original cache in bytes. + original_cache_storage_bytes: nil, + # Number of video processing units used. + video_processing_units_count: nil + ) + end + + sig do + override.returns( + { + bandwidth_bytes: Integer, + extension_units_count: Integer, + media_library_storage_bytes: Integer, + original_cache_storage_bytes: Integer, + video_processing_units_count: Integer + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/asset_list_params.rbi b/rbi/imagekit/models/asset_list_params.rbi new file mode 100644 index 00000000..6e43d77a --- /dev/null +++ b/rbi/imagekit/models/asset_list_params.rbi @@ -0,0 +1,269 @@ +# typed: strong + +module Imagekit + module Models + class AssetListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::AssetListParams, Imagekit::Internal::AnyHash) + end + + # 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) + sig { returns(T.nilable(Imagekit::AssetListParams::FileType::OrSymbol)) } + attr_reader :file_type + + sig do + params(file_type: Imagekit::AssetListParams::FileType::OrSymbol).void + end + attr_writer :file_type + + # The maximum number of results to return in response. + sig { returns(T.nilable(Integer)) } + attr_reader :limit + + sig { params(limit: Integer).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :path + + sig { params(path: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :search_query + + sig { params(search_query: String).void } + attr_writer :search_query + + # The number of results to skip before returning results. + sig { returns(T.nilable(Integer)) } + attr_reader :skip + + sig { params(skip: Integer).void } + attr_writer :skip + + # Sort the results by one of the supported fields in ascending or descending + # order. + sig { returns(T.nilable(Imagekit::AssetListParams::Sort::OrSymbol)) } + attr_reader :sort + + sig { params(sort: Imagekit::AssetListParams::Sort::OrSymbol).void } + attr_writer :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`) + sig { returns(T.nilable(Imagekit::AssetListParams::Type::OrSymbol)) } + attr_reader :type + + sig { params(type: Imagekit::AssetListParams::Type::OrSymbol).void } + attr_writer :type + + sig do + params( + file_type: Imagekit::AssetListParams::FileType::OrSymbol, + limit: Integer, + path: String, + search_query: String, + skip: Integer, + sort: Imagekit::AssetListParams::Sort::OrSymbol, + type: Imagekit::AssetListParams::Type::OrSymbol, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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) + file_type: nil, + # The maximum number of results to return in response. + limit: nil, + # 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. + path: nil, + # 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. + search_query: nil, + # The number of results to skip before returning results. + skip: nil, + # Sort the results by one of the supported fields in ascending or descending + # order. + sort: nil, + # 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`) + type: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + file_type: Imagekit::AssetListParams::FileType::OrSymbol, + limit: Integer, + path: String, + search_query: String, + skip: Integer, + sort: Imagekit::AssetListParams::Sort::OrSymbol, + type: Imagekit::AssetListParams::Type::OrSymbol, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + # 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) + module FileType + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::AssetListParams::FileType) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ALL = T.let(:all, Imagekit::AssetListParams::FileType::TaggedSymbol) + IMAGE = T.let(:image, Imagekit::AssetListParams::FileType::TaggedSymbol) + NON_IMAGE = + T.let(:"non-image", Imagekit::AssetListParams::FileType::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::AssetListParams::FileType::TaggedSymbol] + ) + end + def self.values + end + end + + # Sort the results by one of the supported fields in ascending or descending + # order. + module Sort + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::AssetListParams::Sort) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ASC_NAME = + T.let(:ASC_NAME, Imagekit::AssetListParams::Sort::TaggedSymbol) + DESC_NAME = + T.let(:DESC_NAME, Imagekit::AssetListParams::Sort::TaggedSymbol) + ASC_CREATED = + T.let(:ASC_CREATED, Imagekit::AssetListParams::Sort::TaggedSymbol) + DESC_CREATED = + T.let(:DESC_CREATED, Imagekit::AssetListParams::Sort::TaggedSymbol) + ASC_UPDATED = + T.let(:ASC_UPDATED, Imagekit::AssetListParams::Sort::TaggedSymbol) + DESC_UPDATED = + T.let(:DESC_UPDATED, Imagekit::AssetListParams::Sort::TaggedSymbol) + ASC_HEIGHT = + T.let(:ASC_HEIGHT, Imagekit::AssetListParams::Sort::TaggedSymbol) + DESC_HEIGHT = + T.let(:DESC_HEIGHT, Imagekit::AssetListParams::Sort::TaggedSymbol) + ASC_WIDTH = + T.let(:ASC_WIDTH, Imagekit::AssetListParams::Sort::TaggedSymbol) + DESC_WIDTH = + T.let(:DESC_WIDTH, Imagekit::AssetListParams::Sort::TaggedSymbol) + ASC_SIZE = + T.let(:ASC_SIZE, Imagekit::AssetListParams::Sort::TaggedSymbol) + DESC_SIZE = + T.let(:DESC_SIZE, Imagekit::AssetListParams::Sort::TaggedSymbol) + ASC_RELEVANCE = + T.let(:ASC_RELEVANCE, Imagekit::AssetListParams::Sort::TaggedSymbol) + DESC_RELEVANCE = + T.let(:DESC_RELEVANCE, Imagekit::AssetListParams::Sort::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::AssetListParams::Sort::TaggedSymbol] + ) + end + def self.values + end + end + + # 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`) + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::AssetListParams::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FILE = T.let(:file, Imagekit::AssetListParams::Type::TaggedSymbol) + FILE_VERSION = + T.let(:"file-version", Imagekit::AssetListParams::Type::TaggedSymbol) + FOLDER = T.let(:folder, Imagekit::AssetListParams::Type::TaggedSymbol) + ALL = T.let(:all, Imagekit::AssetListParams::Type::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::AssetListParams::Type::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/files/version_retrieve_response.rbi b/rbi/imagekit/models/asset_list_response.rbi similarity index 65% rename from rbi/imagekit/models/files/version_retrieve_response.rbi rename to rbi/imagekit/models/asset_list_response.rbi index 28f36016..ed74b8d4 100644 --- a/rbi/imagekit/models/files/version_retrieve_response.rbi +++ b/rbi/imagekit/models/asset_list_response.rbi @@ -2,12 +2,23 @@ module Imagekit module Models - module Files - class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel + # Object containing details of a file or file version. + module AssetListResponseItem + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Models::AssetListResponseItem::FileDetails, + Imagekit::Models::AssetListResponseItem::FolderDetails + ) + end + + class FileDetails < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::VersionRetrieveResponse, + Imagekit::Models::AssetListResponseItem::FileDetails, Imagekit::Internal::AnyHash ) end @@ -16,7 +27,9 @@ module Imagekit sig do returns( T.nilable( - T::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag] + T::Array[ + Imagekit::Models::AssetListResponseItem::FileDetails::AITag + ] ) ) end @@ -153,7 +166,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo + Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo ) ) end @@ -162,7 +175,7 @@ module Imagekit sig do params( version_info: - Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo::OrHash + Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo::OrHash ).void end attr_writer :version_info @@ -180,7 +193,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::Models::Files::VersionRetrieveResponse::AITag::OrHash + Imagekit::Models::AssetListResponseItem::FileDetails::AITag::OrHash ] ), created_at: String, @@ -202,7 +215,7 @@ module Imagekit updated_at: String, url: String, version_info: - Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo::OrHash, + Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo::OrHash, width: Float ).returns(T.attached_class) end @@ -265,7 +278,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::Models::Files::VersionRetrieveResponse::AITag + Imagekit::Models::AssetListResponseItem::FileDetails::AITag ] ), created_at: String, @@ -287,7 +300,7 @@ module Imagekit updated_at: String, url: String, version_info: - Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, width: Float } ) @@ -299,7 +312,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Files::VersionRetrieveResponse::AITag, + Imagekit::Models::AssetListResponseItem::FileDetails::AITag, Imagekit::Internal::AnyHash ) end @@ -355,7 +368,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, Imagekit::Internal::AnyHash ) end @@ -389,6 +402,168 @@ module Imagekit end end end + + class FolderDetails < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::AssetListResponseItem::FolderDetails, + Imagekit::Internal::AnyHash + ) + end + + # Date and time when the folder was created. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :created_at + + sig { params(created_at: String).void } + attr_writer :created_at + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :folder_id + + sig { params(folder_id: String).void } + attr_writer :folder_id + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :folder_path + + sig { params(folder_path: String).void } + attr_writer :folder_path + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Type of the asset. + sig do + returns( + T.nilable( + Imagekit::Models::AssetListResponseItem::FolderDetails::Type::TaggedSymbol + ) + ) + end + attr_reader :type + + sig do + params( + type: + Imagekit::Models::AssetListResponseItem::FolderDetails::Type::OrSymbol + ).void + end + attr_writer :type + + # Date and time when the folder was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :updated_at + + sig { params(updated_at: String).void } + attr_writer :updated_at + + sig do + params( + created_at: String, + folder_id: String, + folder_path: String, + name: String, + type: + Imagekit::Models::AssetListResponseItem::FolderDetails::Type::OrSymbol, + updated_at: String + ).returns(T.attached_class) + end + def self.new( + # Date and time when the folder was created. The date and time is in ISO8601 + # format. + created_at: nil, + # Unique identifier of the asset. + folder_id: nil, + # 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. + folder_path: nil, + # Name of the asset. + name: nil, + # Type of the asset. + type: nil, + # Date and time when the folder was last updated. The date and time is in ISO8601 + # format. + updated_at: nil + ) + end + + sig do + override.returns( + { + created_at: String, + folder_id: String, + folder_path: String, + name: String, + type: + Imagekit::Models::AssetListResponseItem::FolderDetails::Type::TaggedSymbol, + updated_at: String + } + ) + end + def to_hash + end + + # Type of the asset. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::AssetListResponseItem::FolderDetails::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FOLDER = + T.let( + :folder, + Imagekit::Models::AssetListResponseItem::FolderDetails::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::AssetListResponseItem::FolderDetails::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[Imagekit::Models::AssetListResponseItem::Variants] + ) + end + def self.variants + end end + + AssetListResponse = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: Imagekit::Models::AssetListResponseItem + ], + Imagekit::Internal::Type::Converter + ) end end diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi new file mode 100644 index 00000000..1ae93408 --- /dev/null +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -0,0 +1,1390 @@ +# typed: strong + +module Imagekit + module Models + module Beta + module V2 + class FileUploadParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams, + Imagekit::Internal::AnyHash + ) + end + + # 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. + sig { returns(Imagekit::Internal::FileInput) } + attr_accessor :file + + # The name with which the file has to be uploaded. + sig { returns(String) } + attr_accessor :file_name + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :token + + sig { params(token: String).void } + attr_writer :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). + sig { returns(T.nilable(String)) } + attr_reader :checks + + sig { params(checks: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :custom_coordinates + + sig { params(custom_coordinates: String).void } + attr_writer :custom_coordinates + + # JSON key-value pairs to associate with the asset. Create the custom metadata + # fields before setting these values. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Array of extensions to be applied to the image. Each extension can be configured + # with specific parameters based on the extension type. + sig do + returns( + T.nilable( + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + ) + ] + ) + ) + end + attr_reader :extensions + + sig do + params( + extensions: + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + ) + ] + ).void + end + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :folder + + sig { params(folder: String).void } + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overwrite_ai_tags + + sig { params(overwrite_ai_tags: T::Boolean).void } + attr_writer :overwrite_ai_tags + + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overwrite_custom_metadata + + sig { params(overwrite_custom_metadata: T::Boolean).void } + attr_writer :overwrite_custom_metadata + + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overwrite_file + + sig { params(overwrite_file: T::Boolean).void } + attr_writer :overwrite_file + + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overwrite_tags + + sig { params(overwrite_tags: T::Boolean).void } + attr_writer :overwrite_tags + + # Array of response field keys to include in the API response body. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + ] + ) + ) + end + attr_reader :response_fields + + sig do + params( + response_fields: + T::Array[ + Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + ] + ).void + end + attr_writer :response_fields + + # 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. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :tags + + sig { params(tags: T::Array[String]).void } + attr_writer :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. + sig do + returns( + T.nilable(Imagekit::Beta::V2::FileUploadParams::Transformation) + ) + end + attr_reader :transformation + + sig do + params( + transformation: + Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash + ).void + end + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :use_unique_file_name + + sig { params(use_unique_file_name: T::Boolean).void } + attr_writer :use_unique_file_name + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + sig do + params( + file: Imagekit::Internal::FileInput, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + ) + ], + folder: String, + is_private_file: T::Boolean, + is_published: T::Boolean, + overwrite_ai_tags: T::Boolean, + overwrite_custom_metadata: T::Boolean, + overwrite_file: T::Boolean, + overwrite_tags: T::Boolean, + response_fields: + T::Array[ + Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + ], + tags: T::Array[String], + transformation: + Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash, + use_unique_file_name: T::Boolean, + webhook_url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + file:, + # The name with which the file has to be uploaded. + file_name:, + # 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. + token: nil, + # 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). + checks: nil, + # 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. + custom_coordinates: nil, + # JSON key-value pairs to associate with the asset. Create the custom metadata + # fields before setting these values. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the image. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + folder: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # 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. + overwrite_ai_tags: nil, + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + overwrite_custom_metadata: nil, + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + overwrite_file: nil, + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + overwrite_tags: nil, + # Array of response field keys to include in the API response body. + response_fields: nil, + # 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. + tags: nil, + # 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. + transformation: nil, + # 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. + use_unique_file_name: nil, + # 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. + webhook_url: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + file: Imagekit::Internal::FileInput, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + ) + ], + folder: String, + is_private_file: T::Boolean, + is_published: T::Boolean, + overwrite_ai_tags: T::Boolean, + overwrite_custom_metadata: T::Boolean, + overwrite_file: T::Boolean, + overwrite_tags: T::Boolean, + response_fields: + T::Array[ + Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + ], + tags: T::Array[String], + transformation: + Imagekit::Beta::V2::FileUploadParams::Transformation, + use_unique_file_name: T::Boolean, + webhook_url: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + module Extension + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + ) + end + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + returns( + T.nilable( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + name: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil + ) + end + + sig do + override.returns( + { + name: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + } + ) + end + def to_hash + end + + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + name: + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Specifies the auto description extension. + name: + ) + end + + sig do + override.returns( + { + name: + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Extension::Variants + ] + ) + end + def self.variants + end + end + + module ResponseField + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::ResponseField + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TAGS = + T.let( + :tags, + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ) + CUSTOM_COORDINATES = + T.let( + :customCoordinates, + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ) + IS_PRIVATE_FILE = + T.let( + :isPrivateFile, + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ) + EMBEDDED_METADATA = + T.let( + :embeddedMetadata, + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ) + IS_PUBLISHED = + T.let( + :isPublished, + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ) + CUSTOM_METADATA = + T.let( + :customMetadata, + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ) + METADATA = + T.let( + :metadata, + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation, + Imagekit::Internal::AnyHash + ) + end + + # 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`. + sig do + returns( + T.nilable( + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + ) + ] + ) + ) + end + attr_reader :post + + sig do + params( + post: + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::OrHash + ) + ] + ).void + end + attr_writer :post + + # Transformation string to apply before uploading the file to the Media Library. + # Useful for optimizing files at ingestion. + sig { returns(T.nilable(String)) } + attr_reader :pre + + sig { params(pre: String).void } + attr_writer :pre + + # 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. + sig do + params( + post: + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::OrHash + ) + ], + pre: String + ).returns(T.attached_class) + end + def self.new( + # 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`. + post: nil, + # Transformation string to apply before uploading the file to the Media Library. + # Useful for optimizing files at ingestion. + pre: nil + ) + end + + sig do + override.returns( + { + post: + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + ) + ], + pre: String + } + ) + end + def to_hash + end + + module Post + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + ) + end + + class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::Internal::AnyHash + ) + end + + # Transformation type. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol + ) + end + attr_accessor :type + + # Transformation string (e.g. `w-200,h-200`). + # Same syntax as ImageKit URL-based transformations. + sig { returns(String) } + attr_accessor :value + + sig do + params( + type: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Transformation type. + type:, + # Transformation string (e.g. `w-200,h-200`). + # Same syntax as ImageKit URL-based transformations. + value: + ) + end + + sig do + override.returns( + { + type: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol, + value: String + } + ) + end + def to_hash + end + + # Transformation type. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRANSFORMATION = + T.let( + :transformation, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::Internal::AnyHash + ) + end + + # Converts an animated GIF into an MP4. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol + ) + end + attr_accessor :type + + # Optional transformation string to apply to the output video. + # **Example**: `q-80` + sig { returns(T.nilable(String)) } + attr_reader :value + + sig { params(value: String).void } + attr_writer :value + + sig do + params( + type: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Converts an animated GIF into an MP4. + type:, + # Optional transformation string to apply to the output video. + # **Example**: `q-80` + value: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol, + value: String + } + ) + end + def to_hash + end + + # Converts an animated GIF into an MP4. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GIF_TO_VIDEO = + T.let( + :"gif-to-video", + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::Internal::AnyHash + ) + end + + # Generates a thumbnail image. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol + ) + end + attr_accessor :type + + # Optional transformation string. + # **Example**: `w-150,h-150` + sig { returns(T.nilable(String)) } + attr_reader :value + + sig { params(value: String).void } + attr_writer :value + + sig do + params( + type: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Generates a thumbnail image. + type:, + # Optional transformation string. + # **Example**: `w-150,h-150` + value: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol, + value: String + } + ) + end + def to_hash + end + + # Generates a thumbnail image. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + THUMBNAIL = + T.let( + :thumbnail, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming, + Imagekit::Internal::AnyHash + ) + end + + # Streaming protocol to use (`hls` or `dash`). + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol + ) + end + attr_accessor :protocol + + # Adaptive Bitrate Streaming (ABS) setup. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol + ) + end + attr_accessor :type + + # List of different representations you want to create separated by an underscore. + sig { returns(String) } + attr_accessor :value + + sig do + params( + protocol: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol, + type: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Streaming protocol to use (`hls` or `dash`). + protocol:, + # Adaptive Bitrate Streaming (ABS) setup. + type:, + # List of different representations you want to create separated by an underscore. + value: + ) + end + + sig do + override.returns( + { + protocol: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol, + type: + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol, + value: String + } + ) + end + def to_hash + end + + # Streaming protocol to use (`hls` or `dash`). + module Protocol + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HLS = + T.let( + :hls, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol + ) + DASH = + T.let( + :dash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Adaptive Bitrate Streaming (ABS) setup. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ABS = + T.let( + :abs, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Variants + ] + ) + end + def self.variants + end + end + end + end + end + end + end +end diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekit/models/beta/v2/file_upload_response.rbi new file mode 100644 index 00000000..84d5a5e9 --- /dev/null +++ b/rbi/imagekit/models/beta/v2/file_upload_response.rbi @@ -0,0 +1,1593 @@ +# typed: strong + +module Imagekit + module Models + module Beta + module V2 + class FileUploadResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the uploaded file by auto tagging. + sig do + returns( + T.nilable( + T::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag] + ) + ) + end + attr_accessor :ai_tags + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :embedded_metadata + + sig { params(embedded_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :embedded_metadata + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus + ) + ) + end + attr_reader :extension_status + + sig do + params( + extension_status: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::OrHash + ).void + end + attr_writer :extension_status + + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the uploaded file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Height of the image in pixels (Only for images) + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata + ) + ) + end + attr_reader :metadata + + sig do + params( + metadata: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::OrHash + ).void + end + attr_writer :metadata + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the image file in Bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # In the case of an image, a small thumbnail URL. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail_url + + sig { params(thumbnail_url: String).void } + attr_writer :thumbnail_url + + # A publicly accessible URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object containing the file or file version's `id` (versionId) and `name`. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo + ) + ) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # Width of the image in pixels (Only for Images) + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a successful upload. + sig do + params( + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::AITag::OrHash + ] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + duration: Integer, + embedded_metadata: T::Hash[Symbol, T.anything], + extension_status: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::OrHash, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::OrHash, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: + Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo::OrHash, + video_codec: String, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the uploaded file by auto tagging. + ai_tags: nil, + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # The duration of the video in seconds (only for video). + duration: nil, + # 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. + embedded_metadata: nil, + # 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. + extension_status: nil, + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + file_id: nil, + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + file_path: nil, + # Type of the uploaded file. Possible values are `image`, `non-image`. + file_type: nil, + # Height of the image in pixels (Only for images) + height: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + metadata: nil, + # Name of the asset. + name: nil, + # Size of the image file in Bytes. + size: nil, + # 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. + tags: nil, + # In the case of an image, a small thumbnail URL. + thumbnail_url: nil, + # A publicly accessible URL of the file. + url: nil, + # An object containing the file or file version's `id` (versionId) and `name`. + version_info: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # Width of the image in pixels (Only for Images) + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::AITag + ] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + duration: Integer, + embedded_metadata: T::Hash[Symbol, T.anything], + extension_status: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: + Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # 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. + source: nil + ) + end + + sig do + override.returns( + { confidence: Float, name: String, source: String } + ) + end + def to_hash + end + end + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :aws_auto_tagging + + sig do + params( + aws_auto_tagging: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol + ).void + end + attr_writer :aws_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :google_auto_tagging + + sig do + params( + google_auto_tagging: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol + ).void + end + attr_writer :google_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + ) + end + attr_reader :remove_bg + + sig do + params( + remove_bg: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol + ).void + end + attr_writer :remove_bg + + # 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. + sig do + params( + aws_auto_tagging: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, + google_auto_tagging: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, + remove_bg: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol + ).returns(T.attached_class) + end + def self.new( + aws_auto_tagging: nil, + google_auto_tagging: nil, + remove_bg: nil + ) + end + + sig do + override.returns( + { + aws_auto_tagging: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + google_auto_tagging: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + remove_bg: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + } + ) + end + def to_hash + end + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class Metadata < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + Imagekit::Internal::AnyHash + ) + end + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif + ) + ) + end + attr_reader :exif + + sig do + params( + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::OrHash + ).void + end + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, + Imagekit::Internal::AnyHash + ) + end + + # Object containing Exif details. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif + ) + ) + end + attr_reader :exif + + sig do + params( + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif::OrHash + ).void + end + attr_writer :exif + + # Object containing GPS information. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps + ) + ) + end + attr_reader :gps + + sig do + params( + gps: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps::OrHash + ).void + end + attr_writer :gps + + # Object containing EXIF image information. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image + ) + ) + end + attr_reader :image + + sig do + params( + image: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image::OrHash + ).void + end + attr_writer :image + + # JSON object. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability + ) + ) + end + attr_reader :interoperability + + sig do + params( + interoperability: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability::OrHash + ).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + ) + ) + end + attr_reader :thumbnail + + sig do + params( + thumbnail: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash + ).void + end + attr_writer :thumbnail + + sig do + params( + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif::OrHash, + gps: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps::OrHash, + image: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image::OrHash, + interoperability: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + gps: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + image: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + interoperability: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns( + T.attached_class + ) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params( + interop_index: String, + interop_version: String + ).returns(T.attached_class) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns( + { interop_index: String, interop_version: String } + ) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object containing the file or file version's `id` (versionId) and `name`. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end + end + end +end diff --git a/rbi/imagekit/models/bulk_job_retrieve_status_response.rbi b/rbi/imagekit/models/bulk_job_retrieve_status_response.rbi deleted file mode 100644 index 8da0523f..00000000 --- a/rbi/imagekit/models/bulk_job_retrieve_status_response.rbi +++ /dev/null @@ -1,55 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class BulkJobRetrieveStatusResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::BulkJobRetrieveStatusResponse, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the bulk job. - sig { returns(T.nilable(String)) } - attr_reader :job_id - - sig { params(job_id: String).void } - attr_writer :job_id - - # Status of the bulk job. Possible values - `Pending`, `Completed`. - sig { returns(T.nilable(String)) } - attr_reader :status - - sig { params(status: String).void } - attr_writer :status - - # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`. - sig { returns(T.nilable(String)) } - attr_reader :type - - sig { params(type: String).void } - attr_writer :type - - sig do - params(job_id: String, status: String, type: String).returns( - T.attached_class - ) - end - def self.new( - # Unique identifier of the bulk job. - job_id: nil, - # Status of the bulk job. Possible values - `Pending`, `Completed`. - status: nil, - # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`. - type: nil - ) - end - - sig { override.returns({ job_id: String, status: String, type: String }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/files/purge_execute_params.rbi b/rbi/imagekit/models/cache/invalidation_create_params.rbi similarity index 86% rename from rbi/imagekit/models/files/purge_execute_params.rbi rename to rbi/imagekit/models/cache/invalidation_create_params.rbi index fbda8a03..bafcab6b 100644 --- a/rbi/imagekit/models/files/purge_execute_params.rbi +++ b/rbi/imagekit/models/cache/invalidation_create_params.rbi @@ -2,15 +2,15 @@ module Imagekit module Models - module Files - class PurgeExecuteParams < Imagekit::Internal::Type::BaseModel + module Cache + class InvalidationCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::PurgeExecuteParams, + Imagekit::Cache::InvalidationCreateParams, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/purge_execute_response.rbi b/rbi/imagekit/models/cache/invalidation_create_response.rbi similarity index 83% rename from rbi/imagekit/models/files/purge_execute_response.rbi rename to rbi/imagekit/models/cache/invalidation_create_response.rbi index da771e69..2d6123a7 100644 --- a/rbi/imagekit/models/files/purge_execute_response.rbi +++ b/rbi/imagekit/models/cache/invalidation_create_response.rbi @@ -2,12 +2,12 @@ module Imagekit module Models - module Files - class PurgeExecuteResponse < Imagekit::Internal::Type::BaseModel + module Cache + class InvalidationCreateResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::PurgeExecuteResponse, + Imagekit::Models::Cache::InvalidationCreateResponse, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/cache/invalidation_get_params.rbi b/rbi/imagekit/models/cache/invalidation_get_params.rbi new file mode 100644 index 00000000..07375fb7 --- /dev/null +++ b/rbi/imagekit/models/cache/invalidation_get_params.rbi @@ -0,0 +1,32 @@ +# typed: strong + +module Imagekit + module Models + module Cache + class InvalidationGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Cache::InvalidationGetParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/purge_status_response.rbi b/rbi/imagekit/models/cache/invalidation_get_response.rbi similarity index 64% rename from rbi/imagekit/models/files/purge_status_response.rbi rename to rbi/imagekit/models/cache/invalidation_get_response.rbi index 3bc42d63..c26651ef 100644 --- a/rbi/imagekit/models/files/purge_status_response.rbi +++ b/rbi/imagekit/models/cache/invalidation_get_response.rbi @@ -2,12 +2,12 @@ module Imagekit module Models - module Files - class PurgeStatusResponse < Imagekit::Internal::Type::BaseModel + module Cache + class InvalidationGetResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::PurgeStatusResponse, + Imagekit::Models::Cache::InvalidationGetResponse, Imagekit::Internal::AnyHash ) end @@ -16,7 +16,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol ) ) end @@ -25,7 +25,7 @@ module Imagekit sig do params( status: - Imagekit::Models::Files::PurgeStatusResponse::Status::OrSymbol + Imagekit::Models::Cache::InvalidationGetResponse::Status::OrSymbol ).void end attr_writer :status @@ -33,7 +33,7 @@ module Imagekit sig do params( status: - Imagekit::Models::Files::PurgeStatusResponse::Status::OrSymbol + Imagekit::Models::Cache::InvalidationGetResponse::Status::OrSymbol ).returns(T.attached_class) end def self.new( @@ -46,7 +46,7 @@ module Imagekit override.returns( { status: - Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol } ) end @@ -61,7 +61,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::Models::Files::PurgeStatusResponse::Status + Imagekit::Models::Cache::InvalidationGetResponse::Status ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -69,18 +69,18 @@ module Imagekit PENDING = T.let( :Pending, - Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol ) COMPLETED = T.let( :Completed, - Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Files::PurgeStatusResponse::Status::TaggedSymbol + Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/custom_metadata_field_create_params.rbi b/rbi/imagekit/models/custom_metadata_field_create_params.rbi index afb0019f..f52db847 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_params.rbi @@ -288,9 +288,9 @@ module Imagekit :Text, Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) - TEXT_AREA = + TEXTAREA = T.let( - :TextArea, + :Textarea, Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) NUMBER = diff --git a/rbi/imagekit/models/custom_metadata_field_create_response.rbi b/rbi/imagekit/models/custom_metadata_field_create_response.rbi index afd4e3bf..73022a7e 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_response.rbi @@ -284,9 +284,9 @@ module Imagekit :Text, Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol ) - TEXT_AREA = + TEXTAREA = T.let( - :TextArea, + :Textarea, Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol ) NUMBER = diff --git a/rbi/imagekit/models/custom_metadata_field_list_params.rbi b/rbi/imagekit/models/custom_metadata_field_list_params.rbi index 1e59ae91..db9f7dac 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_list_params.rbi @@ -14,8 +14,7 @@ module Imagekit ) end - # Set it to `true` to include deleted field objects in the API response. Default - # value is `false`. + # Set it to `true` to include deleted field objects in the API response. sig { returns(T.nilable(T::Boolean)) } attr_reader :include_deleted @@ -29,8 +28,7 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Set it to `true` to include deleted field objects in the API response. Default - # value is `false`. + # Set it to `true` to include deleted field objects in the API response. include_deleted: nil, request_options: {} ) diff --git a/rbi/imagekit/models/custom_metadata_field_list_response.rbi b/rbi/imagekit/models/custom_metadata_field_list_response.rbi index 9a5b2895..04bcfa37 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_list_response.rbi @@ -285,9 +285,9 @@ module Imagekit :Text, Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol ) - TEXT_AREA = + TEXTAREA = T.let( - :TextArea, + :Textarea, Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol ) NUMBER = diff --git a/rbi/imagekit/models/custom_metadata_field_update_response.rbi b/rbi/imagekit/models/custom_metadata_field_update_response.rbi index 9769d07a..6ecfa020 100644 --- a/rbi/imagekit/models/custom_metadata_field_update_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_update_response.rbi @@ -284,9 +284,9 @@ module Imagekit :Text, Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol ) - TEXT_AREA = + TEXTAREA = T.let( - :TextArea, + :Textarea, Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol ) NUMBER = diff --git a/rbi/imagekit/models/exif_details.rbi b/rbi/imagekit/models/exif_details.rbi deleted file mode 100644 index 9fa9f276..00000000 --- a/rbi/imagekit/models/exif_details.rbi +++ /dev/null @@ -1,264 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class ExifDetails < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::ExifDetails, Imagekit::Internal::AnyHash) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/exif_image.rbi b/rbi/imagekit/models/exif_image.rbi deleted file mode 100644 index cea9754a..00000000 --- a/rbi/imagekit/models/exif_image.rbi +++ /dev/null @@ -1,127 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class ExifImage < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias { T.any(Imagekit::ExifImage, Imagekit::Internal::AnyHash) } - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_add_tags_params.rbi b/rbi/imagekit/models/file_add_tags_params.rbi deleted file mode 100644 index bf3d293c..00000000 --- a/rbi/imagekit/models/file_add_tags_params.rbi +++ /dev/null @@ -1,51 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileAddTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileAddTagsParams, Imagekit::Internal::AnyHash) - end - - # An array of fileIds to which you want to add tags. - sig { returns(T::Array[String]) } - attr_accessor :file_ids - - # An array of tags that you want to add to the files. - sig { returns(T::Array[String]) } - attr_accessor :tags - - sig do - params( - file_ids: T::Array[String], - tags: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # An array of fileIds to which you want to add tags. - file_ids:, - # An array of tags that you want to add to the files. - tags:, - request_options: {} - ) - end - - sig do - override.returns( - { - file_ids: T::Array[String], - tags: T::Array[String], - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_add_tags_response.rbi b/rbi/imagekit/models/file_add_tags_response.rbi deleted file mode 100644 index ef9b6d3e..00000000 --- a/rbi/imagekit/models/file_add_tags_response.rbi +++ /dev/null @@ -1,39 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileAddTagsResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileAddTagsResponse, - Imagekit::Internal::AnyHash - ) - end - - # An array of fileIds that in which tags were successfully added. - sig { returns(T.nilable(T::Array[String])) } - attr_reader :successfully_updated_file_ids - - sig { params(successfully_updated_file_ids: T::Array[String]).void } - attr_writer :successfully_updated_file_ids - - sig do - params(successfully_updated_file_ids: T::Array[String]).returns( - T.attached_class - ) - end - def self.new( - # An array of fileIds that in which tags were successfully added. - successfully_updated_file_ids: nil - ) - end - - sig do - override.returns({ successfully_updated_file_ids: T::Array[String] }) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/bulk_job_retrieve_status_params.rbi b/rbi/imagekit/models/file_get_params.rbi similarity index 73% rename from rbi/imagekit/models/bulk_job_retrieve_status_params.rbi rename to rbi/imagekit/models/file_get_params.rbi index 069c5123..f6b5b068 100644 --- a/rbi/imagekit/models/bulk_job_retrieve_status_params.rbi +++ b/rbi/imagekit/models/file_get_params.rbi @@ -2,16 +2,13 @@ module Imagekit module Models - class BulkJobRetrieveStatusParams < Imagekit::Internal::Type::BaseModel + class FileGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any( - Imagekit::BulkJobRetrieveStatusParams, - Imagekit::Internal::AnyHash - ) + T.any(Imagekit::FileGetParams, Imagekit::Internal::AnyHash) end sig do diff --git a/rbi/imagekit/models/file_list_response.rbi b/rbi/imagekit/models/file_get_response.rbi similarity index 89% rename from rbi/imagekit/models/file_list_response.rbi rename to rbi/imagekit/models/file_get_response.rbi index 9f41c564..33c7ef4d 100644 --- a/rbi/imagekit/models/file_list_response.rbi +++ b/rbi/imagekit/models/file_get_response.rbi @@ -2,20 +2,15 @@ module Imagekit module Models - class FileListResponseItem < Imagekit::Internal::Type::BaseModel + class FileGetResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do - T.any( - Imagekit::Models::FileListResponseItem, - Imagekit::Internal::AnyHash - ) + T.any(Imagekit::Models::FileGetResponse, Imagekit::Internal::AnyHash) end # An array of tags assigned to the file by auto tagging. sig do - returns( - T.nilable(T::Array[Imagekit::Models::FileListResponseItem::AITag]) - ) + returns(T.nilable(T::Array[Imagekit::Models::FileGetResponse::AITag])) end attr_accessor :ai_tags @@ -147,15 +142,12 @@ module Imagekit attr_writer :url # An object with details of the file version. - sig do - returns(T.nilable(Imagekit::Models::FileListResponseItem::VersionInfo)) - end + sig { returns(T.nilable(Imagekit::Models::FileGetResponse::VersionInfo)) } attr_reader :version_info sig do params( - version_info: - Imagekit::Models::FileListResponseItem::VersionInfo::OrHash + version_info: Imagekit::Models::FileGetResponse::VersionInfo::OrHash ).void end attr_writer :version_info @@ -172,7 +164,7 @@ module Imagekit params( ai_tags: T.nilable( - T::Array[Imagekit::Models::FileListResponseItem::AITag::OrHash] + T::Array[Imagekit::Models::FileGetResponse::AITag::OrHash] ), created_at: String, custom_coordinates: T.nilable(String), @@ -192,8 +184,7 @@ module Imagekit type: String, updated_at: String, url: String, - version_info: - Imagekit::Models::FileListResponseItem::VersionInfo::OrHash, + version_info: Imagekit::Models::FileGetResponse::VersionInfo::OrHash, width: Float ).returns(T.attached_class) end @@ -254,9 +245,7 @@ module Imagekit override.returns( { ai_tags: - T.nilable( - T::Array[Imagekit::Models::FileListResponseItem::AITag] - ), + T.nilable(T::Array[Imagekit::Models::FileGetResponse::AITag]), created_at: String, custom_coordinates: T.nilable(String), custom_metadata: T.anything, @@ -275,7 +264,7 @@ module Imagekit type: String, updated_at: String, url: String, - version_info: Imagekit::Models::FileListResponseItem::VersionInfo, + version_info: Imagekit::Models::FileGetResponse::VersionInfo, width: Float } ) @@ -287,7 +276,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::FileListResponseItem::AITag, + Imagekit::Models::FileGetResponse::AITag, Imagekit::Internal::AnyHash ) end @@ -341,7 +330,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::FileListResponseItem::VersionInfo, + Imagekit::Models::FileGetResponse::VersionInfo, Imagekit::Internal::AnyHash ) end @@ -375,13 +364,5 @@ module Imagekit end end end - - FileListResponse = - T.let( - Imagekit::Internal::Type::ArrayOf[ - Imagekit::Models::FileListResponseItem - ], - Imagekit::Internal::Type::Converter - ) end end diff --git a/rbi/imagekit/models/file_list_params.rbi b/rbi/imagekit/models/file_list_params.rbi deleted file mode 100644 index cc6d218a..00000000 --- a/rbi/imagekit/models/file_list_params.rbi +++ /dev/null @@ -1,219 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileListParams, Imagekit::Internal::AnyHash) - end - - # Type of files to include in the result set. Accepts three values: - # - # `all` - include all types of files in the result set. `image` - only search in - # image type files. `non-image` - only search in files that are not images, e.g., - # JS or CSS or video files. - # - # Default value - `all` - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # The maximum number of results to return in response: - # - # Minimum value - 1 - # - # Maximum value - 1000 - # - # Default value - 1000 - sig { returns(T.nilable(String)) } - attr_reader :limit - - sig { params(limit: String).void } - attr_writer :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. - sig { returns(T.nilable(String)) } - attr_reader :path - - sig { params(path: String).void } - attr_writer :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. - sig { returns(T.nilable(String)) } - attr_reader :search_query - - sig { params(search_query: String).void } - attr_writer :search_query - - # The number of results to skip before returning results: - # - # Minimum value - 0 - # - # Default value - 0 - sig { returns(T.nilable(String)) } - attr_reader :skip - - sig { params(skip: String).void } - attr_writer :skip - - # You can sort based on the following fields: - # - # 1. name - `ASC_NAME` or `DESC_NAME` - # 2. createdAt - `ASC_CREATED` or `DESC_CREATED` - # 3. updatedAt - `ASC_UPDATED` or `DESC_UPDATED` - # 4. height - `ASC_HEIGHT` or `DESC_HEIGHT` - # 5. width - `ASC_WIDTH` or `DESC_WIDTH` - # 6. size - `ASC_SIZE` or `DESC_SIZE` - # - # Default value - `ASC_CREATED` - sig { returns(T.nilable(String)) } - attr_reader :sort - - sig { params(sort: String).void } - attr_writer :sort - - # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to - # include `files` and `folders` in search results (`file-version` will not be - # included in this case). - # - # Default value - `file` - sig { returns(T.nilable(Imagekit::FileListParams::Type::OrSymbol)) } - attr_reader :type - - sig { params(type: Imagekit::FileListParams::Type::OrSymbol).void } - attr_writer :type - - sig do - params( - file_type: String, - limit: String, - path: String, - search_query: String, - skip: String, - sort: String, - type: Imagekit::FileListParams::Type::OrSymbol, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Type of files to include in the result set. Accepts three values: - # - # `all` - include all types of files in the result set. `image` - only search in - # image type files. `non-image` - only search in files that are not images, e.g., - # JS or CSS or video files. - # - # Default value - `all` - file_type: nil, - # The maximum number of results to return in response: - # - # Minimum value - 1 - # - # Maximum value - 1000 - # - # Default value - 1000 - limit: nil, - # Folder path if you want to limit the search within a specific folder. For - # example, `/sales-banner/` will only search in folder sales-banner. - path: nil, - # 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. - search_query: nil, - # The number of results to skip before returning results: - # - # Minimum value - 0 - # - # Default value - 0 - skip: nil, - # You can sort based on the following fields: - # - # 1. name - `ASC_NAME` or `DESC_NAME` - # 2. createdAt - `ASC_CREATED` or `DESC_CREATED` - # 3. updatedAt - `ASC_UPDATED` or `DESC_UPDATED` - # 4. height - `ASC_HEIGHT` or `DESC_HEIGHT` - # 5. width - `ASC_WIDTH` or `DESC_WIDTH` - # 6. size - `ASC_SIZE` or `DESC_SIZE` - # - # Default value - `ASC_CREATED` - sort: nil, - # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to - # include `files` and `folders` in search results (`file-version` will not be - # included in this case). - # - # Default value - `file` - type: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - file_type: String, - limit: String, - path: String, - search_query: String, - skip: String, - sort: String, - type: Imagekit::FileListParams::Type::OrSymbol, - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - - # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to - # include `files` and `folders` in search results (`file-version` will not be - # included in this case). - # - # Default value - `file` - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::FileListParams::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - FILE = T.let(:file, Imagekit::FileListParams::Type::TaggedSymbol) - FILE_VERSION = - T.let(:"file-version", Imagekit::FileListParams::Type::TaggedSymbol) - FOLDER = T.let(:folder, Imagekit::FileListParams::Type::TaggedSymbol) - ALL = T.let(:all, Imagekit::FileListParams::Type::TaggedSymbol) - - sig do - override.returns( - T::Array[Imagekit::FileListParams::Type::TaggedSymbol] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/imagekit/models/file_remove_ai_tags_params.rbi b/rbi/imagekit/models/file_remove_ai_tags_params.rbi deleted file mode 100644 index a35889f2..00000000 --- a/rbi/imagekit/models/file_remove_ai_tags_params.rbi +++ /dev/null @@ -1,51 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileRemoveAITagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileRemoveAITagsParams, Imagekit::Internal::AnyHash) - end - - # An array of AITags that you want to remove from the files. - sig { returns(T::Array[String]) } - attr_accessor :ai_tags - - # An array of fileIds from which you want to remove AITags. - sig { returns(T::Array[String]) } - attr_accessor :file_ids - - sig do - params( - ai_tags: T::Array[String], - file_ids: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # An array of AITags that you want to remove from the files. - ai_tags:, - # An array of fileIds from which you want to remove AITags. - file_ids:, - request_options: {} - ) - end - - sig do - override.returns( - { - ai_tags: T::Array[String], - file_ids: T::Array[String], - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_remove_ai_tags_response.rbi b/rbi/imagekit/models/file_remove_ai_tags_response.rbi deleted file mode 100644 index d054f93d..00000000 --- a/rbi/imagekit/models/file_remove_ai_tags_response.rbi +++ /dev/null @@ -1,39 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileRemoveAITagsResponse, - Imagekit::Internal::AnyHash - ) - end - - # An array of fileIds that in which AITags were successfully removed. - sig { returns(T.nilable(T::Array[String])) } - attr_reader :successfully_updated_file_ids - - sig { params(successfully_updated_file_ids: T::Array[String]).void } - attr_writer :successfully_updated_file_ids - - sig do - params(successfully_updated_file_ids: T::Array[String]).returns( - T.attached_class - ) - end - def self.new( - # An array of fileIds that in which AITags were successfully removed. - successfully_updated_file_ids: nil - ) - end - - sig do - override.returns({ successfully_updated_file_ids: T::Array[String] }) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_remove_tags_params.rbi b/rbi/imagekit/models/file_remove_tags_params.rbi deleted file mode 100644 index 6a74ef8e..00000000 --- a/rbi/imagekit/models/file_remove_tags_params.rbi +++ /dev/null @@ -1,51 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileRemoveTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileRemoveTagsParams, Imagekit::Internal::AnyHash) - end - - # An array of fileIds from which you want to remove tags. - sig { returns(T::Array[String]) } - attr_accessor :file_ids - - # An array of tags that you want to remove from the files. - sig { returns(T::Array[String]) } - attr_accessor :tags - - sig do - params( - file_ids: T::Array[String], - tags: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # An array of fileIds from which you want to remove tags. - file_ids:, - # An array of tags that you want to remove from the files. - tags:, - request_options: {} - ) - end - - sig do - override.returns( - { - file_ids: T::Array[String], - tags: T::Array[String], - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_remove_tags_response.rbi b/rbi/imagekit/models/file_remove_tags_response.rbi deleted file mode 100644 index 114d74c4..00000000 --- a/rbi/imagekit/models/file_remove_tags_response.rbi +++ /dev/null @@ -1,39 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileRemoveTagsResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileRemoveTagsResponse, - Imagekit::Internal::AnyHash - ) - end - - # An array of fileIds that in which tags were successfully removed. - sig { returns(T.nilable(T::Array[String])) } - attr_reader :successfully_updated_file_ids - - sig { params(successfully_updated_file_ids: T::Array[String]).void } - attr_writer :successfully_updated_file_ids - - sig do - params(successfully_updated_file_ids: T::Array[String]).returns( - T.attached_class - ) - end - def self.new( - # An array of fileIds that in which tags were successfully removed. - successfully_updated_file_ids: nil - ) - end - - sig do - override.returns({ successfully_updated_file_ids: T::Array[String] }) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi new file mode 100644 index 00000000..dad7c300 --- /dev/null +++ b/rbi/imagekit/models/file_update_params.rbi @@ -0,0 +1,656 @@ +# typed: strong + +module Imagekit + module Models + class FileUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileUpdateParams, Imagekit::Internal::AnyHash) + end + + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + sig do + returns( + T.nilable( + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + ) + ] + ) + ) + end + attr_reader :extensions + + sig do + params( + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + ) + ] + ).void + end + attr_writer :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. + sig do + returns( + T.nilable( + T.any( + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + ) + ) + ) + end + attr_reader :remove_ai_tags + + sig do + params( + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + ) + ).void + end + attr_writer :remove_ai_tags + + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + # Configure the publication status of a file and its versions. + sig { returns(T.nilable(Imagekit::FileUpdateParams::Publish)) } + attr_reader :publish + + sig { params(publish: Imagekit::FileUpdateParams::Publish::OrHash).void } + attr_writer :publish + + sig do + params( + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + ) + ], + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish::OrHash, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, + # Configure the publication status of a file and its versions. + publish: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + ) + ], + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + module Extension + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + ) + end + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig do + returns( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + returns( + T.nilable( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + name: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil + ) + end + + sig do + override.returns( + { + name: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + } + ) + end + def to_hash + end + + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig do + returns( + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + name: + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Specifies the auto description extension. + name: + ) + end + + sig do + override.returns( + { + name: + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[Imagekit::FileUpdateParams::Extension::Variants] + ) + end + def self.variants + end + end + + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol + ) + end + + sig do + override.returns( + T::Array[Imagekit::FileUpdateParams::RemoveAITags::Variants] + ) + end + def self.variants + end + + StringArray = + T.let( + Imagekit::Internal::Type::ArrayOf[String], + Imagekit::Internal::Type::Converter + ) + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUpdateParams::RemoveAITags) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ALL = + T.let(:all, Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol) + end + + class Publish < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Publish, + Imagekit::Internal::AnyHash + ) + end + + # Set to `true` to publish the file. Set to `false` to unpublish the file. + sig { returns(T::Boolean) } + attr_accessor :is_published + + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions + + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions + + # Configure the publication status of a file and its versions. + sig do + params( + is_published: T::Boolean, + include_file_versions: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Set to `true` to publish the file. Set to `false` to unpublish the file. + is_published:, + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + include_file_versions: nil + ) + end + + sig do + override.returns( + { is_published: T::Boolean, include_file_versions: T::Boolean } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/file_update_response.rbi b/rbi/imagekit/models/file_update_response.rbi new file mode 100644 index 00000000..d6c22bbc --- /dev/null +++ b/rbi/imagekit/models/file_update_response.rbi @@ -0,0 +1,667 @@ +# typed: strong + +module Imagekit + module Models + class FileUpdateResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUpdateResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the file by auto tagging. + sig do + returns( + T.nilable(T::Array[Imagekit::Models::FileUpdateResponse::AITag]) + ) + end + attr_accessor :ai_tags + + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :created_at + + sig { params(created_at: String).void } + attr_writer :created_at + + # An string with custom coordinates of the file. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # An object with custom metadata for the file. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + sig do + returns( + T.nilable(Imagekit::Models::FileUpdateResponse::ExtensionStatus) + ) + end + attr_reader :extension_status + + sig do + params( + extension_status: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::OrHash + ).void + end + attr_writer :extension_status + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # 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`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Specifies if the image has an alpha channel. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_alpha + + sig { params(has_alpha: T::Boolean).void } + attr_writer :has_alpha + + # Height of the file. + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :height + + # Specifies if the file is private or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # Specifies if the file is published or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # MIME type of the file. + sig { returns(T.nilable(String)) } + attr_reader :mime + + sig { params(mime: String).void } + attr_writer :mime + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the file in bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :size + + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail + + sig { params(thumbnail: String).void } + attr_writer :thumbnail + + # Type of the asset. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(String)) } + attr_reader :updated_at + + sig { params(updated_at: String).void } + attr_writer :updated_at + + # URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object with details of the file version. + sig do + returns(T.nilable(Imagekit::Models::FileUpdateResponse::VersionInfo)) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::FileUpdateResponse::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # Width of the file. + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + sig do + params( + ai_tags: + T.nilable( + T::Array[Imagekit::Models::FileUpdateResponse::AITag::OrHash] + ), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + extension_status: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::OrHash, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: + Imagekit::Models::FileUpdateResponse::VersionInfo::OrHash, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the file by auto tagging. + ai_tags: nil, + # Date and time when the file was uploaded. The date and time is in ISO8601 + # format. + created_at: nil, + # An string with custom coordinates of the file. + custom_coordinates: nil, + # An object with custom metadata for the file. + custom_metadata: nil, + extension_status: nil, + # Unique identifier of the asset. + file_id: nil, + # 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`. + file_path: nil, + # Type of the file. Possible values are `image`, `non-image`. + file_type: nil, + # Specifies if the image has an alpha channel. + has_alpha: nil, + # Height of the file. + height: nil, + # Specifies if the file is private or not. + is_private_file: nil, + # Specifies if the file is published or not. + is_published: nil, + # MIME type of the file. + mime: nil, + # Name of the asset. + name: nil, + # Size of the file in bytes. + size: nil, + # An array of tags assigned to the file. Tags are used to search files in the + # media library. + tags: nil, + # URL of the thumbnail image. This URL is used to access the thumbnail image of + # the file in the media library. + thumbnail: nil, + # Type of the asset. + type: nil, + # Date and time when the file was last updated. The date and time is in ISO8601 + # format. + updated_at: nil, + # URL of the file. + url: nil, + # An object with details of the file version. + version_info: nil, + # Width of the file. + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable(T::Array[Imagekit::Models::FileUpdateResponse::AITag]), + created_at: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + extension_status: + Imagekit::Models::FileUpdateResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + has_alpha: T::Boolean, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + mime: String, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUpdateResponse::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # Source of the tag. Possible values are `google-auto-tagging` and + # `aws-auto-tagging`. + source: nil + ) + end + + sig do + override.returns({ confidence: Float, name: String, source: String }) + end + def to_hash + end + end + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUpdateResponse::ExtensionStatus, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + ) + end + attr_reader :ai_auto_description + + sig do + params( + ai_auto_description: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::OrSymbol + ).void + end + attr_writer :ai_auto_description + + sig do + returns( + T.nilable( + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :aws_auto_tagging + + sig do + params( + aws_auto_tagging: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol + ).void + end + attr_writer :aws_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :google_auto_tagging + + sig do + params( + google_auto_tagging: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol + ).void + end + attr_writer :google_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + ) + end + attr_reader :remove_bg + + sig do + params( + remove_bg: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol + ).void + end + attr_writer :remove_bg + + sig do + params( + ai_auto_description: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::OrSymbol, + aws_auto_tagging: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, + google_auto_tagging: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, + remove_bg: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol + ).returns(T.attached_class) + end + def self.new( + ai_auto_description: nil, + aws_auto_tagging: nil, + google_auto_tagging: nil, + remove_bg: nil + ) + end + + sig do + override.returns( + { + ai_auto_description: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, + aws_auto_tagging: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + google_auto_tagging: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + remove_bg: + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + } + ) + end + def to_hash + end + + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ] + ) + end + def self.values + end + end + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUpdateResponse::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object with details of the file version. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi new file mode 100644 index 00000000..00f5b321 --- /dev/null +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -0,0 +1,1421 @@ +# typed: strong + +module Imagekit + module Models + class FileUploadParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FileUploadParams, Imagekit::Internal::AnyHash) + end + + # 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. + sig { returns(Imagekit::Internal::FileInput) } + attr_accessor :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 `_` + sig { returns(String) } + attr_accessor :file_name + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :token + + sig { params(token: String).void } + attr_writer :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). + sig { returns(T.nilable(String)) } + attr_reader :checks + + sig { params(checks: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :custom_coordinates + + sig { params(custom_coordinates: String).void } + attr_writer :custom_coordinates + + # JSON key-value pairs to associate with the asset. Create the custom metadata + # fields before setting these values. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :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. + sig { returns(T.nilable(Integer)) } + attr_reader :expire + + sig { params(expire: Integer).void } + attr_writer :expire + + # Array of extensions to be applied to the image. Each extension can be configured + # with specific parameters based on the extension type. + sig do + returns( + T.nilable( + T::Array[ + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + ) + ] + ) + ) + end + attr_reader :extensions + + sig do + params( + extensions: + T::Array[ + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + ) + ] + ).void + end + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :folder + + sig { params(folder: String).void } + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overwrite_ai_tags + + sig { params(overwrite_ai_tags: T::Boolean).void } + attr_writer :overwrite_ai_tags + + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overwrite_custom_metadata + + sig { params(overwrite_custom_metadata: T::Boolean).void } + attr_writer :overwrite_custom_metadata + + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overwrite_file + + sig { params(overwrite_file: T::Boolean).void } + attr_writer :overwrite_file + + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overwrite_tags + + sig { params(overwrite_tags: T::Boolean).void } + attr_writer :overwrite_tags + + # Your ImageKit.io public key. This field is only required for authentication when + # uploading a file from the client side. + sig { returns(T.nilable(String)) } + attr_reader :public_key + + sig { params(public_key: String).void } + attr_writer :public_key + + # Array of response field keys to include in the API response body. + sig do + returns( + T.nilable( + T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol] + ) + ) + end + attr_reader :response_fields + + sig do + params( + response_fields: + T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol] + ).void + end + attr_writer :response_fields + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :signature + + sig { params(signature: String).void } + attr_writer :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. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :tags + + sig { params(tags: T::Array[String]).void } + attr_writer :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. + sig { returns(T.nilable(Imagekit::FileUploadParams::Transformation)) } + attr_reader :transformation + + sig do + params( + transformation: Imagekit::FileUploadParams::Transformation::OrHash + ).void + end + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :use_unique_file_name + + sig { params(use_unique_file_name: T::Boolean).void } + attr_writer :use_unique_file_name + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + sig do + params( + file: Imagekit::Internal::FileInput, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + expire: Integer, + extensions: + T::Array[ + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + ) + ], + folder: String, + is_private_file: T::Boolean, + is_published: T::Boolean, + overwrite_ai_tags: T::Boolean, + overwrite_custom_metadata: T::Boolean, + overwrite_file: T::Boolean, + overwrite_tags: T::Boolean, + public_key: String, + response_fields: + T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], + signature: String, + tags: T::Array[String], + transformation: Imagekit::FileUploadParams::Transformation::OrHash, + use_unique_file_name: T::Boolean, + webhook_url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # 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. + 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 `_` + file_name:, + # 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. + token: nil, + # Server-side checks to run on the asset. Read more about + # [Upload API checks](/docs/api-reference/upload-file/upload-file#upload-api-checks). + checks: nil, + # 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. + custom_coordinates: nil, + # JSON key-value pairs to associate with the asset. Create the custom metadata + # fields before setting these values. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # 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. + expire: nil, + # Array of extensions to be applied to the image. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + folder: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # 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. + overwrite_ai_tags: nil, + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + overwrite_custom_metadata: nil, + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + overwrite_file: nil, + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + overwrite_tags: nil, + # Your ImageKit.io public key. This field is only required for authentication when + # uploading a file from the client side. + public_key: nil, + # Array of response field keys to include in the API response body. + response_fields: nil, + # 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. + signature: nil, + # 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. + tags: nil, + # 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. + transformation: nil, + # 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. + use_unique_file_name: nil, + # 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. + webhook_url: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + file: Imagekit::Internal::FileInput, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + expire: Integer, + extensions: + T::Array[ + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + ) + ], + folder: String, + is_private_file: T::Boolean, + is_published: T::Boolean, + overwrite_ai_tags: T::Boolean, + overwrite_custom_metadata: T::Boolean, + overwrite_file: T::Boolean, + overwrite_tags: T::Boolean, + public_key: String, + response_fields: + T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], + signature: String, + tags: T::Array[String], + transformation: Imagekit::FileUploadParams::Transformation, + use_unique_file_name: T::Boolean, + webhook_url: String, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + + module Extension + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + ) + end + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig do + returns( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + returns( + T.nilable( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + name: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil + ) + end + + sig do + override.returns( + { + name: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + } + ) + end + def to_hash + end + + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig do + returns( + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + name: + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Specifies the auto description extension. + name: + ) + end + + sig do + override.returns( + { + name: + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[Imagekit::FileUploadParams::Extension::Variants] + ) + end + def self.variants + end + end + + module ResponseField + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUploadParams::ResponseField) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TAGS = + T.let(:tags, Imagekit::FileUploadParams::ResponseField::TaggedSymbol) + CUSTOM_COORDINATES = + T.let( + :customCoordinates, + Imagekit::FileUploadParams::ResponseField::TaggedSymbol + ) + IS_PRIVATE_FILE = + T.let( + :isPrivateFile, + Imagekit::FileUploadParams::ResponseField::TaggedSymbol + ) + EMBEDDED_METADATA = + T.let( + :embeddedMetadata, + Imagekit::FileUploadParams::ResponseField::TaggedSymbol + ) + IS_PUBLISHED = + T.let( + :isPublished, + Imagekit::FileUploadParams::ResponseField::TaggedSymbol + ) + CUSTOM_METADATA = + T.let( + :customMetadata, + Imagekit::FileUploadParams::ResponseField::TaggedSymbol + ) + METADATA = + T.let( + :metadata, + Imagekit::FileUploadParams::ResponseField::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::FileUploadParams::ResponseField::TaggedSymbol] + ) + end + def self.values + end + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Transformation, + Imagekit::Internal::AnyHash + ) + end + + # 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`. + sig do + returns( + T.nilable( + T::Array[ + T.any( + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + ) + ] + ) + ) + end + attr_reader :post + + sig do + params( + post: + T::Array[ + T.any( + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::OrHash, + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::OrHash, + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::OrHash, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::OrHash + ) + ] + ).void + end + attr_writer :post + + # Transformation string to apply before uploading the file to the Media Library. + # Useful for optimizing files at ingestion. + sig { returns(T.nilable(String)) } + attr_reader :pre + + sig { params(pre: String).void } + attr_writer :pre + + # 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. + sig do + params( + post: + T::Array[ + T.any( + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::OrHash, + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::OrHash, + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::OrHash, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::OrHash + ) + ], + pre: String + ).returns(T.attached_class) + end + def self.new( + # 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`. + post: nil, + # Transformation string to apply before uploading the file to the Media Library. + # Useful for optimizing files at ingestion. + pre: nil + ) + end + + sig do + override.returns( + { + post: + T::Array[ + T.any( + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + ) + ], + pre: String + } + ) + end + def to_hash + end + + module Post + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + ) + end + + class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::Internal::AnyHash + ) + end + + # Transformation type. + sig do + returns( + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol + ) + end + attr_accessor :type + + # Transformation string (e.g. `w-200,h-200`). + # Same syntax as ImageKit URL-based transformations. + sig { returns(String) } + attr_accessor :value + + sig do + params( + type: + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Transformation type. + type:, + # Transformation string (e.g. `w-200,h-200`). + # Same syntax as ImageKit URL-based transformations. + value: + ) + end + + sig do + override.returns( + { + type: + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol, + value: String + } + ) + end + def to_hash + end + + # Transformation type. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRANSFORMATION = + T.let( + :transformation, + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::Internal::AnyHash + ) + end + + # Converts an animated GIF into an MP4. + sig do + returns( + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol + ) + end + attr_accessor :type + + # Optional transformation string to apply to the output video. + # **Example**: `q-80` + sig { returns(T.nilable(String)) } + attr_reader :value + + sig { params(value: String).void } + attr_writer :value + + sig do + params( + type: + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Converts an animated GIF into an MP4. + type:, + # Optional transformation string to apply to the output video. + # **Example**: `q-80` + value: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol, + value: String + } + ) + end + def to_hash + end + + # Converts an animated GIF into an MP4. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GIF_TO_VIDEO = + T.let( + :"gif-to-video", + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::Internal::AnyHash + ) + end + + # Generates a thumbnail image. + sig do + returns( + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol + ) + end + attr_accessor :type + + # Optional transformation string. + # **Example**: `w-150,h-150` + sig { returns(T.nilable(String)) } + attr_reader :value + + sig { params(value: String).void } + attr_writer :value + + sig do + params( + type: + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Generates a thumbnail image. + type:, + # Optional transformation string. + # **Example**: `w-150,h-150` + value: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol, + value: String + } + ) + end + def to_hash + end + + # Generates a thumbnail image. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + THUMBNAIL = + T.let( + :thumbnail, + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming, + Imagekit::Internal::AnyHash + ) + end + + # Streaming protocol to use (`hls` or `dash`). + sig do + returns( + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol + ) + end + attr_accessor :protocol + + # Adaptive Bitrate Streaming (ABS) setup. + sig do + returns( + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol + ) + end + attr_accessor :type + + # List of different representations you want to create separated by an underscore. + sig { returns(String) } + attr_accessor :value + + sig do + params( + protocol: + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol, + type: + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Streaming protocol to use (`hls` or `dash`). + protocol:, + # Adaptive Bitrate Streaming (ABS) setup. + type:, + # List of different representations you want to create separated by an underscore. + value: + ) + end + + sig do + override.returns( + { + protocol: + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol, + type: + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol, + value: String + } + ) + end + def to_hash + end + + # Streaming protocol to use (`hls` or `dash`). + module Protocol + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HLS = + T.let( + :hls, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol + ) + DASH = + T.let( + :dash, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Adaptive Bitrate Streaming (ABS) setup. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ABS = + T.let( + :abs, + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Transformation::Post::Variants + ] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekit/models/file_upload_response.rbi new file mode 100644 index 00000000..f32cdbe2 --- /dev/null +++ b/rbi/imagekit/models/file_upload_response.rbi @@ -0,0 +1,1556 @@ +# typed: strong + +module Imagekit + module Models + class FileUploadResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the uploaded file by auto tagging. + sig do + returns( + T.nilable(T::Array[Imagekit::Models::FileUploadResponse::AITag]) + ) + end + attr_accessor :ai_tags + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T.anything)) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T.anything).void } + attr_writer :custom_metadata + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :embedded_metadata + + sig { params(embedded_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :embedded_metadata + + # 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. + sig do + returns( + T.nilable(Imagekit::Models::FileUploadResponse::ExtensionStatus) + ) + end + attr_reader :extension_status + + sig do + params( + extension_status: + Imagekit::Models::FileUploadResponse::ExtensionStatus::OrHash + ).void + end + attr_writer :extension_status + + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the uploaded file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Height of the image in pixels (Only for images) + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig { returns(T.nilable(Imagekit::Models::FileUploadResponse::Metadata)) } + attr_reader :metadata + + sig do + params( + metadata: Imagekit::Models::FileUploadResponse::Metadata::OrHash + ).void + end + attr_writer :metadata + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the image file in Bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # In the case of an image, a small thumbnail URL. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail_url + + sig { params(thumbnail_url: String).void } + attr_writer :thumbnail_url + + # A publicly accessible URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object containing the file or file version's `id` (versionId) and `name`. + sig do + returns(T.nilable(Imagekit::Models::FileUploadResponse::VersionInfo)) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::Models::FileUploadResponse::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # Width of the image in pixels (Only for Images) + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a successful upload. + sig do + params( + ai_tags: + T.nilable( + T::Array[Imagekit::Models::FileUploadResponse::AITag::OrHash] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + duration: Integer, + embedded_metadata: T::Hash[Symbol, T.anything], + extension_status: + Imagekit::Models::FileUploadResponse::ExtensionStatus::OrHash, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: Imagekit::Models::FileUploadResponse::Metadata::OrHash, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: + Imagekit::Models::FileUploadResponse::VersionInfo::OrHash, + video_codec: String, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the uploaded file by auto tagging. + ai_tags: nil, + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # The duration of the video in seconds (only for video). + duration: nil, + # 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. + embedded_metadata: nil, + # 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. + extension_status: nil, + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + file_id: nil, + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + file_path: nil, + # Type of the uploaded file. Possible values are `image`, `non-image`. + file_type: nil, + # Height of the image in pixels (Only for images) + height: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + metadata: nil, + # Name of the asset. + name: nil, + # Size of the image file in Bytes. + size: nil, + # 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. + tags: nil, + # In the case of an image, a small thumbnail URL. + thumbnail_url: nil, + # A publicly accessible URL of the file. + url: nil, + # An object containing the file or file version's `id` (versionId) and `name`. + version_info: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # Width of the image in pixels (Only for Images) + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable(T::Array[Imagekit::Models::FileUploadResponse::AITag]), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + duration: Integer, + embedded_metadata: T::Hash[Symbol, T.anything], + extension_status: + Imagekit::Models::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: Imagekit::Models::FileUploadResponse::Metadata, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # 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. + source: nil + ) + end + + sig do + override.returns({ confidence: Float, name: String, source: String }) + end + def to_hash + end + end + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::ExtensionStatus, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :aws_auto_tagging + + sig do + params( + aws_auto_tagging: + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol + ).void + end + attr_writer :aws_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :google_auto_tagging + + sig do + params( + google_auto_tagging: + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol + ).void + end + attr_writer :google_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + ) + end + attr_reader :remove_bg + + sig do + params( + remove_bg: + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol + ).void + end + attr_writer :remove_bg + + # 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. + sig do + params( + aws_auto_tagging: + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, + google_auto_tagging: + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, + remove_bg: + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol + ).returns(T.attached_class) + end + def self.new( + aws_auto_tagging: nil, + google_auto_tagging: nil, + remove_bg: nil + ) + end + + sig do + override.returns( + { + aws_auto_tagging: + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + google_auto_tagging: + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + remove_bg: + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + } + ) + end + def to_hash + end + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class Metadata < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata, + Imagekit::Internal::AnyHash + ) + end + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig do + returns( + T.nilable(Imagekit::Models::FileUploadResponse::Metadata::Exif) + ) + end + attr_reader :exif + + sig do + params( + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::OrHash + ).void + end + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif, + Imagekit::Internal::AnyHash + ) + end + + # Object containing Exif details. + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif + ) + ) + end + attr_reader :exif + + sig do + params( + exif: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif::OrHash + ).void + end + attr_writer :exif + + # Object containing GPS information. + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps + ) + ) + end + attr_reader :gps + + sig do + params( + gps: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps::OrHash + ).void + end + attr_writer :gps + + # Object containing EXIF image information. + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image + ) + ) + end + attr_reader :image + + sig do + params( + image: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image::OrHash + ).void + end + attr_writer :image + + # JSON object. + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability + ) + ) + end + attr_reader :interoperability + + sig do + params( + interoperability: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability::OrHash + ).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + ) + ) + end + attr_reader :thumbnail + + sig do + params( + thumbnail: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash + ).void + end + attr_writer :thumbnail + + sig do + params( + exif: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif::OrHash, + gps: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps::OrHash, + image: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image::OrHash, + interoperability: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + image: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + interoperability: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns( + T.attached_class + ) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns( + { interop_index: String, interop_version: String } + ) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object containing the file or file version's `id` (versionId) and `name`. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/file_upload_v1_params.rbi b/rbi/imagekit/models/file_upload_v1_params.rbi deleted file mode 100644 index e1a18d50..00000000 --- a/rbi/imagekit/models/file_upload_v1_params.rbi +++ /dev/null @@ -1,722 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileUploadV1Params < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileUploadV1Params, Imagekit::Internal::AnyHash) - end - - # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, - # please ensure that our servers can access the URL. In case ImageKit is unable to - # download the file from the specified URL, a `400` error response is returned. - # This will also result in a `400` error if the file download request is aborted - # if response headers are not received in 8 seconds. - sig { returns(String) } - attr_accessor :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 `_` - sig { returns(String) } - attr_accessor :file_name - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :token - - sig { params(token: String).void } - attr_writer :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). - sig { returns(T.nilable(String)) } - attr_reader :checks - - sig { params(checks: String).void } - attr_writer :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. - sig { returns(T.nilable(String)) } - attr_reader :custom_coordinates - - sig { params(custom_coordinates: String).void } - attr_writer :custom_coordinates - - # Stringified JSON key-value data to be associated with the asset. - sig { returns(T.nilable(String)) } - attr_reader :custom_metadata - - sig { params(custom_metadata: String).void } - attr_writer :custom_metadata - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :expire - - sig { params(expire: String).void } - attr_writer :expire - - # Stringified JSON object with an array of extensions to be applied to the image. - # Refer to extensions schema in - # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). - sig { returns(T.nilable(String)) } - attr_reader :extensions - - sig { params(extensions: String).void } - attr_writer :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. - sig { returns(T.nilable(String)) } - attr_reader :folder - - sig { params(folder: String).void } - attr_writer :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. - sig do - returns( - T.nilable(Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol) - ) - end - attr_reader :is_private_file - - sig do - params( - is_private_file: Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol - ).void - end - attr_writer :is_private_file - - # 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. - sig do - returns(T.nilable(Imagekit::FileUploadV1Params::IsPublished::OrSymbol)) - end - attr_reader :is_published - - sig do - params( - is_published: Imagekit::FileUploadV1Params::IsPublished::OrSymbol - ).void - end - attr_writer :is_published - - # 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. - sig do - returns( - T.nilable(Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol) - ) - end - attr_reader :overwrite_ai_tags - - sig do - params( - overwrite_ai_tags: - Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol - ).void - end - attr_writer :overwrite_ai_tags - - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - sig do - returns( - T.nilable( - Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol - ) - ) - end - attr_reader :overwrite_custom_metadata - - sig do - params( - overwrite_custom_metadata: - Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol - ).void - end - attr_writer :overwrite_custom_metadata - - # If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # the exact location, upload API will return an error immediately. - sig { returns(T.nilable(String)) } - attr_reader :overwrite_file - - sig { params(overwrite_file: String).void } - attr_writer :overwrite_file - - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - sig do - returns( - T.nilable(Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol) - ) - end - attr_reader :overwrite_tags - - sig do - params( - overwrite_tags: Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol - ).void - end - attr_writer :overwrite_tags - - # Your ImageKit.io public key. This field is only required for authentication when - # uploading a file from the client side. - sig { returns(T.nilable(String)) } - attr_reader :public_key - - sig { params(public_key: String).void } - attr_writer :public_key - - # Comma-separated values of the fields that you want the API to return in the - # response. - # - # For example, set the value of this field to - # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, - # `customCoordinates`, and `isPrivateFile` in the response. - # - # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, - # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. - sig { returns(T.nilable(String)) } - attr_reader :response_fields - - sig { params(response_fields: String).void } - attr_writer :response_fields - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :signature - - sig { params(signature: String).void } - attr_writer :signature - - # Set the tags while uploading the file. - # - # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length - # of all characters should not exceed 500. `%` is not allowed. - # - # If this field is not specified and the file is overwritten then the tags will be - # removed. - sig { returns(T.nilable(String)) } - attr_reader :tags - - sig { params(tags: String).void } - attr_writer :tags - - # Stringified JSON object with properties for pre and post transformations: - # - # `pre` - Accepts a "string" containing a valid transformation used for requesting - # a pre-transformation for an image or a video file. - # - # `post` - Accepts an array of objects with properties: - # - # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` - # (Adaptive bitrate streaming). - # - `value`: A "string" corresponding to the required transformation. Required if - # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or - # `thumbnail`. - # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. - # - # Read more about - # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). - sig { returns(T.nilable(String)) } - attr_reader :transformation - - sig { params(transformation: String).void } - attr_writer :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. - sig do - returns( - T.nilable(Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol) - ) - end - attr_reader :use_unique_file_name - - sig do - params( - use_unique_file_name: - Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol - ).void - end - attr_writer :use_unique_file_name - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :webhook_url - - sig { params(webhook_url: String).void } - attr_writer :webhook_url - - sig do - params( - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - expire: String, - extensions: String, - folder: String, - is_private_file: - Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol, - is_published: Imagekit::FileUploadV1Params::IsPublished::OrSymbol, - overwrite_ai_tags: - Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol, - overwrite_custom_metadata: - Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol, - overwrite_file: String, - overwrite_tags: Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol, - public_key: String, - response_fields: String, - signature: String, - tags: String, - transformation: String, - use_unique_file_name: - Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol, - webhook_url: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, - # please ensure that our servers can access the URL. In case ImageKit is unable to - # download the file from the specified URL, a `400` error response is returned. - # This will also result in a `400` error if the file download request is aborted - # if response headers are not received in 8 seconds. - 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 `_` - file_name:, - # 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. - token: nil, - # Server-side checks to run on the asset. Read more about - # [Upload API checks](/docs/api-reference/upload-file/upload-file#upload-api-checks). - checks: nil, - # 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. - custom_coordinates: nil, - # Stringified JSON key-value data to be associated with the asset. - custom_metadata: nil, - # 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. - expire: nil, - # Stringified JSON object with an array of extensions to be applied to the image. - # Refer to extensions schema in - # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). - extensions: nil, - # 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. - folder: nil, - # 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. - is_private_file: nil, - # 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. - is_published: nil, - # 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. - overwrite_ai_tags: nil, - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - overwrite_custom_metadata: nil, - # If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # the exact location, upload API will return an error immediately. - overwrite_file: nil, - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - overwrite_tags: nil, - # Your ImageKit.io public key. This field is only required for authentication when - # uploading a file from the client side. - public_key: nil, - # Comma-separated values of the fields that you want the API to return in the - # response. - # - # For example, set the value of this field to - # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, - # `customCoordinates`, and `isPrivateFile` in the response. - # - # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, - # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. - response_fields: nil, - # 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. - signature: nil, - # Set the tags while uploading the file. - # - # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length - # of all characters should not exceed 500. `%` is not allowed. - # - # If this field is not specified and the file is overwritten then the tags will be - # removed. - tags: nil, - # Stringified JSON object with properties for pre and post transformations: - # - # `pre` - Accepts a "string" containing a valid transformation used for requesting - # a pre-transformation for an image or a video file. - # - # `post` - Accepts an array of objects with properties: - # - # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` - # (Adaptive bitrate streaming). - # - `value`: A "string" corresponding to the required transformation. Required if - # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or - # `thumbnail`. - # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. - # - # Read more about - # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). - transformation: nil, - # 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. - use_unique_file_name: nil, - # 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. - webhook_url: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - expire: String, - extensions: String, - folder: String, - is_private_file: - Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol, - is_published: Imagekit::FileUploadV1Params::IsPublished::OrSymbol, - overwrite_ai_tags: - Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol, - overwrite_custom_metadata: - Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol, - overwrite_file: String, - overwrite_tags: - Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol, - public_key: String, - response_fields: String, - signature: String, - tags: String, - transformation: String, - use_unique_file_name: - Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol, - webhook_url: String, - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - - # 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. - module IsPrivateFile - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV1Params::IsPrivateFile) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV1Params::IsPrivateFile::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV1Params::IsPrivateFile::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Imagekit::FileUploadV1Params::IsPrivateFile::TaggedSymbol] - ) - end - def self.values - end - end - - # 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. - module IsPublished - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV1Params::IsPublished) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let(:true, Imagekit::FileUploadV1Params::IsPublished::TaggedSymbol) - FALSE = - T.let(:false, Imagekit::FileUploadV1Params::IsPublished::TaggedSymbol) - - sig do - override.returns( - T::Array[Imagekit::FileUploadV1Params::IsPublished::TaggedSymbol] - ) - end - def self.values - end - end - - # 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. - module OverwriteAITags - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV1Params::OverwriteAITags) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV1Params::OverwriteAITags::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV1Params::OverwriteAITags::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadV1Params::OverwriteAITags::TaggedSymbol - ] - ) - end - def self.values - end - end - - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - module OverwriteCustomMetadata - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV1Params::OverwriteCustomMetadata) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV1Params::OverwriteCustomMetadata::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV1Params::OverwriteCustomMetadata::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadV1Params::OverwriteCustomMetadata::TaggedSymbol - ] - ) - end - def self.values - end - end - - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - module OverwriteTags - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV1Params::OverwriteTags) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV1Params::OverwriteTags::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV1Params::OverwriteTags::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Imagekit::FileUploadV1Params::OverwriteTags::TaggedSymbol] - ) - end - def self.values - end - end - - # 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. - module UseUniqueFileName - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV1Params::UseUniqueFileName) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV1Params::UseUniqueFileName::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV1Params::UseUniqueFileName::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadV1Params::UseUniqueFileName::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/imagekit/models/file_upload_v1_response.rbi b/rbi/imagekit/models/file_upload_v1_response.rbi deleted file mode 100644 index 766fea1c..00000000 --- a/rbi/imagekit/models/file_upload_v1_response.rbi +++ /dev/null @@ -1,2625 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileUploadV1Response < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV1Response, - Imagekit::Internal::AnyHash - ) - end - - # An array of tags assigned to the uploaded file by auto tagging. - sig do - returns( - T.nilable(T::Array[Imagekit::Models::FileUploadV1Response::AITag]) - ) - end - attr_accessor :ai_tags - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # 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. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # 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. - sig { returns(T.nilable(T.anything)) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T.anything).void } - attr_writer :custom_metadata - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :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. - sig do - returns( - T.nilable(Imagekit::Models::FileUploadV1Response::EmbeddedMetadata) - ) - end - attr_reader :embedded_metadata - - sig do - params( - embedded_metadata: - Imagekit::Models::FileUploadV1Response::EmbeddedMetadata::OrHash - ).void - end - attr_writer :embedded_metadata - - # 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. - sig do - returns( - T.nilable(Imagekit::Models::FileUploadV1Response::ExtensionStatus) - ) - end - attr_reader :extension_status - - sig do - params( - extension_status: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::OrHash - ).void - end - attr_writer :extension_status - - # Unique fileId. Store this fileld in your database, as this will be used to - # perform update action on this file. - sig { returns(T.nilable(String)) } - attr_reader :file_id - - sig { params(file_id: String).void } - attr_writer :file_id - - # The relative path of the file in the media library e.g. - # `/marketing-assets/new-banner.jpg`. - sig { returns(T.nilable(String)) } - attr_reader :file_path - - sig { params(file_path: String).void } - attr_writer :file_path - - # Type of the uploaded file. Possible values are `image`, `non-image`. - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # Height of the image in pixels (Only for images) - sig { returns(T.nilable(Float)) } - attr_reader :height - - sig { params(height: Float).void } - attr_writer :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. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_private_file - - sig { params(is_private_file: T::Boolean).void } - attr_writer :is_private_file - - # 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. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_published - - sig { params(is_published: T::Boolean).void } - attr_writer :is_published - - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - sig do - returns(T.nilable(Imagekit::Models::FileUploadV1Response::Metadata)) - end - attr_reader :metadata - - sig do - params( - metadata: Imagekit::Models::FileUploadV1Response::Metadata::OrHash - ).void - end - attr_writer :metadata - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Size of the image file in Bytes. - sig { returns(T.nilable(Float)) } - attr_reader :size - - sig { params(size: Float).void } - attr_writer :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. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :tags - - # In the case of an image, a small thumbnail URL. - sig { returns(T.nilable(String)) } - attr_reader :thumbnail_url - - sig { params(thumbnail_url: String).void } - attr_writer :thumbnail_url - - # A publicly accessible URL of the file. - sig { returns(T.nilable(String)) } - attr_reader :url - - sig { params(url: String).void } - attr_writer :url - - # An object containing the file or file version's `id` (versionId) and `name`. - sig do - returns(T.nilable(Imagekit::Models::FileUploadV1Response::VersionInfo)) - end - attr_reader :version_info - - sig do - params( - version_info: - Imagekit::Models::FileUploadV1Response::VersionInfo::OrHash - ).void - end - attr_writer :version_info - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # Width of the image in pixels (Only for Images) - sig { returns(T.nilable(Float)) } - attr_reader :width - - sig { params(width: Float).void } - attr_writer :width - - # Object containing details of a successful upload. - sig do - params( - ai_tags: - T.nilable( - T::Array[Imagekit::Models::FileUploadV1Response::AITag::OrHash] - ), - audio_codec: String, - bit_rate: Integer, - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - duration: Integer, - embedded_metadata: - Imagekit::Models::FileUploadV1Response::EmbeddedMetadata::OrHash, - extension_status: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::OrHash, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - metadata: Imagekit::Models::FileUploadV1Response::Metadata::OrHash, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail_url: String, - url: String, - version_info: - Imagekit::Models::FileUploadV1Response::VersionInfo::OrHash, - video_codec: String, - width: Float - ).returns(T.attached_class) - end - def self.new( - # An array of tags assigned to the uploaded file by auto tagging. - ai_tags: nil, - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # The duration of the video in seconds (only for video). - duration: nil, - # 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. - embedded_metadata: nil, - # 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. - extension_status: nil, - # Unique fileId. Store this fileld in your database, as this will be used to - # perform update action on this file. - file_id: nil, - # The relative path of the file in the media library e.g. - # `/marketing-assets/new-banner.jpg`. - file_path: nil, - # Type of the uploaded file. Possible values are `image`, `non-image`. - file_type: nil, - # Height of the image in pixels (Only for images) - height: nil, - # 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. - is_private_file: nil, - # 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. - is_published: nil, - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - metadata: nil, - # Name of the asset. - name: nil, - # Size of the image file in Bytes. - size: nil, - # 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. - tags: nil, - # In the case of an image, a small thumbnail URL. - thumbnail_url: nil, - # A publicly accessible URL of the file. - url: nil, - # An object containing the file or file version's `id` (versionId) and `name`. - version_info: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # Width of the image in pixels (Only for Images) - width: nil - ) - end - - sig do - override.returns( - { - ai_tags: - T.nilable( - T::Array[Imagekit::Models::FileUploadV1Response::AITag] - ), - audio_codec: String, - bit_rate: Integer, - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - duration: Integer, - embedded_metadata: - Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, - extension_status: - Imagekit::Models::FileUploadV1Response::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - metadata: Imagekit::Models::FileUploadV1Response::Metadata, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::FileUploadV1Response::VersionInfo, - video_codec: String, - width: Float - } - ) - end - def to_hash - end - - class AITag < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV1Response::AITag, - Imagekit::Internal::AnyHash - ) - end - - # Confidence score of the tag. - sig { returns(T.nilable(Float)) } - attr_reader :confidence - - sig { params(confidence: Float).void } - attr_writer :confidence - - # Name of the tag. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :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. - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig do - params(confidence: Float, name: String, source: String).returns( - T.attached_class - ) - end - def self.new( - # Confidence score of the tag. - confidence: nil, - # Name of the tag. - name: nil, - # 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. - source: nil - ) - end - - sig do - override.returns({ confidence: Float, name: String, source: String }) - end - def to_hash - end - end - - class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :about_cv_term_cv_id - - sig { params(about_cv_term_cv_id: String).void } - attr_writer :about_cv_term_cv_id - - sig { returns(T.nilable(String)) } - attr_reader :about_cv_term_id - - sig { params(about_cv_term_id: String).void } - attr_writer :about_cv_term_id - - sig { returns(T.nilable(String)) } - attr_reader :about_cv_term_name - - sig { params(about_cv_term_name: String).void } - attr_writer :about_cv_term_name - - sig { returns(T.nilable(String)) } - attr_reader :about_cv_term_refined_about - - sig { params(about_cv_term_refined_about: String).void } - attr_writer :about_cv_term_refined_about - - sig { returns(T.nilable(String)) } - attr_reader :additional_model_information - - sig { params(additional_model_information: String).void } - attr_writer :additional_model_information - - sig { returns(T.nilable(Integer)) } - attr_reader :application_record_version - - sig { params(application_record_version: Integer).void } - attr_writer :application_record_version - - sig { returns(T.nilable(String)) } - attr_reader :artist - - sig { params(artist: String).void } - attr_writer :artist - - sig { returns(T.nilable(String)) } - attr_reader :artwork_circa_date_created - - sig { params(artwork_circa_date_created: String).void } - attr_writer :artwork_circa_date_created - - sig { returns(T.nilable(String)) } - attr_reader :artwork_content_description - - sig { params(artwork_content_description: String).void } - attr_writer :artwork_content_description - - sig { returns(T.nilable(String)) } - attr_reader :artwork_contribution_description - - sig { params(artwork_contribution_description: String).void } - attr_writer :artwork_contribution_description - - sig { returns(T.nilable(String)) } - attr_reader :artwork_copyright_notice - - sig { params(artwork_copyright_notice: String).void } - attr_writer :artwork_copyright_notice - - sig { returns(T.nilable(String)) } - attr_reader :artwork_copyright_owner_id - - sig { params(artwork_copyright_owner_id: String).void } - attr_writer :artwork_copyright_owner_id - - sig { returns(T.nilable(String)) } - attr_reader :artwork_copyright_owner_name - - sig { params(artwork_copyright_owner_name: String).void } - attr_writer :artwork_copyright_owner_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :artwork_creator - - sig { params(artwork_creator: T::Array[String]).void } - attr_writer :artwork_creator - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :artwork_creator_id - - sig { params(artwork_creator_id: T::Array[String]).void } - attr_writer :artwork_creator_id - - sig { returns(T.nilable(Time)) } - attr_reader :artwork_date_created - - sig { params(artwork_date_created: Time).void } - attr_writer :artwork_date_created - - sig { returns(T.nilable(String)) } - attr_reader :artwork_licensor_id - - sig { params(artwork_licensor_id: String).void } - attr_writer :artwork_licensor_id - - sig { returns(T.nilable(String)) } - attr_reader :artwork_licensor_name - - sig { params(artwork_licensor_name: String).void } - attr_writer :artwork_licensor_name - - sig { returns(T.nilable(String)) } - attr_reader :artwork_physical_description - - sig { params(artwork_physical_description: String).void } - attr_writer :artwork_physical_description - - sig { returns(T.nilable(String)) } - attr_reader :artwork_source - - sig { params(artwork_source: String).void } - attr_writer :artwork_source - - sig { returns(T.nilable(String)) } - attr_reader :artwork_source_inventory_no - - sig { params(artwork_source_inventory_no: String).void } - attr_writer :artwork_source_inventory_no - - sig { returns(T.nilable(String)) } - attr_reader :artwork_source_inv_url - - sig { params(artwork_source_inv_url: String).void } - attr_writer :artwork_source_inv_url - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :artwork_style_period - - sig { params(artwork_style_period: T::Array[String]).void } - attr_writer :artwork_style_period - - sig { returns(T.nilable(String)) } - attr_reader :artwork_title - - sig { params(artwork_title: String).void } - attr_writer :artwork_title - - sig { returns(T.nilable(String)) } - attr_reader :authors_position - - sig { params(authors_position: String).void } - attr_writer :authors_position - - sig { returns(T.nilable(String)) } - attr_reader :byline - - sig { params(byline: String).void } - attr_writer :byline - - sig { returns(T.nilable(String)) } - attr_reader :byline_title - - sig { params(byline_title: String).void } - attr_writer :byline_title - - sig { returns(T.nilable(String)) } - attr_reader :caption - - sig { params(caption: String).void } - attr_writer :caption - - sig { returns(T.nilable(String)) } - attr_reader :caption_abstract - - sig { params(caption_abstract: String).void } - attr_writer :caption_abstract - - sig { returns(T.nilable(String)) } - attr_reader :caption_writer - - sig { params(caption_writer: String).void } - attr_writer :caption_writer - - sig { returns(T.nilable(String)) } - attr_reader :city - - sig { params(city: String).void } - attr_writer :city - - sig { returns(T.nilable(String)) } - attr_reader :color_space - - sig { params(color_space: String).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :components_configuration - - sig { params(components_configuration: String).void } - attr_writer :components_configuration - - sig { returns(T.nilable(String)) } - attr_reader :copyright - - sig { params(copyright: String).void } - attr_writer :copyright - - sig { returns(T.nilable(String)) } - attr_reader :copyright_notice - - sig { params(copyright_notice: String).void } - attr_writer :copyright_notice - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :copyright_owner_id - - sig { params(copyright_owner_id: T::Array[String]).void } - attr_writer :copyright_owner_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :copyright_owner_name - - sig { params(copyright_owner_name: T::Array[String]).void } - attr_writer :copyright_owner_name - - sig { returns(T.nilable(String)) } - attr_reader :country - - sig { params(country: String).void } - attr_writer :country - - sig { returns(T.nilable(String)) } - attr_reader :country_code - - sig { params(country_code: String).void } - attr_writer :country_code - - sig { returns(T.nilable(String)) } - attr_reader :country_primary_location_code - - sig { params(country_primary_location_code: String).void } - attr_writer :country_primary_location_code - - sig { returns(T.nilable(String)) } - attr_reader :country_primary_location_name - - sig { params(country_primary_location_name: String).void } - attr_writer :country_primary_location_name - - sig { returns(T.nilable(String)) } - attr_reader :creator - - sig { params(creator: String).void } - attr_writer :creator - - sig { returns(T.nilable(String)) } - attr_reader :creator_address - - sig { params(creator_address: String).void } - attr_writer :creator_address - - sig { returns(T.nilable(String)) } - attr_reader :creator_city - - sig { params(creator_city: String).void } - attr_writer :creator_city - - sig { returns(T.nilable(String)) } - attr_reader :creator_country - - sig { params(creator_country: String).void } - attr_writer :creator_country - - sig { returns(T.nilable(String)) } - attr_reader :creator_postal_code - - sig { params(creator_postal_code: String).void } - attr_writer :creator_postal_code - - sig { returns(T.nilable(String)) } - attr_reader :creator_region - - sig { params(creator_region: String).void } - attr_writer :creator_region - - sig { returns(T.nilable(String)) } - attr_reader :creator_work_email - - sig { params(creator_work_email: String).void } - attr_writer :creator_work_email - - sig { returns(T.nilable(String)) } - attr_reader :creator_work_telephone - - sig { params(creator_work_telephone: String).void } - attr_writer :creator_work_telephone - - sig { returns(T.nilable(String)) } - attr_reader :creator_work_url - - sig { params(creator_work_url: String).void } - attr_writer :creator_work_url - - sig { returns(T.nilable(String)) } - attr_reader :credit - - sig { params(credit: String).void } - attr_writer :credit - - sig { returns(T.nilable(Time)) } - attr_reader :date_created - - sig { params(date_created: Time).void } - attr_writer :date_created - - sig { returns(T.nilable(Time)) } - attr_reader :date_time_created - - sig { params(date_time_created: Time).void } - attr_writer :date_time_created - - sig { returns(T.nilable(Time)) } - attr_reader :date_time_original - - sig { params(date_time_original: Time).void } - attr_writer :date_time_original - - sig { returns(T.nilable(String)) } - attr_reader :description - - sig { params(description: String).void } - attr_writer :description - - sig { returns(T.nilable(String)) } - attr_reader :digital_image_guid - - sig { params(digital_image_guid: String).void } - attr_writer :digital_image_guid - - sig { returns(T.nilable(String)) } - attr_reader :digital_source_type - - sig { params(digital_source_type: String).void } - attr_writer :digital_source_type - - sig { returns(T.nilable(String)) } - attr_reader :embedded_encoded_rights_expr - - sig { params(embedded_encoded_rights_expr: String).void } - attr_writer :embedded_encoded_rights_expr - - sig { returns(T.nilable(String)) } - attr_reader :embedded_encoded_rights_expr_lang_id - - sig { params(embedded_encoded_rights_expr_lang_id: String).void } - attr_writer :embedded_encoded_rights_expr_lang_id - - sig { returns(T.nilable(String)) } - attr_reader :embedded_encoded_rights_expr_type - - sig { params(embedded_encoded_rights_expr_type: String).void } - attr_writer :embedded_encoded_rights_expr_type - - sig { returns(T.nilable(String)) } - attr_reader :event - - sig { params(event: String).void } - attr_writer :event - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(String)) } - attr_reader :genre_cv_id - - sig { params(genre_cv_id: String).void } - attr_writer :genre_cv_id - - sig { returns(T.nilable(String)) } - attr_reader :genre_cv_term_id - - sig { params(genre_cv_term_id: String).void } - attr_writer :genre_cv_term_id - - sig { returns(T.nilable(String)) } - attr_reader :genre_cv_term_name - - sig { params(genre_cv_term_name: String).void } - attr_writer :genre_cv_term_name - - sig { returns(T.nilable(String)) } - attr_reader :genre_cv_term_refined_about - - sig { params(genre_cv_term_refined_about: String).void } - attr_writer :genre_cv_term_refined_about - - sig { returns(T.nilable(String)) } - attr_reader :headline - - sig { params(headline: String).void } - attr_writer :headline - - sig { returns(T.nilable(String)) } - attr_reader :image_creator_id - - sig { params(image_creator_id: String).void } - attr_writer :image_creator_id - - sig { returns(T.nilable(String)) } - attr_reader :image_creator_image_id - - sig { params(image_creator_image_id: String).void } - attr_writer :image_creator_image_id - - sig { returns(T.nilable(String)) } - attr_reader :image_creator_name - - sig { params(image_creator_name: String).void } - attr_writer :image_creator_name - - sig { returns(T.nilable(String)) } - attr_reader :image_description - - sig { params(image_description: String).void } - attr_writer :image_description - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_h - - sig { params(image_region_boundary_h: T::Array[Float]).void } - attr_writer :image_region_boundary_h - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_rx - - sig { params(image_region_boundary_rx: T::Array[Float]).void } - attr_writer :image_region_boundary_rx - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_boundary_shape - - sig { params(image_region_boundary_shape: T::Array[String]).void } - attr_writer :image_region_boundary_shape - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_boundary_unit - - sig { params(image_region_boundary_unit: T::Array[String]).void } - attr_writer :image_region_boundary_unit - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_vertices_x - - sig { params(image_region_boundary_vertices_x: T::Array[Float]).void } - attr_writer :image_region_boundary_vertices_x - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_vertices_y - - sig { params(image_region_boundary_vertices_y: T::Array[Float]).void } - attr_writer :image_region_boundary_vertices_y - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_w - - sig { params(image_region_boundary_w: T::Array[Float]).void } - attr_writer :image_region_boundary_w - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_x - - sig { params(image_region_boundary_x: T::Array[Float]).void } - attr_writer :image_region_boundary_x - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_y - - sig { params(image_region_boundary_y: T::Array[Float]).void } - attr_writer :image_region_boundary_y - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_ctype_identifier - - sig { params(image_region_ctype_identifier: T::Array[String]).void } - attr_writer :image_region_ctype_identifier - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_ctype_name - - sig { params(image_region_ctype_name: T::Array[String]).void } - attr_writer :image_region_ctype_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_id - - sig { params(image_region_id: T::Array[String]).void } - attr_writer :image_region_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_name - - sig { params(image_region_name: T::Array[String]).void } - attr_writer :image_region_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_organisation_in_image_name - - sig do - params(image_region_organisation_in_image_name: T::Array[String]).void - end - attr_writer :image_region_organisation_in_image_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_person_in_image - - sig { params(image_region_person_in_image: T::Array[String]).void } - attr_writer :image_region_person_in_image - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_role_identifier - - sig { params(image_region_role_identifier: T::Array[String]).void } - attr_writer :image_region_role_identifier - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_role_name - - sig { params(image_region_role_name: T::Array[String]).void } - attr_writer :image_region_role_name - - sig { returns(T.nilable(String)) } - attr_reader :image_supplier_id - - sig { params(image_supplier_id: String).void } - attr_writer :image_supplier_id - - sig { returns(T.nilable(String)) } - attr_reader :image_supplier_image_id - - sig { params(image_supplier_image_id: String).void } - attr_writer :image_supplier_image_id - - sig { returns(T.nilable(String)) } - attr_reader :image_supplier_name - - sig { params(image_supplier_name: String).void } - attr_writer :image_supplier_name - - sig { returns(T.nilable(String)) } - attr_reader :instructions - - sig { params(instructions: String).void } - attr_writer :instructions - - sig { returns(T.nilable(String)) } - attr_reader :intellectual_genre - - sig { params(intellectual_genre: String).void } - attr_writer :intellectual_genre - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :keywords - - sig { params(keywords: T::Array[String]).void } - attr_writer :keywords - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_city - - sig { params(licensor_city: T::Array[String]).void } - attr_writer :licensor_city - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_country - - sig { params(licensor_country: T::Array[String]).void } - attr_writer :licensor_country - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_email - - sig { params(licensor_email: T::Array[String]).void } - attr_writer :licensor_email - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_extended_address - - sig { params(licensor_extended_address: T::Array[String]).void } - attr_writer :licensor_extended_address - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_id - - sig { params(licensor_id: T::Array[String]).void } - attr_writer :licensor_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_name - - sig { params(licensor_name: T::Array[String]).void } - attr_writer :licensor_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_postal_code - - sig { params(licensor_postal_code: T::Array[String]).void } - attr_writer :licensor_postal_code - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_region - - sig { params(licensor_region: T::Array[String]).void } - attr_writer :licensor_region - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_street_address - - sig { params(licensor_street_address: T::Array[String]).void } - attr_writer :licensor_street_address - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_telephone1 - - sig { params(licensor_telephone1: T::Array[String]).void } - attr_writer :licensor_telephone1 - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_telephone2 - - sig { params(licensor_telephone2: T::Array[String]).void } - attr_writer :licensor_telephone2 - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_url - - sig { params(licensor_url: T::Array[String]).void } - attr_writer :licensor_url - - sig { returns(T.nilable(String)) } - attr_reader :linked_encoded_rights_expr - - sig { params(linked_encoded_rights_expr: String).void } - attr_writer :linked_encoded_rights_expr - - sig { returns(T.nilable(String)) } - attr_reader :linked_encoded_rights_expr_lang_id - - sig { params(linked_encoded_rights_expr_lang_id: String).void } - attr_writer :linked_encoded_rights_expr_lang_id - - sig { returns(T.nilable(String)) } - attr_reader :linked_encoded_rights_expr_type - - sig { params(linked_encoded_rights_expr_type: String).void } - attr_writer :linked_encoded_rights_expr_type - - sig { returns(T.nilable(String)) } - attr_reader :location - - sig { params(location: String).void } - attr_writer :location - - sig { returns(T.nilable(String)) } - attr_reader :location_created_city - - sig { params(location_created_city: String).void } - attr_writer :location_created_city - - sig { returns(T.nilable(String)) } - attr_reader :location_created_country_code - - sig { params(location_created_country_code: String).void } - attr_writer :location_created_country_code - - sig { returns(T.nilable(String)) } - attr_reader :location_created_country_name - - sig { params(location_created_country_name: String).void } - attr_writer :location_created_country_name - - sig { returns(T.nilable(String)) } - attr_reader :location_created_gps_altitude - - sig { params(location_created_gps_altitude: String).void } - attr_writer :location_created_gps_altitude - - sig { returns(T.nilable(String)) } - attr_reader :location_created_gps_latitude - - sig { params(location_created_gps_latitude: String).void } - attr_writer :location_created_gps_latitude - - sig { returns(T.nilable(String)) } - attr_reader :location_created_gps_longitude - - sig { params(location_created_gps_longitude: String).void } - attr_writer :location_created_gps_longitude - - sig { returns(T.nilable(String)) } - attr_reader :location_created_location_id - - sig { params(location_created_location_id: String).void } - attr_writer :location_created_location_id - - sig { returns(T.nilable(String)) } - attr_reader :location_created_location_name - - sig { params(location_created_location_name: String).void } - attr_writer :location_created_location_name - - sig { returns(T.nilable(String)) } - attr_reader :location_created_province_state - - sig { params(location_created_province_state: String).void } - attr_writer :location_created_province_state - - sig { returns(T.nilable(String)) } - attr_reader :location_created_sublocation - - sig { params(location_created_sublocation: String).void } - attr_writer :location_created_sublocation - - sig { returns(T.nilable(String)) } - attr_reader :location_created_world_region - - sig { params(location_created_world_region: String).void } - attr_writer :location_created_world_region - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_city - - sig { params(location_shown_city: T::Array[String]).void } - attr_writer :location_shown_city - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_country_code - - sig { params(location_shown_country_code: T::Array[String]).void } - attr_writer :location_shown_country_code - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_country_name - - sig { params(location_shown_country_name: T::Array[String]).void } - attr_writer :location_shown_country_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_gps_altitude - - sig { params(location_shown_gps_altitude: T::Array[String]).void } - attr_writer :location_shown_gps_altitude - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_gps_latitude - - sig { params(location_shown_gps_latitude: T::Array[String]).void } - attr_writer :location_shown_gps_latitude - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_gps_longitude - - sig { params(location_shown_gps_longitude: T::Array[String]).void } - attr_writer :location_shown_gps_longitude - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_location_id - - sig { params(location_shown_location_id: T::Array[String]).void } - attr_writer :location_shown_location_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_location_name - - sig { params(location_shown_location_name: T::Array[String]).void } - attr_writer :location_shown_location_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_province_state - - sig { params(location_shown_province_state: T::Array[String]).void } - attr_writer :location_shown_province_state - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_sublocation - - sig { params(location_shown_sublocation: T::Array[String]).void } - attr_writer :location_shown_sublocation - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_world_region - - sig { params(location_shown_world_region: T::Array[String]).void } - attr_writer :location_shown_world_region - - sig { returns(T.nilable(Float)) } - attr_reader :max_avail_height - - sig { params(max_avail_height: Float).void } - attr_writer :max_avail_height - - sig { returns(T.nilable(Float)) } - attr_reader :max_avail_width - - sig { params(max_avail_width: Float).void } - attr_writer :max_avail_width - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :model_age - - sig { params(model_age: T::Array[Float]).void } - attr_writer :model_age - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :model_release_id - - sig { params(model_release_id: T::Array[String]).void } - attr_writer :model_release_id - - sig { returns(T.nilable(String)) } - attr_reader :object_attribute_reference - - sig { params(object_attribute_reference: String).void } - attr_writer :object_attribute_reference - - sig { returns(T.nilable(String)) } - attr_reader :object_name - - sig { params(object_name: String).void } - attr_writer :object_name - - sig { returns(T.nilable(String)) } - attr_reader :offset_time_original - - sig { params(offset_time_original: String).void } - attr_writer :offset_time_original - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :organisation_in_image_code - - sig { params(organisation_in_image_code: T::Array[String]).void } - attr_writer :organisation_in_image_code - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :organisation_in_image_name - - sig { params(organisation_in_image_name: T::Array[String]).void } - attr_writer :organisation_in_image_name - - sig { returns(T.nilable(String)) } - attr_reader :orientation - - sig { params(orientation: String).void } - attr_writer :orientation - - sig { returns(T.nilable(String)) } - attr_reader :original_transmission_reference - - sig { params(original_transmission_reference: String).void } - attr_writer :original_transmission_reference - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image - - sig { params(person_in_image: T::Array[String]).void } - attr_writer :person_in_image - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_cv_term_cv_id - - sig { params(person_in_image_cv_term_cv_id: T::Array[String]).void } - attr_writer :person_in_image_cv_term_cv_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_cv_term_id - - sig { params(person_in_image_cv_term_id: T::Array[String]).void } - attr_writer :person_in_image_cv_term_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_cv_term_name - - sig { params(person_in_image_cv_term_name: T::Array[String]).void } - attr_writer :person_in_image_cv_term_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_cv_term_refined_about - - sig do - params(person_in_image_cv_term_refined_about: T::Array[String]).void - end - attr_writer :person_in_image_cv_term_refined_about - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_description - - sig { params(person_in_image_description: T::Array[String]).void } - attr_writer :person_in_image_description - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_id - - sig { params(person_in_image_id: T::Array[String]).void } - attr_writer :person_in_image_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_name - - sig { params(person_in_image_name: T::Array[String]).void } - attr_writer :person_in_image_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :product_in_image_description - - sig { params(product_in_image_description: T::Array[String]).void } - attr_writer :product_in_image_description - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :product_in_image_gtin - - sig { params(product_in_image_gtin: T::Array[Float]).void } - attr_writer :product_in_image_gtin - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :product_in_image_name - - sig { params(product_in_image_name: T::Array[String]).void } - attr_writer :product_in_image_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :property_release_id - - sig { params(property_release_id: T::Array[String]).void } - attr_writer :property_release_id - - sig { returns(T.nilable(String)) } - attr_reader :province_state - - sig { params(province_state: String).void } - attr_writer :province_state - - sig { returns(T.nilable(Integer)) } - attr_reader :rating - - sig { params(rating: Integer).void } - attr_writer :rating - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :registry_entry_role - - sig { params(registry_entry_role: T::Array[String]).void } - attr_writer :registry_entry_role - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :registry_item_id - - sig { params(registry_item_id: T::Array[String]).void } - attr_writer :registry_item_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :registry_organisation_id - - sig { params(registry_organisation_id: T::Array[String]).void } - attr_writer :registry_organisation_id - - sig { returns(T.nilable(String)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: String).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :rights - - sig { params(rights: String).void } - attr_writer :rights - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :scene - - sig { params(scene: T::Array[String]).void } - attr_writer :scene - - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig { returns(T.nilable(String)) } - attr_reader :special_instructions - - sig { params(special_instructions: String).void } - attr_writer :special_instructions - - sig { returns(T.nilable(String)) } - attr_reader :state - - sig { params(state: String).void } - attr_writer :state - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :subject - - sig { params(subject: T::Array[String]).void } - attr_writer :subject - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :subject_code - - sig { params(subject_code: T::Array[String]).void } - attr_writer :subject_code - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :subject_reference - - sig { params(subject_reference: T::Array[String]).void } - attr_writer :subject_reference - - sig { returns(T.nilable(String)) } - attr_reader :sublocation - - sig { params(sublocation: String).void } - attr_writer :sublocation - - sig { returns(T.nilable(String)) } - attr_reader :time_created - - sig { params(time_created: String).void } - attr_writer :time_created - - sig { returns(T.nilable(String)) } - attr_reader :title - - sig { params(title: String).void } - attr_writer :title - - sig { returns(T.nilable(String)) } - attr_reader :transmission_reference - - sig { params(transmission_reference: String).void } - attr_writer :transmission_reference - - sig { returns(T.nilable(String)) } - attr_reader :usage_terms - - sig { params(usage_terms: String).void } - attr_writer :usage_terms - - sig { returns(T.nilable(String)) } - attr_reader :web_statement - - sig { params(web_statement: String).void } - attr_writer :web_statement - - sig { returns(T.nilable(String)) } - attr_reader :writer - - sig { params(writer: String).void } - attr_writer :writer - - sig { returns(T.nilable(String)) } - attr_reader :writer_editor - - sig { params(writer_editor: String).void } - attr_writer :writer_editor - - sig { returns(T.nilable(Float)) } - attr_reader :x_resolution - - sig { params(x_resolution: Float).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :y_resolution - - sig { params(y_resolution: Float).void } - attr_writer :y_resolution - - # 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. - sig do - params( - about_cv_term_cv_id: String, - about_cv_term_id: String, - about_cv_term_name: String, - about_cv_term_refined_about: String, - additional_model_information: String, - application_record_version: Integer, - artist: String, - artwork_circa_date_created: String, - artwork_content_description: String, - artwork_contribution_description: String, - artwork_copyright_notice: String, - artwork_copyright_owner_id: String, - artwork_copyright_owner_name: String, - artwork_creator: T::Array[String], - artwork_creator_id: T::Array[String], - artwork_date_created: Time, - artwork_licensor_id: String, - artwork_licensor_name: String, - artwork_physical_description: String, - artwork_source: String, - artwork_source_inventory_no: String, - artwork_source_inv_url: String, - artwork_style_period: T::Array[String], - artwork_title: String, - authors_position: String, - byline: String, - byline_title: String, - caption: String, - caption_abstract: String, - caption_writer: String, - city: String, - color_space: String, - components_configuration: String, - copyright: String, - copyright_notice: String, - copyright_owner_id: T::Array[String], - copyright_owner_name: T::Array[String], - country: String, - country_code: String, - country_primary_location_code: String, - country_primary_location_name: String, - creator: String, - creator_address: String, - creator_city: String, - creator_country: String, - creator_postal_code: String, - creator_region: String, - creator_work_email: String, - creator_work_telephone: String, - creator_work_url: String, - credit: String, - date_created: Time, - date_time_created: Time, - date_time_original: Time, - description: String, - digital_image_guid: String, - digital_source_type: String, - embedded_encoded_rights_expr: String, - embedded_encoded_rights_expr_lang_id: String, - embedded_encoded_rights_expr_type: String, - event: String, - exif_version: String, - flashpix_version: String, - genre_cv_id: String, - genre_cv_term_id: String, - genre_cv_term_name: String, - genre_cv_term_refined_about: String, - headline: String, - image_creator_id: String, - image_creator_image_id: String, - image_creator_name: String, - image_description: String, - image_region_boundary_h: T::Array[Float], - image_region_boundary_rx: T::Array[Float], - image_region_boundary_shape: T::Array[String], - image_region_boundary_unit: T::Array[String], - image_region_boundary_vertices_x: T::Array[Float], - image_region_boundary_vertices_y: T::Array[Float], - image_region_boundary_w: T::Array[Float], - image_region_boundary_x: T::Array[Float], - image_region_boundary_y: T::Array[Float], - image_region_ctype_identifier: T::Array[String], - image_region_ctype_name: T::Array[String], - image_region_id: T::Array[String], - image_region_name: T::Array[String], - image_region_organisation_in_image_name: T::Array[String], - image_region_person_in_image: T::Array[String], - image_region_role_identifier: T::Array[String], - image_region_role_name: T::Array[String], - image_supplier_id: String, - image_supplier_image_id: String, - image_supplier_name: String, - instructions: String, - intellectual_genre: String, - keywords: T::Array[String], - licensor_city: T::Array[String], - licensor_country: T::Array[String], - licensor_email: T::Array[String], - licensor_extended_address: T::Array[String], - licensor_id: T::Array[String], - licensor_name: T::Array[String], - licensor_postal_code: T::Array[String], - licensor_region: T::Array[String], - licensor_street_address: T::Array[String], - licensor_telephone1: T::Array[String], - licensor_telephone2: T::Array[String], - licensor_url: T::Array[String], - linked_encoded_rights_expr: String, - linked_encoded_rights_expr_lang_id: String, - linked_encoded_rights_expr_type: String, - location: String, - location_created_city: String, - location_created_country_code: String, - location_created_country_name: String, - location_created_gps_altitude: String, - location_created_gps_latitude: String, - location_created_gps_longitude: String, - location_created_location_id: String, - location_created_location_name: String, - location_created_province_state: String, - location_created_sublocation: String, - location_created_world_region: String, - location_shown_city: T::Array[String], - location_shown_country_code: T::Array[String], - location_shown_country_name: T::Array[String], - location_shown_gps_altitude: T::Array[String], - location_shown_gps_latitude: T::Array[String], - location_shown_gps_longitude: T::Array[String], - location_shown_location_id: T::Array[String], - location_shown_location_name: T::Array[String], - location_shown_province_state: T::Array[String], - location_shown_sublocation: T::Array[String], - location_shown_world_region: T::Array[String], - max_avail_height: Float, - max_avail_width: Float, - model_age: T::Array[Float], - model_release_id: T::Array[String], - object_attribute_reference: String, - object_name: String, - offset_time_original: String, - organisation_in_image_code: T::Array[String], - organisation_in_image_name: T::Array[String], - orientation: String, - original_transmission_reference: String, - person_in_image: T::Array[String], - person_in_image_cv_term_cv_id: T::Array[String], - person_in_image_cv_term_id: T::Array[String], - person_in_image_cv_term_name: T::Array[String], - person_in_image_cv_term_refined_about: T::Array[String], - person_in_image_description: T::Array[String], - person_in_image_id: T::Array[String], - person_in_image_name: T::Array[String], - product_in_image_description: T::Array[String], - product_in_image_gtin: T::Array[Float], - product_in_image_name: T::Array[String], - property_release_id: T::Array[String], - province_state: String, - rating: Integer, - registry_entry_role: T::Array[String], - registry_item_id: T::Array[String], - registry_organisation_id: T::Array[String], - resolution_unit: String, - rights: String, - scene: T::Array[String], - source: String, - special_instructions: String, - state: String, - subject: T::Array[String], - subject_code: T::Array[String], - subject_reference: T::Array[String], - sublocation: String, - time_created: String, - title: String, - transmission_reference: String, - usage_terms: String, - web_statement: String, - writer: String, - writer_editor: String, - x_resolution: Float, - y_resolution: Float - ).returns(T.attached_class) - end - def self.new( - about_cv_term_cv_id: nil, - about_cv_term_id: nil, - about_cv_term_name: nil, - about_cv_term_refined_about: nil, - additional_model_information: nil, - application_record_version: nil, - artist: nil, - artwork_circa_date_created: nil, - artwork_content_description: nil, - artwork_contribution_description: nil, - artwork_copyright_notice: nil, - artwork_copyright_owner_id: nil, - artwork_copyright_owner_name: nil, - artwork_creator: nil, - artwork_creator_id: nil, - artwork_date_created: nil, - artwork_licensor_id: nil, - artwork_licensor_name: nil, - artwork_physical_description: nil, - artwork_source: nil, - artwork_source_inventory_no: nil, - artwork_source_inv_url: nil, - artwork_style_period: nil, - artwork_title: nil, - authors_position: nil, - byline: nil, - byline_title: nil, - caption: nil, - caption_abstract: nil, - caption_writer: nil, - city: nil, - color_space: nil, - components_configuration: nil, - copyright: nil, - copyright_notice: nil, - copyright_owner_id: nil, - copyright_owner_name: nil, - country: nil, - country_code: nil, - country_primary_location_code: nil, - country_primary_location_name: nil, - creator: nil, - creator_address: nil, - creator_city: nil, - creator_country: nil, - creator_postal_code: nil, - creator_region: nil, - creator_work_email: nil, - creator_work_telephone: nil, - creator_work_url: nil, - credit: nil, - date_created: nil, - date_time_created: nil, - date_time_original: nil, - description: nil, - digital_image_guid: nil, - digital_source_type: nil, - embedded_encoded_rights_expr: nil, - embedded_encoded_rights_expr_lang_id: nil, - embedded_encoded_rights_expr_type: nil, - event: nil, - exif_version: nil, - flashpix_version: nil, - genre_cv_id: nil, - genre_cv_term_id: nil, - genre_cv_term_name: nil, - genre_cv_term_refined_about: nil, - headline: nil, - image_creator_id: nil, - image_creator_image_id: nil, - image_creator_name: nil, - image_description: nil, - image_region_boundary_h: nil, - image_region_boundary_rx: nil, - image_region_boundary_shape: nil, - image_region_boundary_unit: nil, - image_region_boundary_vertices_x: nil, - image_region_boundary_vertices_y: nil, - image_region_boundary_w: nil, - image_region_boundary_x: nil, - image_region_boundary_y: nil, - image_region_ctype_identifier: nil, - image_region_ctype_name: nil, - image_region_id: nil, - image_region_name: nil, - image_region_organisation_in_image_name: nil, - image_region_person_in_image: nil, - image_region_role_identifier: nil, - image_region_role_name: nil, - image_supplier_id: nil, - image_supplier_image_id: nil, - image_supplier_name: nil, - instructions: nil, - intellectual_genre: nil, - keywords: nil, - licensor_city: nil, - licensor_country: nil, - licensor_email: nil, - licensor_extended_address: nil, - licensor_id: nil, - licensor_name: nil, - licensor_postal_code: nil, - licensor_region: nil, - licensor_street_address: nil, - licensor_telephone1: nil, - licensor_telephone2: nil, - licensor_url: nil, - linked_encoded_rights_expr: nil, - linked_encoded_rights_expr_lang_id: nil, - linked_encoded_rights_expr_type: nil, - location: nil, - location_created_city: nil, - location_created_country_code: nil, - location_created_country_name: nil, - location_created_gps_altitude: nil, - location_created_gps_latitude: nil, - location_created_gps_longitude: nil, - location_created_location_id: nil, - location_created_location_name: nil, - location_created_province_state: nil, - location_created_sublocation: nil, - location_created_world_region: nil, - location_shown_city: nil, - location_shown_country_code: nil, - location_shown_country_name: nil, - location_shown_gps_altitude: nil, - location_shown_gps_latitude: nil, - location_shown_gps_longitude: nil, - location_shown_location_id: nil, - location_shown_location_name: nil, - location_shown_province_state: nil, - location_shown_sublocation: nil, - location_shown_world_region: nil, - max_avail_height: nil, - max_avail_width: nil, - model_age: nil, - model_release_id: nil, - object_attribute_reference: nil, - object_name: nil, - offset_time_original: nil, - organisation_in_image_code: nil, - organisation_in_image_name: nil, - orientation: nil, - original_transmission_reference: nil, - person_in_image: nil, - person_in_image_cv_term_cv_id: nil, - person_in_image_cv_term_id: nil, - person_in_image_cv_term_name: nil, - person_in_image_cv_term_refined_about: nil, - person_in_image_description: nil, - person_in_image_id: nil, - person_in_image_name: nil, - product_in_image_description: nil, - product_in_image_gtin: nil, - product_in_image_name: nil, - property_release_id: nil, - province_state: nil, - rating: nil, - registry_entry_role: nil, - registry_item_id: nil, - registry_organisation_id: nil, - resolution_unit: nil, - rights: nil, - scene: nil, - source: nil, - special_instructions: nil, - state: nil, - subject: nil, - subject_code: nil, - subject_reference: nil, - sublocation: nil, - time_created: nil, - title: nil, - transmission_reference: nil, - usage_terms: nil, - web_statement: nil, - writer: nil, - writer_editor: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - about_cv_term_cv_id: String, - about_cv_term_id: String, - about_cv_term_name: String, - about_cv_term_refined_about: String, - additional_model_information: String, - application_record_version: Integer, - artist: String, - artwork_circa_date_created: String, - artwork_content_description: String, - artwork_contribution_description: String, - artwork_copyright_notice: String, - artwork_copyright_owner_id: String, - artwork_copyright_owner_name: String, - artwork_creator: T::Array[String], - artwork_creator_id: T::Array[String], - artwork_date_created: Time, - artwork_licensor_id: String, - artwork_licensor_name: String, - artwork_physical_description: String, - artwork_source: String, - artwork_source_inventory_no: String, - artwork_source_inv_url: String, - artwork_style_period: T::Array[String], - artwork_title: String, - authors_position: String, - byline: String, - byline_title: String, - caption: String, - caption_abstract: String, - caption_writer: String, - city: String, - color_space: String, - components_configuration: String, - copyright: String, - copyright_notice: String, - copyright_owner_id: T::Array[String], - copyright_owner_name: T::Array[String], - country: String, - country_code: String, - country_primary_location_code: String, - country_primary_location_name: String, - creator: String, - creator_address: String, - creator_city: String, - creator_country: String, - creator_postal_code: String, - creator_region: String, - creator_work_email: String, - creator_work_telephone: String, - creator_work_url: String, - credit: String, - date_created: Time, - date_time_created: Time, - date_time_original: Time, - description: String, - digital_image_guid: String, - digital_source_type: String, - embedded_encoded_rights_expr: String, - embedded_encoded_rights_expr_lang_id: String, - embedded_encoded_rights_expr_type: String, - event: String, - exif_version: String, - flashpix_version: String, - genre_cv_id: String, - genre_cv_term_id: String, - genre_cv_term_name: String, - genre_cv_term_refined_about: String, - headline: String, - image_creator_id: String, - image_creator_image_id: String, - image_creator_name: String, - image_description: String, - image_region_boundary_h: T::Array[Float], - image_region_boundary_rx: T::Array[Float], - image_region_boundary_shape: T::Array[String], - image_region_boundary_unit: T::Array[String], - image_region_boundary_vertices_x: T::Array[Float], - image_region_boundary_vertices_y: T::Array[Float], - image_region_boundary_w: T::Array[Float], - image_region_boundary_x: T::Array[Float], - image_region_boundary_y: T::Array[Float], - image_region_ctype_identifier: T::Array[String], - image_region_ctype_name: T::Array[String], - image_region_id: T::Array[String], - image_region_name: T::Array[String], - image_region_organisation_in_image_name: T::Array[String], - image_region_person_in_image: T::Array[String], - image_region_role_identifier: T::Array[String], - image_region_role_name: T::Array[String], - image_supplier_id: String, - image_supplier_image_id: String, - image_supplier_name: String, - instructions: String, - intellectual_genre: String, - keywords: T::Array[String], - licensor_city: T::Array[String], - licensor_country: T::Array[String], - licensor_email: T::Array[String], - licensor_extended_address: T::Array[String], - licensor_id: T::Array[String], - licensor_name: T::Array[String], - licensor_postal_code: T::Array[String], - licensor_region: T::Array[String], - licensor_street_address: T::Array[String], - licensor_telephone1: T::Array[String], - licensor_telephone2: T::Array[String], - licensor_url: T::Array[String], - linked_encoded_rights_expr: String, - linked_encoded_rights_expr_lang_id: String, - linked_encoded_rights_expr_type: String, - location: String, - location_created_city: String, - location_created_country_code: String, - location_created_country_name: String, - location_created_gps_altitude: String, - location_created_gps_latitude: String, - location_created_gps_longitude: String, - location_created_location_id: String, - location_created_location_name: String, - location_created_province_state: String, - location_created_sublocation: String, - location_created_world_region: String, - location_shown_city: T::Array[String], - location_shown_country_code: T::Array[String], - location_shown_country_name: T::Array[String], - location_shown_gps_altitude: T::Array[String], - location_shown_gps_latitude: T::Array[String], - location_shown_gps_longitude: T::Array[String], - location_shown_location_id: T::Array[String], - location_shown_location_name: T::Array[String], - location_shown_province_state: T::Array[String], - location_shown_sublocation: T::Array[String], - location_shown_world_region: T::Array[String], - max_avail_height: Float, - max_avail_width: Float, - model_age: T::Array[Float], - model_release_id: T::Array[String], - object_attribute_reference: String, - object_name: String, - offset_time_original: String, - organisation_in_image_code: T::Array[String], - organisation_in_image_name: T::Array[String], - orientation: String, - original_transmission_reference: String, - person_in_image: T::Array[String], - person_in_image_cv_term_cv_id: T::Array[String], - person_in_image_cv_term_id: T::Array[String], - person_in_image_cv_term_name: T::Array[String], - person_in_image_cv_term_refined_about: T::Array[String], - person_in_image_description: T::Array[String], - person_in_image_id: T::Array[String], - person_in_image_name: T::Array[String], - product_in_image_description: T::Array[String], - product_in_image_gtin: T::Array[Float], - product_in_image_name: T::Array[String], - property_release_id: T::Array[String], - province_state: String, - rating: Integer, - registry_entry_role: T::Array[String], - registry_item_id: T::Array[String], - registry_organisation_id: T::Array[String], - resolution_unit: String, - rights: String, - scene: T::Array[String], - source: String, - special_instructions: String, - state: String, - subject: T::Array[String], - subject_code: T::Array[String], - subject_reference: T::Array[String], - sublocation: String, - time_created: String, - title: String, - transmission_reference: String, - usage_terms: String, - web_statement: String, - writer: String, - writer_editor: String, - x_resolution: Float, - y_resolution: Float - } - ) - end - def to_hash - end - end - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV1Response::ExtensionStatus, - Imagekit::Internal::AnyHash - ) - end - - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - ) - end - attr_reader :aws_auto_tagging - - sig do - params( - aws_auto_tagging: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::OrSymbol - ).void - end - attr_writer :aws_auto_tagging - - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - ) - end - attr_reader :google_auto_tagging - - sig do - params( - google_auto_tagging: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::OrSymbol - ).void - end - attr_writer :google_auto_tagging - - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol - ) - ) - end - attr_reader :remove_bg - - sig do - params( - remove_bg: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::OrSymbol - ).void - end - attr_writer :remove_bg - - # 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. - sig do - params( - aws_auto_tagging: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::OrSymbol, - google_auto_tagging: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::OrSymbol, - remove_bg: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::OrSymbol - ).returns(T.attached_class) - end - def self.new( - aws_auto_tagging: nil, - google_auto_tagging: nil, - remove_bg: nil - ) - end - - sig do - override.returns( - { - aws_auto_tagging: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol, - google_auto_tagging: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, - remove_bg: - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol - } - ) - end - def to_hash - end - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::FileUploadV1Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ] - ) - end - def self.values - end - end - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::FileUploadV1Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ] - ) - end - def self.values - end - end - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::FileUploadV1Response::ExtensionStatus::RemoveBg::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class Metadata < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV1Response::Metadata, - Imagekit::Internal::AnyHash - ) - end - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # The density of the image in DPI. - sig { returns(T.nilable(Integer)) } - attr_reader :density - - sig { params(density: Integer).void } - attr_writer :density - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :duration - - sig do - returns( - T.nilable(Imagekit::Models::FileUploadV1Response::Metadata::Exif) - ) - end - attr_reader :exif - - sig do - params( - exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif::OrHash - ).void - end - attr_writer :exif - - # The format of the file (e.g., 'jpg', 'mp4'). - sig { returns(T.nilable(String)) } - attr_reader :format_ - - sig { params(format_: String).void } - attr_writer :format_ - - # Indicates if the image has a color profile. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_color_profile - - sig { params(has_color_profile: T::Boolean).void } - attr_writer :has_color_profile - - # Indicates if the image contains transparent areas. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_transparency - - sig { params(has_transparency: T::Boolean).void } - attr_writer :has_transparency - - # The height of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :height - - sig { params(height: Integer).void } - attr_writer :height - - # Perceptual hash of the image. - sig { returns(T.nilable(String)) } - attr_reader :p_hash - - sig { params(p_hash: String).void } - attr_writer :p_hash - - # The quality indicator of the image. - sig { returns(T.nilable(Integer)) } - attr_reader :quality - - sig { params(quality: Integer).void } - attr_writer :quality - - # The file size in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :size - - sig { params(size: Integer).void } - attr_writer :size - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # The width of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :width - - sig { params(width: Integer).void } - attr_writer :width - - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - sig do - params( - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: - Imagekit::Models::FileUploadV1Response::Metadata::Exif::OrHash, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - ).returns(T.attached_class) - end - def self.new( - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # The density of the image in DPI. - density: nil, - # The duration of the video in seconds (only for video). - duration: nil, - exif: nil, - # The format of the file (e.g., 'jpg', 'mp4'). - format_: nil, - # Indicates if the image has a color profile. - has_color_profile: nil, - # Indicates if the image contains transparent areas. - has_transparency: nil, - # The height of the image or video in pixels. - height: nil, - # Perceptual hash of the image. - p_hash: nil, - # The quality indicator of the image. - quality: nil, - # The file size in bytes. - size: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # The width of the image or video in pixels. - width: nil - ) - end - - sig do - override.returns( - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV1Response::Metadata::Exif, - Imagekit::Internal::AnyHash - ) - end - - # Object containing Exif details. - sig { returns(T.nilable(Imagekit::ExifDetails)) } - attr_reader :exif - - sig { params(exif: Imagekit::ExifDetails::OrHash).void } - attr_writer :exif - - # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Gps)) } - attr_reader :gps - - sig { params(gps: Imagekit::Gps::OrHash).void } - attr_writer :gps - - # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::ExifImage)) } - attr_reader :image - - sig { params(image: Imagekit::ExifImage::OrHash).void } - attr_writer :image - - # JSON object. - sig { returns(T.nilable(Imagekit::Interoperability)) } - attr_reader :interoperability - - sig do - params(interoperability: Imagekit::Interoperability::OrHash).void - end - attr_writer :interoperability - - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :makernote - - sig { params(makernote: T::Hash[Symbol, T.anything]).void } - attr_writer :makernote - - # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Thumbnail)) } - attr_reader :thumbnail - - sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } - attr_writer :thumbnail - - sig do - params( - exif: Imagekit::ExifDetails::OrHash, - gps: Imagekit::Gps::OrHash, - image: Imagekit::ExifImage::OrHash, - interoperability: Imagekit::Interoperability::OrHash, - makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail::OrHash - ).returns(T.attached_class) - end - def self.new( - # Object containing Exif details. - exif: nil, - # Object containing GPS information. - gps: nil, - # Object containing EXIF image information. - image: nil, - # JSON object. - interoperability: nil, - makernote: nil, - # Object containing Thumbnail information. - thumbnail: nil - ) - end - - sig do - override.returns( - { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail - } - ) - end - def to_hash - end - end - end - - class VersionInfo < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV1Response::VersionInfo, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the file version. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Name of the file version. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # An object containing the file or file version's `id` (versionId) and `name`. - sig { params(id: String, name: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the file version. - id: nil, - # Name of the file version. - name: nil - ) - end - - sig { override.returns({ id: String, name: String }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/file_upload_v2_params.rbi b/rbi/imagekit/models/file_upload_v2_params.rbi deleted file mode 100644 index 06434232..00000000 --- a/rbi/imagekit/models/file_upload_v2_params.rbi +++ /dev/null @@ -1,659 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileUploadV2Params < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileUploadV2Params, Imagekit::Internal::AnyHash) - end - - # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, - # please ensure that our servers can access the URL. In case ImageKit is unable to - # download the file from the specified URL, a `400` error response is returned. - # This will also result in a `400` error if the file download request is aborted - # if response headers are not received in 8 seconds. - sig { returns(String) } - attr_accessor :file - - # The name with which the file has to be uploaded. - sig { returns(String) } - attr_accessor :file_name - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :token - - sig { params(token: String).void } - attr_writer :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). - sig { returns(T.nilable(String)) } - attr_reader :checks - - sig { params(checks: String).void } - attr_writer :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. - sig { returns(T.nilable(String)) } - attr_reader :custom_coordinates - - sig { params(custom_coordinates: String).void } - attr_writer :custom_coordinates - - # Stringified JSON key-value data to be associated with the asset. - sig { returns(T.nilable(String)) } - attr_reader :custom_metadata - - sig { params(custom_metadata: String).void } - attr_writer :custom_metadata - - # Stringified JSON object with an array of extensions to be applied to the image. - # Refer to extensions schema in - # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). - sig { returns(T.nilable(String)) } - attr_reader :extensions - - sig { params(extensions: String).void } - attr_writer :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. - sig { returns(T.nilable(String)) } - attr_reader :folder - - sig { params(folder: String).void } - attr_writer :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. - sig do - returns( - T.nilable(Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol) - ) - end - attr_reader :is_private_file - - sig do - params( - is_private_file: Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol - ).void - end - attr_writer :is_private_file - - # 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. - sig do - returns(T.nilable(Imagekit::FileUploadV2Params::IsPublished::OrSymbol)) - end - attr_reader :is_published - - sig do - params( - is_published: Imagekit::FileUploadV2Params::IsPublished::OrSymbol - ).void - end - attr_writer :is_published - - # 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. - sig do - returns( - T.nilable(Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol) - ) - end - attr_reader :overwrite_ai_tags - - sig do - params( - overwrite_ai_tags: - Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol - ).void - end - attr_writer :overwrite_ai_tags - - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - sig do - returns( - T.nilable( - Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol - ) - ) - end - attr_reader :overwrite_custom_metadata - - sig do - params( - overwrite_custom_metadata: - Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol - ).void - end - attr_writer :overwrite_custom_metadata - - # If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # the exact location, upload API will return an error immediately. - sig { returns(T.nilable(String)) } - attr_reader :overwrite_file - - sig { params(overwrite_file: String).void } - attr_writer :overwrite_file - - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - sig do - returns( - T.nilable(Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol) - ) - end - attr_reader :overwrite_tags - - sig do - params( - overwrite_tags: Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol - ).void - end - attr_writer :overwrite_tags - - # Comma-separated values of the fields that you want the API to return in the - # response. - # - # For example, set the value of this field to - # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, - # `customCoordinates`, and `isPrivateFile` in the response. - # - # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, - # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. - sig { returns(T.nilable(String)) } - attr_reader :response_fields - - sig { params(response_fields: String).void } - attr_writer :response_fields - - # Set the tags while uploading the file. - # - # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length - # of all characters should not exceed 500. `%` is not allowed. - # - # If this field is not specified and the file is overwritten then the tags will be - # removed. - sig { returns(T.nilable(String)) } - attr_reader :tags - - sig { params(tags: String).void } - attr_writer :tags - - # Stringified JSON object with properties for pre and post transformations: - # - # `pre` - Accepts a "string" containing a valid transformation used for requesting - # a pre-transformation for an image or a video file. - # - # `post` - Accepts an array of objects with properties: - # - # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` - # (Adaptive bitrate streaming). - # - `value`: A "string" corresponding to the required transformation. Required if - # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or - # `thumbnail`. - # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. - # - # Read more about - # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). - sig { returns(T.nilable(String)) } - attr_reader :transformation - - sig { params(transformation: String).void } - attr_writer :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. - sig do - returns( - T.nilable(Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol) - ) - end - attr_reader :use_unique_file_name - - sig do - params( - use_unique_file_name: - Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol - ).void - end - attr_writer :use_unique_file_name - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :webhook_url - - sig { params(webhook_url: String).void } - attr_writer :webhook_url - - sig do - params( - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - extensions: String, - folder: String, - is_private_file: - Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol, - is_published: Imagekit::FileUploadV2Params::IsPublished::OrSymbol, - overwrite_ai_tags: - Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol, - overwrite_custom_metadata: - Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol, - overwrite_file: String, - overwrite_tags: Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol, - response_fields: String, - tags: String, - transformation: String, - use_unique_file_name: - Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol, - webhook_url: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, - # please ensure that our servers can access the URL. In case ImageKit is unable to - # download the file from the specified URL, a `400` error response is returned. - # This will also result in a `400` error if the file download request is aborted - # if response headers are not received in 8 seconds. - file:, - # The name with which the file has to be uploaded. - file_name:, - # 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. - token: nil, - # 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). - checks: nil, - # 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. - custom_coordinates: nil, - # Stringified JSON key-value data to be associated with the asset. - custom_metadata: nil, - # Stringified JSON object with an array of extensions to be applied to the image. - # Refer to extensions schema in - # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). - extensions: nil, - # 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. - folder: nil, - # 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. - is_private_file: nil, - # 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. - is_published: nil, - # 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. - overwrite_ai_tags: nil, - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - overwrite_custom_metadata: nil, - # If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # the exact location, upload API will return an error immediately. - overwrite_file: nil, - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - overwrite_tags: nil, - # Comma-separated values of the fields that you want the API to return in the - # response. - # - # For example, set the value of this field to - # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, - # `customCoordinates`, and `isPrivateFile` in the response. - # - # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, - # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. - response_fields: nil, - # Set the tags while uploading the file. - # - # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length - # of all characters should not exceed 500. `%` is not allowed. - # - # If this field is not specified and the file is overwritten then the tags will be - # removed. - tags: nil, - # Stringified JSON object with properties for pre and post transformations: - # - # `pre` - Accepts a "string" containing a valid transformation used for requesting - # a pre-transformation for an image or a video file. - # - # `post` - Accepts an array of objects with properties: - # - # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` - # (Adaptive bitrate streaming). - # - `value`: A "string" corresponding to the required transformation. Required if - # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or - # `thumbnail`. - # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. - # - # Read more about - # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). - transformation: nil, - # 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. - use_unique_file_name: nil, - # 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. - webhook_url: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - extensions: String, - folder: String, - is_private_file: - Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol, - is_published: Imagekit::FileUploadV2Params::IsPublished::OrSymbol, - overwrite_ai_tags: - Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol, - overwrite_custom_metadata: - Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol, - overwrite_file: String, - overwrite_tags: - Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol, - response_fields: String, - tags: String, - transformation: String, - use_unique_file_name: - Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol, - webhook_url: String, - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - - # 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. - module IsPrivateFile - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV2Params::IsPrivateFile) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV2Params::IsPrivateFile::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV2Params::IsPrivateFile::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Imagekit::FileUploadV2Params::IsPrivateFile::TaggedSymbol] - ) - end - def self.values - end - end - - # 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. - module IsPublished - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV2Params::IsPublished) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let(:true, Imagekit::FileUploadV2Params::IsPublished::TaggedSymbol) - FALSE = - T.let(:false, Imagekit::FileUploadV2Params::IsPublished::TaggedSymbol) - - sig do - override.returns( - T::Array[Imagekit::FileUploadV2Params::IsPublished::TaggedSymbol] - ) - end - def self.values - end - end - - # 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. - module OverwriteAITags - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV2Params::OverwriteAITags) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV2Params::OverwriteAITags::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV2Params::OverwriteAITags::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadV2Params::OverwriteAITags::TaggedSymbol - ] - ) - end - def self.values - end - end - - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - module OverwriteCustomMetadata - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV2Params::OverwriteCustomMetadata) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV2Params::OverwriteCustomMetadata::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV2Params::OverwriteCustomMetadata::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadV2Params::OverwriteCustomMetadata::TaggedSymbol - ] - ) - end - def self.values - end - end - - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - module OverwriteTags - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV2Params::OverwriteTags) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV2Params::OverwriteTags::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV2Params::OverwriteTags::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Imagekit::FileUploadV2Params::OverwriteTags::TaggedSymbol] - ) - end - def self.values - end - end - - # 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. - module UseUniqueFileName - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUploadV2Params::UseUniqueFileName) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - Imagekit::FileUploadV2Params::UseUniqueFileName::TaggedSymbol - ) - FALSE = - T.let( - :false, - Imagekit::FileUploadV2Params::UseUniqueFileName::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadV2Params::UseUniqueFileName::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/imagekit/models/file_upload_v2_response.rbi b/rbi/imagekit/models/file_upload_v2_response.rbi deleted file mode 100644 index 8611f584..00000000 --- a/rbi/imagekit/models/file_upload_v2_response.rbi +++ /dev/null @@ -1,2625 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileUploadV2Response < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV2Response, - Imagekit::Internal::AnyHash - ) - end - - # An array of tags assigned to the uploaded file by auto tagging. - sig do - returns( - T.nilable(T::Array[Imagekit::Models::FileUploadV2Response::AITag]) - ) - end - attr_accessor :ai_tags - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # 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. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # 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. - sig { returns(T.nilable(T.anything)) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T.anything).void } - attr_writer :custom_metadata - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :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. - sig do - returns( - T.nilable(Imagekit::Models::FileUploadV2Response::EmbeddedMetadata) - ) - end - attr_reader :embedded_metadata - - sig do - params( - embedded_metadata: - Imagekit::Models::FileUploadV2Response::EmbeddedMetadata::OrHash - ).void - end - attr_writer :embedded_metadata - - # 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. - sig do - returns( - T.nilable(Imagekit::Models::FileUploadV2Response::ExtensionStatus) - ) - end - attr_reader :extension_status - - sig do - params( - extension_status: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::OrHash - ).void - end - attr_writer :extension_status - - # Unique fileId. Store this fileld in your database, as this will be used to - # perform update action on this file. - sig { returns(T.nilable(String)) } - attr_reader :file_id - - sig { params(file_id: String).void } - attr_writer :file_id - - # The relative path of the file in the media library e.g. - # `/marketing-assets/new-banner.jpg`. - sig { returns(T.nilable(String)) } - attr_reader :file_path - - sig { params(file_path: String).void } - attr_writer :file_path - - # Type of the uploaded file. Possible values are `image`, `non-image`. - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # Height of the image in pixels (Only for images) - sig { returns(T.nilable(Float)) } - attr_reader :height - - sig { params(height: Float).void } - attr_writer :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. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_private_file - - sig { params(is_private_file: T::Boolean).void } - attr_writer :is_private_file - - # 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. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_published - - sig { params(is_published: T::Boolean).void } - attr_writer :is_published - - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - sig do - returns(T.nilable(Imagekit::Models::FileUploadV2Response::Metadata)) - end - attr_reader :metadata - - sig do - params( - metadata: Imagekit::Models::FileUploadV2Response::Metadata::OrHash - ).void - end - attr_writer :metadata - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Size of the image file in Bytes. - sig { returns(T.nilable(Float)) } - attr_reader :size - - sig { params(size: Float).void } - attr_writer :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. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :tags - - # In the case of an image, a small thumbnail URL. - sig { returns(T.nilable(String)) } - attr_reader :thumbnail_url - - sig { params(thumbnail_url: String).void } - attr_writer :thumbnail_url - - # A publicly accessible URL of the file. - sig { returns(T.nilable(String)) } - attr_reader :url - - sig { params(url: String).void } - attr_writer :url - - # An object containing the file or file version's `id` (versionId) and `name`. - sig do - returns(T.nilable(Imagekit::Models::FileUploadV2Response::VersionInfo)) - end - attr_reader :version_info - - sig do - params( - version_info: - Imagekit::Models::FileUploadV2Response::VersionInfo::OrHash - ).void - end - attr_writer :version_info - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # Width of the image in pixels (Only for Images) - sig { returns(T.nilable(Float)) } - attr_reader :width - - sig { params(width: Float).void } - attr_writer :width - - # Object containing details of a successful upload. - sig do - params( - ai_tags: - T.nilable( - T::Array[Imagekit::Models::FileUploadV2Response::AITag::OrHash] - ), - audio_codec: String, - bit_rate: Integer, - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - duration: Integer, - embedded_metadata: - Imagekit::Models::FileUploadV2Response::EmbeddedMetadata::OrHash, - extension_status: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::OrHash, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - metadata: Imagekit::Models::FileUploadV2Response::Metadata::OrHash, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail_url: String, - url: String, - version_info: - Imagekit::Models::FileUploadV2Response::VersionInfo::OrHash, - video_codec: String, - width: Float - ).returns(T.attached_class) - end - def self.new( - # An array of tags assigned to the uploaded file by auto tagging. - ai_tags: nil, - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # The duration of the video in seconds (only for video). - duration: nil, - # 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. - embedded_metadata: nil, - # 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. - extension_status: nil, - # Unique fileId. Store this fileld in your database, as this will be used to - # perform update action on this file. - file_id: nil, - # The relative path of the file in the media library e.g. - # `/marketing-assets/new-banner.jpg`. - file_path: nil, - # Type of the uploaded file. Possible values are `image`, `non-image`. - file_type: nil, - # Height of the image in pixels (Only for images) - height: nil, - # 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. - is_private_file: nil, - # 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. - is_published: nil, - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - metadata: nil, - # Name of the asset. - name: nil, - # Size of the image file in Bytes. - size: nil, - # 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. - tags: nil, - # In the case of an image, a small thumbnail URL. - thumbnail_url: nil, - # A publicly accessible URL of the file. - url: nil, - # An object containing the file or file version's `id` (versionId) and `name`. - version_info: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # Width of the image in pixels (Only for Images) - width: nil - ) - end - - sig do - override.returns( - { - ai_tags: - T.nilable( - T::Array[Imagekit::Models::FileUploadV2Response::AITag] - ), - audio_codec: String, - bit_rate: Integer, - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - duration: Integer, - embedded_metadata: - Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, - extension_status: - Imagekit::Models::FileUploadV2Response::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - metadata: Imagekit::Models::FileUploadV2Response::Metadata, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::FileUploadV2Response::VersionInfo, - video_codec: String, - width: Float - } - ) - end - def to_hash - end - - class AITag < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV2Response::AITag, - Imagekit::Internal::AnyHash - ) - end - - # Confidence score of the tag. - sig { returns(T.nilable(Float)) } - attr_reader :confidence - - sig { params(confidence: Float).void } - attr_writer :confidence - - # Name of the tag. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :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. - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig do - params(confidence: Float, name: String, source: String).returns( - T.attached_class - ) - end - def self.new( - # Confidence score of the tag. - confidence: nil, - # Name of the tag. - name: nil, - # 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. - source: nil - ) - end - - sig do - override.returns({ confidence: Float, name: String, source: String }) - end - def to_hash - end - end - - class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :about_cv_term_cv_id - - sig { params(about_cv_term_cv_id: String).void } - attr_writer :about_cv_term_cv_id - - sig { returns(T.nilable(String)) } - attr_reader :about_cv_term_id - - sig { params(about_cv_term_id: String).void } - attr_writer :about_cv_term_id - - sig { returns(T.nilable(String)) } - attr_reader :about_cv_term_name - - sig { params(about_cv_term_name: String).void } - attr_writer :about_cv_term_name - - sig { returns(T.nilable(String)) } - attr_reader :about_cv_term_refined_about - - sig { params(about_cv_term_refined_about: String).void } - attr_writer :about_cv_term_refined_about - - sig { returns(T.nilable(String)) } - attr_reader :additional_model_information - - sig { params(additional_model_information: String).void } - attr_writer :additional_model_information - - sig { returns(T.nilable(Integer)) } - attr_reader :application_record_version - - sig { params(application_record_version: Integer).void } - attr_writer :application_record_version - - sig { returns(T.nilable(String)) } - attr_reader :artist - - sig { params(artist: String).void } - attr_writer :artist - - sig { returns(T.nilable(String)) } - attr_reader :artwork_circa_date_created - - sig { params(artwork_circa_date_created: String).void } - attr_writer :artwork_circa_date_created - - sig { returns(T.nilable(String)) } - attr_reader :artwork_content_description - - sig { params(artwork_content_description: String).void } - attr_writer :artwork_content_description - - sig { returns(T.nilable(String)) } - attr_reader :artwork_contribution_description - - sig { params(artwork_contribution_description: String).void } - attr_writer :artwork_contribution_description - - sig { returns(T.nilable(String)) } - attr_reader :artwork_copyright_notice - - sig { params(artwork_copyright_notice: String).void } - attr_writer :artwork_copyright_notice - - sig { returns(T.nilable(String)) } - attr_reader :artwork_copyright_owner_id - - sig { params(artwork_copyright_owner_id: String).void } - attr_writer :artwork_copyright_owner_id - - sig { returns(T.nilable(String)) } - attr_reader :artwork_copyright_owner_name - - sig { params(artwork_copyright_owner_name: String).void } - attr_writer :artwork_copyright_owner_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :artwork_creator - - sig { params(artwork_creator: T::Array[String]).void } - attr_writer :artwork_creator - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :artwork_creator_id - - sig { params(artwork_creator_id: T::Array[String]).void } - attr_writer :artwork_creator_id - - sig { returns(T.nilable(Time)) } - attr_reader :artwork_date_created - - sig { params(artwork_date_created: Time).void } - attr_writer :artwork_date_created - - sig { returns(T.nilable(String)) } - attr_reader :artwork_licensor_id - - sig { params(artwork_licensor_id: String).void } - attr_writer :artwork_licensor_id - - sig { returns(T.nilable(String)) } - attr_reader :artwork_licensor_name - - sig { params(artwork_licensor_name: String).void } - attr_writer :artwork_licensor_name - - sig { returns(T.nilable(String)) } - attr_reader :artwork_physical_description - - sig { params(artwork_physical_description: String).void } - attr_writer :artwork_physical_description - - sig { returns(T.nilable(String)) } - attr_reader :artwork_source - - sig { params(artwork_source: String).void } - attr_writer :artwork_source - - sig { returns(T.nilable(String)) } - attr_reader :artwork_source_inventory_no - - sig { params(artwork_source_inventory_no: String).void } - attr_writer :artwork_source_inventory_no - - sig { returns(T.nilable(String)) } - attr_reader :artwork_source_inv_url - - sig { params(artwork_source_inv_url: String).void } - attr_writer :artwork_source_inv_url - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :artwork_style_period - - sig { params(artwork_style_period: T::Array[String]).void } - attr_writer :artwork_style_period - - sig { returns(T.nilable(String)) } - attr_reader :artwork_title - - sig { params(artwork_title: String).void } - attr_writer :artwork_title - - sig { returns(T.nilable(String)) } - attr_reader :authors_position - - sig { params(authors_position: String).void } - attr_writer :authors_position - - sig { returns(T.nilable(String)) } - attr_reader :byline - - sig { params(byline: String).void } - attr_writer :byline - - sig { returns(T.nilable(String)) } - attr_reader :byline_title - - sig { params(byline_title: String).void } - attr_writer :byline_title - - sig { returns(T.nilable(String)) } - attr_reader :caption - - sig { params(caption: String).void } - attr_writer :caption - - sig { returns(T.nilable(String)) } - attr_reader :caption_abstract - - sig { params(caption_abstract: String).void } - attr_writer :caption_abstract - - sig { returns(T.nilable(String)) } - attr_reader :caption_writer - - sig { params(caption_writer: String).void } - attr_writer :caption_writer - - sig { returns(T.nilable(String)) } - attr_reader :city - - sig { params(city: String).void } - attr_writer :city - - sig { returns(T.nilable(String)) } - attr_reader :color_space - - sig { params(color_space: String).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :components_configuration - - sig { params(components_configuration: String).void } - attr_writer :components_configuration - - sig { returns(T.nilable(String)) } - attr_reader :copyright - - sig { params(copyright: String).void } - attr_writer :copyright - - sig { returns(T.nilable(String)) } - attr_reader :copyright_notice - - sig { params(copyright_notice: String).void } - attr_writer :copyright_notice - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :copyright_owner_id - - sig { params(copyright_owner_id: T::Array[String]).void } - attr_writer :copyright_owner_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :copyright_owner_name - - sig { params(copyright_owner_name: T::Array[String]).void } - attr_writer :copyright_owner_name - - sig { returns(T.nilable(String)) } - attr_reader :country - - sig { params(country: String).void } - attr_writer :country - - sig { returns(T.nilable(String)) } - attr_reader :country_code - - sig { params(country_code: String).void } - attr_writer :country_code - - sig { returns(T.nilable(String)) } - attr_reader :country_primary_location_code - - sig { params(country_primary_location_code: String).void } - attr_writer :country_primary_location_code - - sig { returns(T.nilable(String)) } - attr_reader :country_primary_location_name - - sig { params(country_primary_location_name: String).void } - attr_writer :country_primary_location_name - - sig { returns(T.nilable(String)) } - attr_reader :creator - - sig { params(creator: String).void } - attr_writer :creator - - sig { returns(T.nilable(String)) } - attr_reader :creator_address - - sig { params(creator_address: String).void } - attr_writer :creator_address - - sig { returns(T.nilable(String)) } - attr_reader :creator_city - - sig { params(creator_city: String).void } - attr_writer :creator_city - - sig { returns(T.nilable(String)) } - attr_reader :creator_country - - sig { params(creator_country: String).void } - attr_writer :creator_country - - sig { returns(T.nilable(String)) } - attr_reader :creator_postal_code - - sig { params(creator_postal_code: String).void } - attr_writer :creator_postal_code - - sig { returns(T.nilable(String)) } - attr_reader :creator_region - - sig { params(creator_region: String).void } - attr_writer :creator_region - - sig { returns(T.nilable(String)) } - attr_reader :creator_work_email - - sig { params(creator_work_email: String).void } - attr_writer :creator_work_email - - sig { returns(T.nilable(String)) } - attr_reader :creator_work_telephone - - sig { params(creator_work_telephone: String).void } - attr_writer :creator_work_telephone - - sig { returns(T.nilable(String)) } - attr_reader :creator_work_url - - sig { params(creator_work_url: String).void } - attr_writer :creator_work_url - - sig { returns(T.nilable(String)) } - attr_reader :credit - - sig { params(credit: String).void } - attr_writer :credit - - sig { returns(T.nilable(Time)) } - attr_reader :date_created - - sig { params(date_created: Time).void } - attr_writer :date_created - - sig { returns(T.nilable(Time)) } - attr_reader :date_time_created - - sig { params(date_time_created: Time).void } - attr_writer :date_time_created - - sig { returns(T.nilable(Time)) } - attr_reader :date_time_original - - sig { params(date_time_original: Time).void } - attr_writer :date_time_original - - sig { returns(T.nilable(String)) } - attr_reader :description - - sig { params(description: String).void } - attr_writer :description - - sig { returns(T.nilable(String)) } - attr_reader :digital_image_guid - - sig { params(digital_image_guid: String).void } - attr_writer :digital_image_guid - - sig { returns(T.nilable(String)) } - attr_reader :digital_source_type - - sig { params(digital_source_type: String).void } - attr_writer :digital_source_type - - sig { returns(T.nilable(String)) } - attr_reader :embedded_encoded_rights_expr - - sig { params(embedded_encoded_rights_expr: String).void } - attr_writer :embedded_encoded_rights_expr - - sig { returns(T.nilable(String)) } - attr_reader :embedded_encoded_rights_expr_lang_id - - sig { params(embedded_encoded_rights_expr_lang_id: String).void } - attr_writer :embedded_encoded_rights_expr_lang_id - - sig { returns(T.nilable(String)) } - attr_reader :embedded_encoded_rights_expr_type - - sig { params(embedded_encoded_rights_expr_type: String).void } - attr_writer :embedded_encoded_rights_expr_type - - sig { returns(T.nilable(String)) } - attr_reader :event - - sig { params(event: String).void } - attr_writer :event - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(String)) } - attr_reader :genre_cv_id - - sig { params(genre_cv_id: String).void } - attr_writer :genre_cv_id - - sig { returns(T.nilable(String)) } - attr_reader :genre_cv_term_id - - sig { params(genre_cv_term_id: String).void } - attr_writer :genre_cv_term_id - - sig { returns(T.nilable(String)) } - attr_reader :genre_cv_term_name - - sig { params(genre_cv_term_name: String).void } - attr_writer :genre_cv_term_name - - sig { returns(T.nilable(String)) } - attr_reader :genre_cv_term_refined_about - - sig { params(genre_cv_term_refined_about: String).void } - attr_writer :genre_cv_term_refined_about - - sig { returns(T.nilable(String)) } - attr_reader :headline - - sig { params(headline: String).void } - attr_writer :headline - - sig { returns(T.nilable(String)) } - attr_reader :image_creator_id - - sig { params(image_creator_id: String).void } - attr_writer :image_creator_id - - sig { returns(T.nilable(String)) } - attr_reader :image_creator_image_id - - sig { params(image_creator_image_id: String).void } - attr_writer :image_creator_image_id - - sig { returns(T.nilable(String)) } - attr_reader :image_creator_name - - sig { params(image_creator_name: String).void } - attr_writer :image_creator_name - - sig { returns(T.nilable(String)) } - attr_reader :image_description - - sig { params(image_description: String).void } - attr_writer :image_description - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_h - - sig { params(image_region_boundary_h: T::Array[Float]).void } - attr_writer :image_region_boundary_h - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_rx - - sig { params(image_region_boundary_rx: T::Array[Float]).void } - attr_writer :image_region_boundary_rx - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_boundary_shape - - sig { params(image_region_boundary_shape: T::Array[String]).void } - attr_writer :image_region_boundary_shape - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_boundary_unit - - sig { params(image_region_boundary_unit: T::Array[String]).void } - attr_writer :image_region_boundary_unit - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_vertices_x - - sig { params(image_region_boundary_vertices_x: T::Array[Float]).void } - attr_writer :image_region_boundary_vertices_x - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_vertices_y - - sig { params(image_region_boundary_vertices_y: T::Array[Float]).void } - attr_writer :image_region_boundary_vertices_y - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_w - - sig { params(image_region_boundary_w: T::Array[Float]).void } - attr_writer :image_region_boundary_w - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_x - - sig { params(image_region_boundary_x: T::Array[Float]).void } - attr_writer :image_region_boundary_x - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :image_region_boundary_y - - sig { params(image_region_boundary_y: T::Array[Float]).void } - attr_writer :image_region_boundary_y - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_ctype_identifier - - sig { params(image_region_ctype_identifier: T::Array[String]).void } - attr_writer :image_region_ctype_identifier - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_ctype_name - - sig { params(image_region_ctype_name: T::Array[String]).void } - attr_writer :image_region_ctype_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_id - - sig { params(image_region_id: T::Array[String]).void } - attr_writer :image_region_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_name - - sig { params(image_region_name: T::Array[String]).void } - attr_writer :image_region_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_organisation_in_image_name - - sig do - params(image_region_organisation_in_image_name: T::Array[String]).void - end - attr_writer :image_region_organisation_in_image_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_person_in_image - - sig { params(image_region_person_in_image: T::Array[String]).void } - attr_writer :image_region_person_in_image - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_role_identifier - - sig { params(image_region_role_identifier: T::Array[String]).void } - attr_writer :image_region_role_identifier - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :image_region_role_name - - sig { params(image_region_role_name: T::Array[String]).void } - attr_writer :image_region_role_name - - sig { returns(T.nilable(String)) } - attr_reader :image_supplier_id - - sig { params(image_supplier_id: String).void } - attr_writer :image_supplier_id - - sig { returns(T.nilable(String)) } - attr_reader :image_supplier_image_id - - sig { params(image_supplier_image_id: String).void } - attr_writer :image_supplier_image_id - - sig { returns(T.nilable(String)) } - attr_reader :image_supplier_name - - sig { params(image_supplier_name: String).void } - attr_writer :image_supplier_name - - sig { returns(T.nilable(String)) } - attr_reader :instructions - - sig { params(instructions: String).void } - attr_writer :instructions - - sig { returns(T.nilable(String)) } - attr_reader :intellectual_genre - - sig { params(intellectual_genre: String).void } - attr_writer :intellectual_genre - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :keywords - - sig { params(keywords: T::Array[String]).void } - attr_writer :keywords - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_city - - sig { params(licensor_city: T::Array[String]).void } - attr_writer :licensor_city - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_country - - sig { params(licensor_country: T::Array[String]).void } - attr_writer :licensor_country - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_email - - sig { params(licensor_email: T::Array[String]).void } - attr_writer :licensor_email - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_extended_address - - sig { params(licensor_extended_address: T::Array[String]).void } - attr_writer :licensor_extended_address - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_id - - sig { params(licensor_id: T::Array[String]).void } - attr_writer :licensor_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_name - - sig { params(licensor_name: T::Array[String]).void } - attr_writer :licensor_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_postal_code - - sig { params(licensor_postal_code: T::Array[String]).void } - attr_writer :licensor_postal_code - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_region - - sig { params(licensor_region: T::Array[String]).void } - attr_writer :licensor_region - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_street_address - - sig { params(licensor_street_address: T::Array[String]).void } - attr_writer :licensor_street_address - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_telephone1 - - sig { params(licensor_telephone1: T::Array[String]).void } - attr_writer :licensor_telephone1 - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_telephone2 - - sig { params(licensor_telephone2: T::Array[String]).void } - attr_writer :licensor_telephone2 - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :licensor_url - - sig { params(licensor_url: T::Array[String]).void } - attr_writer :licensor_url - - sig { returns(T.nilable(String)) } - attr_reader :linked_encoded_rights_expr - - sig { params(linked_encoded_rights_expr: String).void } - attr_writer :linked_encoded_rights_expr - - sig { returns(T.nilable(String)) } - attr_reader :linked_encoded_rights_expr_lang_id - - sig { params(linked_encoded_rights_expr_lang_id: String).void } - attr_writer :linked_encoded_rights_expr_lang_id - - sig { returns(T.nilable(String)) } - attr_reader :linked_encoded_rights_expr_type - - sig { params(linked_encoded_rights_expr_type: String).void } - attr_writer :linked_encoded_rights_expr_type - - sig { returns(T.nilable(String)) } - attr_reader :location - - sig { params(location: String).void } - attr_writer :location - - sig { returns(T.nilable(String)) } - attr_reader :location_created_city - - sig { params(location_created_city: String).void } - attr_writer :location_created_city - - sig { returns(T.nilable(String)) } - attr_reader :location_created_country_code - - sig { params(location_created_country_code: String).void } - attr_writer :location_created_country_code - - sig { returns(T.nilable(String)) } - attr_reader :location_created_country_name - - sig { params(location_created_country_name: String).void } - attr_writer :location_created_country_name - - sig { returns(T.nilable(String)) } - attr_reader :location_created_gps_altitude - - sig { params(location_created_gps_altitude: String).void } - attr_writer :location_created_gps_altitude - - sig { returns(T.nilable(String)) } - attr_reader :location_created_gps_latitude - - sig { params(location_created_gps_latitude: String).void } - attr_writer :location_created_gps_latitude - - sig { returns(T.nilable(String)) } - attr_reader :location_created_gps_longitude - - sig { params(location_created_gps_longitude: String).void } - attr_writer :location_created_gps_longitude - - sig { returns(T.nilable(String)) } - attr_reader :location_created_location_id - - sig { params(location_created_location_id: String).void } - attr_writer :location_created_location_id - - sig { returns(T.nilable(String)) } - attr_reader :location_created_location_name - - sig { params(location_created_location_name: String).void } - attr_writer :location_created_location_name - - sig { returns(T.nilable(String)) } - attr_reader :location_created_province_state - - sig { params(location_created_province_state: String).void } - attr_writer :location_created_province_state - - sig { returns(T.nilable(String)) } - attr_reader :location_created_sublocation - - sig { params(location_created_sublocation: String).void } - attr_writer :location_created_sublocation - - sig { returns(T.nilable(String)) } - attr_reader :location_created_world_region - - sig { params(location_created_world_region: String).void } - attr_writer :location_created_world_region - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_city - - sig { params(location_shown_city: T::Array[String]).void } - attr_writer :location_shown_city - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_country_code - - sig { params(location_shown_country_code: T::Array[String]).void } - attr_writer :location_shown_country_code - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_country_name - - sig { params(location_shown_country_name: T::Array[String]).void } - attr_writer :location_shown_country_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_gps_altitude - - sig { params(location_shown_gps_altitude: T::Array[String]).void } - attr_writer :location_shown_gps_altitude - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_gps_latitude - - sig { params(location_shown_gps_latitude: T::Array[String]).void } - attr_writer :location_shown_gps_latitude - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_gps_longitude - - sig { params(location_shown_gps_longitude: T::Array[String]).void } - attr_writer :location_shown_gps_longitude - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_location_id - - sig { params(location_shown_location_id: T::Array[String]).void } - attr_writer :location_shown_location_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_location_name - - sig { params(location_shown_location_name: T::Array[String]).void } - attr_writer :location_shown_location_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_province_state - - sig { params(location_shown_province_state: T::Array[String]).void } - attr_writer :location_shown_province_state - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_sublocation - - sig { params(location_shown_sublocation: T::Array[String]).void } - attr_writer :location_shown_sublocation - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :location_shown_world_region - - sig { params(location_shown_world_region: T::Array[String]).void } - attr_writer :location_shown_world_region - - sig { returns(T.nilable(Float)) } - attr_reader :max_avail_height - - sig { params(max_avail_height: Float).void } - attr_writer :max_avail_height - - sig { returns(T.nilable(Float)) } - attr_reader :max_avail_width - - sig { params(max_avail_width: Float).void } - attr_writer :max_avail_width - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :model_age - - sig { params(model_age: T::Array[Float]).void } - attr_writer :model_age - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :model_release_id - - sig { params(model_release_id: T::Array[String]).void } - attr_writer :model_release_id - - sig { returns(T.nilable(String)) } - attr_reader :object_attribute_reference - - sig { params(object_attribute_reference: String).void } - attr_writer :object_attribute_reference - - sig { returns(T.nilable(String)) } - attr_reader :object_name - - sig { params(object_name: String).void } - attr_writer :object_name - - sig { returns(T.nilable(String)) } - attr_reader :offset_time_original - - sig { params(offset_time_original: String).void } - attr_writer :offset_time_original - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :organisation_in_image_code - - sig { params(organisation_in_image_code: T::Array[String]).void } - attr_writer :organisation_in_image_code - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :organisation_in_image_name - - sig { params(organisation_in_image_name: T::Array[String]).void } - attr_writer :organisation_in_image_name - - sig { returns(T.nilable(String)) } - attr_reader :orientation - - sig { params(orientation: String).void } - attr_writer :orientation - - sig { returns(T.nilable(String)) } - attr_reader :original_transmission_reference - - sig { params(original_transmission_reference: String).void } - attr_writer :original_transmission_reference - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image - - sig { params(person_in_image: T::Array[String]).void } - attr_writer :person_in_image - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_cv_term_cv_id - - sig { params(person_in_image_cv_term_cv_id: T::Array[String]).void } - attr_writer :person_in_image_cv_term_cv_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_cv_term_id - - sig { params(person_in_image_cv_term_id: T::Array[String]).void } - attr_writer :person_in_image_cv_term_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_cv_term_name - - sig { params(person_in_image_cv_term_name: T::Array[String]).void } - attr_writer :person_in_image_cv_term_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_cv_term_refined_about - - sig do - params(person_in_image_cv_term_refined_about: T::Array[String]).void - end - attr_writer :person_in_image_cv_term_refined_about - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_description - - sig { params(person_in_image_description: T::Array[String]).void } - attr_writer :person_in_image_description - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_id - - sig { params(person_in_image_id: T::Array[String]).void } - attr_writer :person_in_image_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :person_in_image_name - - sig { params(person_in_image_name: T::Array[String]).void } - attr_writer :person_in_image_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :product_in_image_description - - sig { params(product_in_image_description: T::Array[String]).void } - attr_writer :product_in_image_description - - sig { returns(T.nilable(T::Array[Float])) } - attr_reader :product_in_image_gtin - - sig { params(product_in_image_gtin: T::Array[Float]).void } - attr_writer :product_in_image_gtin - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :product_in_image_name - - sig { params(product_in_image_name: T::Array[String]).void } - attr_writer :product_in_image_name - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :property_release_id - - sig { params(property_release_id: T::Array[String]).void } - attr_writer :property_release_id - - sig { returns(T.nilable(String)) } - attr_reader :province_state - - sig { params(province_state: String).void } - attr_writer :province_state - - sig { returns(T.nilable(Integer)) } - attr_reader :rating - - sig { params(rating: Integer).void } - attr_writer :rating - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :registry_entry_role - - sig { params(registry_entry_role: T::Array[String]).void } - attr_writer :registry_entry_role - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :registry_item_id - - sig { params(registry_item_id: T::Array[String]).void } - attr_writer :registry_item_id - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :registry_organisation_id - - sig { params(registry_organisation_id: T::Array[String]).void } - attr_writer :registry_organisation_id - - sig { returns(T.nilable(String)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: String).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :rights - - sig { params(rights: String).void } - attr_writer :rights - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :scene - - sig { params(scene: T::Array[String]).void } - attr_writer :scene - - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig { returns(T.nilable(String)) } - attr_reader :special_instructions - - sig { params(special_instructions: String).void } - attr_writer :special_instructions - - sig { returns(T.nilable(String)) } - attr_reader :state - - sig { params(state: String).void } - attr_writer :state - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :subject - - sig { params(subject: T::Array[String]).void } - attr_writer :subject - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :subject_code - - sig { params(subject_code: T::Array[String]).void } - attr_writer :subject_code - - sig { returns(T.nilable(T::Array[String])) } - attr_reader :subject_reference - - sig { params(subject_reference: T::Array[String]).void } - attr_writer :subject_reference - - sig { returns(T.nilable(String)) } - attr_reader :sublocation - - sig { params(sublocation: String).void } - attr_writer :sublocation - - sig { returns(T.nilable(String)) } - attr_reader :time_created - - sig { params(time_created: String).void } - attr_writer :time_created - - sig { returns(T.nilable(String)) } - attr_reader :title - - sig { params(title: String).void } - attr_writer :title - - sig { returns(T.nilable(String)) } - attr_reader :transmission_reference - - sig { params(transmission_reference: String).void } - attr_writer :transmission_reference - - sig { returns(T.nilable(String)) } - attr_reader :usage_terms - - sig { params(usage_terms: String).void } - attr_writer :usage_terms - - sig { returns(T.nilable(String)) } - attr_reader :web_statement - - sig { params(web_statement: String).void } - attr_writer :web_statement - - sig { returns(T.nilable(String)) } - attr_reader :writer - - sig { params(writer: String).void } - attr_writer :writer - - sig { returns(T.nilable(String)) } - attr_reader :writer_editor - - sig { params(writer_editor: String).void } - attr_writer :writer_editor - - sig { returns(T.nilable(Float)) } - attr_reader :x_resolution - - sig { params(x_resolution: Float).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :y_resolution - - sig { params(y_resolution: Float).void } - attr_writer :y_resolution - - # 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. - sig do - params( - about_cv_term_cv_id: String, - about_cv_term_id: String, - about_cv_term_name: String, - about_cv_term_refined_about: String, - additional_model_information: String, - application_record_version: Integer, - artist: String, - artwork_circa_date_created: String, - artwork_content_description: String, - artwork_contribution_description: String, - artwork_copyright_notice: String, - artwork_copyright_owner_id: String, - artwork_copyright_owner_name: String, - artwork_creator: T::Array[String], - artwork_creator_id: T::Array[String], - artwork_date_created: Time, - artwork_licensor_id: String, - artwork_licensor_name: String, - artwork_physical_description: String, - artwork_source: String, - artwork_source_inventory_no: String, - artwork_source_inv_url: String, - artwork_style_period: T::Array[String], - artwork_title: String, - authors_position: String, - byline: String, - byline_title: String, - caption: String, - caption_abstract: String, - caption_writer: String, - city: String, - color_space: String, - components_configuration: String, - copyright: String, - copyright_notice: String, - copyright_owner_id: T::Array[String], - copyright_owner_name: T::Array[String], - country: String, - country_code: String, - country_primary_location_code: String, - country_primary_location_name: String, - creator: String, - creator_address: String, - creator_city: String, - creator_country: String, - creator_postal_code: String, - creator_region: String, - creator_work_email: String, - creator_work_telephone: String, - creator_work_url: String, - credit: String, - date_created: Time, - date_time_created: Time, - date_time_original: Time, - description: String, - digital_image_guid: String, - digital_source_type: String, - embedded_encoded_rights_expr: String, - embedded_encoded_rights_expr_lang_id: String, - embedded_encoded_rights_expr_type: String, - event: String, - exif_version: String, - flashpix_version: String, - genre_cv_id: String, - genre_cv_term_id: String, - genre_cv_term_name: String, - genre_cv_term_refined_about: String, - headline: String, - image_creator_id: String, - image_creator_image_id: String, - image_creator_name: String, - image_description: String, - image_region_boundary_h: T::Array[Float], - image_region_boundary_rx: T::Array[Float], - image_region_boundary_shape: T::Array[String], - image_region_boundary_unit: T::Array[String], - image_region_boundary_vertices_x: T::Array[Float], - image_region_boundary_vertices_y: T::Array[Float], - image_region_boundary_w: T::Array[Float], - image_region_boundary_x: T::Array[Float], - image_region_boundary_y: T::Array[Float], - image_region_ctype_identifier: T::Array[String], - image_region_ctype_name: T::Array[String], - image_region_id: T::Array[String], - image_region_name: T::Array[String], - image_region_organisation_in_image_name: T::Array[String], - image_region_person_in_image: T::Array[String], - image_region_role_identifier: T::Array[String], - image_region_role_name: T::Array[String], - image_supplier_id: String, - image_supplier_image_id: String, - image_supplier_name: String, - instructions: String, - intellectual_genre: String, - keywords: T::Array[String], - licensor_city: T::Array[String], - licensor_country: T::Array[String], - licensor_email: T::Array[String], - licensor_extended_address: T::Array[String], - licensor_id: T::Array[String], - licensor_name: T::Array[String], - licensor_postal_code: T::Array[String], - licensor_region: T::Array[String], - licensor_street_address: T::Array[String], - licensor_telephone1: T::Array[String], - licensor_telephone2: T::Array[String], - licensor_url: T::Array[String], - linked_encoded_rights_expr: String, - linked_encoded_rights_expr_lang_id: String, - linked_encoded_rights_expr_type: String, - location: String, - location_created_city: String, - location_created_country_code: String, - location_created_country_name: String, - location_created_gps_altitude: String, - location_created_gps_latitude: String, - location_created_gps_longitude: String, - location_created_location_id: String, - location_created_location_name: String, - location_created_province_state: String, - location_created_sublocation: String, - location_created_world_region: String, - location_shown_city: T::Array[String], - location_shown_country_code: T::Array[String], - location_shown_country_name: T::Array[String], - location_shown_gps_altitude: T::Array[String], - location_shown_gps_latitude: T::Array[String], - location_shown_gps_longitude: T::Array[String], - location_shown_location_id: T::Array[String], - location_shown_location_name: T::Array[String], - location_shown_province_state: T::Array[String], - location_shown_sublocation: T::Array[String], - location_shown_world_region: T::Array[String], - max_avail_height: Float, - max_avail_width: Float, - model_age: T::Array[Float], - model_release_id: T::Array[String], - object_attribute_reference: String, - object_name: String, - offset_time_original: String, - organisation_in_image_code: T::Array[String], - organisation_in_image_name: T::Array[String], - orientation: String, - original_transmission_reference: String, - person_in_image: T::Array[String], - person_in_image_cv_term_cv_id: T::Array[String], - person_in_image_cv_term_id: T::Array[String], - person_in_image_cv_term_name: T::Array[String], - person_in_image_cv_term_refined_about: T::Array[String], - person_in_image_description: T::Array[String], - person_in_image_id: T::Array[String], - person_in_image_name: T::Array[String], - product_in_image_description: T::Array[String], - product_in_image_gtin: T::Array[Float], - product_in_image_name: T::Array[String], - property_release_id: T::Array[String], - province_state: String, - rating: Integer, - registry_entry_role: T::Array[String], - registry_item_id: T::Array[String], - registry_organisation_id: T::Array[String], - resolution_unit: String, - rights: String, - scene: T::Array[String], - source: String, - special_instructions: String, - state: String, - subject: T::Array[String], - subject_code: T::Array[String], - subject_reference: T::Array[String], - sublocation: String, - time_created: String, - title: String, - transmission_reference: String, - usage_terms: String, - web_statement: String, - writer: String, - writer_editor: String, - x_resolution: Float, - y_resolution: Float - ).returns(T.attached_class) - end - def self.new( - about_cv_term_cv_id: nil, - about_cv_term_id: nil, - about_cv_term_name: nil, - about_cv_term_refined_about: nil, - additional_model_information: nil, - application_record_version: nil, - artist: nil, - artwork_circa_date_created: nil, - artwork_content_description: nil, - artwork_contribution_description: nil, - artwork_copyright_notice: nil, - artwork_copyright_owner_id: nil, - artwork_copyright_owner_name: nil, - artwork_creator: nil, - artwork_creator_id: nil, - artwork_date_created: nil, - artwork_licensor_id: nil, - artwork_licensor_name: nil, - artwork_physical_description: nil, - artwork_source: nil, - artwork_source_inventory_no: nil, - artwork_source_inv_url: nil, - artwork_style_period: nil, - artwork_title: nil, - authors_position: nil, - byline: nil, - byline_title: nil, - caption: nil, - caption_abstract: nil, - caption_writer: nil, - city: nil, - color_space: nil, - components_configuration: nil, - copyright: nil, - copyright_notice: nil, - copyright_owner_id: nil, - copyright_owner_name: nil, - country: nil, - country_code: nil, - country_primary_location_code: nil, - country_primary_location_name: nil, - creator: nil, - creator_address: nil, - creator_city: nil, - creator_country: nil, - creator_postal_code: nil, - creator_region: nil, - creator_work_email: nil, - creator_work_telephone: nil, - creator_work_url: nil, - credit: nil, - date_created: nil, - date_time_created: nil, - date_time_original: nil, - description: nil, - digital_image_guid: nil, - digital_source_type: nil, - embedded_encoded_rights_expr: nil, - embedded_encoded_rights_expr_lang_id: nil, - embedded_encoded_rights_expr_type: nil, - event: nil, - exif_version: nil, - flashpix_version: nil, - genre_cv_id: nil, - genre_cv_term_id: nil, - genre_cv_term_name: nil, - genre_cv_term_refined_about: nil, - headline: nil, - image_creator_id: nil, - image_creator_image_id: nil, - image_creator_name: nil, - image_description: nil, - image_region_boundary_h: nil, - image_region_boundary_rx: nil, - image_region_boundary_shape: nil, - image_region_boundary_unit: nil, - image_region_boundary_vertices_x: nil, - image_region_boundary_vertices_y: nil, - image_region_boundary_w: nil, - image_region_boundary_x: nil, - image_region_boundary_y: nil, - image_region_ctype_identifier: nil, - image_region_ctype_name: nil, - image_region_id: nil, - image_region_name: nil, - image_region_organisation_in_image_name: nil, - image_region_person_in_image: nil, - image_region_role_identifier: nil, - image_region_role_name: nil, - image_supplier_id: nil, - image_supplier_image_id: nil, - image_supplier_name: nil, - instructions: nil, - intellectual_genre: nil, - keywords: nil, - licensor_city: nil, - licensor_country: nil, - licensor_email: nil, - licensor_extended_address: nil, - licensor_id: nil, - licensor_name: nil, - licensor_postal_code: nil, - licensor_region: nil, - licensor_street_address: nil, - licensor_telephone1: nil, - licensor_telephone2: nil, - licensor_url: nil, - linked_encoded_rights_expr: nil, - linked_encoded_rights_expr_lang_id: nil, - linked_encoded_rights_expr_type: nil, - location: nil, - location_created_city: nil, - location_created_country_code: nil, - location_created_country_name: nil, - location_created_gps_altitude: nil, - location_created_gps_latitude: nil, - location_created_gps_longitude: nil, - location_created_location_id: nil, - location_created_location_name: nil, - location_created_province_state: nil, - location_created_sublocation: nil, - location_created_world_region: nil, - location_shown_city: nil, - location_shown_country_code: nil, - location_shown_country_name: nil, - location_shown_gps_altitude: nil, - location_shown_gps_latitude: nil, - location_shown_gps_longitude: nil, - location_shown_location_id: nil, - location_shown_location_name: nil, - location_shown_province_state: nil, - location_shown_sublocation: nil, - location_shown_world_region: nil, - max_avail_height: nil, - max_avail_width: nil, - model_age: nil, - model_release_id: nil, - object_attribute_reference: nil, - object_name: nil, - offset_time_original: nil, - organisation_in_image_code: nil, - organisation_in_image_name: nil, - orientation: nil, - original_transmission_reference: nil, - person_in_image: nil, - person_in_image_cv_term_cv_id: nil, - person_in_image_cv_term_id: nil, - person_in_image_cv_term_name: nil, - person_in_image_cv_term_refined_about: nil, - person_in_image_description: nil, - person_in_image_id: nil, - person_in_image_name: nil, - product_in_image_description: nil, - product_in_image_gtin: nil, - product_in_image_name: nil, - property_release_id: nil, - province_state: nil, - rating: nil, - registry_entry_role: nil, - registry_item_id: nil, - registry_organisation_id: nil, - resolution_unit: nil, - rights: nil, - scene: nil, - source: nil, - special_instructions: nil, - state: nil, - subject: nil, - subject_code: nil, - subject_reference: nil, - sublocation: nil, - time_created: nil, - title: nil, - transmission_reference: nil, - usage_terms: nil, - web_statement: nil, - writer: nil, - writer_editor: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - about_cv_term_cv_id: String, - about_cv_term_id: String, - about_cv_term_name: String, - about_cv_term_refined_about: String, - additional_model_information: String, - application_record_version: Integer, - artist: String, - artwork_circa_date_created: String, - artwork_content_description: String, - artwork_contribution_description: String, - artwork_copyright_notice: String, - artwork_copyright_owner_id: String, - artwork_copyright_owner_name: String, - artwork_creator: T::Array[String], - artwork_creator_id: T::Array[String], - artwork_date_created: Time, - artwork_licensor_id: String, - artwork_licensor_name: String, - artwork_physical_description: String, - artwork_source: String, - artwork_source_inventory_no: String, - artwork_source_inv_url: String, - artwork_style_period: T::Array[String], - artwork_title: String, - authors_position: String, - byline: String, - byline_title: String, - caption: String, - caption_abstract: String, - caption_writer: String, - city: String, - color_space: String, - components_configuration: String, - copyright: String, - copyright_notice: String, - copyright_owner_id: T::Array[String], - copyright_owner_name: T::Array[String], - country: String, - country_code: String, - country_primary_location_code: String, - country_primary_location_name: String, - creator: String, - creator_address: String, - creator_city: String, - creator_country: String, - creator_postal_code: String, - creator_region: String, - creator_work_email: String, - creator_work_telephone: String, - creator_work_url: String, - credit: String, - date_created: Time, - date_time_created: Time, - date_time_original: Time, - description: String, - digital_image_guid: String, - digital_source_type: String, - embedded_encoded_rights_expr: String, - embedded_encoded_rights_expr_lang_id: String, - embedded_encoded_rights_expr_type: String, - event: String, - exif_version: String, - flashpix_version: String, - genre_cv_id: String, - genre_cv_term_id: String, - genre_cv_term_name: String, - genre_cv_term_refined_about: String, - headline: String, - image_creator_id: String, - image_creator_image_id: String, - image_creator_name: String, - image_description: String, - image_region_boundary_h: T::Array[Float], - image_region_boundary_rx: T::Array[Float], - image_region_boundary_shape: T::Array[String], - image_region_boundary_unit: T::Array[String], - image_region_boundary_vertices_x: T::Array[Float], - image_region_boundary_vertices_y: T::Array[Float], - image_region_boundary_w: T::Array[Float], - image_region_boundary_x: T::Array[Float], - image_region_boundary_y: T::Array[Float], - image_region_ctype_identifier: T::Array[String], - image_region_ctype_name: T::Array[String], - image_region_id: T::Array[String], - image_region_name: T::Array[String], - image_region_organisation_in_image_name: T::Array[String], - image_region_person_in_image: T::Array[String], - image_region_role_identifier: T::Array[String], - image_region_role_name: T::Array[String], - image_supplier_id: String, - image_supplier_image_id: String, - image_supplier_name: String, - instructions: String, - intellectual_genre: String, - keywords: T::Array[String], - licensor_city: T::Array[String], - licensor_country: T::Array[String], - licensor_email: T::Array[String], - licensor_extended_address: T::Array[String], - licensor_id: T::Array[String], - licensor_name: T::Array[String], - licensor_postal_code: T::Array[String], - licensor_region: T::Array[String], - licensor_street_address: T::Array[String], - licensor_telephone1: T::Array[String], - licensor_telephone2: T::Array[String], - licensor_url: T::Array[String], - linked_encoded_rights_expr: String, - linked_encoded_rights_expr_lang_id: String, - linked_encoded_rights_expr_type: String, - location: String, - location_created_city: String, - location_created_country_code: String, - location_created_country_name: String, - location_created_gps_altitude: String, - location_created_gps_latitude: String, - location_created_gps_longitude: String, - location_created_location_id: String, - location_created_location_name: String, - location_created_province_state: String, - location_created_sublocation: String, - location_created_world_region: String, - location_shown_city: T::Array[String], - location_shown_country_code: T::Array[String], - location_shown_country_name: T::Array[String], - location_shown_gps_altitude: T::Array[String], - location_shown_gps_latitude: T::Array[String], - location_shown_gps_longitude: T::Array[String], - location_shown_location_id: T::Array[String], - location_shown_location_name: T::Array[String], - location_shown_province_state: T::Array[String], - location_shown_sublocation: T::Array[String], - location_shown_world_region: T::Array[String], - max_avail_height: Float, - max_avail_width: Float, - model_age: T::Array[Float], - model_release_id: T::Array[String], - object_attribute_reference: String, - object_name: String, - offset_time_original: String, - organisation_in_image_code: T::Array[String], - organisation_in_image_name: T::Array[String], - orientation: String, - original_transmission_reference: String, - person_in_image: T::Array[String], - person_in_image_cv_term_cv_id: T::Array[String], - person_in_image_cv_term_id: T::Array[String], - person_in_image_cv_term_name: T::Array[String], - person_in_image_cv_term_refined_about: T::Array[String], - person_in_image_description: T::Array[String], - person_in_image_id: T::Array[String], - person_in_image_name: T::Array[String], - product_in_image_description: T::Array[String], - product_in_image_gtin: T::Array[Float], - product_in_image_name: T::Array[String], - property_release_id: T::Array[String], - province_state: String, - rating: Integer, - registry_entry_role: T::Array[String], - registry_item_id: T::Array[String], - registry_organisation_id: T::Array[String], - resolution_unit: String, - rights: String, - scene: T::Array[String], - source: String, - special_instructions: String, - state: String, - subject: T::Array[String], - subject_code: T::Array[String], - subject_reference: T::Array[String], - sublocation: String, - time_created: String, - title: String, - transmission_reference: String, - usage_terms: String, - web_statement: String, - writer: String, - writer_editor: String, - x_resolution: Float, - y_resolution: Float - } - ) - end - def to_hash - end - end - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV2Response::ExtensionStatus, - Imagekit::Internal::AnyHash - ) - end - - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - ) - end - attr_reader :aws_auto_tagging - - sig do - params( - aws_auto_tagging: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::OrSymbol - ).void - end - attr_writer :aws_auto_tagging - - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - ) - end - attr_reader :google_auto_tagging - - sig do - params( - google_auto_tagging: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::OrSymbol - ).void - end - attr_writer :google_auto_tagging - - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol - ) - ) - end - attr_reader :remove_bg - - sig do - params( - remove_bg: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::OrSymbol - ).void - end - attr_writer :remove_bg - - # 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. - sig do - params( - aws_auto_tagging: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::OrSymbol, - google_auto_tagging: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::OrSymbol, - remove_bg: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::OrSymbol - ).returns(T.attached_class) - end - def self.new( - aws_auto_tagging: nil, - google_auto_tagging: nil, - remove_bg: nil - ) - end - - sig do - override.returns( - { - aws_auto_tagging: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol, - google_auto_tagging: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, - remove_bg: - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol - } - ) - end - def to_hash - end - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::FileUploadV2Response::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ] - ) - end - def self.values - end - end - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::FileUploadV2Response::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ] - ) - end - def self.values - end - end - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::FileUploadV2Response::ExtensionStatus::RemoveBg::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class Metadata < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV2Response::Metadata, - Imagekit::Internal::AnyHash - ) - end - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # The density of the image in DPI. - sig { returns(T.nilable(Integer)) } - attr_reader :density - - sig { params(density: Integer).void } - attr_writer :density - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :duration - - sig do - returns( - T.nilable(Imagekit::Models::FileUploadV2Response::Metadata::Exif) - ) - end - attr_reader :exif - - sig do - params( - exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif::OrHash - ).void - end - attr_writer :exif - - # The format of the file (e.g., 'jpg', 'mp4'). - sig { returns(T.nilable(String)) } - attr_reader :format_ - - sig { params(format_: String).void } - attr_writer :format_ - - # Indicates if the image has a color profile. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_color_profile - - sig { params(has_color_profile: T::Boolean).void } - attr_writer :has_color_profile - - # Indicates if the image contains transparent areas. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_transparency - - sig { params(has_transparency: T::Boolean).void } - attr_writer :has_transparency - - # The height of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :height - - sig { params(height: Integer).void } - attr_writer :height - - # Perceptual hash of the image. - sig { returns(T.nilable(String)) } - attr_reader :p_hash - - sig { params(p_hash: String).void } - attr_writer :p_hash - - # The quality indicator of the image. - sig { returns(T.nilable(Integer)) } - attr_reader :quality - - sig { params(quality: Integer).void } - attr_writer :quality - - # The file size in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :size - - sig { params(size: Integer).void } - attr_writer :size - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # The width of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :width - - sig { params(width: Integer).void } - attr_writer :width - - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - sig do - params( - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: - Imagekit::Models::FileUploadV2Response::Metadata::Exif::OrHash, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - ).returns(T.attached_class) - end - def self.new( - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # The density of the image in DPI. - density: nil, - # The duration of the video in seconds (only for video). - duration: nil, - exif: nil, - # The format of the file (e.g., 'jpg', 'mp4'). - format_: nil, - # Indicates if the image has a color profile. - has_color_profile: nil, - # Indicates if the image contains transparent areas. - has_transparency: nil, - # The height of the image or video in pixels. - height: nil, - # Perceptual hash of the image. - p_hash: nil, - # The quality indicator of the image. - quality: nil, - # The file size in bytes. - size: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # The width of the image or video in pixels. - width: nil - ) - end - - sig do - override.returns( - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV2Response::Metadata::Exif, - Imagekit::Internal::AnyHash - ) - end - - # Object containing Exif details. - sig { returns(T.nilable(Imagekit::ExifDetails)) } - attr_reader :exif - - sig { params(exif: Imagekit::ExifDetails::OrHash).void } - attr_writer :exif - - # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Gps)) } - attr_reader :gps - - sig { params(gps: Imagekit::Gps::OrHash).void } - attr_writer :gps - - # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::ExifImage)) } - attr_reader :image - - sig { params(image: Imagekit::ExifImage::OrHash).void } - attr_writer :image - - # JSON object. - sig { returns(T.nilable(Imagekit::Interoperability)) } - attr_reader :interoperability - - sig do - params(interoperability: Imagekit::Interoperability::OrHash).void - end - attr_writer :interoperability - - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :makernote - - sig { params(makernote: T::Hash[Symbol, T.anything]).void } - attr_writer :makernote - - # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Thumbnail)) } - attr_reader :thumbnail - - sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } - attr_writer :thumbnail - - sig do - params( - exif: Imagekit::ExifDetails::OrHash, - gps: Imagekit::Gps::OrHash, - image: Imagekit::ExifImage::OrHash, - interoperability: Imagekit::Interoperability::OrHash, - makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail::OrHash - ).returns(T.attached_class) - end - def self.new( - # Object containing Exif details. - exif: nil, - # Object containing GPS information. - gps: nil, - # Object containing EXIF image information. - image: nil, - # JSON object. - interoperability: nil, - makernote: nil, - # Object containing Thumbnail information. - thumbnail: nil - ) - end - - sig do - override.returns( - { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail - } - ) - end - def to_hash - end - end - end - - class VersionInfo < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadV2Response::VersionInfo, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the file version. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Name of the file version. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # An object containing the file or file version's `id` (versionId) and `name`. - sig { params(id: String, name: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the file version. - id: nil, - # Name of the file version. - name: nil - ) - end - - sig { override.returns({ id: String, name: String }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/files/bulk_add_tags_params.rbi b/rbi/imagekit/models/files/bulk_add_tags_params.rbi new file mode 100644 index 00000000..6825f8f1 --- /dev/null +++ b/rbi/imagekit/models/files/bulk_add_tags_params.rbi @@ -0,0 +1,56 @@ +# typed: strong + +module Imagekit + module Models + module Files + class BulkAddTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::BulkAddTagsParams, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds to which you want to add tags. + sig { returns(T::Array[String]) } + attr_accessor :file_ids + + # An array of tags that you want to add to the files. + sig { returns(T::Array[String]) } + attr_accessor :tags + + sig do + params( + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # An array of fileIds to which you want to add tags. + file_ids:, + # An array of tags that you want to add to the files. + tags:, + request_options: {} + ) + end + + sig do + override.returns( + { + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/bulk_add_tags_response.rbi b/rbi/imagekit/models/files/bulk_add_tags_response.rbi new file mode 100644 index 00000000..a33291a4 --- /dev/null +++ b/rbi/imagekit/models/files/bulk_add_tags_response.rbi @@ -0,0 +1,41 @@ +# typed: strong + +module Imagekit + module Models + module Files + class BulkAddTagsResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::BulkAddTagsResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds that in which tags were successfully added. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :successfully_updated_file_ids + + sig { params(successfully_updated_file_ids: T::Array[String]).void } + attr_writer :successfully_updated_file_ids + + sig do + params(successfully_updated_file_ids: T::Array[String]).returns( + T.attached_class + ) + end + def self.new( + # An array of fileIds that in which tags were successfully added. + successfully_updated_file_ids: nil + ) + end + + sig do + override.returns({ successfully_updated_file_ids: T::Array[String] }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/batch_delete_params.rbi b/rbi/imagekit/models/files/bulk_delete_params.rbi similarity index 89% rename from rbi/imagekit/models/files/batch_delete_params.rbi rename to rbi/imagekit/models/files/bulk_delete_params.rbi index 8f6b4768..6aa1de5f 100644 --- a/rbi/imagekit/models/files/batch_delete_params.rbi +++ b/rbi/imagekit/models/files/bulk_delete_params.rbi @@ -3,14 +3,14 @@ module Imagekit module Models module Files - class BatchDeleteParams < Imagekit::Internal::Type::BaseModel + class BulkDeleteParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::BatchDeleteParams, + Imagekit::Files::BulkDeleteParams, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/batch_delete_response.rbi b/rbi/imagekit/models/files/bulk_delete_response.rbi similarity index 88% rename from rbi/imagekit/models/files/batch_delete_response.rbi rename to rbi/imagekit/models/files/bulk_delete_response.rbi index 12ca30c3..28ce486e 100644 --- a/rbi/imagekit/models/files/batch_delete_response.rbi +++ b/rbi/imagekit/models/files/bulk_delete_response.rbi @@ -3,11 +3,11 @@ module Imagekit module Models module Files - class BatchDeleteResponse < Imagekit::Internal::Type::BaseModel + class BulkDeleteResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::BatchDeleteResponse, + Imagekit::Models::Files::BulkDeleteResponse, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/bulk_remove_ai_tags_params.rbi b/rbi/imagekit/models/files/bulk_remove_ai_tags_params.rbi new file mode 100644 index 00000000..b28187ea --- /dev/null +++ b/rbi/imagekit/models/files/bulk_remove_ai_tags_params.rbi @@ -0,0 +1,56 @@ +# typed: strong + +module Imagekit + module Models + module Files + class BulkRemoveAITagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::BulkRemoveAITagsParams, + Imagekit::Internal::AnyHash + ) + end + + # An array of AITags that you want to remove from the files. + sig { returns(T::Array[String]) } + attr_accessor :ai_tags + + # An array of fileIds from which you want to remove AITags. + sig { returns(T::Array[String]) } + attr_accessor :file_ids + + sig do + params( + ai_tags: T::Array[String], + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # An array of AITags that you want to remove from the files. + ai_tags:, + # An array of fileIds from which you want to remove AITags. + file_ids:, + request_options: {} + ) + end + + sig do + override.returns( + { + ai_tags: T::Array[String], + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/bulk_remove_ai_tags_response.rbi b/rbi/imagekit/models/files/bulk_remove_ai_tags_response.rbi new file mode 100644 index 00000000..404fb021 --- /dev/null +++ b/rbi/imagekit/models/files/bulk_remove_ai_tags_response.rbi @@ -0,0 +1,41 @@ +# typed: strong + +module Imagekit + module Models + module Files + class BulkRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::BulkRemoveAITagsResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds that in which AITags were successfully removed. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :successfully_updated_file_ids + + sig { params(successfully_updated_file_ids: T::Array[String]).void } + attr_writer :successfully_updated_file_ids + + sig do + params(successfully_updated_file_ids: T::Array[String]).returns( + T.attached_class + ) + end + def self.new( + # An array of fileIds that in which AITags were successfully removed. + successfully_updated_file_ids: nil + ) + end + + sig do + override.returns({ successfully_updated_file_ids: T::Array[String] }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/bulk_remove_tags_params.rbi b/rbi/imagekit/models/files/bulk_remove_tags_params.rbi new file mode 100644 index 00000000..bbbaeebe --- /dev/null +++ b/rbi/imagekit/models/files/bulk_remove_tags_params.rbi @@ -0,0 +1,56 @@ +# typed: strong + +module Imagekit + module Models + module Files + class BulkRemoveTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::Files::BulkRemoveTagsParams, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds from which you want to remove tags. + sig { returns(T::Array[String]) } + attr_accessor :file_ids + + # An array of tags that you want to remove from the files. + sig { returns(T::Array[String]) } + attr_accessor :tags + + sig do + params( + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # An array of fileIds from which you want to remove tags. + file_ids:, + # An array of tags that you want to remove from the files. + tags:, + request_options: {} + ) + end + + sig do + override.returns( + { + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/bulk_remove_tags_response.rbi b/rbi/imagekit/models/files/bulk_remove_tags_response.rbi new file mode 100644 index 00000000..68d16d5d --- /dev/null +++ b/rbi/imagekit/models/files/bulk_remove_tags_response.rbi @@ -0,0 +1,41 @@ +# typed: strong + +module Imagekit + module Models + module Files + class BulkRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::BulkRemoveTagsResponse, + Imagekit::Internal::AnyHash + ) + end + + # An array of fileIds that in which tags were successfully removed. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :successfully_updated_file_ids + + sig { params(successfully_updated_file_ids: T::Array[String]).void } + attr_writer :successfully_updated_file_ids + + sig do + params(successfully_updated_file_ids: T::Array[String]).returns( + T.attached_class + ) + end + def self.new( + # An array of fileIds that in which tags were successfully removed. + successfully_updated_file_ids: nil + ) + end + + sig do + override.returns({ successfully_updated_file_ids: T::Array[String] }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/detail_update_params.rbi b/rbi/imagekit/models/files/detail_update_params.rbi deleted file mode 100644 index 04659912..00000000 --- a/rbi/imagekit/models/files/detail_update_params.rbi +++ /dev/null @@ -1,583 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class DetailUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Files::DetailUpdateParams, - Imagekit::Internal::AnyHash - ) - end - - # 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. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # 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. - sig { returns(T.nilable(T.anything)) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T.anything).void } - attr_writer :custom_metadata - - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - sig do - returns( - T.nilable( - T::Array[ - T.any( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension, - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension - ) - ] - ) - ) - end - attr_reader :extensions - - sig do - params( - extensions: - T::Array[ - T.any( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::OrHash - ) - ] - ).void - end - attr_writer :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. - sig do - returns( - T.nilable( - T.any( - T::Array[String], - Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol - ) - ) - ) - end - attr_reader :remove_ai_tags - - sig do - params( - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol - ) - ).void - end - attr_writer :remove_ai_tags - - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :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. - sig { returns(T.nilable(String)) } - attr_reader :webhook_url - - sig { params(webhook_url: String).void } - attr_writer :webhook_url - - # Configure the publication status of a file and its versions. - sig { returns(T.nilable(Imagekit::Files::DetailUpdateParams::Publish)) } - attr_reader :publish - - sig do - params( - publish: Imagekit::Files::DetailUpdateParams::Publish::OrHash - ).void - end - attr_writer :publish - - sig do - params( - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - extensions: - T::Array[ - T.any( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::OrHash - ) - ], - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol - ), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::Files::DetailUpdateParams::Publish::OrHash, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, - # Configure the publication status of a file and its versions. - publish: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - extensions: - T::Array[ - T.any( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension, - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension - ) - ], - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol - ), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::Files::DetailUpdateParams::Publish, - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - - module Extension - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension, - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension - ) - end - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the background removal extension. - sig do - returns( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - returns( - T.nilable( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options - ) - ) - end - attr_reader :options - - sig do - params( - options: - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options::OrHash - ).void - end - attr_writer :options - - sig do - params( - name: - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options::OrHash - ).returns(T.attached_class) - end - def self.new( - # Specifies the background removal extension. - name:, - options: nil - ) - end - - sig do - override.returns( - { - name: - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options - } - ) - end - def to_hash - end - - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash - ) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - sig do - override.returns( - T::Array[Imagekit::Files::DetailUpdateParams::Extension::Variants] - ) - end - def self.variants - end - end - - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - T::Array[String], - Imagekit::Files::DetailUpdateParams::RemoveAITags::TaggedSymbol - ) - end - - sig do - override.returns( - T::Array[ - Imagekit::Files::DetailUpdateParams::RemoveAITags::Variants - ] - ) - end - def self.variants - end - - StringArray = - T.let( - Imagekit::Internal::Type::ArrayOf[String], - Imagekit::Internal::Type::Converter - ) - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::Files::DetailUpdateParams::RemoveAITags) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ALL = - T.let( - :all, - Imagekit::Files::DetailUpdateParams::RemoveAITags::TaggedSymbol - ) - end - - class Publish < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Files::DetailUpdateParams::Publish, - Imagekit::Internal::AnyHash - ) - end - - # Set to `true` to publish the file. Set to `false` to unpublish the file. - sig { returns(T::Boolean) } - attr_accessor :is_published - - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_file_versions - - sig { params(include_file_versions: T::Boolean).void } - attr_writer :include_file_versions - - # Configure the publication status of a file and its versions. - sig do - params( - is_published: T::Boolean, - include_file_versions: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Set to `true` to publish the file. Set to `false` to unpublish the file. - is_published:, - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - include_file_versions: nil - ) - end - - sig do - override.returns( - { is_published: T::Boolean, include_file_versions: T::Boolean } - ) - end - def to_hash - end - end - end - end - end -end diff --git a/rbi/imagekit/models/files/detail_update_response.rbi b/rbi/imagekit/models/files/detail_update_response.rbi deleted file mode 100644 index ac439423..00000000 --- a/rbi/imagekit/models/files/detail_update_response.rbi +++ /dev/null @@ -1,623 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class DetailUpdateResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::DetailUpdateResponse, - Imagekit::Internal::AnyHash - ) - end - - # An array of tags assigned to the file by auto tagging. - sig do - returns( - T.nilable( - T::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag] - ) - ) - end - attr_accessor :ai_tags - - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(String)) } - attr_reader :created_at - - sig { params(created_at: String).void } - attr_writer :created_at - - # An string with custom coordinates of the file. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # An object with custom metadata for the file. - sig { returns(T.nilable(T.anything)) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T.anything).void } - attr_writer :custom_metadata - - sig do - returns( - T.nilable( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus - ) - ) - end - attr_reader :extension_status - - sig do - params( - extension_status: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::OrHash - ).void - end - attr_writer :extension_status - - # Unique identifier of the asset. - sig { returns(T.nilable(String)) } - attr_reader :file_id - - sig { params(file_id: String).void } - attr_writer :file_id - - # 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`. - sig { returns(T.nilable(String)) } - attr_reader :file_path - - sig { params(file_path: String).void } - attr_writer :file_path - - # Type of the file. Possible values are `image`, `non-image`. - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # Specifies if the image has an alpha channel. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_alpha - - sig { params(has_alpha: T::Boolean).void } - attr_writer :has_alpha - - # Height of the file. - sig { returns(T.nilable(Float)) } - attr_reader :height - - sig { params(height: Float).void } - attr_writer :height - - # Specifies if the file is private or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_private_file - - sig { params(is_private_file: T::Boolean).void } - attr_writer :is_private_file - - # Specifies if the file is published or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_published - - sig { params(is_published: T::Boolean).void } - attr_writer :is_published - - # MIME type of the file. - sig { returns(T.nilable(String)) } - attr_reader :mime - - sig { params(mime: String).void } - attr_writer :mime - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Size of the file in bytes. - sig { returns(T.nilable(Float)) } - attr_reader :size - - sig { params(size: Float).void } - attr_writer :size - - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :tags - - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - sig { returns(T.nilable(String)) } - attr_reader :thumbnail - - sig { params(thumbnail: String).void } - attr_writer :thumbnail - - # Type of the asset. - sig { returns(T.nilable(String)) } - attr_reader :type - - sig { params(type: String).void } - attr_writer :type - - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(String)) } - attr_reader :updated_at - - sig { params(updated_at: String).void } - attr_writer :updated_at - - # URL of the file. - sig { returns(T.nilable(String)) } - attr_reader :url - - sig { params(url: String).void } - attr_writer :url - - # An object with details of the file version. - sig do - returns( - T.nilable( - Imagekit::Models::Files::DetailUpdateResponse::VersionInfo - ) - ) - end - attr_reader :version_info - - sig do - params( - version_info: - Imagekit::Models::Files::DetailUpdateResponse::VersionInfo::OrHash - ).void - end - attr_writer :version_info - - # Width of the file. - sig { returns(T.nilable(Float)) } - attr_reader :width - - sig { params(width: Float).void } - attr_writer :width - - sig do - params( - ai_tags: - T.nilable( - T::Array[ - Imagekit::Models::Files::DetailUpdateResponse::AITag::OrHash - ] - ), - created_at: String, - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - extension_status: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::OrHash, - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: String, - updated_at: String, - url: String, - version_info: - Imagekit::Models::Files::DetailUpdateResponse::VersionInfo::OrHash, - width: Float - ).returns(T.attached_class) - end - def self.new( - # An array of tags assigned to the file by auto tagging. - ai_tags: nil, - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - created_at: nil, - # An string with custom coordinates of the file. - custom_coordinates: nil, - # An object with custom metadata for the file. - custom_metadata: nil, - extension_status: nil, - # Unique identifier of the asset. - file_id: nil, - # 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`. - file_path: nil, - # Type of the file. Possible values are `image`, `non-image`. - file_type: nil, - # Specifies if the image has an alpha channel. - has_alpha: nil, - # Height of the file. - height: nil, - # Specifies if the file is private or not. - is_private_file: nil, - # Specifies if the file is published or not. - is_published: nil, - # MIME type of the file. - mime: nil, - # Name of the asset. - name: nil, - # Size of the file in bytes. - size: nil, - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - tags: nil, - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - thumbnail: nil, - # Type of the asset. - type: nil, - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - updated_at: nil, - # URL of the file. - url: nil, - # An object with details of the file version. - version_info: nil, - # Width of the file. - width: nil - ) - end - - sig do - override.returns( - { - ai_tags: - T.nilable( - T::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag] - ), - created_at: String, - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - extension_status: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: String, - updated_at: String, - url: String, - version_info: - Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, - width: Float - } - ) - end - def to_hash - end - - class AITag < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::DetailUpdateResponse::AITag, - Imagekit::Internal::AnyHash - ) - end - - # Confidence score of the tag. - sig { returns(T.nilable(Float)) } - attr_reader :confidence - - sig { params(confidence: Float).void } - attr_writer :confidence - - # Name of the tag. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig do - params(confidence: Float, name: String, source: String).returns( - T.attached_class - ) - end - def self.new( - # Confidence score of the tag. - confidence: nil, - # Name of the tag. - name: nil, - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - source: nil - ) - end - - sig do - override.returns( - { confidence: Float, name: String, source: String } - ) - end - def to_hash - end - end - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, - Imagekit::Internal::AnyHash - ) - end - - sig do - returns( - T.nilable( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - ) - end - attr_reader :aws_auto_tagging - - sig do - params( - aws_auto_tagging: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol - ).void - end - attr_writer :aws_auto_tagging - - sig do - returns( - T.nilable( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - ) - end - attr_reader :google_auto_tagging - - sig do - params( - google_auto_tagging: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol - ).void - end - attr_writer :google_auto_tagging - - sig do - returns( - T.nilable( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol - ) - ) - end - attr_reader :remove_bg - - sig do - params( - remove_bg: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol - ).void - end - attr_writer :remove_bg - - sig do - params( - aws_auto_tagging: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, - google_auto_tagging: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, - remove_bg: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol - ).returns(T.attached_class) - end - def self.new( - aws_auto_tagging: nil, - google_auto_tagging: nil, - remove_bg: nil - ) - end - - sig do - override.returns( - { - aws_auto_tagging: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, - google_auto_tagging: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, - remove_bg: - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol - } - ) - end - def to_hash - end - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol - ] - ) - end - def self.values - end - end - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol - ] - ) - end - def self.values - end - end - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUCCESS = - T.let( - :success, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol - ) - PENDING = - T.let( - :pending, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol - ) - FAILED = - T.let( - :failed, - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class VersionInfo < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the file version. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Name of the file version. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # An object with details of the file version. - sig { params(id: String, name: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the file version. - id: nil, - # Name of the file version. - name: nil - ) - end - - sig { override.returns({ id: String, name: String }) } - def to_hash - end - end - end - end - end -end diff --git a/rbi/imagekit/models/files/metadata_from_url_response.rbi b/rbi/imagekit/models/files/metadata_from_url_response.rbi deleted file mode 100644 index d20408eb..00000000 --- a/rbi/imagekit/models/files/metadata_from_url_response.rbi +++ /dev/null @@ -1,289 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class MetadataFromURLResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataFromURLResponse, - Imagekit::Internal::AnyHash - ) - end - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # The density of the image in DPI. - sig { returns(T.nilable(Integer)) } - attr_reader :density - - sig { params(density: Integer).void } - attr_writer :density - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :duration - - sig do - returns( - T.nilable(Imagekit::Models::Files::MetadataFromURLResponse::Exif) - ) - end - attr_reader :exif - - sig do - params( - exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif::OrHash - ).void - end - attr_writer :exif - - # The format of the file (e.g., 'jpg', 'mp4'). - sig { returns(T.nilable(String)) } - attr_reader :format_ - - sig { params(format_: String).void } - attr_writer :format_ - - # Indicates if the image has a color profile. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_color_profile - - sig { params(has_color_profile: T::Boolean).void } - attr_writer :has_color_profile - - # Indicates if the image contains transparent areas. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_transparency - - sig { params(has_transparency: T::Boolean).void } - attr_writer :has_transparency - - # The height of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :height - - sig { params(height: Integer).void } - attr_writer :height - - # Perceptual hash of the image. - sig { returns(T.nilable(String)) } - attr_reader :p_hash - - sig { params(p_hash: String).void } - attr_writer :p_hash - - # The quality indicator of the image. - sig { returns(T.nilable(Integer)) } - attr_reader :quality - - sig { params(quality: Integer).void } - attr_writer :quality - - # The file size in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :size - - sig { params(size: Integer).void } - attr_writer :size - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # The width of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :width - - sig { params(width: Integer).void } - attr_writer :width - - # JSON object containing metadata. - sig do - params( - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: - Imagekit::Models::Files::MetadataFromURLResponse::Exif::OrHash, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - ).returns(T.attached_class) - end - def self.new( - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # The density of the image in DPI. - density: nil, - # The duration of the video in seconds (only for video). - duration: nil, - exif: nil, - # The format of the file (e.g., 'jpg', 'mp4'). - format_: nil, - # Indicates if the image has a color profile. - has_color_profile: nil, - # Indicates if the image contains transparent areas. - has_transparency: nil, - # The height of the image or video in pixels. - height: nil, - # Perceptual hash of the image. - p_hash: nil, - # The quality indicator of the image. - quality: nil, - # The file size in bytes. - size: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # The width of the image or video in pixels. - width: nil - ) - end - - sig do - override.returns( - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataFromURLResponse::Exif, - Imagekit::Internal::AnyHash - ) - end - - # Object containing Exif details. - sig { returns(T.nilable(Imagekit::ExifDetails)) } - attr_reader :exif - - sig { params(exif: Imagekit::ExifDetails::OrHash).void } - attr_writer :exif - - # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Gps)) } - attr_reader :gps - - sig { params(gps: Imagekit::Gps::OrHash).void } - attr_writer :gps - - # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::ExifImage)) } - attr_reader :image - - sig { params(image: Imagekit::ExifImage::OrHash).void } - attr_writer :image - - # JSON object. - sig { returns(T.nilable(Imagekit::Interoperability)) } - attr_reader :interoperability - - sig do - params(interoperability: Imagekit::Interoperability::OrHash).void - end - attr_writer :interoperability - - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :makernote - - sig { params(makernote: T::Hash[Symbol, T.anything]).void } - attr_writer :makernote - - # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Thumbnail)) } - attr_reader :thumbnail - - sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } - attr_writer :thumbnail - - sig do - params( - exif: Imagekit::ExifDetails::OrHash, - gps: Imagekit::Gps::OrHash, - image: Imagekit::ExifImage::OrHash, - interoperability: Imagekit::Interoperability::OrHash, - makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail::OrHash - ).returns(T.attached_class) - end - def self.new( - # Object containing Exif details. - exif: nil, - # Object containing GPS information. - gps: nil, - # Object containing EXIF image information. - image: nil, - # JSON object. - interoperability: nil, - makernote: nil, - # Object containing Thumbnail information. - thumbnail: nil - ) - end - - sig do - override.returns( - { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail - } - ) - end - def to_hash - end - end - end - end - end -end diff --git a/rbi/imagekit/models/files/metadata_from_url_params.rbi b/rbi/imagekit/models/files/metadata_get_from_url_params.rbi similarity index 88% rename from rbi/imagekit/models/files/metadata_from_url_params.rbi rename to rbi/imagekit/models/files/metadata_get_from_url_params.rbi index c0d403f0..b22de2f1 100644 --- a/rbi/imagekit/models/files/metadata_from_url_params.rbi +++ b/rbi/imagekit/models/files/metadata_get_from_url_params.rbi @@ -3,14 +3,14 @@ module Imagekit module Models module Files - class MetadataFromURLParams < Imagekit::Internal::Type::BaseModel + class MetadataGetFromURLParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::MetadataFromURLParams, + Imagekit::Files::MetadataGetFromURLParams, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/metadata_get_from_url_response.rbi b/rbi/imagekit/models/files/metadata_get_from_url_response.rbi new file mode 100644 index 00000000..197185d4 --- /dev/null +++ b/rbi/imagekit/models/files/metadata_get_from_url_response.rbi @@ -0,0 +1,892 @@ +# typed: strong + +module Imagekit + module Models + module Files + class MetadataGetFromURLResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse, + Imagekit::Internal::AnyHash + ) + end + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig do + returns( + T.nilable(Imagekit::Models::Files::MetadataGetFromURLResponse::Exif) + ) + end + attr_reader :exif + + sig do + params( + exif: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::OrHash + ).void + end + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # JSON object containing metadata. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, + Imagekit::Internal::AnyHash + ) + end + + # Object containing Exif details. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif + ) + ) + end + attr_reader :exif + + sig do + params( + exif: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif::OrHash + ).void + end + attr_writer :exif + + # Object containing GPS information. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps + ) + ) + end + attr_reader :gps + + sig do + params( + gps: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps::OrHash + ).void + end + attr_writer :gps + + # Object containing EXIF image information. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image + ) + ) + end + attr_reader :image + + sig do + params( + image: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image::OrHash + ).void + end + attr_writer :image + + # JSON object. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability + ) + ) + end + attr_reader :interoperability + + sig do + params( + interoperability: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability::OrHash + ).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + ) + ) + end + attr_reader :thumbnail + + sig do + params( + thumbnail: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail::OrHash + ).void + end + attr_writer :thumbnail + + sig do + params( + exif: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif::OrHash, + gps: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps::OrHash, + image: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image::OrHash, + interoperability: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + gps: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + image: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + interoperability: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns( + T.attached_class + ) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns( + { interop_index: String, interop_version: String } + ) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/purge_status_params.rbi b/rbi/imagekit/models/files/metadata_get_params.rbi similarity index 85% rename from rbi/imagekit/models/files/purge_status_params.rbi rename to rbi/imagekit/models/files/metadata_get_params.rbi index 54f3e40c..af5861ac 100644 --- a/rbi/imagekit/models/files/purge_status_params.rbi +++ b/rbi/imagekit/models/files/metadata_get_params.rbi @@ -3,14 +3,14 @@ module Imagekit module Models module Files - class PurgeStatusParams < Imagekit::Internal::Type::BaseModel + class MetadataGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::PurgeStatusParams, + Imagekit::Files::MetadataGetParams, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/metadata_get_response.rbi b/rbi/imagekit/models/files/metadata_get_response.rbi new file mode 100644 index 00000000..a1d5cf55 --- /dev/null +++ b/rbi/imagekit/models/files/metadata_get_response.rbi @@ -0,0 +1,884 @@ +# typed: strong + +module Imagekit + module Models + module Files + class MetadataGetResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse, + Imagekit::Internal::AnyHash + ) + end + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig do + returns(T.nilable(Imagekit::Models::Files::MetadataGetResponse::Exif)) + end + attr_reader :exif + + sig do + params( + exif: Imagekit::Models::Files::MetadataGetResponse::Exif::OrHash + ).void + end + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # JSON object containing metadata. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataGetResponse::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataGetResponse::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif, + Imagekit::Internal::AnyHash + ) + end + + # Object containing Exif details. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif + ) + ) + end + attr_reader :exif + + sig do + params( + exif: + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif::OrHash + ).void + end + attr_writer :exif + + # Object containing GPS information. + sig do + returns( + T.nilable(Imagekit::Models::Files::MetadataGetResponse::Exif::Gps) + ) + end + attr_reader :gps + + sig do + params( + gps: + Imagekit::Models::Files::MetadataGetResponse::Exif::Gps::OrHash + ).void + end + attr_writer :gps + + # Object containing EXIF image information. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetResponse::Exif::Image + ) + ) + end + attr_reader :image + + sig do + params( + image: + Imagekit::Models::Files::MetadataGetResponse::Exif::Image::OrHash + ).void + end + attr_writer :image + + # JSON object. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability + ) + ) + end + attr_reader :interoperability + + sig do + params( + interoperability: + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability::OrHash + ).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + ) + ) + end + attr_reader :thumbnail + + sig do + params( + thumbnail: + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail::OrHash + ).void + end + attr_writer :thumbnail + + sig do + params( + exif: + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif::OrHash, + gps: + Imagekit::Models::Files::MetadataGetResponse::Exif::Gps::OrHash, + image: + Imagekit::Models::Files::MetadataGetResponse::Exif::Image::OrHash, + interoperability: + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + image: + Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + interoperability: + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns( + T.attached_class + ) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns( + { interop_index: String, interop_version: String } + ) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end + end + end + end +end diff --git a/rbi/imagekit/models/files/metadata_retrieve_response.rbi b/rbi/imagekit/models/files/metadata_retrieve_response.rbi deleted file mode 100644 index 093668d6..00000000 --- a/rbi/imagekit/models/files/metadata_retrieve_response.rbi +++ /dev/null @@ -1,290 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class MetadataRetrieveResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataRetrieveResponse, - Imagekit::Internal::AnyHash - ) - end - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # The density of the image in DPI. - sig { returns(T.nilable(Integer)) } - attr_reader :density - - sig { params(density: Integer).void } - attr_writer :density - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :duration - - sig do - returns( - T.nilable(Imagekit::Models::Files::MetadataRetrieveResponse::Exif) - ) - end - attr_reader :exif - - sig do - params( - exif: - Imagekit::Models::Files::MetadataRetrieveResponse::Exif::OrHash - ).void - end - attr_writer :exif - - # The format of the file (e.g., 'jpg', 'mp4'). - sig { returns(T.nilable(String)) } - attr_reader :format_ - - sig { params(format_: String).void } - attr_writer :format_ - - # Indicates if the image has a color profile. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_color_profile - - sig { params(has_color_profile: T::Boolean).void } - attr_writer :has_color_profile - - # Indicates if the image contains transparent areas. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_transparency - - sig { params(has_transparency: T::Boolean).void } - attr_writer :has_transparency - - # The height of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :height - - sig { params(height: Integer).void } - attr_writer :height - - # Perceptual hash of the image. - sig { returns(T.nilable(String)) } - attr_reader :p_hash - - sig { params(p_hash: String).void } - attr_writer :p_hash - - # The quality indicator of the image. - sig { returns(T.nilable(Integer)) } - attr_reader :quality - - sig { params(quality: Integer).void } - attr_writer :quality - - # The file size in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :size - - sig { params(size: Integer).void } - attr_writer :size - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # The width of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :width - - sig { params(width: Integer).void } - attr_writer :width - - # JSON object containing metadata. - sig do - params( - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: - Imagekit::Models::Files::MetadataRetrieveResponse::Exif::OrHash, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - ).returns(T.attached_class) - end - def self.new( - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # The density of the image in DPI. - density: nil, - # The duration of the video in seconds (only for video). - duration: nil, - exif: nil, - # The format of the file (e.g., 'jpg', 'mp4'). - format_: nil, - # Indicates if the image has a color profile. - has_color_profile: nil, - # Indicates if the image contains transparent areas. - has_transparency: nil, - # The height of the image or video in pixels. - height: nil, - # Perceptual hash of the image. - p_hash: nil, - # The quality indicator of the image. - quality: nil, - # The file size in bytes. - size: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # The width of the image or video in pixels. - width: nil - ) - end - - sig do - override.returns( - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataRetrieveResponse::Exif, - Imagekit::Internal::AnyHash - ) - end - - # Object containing Exif details. - sig { returns(T.nilable(Imagekit::ExifDetails)) } - attr_reader :exif - - sig { params(exif: Imagekit::ExifDetails::OrHash).void } - attr_writer :exif - - # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Gps)) } - attr_reader :gps - - sig { params(gps: Imagekit::Gps::OrHash).void } - attr_writer :gps - - # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::ExifImage)) } - attr_reader :image - - sig { params(image: Imagekit::ExifImage::OrHash).void } - attr_writer :image - - # JSON object. - sig { returns(T.nilable(Imagekit::Interoperability)) } - attr_reader :interoperability - - sig do - params(interoperability: Imagekit::Interoperability::OrHash).void - end - attr_writer :interoperability - - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :makernote - - sig { params(makernote: T::Hash[Symbol, T.anything]).void } - attr_writer :makernote - - # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Thumbnail)) } - attr_reader :thumbnail - - sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } - attr_writer :thumbnail - - sig do - params( - exif: Imagekit::ExifDetails::OrHash, - gps: Imagekit::Gps::OrHash, - image: Imagekit::ExifImage::OrHash, - interoperability: Imagekit::Interoperability::OrHash, - makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail::OrHash - ).returns(T.attached_class) - end - def self.new( - # Object containing Exif details. - exif: nil, - # Object containing GPS information. - gps: nil, - # Object containing EXIF image information. - image: nil, - # JSON object. - interoperability: nil, - makernote: nil, - # Object containing Thumbnail information. - thumbnail: nil - ) - end - - sig do - override.returns( - { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail - } - ) - end - def to_hash - end - end - end - end - end -end diff --git a/rbi/imagekit/models/files/version_retrieve_params.rbi b/rbi/imagekit/models/files/version_get_params.rbi similarity index 86% rename from rbi/imagekit/models/files/version_retrieve_params.rbi rename to rbi/imagekit/models/files/version_get_params.rbi index b5d6b948..107a03d0 100644 --- a/rbi/imagekit/models/files/version_retrieve_params.rbi +++ b/rbi/imagekit/models/files/version_get_params.rbi @@ -3,14 +3,14 @@ module Imagekit module Models module Files - class VersionRetrieveParams < Imagekit::Internal::Type::BaseModel + class VersionGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::VersionRetrieveParams, + Imagekit::Files::VersionGetParams, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/detail_retrieve_response.rbi b/rbi/imagekit/models/files/version_get_response.rbi similarity index 92% rename from rbi/imagekit/models/files/detail_retrieve_response.rbi rename to rbi/imagekit/models/files/version_get_response.rbi index 61a87012..ce4781b3 100644 --- a/rbi/imagekit/models/files/detail_retrieve_response.rbi +++ b/rbi/imagekit/models/files/version_get_response.rbi @@ -3,11 +3,11 @@ module Imagekit module Models module Files - class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel + class VersionGetResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::DetailRetrieveResponse, + Imagekit::Models::Files::VersionGetResponse, Imagekit::Internal::AnyHash ) end @@ -16,7 +16,7 @@ module Imagekit sig do returns( T.nilable( - T::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag] + T::Array[Imagekit::Models::Files::VersionGetResponse::AITag] ) ) end @@ -152,9 +152,7 @@ module Imagekit # An object with details of the file version. sig do returns( - T.nilable( - Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo - ) + T.nilable(Imagekit::Models::Files::VersionGetResponse::VersionInfo) ) end attr_reader :version_info @@ -162,7 +160,7 @@ module Imagekit sig do params( version_info: - Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo::OrHash + Imagekit::Models::Files::VersionGetResponse::VersionInfo::OrHash ).void end attr_writer :version_info @@ -180,7 +178,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::Models::Files::DetailRetrieveResponse::AITag::OrHash + Imagekit::Models::Files::VersionGetResponse::AITag::OrHash ] ), created_at: String, @@ -202,7 +200,7 @@ module Imagekit updated_at: String, url: String, version_info: - Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo::OrHash, + Imagekit::Models::Files::VersionGetResponse::VersionInfo::OrHash, width: Float ).returns(T.attached_class) end @@ -264,9 +262,7 @@ module Imagekit { ai_tags: T.nilable( - T::Array[ - Imagekit::Models::Files::DetailRetrieveResponse::AITag - ] + T::Array[Imagekit::Models::Files::VersionGetResponse::AITag] ), created_at: String, custom_coordinates: T.nilable(String), @@ -287,7 +283,7 @@ module Imagekit updated_at: String, url: String, version_info: - Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + Imagekit::Models::Files::VersionGetResponse::VersionInfo, width: Float } ) @@ -299,7 +295,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Files::DetailRetrieveResponse::AITag, + Imagekit::Models::Files::VersionGetResponse::AITag, Imagekit::Internal::AnyHash ) end @@ -355,7 +351,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + Imagekit::Models::Files::VersionGetResponse::VersionInfo, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/bulk_job_copy_folder_params.rbi b/rbi/imagekit/models/folder_copy_params.rbi similarity index 93% rename from rbi/imagekit/models/bulk_job_copy_folder_params.rbi rename to rbi/imagekit/models/folder_copy_params.rbi index 79256fbb..b73945bc 100644 --- a/rbi/imagekit/models/bulk_job_copy_folder_params.rbi +++ b/rbi/imagekit/models/folder_copy_params.rbi @@ -2,13 +2,13 @@ module Imagekit module Models - class BulkJobCopyFolderParams < Imagekit::Internal::Type::BaseModel + class FolderCopyParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::BulkJobCopyFolderParams, Imagekit::Internal::AnyHash) + T.any(Imagekit::FolderCopyParams, Imagekit::Internal::AnyHash) end # Full path to the destination folder where you want to copy the source folder diff --git a/rbi/imagekit/models/bulk_job_copy_folder_response.rbi b/rbi/imagekit/models/folder_copy_response.rbi similarity index 84% rename from rbi/imagekit/models/bulk_job_copy_folder_response.rbi rename to rbi/imagekit/models/folder_copy_response.rbi index d1c906f2..71c01b2d 100644 --- a/rbi/imagekit/models/bulk_job_copy_folder_response.rbi +++ b/rbi/imagekit/models/folder_copy_response.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class BulkJobCopyFolderResponse < Imagekit::Internal::Type::BaseModel + class FolderCopyResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::BulkJobCopyFolderResponse, + Imagekit::Models::FolderCopyResponse, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/bulk_job_move_folder_params.rbi b/rbi/imagekit/models/folder_move_params.rbi similarity index 89% rename from rbi/imagekit/models/bulk_job_move_folder_params.rbi rename to rbi/imagekit/models/folder_move_params.rbi index 048ceb4f..c8bb4036 100644 --- a/rbi/imagekit/models/bulk_job_move_folder_params.rbi +++ b/rbi/imagekit/models/folder_move_params.rbi @@ -2,13 +2,13 @@ module Imagekit module Models - class BulkJobMoveFolderParams < Imagekit::Internal::Type::BaseModel + class FolderMoveParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::BulkJobMoveFolderParams, Imagekit::Internal::AnyHash) + T.any(Imagekit::FolderMoveParams, Imagekit::Internal::AnyHash) end # Full path to the destination folder where you want to move the source folder diff --git a/rbi/imagekit/models/bulk_job_move_folder_response.rbi b/rbi/imagekit/models/folder_move_response.rbi similarity index 84% rename from rbi/imagekit/models/bulk_job_move_folder_response.rbi rename to rbi/imagekit/models/folder_move_response.rbi index 21984d3f..a28a2310 100644 --- a/rbi/imagekit/models/bulk_job_move_folder_response.rbi +++ b/rbi/imagekit/models/folder_move_response.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class BulkJobMoveFolderResponse < Imagekit::Internal::Type::BaseModel + class FolderMoveResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::BulkJobMoveFolderResponse, + Imagekit::Models::FolderMoveResponse, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/folder_rename_params.rbi b/rbi/imagekit/models/folder_rename_params.rbi new file mode 100644 index 00000000..3de0ef79 --- /dev/null +++ b/rbi/imagekit/models/folder_rename_params.rbi @@ -0,0 +1,98 @@ +# typed: strong + +module Imagekit + module Models + class FolderRenameParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::FolderRenameParams, Imagekit::Internal::AnyHash) + end + + # The full path to the folder you want to rename. + sig { returns(String) } + attr_accessor :folder_path + + # 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. `_`. + sig { returns(String) } + attr_accessor :new_folder_name + + # 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` + sig { returns(T.nilable(T::Boolean)) } + attr_reader :purge_cache + + sig { params(purge_cache: T::Boolean).void } + attr_writer :purge_cache + + sig do + params( + folder_path: String, + new_folder_name: String, + purge_cache: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # The full path to the folder you want to rename. + folder_path:, + # 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. `_`. + new_folder_name:, + # 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` + purge_cache: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + folder_path: String, + new_folder_name: String, + purge_cache: T::Boolean, + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/folder_rename_response.rbi b/rbi/imagekit/models/folder_rename_response.rbi new file mode 100644 index 00000000..fd47a6a3 --- /dev/null +++ b/rbi/imagekit/models/folder_rename_response.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Imagekit + module Models + class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FolderRenameResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + sig { returns(T.nilable(String)) } + attr_reader :job_id + + sig { params(job_id: String).void } + attr_writer :job_id + + sig { params(job_id: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + job_id: nil + ) + end + + sig { override.returns({ job_id: String }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/folders/job_get_params.rbi b/rbi/imagekit/models/folders/job_get_params.rbi new file mode 100644 index 00000000..5dc84db4 --- /dev/null +++ b/rbi/imagekit/models/folders/job_get_params.rbi @@ -0,0 +1,29 @@ +# typed: strong + +module Imagekit + module Models + module Folders + class JobGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::Folders::JobGetParams, Imagekit::Internal::AnyHash) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/folders/job_get_response.rbi b/rbi/imagekit/models/folders/job_get_response.rbi new file mode 100644 index 00000000..506b7482 --- /dev/null +++ b/rbi/imagekit/models/folders/job_get_response.rbi @@ -0,0 +1,82 @@ +# typed: strong + +module Imagekit + module Models + module Folders + class JobGetResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Folders::JobGetResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the bulk job. + sig { returns(T.nilable(String)) } + attr_reader :job_id + + sig { params(job_id: String).void } + attr_writer :job_id + + # Unique identifier of the purge request. This will be present only if + # `purgeCache` is set to `true` in the rename folder API request. + sig { returns(T.nilable(String)) } + attr_reader :purge_request_id + + sig { params(purge_request_id: String).void } + attr_writer :purge_request_id + + # Status of the bulk job. Possible values - `Pending`, `Completed`. + sig { returns(T.nilable(String)) } + attr_reader :status + + sig { params(status: String).void } + attr_writer :status + + # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`, + # `RENAME_FOLDER`. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + sig do + params( + job_id: String, + purge_request_id: String, + status: String, + type: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier of the bulk job. + job_id: nil, + # Unique identifier of the purge request. This will be present only if + # `purgeCache` is set to `true` in the rename folder API request. + purge_request_id: nil, + # Status of the bulk job. Possible values - `Pending`, `Completed`. + status: nil, + # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`, + # `RENAME_FOLDER`. + type: nil + ) + end + + sig do + override.returns( + { + job_id: String, + purge_request_id: String, + status: String, + type: String + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/gps.rbi b/rbi/imagekit/models/gps.rbi deleted file mode 100644 index 57931ca6..00000000 --- a/rbi/imagekit/models/gps.rbi +++ /dev/null @@ -1,27 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias { T.any(Imagekit::Gps, Imagekit::Internal::AnyHash) } - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns(T.attached_class) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/interoperability.rbi b/rbi/imagekit/models/interoperability.rbi deleted file mode 100644 index 69123b0b..00000000 --- a/rbi/imagekit/models/interoperability.rbi +++ /dev/null @@ -1,39 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::Interoperability, Imagekit::Internal::AnyHash) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params(interop_index: String, interop_version: String).returns( - T.attached_class - ) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns({ interop_index: String, interop_version: String }) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/thumbnail.rbi b/rbi/imagekit/models/thumbnail.rbi deleted file mode 100644 index e35978ae..00000000 --- a/rbi/imagekit/models/thumbnail.rbi +++ /dev/null @@ -1,82 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias { T.any(Imagekit::Thumbnail, Imagekit::Internal::AnyHash) } - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/resources/accounts.rbi b/rbi/imagekit/resources/accounts.rbi index 4b2834bb..6a50dd49 100644 --- a/rbi/imagekit/resources/accounts.rbi +++ b/rbi/imagekit/resources/accounts.rbi @@ -3,27 +3,14 @@ module Imagekit module Resources class Accounts - # 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. - sig do - params( - end_date: Date, - start_date: Date, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::AccountGetUsageResponse) - end - def get_usage( - # 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. - end_date:, - # 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. - start_date:, - request_options: {} - ) - end + sig { returns(Imagekit::Resources::Accounts::Usage) } + attr_reader :usage + + sig { returns(Imagekit::Resources::Accounts::Origins) } + attr_reader :origins + + sig { returns(Imagekit::Resources::Accounts::URLEndpoints) } + attr_reader :url_endpoints # @api private sig { params(client: Imagekit::Client).returns(T.attached_class) } diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi new file mode 100644 index 00000000..73b6f746 --- /dev/null +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -0,0 +1,197 @@ +# typed: strong + +module Imagekit + module Resources + class Accounts + class Origins + # **Note:** This API is currently in beta. + # Creates a new origin and returns the origin object. + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + forward_host_header_to_origin: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Accounts::OriginCreateResponse::Variants) + end + def create( + # Access key for the bucket. + access_key:, + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + type:, + # Custom S3-compatible endpoint. + endpoint:, + # Akeneo instance base URL. + base_url:, + client_email:, + private_key:, + account_name:, + container:, + sas_token:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + request_options: {} + ) + end + + # **Note:** This API is currently in beta. + # Updates the origin identified by `id` and returns the updated origin object. + sig do + params( + id: String, + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + forward_host_header_to_origin: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Accounts::OriginUpdateResponse::Variants) + end + def update( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id, + # Access key for the bucket. + access_key:, + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + type:, + # Custom S3-compatible endpoint. + endpoint:, + # Akeneo instance base URL. + base_url:, + client_email:, + private_key:, + account_name:, + container:, + sas_token:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + request_options: {} + ) + end + + # **Note:** This API is currently in beta. + # Returns an array of all configured origins for the current account. + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T::Array[ + Imagekit::Models::Accounts::OriginListResponseItem::Variants + ] + ) + end + def list(request_options: {}) + end + + # **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. + sig do + params( + id: String, + request_options: Imagekit::RequestOptions::OrHash + ).void + end + def delete( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id, + request_options: {} + ) + end + + # **Note:** This API is currently in beta. + # Retrieves the origin identified by `id`. + sig do + params( + id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Accounts::OriginGetResponse::Variants) + end + def get( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/accounts/url_endpoints.rbi b/rbi/imagekit/resources/accounts/url_endpoints.rbi new file mode 100644 index 00000000..2a0a81f1 --- /dev/null +++ b/rbi/imagekit/resources/accounts/url_endpoints.rbi @@ -0,0 +1,129 @@ +# typed: strong + +module Imagekit + module Resources + class Accounts + class URLEndpoints + # **Note:** This API is currently in beta. + # Creates a new URL‑endpoint and returns the resulting object. + sig do + params( + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Accounts::URLEndpointCreateResponse) + end + def create( + # Description of the URL endpoint. + 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. + origins: nil, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix: nil, + # Configuration for third-party URL rewriting. + url_rewriter: nil, + request_options: {} + ) + end + + # **Note:** This API is currently in beta. + # Updates the URL‑endpoint identified by `id` and returns the updated object. + sig do + params( + id: String, + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Accounts::URLEndpointUpdateResponse) + end + def update( + # 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`. + id, + # Description of the URL endpoint. + 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. + origins: nil, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix: nil, + # Configuration for third-party URL rewriting. + url_rewriter: nil, + request_options: {} + ) + end + + # **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. + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem] + ) + end + def list(request_options: {}) + end + + # **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. + sig do + params( + id: String, + request_options: Imagekit::RequestOptions::OrHash + ).void + end + def delete( + # 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`. + id, + request_options: {} + ) + end + + # **Note:** This API is currently in beta. + # Retrieves the URL‑endpoint identified by `id`. + sig do + params( + id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Accounts::URLEndpointGetResponse) + end + def get( + # 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`. + id, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/accounts/usage.rbi b/rbi/imagekit/resources/accounts/usage.rbi new file mode 100644 index 00000000..9efefba7 --- /dev/null +++ b/rbi/imagekit/resources/accounts/usage.rbi @@ -0,0 +1,36 @@ +# typed: strong + +module Imagekit + module Resources + class Accounts + class Usage + # 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. + sig do + params( + end_date: Date, + start_date: Date, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Accounts::UsageGetResponse) + end + def get( + # 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. + end_date:, + # 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. + start_date:, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/assets.rbi b/rbi/imagekit/resources/assets.rbi new file mode 100644 index 00000000..52e5efc0 --- /dev/null +++ b/rbi/imagekit/resources/assets.rbi @@ -0,0 +1,74 @@ +# typed: strong + +module Imagekit + module Resources + class Assets + # 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`. + sig do + params( + file_type: Imagekit::AssetListParams::FileType::OrSymbol, + limit: Integer, + path: String, + search_query: String, + skip: Integer, + sort: Imagekit::AssetListParams::Sort::OrSymbol, + type: Imagekit::AssetListParams::Type::OrSymbol, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T::Array[Imagekit::Models::AssetListResponseItem::Variants]) + end + def list( + # 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) + file_type: nil, + # The maximum number of results to return in response. + limit: nil, + # 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. + path: nil, + # 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. + search_query: nil, + # The number of results to skip before returning results. + skip: nil, + # Sort the results by one of the supported fields in ascending or descending + # order. + sort: nil, + # 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`) + type: nil, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/beta.rbi b/rbi/imagekit/resources/beta.rbi new file mode 100644 index 00000000..6accb5af --- /dev/null +++ b/rbi/imagekit/resources/beta.rbi @@ -0,0 +1,15 @@ +# typed: strong + +module Imagekit + module Resources + class Beta + sig { returns(Imagekit::Resources::Beta::V2) } + attr_reader :v2 + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/beta/v2.rbi b/rbi/imagekit/resources/beta/v2.rbi new file mode 100644 index 00000000..829675dc --- /dev/null +++ b/rbi/imagekit/resources/beta/v2.rbi @@ -0,0 +1,17 @@ +# typed: strong + +module Imagekit + module Resources + class Beta + class V2 + sig { returns(Imagekit::Resources::Beta::V2::Files) } + attr_reader :files + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekit/resources/beta/v2/files.rbi new file mode 100644 index 00000000..cf3cca05 --- /dev/null +++ b/rbi/imagekit/resources/beta/v2/files.rbi @@ -0,0 +1,193 @@ +# typed: strong + +module Imagekit + module Resources + class Beta + class V2 + class Files + # 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. + # + # **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. + sig do + params( + file: Imagekit::Internal::FileInput, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + ) + ], + folder: String, + is_private_file: T::Boolean, + is_published: T::Boolean, + overwrite_ai_tags: T::Boolean, + overwrite_custom_metadata: T::Boolean, + overwrite_file: T::Boolean, + overwrite_tags: T::Boolean, + response_fields: + T::Array[ + Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + ], + tags: T::Array[String], + transformation: + Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash, + use_unique_file_name: T::Boolean, + webhook_url: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Beta::V2::FileUploadResponse) + end + def upload( + # 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. + file:, + # The name with which the file has to be uploaded. + file_name:, + # 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. + token: nil, + # 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). + checks: nil, + # 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. + custom_coordinates: nil, + # JSON key-value pairs to associate with the asset. Create the custom metadata + # fields before setting these values. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the image. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + folder: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # 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. + overwrite_ai_tags: nil, + # If the request does not have `customMetadata`, and a file already exists at the + # exact location, existing customMetadata will be removed. + overwrite_custom_metadata: nil, + # If `false` and `useUniqueFileName` is also `false`, and a file already exists at + # the exact location, upload API will return an error immediately. + overwrite_file: nil, + # If the request does not have `tags`, and a file already exists at the exact + # location, existing tags will be removed. + overwrite_tags: nil, + # Array of response field keys to include in the API response body. + response_fields: nil, + # 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. + tags: nil, + # 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. + transformation: nil, + # 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. + use_unique_file_name: nil, + # 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. + webhook_url: nil, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end + end +end diff --git a/rbi/imagekit/resources/bulk_jobs.rbi b/rbi/imagekit/resources/bulk_jobs.rbi deleted file mode 100644 index 66a96c6e..00000000 --- a/rbi/imagekit/resources/bulk_jobs.rbi +++ /dev/null @@ -1,75 +0,0 @@ -# typed: strong - -module Imagekit - module Resources - class BulkJobs - # 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. - sig do - params( - destination_path: String, - source_folder_path: String, - include_versions: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::BulkJobCopyFolderResponse) - end - def copy_folder( - # Full path to the destination folder where you want to copy the source folder - # into. - destination_path:, - # The full path to the source folder you want to copy. - source_folder_path:, - # 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`. - include_versions: nil, - request_options: {} - ) - end - - # 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. - sig do - params( - destination_path: String, - source_folder_path: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::BulkJobMoveFolderResponse) - end - def move_folder( - # Full path to the destination folder where you want to move the source folder - # into. - destination_path:, - # The full path to the source folder you want to move. - source_folder_path:, - request_options: {} - ) - end - - # This API returns the status of a bulk job like copy and move folder operations. - sig do - params( - job_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::BulkJobRetrieveStatusResponse) - end - def retrieve_status( - # The `jobId` is returned in the response of bulk job API e.g. copy folder or move - # folder API. - job_id, - request_options: {} - ) - end - - # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } - def self.new(client:) - end - end - end -end diff --git a/rbi/imagekit/resources/cache.rbi b/rbi/imagekit/resources/cache.rbi new file mode 100644 index 00000000..5d9aa111 --- /dev/null +++ b/rbi/imagekit/resources/cache.rbi @@ -0,0 +1,15 @@ +# typed: strong + +module Imagekit + module Resources + class Cache + sig { returns(Imagekit::Resources::Cache::Invalidation) } + attr_reader :invalidation + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/files/purge.rbi b/rbi/imagekit/resources/cache/invalidation.rbi similarity index 81% rename from rbi/imagekit/resources/files/purge.rbi rename to rbi/imagekit/resources/cache/invalidation.rbi index 8c196172..e0aa6e8b 100644 --- a/rbi/imagekit/resources/files/purge.rbi +++ b/rbi/imagekit/resources/cache/invalidation.rbi @@ -2,8 +2,8 @@ module Imagekit module Resources - class Files - class Purge + class Cache + class Invalidation # 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. @@ -11,9 +11,9 @@ module Imagekit params( url: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::PurgeExecuteResponse) + ).returns(Imagekit::Models::Cache::InvalidationCreateResponse) end - def execute( + def create( # The full URL of the file to be purged. url:, request_options: {} @@ -25,9 +25,9 @@ module Imagekit params( request_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::PurgeStatusResponse) + ).returns(Imagekit::Models::Cache::InvalidationGetResponse) end - def status( + def get( # Should be a valid requestId. request_id, request_options: {} diff --git a/rbi/imagekit/resources/custom_metadata_fields.rbi b/rbi/imagekit/resources/custom_metadata_fields.rbi index bd07c8e6..379a0884 100644 --- a/rbi/imagekit/resources/custom_metadata_fields.rbi +++ b/rbi/imagekit/resources/custom_metadata_fields.rbi @@ -67,8 +67,7 @@ module Imagekit ) end def list( - # Set it to `true` to include deleted field objects in the API response. Default - # value is `false`. + # Set it to `true` to include deleted field objects in the API response. include_deleted: nil, request_options: {} ) diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 47c0541c..f704d5bc 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -3,92 +3,78 @@ module Imagekit module Resources class Files - sig { returns(Imagekit::Resources::Files::Details) } - attr_reader :details - - sig { returns(Imagekit::Resources::Files::Batch) } - attr_reader :batch + sig { returns(Imagekit::Resources::Files::Bulk) } + attr_reader :bulk sig { returns(Imagekit::Resources::Files::Versions) } attr_reader :versions - sig { returns(Imagekit::Resources::Files::Purge) } - attr_reader :purge - sig { returns(Imagekit::Resources::Files::Metadata) } attr_reader :metadata - # 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`. + # 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. sig do params( - file_type: String, - limit: String, - path: String, - search_query: String, - skip: String, - sort: String, - type: Imagekit::FileListParams::Type::OrSymbol, + file_id: String, + custom_coordinates: T.nilable(String), + custom_metadata: T.anything, + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + ) + ], + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish::OrHash, request_options: Imagekit::RequestOptions::OrHash - ).returns(T::Array[Imagekit::Models::FileListResponseItem]) + ).returns(Imagekit::Models::FileUpdateResponse) end - def list( - # Type of files to include in the result set. Accepts three values: - # - # `all` - include all types of files in the result set. `image` - only search in - # image type files. `non-image` - only search in files that are not images, e.g., - # JS or CSS or video files. - # - # Default value - `all` - file_type: nil, - # The maximum number of results to return in response: - # - # Minimum value - 1 - # - # Maximum value - 1000 - # - # Default value - 1000 - limit: nil, - # Folder path if you want to limit the search within a specific folder. For - # example, `/sales-banner/` will only search in folder sales-banner. - path: nil, - # 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. - search_query: nil, - # The number of results to skip before returning results: - # - # Minimum value - 0 - # - # Default value - 0 - skip: nil, - # You can sort based on the following fields: - # - # 1. name - `ASC_NAME` or `DESC_NAME` - # 2. createdAt - `ASC_CREATED` or `DESC_CREATED` - # 3. updatedAt - `ASC_UPDATED` or `DESC_UPDATED` - # 4. height - `ASC_HEIGHT` or `DESC_HEIGHT` - # 5. width - `ASC_WIDTH` or `DESC_WIDTH` - # 6. size - `ASC_SIZE` or `DESC_SIZE` + def update( + # The unique `fileId` of the uploaded file. `fileId` is returned in list and + # search assets API and upload API. + file_id, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # An array of AITags associated with the file that you want to remove, e.g. + # `["car", "vehicle", "motorsports"]`. # - # Default value - `ASC_CREATED` - sort: nil, - # Limit search to one of `file`, `file-version`, or `folder`. Pass `all` to - # include `files` and `folders` in search results (`file-version` will not be - # included in this case). + # If you want to remove all AITags associated with the file, send a string - + # "all". # - # Default value - `file` - type: nil, + # Note: The remove operation for `AITags` executes before any of the `extensions` + # are processed. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, + # Configure the publication status of a file and its versions. + publish: nil, request_options: {} ) end @@ -112,24 +98,6 @@ module Imagekit ) end - # This API adds tags to multiple files in bulk. A maximum of 50 files can be - # specified at a time. - sig do - params( - file_ids: T::Array[String], - tags: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileAddTagsResponse) - end - def add_tags( - # An array of fileIds to which you want to add tags. - file_ids:, - # An array of tags that you want to add to the files. - tags:, - request_options: {} - ) - end - # 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 @@ -156,6 +124,22 @@ module Imagekit ) end + # This API returns an object with details or attributes about the current version + # of the file. + sig do + params( + file_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FileGetResponse) + end + def get( + # The unique `fileId` of the uploaded file. `fileId` is returned in the list and + # search assets API and upload API. + file_id, + request_options: {} + ) + end + # 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 @@ -176,42 +160,6 @@ module Imagekit ) end - # This API removes AITags from multiple files in bulk. A maximum of 50 files can - # be specified at a time. - sig do - params( - ai_tags: T::Array[String], - file_ids: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileRemoveAITagsResponse) - end - def remove_ai_tags( - # An array of AITags that you want to remove from the files. - ai_tags:, - # An array of fileIds from which you want to remove AITags. - file_ids:, - request_options: {} - ) - end - - # This API removes tags from multiple files in bulk. A maximum of 50 files can be - # specified at a time. - sig do - params( - file_ids: T::Array[String], - tags: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileRemoveTagsResponse) - end - def remove_tags( - # An array of fileIds from which you want to remove tags. - file_ids:, - # An array of tags that you want to remove from the files. - tags:, - request_options: {} - ) - end - # 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. # @@ -285,41 +233,50 @@ module Imagekit # technologies. sig do params( - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, custom_coordinates: String, - custom_metadata: String, - expire: String, - extensions: String, + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + expire: Integer, + extensions: + T::Array[ + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + ) + ], folder: String, - is_private_file: - Imagekit::FileUploadV1Params::IsPrivateFile::OrSymbol, - is_published: Imagekit::FileUploadV1Params::IsPublished::OrSymbol, - overwrite_ai_tags: - Imagekit::FileUploadV1Params::OverwriteAITags::OrSymbol, - overwrite_custom_metadata: - Imagekit::FileUploadV1Params::OverwriteCustomMetadata::OrSymbol, - overwrite_file: String, - overwrite_tags: Imagekit::FileUploadV1Params::OverwriteTags::OrSymbol, + is_private_file: T::Boolean, + is_published: T::Boolean, + overwrite_ai_tags: T::Boolean, + overwrite_custom_metadata: T::Boolean, + overwrite_file: T::Boolean, + overwrite_tags: T::Boolean, public_key: String, - response_fields: String, + response_fields: + T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], signature: String, - tags: String, - transformation: String, - use_unique_file_name: - Imagekit::FileUploadV1Params::UseUniqueFileName::OrSymbol, + tags: T::Array[String], + transformation: Imagekit::FileUploadParams::Transformation::OrHash, + use_unique_file_name: T::Boolean, webhook_url: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileUploadV1Response) + ).returns(Imagekit::Models::FileUploadResponse) end - def upload_v1( - # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, - # please ensure that our servers can access the URL. In case ImageKit is unable to - # download the file from the specified URL, a `400` error response is returned. - # This will also result in a `400` error if the file download request is aborted - # if response headers are not received in 8 seconds. + def upload( + # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # @@ -350,16 +307,18 @@ module Imagekit # - If this field is not specified and the file is overwritten, then # customCoordinates will be removed. custom_coordinates: nil, - # Stringified JSON key-value data to be associated with the asset. + # JSON key-value pairs to associate with the asset. Create the custom metadata + # fields before setting these values. custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, # 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. expire: nil, - # Stringified JSON object with an array of extensions to be applied to the image. - # Refer to extensions schema in - # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). + # Array of extensions to be applied to the image. Each extension can be configured + # with specific parameters based on the extension type. extensions: nil, # 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. @@ -400,15 +359,7 @@ module Imagekit # Your ImageKit.io public key. This field is only required for authentication when # uploading a file from the client side. public_key: nil, - # Comma-separated values of the fields that you want the API to return in the - # response. - # - # For example, set the value of this field to - # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, - # `customCoordinates`, and `isPrivateFile` in the response. - # - # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, - # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. + # Array of response field keys to include in the API response body. response_fields: nil, # 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 @@ -417,209 +368,22 @@ module Imagekit # Signature must be calculated on the server-side. This field is only required for # authentication when uploading a file from the client side. signature: nil, - # Set the tags while uploading the file. - # - # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length - # of all characters should not exceed 500. `%` is not allowed. - # - # If this field is not specified and the file is overwritten then the tags will be - # removed. - tags: nil, - # Stringified JSON object with properties for pre and post transformations: - # - # `pre` - Accepts a "string" containing a valid transformation used for requesting - # a pre-transformation for an image or a video file. - # - # `post` - Accepts an array of objects with properties: - # - # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` - # (Adaptive bitrate streaming). - # - `value`: A "string" corresponding to the required transformation. Required if - # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or - # `thumbnail`. - # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. - # - # Read more about - # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). - transformation: nil, - # 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. - use_unique_file_name: nil, - # 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. - webhook_url: nil, - request_options: {} - ) - end - - # 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. - # - # **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. - sig do - params( - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - extensions: String, - folder: String, - is_private_file: - Imagekit::FileUploadV2Params::IsPrivateFile::OrSymbol, - is_published: Imagekit::FileUploadV2Params::IsPublished::OrSymbol, - overwrite_ai_tags: - Imagekit::FileUploadV2Params::OverwriteAITags::OrSymbol, - overwrite_custom_metadata: - Imagekit::FileUploadV2Params::OverwriteCustomMetadata::OrSymbol, - overwrite_file: String, - overwrite_tags: Imagekit::FileUploadV2Params::OverwriteTags::OrSymbol, - response_fields: String, - tags: String, - transformation: String, - use_unique_file_name: - Imagekit::FileUploadV2Params::UseUniqueFileName::OrSymbol, - webhook_url: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileUploadV2Response) - end - def upload_v2( - # Pass the HTTP URL or base64 string. When passing a URL in the file parameter, - # please ensure that our servers can access the URL. In case ImageKit is unable to - # download the file from the specified URL, a `400` error response is returned. - # This will also result in a `400` error if the file download request is aborted - # if response headers are not received in 8 seconds. - file:, - # The name with which the file has to be uploaded. - file_name:, - # 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. - token: nil, - # 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). - checks: nil, - # 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. - custom_coordinates: nil, - # Stringified JSON key-value data to be associated with the asset. - custom_metadata: nil, - # Stringified JSON object with an array of extensions to be applied to the image. - # Refer to extensions schema in - # [update file API request body](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#request-body). - extensions: nil, - # 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. - folder: nil, - # 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. - is_private_file: nil, - # 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. - is_published: nil, - # 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. - overwrite_ai_tags: nil, - # If the request does not have `customMetadata`, and a file already exists at the - # exact location, existing customMetadata will be removed. - overwrite_custom_metadata: nil, - # If `false` and `useUniqueFileName` is also `false`, and a file already exists at - # the exact location, upload API will return an error immediately. - overwrite_file: nil, - # If the request does not have `tags`, and a file already exists at the exact - # location, existing tags will be removed. - overwrite_tags: nil, - # Comma-separated values of the fields that you want the API to return in the - # response. - # - # For example, set the value of this field to - # `tags,customCoordinates,isPrivateFile` to get the value of `tags`, - # `customCoordinates`, and `isPrivateFile` in the response. - # - # Accepts combination of `tags`, `customCoordinates`, `isPrivateFile`, - # `embeddedMetadata`, `isPublished`, `customMetadata`, and `metadata`. - response_fields: nil, - # Set the tags while uploading the file. - # - # Comma-separated value of tags in the format `tag1,tag2,tag3`. The maximum length - # of all characters should not exceed 500. `%` is not allowed. - # - # If this field is not specified and the file is overwritten then the tags will be - # removed. + # 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. tags: nil, - # Stringified JSON object with properties for pre and post transformations: - # - # `pre` - Accepts a "string" containing a valid transformation used for requesting - # a pre-transformation for an image or a video file. + # Configure pre-processing (`pre`) and post-processing (`post`) transformations. # - # `post` - Accepts an array of objects with properties: + # - `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). # - # - `type`: One of `transformation`, `gif-to-video`, `thumbnail`, or `abs` - # (Adaptive bitrate streaming). - # - `value`: A "string" corresponding to the required transformation. Required if - # `type` is `transformation` or `abs`. Optional if `type` is `gif-to-video` or - # `thumbnail`. - # - `protocol`: Either `hls` or `dash`, applicable only if `type` is `abs`. + # - `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. # - # Read more about - # [Adaptive bitrate streaming (ABS)](/docs/adaptive-bitrate-streaming). + # You can mix and match any combination of post-processing types. transformation: nil, # Whether to use a unique filename for this file or not. # diff --git a/rbi/imagekit/resources/files/batch.rbi b/rbi/imagekit/resources/files/batch.rbi deleted file mode 100644 index 684f97dd..00000000 --- a/rbi/imagekit/resources/files/batch.rbi +++ /dev/null @@ -1,34 +0,0 @@ -# typed: strong - -module Imagekit - module Resources - class Files - class Batch - # 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. - sig do - params( - file_ids: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::BatchDeleteResponse) - end - def delete( - # An array of fileIds which you want to delete. - file_ids:, - request_options: {} - ) - end - - # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } - def self.new(client:) - end - end - end - end -end diff --git a/rbi/imagekit/resources/files/bulk.rbi b/rbi/imagekit/resources/files/bulk.rbi new file mode 100644 index 00000000..44af2dfe --- /dev/null +++ b/rbi/imagekit/resources/files/bulk.rbi @@ -0,0 +1,88 @@ +# typed: strong + +module Imagekit + module Resources + class Files + class Bulk + # 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. + sig do + params( + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::BulkDeleteResponse) + end + def delete( + # An array of fileIds which you want to delete. + file_ids:, + request_options: {} + ) + end + + # This API adds tags to multiple files in bulk. A maximum of 50 files can be + # specified at a time. + sig do + params( + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::BulkAddTagsResponse) + end + def add_tags( + # An array of fileIds to which you want to add tags. + file_ids:, + # An array of tags that you want to add to the files. + tags:, + request_options: {} + ) + end + + # This API removes AITags from multiple files in bulk. A maximum of 50 files can + # be specified at a time. + sig do + params( + ai_tags: T::Array[String], + file_ids: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::BulkRemoveAITagsResponse) + end + def remove_ai_tags( + # An array of AITags that you want to remove from the files. + ai_tags:, + # An array of fileIds from which you want to remove AITags. + file_ids:, + request_options: {} + ) + end + + # This API removes tags from multiple files in bulk. A maximum of 50 files can be + # specified at a time. + sig do + params( + file_ids: T::Array[String], + tags: T::Array[String], + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Files::BulkRemoveTagsResponse) + end + def remove_tags( + # An array of fileIds from which you want to remove tags. + file_ids:, + # An array of tags that you want to remove from the files. + tags:, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/imagekit/resources/files/details.rbi b/rbi/imagekit/resources/files/details.rbi deleted file mode 100644 index 88868ad2..00000000 --- a/rbi/imagekit/resources/files/details.rbi +++ /dev/null @@ -1,93 +0,0 @@ -# typed: strong - -module Imagekit - module Resources - class Files - class Details - # This API returns an object with details or attributes about the current version - # of the file. - sig do - params( - file_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::DetailRetrieveResponse) - end - def retrieve( - # The unique `fileId` of the uploaded file. `fileId` is returned in the list and - # search assets API and upload API. - file_id, - request_options: {} - ) - end - - # 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. - sig do - params( - file_id: String, - custom_coordinates: T.nilable(String), - custom_metadata: T.anything, - extensions: - T::Array[ - T.any( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension::OrHash - ) - ], - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::Files::DetailUpdateParams::RemoveAITags::OrSymbol - ), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::Files::DetailUpdateParams::Publish::OrHash, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::DetailUpdateResponse) - end - def update( - # The unique `fileId` of the uploaded file. `fileId` is returned in list and - # search assets API and upload API. - file_id, - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, - # Configure the publication status of a file and its versions. - publish: nil, - request_options: {} - ) - end - - # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } - def self.new(client:) - end - end - end - end -end diff --git a/rbi/imagekit/resources/files/metadata.rbi b/rbi/imagekit/resources/files/metadata.rbi index 53e8ea45..9b795ba6 100644 --- a/rbi/imagekit/resources/files/metadata.rbi +++ b/rbi/imagekit/resources/files/metadata.rbi @@ -13,9 +13,9 @@ module Imagekit params( file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::MetadataRetrieveResponse) + ).returns(Imagekit::Models::Files::MetadataGetResponse) end - def retrieve( + def get( # The unique `fileId` of the uploaded file. `fileId` is returned in the list and # search assets API and upload API. file_id, @@ -29,9 +29,9 @@ module Imagekit params( url: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::MetadataFromURLResponse) + ).returns(Imagekit::Models::Files::MetadataGetFromURLResponse) end - def from_url( + def get_from_url( # Should be a valid file URL. It should be accessible using your ImageKit.io # account. url:, diff --git a/rbi/imagekit/resources/files/versions.rbi b/rbi/imagekit/resources/files/versions.rbi index ee36ab8c..3146f22b 100644 --- a/rbi/imagekit/resources/files/versions.rbi +++ b/rbi/imagekit/resources/files/versions.rbi @@ -4,52 +4,52 @@ module Imagekit module Resources class Files class Versions - # This API returns an object with details or attributes of a file version. + # This API returns details of all versions of a file. sig do params( - version_id: String, file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::VersionRetrieveResponse) + ).returns(T::Array[Imagekit::Models::Files::VersionListResponseItem]) end - def retrieve( - # The unique `versionId` of the uploaded file. `versionId` is returned in list and - # search assets API and upload API. - version_id, + def list( # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. - file_id:, + file_id, request_options: {} ) end - # This API returns details of all versions of a file. + # 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. sig do params( + version_id: String, file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(T::Array[Imagekit::Models::Files::VersionListResponseItem]) + ).returns(T.anything) end - def list( + def delete( + # The unique `versionId` of the uploaded file. `versionId` is returned in list and + # search assets API and upload API. + version_id, # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. - file_id, + file_id:, request_options: {} ) end - # 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. + # This API returns an object with details or attributes of a file version. sig do params( version_id: String, file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) + ).returns(Imagekit::Models::Files::VersionGetResponse) end - def delete( + def get( # The unique `versionId` of the uploaded file. `versionId` is returned in list and # search assets API and upload API. version_id, diff --git a/rbi/imagekit/resources/folder.rbi b/rbi/imagekit/resources/folder.rbi deleted file mode 100644 index f89a3b45..00000000 --- a/rbi/imagekit/resources/folder.rbi +++ /dev/null @@ -1,55 +0,0 @@ -# typed: strong - -module Imagekit - module Resources - class Folder - # 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. - sig do - params( - folder_name: String, - parent_folder_path: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) - end - def create( - # 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. - # `_`. - folder_name:, - # 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. - parent_folder_path:, - request_options: {} - ) - end - - # This will delete a folder and all its contents permanently. The API returns an - # empty response. - sig do - params( - folder_path: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) - end - def delete( - # Full path to the folder you want to delete. For example `/folder/to/delete/`. - folder_path:, - request_options: {} - ) - end - - # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } - def self.new(client:) - end - end - end -end diff --git a/rbi/imagekit/resources/folders.rbi b/rbi/imagekit/resources/folders.rbi new file mode 100644 index 00000000..3a10047a --- /dev/null +++ b/rbi/imagekit/resources/folders.rbi @@ -0,0 +1,146 @@ +# typed: strong + +module Imagekit + module Resources + class Folders + sig { returns(Imagekit::Resources::Folders::Job) } + attr_reader :job + + # 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. + sig do + params( + folder_name: String, + parent_folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.anything) + end + def create( + # 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. + # `_`. + folder_name:, + # 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. + parent_folder_path:, + request_options: {} + ) + end + + # This will delete a folder and all its contents permanently. The API returns an + # empty response. + sig do + params( + folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.anything) + end + def delete( + # Full path to the folder you want to delete. For example `/folder/to/delete/`. + folder_path:, + request_options: {} + ) + end + + # 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. + sig do + params( + destination_path: String, + source_folder_path: String, + include_versions: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FolderCopyResponse) + end + def copy( + # Full path to the destination folder where you want to copy the source folder + # into. + destination_path:, + # The full path to the source folder you want to copy. + source_folder_path:, + # 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`. + include_versions: nil, + request_options: {} + ) + end + + # 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. + sig do + params( + destination_path: String, + source_folder_path: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FolderMoveResponse) + end + def move( + # Full path to the destination folder where you want to move the source folder + # into. + destination_path:, + # The full path to the source folder you want to move. + source_folder_path:, + request_options: {} + ) + end + + # 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. + sig do + params( + folder_path: String, + new_folder_name: String, + purge_cache: T::Boolean, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::FolderRenameResponse) + end + def rename( + # The full path to the folder you want to rename. + folder_path:, + # 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. `_`. + new_folder_name:, + # 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` + purge_cache: nil, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/folders/job.rbi b/rbi/imagekit/resources/folders/job.rbi new file mode 100644 index 00000000..f59139e4 --- /dev/null +++ b/rbi/imagekit/resources/folders/job.rbi @@ -0,0 +1,29 @@ +# typed: strong + +module Imagekit + module Resources + class Folders + class Job + # This API returns the status of a bulk job like copy and move folder operations. + sig do + params( + job_id: String, + request_options: Imagekit::RequestOptions::OrHash + ).returns(Imagekit::Models::Folders::JobGetResponse) + end + def get( + # The `jobId` is returned in the response of bulk job API e.g. copy folder or move + # folder API. + job_id, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/sig/imagekit/client.rbs b/sig/imagekit/client.rbs index 7dddd06d..a2b509d3 100644 --- a/sig/imagekit/client.rbs +++ b/sig/imagekit/client.rbs @@ -16,12 +16,16 @@ module Imagekit attr_reader files: Imagekit::Resources::Files - attr_reader folder: Imagekit::Resources::Folder + attr_reader assets: Imagekit::Resources::Assets - attr_reader bulk_jobs: Imagekit::Resources::BulkJobs + attr_reader cache: Imagekit::Resources::Cache + + attr_reader folders: Imagekit::Resources::Folders attr_reader accounts: Imagekit::Resources::Accounts + attr_reader beta: Imagekit::Resources::Beta + private def auth_headers: -> ::Hash[String, String] def base_url_overridden?: -> bool diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 01de18de..124cbd93 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -1,11 +1,11 @@ module Imagekit - class AccountGetUsageParams = Imagekit::Models::AccountGetUsageParams + module Accounts = Imagekit::Models::Accounts - class BulkJobCopyFolderParams = Imagekit::Models::BulkJobCopyFolderParams + class AssetListParams = Imagekit::Models::AssetListParams - class BulkJobMoveFolderParams = Imagekit::Models::BulkJobMoveFolderParams + module Beta = Imagekit::Models::Beta - class BulkJobRetrieveStatusParams = Imagekit::Models::BulkJobRetrieveStatusParams + module Cache = Imagekit::Models::Cache class CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams @@ -15,39 +15,31 @@ module Imagekit class CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams - class ExifDetails = Imagekit::Models::ExifDetails - - class ExifImage = Imagekit::Models::ExifImage - - class FileAddTagsParams = Imagekit::Models::FileAddTagsParams - class FileCopyParams = Imagekit::Models::FileCopyParams class FileDeleteParams = Imagekit::Models::FileDeleteParams - class FileListParams = Imagekit::Models::FileListParams + class FileGetParams = Imagekit::Models::FileGetParams class FileMoveParams = Imagekit::Models::FileMoveParams - class FileRemoveAITagsParams = Imagekit::Models::FileRemoveAITagsParams - - class FileRemoveTagsParams = Imagekit::Models::FileRemoveTagsParams - class FileRenameParams = Imagekit::Models::FileRenameParams module Files = Imagekit::Models::Files - class FileUploadV1Params = Imagekit::Models::FileUploadV1Params + class FileUpdateParams = Imagekit::Models::FileUpdateParams + + class FileUploadParams = Imagekit::Models::FileUploadParams - class FileUploadV2Params = Imagekit::Models::FileUploadV2Params + class FolderCopyParams = Imagekit::Models::FolderCopyParams class FolderCreateParams = Imagekit::Models::FolderCreateParams class FolderDeleteParams = Imagekit::Models::FolderDeleteParams - class Gps = Imagekit::Models::Gps + class FolderMoveParams = Imagekit::Models::FolderMoveParams - class Interoperability = Imagekit::Models::Interoperability + class FolderRenameParams = Imagekit::Models::FolderRenameParams - class Thumbnail = Imagekit::Models::Thumbnail + module Folders = Imagekit::Models::Folders end diff --git a/sig/imagekit/models/account_get_usage_params.rbs b/sig/imagekit/models/account_get_usage_params.rbs deleted file mode 100644 index 156f6bb4..00000000 --- a/sig/imagekit/models/account_get_usage_params.rbs +++ /dev/null @@ -1,28 +0,0 @@ -module Imagekit - module Models - type account_get_usage_params = - { end_date: Date, start_date: Date } - & Imagekit::Internal::Type::request_parameters - - class AccountGetUsageParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor end_date: Date - - attr_accessor start_date: Date - - def initialize: ( - end_date: Date, - start_date: Date, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - end_date: Date, - start_date: Date, - request_options: Imagekit::RequestOptions - } - end - end -end diff --git a/sig/imagekit/models/account_get_usage_response.rbs b/sig/imagekit/models/account_get_usage_response.rbs deleted file mode 100644 index 5dcaef1d..00000000 --- a/sig/imagekit/models/account_get_usage_response.rbs +++ /dev/null @@ -1,50 +0,0 @@ -module Imagekit - module Models - type account_get_usage_response = - { - bandwidth_bytes: Integer, - extension_units_count: Integer, - media_library_storage_bytes: Integer, - original_cache_storage_bytes: Integer, - video_processing_units_count: Integer - } - - class AccountGetUsageResponse < Imagekit::Internal::Type::BaseModel - attr_reader bandwidth_bytes: Integer? - - def bandwidth_bytes=: (Integer) -> Integer - - attr_reader extension_units_count: Integer? - - def extension_units_count=: (Integer) -> Integer - - attr_reader media_library_storage_bytes: Integer? - - def media_library_storage_bytes=: (Integer) -> Integer - - attr_reader original_cache_storage_bytes: Integer? - - def original_cache_storage_bytes=: (Integer) -> Integer - - attr_reader video_processing_units_count: Integer? - - def video_processing_units_count=: (Integer) -> Integer - - def initialize: ( - ?bandwidth_bytes: Integer, - ?extension_units_count: Integer, - ?media_library_storage_bytes: Integer, - ?original_cache_storage_bytes: Integer, - ?video_processing_units_count: Integer - ) -> void - - def to_hash: -> { - bandwidth_bytes: Integer, - extension_units_count: Integer, - media_library_storage_bytes: Integer, - original_cache_storage_bytes: Integer, - video_processing_units_count: Integer - } - end - end -end diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs new file mode 100644 index 00000000..679133d0 --- /dev/null +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -0,0 +1,148 @@ +module Imagekit + module Models + module Accounts + type origin_create_params = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Models::Accounts::OriginCreateParams::type_, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + endpoint: String, + :s3_force_path_style => bool, + base_url: String, + forward_host_header_to_origin: bool, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String + } + & Imagekit::Internal::Type::request_parameters + + class OriginCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateParams::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_accessor endpoint: String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + attr_accessor base_url: String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_accessor client_email: String + + attr_accessor private_key: String + + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor sas_token: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor password: String + + attr_accessor username: String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Models::Accounts::OriginCreateParams::type_, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?forward_host_header_to_origin: bool, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Models::Accounts::OriginCreateParams::type_, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + endpoint: String, + :s3_force_path_style => bool, + base_url: String, + forward_host_header_to_origin: bool, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + request_options: Imagekit::RequestOptions + } + + type type_ = :AKENEO_PIM + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM: :AKENEO_PIM + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateParams::type_] + end + end + end + end +end diff --git a/sig/imagekit/models/accounts/origin_create_response.rbs b/sig/imagekit/models/accounts/origin_create_response.rbs new file mode 100644 index 00000000..e333344e --- /dev/null +++ b/sig/imagekit/models/accounts/origin_create_response.rbs @@ -0,0 +1,498 @@ +module Imagekit + module Models + module Accounts + type origin_create_response = + Imagekit::Models::Accounts::OriginCreateResponse::S3 + | Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible + | Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup + | Imagekit::Models::Accounts::OriginCreateResponse::WebFolder + | Imagekit::Models::Accounts::OriginCreateResponse::WebProxy + | Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs + | Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim + + module OriginCreateResponse + extend Imagekit::Internal::Type::Union + + type s3 = + { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, + base_url_for_canonical_header: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, + base_url_for_canonical_header: String + } + + type type_ = :S3 + + module Type + extend Imagekit::Internal::Type::Enum + + S3: :S3 + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::S3::type_] + end + end + + type s3_compatible = + { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + :s3_force_path_style => bool, + type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, + base_url_for_canonical_header: String + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor s3_force_path_style: bool + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + s3_force_path_style: bool, + type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + :s3_force_path_style => bool, + type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, + base_url_for_canonical_header: String + } + + type type_ = :S3_COMPATIBLE + + module Type + extend Imagekit::Internal::Type::Enum + + S3_COMPATIBLE: :S3_COMPATIBLE + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_] + end + end + + type cloudinary_backup = + { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, + base_url_for_canonical_header: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, + base_url_for_canonical_header: String + } + + type type_ = :CLOUDINARY_BACKUP + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_] + end + end + + type web_folder = + { + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_, + base_url_for_canonical_header: String + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: top + + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_, + base_url_for_canonical_header: String + } + + type type_ = :WEB_FOLDER + + module Type + extend Imagekit::Internal::Type::Enum + + WEB_FOLDER: :WEB_FOLDER + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_] + end + end + + type web_proxy = + { + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_, + base_url_for_canonical_header: String + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_, + base_url_for_canonical_header: String + } + + type type_ = :WEB_PROXY + + module Type + extend Imagekit::Internal::Type::Enum + + WEB_PROXY: :WEB_PROXY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_] + end + end + + type google_cloud_storage_gcs = + { + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, + base_url_for_canonical_header: String + } + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, + base_url_for_canonical_header: String + } + + type type_ = :GCS + + module Type + extend Imagekit::Internal::Type::Enum + + GCS: :GCS + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_] + end + end + + type azure_blob_storage = + { + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, + base_url_for_canonical_header: String + } + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, + base_url_for_canonical_header: String + } + + type type_ = :AZURE_BLOB + + module Type + extend Imagekit::Internal::Type::Enum + + AZURE_BLOB: :AZURE_BLOB + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_] + end + end + + type akeneo_pim = + { + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, + base_url_for_canonical_header: String + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: top + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, + base_url_for_canonical_header: String + } + + type type_ = :AKENEO_PIM + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM: :AKENEO_PIM + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_create_response] + end + end + end +end diff --git a/sig/imagekit/models/files/metadata_retrieve_params.rbs b/sig/imagekit/models/accounts/origin_delete_params.rbs similarity index 75% rename from sig/imagekit/models/files/metadata_retrieve_params.rbs rename to sig/imagekit/models/accounts/origin_delete_params.rbs index 5d5bae33..da2cff14 100644 --- a/sig/imagekit/models/files/metadata_retrieve_params.rbs +++ b/sig/imagekit/models/accounts/origin_delete_params.rbs @@ -1,10 +1,10 @@ module Imagekit module Models - module Files - type metadata_retrieve_params = + module Accounts + type origin_delete_params = { } & Imagekit::Internal::Type::request_parameters - class MetadataRetrieveParams < Imagekit::Internal::Type::BaseModel + class OriginDeleteParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/accounts/origin_get_params.rbs b/sig/imagekit/models/accounts/origin_get_params.rbs new file mode 100644 index 00000000..b80c072e --- /dev/null +++ b/sig/imagekit/models/accounts/origin_get_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Accounts + type origin_get_params = + { } & Imagekit::Internal::Type::request_parameters + + class OriginGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/accounts/origin_get_response.rbs b/sig/imagekit/models/accounts/origin_get_response.rbs new file mode 100644 index 00000000..3ac55b9e --- /dev/null +++ b/sig/imagekit/models/accounts/origin_get_response.rbs @@ -0,0 +1,498 @@ +module Imagekit + module Models + module Accounts + type origin_get_response = + Imagekit::Models::Accounts::OriginGetResponse::S3 + | Imagekit::Models::Accounts::OriginGetResponse::S3Compatible + | Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup + | Imagekit::Models::Accounts::OriginGetResponse::WebFolder + | Imagekit::Models::Accounts::OriginGetResponse::WebProxy + | Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs + | Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim + + module OriginGetResponse + extend Imagekit::Internal::Type::Union + + type s3 = + { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, + base_url_for_canonical_header: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, + base_url_for_canonical_header: String + } + + type type_ = :S3 + + module Type + extend Imagekit::Internal::Type::Enum + + S3: :S3 + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::S3::type_] + end + end + + type s3_compatible = + { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + :s3_force_path_style => bool, + type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, + base_url_for_canonical_header: String + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor s3_force_path_style: bool + + attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + s3_force_path_style: bool, + type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + :s3_force_path_style => bool, + type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, + base_url_for_canonical_header: String + } + + type type_ = :S3_COMPATIBLE + + module Type + extend Imagekit::Internal::Type::Enum + + S3_COMPATIBLE: :S3_COMPATIBLE + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_] + end + end + + type cloudinary_backup = + { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, + base_url_for_canonical_header: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, + base_url_for_canonical_header: String + } + + type type_ = :CLOUDINARY_BACKUP + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_] + end + end + + type web_folder = + { + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_, + base_url_for_canonical_header: String + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: top + + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_, + base_url_for_canonical_header: String + } + + type type_ = :WEB_FOLDER + + module Type + extend Imagekit::Internal::Type::Enum + + WEB_FOLDER: :WEB_FOLDER + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_] + end + end + + type web_proxy = + { + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_, + base_url_for_canonical_header: String + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_, + base_url_for_canonical_header: String + } + + type type_ = :WEB_PROXY + + module Type + extend Imagekit::Internal::Type::Enum + + WEB_PROXY: :WEB_PROXY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_] + end + end + + type google_cloud_storage_gcs = + { + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, + base_url_for_canonical_header: String + } + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, + base_url_for_canonical_header: String + } + + type type_ = :GCS + + module Type + extend Imagekit::Internal::Type::Enum + + GCS: :GCS + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_] + end + end + + type azure_blob_storage = + { + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, + base_url_for_canonical_header: String + } + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, + base_url_for_canonical_header: String + } + + type type_ = :AZURE_BLOB + + module Type + extend Imagekit::Internal::Type::Enum + + AZURE_BLOB: :AZURE_BLOB + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_] + end + end + + type akeneo_pim = + { + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, + base_url_for_canonical_header: String + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: top + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, + base_url_for_canonical_header: String + } + + type type_ = :AKENEO_PIM + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM: :AKENEO_PIM + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_get_response] + end + end + end +end diff --git a/sig/imagekit/models/accounts/origin_list_params.rbs b/sig/imagekit/models/accounts/origin_list_params.rbs new file mode 100644 index 00000000..ea2e0350 --- /dev/null +++ b/sig/imagekit/models/accounts/origin_list_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Accounts + type origin_list_params = + { } & Imagekit::Internal::Type::request_parameters + + class OriginListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs new file mode 100644 index 00000000..9dd3ae4b --- /dev/null +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -0,0 +1,503 @@ +module Imagekit + module Models + module Accounts + type origin_list_response_item = + Imagekit::Models::Accounts::OriginListResponseItem::S3 + | Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible + | Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup + | Imagekit::Models::Accounts::OriginListResponseItem::WebFolder + | Imagekit::Models::Accounts::OriginListResponseItem::WebProxy + | Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs + | Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage + | Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim + + module OriginListResponseItem + extend Imagekit::Internal::Type::Union + + type s3 = + { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, + base_url_for_canonical_header: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, + base_url_for_canonical_header: String + } + + type type_ = :S3 + + module Type + extend Imagekit::Internal::Type::Enum + + S3: :S3 + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::S3::type_] + end + end + + type s3_compatible = + { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + :s3_force_path_style => bool, + type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, + base_url_for_canonical_header: String + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor s3_force_path_style: bool + + attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + s3_force_path_style: bool, + type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + :s3_force_path_style => bool, + type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, + base_url_for_canonical_header: String + } + + type type_ = :S3_COMPATIBLE + + module Type + extend Imagekit::Internal::Type::Enum + + S3_COMPATIBLE: :S3_COMPATIBLE + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_] + end + end + + type cloudinary_backup = + { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, + base_url_for_canonical_header: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, + base_url_for_canonical_header: String + } + + type type_ = :CLOUDINARY_BACKUP + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_] + end + end + + type web_folder = + { + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_, + base_url_for_canonical_header: String + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: top + + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_, + base_url_for_canonical_header: String + } + + type type_ = :WEB_FOLDER + + module Type + extend Imagekit::Internal::Type::Enum + + WEB_FOLDER: :WEB_FOLDER + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_] + end + end + + type web_proxy = + { + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_, + base_url_for_canonical_header: String + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_, + base_url_for_canonical_header: String + } + + type type_ = :WEB_PROXY + + module Type + extend Imagekit::Internal::Type::Enum + + WEB_PROXY: :WEB_PROXY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_] + end + end + + type google_cloud_storage_gcs = + { + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, + base_url_for_canonical_header: String + } + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, + base_url_for_canonical_header: String + } + + type type_ = :GCS + + module Type + extend Imagekit::Internal::Type::Enum + + GCS: :GCS + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_] + end + end + + type azure_blob_storage = + { + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, + base_url_for_canonical_header: String + } + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, + base_url_for_canonical_header: String + } + + type type_ = :AZURE_BLOB + + module Type + extend Imagekit::Internal::Type::Enum + + AZURE_BLOB: :AZURE_BLOB + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_] + end + end + + type akeneo_pim = + { + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, + base_url_for_canonical_header: String + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: top + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, + base_url_for_canonical_header: String + } + + type type_ = :AKENEO_PIM + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM: :AKENEO_PIM + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_list_response_item] + end + + type origin_list_response = + ::Array[Imagekit::Models::Accounts::origin_list_response_item] + + OriginListResponse: Imagekit::Internal::Type::Converter + end + end +end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs new file mode 100644 index 00000000..ff5d0ad2 --- /dev/null +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -0,0 +1,148 @@ +module Imagekit + module Models + module Accounts + type origin_update_params = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Models::Accounts::OriginUpdateParams::type_, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + endpoint: String, + :s3_force_path_style => bool, + base_url: String, + forward_host_header_to_origin: bool, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String + } + & Imagekit::Internal::Type::request_parameters + + class OriginUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateParams::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_accessor endpoint: String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + attr_accessor base_url: String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_accessor client_email: String + + attr_accessor private_key: String + + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor sas_token: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor password: String + + attr_accessor username: String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Models::Accounts::OriginUpdateParams::type_, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?forward_host_header_to_origin: bool, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Models::Accounts::OriginUpdateParams::type_, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + endpoint: String, + :s3_force_path_style => bool, + base_url: String, + forward_host_header_to_origin: bool, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + request_options: Imagekit::RequestOptions + } + + type type_ = :AKENEO_PIM + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM: :AKENEO_PIM + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateParams::type_] + end + end + end + end +end diff --git a/sig/imagekit/models/accounts/origin_update_response.rbs b/sig/imagekit/models/accounts/origin_update_response.rbs new file mode 100644 index 00000000..f82f6496 --- /dev/null +++ b/sig/imagekit/models/accounts/origin_update_response.rbs @@ -0,0 +1,498 @@ +module Imagekit + module Models + module Accounts + type origin_update_response = + Imagekit::Models::Accounts::OriginUpdateResponse::S3 + | Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible + | Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup + | Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder + | Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy + | Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs + | Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim + + module OriginUpdateResponse + extend Imagekit::Internal::Type::Union + + type s3 = + { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, + base_url_for_canonical_header: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, + base_url_for_canonical_header: String + } + + type type_ = :S3 + + module Type + extend Imagekit::Internal::Type::Enum + + S3: :S3 + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_] + end + end + + type s3_compatible = + { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + :s3_force_path_style => bool, + type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, + base_url_for_canonical_header: String + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor s3_force_path_style: bool + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + s3_force_path_style: bool, + type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + endpoint: String, + include_canonical_header: bool, + name: String, + prefix: top, + :s3_force_path_style => bool, + type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, + base_url_for_canonical_header: String + } + + type type_ = :S3_COMPATIBLE + + module Type + extend Imagekit::Internal::Type::Enum + + S3_COMPATIBLE: :S3_COMPATIBLE + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_] + end + end + + type cloudinary_backup = + { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, + base_url_for_canonical_header: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, + base_url_for_canonical_header: String + } + + type type_ = :CLOUDINARY_BACKUP + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_] + end + end + + type web_folder = + { + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_, + base_url_for_canonical_header: String + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: top + + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + base_url: top, + forward_host_header_to_origin: bool, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_, + base_url_for_canonical_header: String + } + + type type_ = :WEB_FOLDER + + module Type + extend Imagekit::Internal::Type::Enum + + WEB_FOLDER: :WEB_FOLDER + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_] + end + end + + type web_proxy = + { + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_, + base_url_for_canonical_header: String + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_, + base_url_for_canonical_header: String + } + + type type_ = :WEB_PROXY + + module Type + extend Imagekit::Internal::Type::Enum + + WEB_PROXY: :WEB_PROXY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_] + end + end + + type google_cloud_storage_gcs = + { + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, + base_url_for_canonical_header: String + } + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + bucket: String, + client_email: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, + base_url_for_canonical_header: String + } + + type type_ = :GCS + + module Type + extend Imagekit::Internal::Type::Enum + + GCS: :GCS + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_] + end + end + + type azure_blob_storage = + { + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, + base_url_for_canonical_header: String + } + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor prefix: top + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + account_name: String, + container: String, + include_canonical_header: bool, + name: String, + prefix: top, + type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, + base_url_for_canonical_header: String + } + + type type_ = :AZURE_BLOB + + module Type + extend Imagekit::Internal::Type::Enum + + AZURE_BLOB: :AZURE_BLOB + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_] + end + end + + type akeneo_pim = + { + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, + base_url_for_canonical_header: String + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: top + + attr_accessor include_canonical_header: bool + + attr_accessor name: String + + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_ + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_accessor id: String + + def initialize: ( + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, + ?base_url_for_canonical_header: String + ) -> void + + def to_hash: -> { + id: String, + base_url: top, + include_canonical_header: bool, + name: String, + type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, + base_url_for_canonical_header: String + } + + type type_ = :AKENEO_PIM + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM: :AKENEO_PIM + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_update_response] + end + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs new file mode 100644 index 00000000..5490dc25 --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs @@ -0,0 +1,150 @@ +module Imagekit + module Models + module Accounts + type url_endpoint_create_params = + { + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter + } + & Imagekit::Internal::Type::request_parameters + + class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor description: String + + attr_reader origins: ::Array[String]? + + def origins=: (::Array[String]) -> ::Array[String] + + attr_reader url_prefix: String? + + def url_prefix=: (String) -> String + + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter? + + def url_rewriter=: ( + Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter + + def initialize: ( + description: String, + ?origins: ::Array[String], + ?url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter, + request_options: Imagekit::RequestOptions + } + + type url_rewriter = + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter + | Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter + | Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter + + module URLRewriter + extend Imagekit::Internal::Type::Union + + type cloudinary_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_, + preserve_asset_delivery_types: bool + } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_ + + attr_reader preserve_asset_delivery_types: bool? + + def preserve_asset_delivery_types=: (bool) -> bool + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_, + ?preserve_asset_delivery_types: bool + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_, + preserve_asset_delivery_types: bool + } + + type type_ = :CLOUDINARY + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY: :CLOUDINARY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_] + end + end + + type imgix_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_ + } + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_ + } + + type type_ = :IMGIX + + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX: :IMGIX + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_] + end + end + + type akamai_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_ + } + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_ + } + + type type_ = :AKAMAI + + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI: :AKAMAI + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter] + end + end + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_create_response.rbs b/sig/imagekit/models/accounts/url_endpoint_create_response.rbs new file mode 100644 index 00000000..5b033e19 --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint_create_response.rbs @@ -0,0 +1,143 @@ +module Imagekit + module Models + module Accounts + type url_endpoint_create_response = + { + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter + } + + class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel + attr_accessor description: String + + attr_accessor origins: ::Array[String] + + attr_accessor url_prefix: String + + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter? + + def url_rewriter=: ( + Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter + + attr_accessor id: String + + def initialize: ( + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter + ) -> void + + def to_hash: -> { + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter + } + + type url_rewriter = + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter + | Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter + | Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter + + module URLRewriter + extend Imagekit::Internal::Type::Union + + type cloudinary_url_rewriter = + { + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_ + } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor preserve_asset_delivery_types: bool + + attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_ + + def initialize: ( + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_ + ) -> void + + def to_hash: -> { + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_ + } + + type type_ = :CLOUDINARY + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY: :CLOUDINARY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_] + end + end + + type imgix_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_ + } + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_ + } + + type type_ = :IMGIX + + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX: :IMGIX + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_] + end + end + + type akamai_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_ + } + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_ + } + + type type_ = :AKAMAI + + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI: :AKAMAI + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter] + end + end + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_delete_params.rbs b/sig/imagekit/models/accounts/url_endpoint_delete_params.rbs new file mode 100644 index 00000000..ea88292a --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint_delete_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Accounts + type url_endpoint_delete_params = + { } & Imagekit::Internal::Type::request_parameters + + class URLEndpointDeleteParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/files/detail_retrieve_params.rbs b/sig/imagekit/models/accounts/url_endpoint_get_params.rbs similarity index 76% rename from sig/imagekit/models/files/detail_retrieve_params.rbs rename to sig/imagekit/models/accounts/url_endpoint_get_params.rbs index 63b2e0b8..f13c5bf6 100644 --- a/sig/imagekit/models/files/detail_retrieve_params.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_get_params.rbs @@ -1,10 +1,10 @@ module Imagekit module Models - module Files - type detail_retrieve_params = + module Accounts + type url_endpoint_get_params = { } & Imagekit::Internal::Type::request_parameters - class DetailRetrieveParams < Imagekit::Internal::Type::BaseModel + class URLEndpointGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/accounts/url_endpoint_get_response.rbs b/sig/imagekit/models/accounts/url_endpoint_get_response.rbs new file mode 100644 index 00000000..205407ad --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint_get_response.rbs @@ -0,0 +1,143 @@ +module Imagekit + module Models + module Accounts + type url_endpoint_get_response = + { + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + } + + class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel + attr_accessor description: String + + attr_accessor origins: ::Array[String] + + attr_accessor url_prefix: String + + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter? + + def url_rewriter=: ( + Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + + attr_accessor id: String + + def initialize: ( + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + ) -> void + + def to_hash: -> { + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + } + + type url_rewriter = + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter + | Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter + | Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter + + module URLRewriter + extend Imagekit::Internal::Type::Union + + type cloudinary_url_rewriter = + { + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_ + } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor preserve_asset_delivery_types: bool + + attr_accessor type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_ + + def initialize: ( + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_ + ) -> void + + def to_hash: -> { + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_ + } + + type type_ = :CLOUDINARY + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY: :CLOUDINARY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_] + end + end + + type imgix_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_ + } + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_ + } + + type type_ = :IMGIX + + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX: :IMGIX + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_] + end + end + + type akamai_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_ + } + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_ + } + + type type_ = :AKAMAI + + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI: :AKAMAI + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter] + end + end + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_list_params.rbs b/sig/imagekit/models/accounts/url_endpoint_list_params.rbs new file mode 100644 index 00000000..f90a121a --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint_list_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Accounts + type url_endpoint_list_params = + { } & Imagekit::Internal::Type::request_parameters + + class URLEndpointListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs new file mode 100644 index 00000000..d8394666 --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs @@ -0,0 +1,148 @@ +module Imagekit + module Models + module Accounts + type url_endpoint_list_response_item = + { + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter + } + + class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel + attr_accessor description: String + + attr_accessor origins: ::Array[String] + + attr_accessor url_prefix: String + + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter? + + def url_rewriter=: ( + Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter + + attr_accessor id: String + + def initialize: ( + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter + ) -> void + + def to_hash: -> { + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter + } + + type url_rewriter = + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter + | Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter + | Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter + + module URLRewriter + extend Imagekit::Internal::Type::Union + + type cloudinary_url_rewriter = + { + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_ + } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor preserve_asset_delivery_types: bool + + attr_accessor type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_ + + def initialize: ( + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_ + ) -> void + + def to_hash: -> { + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_ + } + + type type_ = :CLOUDINARY + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY: :CLOUDINARY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_] + end + end + + type imgix_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_ + } + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_ + } + + type type_ = :IMGIX + + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX: :IMGIX + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_] + end + end + + type akamai_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_ + } + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_ + } + + type type_ = :AKAMAI + + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI: :AKAMAI + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter] + end + end + + type url_endpoint_list_response = + ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem] + + URLEndpointListResponse: Imagekit::Internal::Type::Converter + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs new file mode 100644 index 00000000..fd065303 --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs @@ -0,0 +1,150 @@ +module Imagekit + module Models + module Accounts + type url_endpoint_update_params = + { + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter + } + & Imagekit::Internal::Type::request_parameters + + class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor description: String + + attr_reader origins: ::Array[String]? + + def origins=: (::Array[String]) -> ::Array[String] + + attr_reader url_prefix: String? + + def url_prefix=: (String) -> String + + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter? + + def url_rewriter=: ( + Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter + + def initialize: ( + description: String, + ?origins: ::Array[String], + ?url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter, + request_options: Imagekit::RequestOptions + } + + type url_rewriter = + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter + | Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter + | Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter + + module URLRewriter + extend Imagekit::Internal::Type::Union + + type cloudinary_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_, + preserve_asset_delivery_types: bool + } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_ + + attr_reader preserve_asset_delivery_types: bool? + + def preserve_asset_delivery_types=: (bool) -> bool + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_, + ?preserve_asset_delivery_types: bool + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_, + preserve_asset_delivery_types: bool + } + + type type_ = :CLOUDINARY + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY: :CLOUDINARY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_] + end + end + + type imgix_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_ + } + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_ + } + + type type_ = :IMGIX + + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX: :IMGIX + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_] + end + end + + type akamai_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_ + } + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_ + } + + type type_ = :AKAMAI + + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI: :AKAMAI + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter] + end + end + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_update_response.rbs b/sig/imagekit/models/accounts/url_endpoint_update_response.rbs new file mode 100644 index 00000000..d32f91c7 --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint_update_response.rbs @@ -0,0 +1,143 @@ +module Imagekit + module Models + module Accounts + type url_endpoint_update_response = + { + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter + } + + class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel + attr_accessor description: String + + attr_accessor origins: ::Array[String] + + attr_accessor url_prefix: String + + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter? + + def url_rewriter=: ( + Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter + + attr_accessor id: String + + def initialize: ( + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter + ) -> void + + def to_hash: -> { + id: String, + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter + } + + type url_rewriter = + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter + | Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter + | Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter + + module URLRewriter + extend Imagekit::Internal::Type::Union + + type cloudinary_url_rewriter = + { + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_ + } + + class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor preserve_asset_delivery_types: bool + + attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_ + + def initialize: ( + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_ + ) -> void + + def to_hash: -> { + preserve_asset_delivery_types: bool, + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_ + } + + type type_ = :CLOUDINARY + + module Type + extend Imagekit::Internal::Type::Enum + + CLOUDINARY: :CLOUDINARY + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_] + end + end + + type imgix_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_ + } + + class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_ + } + + type type_ = :IMGIX + + module Type + extend Imagekit::Internal::Type::Enum + + IMGIX: :IMGIX + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_] + end + end + + type akamai_url_rewriter = + { + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_ + } + + class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_ + + def initialize: ( + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_ + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_ + } + + type type_ = :AKAMAI + + module Type + extend Imagekit::Internal::Type::Enum + + AKAMAI: :AKAMAI + + def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter] + end + end + end + end +end diff --git a/sig/imagekit/models/accounts/usage_get_params.rbs b/sig/imagekit/models/accounts/usage_get_params.rbs new file mode 100644 index 00000000..b5ea8183 --- /dev/null +++ b/sig/imagekit/models/accounts/usage_get_params.rbs @@ -0,0 +1,30 @@ +module Imagekit + module Models + module Accounts + type usage_get_params = + { end_date: Date, start_date: Date } + & Imagekit::Internal::Type::request_parameters + + class UsageGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor end_date: Date + + attr_accessor start_date: Date + + def initialize: ( + end_date: Date, + start_date: Date, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + end_date: Date, + start_date: Date, + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/accounts/usage_get_response.rbs b/sig/imagekit/models/accounts/usage_get_response.rbs new file mode 100644 index 00000000..8b11aae0 --- /dev/null +++ b/sig/imagekit/models/accounts/usage_get_response.rbs @@ -0,0 +1,52 @@ +module Imagekit + module Models + module Accounts + type usage_get_response = + { + bandwidth_bytes: Integer, + extension_units_count: Integer, + media_library_storage_bytes: Integer, + original_cache_storage_bytes: Integer, + video_processing_units_count: Integer + } + + class UsageGetResponse < Imagekit::Internal::Type::BaseModel + attr_reader bandwidth_bytes: Integer? + + def bandwidth_bytes=: (Integer) -> Integer + + attr_reader extension_units_count: Integer? + + def extension_units_count=: (Integer) -> Integer + + attr_reader media_library_storage_bytes: Integer? + + def media_library_storage_bytes=: (Integer) -> Integer + + attr_reader original_cache_storage_bytes: Integer? + + def original_cache_storage_bytes=: (Integer) -> Integer + + attr_reader video_processing_units_count: Integer? + + def video_processing_units_count=: (Integer) -> Integer + + def initialize: ( + ?bandwidth_bytes: Integer, + ?extension_units_count: Integer, + ?media_library_storage_bytes: Integer, + ?original_cache_storage_bytes: Integer, + ?video_processing_units_count: Integer + ) -> void + + def to_hash: -> { + bandwidth_bytes: Integer, + extension_units_count: Integer, + media_library_storage_bytes: Integer, + original_cache_storage_bytes: Integer, + video_processing_units_count: Integer + } + end + end + end +end diff --git a/sig/imagekit/models/asset_list_params.rbs b/sig/imagekit/models/asset_list_params.rbs new file mode 100644 index 00000000..21cd33ef --- /dev/null +++ b/sig/imagekit/models/asset_list_params.rbs @@ -0,0 +1,138 @@ +module Imagekit + module Models + type asset_list_params = + { + file_type: Imagekit::Models::AssetListParams::file_type, + limit: Integer, + path: String, + search_query: String, + skip: Integer, + sort: Imagekit::Models::AssetListParams::sort, + type: Imagekit::Models::AssetListParams::type_ + } + & Imagekit::Internal::Type::request_parameters + + class AssetListParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_reader file_type: Imagekit::Models::AssetListParams::file_type? + + def file_type=: ( + Imagekit::Models::AssetListParams::file_type + ) -> Imagekit::Models::AssetListParams::file_type + + attr_reader limit: Integer? + + def limit=: (Integer) -> Integer + + attr_reader path: String? + + def path=: (String) -> String + + attr_reader search_query: String? + + def search_query=: (String) -> String + + attr_reader skip: Integer? + + def skip=: (Integer) -> Integer + + attr_reader sort: Imagekit::Models::AssetListParams::sort? + + def sort=: ( + Imagekit::Models::AssetListParams::sort + ) -> Imagekit::Models::AssetListParams::sort + + attr_reader type: Imagekit::Models::AssetListParams::type_? + + def type=: ( + Imagekit::Models::AssetListParams::type_ + ) -> Imagekit::Models::AssetListParams::type_ + + def initialize: ( + ?file_type: Imagekit::Models::AssetListParams::file_type, + ?limit: Integer, + ?path: String, + ?search_query: String, + ?skip: Integer, + ?sort: Imagekit::Models::AssetListParams::sort, + ?type: Imagekit::Models::AssetListParams::type_, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_type: Imagekit::Models::AssetListParams::file_type, + limit: Integer, + path: String, + search_query: String, + skip: Integer, + sort: Imagekit::Models::AssetListParams::sort, + type: Imagekit::Models::AssetListParams::type_, + request_options: Imagekit::RequestOptions + } + + type file_type = :all | :image | :"non-image" + + module FileType + extend Imagekit::Internal::Type::Enum + + ALL: :all + IMAGE: :image + NON_IMAGE: :"non-image" + + def self?.values: -> ::Array[Imagekit::Models::AssetListParams::file_type] + end + + type sort = + :ASC_NAME + | :DESC_NAME + | :ASC_CREATED + | :DESC_CREATED + | :ASC_UPDATED + | :DESC_UPDATED + | :ASC_HEIGHT + | :DESC_HEIGHT + | :ASC_WIDTH + | :DESC_WIDTH + | :ASC_SIZE + | :DESC_SIZE + | :ASC_RELEVANCE + | :DESC_RELEVANCE + + module Sort + extend Imagekit::Internal::Type::Enum + + ASC_NAME: :ASC_NAME + DESC_NAME: :DESC_NAME + ASC_CREATED: :ASC_CREATED + DESC_CREATED: :DESC_CREATED + ASC_UPDATED: :ASC_UPDATED + DESC_UPDATED: :DESC_UPDATED + ASC_HEIGHT: :ASC_HEIGHT + DESC_HEIGHT: :DESC_HEIGHT + ASC_WIDTH: :ASC_WIDTH + DESC_WIDTH: :DESC_WIDTH + ASC_SIZE: :ASC_SIZE + DESC_SIZE: :DESC_SIZE + ASC_RELEVANCE: :ASC_RELEVANCE + DESC_RELEVANCE: :DESC_RELEVANCE + + def self?.values: -> ::Array[Imagekit::Models::AssetListParams::sort] + end + + type type_ = :file | :"file-version" | :folder | :all + + module Type + extend Imagekit::Internal::Type::Enum + + FILE: :file + FILE_VERSION: :"file-version" + FOLDER: :folder + ALL: :all + + def self?.values: -> ::Array[Imagekit::Models::AssetListParams::type_] + end + end + end +end diff --git a/sig/imagekit/models/files/detail_retrieve_response.rbs b/sig/imagekit/models/asset_list_response.rbs similarity index 56% rename from sig/imagekit/models/files/detail_retrieve_response.rbs rename to sig/imagekit/models/asset_list_response.rbs index 71d7872b..ca47dadc 100644 --- a/sig/imagekit/models/files/detail_retrieve_response.rbs +++ b/sig/imagekit/models/asset_list_response.rbs @@ -1,9 +1,15 @@ module Imagekit module Models - module Files - type detail_retrieve_response = + type asset_list_response_item = + Imagekit::Models::AssetListResponseItem::FileDetails + | Imagekit::Models::AssetListResponseItem::FolderDetails + + module AssetListResponseItem + extend Imagekit::Internal::Type::Union + + type file_details = { - ai_tags: ::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag]?, + ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, created_at: String, custom_coordinates: String?, custom_metadata: top, @@ -22,12 +28,12 @@ module Imagekit type: String, updated_at: String, url: String, - version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, width: Float } - class DetailRetrieveResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag]? + class FileDetails < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]? attr_reader created_at: String? @@ -97,18 +103,18 @@ module Imagekit def url=: (String) -> String - attr_reader version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo? + attr_reader version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo? def version_info=: ( - Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo - ) -> Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo + Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo + ) -> Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo attr_reader width: Float? def width=: (Float) -> Float def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag]?, + ?ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, ?created_at: String, ?custom_coordinates: String?, ?custom_metadata: top, @@ -127,12 +133,12 @@ module Imagekit ?type: String, ?updated_at: String, ?url: String, - ?version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + ?version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, ?width: Float ) -> void def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::Files::DetailRetrieveResponse::AITag]?, + ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, created_at: String, custom_coordinates: String?, custom_metadata: top, @@ -151,7 +157,7 @@ module Imagekit type: String, updated_at: String, url: String, - version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo, + version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, width: Float } @@ -195,6 +201,79 @@ module Imagekit def to_hash: -> { id: String, name: String } end end + + type folder_details = + { + created_at: String, + folder_id: String, + folder_path: String, + name: String, + type: Imagekit::Models::AssetListResponseItem::FolderDetails::type_, + updated_at: String + } + + class FolderDetails < Imagekit::Internal::Type::BaseModel + attr_reader created_at: String? + + def created_at=: (String) -> String + + attr_reader folder_id: String? + + def folder_id=: (String) -> String + + attr_reader folder_path: String? + + def folder_path=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader type: Imagekit::Models::AssetListResponseItem::FolderDetails::type_? + + def type=: ( + Imagekit::Models::AssetListResponseItem::FolderDetails::type_ + ) -> Imagekit::Models::AssetListResponseItem::FolderDetails::type_ + + attr_reader updated_at: String? + + def updated_at=: (String) -> String + + def initialize: ( + ?created_at: String, + ?folder_id: String, + ?folder_path: String, + ?name: String, + ?type: Imagekit::Models::AssetListResponseItem::FolderDetails::type_, + ?updated_at: String + ) -> void + + def to_hash: -> { + created_at: String, + folder_id: String, + folder_path: String, + name: String, + type: Imagekit::Models::AssetListResponseItem::FolderDetails::type_, + updated_at: String + } + + type type_ = :folder + + module Type + extend Imagekit::Internal::Type::Enum + + FOLDER: :folder + + def self?.values: -> ::Array[Imagekit::Models::AssetListResponseItem::FolderDetails::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::asset_list_response_item] end + + type asset_list_response = + ::Array[Imagekit::Models::asset_list_response_item] + + AssetListResponse: Imagekit::Internal::Type::Converter end end diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekit/models/beta/v2/file_upload_params.rbs new file mode 100644 index 00000000..8c630015 --- /dev/null +++ b/sig/imagekit/models/beta/v2/file_upload_params.rbs @@ -0,0 +1,530 @@ +module Imagekit + module Models + module Beta + module V2 + type file_upload_params = + { + file: Imagekit::Internal::file_input, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension], + folder: String, + is_private_file: bool, + is_published: bool, + overwrite_ai_tags: bool, + overwrite_custom_metadata: bool, + overwrite_file: bool, + overwrite_tags: bool, + response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + tags: ::Array[String], + transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, + use_unique_file_name: bool, + webhook_url: String + } + & Imagekit::Internal::Type::request_parameters + + class FileUploadParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file: Imagekit::Internal::file_input + + attr_accessor file_name: String + + attr_reader token: String? + + def token=: (String) -> String + + attr_reader checks: String? + + def checks=: (String) -> String + + attr_reader custom_coordinates: String? + + def custom_coordinates=: (String) -> String + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension]? + + def extensions=: ( + ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] + ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] + + attr_reader folder: String? + + def folder=: (String) -> String + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader overwrite_ai_tags: bool? + + def overwrite_ai_tags=: (bool) -> bool + + attr_reader overwrite_custom_metadata: bool? + + def overwrite_custom_metadata=: (bool) -> bool + + attr_reader overwrite_file: bool? + + def overwrite_file=: (bool) -> bool + + attr_reader overwrite_tags: bool? + + def overwrite_tags=: (bool) -> bool + + attr_reader response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field]? + + def response_fields=: ( + ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] + ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] + + attr_reader tags: ::Array[String]? + + def tags=: (::Array[String]) -> ::Array[String] + + attr_reader transformation: Imagekit::Beta::V2::FileUploadParams::Transformation? + + def transformation=: ( + Imagekit::Beta::V2::FileUploadParams::Transformation + ) -> Imagekit::Beta::V2::FileUploadParams::Transformation + + attr_reader use_unique_file_name: bool? + + def use_unique_file_name=: (bool) -> bool + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + def initialize: ( + file: Imagekit::Internal::file_input, + file_name: String, + ?token: String, + ?checks: String, + ?custom_coordinates: String, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension], + ?folder: String, + ?is_private_file: bool, + ?is_published: bool, + ?overwrite_ai_tags: bool, + ?overwrite_custom_metadata: bool, + ?overwrite_file: bool, + ?overwrite_tags: bool, + ?response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + ?tags: ::Array[String], + ?transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, + ?use_unique_file_name: bool, + ?webhook_url: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file: Imagekit::Internal::file_input, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension], + folder: String, + is_private_file: bool, + is_published: bool, + overwrite_ai_tags: bool, + overwrite_custom_metadata: bool, + overwrite_file: bool, + overwrite_tags: bool, + response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + tags: ::Array[String], + transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, + use_unique_file_name: bool, + webhook_url: String, + request_options: Imagekit::RequestOptions + } + + type extension = + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension + | Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension + | Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + + module Extension + extend Imagekit::Internal::Type::Union + + type removedot_bg_extension = + { + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_ + + attr_reader options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options? + + def options=: ( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + ) -> Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + + def initialize: ( + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + ) -> void + + def to_hash: -> { + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + type name_ = :"remove-bg" + + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG: :"remove-bg" + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_] + end + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_] + end + end + + type auto_description_extension = + { + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + } + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + + def initialize: ( + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + ) -> void + + def to_hash: -> { + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + } + + type name_ = :"ai-auto-description" + + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION: :"ai-auto-description" + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] + end + + type response_field = + :tags + | :customCoordinates + | :isPrivateFile + | :embeddedMetadata + | :isPublished + | :customMetadata + | :metadata + + module ResponseField + extend Imagekit::Internal::Type::Enum + + TAGS: :tags + CUSTOM_COORDINATES: :customCoordinates + IS_PRIVATE_FILE: :isPrivateFile + EMBEDDED_METADATA: :embeddedMetadata + IS_PUBLISHED: :isPublished + CUSTOM_METADATA: :customMetadata + METADATA: :metadata + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] + end + + type transformation = + { + post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post], + pre: String + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_reader post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post]? + + def post=: ( + ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post] + ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post] + + attr_reader pre: String? + + def pre=: (String) -> String + + def initialize: ( + ?post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post], + ?pre: String + ) -> void + + def to_hash: -> { + post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post], + pre: String + } + + type post = + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation + | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo + | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail + | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + + module Post + extend Imagekit::Internal::Type::Union + + type simple_post_transformation = + { + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, + value: String + } + + class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_ + + attr_accessor value: String + + def initialize: ( + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, + value: String + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, + value: String + } + + type type_ = :transformation + + module Type + extend Imagekit::Internal::Type::Enum + + TRANSFORMATION: :transformation + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_] + end + end + + type convert_gif_to_video = + { + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, + value: String + } + + class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_ + + attr_reader value: String? + + def value=: (String) -> String + + def initialize: ( + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, + ?value: String + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, + value: String + } + + type type_ = :"gif-to-video" + + module Type + extend Imagekit::Internal::Type::Enum + + GIF_TO_VIDEO: :"gif-to-video" + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_] + end + end + + type generate_a_thumbnail = + { + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, + value: String + } + + class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_ + + attr_reader value: String? + + def value=: (String) -> String + + def initialize: ( + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, + ?value: String + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, + value: String + } + + type type_ = :thumbnail + + module Type + extend Imagekit::Internal::Type::Enum + + THUMBNAIL: :thumbnail + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_] + end + end + + type adaptive_bitrate_streaming = + { + protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + value: String + } + + class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + attr_accessor protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol + + attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_ + + attr_accessor value: String + + def initialize: ( + protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + value: String + ) -> void + + def to_hash: -> { + protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, + type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + value: String + } + + type protocol = :hls | :dash + + module Protocol + extend Imagekit::Internal::Type::Enum + + HLS: :hls + DASH: :dash + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol] + end + + type type_ = :abs + + module Type + extend Imagekit::Internal::Type::Enum + + ABS: :abs + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post] + end + end + end + end + end + end +end diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs new file mode 100644 index 00000000..0e30b971 --- /dev/null +++ b/sig/imagekit/models/beta/v2/file_upload_response.rbs @@ -0,0 +1,843 @@ +module Imagekit + module Models + module Beta + module V2 + type file_upload_response = + { + ai_tags: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: top, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + + class FileUploadResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]? + + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: ::Hash[Symbol, top]? + + def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus? + + def extension_status=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata? + + def metadata=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail_url: String? + + def thumbnail_url=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo? + + def version_info=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?duration: Integer, + ?embedded_metadata: ::Hash[Symbol, top], + ?extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail_url: String, + ?url: String, + ?version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, + ?video_codec: String, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: top, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type extension_status = + { + aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + + def initialize: ( + ?aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + } + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg] + end + end + + type metadata = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class Metadata < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif? + + def exif=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif? + + def exif=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif + + attr_reader gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps? + + def gps=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps + + attr_reader image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image? + + def image=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image + + attr_reader interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability? + + def interoperability=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail? + + def thumbnail=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + + def initialize: ( + ?exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + ?gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + ?image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + ?interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { + interop_index: String, + interop_version: String + } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end + end + end +end diff --git a/sig/imagekit/models/bulk_job_retrieve_status_response.rbs b/sig/imagekit/models/bulk_job_retrieve_status_response.rbs deleted file mode 100644 index 805c7a28..00000000 --- a/sig/imagekit/models/bulk_job_retrieve_status_response.rbs +++ /dev/null @@ -1,24 +0,0 @@ -module Imagekit - module Models - type bulk_job_retrieve_status_response = - { job_id: String, status: String, type: String } - - class BulkJobRetrieveStatusResponse < Imagekit::Internal::Type::BaseModel - attr_reader job_id: String? - - def job_id=: (String) -> String - - attr_reader status: String? - - def status=: (String) -> String - - attr_reader type: String? - - def type=: (String) -> String - - def initialize: (?job_id: String, ?status: String, ?type: String) -> void - - def to_hash: -> { job_id: String, status: String, type: String } - end - end -end diff --git a/sig/imagekit/models/files/metadata_from_url_params.rbs b/sig/imagekit/models/cache/invalidation_create_params.rbs similarity index 80% rename from sig/imagekit/models/files/metadata_from_url_params.rbs rename to sig/imagekit/models/cache/invalidation_create_params.rbs index 654e1d9f..6bd7b3d4 100644 --- a/sig/imagekit/models/files/metadata_from_url_params.rbs +++ b/sig/imagekit/models/cache/invalidation_create_params.rbs @@ -1,10 +1,10 @@ module Imagekit module Models - module Files - type metadata_from_url_params = + module Cache + type invalidation_create_params = { url: String } & Imagekit::Internal::Type::request_parameters - class MetadataFromURLParams < Imagekit::Internal::Type::BaseModel + class InvalidationCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/files/purge_execute_response.rbs b/sig/imagekit/models/cache/invalidation_create_response.rbs similarity index 61% rename from sig/imagekit/models/files/purge_execute_response.rbs rename to sig/imagekit/models/cache/invalidation_create_response.rbs index 3defae18..9e40cc12 100644 --- a/sig/imagekit/models/files/purge_execute_response.rbs +++ b/sig/imagekit/models/cache/invalidation_create_response.rbs @@ -1,9 +1,9 @@ module Imagekit module Models - module Files - type purge_execute_response = { request_id: String } + module Cache + type invalidation_create_response = { request_id: String } - class PurgeExecuteResponse < Imagekit::Internal::Type::BaseModel + class InvalidationCreateResponse < Imagekit::Internal::Type::BaseModel attr_reader request_id: String? def request_id=: (String) -> String diff --git a/sig/imagekit/models/cache/invalidation_get_params.rbs b/sig/imagekit/models/cache/invalidation_get_params.rbs new file mode 100644 index 00000000..ff6bb012 --- /dev/null +++ b/sig/imagekit/models/cache/invalidation_get_params.rbs @@ -0,0 +1,17 @@ +module Imagekit + module Models + module Cache + type invalidation_get_params = + { } & Imagekit::Internal::Type::request_parameters + + class InvalidationGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/cache/invalidation_get_response.rbs b/sig/imagekit/models/cache/invalidation_get_response.rbs new file mode 100644 index 00000000..0c937b59 --- /dev/null +++ b/sig/imagekit/models/cache/invalidation_get_response.rbs @@ -0,0 +1,35 @@ +module Imagekit + module Models + module Cache + type invalidation_get_response = + { status: Imagekit::Models::Cache::InvalidationGetResponse::status } + + class InvalidationGetResponse < Imagekit::Internal::Type::BaseModel + attr_reader status: Imagekit::Models::Cache::InvalidationGetResponse::status? + + def status=: ( + Imagekit::Models::Cache::InvalidationGetResponse::status + ) -> Imagekit::Models::Cache::InvalidationGetResponse::status + + def initialize: ( + ?status: Imagekit::Models::Cache::InvalidationGetResponse::status + ) -> void + + def to_hash: -> { + status: Imagekit::Models::Cache::InvalidationGetResponse::status + } + + type status = :Pending | :Completed + + module Status + extend Imagekit::Internal::Type::Enum + + PENDING: :Pending + COMPLETED: :Completed + + def self?.values: -> ::Array[Imagekit::Models::Cache::InvalidationGetResponse::status] + end + end + end + end +end diff --git a/sig/imagekit/models/custom_metadata_field_create_params.rbs b/sig/imagekit/models/custom_metadata_field_create_params.rbs index f3045dd6..667751cd 100644 --- a/sig/imagekit/models/custom_metadata_field_create_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_params.rbs @@ -107,7 +107,7 @@ module Imagekit type type_ = :Text - | :TextArea + | :Textarea | :Number | :Date | :Boolean @@ -118,7 +118,7 @@ module Imagekit extend Imagekit::Internal::Type::Enum TEXT: :Text - TEXT_AREA: :TextArea + TEXTAREA: :Textarea NUMBER: :Number DATE: :Date BOOLEAN: :Boolean diff --git a/sig/imagekit/models/custom_metadata_field_create_response.rbs b/sig/imagekit/models/custom_metadata_field_create_response.rbs index 3ba41ec2..dc03ab3c 100644 --- a/sig/imagekit/models/custom_metadata_field_create_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_response.rbs @@ -106,7 +106,7 @@ module Imagekit type type_ = :Text - | :TextArea + | :Textarea | :Number | :Date | :Boolean @@ -117,7 +117,7 @@ module Imagekit extend Imagekit::Internal::Type::Enum TEXT: :Text - TEXT_AREA: :TextArea + TEXTAREA: :Textarea NUMBER: :Number DATE: :Date BOOLEAN: :Boolean diff --git a/sig/imagekit/models/custom_metadata_field_list_response.rbs b/sig/imagekit/models/custom_metadata_field_list_response.rbs index bbc4aad5..9ff08639 100644 --- a/sig/imagekit/models/custom_metadata_field_list_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_list_response.rbs @@ -106,7 +106,7 @@ module Imagekit type type_ = :Text - | :TextArea + | :Textarea | :Number | :Date | :Boolean @@ -117,7 +117,7 @@ module Imagekit extend Imagekit::Internal::Type::Enum TEXT: :Text - TEXT_AREA: :TextArea + TEXTAREA: :Textarea NUMBER: :Number DATE: :Date BOOLEAN: :Boolean diff --git a/sig/imagekit/models/custom_metadata_field_update_response.rbs b/sig/imagekit/models/custom_metadata_field_update_response.rbs index d46979da..5d806344 100644 --- a/sig/imagekit/models/custom_metadata_field_update_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_update_response.rbs @@ -106,7 +106,7 @@ module Imagekit type type_ = :Text - | :TextArea + | :Textarea | :Number | :Date | :Boolean @@ -117,7 +117,7 @@ module Imagekit extend Imagekit::Internal::Type::Enum TEXT: :Text - TEXT_AREA: :TextArea + TEXTAREA: :Textarea NUMBER: :Number DATE: :Date BOOLEAN: :Boolean diff --git a/sig/imagekit/models/exif_details.rbs b/sig/imagekit/models/exif_details.rbs deleted file mode 100644 index 76edd041..00000000 --- a/sig/imagekit/models/exif_details.rbs +++ /dev/null @@ -1,197 +0,0 @@ -module Imagekit - module Models - type exif_details = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class ExifDetails < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - end -end diff --git a/sig/imagekit/models/exif_image.rbs b/sig/imagekit/models/exif_image.rbs deleted file mode 100644 index 684ef926..00000000 --- a/sig/imagekit/models/exif_image.rbs +++ /dev/null @@ -1,92 +0,0 @@ -module Imagekit - module Models - type exif_image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class ExifImage < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - end -end diff --git a/sig/imagekit/models/file_add_tags_params.rbs b/sig/imagekit/models/file_add_tags_params.rbs deleted file mode 100644 index bad61da8..00000000 --- a/sig/imagekit/models/file_add_tags_params.rbs +++ /dev/null @@ -1,28 +0,0 @@ -module Imagekit - module Models - type file_add_tags_params = - { file_ids: ::Array[String], tags: ::Array[String] } - & Imagekit::Internal::Type::request_parameters - - class FileAddTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor file_ids: ::Array[String] - - attr_accessor tags: ::Array[String] - - def initialize: ( - file_ids: ::Array[String], - tags: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file_ids: ::Array[String], - tags: ::Array[String], - request_options: Imagekit::RequestOptions - } - end - end -end diff --git a/sig/imagekit/models/file_add_tags_response.rbs b/sig/imagekit/models/file_add_tags_response.rbs deleted file mode 100644 index e4b1caf9..00000000 --- a/sig/imagekit/models/file_add_tags_response.rbs +++ /dev/null @@ -1,16 +0,0 @@ -module Imagekit - module Models - type file_add_tags_response = - { successfully_updated_file_ids: ::Array[String] } - - class FileAddTagsResponse < Imagekit::Internal::Type::BaseModel - attr_reader successfully_updated_file_ids: ::Array[String]? - - def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] - - def initialize: (?successfully_updated_file_ids: ::Array[String]) -> void - - def to_hash: -> { successfully_updated_file_ids: ::Array[String] } - end - end -end diff --git a/sig/imagekit/models/bulk_job_retrieve_status_params.rbs b/sig/imagekit/models/file_get_params.rbs similarity index 64% rename from sig/imagekit/models/bulk_job_retrieve_status_params.rbs rename to sig/imagekit/models/file_get_params.rbs index 8743f71f..1a204dfb 100644 --- a/sig/imagekit/models/bulk_job_retrieve_status_params.rbs +++ b/sig/imagekit/models/file_get_params.rbs @@ -1,9 +1,8 @@ module Imagekit module Models - type bulk_job_retrieve_status_params = - { } & Imagekit::Internal::Type::request_parameters + type file_get_params = { } & Imagekit::Internal::Type::request_parameters - class BulkJobRetrieveStatusParams < Imagekit::Internal::Type::BaseModel + class FileGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/file_list_response.rbs b/sig/imagekit/models/file_get_response.rbs similarity index 80% rename from sig/imagekit/models/file_list_response.rbs rename to sig/imagekit/models/file_get_response.rbs index 48121562..3ed8c9bd 100644 --- a/sig/imagekit/models/file_list_response.rbs +++ b/sig/imagekit/models/file_get_response.rbs @@ -1,8 +1,8 @@ module Imagekit module Models - type file_list_response_item = + type file_get_response = { - ai_tags: ::Array[Imagekit::Models::FileListResponseItem::AITag]?, + ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, created_at: String, custom_coordinates: String?, custom_metadata: top, @@ -21,12 +21,12 @@ module Imagekit type: String, updated_at: String, url: String, - version_info: Imagekit::Models::FileListResponseItem::VersionInfo, + version_info: Imagekit::Models::FileGetResponse::VersionInfo, width: Float } - class FileListResponseItem < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::FileListResponseItem::AITag]? + class FileGetResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]? attr_reader created_at: String? @@ -96,18 +96,18 @@ module Imagekit def url=: (String) -> String - attr_reader version_info: Imagekit::Models::FileListResponseItem::VersionInfo? + attr_reader version_info: Imagekit::Models::FileGetResponse::VersionInfo? def version_info=: ( - Imagekit::Models::FileListResponseItem::VersionInfo - ) -> Imagekit::Models::FileListResponseItem::VersionInfo + Imagekit::Models::FileGetResponse::VersionInfo + ) -> Imagekit::Models::FileGetResponse::VersionInfo attr_reader width: Float? def width=: (Float) -> Float def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::FileListResponseItem::AITag]?, + ?ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, ?created_at: String, ?custom_coordinates: String?, ?custom_metadata: top, @@ -126,12 +126,12 @@ module Imagekit ?type: String, ?updated_at: String, ?url: String, - ?version_info: Imagekit::Models::FileListResponseItem::VersionInfo, + ?version_info: Imagekit::Models::FileGetResponse::VersionInfo, ?width: Float ) -> void def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::FileListResponseItem::AITag]?, + ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, created_at: String, custom_coordinates: String?, custom_metadata: top, @@ -150,7 +150,7 @@ module Imagekit type: String, updated_at: String, url: String, - version_info: Imagekit::Models::FileListResponseItem::VersionInfo, + version_info: Imagekit::Models::FileGetResponse::VersionInfo, width: Float } @@ -194,9 +194,5 @@ module Imagekit def to_hash: -> { id: String, name: String } end end - - type file_list_response = ::Array[Imagekit::Models::FileListResponseItem] - - FileListResponse: Imagekit::Internal::Type::Converter end end diff --git a/sig/imagekit/models/file_list_params.rbs b/sig/imagekit/models/file_list_params.rbs deleted file mode 100644 index 5a252edd..00000000 --- a/sig/imagekit/models/file_list_params.rbs +++ /dev/null @@ -1,85 +0,0 @@ -module Imagekit - module Models - type file_list_params = - { - file_type: String, - limit: String, - path: String, - search_query: String, - skip: String, - sort: String, - type: Imagekit::Models::FileListParams::type_ - } - & Imagekit::Internal::Type::request_parameters - - class FileListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader limit: String? - - def limit=: (String) -> String - - attr_reader path: String? - - def path=: (String) -> String - - attr_reader search_query: String? - - def search_query=: (String) -> String - - attr_reader skip: String? - - def skip=: (String) -> String - - attr_reader sort: String? - - def sort=: (String) -> String - - attr_reader type: Imagekit::Models::FileListParams::type_? - - def type=: ( - Imagekit::Models::FileListParams::type_ - ) -> Imagekit::Models::FileListParams::type_ - - def initialize: ( - ?file_type: String, - ?limit: String, - ?path: String, - ?search_query: String, - ?skip: String, - ?sort: String, - ?type: Imagekit::Models::FileListParams::type_, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file_type: String, - limit: String, - path: String, - search_query: String, - skip: String, - sort: String, - type: Imagekit::Models::FileListParams::type_, - request_options: Imagekit::RequestOptions - } - - type type_ = :file | :"file-version" | :folder | :all - - module Type - extend Imagekit::Internal::Type::Enum - - FILE: :file - FILE_VERSION: :"file-version" - FOLDER: :folder - ALL: :all - - def self?.values: -> ::Array[Imagekit::Models::FileListParams::type_] - end - end - end -end diff --git a/sig/imagekit/models/file_remove_ai_tags_params.rbs b/sig/imagekit/models/file_remove_ai_tags_params.rbs deleted file mode 100644 index 882092e5..00000000 --- a/sig/imagekit/models/file_remove_ai_tags_params.rbs +++ /dev/null @@ -1,28 +0,0 @@ -module Imagekit - module Models - type file_remove_ai_tags_params = - { ai_tags: ::Array[String], file_ids: ::Array[String] } - & Imagekit::Internal::Type::request_parameters - - class FileRemoveAITagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor ai_tags: ::Array[String] - - attr_accessor file_ids: ::Array[String] - - def initialize: ( - ai_tags: ::Array[String], - file_ids: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - ai_tags: ::Array[String], - file_ids: ::Array[String], - request_options: Imagekit::RequestOptions - } - end - end -end diff --git a/sig/imagekit/models/file_remove_ai_tags_response.rbs b/sig/imagekit/models/file_remove_ai_tags_response.rbs deleted file mode 100644 index 484935a1..00000000 --- a/sig/imagekit/models/file_remove_ai_tags_response.rbs +++ /dev/null @@ -1,16 +0,0 @@ -module Imagekit - module Models - type file_remove_ai_tags_response = - { successfully_updated_file_ids: ::Array[String] } - - class FileRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel - attr_reader successfully_updated_file_ids: ::Array[String]? - - def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] - - def initialize: (?successfully_updated_file_ids: ::Array[String]) -> void - - def to_hash: -> { successfully_updated_file_ids: ::Array[String] } - end - end -end diff --git a/sig/imagekit/models/file_remove_tags_params.rbs b/sig/imagekit/models/file_remove_tags_params.rbs deleted file mode 100644 index 9e7ca69b..00000000 --- a/sig/imagekit/models/file_remove_tags_params.rbs +++ /dev/null @@ -1,28 +0,0 @@ -module Imagekit - module Models - type file_remove_tags_params = - { file_ids: ::Array[String], tags: ::Array[String] } - & Imagekit::Internal::Type::request_parameters - - class FileRemoveTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor file_ids: ::Array[String] - - attr_accessor tags: ::Array[String] - - def initialize: ( - file_ids: ::Array[String], - tags: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file_ids: ::Array[String], - tags: ::Array[String], - request_options: Imagekit::RequestOptions - } - end - end -end diff --git a/sig/imagekit/models/file_remove_tags_response.rbs b/sig/imagekit/models/file_remove_tags_response.rbs deleted file mode 100644 index 0544e0e6..00000000 --- a/sig/imagekit/models/file_remove_tags_response.rbs +++ /dev/null @@ -1,16 +0,0 @@ -module Imagekit - module Models - type file_remove_tags_response = - { successfully_updated_file_ids: ::Array[String] } - - class FileRemoveTagsResponse < Imagekit::Internal::Type::BaseModel - attr_reader successfully_updated_file_ids: ::Array[String]? - - def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] - - def initialize: (?successfully_updated_file_ids: ::Array[String]) -> void - - def to_hash: -> { successfully_updated_file_ids: ::Array[String] } - end - end -end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs new file mode 100644 index 00000000..f78fd3ca --- /dev/null +++ b/sig/imagekit/models/file_update_params.rbs @@ -0,0 +1,260 @@ +module Imagekit + module Models + type file_update_params = + { + custom_coordinates: String?, + custom_metadata: top, + description: String, + extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], + remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish + } + & Imagekit::Internal::Type::request_parameters + + class FileUpdateParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader extensions: ::Array[Imagekit::Models::FileUpdateParams::extension]? + + def extensions=: ( + ::Array[Imagekit::Models::FileUpdateParams::extension] + ) -> ::Array[Imagekit::Models::FileUpdateParams::extension] + + attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags? + + def remove_ai_tags=: ( + Imagekit::Models::FileUpdateParams::remove_ai_tags + ) -> Imagekit::Models::FileUpdateParams::remove_ai_tags + + attr_accessor tags: ::Array[String]? + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + attr_reader publish: Imagekit::FileUpdateParams::Publish? + + def publish=: ( + Imagekit::FileUpdateParams::Publish + ) -> Imagekit::FileUpdateParams::Publish + + def initialize: ( + ?custom_coordinates: String?, + ?custom_metadata: top, + ?description: String, + ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], + ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, + ?publish: Imagekit::FileUpdateParams::Publish, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + custom_coordinates: String?, + custom_metadata: top, + description: String, + extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], + remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish, + request_options: Imagekit::RequestOptions + } + + type extension = + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension + | Imagekit::FileUpdateParams::Extension::AutoTaggingExtension + | Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + + module Extension + extend Imagekit::Internal::Type::Union + + type removedot_bg_extension = + { + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_ + + attr_reader options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options? + + def options=: ( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ) -> Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + + def initialize: ( + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + } + + type name_ = :"remove-bg" + + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG: :"remove-bg" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_] + end + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_] + end + end + + type auto_description_extension = + { + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + } + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + + def initialize: ( + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + } + + type name_ = :"ai-auto-description" + + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION: :"ai-auto-description" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::extension] + end + + type remove_ai_tags = ::Array[String] | :all + + module RemoveAITags + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::remove_ai_tags] + + StringArray: Imagekit::Internal::Type::Converter + + ALL: :all + end + + type publish = { is_published: bool, include_file_versions: bool } + + class Publish < Imagekit::Internal::Type::BaseModel + attr_accessor is_published: bool + + attr_reader include_file_versions: bool? + + def include_file_versions=: (bool) -> bool + + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void + + def to_hash: -> { is_published: bool, include_file_versions: bool } + end + end + end +end diff --git a/sig/imagekit/models/file_update_response.rbs b/sig/imagekit/models/file_update_response.rbs new file mode 100644 index 00000000..57792c82 --- /dev/null +++ b/sig/imagekit/models/file_update_response.rbs @@ -0,0 +1,303 @@ +module Imagekit + module Models + type file_update_response = + { + ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, + width: Float + } + + class FileUpdateResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]? + + attr_reader created_at: String? + + def created_at=: (String) -> String + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus? + + def extension_status=: ( + Imagekit::Models::FileUpdateResponse::ExtensionStatus + ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader has_alpha: bool? + + def has_alpha=: (bool) -> bool + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader mime: String? + + def mime=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail: String? + + def thumbnail=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + attr_reader updated_at: String? + + def updated_at=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::FileUpdateResponse::VersionInfo? + + def version_info=: ( + Imagekit::Models::FileUpdateResponse::VersionInfo + ) -> Imagekit::Models::FileUpdateResponse::VersionInfo + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, + ?created_at: String, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?has_alpha: bool, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?mime: String, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail: String, + ?type: String, + ?updated_at: String, + ?url: String, + ?version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, + created_at: String, + custom_coordinates: String?, + custom_metadata: top, + extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + has_alpha: bool, + height: Float, + is_private_file: bool, + is_published: bool, + mime: String, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail: String, + type: String, + updated_at: String, + url: String, + version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type extension_status = + { + ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description? + + def ai_auto_description=: ( + Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description + ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description + + attr_reader aws_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging + ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging + ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg + ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg + + def initialize: ( + ?ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + ?aws_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg + } + + type ai_auto_description = :success | :pending | :failed + + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description] + end + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg] + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end +end diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs new file mode 100644 index 00000000..b9b40672 --- /dev/null +++ b/sig/imagekit/models/file_upload_params.rbs @@ -0,0 +1,547 @@ +module Imagekit + module Models + type file_upload_params = + { + file: Imagekit::Internal::file_input, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: ::Hash[Symbol, top], + description: String, + expire: Integer, + extensions: ::Array[Imagekit::Models::FileUploadParams::extension], + folder: String, + is_private_file: bool, + is_published: bool, + overwrite_ai_tags: bool, + overwrite_custom_metadata: bool, + overwrite_file: bool, + overwrite_tags: bool, + public_key: String, + response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + signature: String, + tags: ::Array[String], + transformation: Imagekit::FileUploadParams::Transformation, + use_unique_file_name: bool, + webhook_url: String + } + & Imagekit::Internal::Type::request_parameters + + class FileUploadParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file: Imagekit::Internal::file_input + + attr_accessor file_name: String + + attr_reader token: String? + + def token=: (String) -> String + + attr_reader checks: String? + + def checks=: (String) -> String + + attr_reader custom_coordinates: String? + + def custom_coordinates=: (String) -> String + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader expire: Integer? + + def expire=: (Integer) -> Integer + + attr_reader extensions: ::Array[Imagekit::Models::FileUploadParams::extension]? + + def extensions=: ( + ::Array[Imagekit::Models::FileUploadParams::extension] + ) -> ::Array[Imagekit::Models::FileUploadParams::extension] + + attr_reader folder: String? + + def folder=: (String) -> String + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader overwrite_ai_tags: bool? + + def overwrite_ai_tags=: (bool) -> bool + + attr_reader overwrite_custom_metadata: bool? + + def overwrite_custom_metadata=: (bool) -> bool + + attr_reader overwrite_file: bool? + + def overwrite_file=: (bool) -> bool + + attr_reader overwrite_tags: bool? + + def overwrite_tags=: (bool) -> bool + + attr_reader public_key: String? + + def public_key=: (String) -> String + + attr_reader response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field]? + + def response_fields=: ( + ::Array[Imagekit::Models::FileUploadParams::response_field] + ) -> ::Array[Imagekit::Models::FileUploadParams::response_field] + + attr_reader signature: String? + + def signature=: (String) -> String + + attr_reader tags: ::Array[String]? + + def tags=: (::Array[String]) -> ::Array[String] + + attr_reader transformation: Imagekit::FileUploadParams::Transformation? + + def transformation=: ( + Imagekit::FileUploadParams::Transformation + ) -> Imagekit::FileUploadParams::Transformation + + attr_reader use_unique_file_name: bool? + + def use_unique_file_name=: (bool) -> bool + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + def initialize: ( + file: Imagekit::Internal::file_input, + file_name: String, + ?token: String, + ?checks: String, + ?custom_coordinates: String, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?expire: Integer, + ?extensions: ::Array[Imagekit::Models::FileUploadParams::extension], + ?folder: String, + ?is_private_file: bool, + ?is_published: bool, + ?overwrite_ai_tags: bool, + ?overwrite_custom_metadata: bool, + ?overwrite_file: bool, + ?overwrite_tags: bool, + ?public_key: String, + ?response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + ?signature: String, + ?tags: ::Array[String], + ?transformation: Imagekit::FileUploadParams::Transformation, + ?use_unique_file_name: bool, + ?webhook_url: String, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file: Imagekit::Internal::file_input, + file_name: String, + token: String, + checks: String, + custom_coordinates: String, + custom_metadata: ::Hash[Symbol, top], + description: String, + expire: Integer, + extensions: ::Array[Imagekit::Models::FileUploadParams::extension], + folder: String, + is_private_file: bool, + is_published: bool, + overwrite_ai_tags: bool, + overwrite_custom_metadata: bool, + overwrite_file: bool, + overwrite_tags: bool, + public_key: String, + response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + signature: String, + tags: ::Array[String], + transformation: Imagekit::FileUploadParams::Transformation, + use_unique_file_name: bool, + webhook_url: String, + request_options: Imagekit::RequestOptions + } + + type extension = + Imagekit::FileUploadParams::Extension::RemovedotBgExtension + | Imagekit::FileUploadParams::Extension::AutoTaggingExtension + | Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + + module Extension + extend Imagekit::Internal::Type::Union + + type removedot_bg_extension = + { + name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_ + + attr_reader options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options? + + def options=: ( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + ) -> Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + + def initialize: ( + name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + type name_ = :"remove-bg" + + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG: :"remove-bg" + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_] + end + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_] + end + end + + type auto_description_extension = + { + name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + } + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + + def initialize: ( + name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + } + + type name_ = :"ai-auto-description" + + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION: :"ai-auto-description" + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::extension] + end + + type response_field = + :tags + | :customCoordinates + | :isPrivateFile + | :embeddedMetadata + | :isPublished + | :customMetadata + | :metadata + + module ResponseField + extend Imagekit::Internal::Type::Enum + + TAGS: :tags + CUSTOM_COORDINATES: :customCoordinates + IS_PRIVATE_FILE: :isPrivateFile + EMBEDDED_METADATA: :embeddedMetadata + IS_PUBLISHED: :isPublished + CUSTOM_METADATA: :customMetadata + METADATA: :metadata + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::response_field] + end + + type transformation = + { + post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post], + pre: String + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_reader post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post]? + + def post=: ( + ::Array[Imagekit::Models::FileUploadParams::Transformation::post] + ) -> ::Array[Imagekit::Models::FileUploadParams::Transformation::post] + + attr_reader pre: String? + + def pre=: (String) -> String + + def initialize: ( + ?post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post], + ?pre: String + ) -> void + + def to_hash: -> { + post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post], + pre: String + } + + type post = + Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation + | Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo + | Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail + | Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + + module Post + extend Imagekit::Internal::Type::Union + + type simple_post_transformation = + { + type: Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, + value: String + } + + class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_ + + attr_accessor value: String + + def initialize: ( + type: Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, + value: String + ) -> void + + def to_hash: -> { + type: Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, + value: String + } + + type type_ = :transformation + + module Type + extend Imagekit::Internal::Type::Enum + + TRANSFORMATION: :transformation + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_] + end + end + + type convert_gif_to_video = + { + type: Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, + value: String + } + + class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_ + + attr_reader value: String? + + def value=: (String) -> String + + def initialize: ( + type: Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, + ?value: String + ) -> void + + def to_hash: -> { + type: Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, + value: String + } + + type type_ = :"gif-to-video" + + module Type + extend Imagekit::Internal::Type::Enum + + GIF_TO_VIDEO: :"gif-to-video" + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_] + end + end + + type generate_a_thumbnail = + { + type: Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, + value: String + } + + class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_ + + attr_reader value: String? + + def value=: (String) -> String + + def initialize: ( + type: Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, + ?value: String + ) -> void + + def to_hash: -> { + type: Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, + value: String + } + + type type_ = :thumbnail + + module Type + extend Imagekit::Internal::Type::Enum + + THUMBNAIL: :thumbnail + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_] + end + end + + type adaptive_bitrate_streaming = + { + protocol: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, + type: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + value: String + } + + class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + attr_accessor protocol: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol + + attr_accessor type: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_ + + attr_accessor value: String + + def initialize: ( + protocol: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, + type: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + value: String + ) -> void + + def to_hash: -> { + protocol: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, + type: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + value: String + } + + type protocol = :hls | :dash + + module Protocol + extend Imagekit::Internal::Type::Enum + + HLS: :hls + DASH: :dash + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol] + end + + type type_ = :abs + + module Type + extend Imagekit::Internal::Type::Enum + + ABS: :abs + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_] + end + end + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::post] + end + end + end + end +end diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs new file mode 100644 index 00000000..7f8e58d4 --- /dev/null +++ b/sig/imagekit/models/file_upload_response.rbs @@ -0,0 +1,836 @@ +module Imagekit + module Models + type file_upload_response = + { + ai_tags: ::Array[Imagekit::Models::FileUploadResponse::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: top, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Models::FileUploadResponse::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + + class FileUploadResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::FileUploadResponse::AITag]? + + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: top? + + def custom_metadata=: (top) -> top + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: ::Hash[Symbol, top]? + + def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus? + + def extension_status=: ( + Imagekit::Models::FileUploadResponse::ExtensionStatus + ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader metadata: Imagekit::Models::FileUploadResponse::Metadata? + + def metadata=: ( + Imagekit::Models::FileUploadResponse::Metadata + ) -> Imagekit::Models::FileUploadResponse::Metadata + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail_url: String? + + def thumbnail_url=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::Models::FileUploadResponse::VersionInfo? + + def version_info=: ( + Imagekit::Models::FileUploadResponse::VersionInfo + ) -> Imagekit::Models::FileUploadResponse::VersionInfo + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::Models::FileUploadResponse::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?duration: Integer, + ?embedded_metadata: ::Hash[Symbol, top], + ?extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?metadata: Imagekit::Models::FileUploadResponse::Metadata, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail_url: String, + ?url: String, + ?version_info: Imagekit::Models::FileUploadResponse::VersionInfo, + ?video_codec: String, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::Models::FileUploadResponse::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: top, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Models::FileUploadResponse::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::Models::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type extension_status = + { + aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging + ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging + ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg + ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg + + def initialize: ( + ?aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg + } + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg] + end + end + + type metadata = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class Metadata < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Models::FileUploadResponse::Metadata::Exif? + + def exif=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Models::FileUploadResponse::Metadata::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif? + + def exif=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif + + attr_reader gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps? + + def gps=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps + + attr_reader image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image? + + def image=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Image + + attr_reader interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability? + + def interoperability=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail? + + def thumbnail=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + + def initialize: ( + ?exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + ?gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + ?image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + ?interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end +end diff --git a/sig/imagekit/models/file_upload_v1_params.rbs b/sig/imagekit/models/file_upload_v1_params.rbs deleted file mode 100644 index 2395e995..00000000 --- a/sig/imagekit/models/file_upload_v1_params.rbs +++ /dev/null @@ -1,249 +0,0 @@ -module Imagekit - module Models - type file_upload_v1_params = - { - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - expire: String, - extensions: String, - folder: String, - is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file, - is_published: Imagekit::Models::FileUploadV1Params::is_published, - overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags, - overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata, - overwrite_file: String, - overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags, - public_key: String, - response_fields: String, - signature: String, - tags: String, - transformation: String, - use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name, - webhook_url: String - } - & Imagekit::Internal::Type::request_parameters - - class FileUploadV1Params < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor file: String - - attr_accessor file_name: String - - attr_reader token: String? - - def token=: (String) -> String - - attr_reader checks: String? - - def checks=: (String) -> String - - attr_reader custom_coordinates: String? - - def custom_coordinates=: (String) -> String - - attr_reader custom_metadata: String? - - def custom_metadata=: (String) -> String - - attr_reader expire: String? - - def expire=: (String) -> String - - attr_reader extensions: String? - - def extensions=: (String) -> String - - attr_reader folder: String? - - def folder=: (String) -> String - - attr_reader is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file? - - def is_private_file=: ( - Imagekit::Models::FileUploadV1Params::is_private_file - ) -> Imagekit::Models::FileUploadV1Params::is_private_file - - attr_reader is_published: Imagekit::Models::FileUploadV1Params::is_published? - - def is_published=: ( - Imagekit::Models::FileUploadV1Params::is_published - ) -> Imagekit::Models::FileUploadV1Params::is_published - - attr_reader overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags? - - def overwrite_ai_tags=: ( - Imagekit::Models::FileUploadV1Params::overwrite_ai_tags - ) -> Imagekit::Models::FileUploadV1Params::overwrite_ai_tags - - attr_reader overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata? - - def overwrite_custom_metadata=: ( - Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata - ) -> Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata - - attr_reader overwrite_file: String? - - def overwrite_file=: (String) -> String - - attr_reader overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags? - - def overwrite_tags=: ( - Imagekit::Models::FileUploadV1Params::overwrite_tags - ) -> Imagekit::Models::FileUploadV1Params::overwrite_tags - - attr_reader public_key: String? - - def public_key=: (String) -> String - - attr_reader response_fields: String? - - def response_fields=: (String) -> String - - attr_reader signature: String? - - def signature=: (String) -> String - - attr_reader tags: String? - - def tags=: (String) -> String - - attr_reader transformation: String? - - def transformation=: (String) -> String - - attr_reader use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name? - - def use_unique_file_name=: ( - Imagekit::Models::FileUploadV1Params::use_unique_file_name - ) -> Imagekit::Models::FileUploadV1Params::use_unique_file_name - - attr_reader webhook_url: String? - - def webhook_url=: (String) -> String - - def initialize: ( - file: String, - file_name: String, - ?token: String, - ?checks: String, - ?custom_coordinates: String, - ?custom_metadata: String, - ?expire: String, - ?extensions: String, - ?folder: String, - ?is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file, - ?is_published: Imagekit::Models::FileUploadV1Params::is_published, - ?overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags, - ?overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata, - ?overwrite_file: String, - ?overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags, - ?public_key: String, - ?response_fields: String, - ?signature: String, - ?tags: String, - ?transformation: String, - ?use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name, - ?webhook_url: String, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - expire: String, - extensions: String, - folder: String, - is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file, - is_published: Imagekit::Models::FileUploadV1Params::is_published, - overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags, - overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata, - overwrite_file: String, - overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags, - public_key: String, - response_fields: String, - signature: String, - tags: String, - transformation: String, - use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name, - webhook_url: String, - request_options: Imagekit::RequestOptions - } - - type is_private_file = :true | :false - - module IsPrivateFile - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::is_private_file] - end - - type is_published = :true | :false - - module IsPublished - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::is_published] - end - - type overwrite_ai_tags = :true | :false - - module OverwriteAITags - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::overwrite_ai_tags] - end - - type overwrite_custom_metadata = :true | :false - - module OverwriteCustomMetadata - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata] - end - - type overwrite_tags = :true | :false - - module OverwriteTags - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::overwrite_tags] - end - - type use_unique_file_name = :true | :false - - module UseUniqueFileName - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Params::use_unique_file_name] - end - end - end -end diff --git a/sig/imagekit/models/file_upload_v1_response.rbs b/sig/imagekit/models/file_upload_v1_response.rbs deleted file mode 100644 index 951f9136..00000000 --- a/sig/imagekit/models/file_upload_v1_response.rbs +++ /dev/null @@ -1,1741 +0,0 @@ -module Imagekit - module Models - type file_upload_v1_response = - { - ai_tags: ::Array[Imagekit::Models::FileUploadV1Response::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: top, - duration: Integer, - embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, - extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Models::FileUploadV1Response::Metadata, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::FileUploadV1Response::VersionInfo, - video_codec: String, - width: Float - } - - class FileUploadV1Response < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::FileUploadV1Response::AITag]? - - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: top? - - def custom_metadata=: (top) -> top - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata? - - def embedded_metadata=: ( - Imagekit::Models::FileUploadV1Response::EmbeddedMetadata - ) -> Imagekit::Models::FileUploadV1Response::EmbeddedMetadata - - attr_reader extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus? - - def extension_status=: ( - Imagekit::Models::FileUploadV1Response::ExtensionStatus - ) -> Imagekit::Models::FileUploadV1Response::ExtensionStatus - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader metadata: Imagekit::Models::FileUploadV1Response::Metadata? - - def metadata=: ( - Imagekit::Models::FileUploadV1Response::Metadata - ) -> Imagekit::Models::FileUploadV1Response::Metadata - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail_url: String? - - def thumbnail_url=: (String) -> String - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::FileUploadV1Response::VersionInfo? - - def version_info=: ( - Imagekit::Models::FileUploadV1Response::VersionInfo - ) -> Imagekit::Models::FileUploadV1Response::VersionInfo - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::FileUploadV1Response::AITag]?, - ?audio_codec: String, - ?bit_rate: Integer, - ?custom_coordinates: String?, - ?custom_metadata: top, - ?duration: Integer, - ?embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, - ?extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus, - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?metadata: Imagekit::Models::FileUploadV1Response::Metadata, - ?name: String, - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail_url: String, - ?url: String, - ?version_info: Imagekit::Models::FileUploadV1Response::VersionInfo, - ?video_codec: String, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::FileUploadV1Response::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: top, - duration: Integer, - embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata, - extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Models::FileUploadV1Response::Metadata, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::FileUploadV1Response::VersionInfo, - video_codec: String, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type embedded_metadata = - { - about_cv_term_cv_id: String, - about_cv_term_id: String, - about_cv_term_name: String, - about_cv_term_refined_about: String, - additional_model_information: String, - application_record_version: Integer, - artist: String, - artwork_circa_date_created: String, - artwork_content_description: String, - artwork_contribution_description: String, - artwork_copyright_notice: String, - artwork_copyright_owner_id: String, - artwork_copyright_owner_name: String, - artwork_creator: ::Array[String], - artwork_creator_id: ::Array[String], - artwork_date_created: Time, - artwork_licensor_id: String, - artwork_licensor_name: String, - artwork_physical_description: String, - artwork_source: String, - artwork_source_inventory_no: String, - artwork_source_inv_url: String, - artwork_style_period: ::Array[String], - artwork_title: String, - authors_position: String, - byline: String, - byline_title: String, - caption: String, - caption_abstract: String, - caption_writer: String, - city: String, - color_space: String, - components_configuration: String, - copyright: String, - copyright_notice: String, - copyright_owner_id: ::Array[String], - copyright_owner_name: ::Array[String], - country: String, - country_code: String, - country_primary_location_code: String, - country_primary_location_name: String, - creator: String, - creator_address: String, - creator_city: String, - creator_country: String, - creator_postal_code: String, - creator_region: String, - creator_work_email: String, - creator_work_telephone: String, - creator_work_url: String, - credit: String, - date_created: Time, - date_time_created: Time, - date_time_original: Time, - description: String, - digital_image_guid: String, - digital_source_type: String, - embedded_encoded_rights_expr: String, - embedded_encoded_rights_expr_lang_id: String, - embedded_encoded_rights_expr_type: String, - event: String, - exif_version: String, - flashpix_version: String, - genre_cv_id: String, - genre_cv_term_id: String, - genre_cv_term_name: String, - genre_cv_term_refined_about: String, - headline: String, - image_creator_id: String, - image_creator_image_id: String, - image_creator_name: String, - image_description: String, - image_region_boundary_h: ::Array[Float], - image_region_boundary_rx: ::Array[Float], - image_region_boundary_shape: ::Array[String], - image_region_boundary_unit: ::Array[String], - image_region_boundary_vertices_x: ::Array[Float], - image_region_boundary_vertices_y: ::Array[Float], - image_region_boundary_w: ::Array[Float], - image_region_boundary_x: ::Array[Float], - image_region_boundary_y: ::Array[Float], - image_region_ctype_identifier: ::Array[String], - image_region_ctype_name: ::Array[String], - image_region_id: ::Array[String], - image_region_name: ::Array[String], - image_region_organisation_in_image_name: ::Array[String], - image_region_person_in_image: ::Array[String], - image_region_role_identifier: ::Array[String], - image_region_role_name: ::Array[String], - image_supplier_id: String, - image_supplier_image_id: String, - image_supplier_name: String, - instructions: String, - intellectual_genre: String, - keywords: ::Array[String], - licensor_city: ::Array[String], - licensor_country: ::Array[String], - licensor_email: ::Array[String], - licensor_extended_address: ::Array[String], - licensor_id: ::Array[String], - licensor_name: ::Array[String], - licensor_postal_code: ::Array[String], - licensor_region: ::Array[String], - licensor_street_address: ::Array[String], - :licensor_telephone1 => ::Array[String], - :licensor_telephone2 => ::Array[String], - licensor_url: ::Array[String], - linked_encoded_rights_expr: String, - linked_encoded_rights_expr_lang_id: String, - linked_encoded_rights_expr_type: String, - location: String, - location_created_city: String, - location_created_country_code: String, - location_created_country_name: String, - location_created_gps_altitude: String, - location_created_gps_latitude: String, - location_created_gps_longitude: String, - location_created_location_id: String, - location_created_location_name: String, - location_created_province_state: String, - location_created_sublocation: String, - location_created_world_region: String, - location_shown_city: ::Array[String], - location_shown_country_code: ::Array[String], - location_shown_country_name: ::Array[String], - location_shown_gps_altitude: ::Array[String], - location_shown_gps_latitude: ::Array[String], - location_shown_gps_longitude: ::Array[String], - location_shown_location_id: ::Array[String], - location_shown_location_name: ::Array[String], - location_shown_province_state: ::Array[String], - location_shown_sublocation: ::Array[String], - location_shown_world_region: ::Array[String], - max_avail_height: Float, - max_avail_width: Float, - model_age: ::Array[Float], - model_release_id: ::Array[String], - object_attribute_reference: String, - object_name: String, - offset_time_original: String, - organisation_in_image_code: ::Array[String], - organisation_in_image_name: ::Array[String], - orientation: String, - original_transmission_reference: String, - person_in_image: ::Array[String], - person_in_image_cv_term_cv_id: ::Array[String], - person_in_image_cv_term_id: ::Array[String], - person_in_image_cv_term_name: ::Array[String], - person_in_image_cv_term_refined_about: ::Array[String], - person_in_image_description: ::Array[String], - person_in_image_id: ::Array[String], - person_in_image_name: ::Array[String], - product_in_image_description: ::Array[String], - product_in_image_gtin: ::Array[Float], - product_in_image_name: ::Array[String], - property_release_id: ::Array[String], - province_state: String, - rating: Integer, - registry_entry_role: ::Array[String], - registry_item_id: ::Array[String], - registry_organisation_id: ::Array[String], - resolution_unit: String, - rights: String, - scene: ::Array[String], - source: String, - special_instructions: String, - state: String, - subject: ::Array[String], - subject_code: ::Array[String], - subject_reference: ::Array[String], - sublocation: String, - time_created: String, - title: String, - transmission_reference: String, - usage_terms: String, - web_statement: String, - writer: String, - writer_editor: String, - x_resolution: Float, - y_resolution: Float - } - - class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel - attr_reader about_cv_term_cv_id: String? - - def about_cv_term_cv_id=: (String) -> String - - attr_reader about_cv_term_id: String? - - def about_cv_term_id=: (String) -> String - - attr_reader about_cv_term_name: String? - - def about_cv_term_name=: (String) -> String - - attr_reader about_cv_term_refined_about: String? - - def about_cv_term_refined_about=: (String) -> String - - attr_reader additional_model_information: String? - - def additional_model_information=: (String) -> String - - attr_reader application_record_version: Integer? - - def application_record_version=: (Integer) -> Integer - - attr_reader artist: String? - - def artist=: (String) -> String - - attr_reader artwork_circa_date_created: String? - - def artwork_circa_date_created=: (String) -> String - - attr_reader artwork_content_description: String? - - def artwork_content_description=: (String) -> String - - attr_reader artwork_contribution_description: String? - - def artwork_contribution_description=: (String) -> String - - attr_reader artwork_copyright_notice: String? - - def artwork_copyright_notice=: (String) -> String - - attr_reader artwork_copyright_owner_id: String? - - def artwork_copyright_owner_id=: (String) -> String - - attr_reader artwork_copyright_owner_name: String? - - def artwork_copyright_owner_name=: (String) -> String - - attr_reader artwork_creator: ::Array[String]? - - def artwork_creator=: (::Array[String]) -> ::Array[String] - - attr_reader artwork_creator_id: ::Array[String]? - - def artwork_creator_id=: (::Array[String]) -> ::Array[String] - - attr_reader artwork_date_created: Time? - - def artwork_date_created=: (Time) -> Time - - attr_reader artwork_licensor_id: String? - - def artwork_licensor_id=: (String) -> String - - attr_reader artwork_licensor_name: String? - - def artwork_licensor_name=: (String) -> String - - attr_reader artwork_physical_description: String? - - def artwork_physical_description=: (String) -> String - - attr_reader artwork_source: String? - - def artwork_source=: (String) -> String - - attr_reader artwork_source_inventory_no: String? - - def artwork_source_inventory_no=: (String) -> String - - attr_reader artwork_source_inv_url: String? - - def artwork_source_inv_url=: (String) -> String - - attr_reader artwork_style_period: ::Array[String]? - - def artwork_style_period=: (::Array[String]) -> ::Array[String] - - attr_reader artwork_title: String? - - def artwork_title=: (String) -> String - - attr_reader authors_position: String? - - def authors_position=: (String) -> String - - attr_reader byline: String? - - def byline=: (String) -> String - - attr_reader byline_title: String? - - def byline_title=: (String) -> String - - attr_reader caption: String? - - def caption=: (String) -> String - - attr_reader caption_abstract: String? - - def caption_abstract=: (String) -> String - - attr_reader caption_writer: String? - - def caption_writer=: (String) -> String - - attr_reader city: String? - - def city=: (String) -> String - - attr_reader color_space: String? - - def color_space=: (String) -> String - - attr_reader components_configuration: String? - - def components_configuration=: (String) -> String - - attr_reader copyright: String? - - def copyright=: (String) -> String - - attr_reader copyright_notice: String? - - def copyright_notice=: (String) -> String - - attr_reader copyright_owner_id: ::Array[String]? - - def copyright_owner_id=: (::Array[String]) -> ::Array[String] - - attr_reader copyright_owner_name: ::Array[String]? - - def copyright_owner_name=: (::Array[String]) -> ::Array[String] - - attr_reader country: String? - - def country=: (String) -> String - - attr_reader country_code: String? - - def country_code=: (String) -> String - - attr_reader country_primary_location_code: String? - - def country_primary_location_code=: (String) -> String - - attr_reader country_primary_location_name: String? - - def country_primary_location_name=: (String) -> String - - attr_reader creator: String? - - def creator=: (String) -> String - - attr_reader creator_address: String? - - def creator_address=: (String) -> String - - attr_reader creator_city: String? - - def creator_city=: (String) -> String - - attr_reader creator_country: String? - - def creator_country=: (String) -> String - - attr_reader creator_postal_code: String? - - def creator_postal_code=: (String) -> String - - attr_reader creator_region: String? - - def creator_region=: (String) -> String - - attr_reader creator_work_email: String? - - def creator_work_email=: (String) -> String - - attr_reader creator_work_telephone: String? - - def creator_work_telephone=: (String) -> String - - attr_reader creator_work_url: String? - - def creator_work_url=: (String) -> String - - attr_reader credit: String? - - def credit=: (String) -> String - - attr_reader date_created: Time? - - def date_created=: (Time) -> Time - - attr_reader date_time_created: Time? - - def date_time_created=: (Time) -> Time - - attr_reader date_time_original: Time? - - def date_time_original=: (Time) -> Time - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader digital_image_guid: String? - - def digital_image_guid=: (String) -> String - - attr_reader digital_source_type: String? - - def digital_source_type=: (String) -> String - - attr_reader embedded_encoded_rights_expr: String? - - def embedded_encoded_rights_expr=: (String) -> String - - attr_reader embedded_encoded_rights_expr_lang_id: String? - - def embedded_encoded_rights_expr_lang_id=: (String) -> String - - attr_reader embedded_encoded_rights_expr_type: String? - - def embedded_encoded_rights_expr_type=: (String) -> String - - attr_reader event: String? - - def event=: (String) -> String - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader genre_cv_id: String? - - def genre_cv_id=: (String) -> String - - attr_reader genre_cv_term_id: String? - - def genre_cv_term_id=: (String) -> String - - attr_reader genre_cv_term_name: String? - - def genre_cv_term_name=: (String) -> String - - attr_reader genre_cv_term_refined_about: String? - - def genre_cv_term_refined_about=: (String) -> String - - attr_reader headline: String? - - def headline=: (String) -> String - - attr_reader image_creator_id: String? - - def image_creator_id=: (String) -> String - - attr_reader image_creator_image_id: String? - - def image_creator_image_id=: (String) -> String - - attr_reader image_creator_name: String? - - def image_creator_name=: (String) -> String - - attr_reader image_description: String? - - def image_description=: (String) -> String - - attr_reader image_region_boundary_h: ::Array[Float]? - - def image_region_boundary_h=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_boundary_rx: ::Array[Float]? - - def image_region_boundary_rx=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_boundary_shape: ::Array[String]? - - def image_region_boundary_shape=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_boundary_unit: ::Array[String]? - - def image_region_boundary_unit=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_boundary_vertices_x: ::Array[Float]? - - def image_region_boundary_vertices_x=: ( - ::Array[Float] - ) -> ::Array[Float] - - attr_reader image_region_boundary_vertices_y: ::Array[Float]? - - def image_region_boundary_vertices_y=: ( - ::Array[Float] - ) -> ::Array[Float] - - attr_reader image_region_boundary_w: ::Array[Float]? - - def image_region_boundary_w=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_boundary_x: ::Array[Float]? - - def image_region_boundary_x=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_boundary_y: ::Array[Float]? - - def image_region_boundary_y=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_ctype_identifier: ::Array[String]? - - def image_region_ctype_identifier=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_ctype_name: ::Array[String]? - - def image_region_ctype_name=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_id: ::Array[String]? - - def image_region_id=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_name: ::Array[String]? - - def image_region_name=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_organisation_in_image_name: ::Array[String]? - - def image_region_organisation_in_image_name=: ( - ::Array[String] - ) -> ::Array[String] - - attr_reader image_region_person_in_image: ::Array[String]? - - def image_region_person_in_image=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_role_identifier: ::Array[String]? - - def image_region_role_identifier=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_role_name: ::Array[String]? - - def image_region_role_name=: (::Array[String]) -> ::Array[String] - - attr_reader image_supplier_id: String? - - def image_supplier_id=: (String) -> String - - attr_reader image_supplier_image_id: String? - - def image_supplier_image_id=: (String) -> String - - attr_reader image_supplier_name: String? - - def image_supplier_name=: (String) -> String - - attr_reader instructions: String? - - def instructions=: (String) -> String - - attr_reader intellectual_genre: String? - - def intellectual_genre=: (String) -> String - - attr_reader keywords: ::Array[String]? - - def keywords=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_city: ::Array[String]? - - def licensor_city=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_country: ::Array[String]? - - def licensor_country=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_email: ::Array[String]? - - def licensor_email=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_extended_address: ::Array[String]? - - def licensor_extended_address=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_id: ::Array[String]? - - def licensor_id=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_name: ::Array[String]? - - def licensor_name=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_postal_code: ::Array[String]? - - def licensor_postal_code=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_region: ::Array[String]? - - def licensor_region=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_street_address: ::Array[String]? - - def licensor_street_address=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_telephone1: ::Array[String]? - - def licensor_telephone1=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_telephone2: ::Array[String]? - - def licensor_telephone2=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_url: ::Array[String]? - - def licensor_url=: (::Array[String]) -> ::Array[String] - - attr_reader linked_encoded_rights_expr: String? - - def linked_encoded_rights_expr=: (String) -> String - - attr_reader linked_encoded_rights_expr_lang_id: String? - - def linked_encoded_rights_expr_lang_id=: (String) -> String - - attr_reader linked_encoded_rights_expr_type: String? - - def linked_encoded_rights_expr_type=: (String) -> String - - attr_reader location: String? - - def location=: (String) -> String - - attr_reader location_created_city: String? - - def location_created_city=: (String) -> String - - attr_reader location_created_country_code: String? - - def location_created_country_code=: (String) -> String - - attr_reader location_created_country_name: String? - - def location_created_country_name=: (String) -> String - - attr_reader location_created_gps_altitude: String? - - def location_created_gps_altitude=: (String) -> String - - attr_reader location_created_gps_latitude: String? - - def location_created_gps_latitude=: (String) -> String - - attr_reader location_created_gps_longitude: String? - - def location_created_gps_longitude=: (String) -> String - - attr_reader location_created_location_id: String? - - def location_created_location_id=: (String) -> String - - attr_reader location_created_location_name: String? - - def location_created_location_name=: (String) -> String - - attr_reader location_created_province_state: String? - - def location_created_province_state=: (String) -> String - - attr_reader location_created_sublocation: String? - - def location_created_sublocation=: (String) -> String - - attr_reader location_created_world_region: String? - - def location_created_world_region=: (String) -> String - - attr_reader location_shown_city: ::Array[String]? - - def location_shown_city=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_country_code: ::Array[String]? - - def location_shown_country_code=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_country_name: ::Array[String]? - - def location_shown_country_name=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_gps_altitude: ::Array[String]? - - def location_shown_gps_altitude=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_gps_latitude: ::Array[String]? - - def location_shown_gps_latitude=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_gps_longitude: ::Array[String]? - - def location_shown_gps_longitude=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_location_id: ::Array[String]? - - def location_shown_location_id=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_location_name: ::Array[String]? - - def location_shown_location_name=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_province_state: ::Array[String]? - - def location_shown_province_state=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_sublocation: ::Array[String]? - - def location_shown_sublocation=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_world_region: ::Array[String]? - - def location_shown_world_region=: (::Array[String]) -> ::Array[String] - - attr_reader max_avail_height: Float? - - def max_avail_height=: (Float) -> Float - - attr_reader max_avail_width: Float? - - def max_avail_width=: (Float) -> Float - - attr_reader model_age: ::Array[Float]? - - def model_age=: (::Array[Float]) -> ::Array[Float] - - attr_reader model_release_id: ::Array[String]? - - def model_release_id=: (::Array[String]) -> ::Array[String] - - attr_reader object_attribute_reference: String? - - def object_attribute_reference=: (String) -> String - - attr_reader object_name: String? - - def object_name=: (String) -> String - - attr_reader offset_time_original: String? - - def offset_time_original=: (String) -> String - - attr_reader organisation_in_image_code: ::Array[String]? - - def organisation_in_image_code=: (::Array[String]) -> ::Array[String] - - attr_reader organisation_in_image_name: ::Array[String]? - - def organisation_in_image_name=: (::Array[String]) -> ::Array[String] - - attr_reader orientation: String? - - def orientation=: (String) -> String - - attr_reader original_transmission_reference: String? - - def original_transmission_reference=: (String) -> String - - attr_reader person_in_image: ::Array[String]? - - def person_in_image=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_cv_term_cv_id: ::Array[String]? - - def person_in_image_cv_term_cv_id=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_cv_term_id: ::Array[String]? - - def person_in_image_cv_term_id=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_cv_term_name: ::Array[String]? - - def person_in_image_cv_term_name=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_cv_term_refined_about: ::Array[String]? - - def person_in_image_cv_term_refined_about=: ( - ::Array[String] - ) -> ::Array[String] - - attr_reader person_in_image_description: ::Array[String]? - - def person_in_image_description=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_id: ::Array[String]? - - def person_in_image_id=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_name: ::Array[String]? - - def person_in_image_name=: (::Array[String]) -> ::Array[String] - - attr_reader product_in_image_description: ::Array[String]? - - def product_in_image_description=: (::Array[String]) -> ::Array[String] - - attr_reader product_in_image_gtin: ::Array[Float]? - - def product_in_image_gtin=: (::Array[Float]) -> ::Array[Float] - - attr_reader product_in_image_name: ::Array[String]? - - def product_in_image_name=: (::Array[String]) -> ::Array[String] - - attr_reader property_release_id: ::Array[String]? - - def property_release_id=: (::Array[String]) -> ::Array[String] - - attr_reader province_state: String? - - def province_state=: (String) -> String - - attr_reader rating: Integer? - - def rating=: (Integer) -> Integer - - attr_reader registry_entry_role: ::Array[String]? - - def registry_entry_role=: (::Array[String]) -> ::Array[String] - - attr_reader registry_item_id: ::Array[String]? - - def registry_item_id=: (::Array[String]) -> ::Array[String] - - attr_reader registry_organisation_id: ::Array[String]? - - def registry_organisation_id=: (::Array[String]) -> ::Array[String] - - attr_reader resolution_unit: String? - - def resolution_unit=: (String) -> String - - attr_reader rights: String? - - def rights=: (String) -> String - - attr_reader scene: ::Array[String]? - - def scene=: (::Array[String]) -> ::Array[String] - - attr_reader source: String? - - def source=: (String) -> String - - attr_reader special_instructions: String? - - def special_instructions=: (String) -> String - - attr_reader state: String? - - def state=: (String) -> String - - attr_reader subject: ::Array[String]? - - def subject=: (::Array[String]) -> ::Array[String] - - attr_reader subject_code: ::Array[String]? - - def subject_code=: (::Array[String]) -> ::Array[String] - - attr_reader subject_reference: ::Array[String]? - - def subject_reference=: (::Array[String]) -> ::Array[String] - - attr_reader sublocation: String? - - def sublocation=: (String) -> String - - attr_reader time_created: String? - - def time_created=: (String) -> String - - attr_reader title: String? - - def title=: (String) -> String - - attr_reader transmission_reference: String? - - def transmission_reference=: (String) -> String - - attr_reader usage_terms: String? - - def usage_terms=: (String) -> String - - attr_reader web_statement: String? - - def web_statement=: (String) -> String - - attr_reader writer: String? - - def writer=: (String) -> String - - attr_reader writer_editor: String? - - def writer_editor=: (String) -> String - - attr_reader x_resolution: Float? - - def x_resolution=: (Float) -> Float - - attr_reader y_resolution: Float? - - def y_resolution=: (Float) -> Float - - def initialize: ( - ?about_cv_term_cv_id: String, - ?about_cv_term_id: String, - ?about_cv_term_name: String, - ?about_cv_term_refined_about: String, - ?additional_model_information: String, - ?application_record_version: Integer, - ?artist: String, - ?artwork_circa_date_created: String, - ?artwork_content_description: String, - ?artwork_contribution_description: String, - ?artwork_copyright_notice: String, - ?artwork_copyright_owner_id: String, - ?artwork_copyright_owner_name: String, - ?artwork_creator: ::Array[String], - ?artwork_creator_id: ::Array[String], - ?artwork_date_created: Time, - ?artwork_licensor_id: String, - ?artwork_licensor_name: String, - ?artwork_physical_description: String, - ?artwork_source: String, - ?artwork_source_inventory_no: String, - ?artwork_source_inv_url: String, - ?artwork_style_period: ::Array[String], - ?artwork_title: String, - ?authors_position: String, - ?byline: String, - ?byline_title: String, - ?caption: String, - ?caption_abstract: String, - ?caption_writer: String, - ?city: String, - ?color_space: String, - ?components_configuration: String, - ?copyright: String, - ?copyright_notice: String, - ?copyright_owner_id: ::Array[String], - ?copyright_owner_name: ::Array[String], - ?country: String, - ?country_code: String, - ?country_primary_location_code: String, - ?country_primary_location_name: String, - ?creator: String, - ?creator_address: String, - ?creator_city: String, - ?creator_country: String, - ?creator_postal_code: String, - ?creator_region: String, - ?creator_work_email: String, - ?creator_work_telephone: String, - ?creator_work_url: String, - ?credit: String, - ?date_created: Time, - ?date_time_created: Time, - ?date_time_original: Time, - ?description: String, - ?digital_image_guid: String, - ?digital_source_type: String, - ?embedded_encoded_rights_expr: String, - ?embedded_encoded_rights_expr_lang_id: String, - ?embedded_encoded_rights_expr_type: String, - ?event: String, - ?exif_version: String, - ?flashpix_version: String, - ?genre_cv_id: String, - ?genre_cv_term_id: String, - ?genre_cv_term_name: String, - ?genre_cv_term_refined_about: String, - ?headline: String, - ?image_creator_id: String, - ?image_creator_image_id: String, - ?image_creator_name: String, - ?image_description: String, - ?image_region_boundary_h: ::Array[Float], - ?image_region_boundary_rx: ::Array[Float], - ?image_region_boundary_shape: ::Array[String], - ?image_region_boundary_unit: ::Array[String], - ?image_region_boundary_vertices_x: ::Array[Float], - ?image_region_boundary_vertices_y: ::Array[Float], - ?image_region_boundary_w: ::Array[Float], - ?image_region_boundary_x: ::Array[Float], - ?image_region_boundary_y: ::Array[Float], - ?image_region_ctype_identifier: ::Array[String], - ?image_region_ctype_name: ::Array[String], - ?image_region_id: ::Array[String], - ?image_region_name: ::Array[String], - ?image_region_organisation_in_image_name: ::Array[String], - ?image_region_person_in_image: ::Array[String], - ?image_region_role_identifier: ::Array[String], - ?image_region_role_name: ::Array[String], - ?image_supplier_id: String, - ?image_supplier_image_id: String, - ?image_supplier_name: String, - ?instructions: String, - ?intellectual_genre: String, - ?keywords: ::Array[String], - ?licensor_city: ::Array[String], - ?licensor_country: ::Array[String], - ?licensor_email: ::Array[String], - ?licensor_extended_address: ::Array[String], - ?licensor_id: ::Array[String], - ?licensor_name: ::Array[String], - ?licensor_postal_code: ::Array[String], - ?licensor_region: ::Array[String], - ?licensor_street_address: ::Array[String], - ?licensor_telephone1: ::Array[String], - ?licensor_telephone2: ::Array[String], - ?licensor_url: ::Array[String], - ?linked_encoded_rights_expr: String, - ?linked_encoded_rights_expr_lang_id: String, - ?linked_encoded_rights_expr_type: String, - ?location: String, - ?location_created_city: String, - ?location_created_country_code: String, - ?location_created_country_name: String, - ?location_created_gps_altitude: String, - ?location_created_gps_latitude: String, - ?location_created_gps_longitude: String, - ?location_created_location_id: String, - ?location_created_location_name: String, - ?location_created_province_state: String, - ?location_created_sublocation: String, - ?location_created_world_region: String, - ?location_shown_city: ::Array[String], - ?location_shown_country_code: ::Array[String], - ?location_shown_country_name: ::Array[String], - ?location_shown_gps_altitude: ::Array[String], - ?location_shown_gps_latitude: ::Array[String], - ?location_shown_gps_longitude: ::Array[String], - ?location_shown_location_id: ::Array[String], - ?location_shown_location_name: ::Array[String], - ?location_shown_province_state: ::Array[String], - ?location_shown_sublocation: ::Array[String], - ?location_shown_world_region: ::Array[String], - ?max_avail_height: Float, - ?max_avail_width: Float, - ?model_age: ::Array[Float], - ?model_release_id: ::Array[String], - ?object_attribute_reference: String, - ?object_name: String, - ?offset_time_original: String, - ?organisation_in_image_code: ::Array[String], - ?organisation_in_image_name: ::Array[String], - ?orientation: String, - ?original_transmission_reference: String, - ?person_in_image: ::Array[String], - ?person_in_image_cv_term_cv_id: ::Array[String], - ?person_in_image_cv_term_id: ::Array[String], - ?person_in_image_cv_term_name: ::Array[String], - ?person_in_image_cv_term_refined_about: ::Array[String], - ?person_in_image_description: ::Array[String], - ?person_in_image_id: ::Array[String], - ?person_in_image_name: ::Array[String], - ?product_in_image_description: ::Array[String], - ?product_in_image_gtin: ::Array[Float], - ?product_in_image_name: ::Array[String], - ?property_release_id: ::Array[String], - ?province_state: String, - ?rating: Integer, - ?registry_entry_role: ::Array[String], - ?registry_item_id: ::Array[String], - ?registry_organisation_id: ::Array[String], - ?resolution_unit: String, - ?rights: String, - ?scene: ::Array[String], - ?source: String, - ?special_instructions: String, - ?state: String, - ?subject: ::Array[String], - ?subject_code: ::Array[String], - ?subject_reference: ::Array[String], - ?sublocation: String, - ?time_created: String, - ?title: String, - ?transmission_reference: String, - ?usage_terms: String, - ?web_statement: String, - ?writer: String, - ?writer_editor: String, - ?x_resolution: Float, - ?y_resolution: Float - ) -> void - - def to_hash: -> { - about_cv_term_cv_id: String, - about_cv_term_id: String, - about_cv_term_name: String, - about_cv_term_refined_about: String, - additional_model_information: String, - application_record_version: Integer, - artist: String, - artwork_circa_date_created: String, - artwork_content_description: String, - artwork_contribution_description: String, - artwork_copyright_notice: String, - artwork_copyright_owner_id: String, - artwork_copyright_owner_name: String, - artwork_creator: ::Array[String], - artwork_creator_id: ::Array[String], - artwork_date_created: Time, - artwork_licensor_id: String, - artwork_licensor_name: String, - artwork_physical_description: String, - artwork_source: String, - artwork_source_inventory_no: String, - artwork_source_inv_url: String, - artwork_style_period: ::Array[String], - artwork_title: String, - authors_position: String, - byline: String, - byline_title: String, - caption: String, - caption_abstract: String, - caption_writer: String, - city: String, - color_space: String, - components_configuration: String, - copyright: String, - copyright_notice: String, - copyright_owner_id: ::Array[String], - copyright_owner_name: ::Array[String], - country: String, - country_code: String, - country_primary_location_code: String, - country_primary_location_name: String, - creator: String, - creator_address: String, - creator_city: String, - creator_country: String, - creator_postal_code: String, - creator_region: String, - creator_work_email: String, - creator_work_telephone: String, - creator_work_url: String, - credit: String, - date_created: Time, - date_time_created: Time, - date_time_original: Time, - description: String, - digital_image_guid: String, - digital_source_type: String, - embedded_encoded_rights_expr: String, - embedded_encoded_rights_expr_lang_id: String, - embedded_encoded_rights_expr_type: String, - event: String, - exif_version: String, - flashpix_version: String, - genre_cv_id: String, - genre_cv_term_id: String, - genre_cv_term_name: String, - genre_cv_term_refined_about: String, - headline: String, - image_creator_id: String, - image_creator_image_id: String, - image_creator_name: String, - image_description: String, - image_region_boundary_h: ::Array[Float], - image_region_boundary_rx: ::Array[Float], - image_region_boundary_shape: ::Array[String], - image_region_boundary_unit: ::Array[String], - image_region_boundary_vertices_x: ::Array[Float], - image_region_boundary_vertices_y: ::Array[Float], - image_region_boundary_w: ::Array[Float], - image_region_boundary_x: ::Array[Float], - image_region_boundary_y: ::Array[Float], - image_region_ctype_identifier: ::Array[String], - image_region_ctype_name: ::Array[String], - image_region_id: ::Array[String], - image_region_name: ::Array[String], - image_region_organisation_in_image_name: ::Array[String], - image_region_person_in_image: ::Array[String], - image_region_role_identifier: ::Array[String], - image_region_role_name: ::Array[String], - image_supplier_id: String, - image_supplier_image_id: String, - image_supplier_name: String, - instructions: String, - intellectual_genre: String, - keywords: ::Array[String], - licensor_city: ::Array[String], - licensor_country: ::Array[String], - licensor_email: ::Array[String], - licensor_extended_address: ::Array[String], - licensor_id: ::Array[String], - licensor_name: ::Array[String], - licensor_postal_code: ::Array[String], - licensor_region: ::Array[String], - licensor_street_address: ::Array[String], - :licensor_telephone1 => ::Array[String], - :licensor_telephone2 => ::Array[String], - licensor_url: ::Array[String], - linked_encoded_rights_expr: String, - linked_encoded_rights_expr_lang_id: String, - linked_encoded_rights_expr_type: String, - location: String, - location_created_city: String, - location_created_country_code: String, - location_created_country_name: String, - location_created_gps_altitude: String, - location_created_gps_latitude: String, - location_created_gps_longitude: String, - location_created_location_id: String, - location_created_location_name: String, - location_created_province_state: String, - location_created_sublocation: String, - location_created_world_region: String, - location_shown_city: ::Array[String], - location_shown_country_code: ::Array[String], - location_shown_country_name: ::Array[String], - location_shown_gps_altitude: ::Array[String], - location_shown_gps_latitude: ::Array[String], - location_shown_gps_longitude: ::Array[String], - location_shown_location_id: ::Array[String], - location_shown_location_name: ::Array[String], - location_shown_province_state: ::Array[String], - location_shown_sublocation: ::Array[String], - location_shown_world_region: ::Array[String], - max_avail_height: Float, - max_avail_width: Float, - model_age: ::Array[Float], - model_release_id: ::Array[String], - object_attribute_reference: String, - object_name: String, - offset_time_original: String, - organisation_in_image_code: ::Array[String], - organisation_in_image_name: ::Array[String], - orientation: String, - original_transmission_reference: String, - person_in_image: ::Array[String], - person_in_image_cv_term_cv_id: ::Array[String], - person_in_image_cv_term_id: ::Array[String], - person_in_image_cv_term_name: ::Array[String], - person_in_image_cv_term_refined_about: ::Array[String], - person_in_image_description: ::Array[String], - person_in_image_id: ::Array[String], - person_in_image_name: ::Array[String], - product_in_image_description: ::Array[String], - product_in_image_gtin: ::Array[Float], - product_in_image_name: ::Array[String], - property_release_id: ::Array[String], - province_state: String, - rating: Integer, - registry_entry_role: ::Array[String], - registry_item_id: ::Array[String], - registry_organisation_id: ::Array[String], - resolution_unit: String, - rights: String, - scene: ::Array[String], - source: String, - special_instructions: String, - state: String, - subject: ::Array[String], - subject_code: ::Array[String], - subject_reference: ::Array[String], - sublocation: String, - time_created: String, - title: String, - transmission_reference: String, - usage_terms: String, - web_statement: String, - writer: String, - writer_editor: String, - x_resolution: Float, - y_resolution: Float - } - end - - type extension_status = - { - aws_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg - } - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - attr_reader aws_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging? - - def aws_auto_tagging=: ( - Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging - ) -> Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging - - attr_reader google_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging? - - def google_auto_tagging=: ( - Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging - ) -> Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging - - attr_reader remove_bg: Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg? - - def remove_bg=: ( - Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg - ) -> Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg - - def initialize: ( - ?aws_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging, - ?google_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging, - ?remove_bg: Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg - ) -> void - - def to_hash: -> { - aws_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg - } - - type aws_auto_tagging = :success | :pending | :failed - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Response::ExtensionStatus::aws_auto_tagging] - end - - type google_auto_tagging = :success | :pending | :failed - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Response::ExtensionStatus::google_auto_tagging] - end - - type remove_bg = :success | :pending | :failed - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV1Response::ExtensionStatus::remove_bg] - end - end - - type metadata = - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - class Metadata < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_reader density: Integer? - - def density=: (Integer) -> Integer - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif? - - def exif=: ( - Imagekit::Models::FileUploadV1Response::Metadata::Exif - ) -> Imagekit::Models::FileUploadV1Response::Metadata::Exif - - attr_reader format_: String? - - def format_=: (String) -> String - - attr_reader has_color_profile: bool? - - def has_color_profile=: (bool) -> bool - - attr_reader has_transparency: bool? - - def has_transparency=: (bool) -> bool - - attr_reader height: Integer? - - def height=: (Integer) -> Integer - - attr_reader p_hash: String? - - def p_hash=: (String) -> String - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader size: Integer? - - def size=: (Integer) -> Integer - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Integer? - - def width=: (Integer) -> Integer - - def initialize: ( - ?audio_codec: String, - ?bit_rate: Integer, - ?density: Integer, - ?duration: Integer, - ?exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif, - ?format_: String, - ?has_color_profile: bool, - ?has_transparency: bool, - ?height: Integer, - ?p_hash: String, - ?quality: Integer, - ?size: Integer, - ?video_codec: String, - ?width: Integer - ) -> void - - def to_hash: -> { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadV1Response::Metadata::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - type exif = - { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::ExifDetails? - - def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails - - attr_reader gps: Imagekit::Gps? - - def gps=: (Imagekit::Gps) -> Imagekit::Gps - - attr_reader image: Imagekit::ExifImage? - - def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage - - attr_reader interoperability: Imagekit::Interoperability? - - def interoperability=: ( - Imagekit::Interoperability - ) -> Imagekit::Interoperability - - attr_reader makernote: ::Hash[Symbol, top]? - - def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader thumbnail: Imagekit::Thumbnail? - - def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail - - def initialize: ( - ?exif: Imagekit::ExifDetails, - ?gps: Imagekit::Gps, - ?image: Imagekit::ExifImage, - ?interoperability: Imagekit::Interoperability, - ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Thumbnail - ) -> void - - def to_hash: -> { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail - } - end - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - end -end diff --git a/sig/imagekit/models/file_upload_v2_params.rbs b/sig/imagekit/models/file_upload_v2_params.rbs deleted file mode 100644 index ecb9b725..00000000 --- a/sig/imagekit/models/file_upload_v2_params.rbs +++ /dev/null @@ -1,228 +0,0 @@ -module Imagekit - module Models - type file_upload_v2_params = - { - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - extensions: String, - folder: String, - is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file, - is_published: Imagekit::Models::FileUploadV2Params::is_published, - overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags, - overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata, - overwrite_file: String, - overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags, - response_fields: String, - tags: String, - transformation: String, - use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name, - webhook_url: String - } - & Imagekit::Internal::Type::request_parameters - - class FileUploadV2Params < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor file: String - - attr_accessor file_name: String - - attr_reader token: String? - - def token=: (String) -> String - - attr_reader checks: String? - - def checks=: (String) -> String - - attr_reader custom_coordinates: String? - - def custom_coordinates=: (String) -> String - - attr_reader custom_metadata: String? - - def custom_metadata=: (String) -> String - - attr_reader extensions: String? - - def extensions=: (String) -> String - - attr_reader folder: String? - - def folder=: (String) -> String - - attr_reader is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file? - - def is_private_file=: ( - Imagekit::Models::FileUploadV2Params::is_private_file - ) -> Imagekit::Models::FileUploadV2Params::is_private_file - - attr_reader is_published: Imagekit::Models::FileUploadV2Params::is_published? - - def is_published=: ( - Imagekit::Models::FileUploadV2Params::is_published - ) -> Imagekit::Models::FileUploadV2Params::is_published - - attr_reader overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags? - - def overwrite_ai_tags=: ( - Imagekit::Models::FileUploadV2Params::overwrite_ai_tags - ) -> Imagekit::Models::FileUploadV2Params::overwrite_ai_tags - - attr_reader overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata? - - def overwrite_custom_metadata=: ( - Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata - ) -> Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata - - attr_reader overwrite_file: String? - - def overwrite_file=: (String) -> String - - attr_reader overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags? - - def overwrite_tags=: ( - Imagekit::Models::FileUploadV2Params::overwrite_tags - ) -> Imagekit::Models::FileUploadV2Params::overwrite_tags - - attr_reader response_fields: String? - - def response_fields=: (String) -> String - - attr_reader tags: String? - - def tags=: (String) -> String - - attr_reader transformation: String? - - def transformation=: (String) -> String - - attr_reader use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name? - - def use_unique_file_name=: ( - Imagekit::Models::FileUploadV2Params::use_unique_file_name - ) -> Imagekit::Models::FileUploadV2Params::use_unique_file_name - - attr_reader webhook_url: String? - - def webhook_url=: (String) -> String - - def initialize: ( - file: String, - file_name: String, - ?token: String, - ?checks: String, - ?custom_coordinates: String, - ?custom_metadata: String, - ?extensions: String, - ?folder: String, - ?is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file, - ?is_published: Imagekit::Models::FileUploadV2Params::is_published, - ?overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags, - ?overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata, - ?overwrite_file: String, - ?overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags, - ?response_fields: String, - ?tags: String, - ?transformation: String, - ?use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name, - ?webhook_url: String, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file: String, - file_name: String, - token: String, - checks: String, - custom_coordinates: String, - custom_metadata: String, - extensions: String, - folder: String, - is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file, - is_published: Imagekit::Models::FileUploadV2Params::is_published, - overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags, - overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata, - overwrite_file: String, - overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags, - response_fields: String, - tags: String, - transformation: String, - use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name, - webhook_url: String, - request_options: Imagekit::RequestOptions - } - - type is_private_file = :true | :false - - module IsPrivateFile - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::is_private_file] - end - - type is_published = :true | :false - - module IsPublished - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::is_published] - end - - type overwrite_ai_tags = :true | :false - - module OverwriteAITags - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::overwrite_ai_tags] - end - - type overwrite_custom_metadata = :true | :false - - module OverwriteCustomMetadata - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata] - end - - type overwrite_tags = :true | :false - - module OverwriteTags - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::overwrite_tags] - end - - type use_unique_file_name = :true | :false - - module UseUniqueFileName - extend Imagekit::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Params::use_unique_file_name] - end - end - end -end diff --git a/sig/imagekit/models/file_upload_v2_response.rbs b/sig/imagekit/models/file_upload_v2_response.rbs deleted file mode 100644 index d72f49b1..00000000 --- a/sig/imagekit/models/file_upload_v2_response.rbs +++ /dev/null @@ -1,1741 +0,0 @@ -module Imagekit - module Models - type file_upload_v2_response = - { - ai_tags: ::Array[Imagekit::Models::FileUploadV2Response::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: top, - duration: Integer, - embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, - extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Models::FileUploadV2Response::Metadata, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::FileUploadV2Response::VersionInfo, - video_codec: String, - width: Float - } - - class FileUploadV2Response < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::FileUploadV2Response::AITag]? - - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: top? - - def custom_metadata=: (top) -> top - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata? - - def embedded_metadata=: ( - Imagekit::Models::FileUploadV2Response::EmbeddedMetadata - ) -> Imagekit::Models::FileUploadV2Response::EmbeddedMetadata - - attr_reader extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus? - - def extension_status=: ( - Imagekit::Models::FileUploadV2Response::ExtensionStatus - ) -> Imagekit::Models::FileUploadV2Response::ExtensionStatus - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader metadata: Imagekit::Models::FileUploadV2Response::Metadata? - - def metadata=: ( - Imagekit::Models::FileUploadV2Response::Metadata - ) -> Imagekit::Models::FileUploadV2Response::Metadata - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail_url: String? - - def thumbnail_url=: (String) -> String - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::FileUploadV2Response::VersionInfo? - - def version_info=: ( - Imagekit::Models::FileUploadV2Response::VersionInfo - ) -> Imagekit::Models::FileUploadV2Response::VersionInfo - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::FileUploadV2Response::AITag]?, - ?audio_codec: String, - ?bit_rate: Integer, - ?custom_coordinates: String?, - ?custom_metadata: top, - ?duration: Integer, - ?embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, - ?extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus, - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?metadata: Imagekit::Models::FileUploadV2Response::Metadata, - ?name: String, - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail_url: String, - ?url: String, - ?version_info: Imagekit::Models::FileUploadV2Response::VersionInfo, - ?video_codec: String, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::FileUploadV2Response::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: top, - duration: Integer, - embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata, - extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Models::FileUploadV2Response::Metadata, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::FileUploadV2Response::VersionInfo, - video_codec: String, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type embedded_metadata = - { - about_cv_term_cv_id: String, - about_cv_term_id: String, - about_cv_term_name: String, - about_cv_term_refined_about: String, - additional_model_information: String, - application_record_version: Integer, - artist: String, - artwork_circa_date_created: String, - artwork_content_description: String, - artwork_contribution_description: String, - artwork_copyright_notice: String, - artwork_copyright_owner_id: String, - artwork_copyright_owner_name: String, - artwork_creator: ::Array[String], - artwork_creator_id: ::Array[String], - artwork_date_created: Time, - artwork_licensor_id: String, - artwork_licensor_name: String, - artwork_physical_description: String, - artwork_source: String, - artwork_source_inventory_no: String, - artwork_source_inv_url: String, - artwork_style_period: ::Array[String], - artwork_title: String, - authors_position: String, - byline: String, - byline_title: String, - caption: String, - caption_abstract: String, - caption_writer: String, - city: String, - color_space: String, - components_configuration: String, - copyright: String, - copyright_notice: String, - copyright_owner_id: ::Array[String], - copyright_owner_name: ::Array[String], - country: String, - country_code: String, - country_primary_location_code: String, - country_primary_location_name: String, - creator: String, - creator_address: String, - creator_city: String, - creator_country: String, - creator_postal_code: String, - creator_region: String, - creator_work_email: String, - creator_work_telephone: String, - creator_work_url: String, - credit: String, - date_created: Time, - date_time_created: Time, - date_time_original: Time, - description: String, - digital_image_guid: String, - digital_source_type: String, - embedded_encoded_rights_expr: String, - embedded_encoded_rights_expr_lang_id: String, - embedded_encoded_rights_expr_type: String, - event: String, - exif_version: String, - flashpix_version: String, - genre_cv_id: String, - genre_cv_term_id: String, - genre_cv_term_name: String, - genre_cv_term_refined_about: String, - headline: String, - image_creator_id: String, - image_creator_image_id: String, - image_creator_name: String, - image_description: String, - image_region_boundary_h: ::Array[Float], - image_region_boundary_rx: ::Array[Float], - image_region_boundary_shape: ::Array[String], - image_region_boundary_unit: ::Array[String], - image_region_boundary_vertices_x: ::Array[Float], - image_region_boundary_vertices_y: ::Array[Float], - image_region_boundary_w: ::Array[Float], - image_region_boundary_x: ::Array[Float], - image_region_boundary_y: ::Array[Float], - image_region_ctype_identifier: ::Array[String], - image_region_ctype_name: ::Array[String], - image_region_id: ::Array[String], - image_region_name: ::Array[String], - image_region_organisation_in_image_name: ::Array[String], - image_region_person_in_image: ::Array[String], - image_region_role_identifier: ::Array[String], - image_region_role_name: ::Array[String], - image_supplier_id: String, - image_supplier_image_id: String, - image_supplier_name: String, - instructions: String, - intellectual_genre: String, - keywords: ::Array[String], - licensor_city: ::Array[String], - licensor_country: ::Array[String], - licensor_email: ::Array[String], - licensor_extended_address: ::Array[String], - licensor_id: ::Array[String], - licensor_name: ::Array[String], - licensor_postal_code: ::Array[String], - licensor_region: ::Array[String], - licensor_street_address: ::Array[String], - :licensor_telephone1 => ::Array[String], - :licensor_telephone2 => ::Array[String], - licensor_url: ::Array[String], - linked_encoded_rights_expr: String, - linked_encoded_rights_expr_lang_id: String, - linked_encoded_rights_expr_type: String, - location: String, - location_created_city: String, - location_created_country_code: String, - location_created_country_name: String, - location_created_gps_altitude: String, - location_created_gps_latitude: String, - location_created_gps_longitude: String, - location_created_location_id: String, - location_created_location_name: String, - location_created_province_state: String, - location_created_sublocation: String, - location_created_world_region: String, - location_shown_city: ::Array[String], - location_shown_country_code: ::Array[String], - location_shown_country_name: ::Array[String], - location_shown_gps_altitude: ::Array[String], - location_shown_gps_latitude: ::Array[String], - location_shown_gps_longitude: ::Array[String], - location_shown_location_id: ::Array[String], - location_shown_location_name: ::Array[String], - location_shown_province_state: ::Array[String], - location_shown_sublocation: ::Array[String], - location_shown_world_region: ::Array[String], - max_avail_height: Float, - max_avail_width: Float, - model_age: ::Array[Float], - model_release_id: ::Array[String], - object_attribute_reference: String, - object_name: String, - offset_time_original: String, - organisation_in_image_code: ::Array[String], - organisation_in_image_name: ::Array[String], - orientation: String, - original_transmission_reference: String, - person_in_image: ::Array[String], - person_in_image_cv_term_cv_id: ::Array[String], - person_in_image_cv_term_id: ::Array[String], - person_in_image_cv_term_name: ::Array[String], - person_in_image_cv_term_refined_about: ::Array[String], - person_in_image_description: ::Array[String], - person_in_image_id: ::Array[String], - person_in_image_name: ::Array[String], - product_in_image_description: ::Array[String], - product_in_image_gtin: ::Array[Float], - product_in_image_name: ::Array[String], - property_release_id: ::Array[String], - province_state: String, - rating: Integer, - registry_entry_role: ::Array[String], - registry_item_id: ::Array[String], - registry_organisation_id: ::Array[String], - resolution_unit: String, - rights: String, - scene: ::Array[String], - source: String, - special_instructions: String, - state: String, - subject: ::Array[String], - subject_code: ::Array[String], - subject_reference: ::Array[String], - sublocation: String, - time_created: String, - title: String, - transmission_reference: String, - usage_terms: String, - web_statement: String, - writer: String, - writer_editor: String, - x_resolution: Float, - y_resolution: Float - } - - class EmbeddedMetadata < Imagekit::Internal::Type::BaseModel - attr_reader about_cv_term_cv_id: String? - - def about_cv_term_cv_id=: (String) -> String - - attr_reader about_cv_term_id: String? - - def about_cv_term_id=: (String) -> String - - attr_reader about_cv_term_name: String? - - def about_cv_term_name=: (String) -> String - - attr_reader about_cv_term_refined_about: String? - - def about_cv_term_refined_about=: (String) -> String - - attr_reader additional_model_information: String? - - def additional_model_information=: (String) -> String - - attr_reader application_record_version: Integer? - - def application_record_version=: (Integer) -> Integer - - attr_reader artist: String? - - def artist=: (String) -> String - - attr_reader artwork_circa_date_created: String? - - def artwork_circa_date_created=: (String) -> String - - attr_reader artwork_content_description: String? - - def artwork_content_description=: (String) -> String - - attr_reader artwork_contribution_description: String? - - def artwork_contribution_description=: (String) -> String - - attr_reader artwork_copyright_notice: String? - - def artwork_copyright_notice=: (String) -> String - - attr_reader artwork_copyright_owner_id: String? - - def artwork_copyright_owner_id=: (String) -> String - - attr_reader artwork_copyright_owner_name: String? - - def artwork_copyright_owner_name=: (String) -> String - - attr_reader artwork_creator: ::Array[String]? - - def artwork_creator=: (::Array[String]) -> ::Array[String] - - attr_reader artwork_creator_id: ::Array[String]? - - def artwork_creator_id=: (::Array[String]) -> ::Array[String] - - attr_reader artwork_date_created: Time? - - def artwork_date_created=: (Time) -> Time - - attr_reader artwork_licensor_id: String? - - def artwork_licensor_id=: (String) -> String - - attr_reader artwork_licensor_name: String? - - def artwork_licensor_name=: (String) -> String - - attr_reader artwork_physical_description: String? - - def artwork_physical_description=: (String) -> String - - attr_reader artwork_source: String? - - def artwork_source=: (String) -> String - - attr_reader artwork_source_inventory_no: String? - - def artwork_source_inventory_no=: (String) -> String - - attr_reader artwork_source_inv_url: String? - - def artwork_source_inv_url=: (String) -> String - - attr_reader artwork_style_period: ::Array[String]? - - def artwork_style_period=: (::Array[String]) -> ::Array[String] - - attr_reader artwork_title: String? - - def artwork_title=: (String) -> String - - attr_reader authors_position: String? - - def authors_position=: (String) -> String - - attr_reader byline: String? - - def byline=: (String) -> String - - attr_reader byline_title: String? - - def byline_title=: (String) -> String - - attr_reader caption: String? - - def caption=: (String) -> String - - attr_reader caption_abstract: String? - - def caption_abstract=: (String) -> String - - attr_reader caption_writer: String? - - def caption_writer=: (String) -> String - - attr_reader city: String? - - def city=: (String) -> String - - attr_reader color_space: String? - - def color_space=: (String) -> String - - attr_reader components_configuration: String? - - def components_configuration=: (String) -> String - - attr_reader copyright: String? - - def copyright=: (String) -> String - - attr_reader copyright_notice: String? - - def copyright_notice=: (String) -> String - - attr_reader copyright_owner_id: ::Array[String]? - - def copyright_owner_id=: (::Array[String]) -> ::Array[String] - - attr_reader copyright_owner_name: ::Array[String]? - - def copyright_owner_name=: (::Array[String]) -> ::Array[String] - - attr_reader country: String? - - def country=: (String) -> String - - attr_reader country_code: String? - - def country_code=: (String) -> String - - attr_reader country_primary_location_code: String? - - def country_primary_location_code=: (String) -> String - - attr_reader country_primary_location_name: String? - - def country_primary_location_name=: (String) -> String - - attr_reader creator: String? - - def creator=: (String) -> String - - attr_reader creator_address: String? - - def creator_address=: (String) -> String - - attr_reader creator_city: String? - - def creator_city=: (String) -> String - - attr_reader creator_country: String? - - def creator_country=: (String) -> String - - attr_reader creator_postal_code: String? - - def creator_postal_code=: (String) -> String - - attr_reader creator_region: String? - - def creator_region=: (String) -> String - - attr_reader creator_work_email: String? - - def creator_work_email=: (String) -> String - - attr_reader creator_work_telephone: String? - - def creator_work_telephone=: (String) -> String - - attr_reader creator_work_url: String? - - def creator_work_url=: (String) -> String - - attr_reader credit: String? - - def credit=: (String) -> String - - attr_reader date_created: Time? - - def date_created=: (Time) -> Time - - attr_reader date_time_created: Time? - - def date_time_created=: (Time) -> Time - - attr_reader date_time_original: Time? - - def date_time_original=: (Time) -> Time - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader digital_image_guid: String? - - def digital_image_guid=: (String) -> String - - attr_reader digital_source_type: String? - - def digital_source_type=: (String) -> String - - attr_reader embedded_encoded_rights_expr: String? - - def embedded_encoded_rights_expr=: (String) -> String - - attr_reader embedded_encoded_rights_expr_lang_id: String? - - def embedded_encoded_rights_expr_lang_id=: (String) -> String - - attr_reader embedded_encoded_rights_expr_type: String? - - def embedded_encoded_rights_expr_type=: (String) -> String - - attr_reader event: String? - - def event=: (String) -> String - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader genre_cv_id: String? - - def genre_cv_id=: (String) -> String - - attr_reader genre_cv_term_id: String? - - def genre_cv_term_id=: (String) -> String - - attr_reader genre_cv_term_name: String? - - def genre_cv_term_name=: (String) -> String - - attr_reader genre_cv_term_refined_about: String? - - def genre_cv_term_refined_about=: (String) -> String - - attr_reader headline: String? - - def headline=: (String) -> String - - attr_reader image_creator_id: String? - - def image_creator_id=: (String) -> String - - attr_reader image_creator_image_id: String? - - def image_creator_image_id=: (String) -> String - - attr_reader image_creator_name: String? - - def image_creator_name=: (String) -> String - - attr_reader image_description: String? - - def image_description=: (String) -> String - - attr_reader image_region_boundary_h: ::Array[Float]? - - def image_region_boundary_h=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_boundary_rx: ::Array[Float]? - - def image_region_boundary_rx=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_boundary_shape: ::Array[String]? - - def image_region_boundary_shape=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_boundary_unit: ::Array[String]? - - def image_region_boundary_unit=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_boundary_vertices_x: ::Array[Float]? - - def image_region_boundary_vertices_x=: ( - ::Array[Float] - ) -> ::Array[Float] - - attr_reader image_region_boundary_vertices_y: ::Array[Float]? - - def image_region_boundary_vertices_y=: ( - ::Array[Float] - ) -> ::Array[Float] - - attr_reader image_region_boundary_w: ::Array[Float]? - - def image_region_boundary_w=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_boundary_x: ::Array[Float]? - - def image_region_boundary_x=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_boundary_y: ::Array[Float]? - - def image_region_boundary_y=: (::Array[Float]) -> ::Array[Float] - - attr_reader image_region_ctype_identifier: ::Array[String]? - - def image_region_ctype_identifier=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_ctype_name: ::Array[String]? - - def image_region_ctype_name=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_id: ::Array[String]? - - def image_region_id=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_name: ::Array[String]? - - def image_region_name=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_organisation_in_image_name: ::Array[String]? - - def image_region_organisation_in_image_name=: ( - ::Array[String] - ) -> ::Array[String] - - attr_reader image_region_person_in_image: ::Array[String]? - - def image_region_person_in_image=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_role_identifier: ::Array[String]? - - def image_region_role_identifier=: (::Array[String]) -> ::Array[String] - - attr_reader image_region_role_name: ::Array[String]? - - def image_region_role_name=: (::Array[String]) -> ::Array[String] - - attr_reader image_supplier_id: String? - - def image_supplier_id=: (String) -> String - - attr_reader image_supplier_image_id: String? - - def image_supplier_image_id=: (String) -> String - - attr_reader image_supplier_name: String? - - def image_supplier_name=: (String) -> String - - attr_reader instructions: String? - - def instructions=: (String) -> String - - attr_reader intellectual_genre: String? - - def intellectual_genre=: (String) -> String - - attr_reader keywords: ::Array[String]? - - def keywords=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_city: ::Array[String]? - - def licensor_city=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_country: ::Array[String]? - - def licensor_country=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_email: ::Array[String]? - - def licensor_email=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_extended_address: ::Array[String]? - - def licensor_extended_address=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_id: ::Array[String]? - - def licensor_id=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_name: ::Array[String]? - - def licensor_name=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_postal_code: ::Array[String]? - - def licensor_postal_code=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_region: ::Array[String]? - - def licensor_region=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_street_address: ::Array[String]? - - def licensor_street_address=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_telephone1: ::Array[String]? - - def licensor_telephone1=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_telephone2: ::Array[String]? - - def licensor_telephone2=: (::Array[String]) -> ::Array[String] - - attr_reader licensor_url: ::Array[String]? - - def licensor_url=: (::Array[String]) -> ::Array[String] - - attr_reader linked_encoded_rights_expr: String? - - def linked_encoded_rights_expr=: (String) -> String - - attr_reader linked_encoded_rights_expr_lang_id: String? - - def linked_encoded_rights_expr_lang_id=: (String) -> String - - attr_reader linked_encoded_rights_expr_type: String? - - def linked_encoded_rights_expr_type=: (String) -> String - - attr_reader location: String? - - def location=: (String) -> String - - attr_reader location_created_city: String? - - def location_created_city=: (String) -> String - - attr_reader location_created_country_code: String? - - def location_created_country_code=: (String) -> String - - attr_reader location_created_country_name: String? - - def location_created_country_name=: (String) -> String - - attr_reader location_created_gps_altitude: String? - - def location_created_gps_altitude=: (String) -> String - - attr_reader location_created_gps_latitude: String? - - def location_created_gps_latitude=: (String) -> String - - attr_reader location_created_gps_longitude: String? - - def location_created_gps_longitude=: (String) -> String - - attr_reader location_created_location_id: String? - - def location_created_location_id=: (String) -> String - - attr_reader location_created_location_name: String? - - def location_created_location_name=: (String) -> String - - attr_reader location_created_province_state: String? - - def location_created_province_state=: (String) -> String - - attr_reader location_created_sublocation: String? - - def location_created_sublocation=: (String) -> String - - attr_reader location_created_world_region: String? - - def location_created_world_region=: (String) -> String - - attr_reader location_shown_city: ::Array[String]? - - def location_shown_city=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_country_code: ::Array[String]? - - def location_shown_country_code=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_country_name: ::Array[String]? - - def location_shown_country_name=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_gps_altitude: ::Array[String]? - - def location_shown_gps_altitude=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_gps_latitude: ::Array[String]? - - def location_shown_gps_latitude=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_gps_longitude: ::Array[String]? - - def location_shown_gps_longitude=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_location_id: ::Array[String]? - - def location_shown_location_id=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_location_name: ::Array[String]? - - def location_shown_location_name=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_province_state: ::Array[String]? - - def location_shown_province_state=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_sublocation: ::Array[String]? - - def location_shown_sublocation=: (::Array[String]) -> ::Array[String] - - attr_reader location_shown_world_region: ::Array[String]? - - def location_shown_world_region=: (::Array[String]) -> ::Array[String] - - attr_reader max_avail_height: Float? - - def max_avail_height=: (Float) -> Float - - attr_reader max_avail_width: Float? - - def max_avail_width=: (Float) -> Float - - attr_reader model_age: ::Array[Float]? - - def model_age=: (::Array[Float]) -> ::Array[Float] - - attr_reader model_release_id: ::Array[String]? - - def model_release_id=: (::Array[String]) -> ::Array[String] - - attr_reader object_attribute_reference: String? - - def object_attribute_reference=: (String) -> String - - attr_reader object_name: String? - - def object_name=: (String) -> String - - attr_reader offset_time_original: String? - - def offset_time_original=: (String) -> String - - attr_reader organisation_in_image_code: ::Array[String]? - - def organisation_in_image_code=: (::Array[String]) -> ::Array[String] - - attr_reader organisation_in_image_name: ::Array[String]? - - def organisation_in_image_name=: (::Array[String]) -> ::Array[String] - - attr_reader orientation: String? - - def orientation=: (String) -> String - - attr_reader original_transmission_reference: String? - - def original_transmission_reference=: (String) -> String - - attr_reader person_in_image: ::Array[String]? - - def person_in_image=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_cv_term_cv_id: ::Array[String]? - - def person_in_image_cv_term_cv_id=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_cv_term_id: ::Array[String]? - - def person_in_image_cv_term_id=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_cv_term_name: ::Array[String]? - - def person_in_image_cv_term_name=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_cv_term_refined_about: ::Array[String]? - - def person_in_image_cv_term_refined_about=: ( - ::Array[String] - ) -> ::Array[String] - - attr_reader person_in_image_description: ::Array[String]? - - def person_in_image_description=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_id: ::Array[String]? - - def person_in_image_id=: (::Array[String]) -> ::Array[String] - - attr_reader person_in_image_name: ::Array[String]? - - def person_in_image_name=: (::Array[String]) -> ::Array[String] - - attr_reader product_in_image_description: ::Array[String]? - - def product_in_image_description=: (::Array[String]) -> ::Array[String] - - attr_reader product_in_image_gtin: ::Array[Float]? - - def product_in_image_gtin=: (::Array[Float]) -> ::Array[Float] - - attr_reader product_in_image_name: ::Array[String]? - - def product_in_image_name=: (::Array[String]) -> ::Array[String] - - attr_reader property_release_id: ::Array[String]? - - def property_release_id=: (::Array[String]) -> ::Array[String] - - attr_reader province_state: String? - - def province_state=: (String) -> String - - attr_reader rating: Integer? - - def rating=: (Integer) -> Integer - - attr_reader registry_entry_role: ::Array[String]? - - def registry_entry_role=: (::Array[String]) -> ::Array[String] - - attr_reader registry_item_id: ::Array[String]? - - def registry_item_id=: (::Array[String]) -> ::Array[String] - - attr_reader registry_organisation_id: ::Array[String]? - - def registry_organisation_id=: (::Array[String]) -> ::Array[String] - - attr_reader resolution_unit: String? - - def resolution_unit=: (String) -> String - - attr_reader rights: String? - - def rights=: (String) -> String - - attr_reader scene: ::Array[String]? - - def scene=: (::Array[String]) -> ::Array[String] - - attr_reader source: String? - - def source=: (String) -> String - - attr_reader special_instructions: String? - - def special_instructions=: (String) -> String - - attr_reader state: String? - - def state=: (String) -> String - - attr_reader subject: ::Array[String]? - - def subject=: (::Array[String]) -> ::Array[String] - - attr_reader subject_code: ::Array[String]? - - def subject_code=: (::Array[String]) -> ::Array[String] - - attr_reader subject_reference: ::Array[String]? - - def subject_reference=: (::Array[String]) -> ::Array[String] - - attr_reader sublocation: String? - - def sublocation=: (String) -> String - - attr_reader time_created: String? - - def time_created=: (String) -> String - - attr_reader title: String? - - def title=: (String) -> String - - attr_reader transmission_reference: String? - - def transmission_reference=: (String) -> String - - attr_reader usage_terms: String? - - def usage_terms=: (String) -> String - - attr_reader web_statement: String? - - def web_statement=: (String) -> String - - attr_reader writer: String? - - def writer=: (String) -> String - - attr_reader writer_editor: String? - - def writer_editor=: (String) -> String - - attr_reader x_resolution: Float? - - def x_resolution=: (Float) -> Float - - attr_reader y_resolution: Float? - - def y_resolution=: (Float) -> Float - - def initialize: ( - ?about_cv_term_cv_id: String, - ?about_cv_term_id: String, - ?about_cv_term_name: String, - ?about_cv_term_refined_about: String, - ?additional_model_information: String, - ?application_record_version: Integer, - ?artist: String, - ?artwork_circa_date_created: String, - ?artwork_content_description: String, - ?artwork_contribution_description: String, - ?artwork_copyright_notice: String, - ?artwork_copyright_owner_id: String, - ?artwork_copyright_owner_name: String, - ?artwork_creator: ::Array[String], - ?artwork_creator_id: ::Array[String], - ?artwork_date_created: Time, - ?artwork_licensor_id: String, - ?artwork_licensor_name: String, - ?artwork_physical_description: String, - ?artwork_source: String, - ?artwork_source_inventory_no: String, - ?artwork_source_inv_url: String, - ?artwork_style_period: ::Array[String], - ?artwork_title: String, - ?authors_position: String, - ?byline: String, - ?byline_title: String, - ?caption: String, - ?caption_abstract: String, - ?caption_writer: String, - ?city: String, - ?color_space: String, - ?components_configuration: String, - ?copyright: String, - ?copyright_notice: String, - ?copyright_owner_id: ::Array[String], - ?copyright_owner_name: ::Array[String], - ?country: String, - ?country_code: String, - ?country_primary_location_code: String, - ?country_primary_location_name: String, - ?creator: String, - ?creator_address: String, - ?creator_city: String, - ?creator_country: String, - ?creator_postal_code: String, - ?creator_region: String, - ?creator_work_email: String, - ?creator_work_telephone: String, - ?creator_work_url: String, - ?credit: String, - ?date_created: Time, - ?date_time_created: Time, - ?date_time_original: Time, - ?description: String, - ?digital_image_guid: String, - ?digital_source_type: String, - ?embedded_encoded_rights_expr: String, - ?embedded_encoded_rights_expr_lang_id: String, - ?embedded_encoded_rights_expr_type: String, - ?event: String, - ?exif_version: String, - ?flashpix_version: String, - ?genre_cv_id: String, - ?genre_cv_term_id: String, - ?genre_cv_term_name: String, - ?genre_cv_term_refined_about: String, - ?headline: String, - ?image_creator_id: String, - ?image_creator_image_id: String, - ?image_creator_name: String, - ?image_description: String, - ?image_region_boundary_h: ::Array[Float], - ?image_region_boundary_rx: ::Array[Float], - ?image_region_boundary_shape: ::Array[String], - ?image_region_boundary_unit: ::Array[String], - ?image_region_boundary_vertices_x: ::Array[Float], - ?image_region_boundary_vertices_y: ::Array[Float], - ?image_region_boundary_w: ::Array[Float], - ?image_region_boundary_x: ::Array[Float], - ?image_region_boundary_y: ::Array[Float], - ?image_region_ctype_identifier: ::Array[String], - ?image_region_ctype_name: ::Array[String], - ?image_region_id: ::Array[String], - ?image_region_name: ::Array[String], - ?image_region_organisation_in_image_name: ::Array[String], - ?image_region_person_in_image: ::Array[String], - ?image_region_role_identifier: ::Array[String], - ?image_region_role_name: ::Array[String], - ?image_supplier_id: String, - ?image_supplier_image_id: String, - ?image_supplier_name: String, - ?instructions: String, - ?intellectual_genre: String, - ?keywords: ::Array[String], - ?licensor_city: ::Array[String], - ?licensor_country: ::Array[String], - ?licensor_email: ::Array[String], - ?licensor_extended_address: ::Array[String], - ?licensor_id: ::Array[String], - ?licensor_name: ::Array[String], - ?licensor_postal_code: ::Array[String], - ?licensor_region: ::Array[String], - ?licensor_street_address: ::Array[String], - ?licensor_telephone1: ::Array[String], - ?licensor_telephone2: ::Array[String], - ?licensor_url: ::Array[String], - ?linked_encoded_rights_expr: String, - ?linked_encoded_rights_expr_lang_id: String, - ?linked_encoded_rights_expr_type: String, - ?location: String, - ?location_created_city: String, - ?location_created_country_code: String, - ?location_created_country_name: String, - ?location_created_gps_altitude: String, - ?location_created_gps_latitude: String, - ?location_created_gps_longitude: String, - ?location_created_location_id: String, - ?location_created_location_name: String, - ?location_created_province_state: String, - ?location_created_sublocation: String, - ?location_created_world_region: String, - ?location_shown_city: ::Array[String], - ?location_shown_country_code: ::Array[String], - ?location_shown_country_name: ::Array[String], - ?location_shown_gps_altitude: ::Array[String], - ?location_shown_gps_latitude: ::Array[String], - ?location_shown_gps_longitude: ::Array[String], - ?location_shown_location_id: ::Array[String], - ?location_shown_location_name: ::Array[String], - ?location_shown_province_state: ::Array[String], - ?location_shown_sublocation: ::Array[String], - ?location_shown_world_region: ::Array[String], - ?max_avail_height: Float, - ?max_avail_width: Float, - ?model_age: ::Array[Float], - ?model_release_id: ::Array[String], - ?object_attribute_reference: String, - ?object_name: String, - ?offset_time_original: String, - ?organisation_in_image_code: ::Array[String], - ?organisation_in_image_name: ::Array[String], - ?orientation: String, - ?original_transmission_reference: String, - ?person_in_image: ::Array[String], - ?person_in_image_cv_term_cv_id: ::Array[String], - ?person_in_image_cv_term_id: ::Array[String], - ?person_in_image_cv_term_name: ::Array[String], - ?person_in_image_cv_term_refined_about: ::Array[String], - ?person_in_image_description: ::Array[String], - ?person_in_image_id: ::Array[String], - ?person_in_image_name: ::Array[String], - ?product_in_image_description: ::Array[String], - ?product_in_image_gtin: ::Array[Float], - ?product_in_image_name: ::Array[String], - ?property_release_id: ::Array[String], - ?province_state: String, - ?rating: Integer, - ?registry_entry_role: ::Array[String], - ?registry_item_id: ::Array[String], - ?registry_organisation_id: ::Array[String], - ?resolution_unit: String, - ?rights: String, - ?scene: ::Array[String], - ?source: String, - ?special_instructions: String, - ?state: String, - ?subject: ::Array[String], - ?subject_code: ::Array[String], - ?subject_reference: ::Array[String], - ?sublocation: String, - ?time_created: String, - ?title: String, - ?transmission_reference: String, - ?usage_terms: String, - ?web_statement: String, - ?writer: String, - ?writer_editor: String, - ?x_resolution: Float, - ?y_resolution: Float - ) -> void - - def to_hash: -> { - about_cv_term_cv_id: String, - about_cv_term_id: String, - about_cv_term_name: String, - about_cv_term_refined_about: String, - additional_model_information: String, - application_record_version: Integer, - artist: String, - artwork_circa_date_created: String, - artwork_content_description: String, - artwork_contribution_description: String, - artwork_copyright_notice: String, - artwork_copyright_owner_id: String, - artwork_copyright_owner_name: String, - artwork_creator: ::Array[String], - artwork_creator_id: ::Array[String], - artwork_date_created: Time, - artwork_licensor_id: String, - artwork_licensor_name: String, - artwork_physical_description: String, - artwork_source: String, - artwork_source_inventory_no: String, - artwork_source_inv_url: String, - artwork_style_period: ::Array[String], - artwork_title: String, - authors_position: String, - byline: String, - byline_title: String, - caption: String, - caption_abstract: String, - caption_writer: String, - city: String, - color_space: String, - components_configuration: String, - copyright: String, - copyright_notice: String, - copyright_owner_id: ::Array[String], - copyright_owner_name: ::Array[String], - country: String, - country_code: String, - country_primary_location_code: String, - country_primary_location_name: String, - creator: String, - creator_address: String, - creator_city: String, - creator_country: String, - creator_postal_code: String, - creator_region: String, - creator_work_email: String, - creator_work_telephone: String, - creator_work_url: String, - credit: String, - date_created: Time, - date_time_created: Time, - date_time_original: Time, - description: String, - digital_image_guid: String, - digital_source_type: String, - embedded_encoded_rights_expr: String, - embedded_encoded_rights_expr_lang_id: String, - embedded_encoded_rights_expr_type: String, - event: String, - exif_version: String, - flashpix_version: String, - genre_cv_id: String, - genre_cv_term_id: String, - genre_cv_term_name: String, - genre_cv_term_refined_about: String, - headline: String, - image_creator_id: String, - image_creator_image_id: String, - image_creator_name: String, - image_description: String, - image_region_boundary_h: ::Array[Float], - image_region_boundary_rx: ::Array[Float], - image_region_boundary_shape: ::Array[String], - image_region_boundary_unit: ::Array[String], - image_region_boundary_vertices_x: ::Array[Float], - image_region_boundary_vertices_y: ::Array[Float], - image_region_boundary_w: ::Array[Float], - image_region_boundary_x: ::Array[Float], - image_region_boundary_y: ::Array[Float], - image_region_ctype_identifier: ::Array[String], - image_region_ctype_name: ::Array[String], - image_region_id: ::Array[String], - image_region_name: ::Array[String], - image_region_organisation_in_image_name: ::Array[String], - image_region_person_in_image: ::Array[String], - image_region_role_identifier: ::Array[String], - image_region_role_name: ::Array[String], - image_supplier_id: String, - image_supplier_image_id: String, - image_supplier_name: String, - instructions: String, - intellectual_genre: String, - keywords: ::Array[String], - licensor_city: ::Array[String], - licensor_country: ::Array[String], - licensor_email: ::Array[String], - licensor_extended_address: ::Array[String], - licensor_id: ::Array[String], - licensor_name: ::Array[String], - licensor_postal_code: ::Array[String], - licensor_region: ::Array[String], - licensor_street_address: ::Array[String], - :licensor_telephone1 => ::Array[String], - :licensor_telephone2 => ::Array[String], - licensor_url: ::Array[String], - linked_encoded_rights_expr: String, - linked_encoded_rights_expr_lang_id: String, - linked_encoded_rights_expr_type: String, - location: String, - location_created_city: String, - location_created_country_code: String, - location_created_country_name: String, - location_created_gps_altitude: String, - location_created_gps_latitude: String, - location_created_gps_longitude: String, - location_created_location_id: String, - location_created_location_name: String, - location_created_province_state: String, - location_created_sublocation: String, - location_created_world_region: String, - location_shown_city: ::Array[String], - location_shown_country_code: ::Array[String], - location_shown_country_name: ::Array[String], - location_shown_gps_altitude: ::Array[String], - location_shown_gps_latitude: ::Array[String], - location_shown_gps_longitude: ::Array[String], - location_shown_location_id: ::Array[String], - location_shown_location_name: ::Array[String], - location_shown_province_state: ::Array[String], - location_shown_sublocation: ::Array[String], - location_shown_world_region: ::Array[String], - max_avail_height: Float, - max_avail_width: Float, - model_age: ::Array[Float], - model_release_id: ::Array[String], - object_attribute_reference: String, - object_name: String, - offset_time_original: String, - organisation_in_image_code: ::Array[String], - organisation_in_image_name: ::Array[String], - orientation: String, - original_transmission_reference: String, - person_in_image: ::Array[String], - person_in_image_cv_term_cv_id: ::Array[String], - person_in_image_cv_term_id: ::Array[String], - person_in_image_cv_term_name: ::Array[String], - person_in_image_cv_term_refined_about: ::Array[String], - person_in_image_description: ::Array[String], - person_in_image_id: ::Array[String], - person_in_image_name: ::Array[String], - product_in_image_description: ::Array[String], - product_in_image_gtin: ::Array[Float], - product_in_image_name: ::Array[String], - property_release_id: ::Array[String], - province_state: String, - rating: Integer, - registry_entry_role: ::Array[String], - registry_item_id: ::Array[String], - registry_organisation_id: ::Array[String], - resolution_unit: String, - rights: String, - scene: ::Array[String], - source: String, - special_instructions: String, - state: String, - subject: ::Array[String], - subject_code: ::Array[String], - subject_reference: ::Array[String], - sublocation: String, - time_created: String, - title: String, - transmission_reference: String, - usage_terms: String, - web_statement: String, - writer: String, - writer_editor: String, - x_resolution: Float, - y_resolution: Float - } - end - - type extension_status = - { - aws_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg - } - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - attr_reader aws_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging? - - def aws_auto_tagging=: ( - Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging - ) -> Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging - - attr_reader google_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging? - - def google_auto_tagging=: ( - Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging - ) -> Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging - - attr_reader remove_bg: Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg? - - def remove_bg=: ( - Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg - ) -> Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg - - def initialize: ( - ?aws_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging, - ?google_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging, - ?remove_bg: Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg - ) -> void - - def to_hash: -> { - aws_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg - } - - type aws_auto_tagging = :success | :pending | :failed - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Response::ExtensionStatus::aws_auto_tagging] - end - - type google_auto_tagging = :success | :pending | :failed - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Response::ExtensionStatus::google_auto_tagging] - end - - type remove_bg = :success | :pending | :failed - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadV2Response::ExtensionStatus::remove_bg] - end - end - - type metadata = - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - class Metadata < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_reader density: Integer? - - def density=: (Integer) -> Integer - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif? - - def exif=: ( - Imagekit::Models::FileUploadV2Response::Metadata::Exif - ) -> Imagekit::Models::FileUploadV2Response::Metadata::Exif - - attr_reader format_: String? - - def format_=: (String) -> String - - attr_reader has_color_profile: bool? - - def has_color_profile=: (bool) -> bool - - attr_reader has_transparency: bool? - - def has_transparency=: (bool) -> bool - - attr_reader height: Integer? - - def height=: (Integer) -> Integer - - attr_reader p_hash: String? - - def p_hash=: (String) -> String - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader size: Integer? - - def size=: (Integer) -> Integer - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Integer? - - def width=: (Integer) -> Integer - - def initialize: ( - ?audio_codec: String, - ?bit_rate: Integer, - ?density: Integer, - ?duration: Integer, - ?exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif, - ?format_: String, - ?has_color_profile: bool, - ?has_transparency: bool, - ?height: Integer, - ?p_hash: String, - ?quality: Integer, - ?size: Integer, - ?video_codec: String, - ?width: Integer - ) -> void - - def to_hash: -> { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadV2Response::Metadata::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - type exif = - { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::ExifDetails? - - def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails - - attr_reader gps: Imagekit::Gps? - - def gps=: (Imagekit::Gps) -> Imagekit::Gps - - attr_reader image: Imagekit::ExifImage? - - def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage - - attr_reader interoperability: Imagekit::Interoperability? - - def interoperability=: ( - Imagekit::Interoperability - ) -> Imagekit::Interoperability - - attr_reader makernote: ::Hash[Symbol, top]? - - def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader thumbnail: Imagekit::Thumbnail? - - def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail - - def initialize: ( - ?exif: Imagekit::ExifDetails, - ?gps: Imagekit::Gps, - ?image: Imagekit::ExifImage, - ?interoperability: Imagekit::Interoperability, - ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Thumbnail - ) -> void - - def to_hash: -> { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail - } - end - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - end -end diff --git a/sig/imagekit/models/files/bulk_add_tags_params.rbs b/sig/imagekit/models/files/bulk_add_tags_params.rbs new file mode 100644 index 00000000..756027fa --- /dev/null +++ b/sig/imagekit/models/files/bulk_add_tags_params.rbs @@ -0,0 +1,30 @@ +module Imagekit + module Models + module Files + type bulk_add_tags_params = + { file_ids: ::Array[String], tags: ::Array[String] } + & Imagekit::Internal::Type::request_parameters + + class BulkAddTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_ids: ::Array[String] + + attr_accessor tags: ::Array[String] + + def initialize: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_ids: ::Array[String], + tags: ::Array[String], + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/bulk_add_tags_response.rbs b/sig/imagekit/models/files/bulk_add_tags_response.rbs new file mode 100644 index 00000000..7d9309bc --- /dev/null +++ b/sig/imagekit/models/files/bulk_add_tags_response.rbs @@ -0,0 +1,20 @@ +module Imagekit + module Models + module Files + type bulk_add_tags_response = + { successfully_updated_file_ids: ::Array[String] } + + class BulkAddTagsResponse < Imagekit::Internal::Type::BaseModel + attr_reader successfully_updated_file_ids: ::Array[String]? + + def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] + + def initialize: ( + ?successfully_updated_file_ids: ::Array[String] + ) -> void + + def to_hash: -> { successfully_updated_file_ids: ::Array[String] } + end + end + end +end diff --git a/sig/imagekit/models/files/batch_delete_params.rbs b/sig/imagekit/models/files/bulk_delete_params.rbs similarity index 85% rename from sig/imagekit/models/files/batch_delete_params.rbs rename to sig/imagekit/models/files/bulk_delete_params.rbs index 418ed487..353a3add 100644 --- a/sig/imagekit/models/files/batch_delete_params.rbs +++ b/sig/imagekit/models/files/bulk_delete_params.rbs @@ -1,11 +1,11 @@ module Imagekit module Models module Files - type batch_delete_params = + type bulk_delete_params = { file_ids: ::Array[String] } & Imagekit::Internal::Type::request_parameters - class BatchDeleteParams < Imagekit::Internal::Type::BaseModel + class BulkDeleteParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/files/batch_delete_response.rbs b/sig/imagekit/models/files/bulk_delete_response.rbs similarity index 81% rename from sig/imagekit/models/files/batch_delete_response.rbs rename to sig/imagekit/models/files/bulk_delete_response.rbs index 654f28aa..7a5933c1 100644 --- a/sig/imagekit/models/files/batch_delete_response.rbs +++ b/sig/imagekit/models/files/bulk_delete_response.rbs @@ -1,10 +1,10 @@ module Imagekit module Models module Files - type batch_delete_response = + type bulk_delete_response = { successfully_deleted_file_ids: ::Array[String] } - class BatchDeleteResponse < Imagekit::Internal::Type::BaseModel + class BulkDeleteResponse < Imagekit::Internal::Type::BaseModel attr_reader successfully_deleted_file_ids: ::Array[String]? def successfully_deleted_file_ids=: (::Array[String]) -> ::Array[String] diff --git a/sig/imagekit/models/files/bulk_remove_ai_tags_params.rbs b/sig/imagekit/models/files/bulk_remove_ai_tags_params.rbs new file mode 100644 index 00000000..b7d6122d --- /dev/null +++ b/sig/imagekit/models/files/bulk_remove_ai_tags_params.rbs @@ -0,0 +1,30 @@ +module Imagekit + module Models + module Files + type bulk_remove_ai_tags_params = + { ai_tags: ::Array[String], file_ids: ::Array[String] } + & Imagekit::Internal::Type::request_parameters + + class BulkRemoveAITagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor ai_tags: ::Array[String] + + attr_accessor file_ids: ::Array[String] + + def initialize: ( + ai_tags: ::Array[String], + file_ids: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + ai_tags: ::Array[String], + file_ids: ::Array[String], + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/bulk_remove_ai_tags_response.rbs b/sig/imagekit/models/files/bulk_remove_ai_tags_response.rbs new file mode 100644 index 00000000..ffe753ea --- /dev/null +++ b/sig/imagekit/models/files/bulk_remove_ai_tags_response.rbs @@ -0,0 +1,20 @@ +module Imagekit + module Models + module Files + type bulk_remove_ai_tags_response = + { successfully_updated_file_ids: ::Array[String] } + + class BulkRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + attr_reader successfully_updated_file_ids: ::Array[String]? + + def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] + + def initialize: ( + ?successfully_updated_file_ids: ::Array[String] + ) -> void + + def to_hash: -> { successfully_updated_file_ids: ::Array[String] } + end + end + end +end diff --git a/sig/imagekit/models/files/bulk_remove_tags_params.rbs b/sig/imagekit/models/files/bulk_remove_tags_params.rbs new file mode 100644 index 00000000..020cfb2b --- /dev/null +++ b/sig/imagekit/models/files/bulk_remove_tags_params.rbs @@ -0,0 +1,30 @@ +module Imagekit + module Models + module Files + type bulk_remove_tags_params = + { file_ids: ::Array[String], tags: ::Array[String] } + & Imagekit::Internal::Type::request_parameters + + class BulkRemoveTagsParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor file_ids: ::Array[String] + + attr_accessor tags: ::Array[String] + + def initialize: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + file_ids: ::Array[String], + tags: ::Array[String], + request_options: Imagekit::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/bulk_remove_tags_response.rbs b/sig/imagekit/models/files/bulk_remove_tags_response.rbs new file mode 100644 index 00000000..ab915fda --- /dev/null +++ b/sig/imagekit/models/files/bulk_remove_tags_response.rbs @@ -0,0 +1,20 @@ +module Imagekit + module Models + module Files + type bulk_remove_tags_response = + { successfully_updated_file_ids: ::Array[String] } + + class BulkRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + attr_reader successfully_updated_file_ids: ::Array[String]? + + def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] + + def initialize: ( + ?successfully_updated_file_ids: ::Array[String] + ) -> void + + def to_hash: -> { successfully_updated_file_ids: ::Array[String] } + end + end + end +end diff --git a/sig/imagekit/models/files/detail_update_params.rbs b/sig/imagekit/models/files/detail_update_params.rbs deleted file mode 100644 index d414df76..00000000 --- a/sig/imagekit/models/files/detail_update_params.rbs +++ /dev/null @@ -1,227 +0,0 @@ -module Imagekit - module Models - module Files - type detail_update_params = - { - custom_coordinates: String?, - custom_metadata: top, - extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension], - remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String, - publish: Imagekit::Files::DetailUpdateParams::Publish - } - & Imagekit::Internal::Type::request_parameters - - class DetailUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: top? - - def custom_metadata=: (top) -> top - - attr_reader extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension]? - - def extensions=: ( - ::Array[Imagekit::Models::Files::DetailUpdateParams::extension] - ) -> ::Array[Imagekit::Models::Files::DetailUpdateParams::extension] - - attr_reader remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags? - - def remove_ai_tags=: ( - Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags - ) -> Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags - - attr_accessor tags: ::Array[String]? - - attr_reader webhook_url: String? - - def webhook_url=: (String) -> String - - attr_reader publish: Imagekit::Files::DetailUpdateParams::Publish? - - def publish=: ( - Imagekit::Files::DetailUpdateParams::Publish - ) -> Imagekit::Files::DetailUpdateParams::Publish - - def initialize: ( - ?custom_coordinates: String?, - ?custom_metadata: top, - ?extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension], - ?remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, - ?publish: Imagekit::Files::DetailUpdateParams::Publish, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - custom_coordinates: String?, - custom_metadata: top, - extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension], - remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String, - publish: Imagekit::Files::DetailUpdateParams::Publish, - request_options: Imagekit::RequestOptions - } - - type extension = - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension - | Imagekit::Files::DetailUpdateParams::Extension::AutoTaggingExtension - - module Extension - extend Imagekit::Internal::Type::Union - - type removedot_bg_extension = - { - name: Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options - } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_ - - attr_reader options: Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options? - - def options=: ( - Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options - ) -> Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options - - def initialize: ( - name: Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options - ) -> void - - def to_hash: -> { - name: Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::Files::DetailUpdateParams::Extension::RemovedotBgExtension::Options - } - - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateParams::Extension::RemovedotBgExtension::name_] - end - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? - - def add_shadow=: (bool) -> bool - - attr_reader bg_color: String? - - def bg_color=: (String) -> String - - attr_reader bg_image_url: String? - - def bg_image_url=: (String) -> String - - attr_reader semitransparency: bool? - - def semitransparency=: (bool) -> bool - - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void - - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end - - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_ - } - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer - - attr_accessor min_confidence: Integer - - attr_accessor name: Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_ - - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_ - ) -> void - - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_ - } - - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" - - def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateParams::Extension::AutoTaggingExtension::name_] - end - end - - def self?.variants: -> ::Array[Imagekit::Models::Files::DetailUpdateParams::extension] - end - - type remove_ai_tags = ::Array[String] | :all - - module RemoveAITags - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags] - - StringArray: Imagekit::Internal::Type::Converter - - ALL: :all - end - - type publish = { is_published: bool, include_file_versions: bool } - - class Publish < Imagekit::Internal::Type::BaseModel - attr_accessor is_published: bool - - attr_reader include_file_versions: bool? - - def include_file_versions=: (bool) -> bool - - def initialize: ( - is_published: bool, - ?include_file_versions: bool - ) -> void - - def to_hash: -> { is_published: bool, include_file_versions: bool } - end - end - end - end -end diff --git a/sig/imagekit/models/files/detail_update_response.rbs b/sig/imagekit/models/files/detail_update_response.rbs deleted file mode 100644 index 2f635f1d..00000000 --- a/sig/imagekit/models/files/detail_update_response.rbs +++ /dev/null @@ -1,284 +0,0 @@ -module Imagekit - module Models - module Files - type detail_update_response = - { - ai_tags: ::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag]?, - created_at: String, - custom_coordinates: String?, - custom_metadata: top, - extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: String, - updated_at: String, - url: String, - version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, - width: Float - } - - class DetailUpdateResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag]? - - attr_reader created_at: String? - - def created_at=: (String) -> String - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: top? - - def custom_metadata=: (top) -> top - - attr_reader extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus? - - def extension_status=: ( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus - ) -> Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader has_alpha: bool? - - def has_alpha=: (bool) -> bool - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader mime: String? - - def mime=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail: String? - - def thumbnail=: (String) -> String - - attr_reader type: String? - - def type=: (String) -> String - - attr_reader updated_at: String? - - def updated_at=: (String) -> String - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo? - - def version_info=: ( - Imagekit::Models::Files::DetailUpdateResponse::VersionInfo - ) -> Imagekit::Models::Files::DetailUpdateResponse::VersionInfo - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag]?, - ?created_at: String, - ?custom_coordinates: String?, - ?custom_metadata: top, - ?extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?has_alpha: bool, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?mime: String, - ?name: String, - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail: String, - ?type: String, - ?updated_at: String, - ?url: String, - ?version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::Files::DetailUpdateResponse::AITag]?, - created_at: String, - custom_coordinates: String?, - custom_metadata: top, - extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: String, - updated_at: String, - url: String, - version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type extension_status = - { - aws_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg - } - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - attr_reader aws_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging? - - def aws_auto_tagging=: ( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging - ) -> Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging - - attr_reader google_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging? - - def google_auto_tagging=: ( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging - ) -> Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging - - attr_reader remove_bg: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg? - - def remove_bg=: ( - Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg - ) -> Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg - - def initialize: ( - ?aws_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging, - ?google_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging, - ?remove_bg: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg - ) -> void - - def to_hash: -> { - aws_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg - } - - type aws_auto_tagging = :success | :pending | :failed - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::aws_auto_tagging] - end - - type google_auto_tagging = :success | :pending | :failed - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::google_auto_tagging] - end - - type remove_bg = :success | :pending | :failed - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus::remove_bg] - end - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - end - end -end diff --git a/sig/imagekit/models/files/metadata_from_url_response.rbs b/sig/imagekit/models/files/metadata_from_url_response.rbs deleted file mode 100644 index 3b3dd9ed..00000000 --- a/sig/imagekit/models/files/metadata_from_url_response.rbs +++ /dev/null @@ -1,173 +0,0 @@ -module Imagekit - module Models - module Files - type metadata_from_url_response = - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - class MetadataFromURLResponse < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_reader density: Integer? - - def density=: (Integer) -> Integer - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif? - - def exif=: ( - Imagekit::Models::Files::MetadataFromURLResponse::Exif - ) -> Imagekit::Models::Files::MetadataFromURLResponse::Exif - - attr_reader format_: String? - - def format_=: (String) -> String - - attr_reader has_color_profile: bool? - - def has_color_profile=: (bool) -> bool - - attr_reader has_transparency: bool? - - def has_transparency=: (bool) -> bool - - attr_reader height: Integer? - - def height=: (Integer) -> Integer - - attr_reader p_hash: String? - - def p_hash=: (String) -> String - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader size: Integer? - - def size=: (Integer) -> Integer - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Integer? - - def width=: (Integer) -> Integer - - def initialize: ( - ?audio_codec: String, - ?bit_rate: Integer, - ?density: Integer, - ?duration: Integer, - ?exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif, - ?format_: String, - ?has_color_profile: bool, - ?has_transparency: bool, - ?height: Integer, - ?p_hash: String, - ?quality: Integer, - ?size: Integer, - ?video_codec: String, - ?width: Integer - ) -> void - - def to_hash: -> { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - type exif = - { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::ExifDetails? - - def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails - - attr_reader gps: Imagekit::Gps? - - def gps=: (Imagekit::Gps) -> Imagekit::Gps - - attr_reader image: Imagekit::ExifImage? - - def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage - - attr_reader interoperability: Imagekit::Interoperability? - - def interoperability=: ( - Imagekit::Interoperability - ) -> Imagekit::Interoperability - - attr_reader makernote: ::Hash[Symbol, top]? - - def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader thumbnail: Imagekit::Thumbnail? - - def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail - - def initialize: ( - ?exif: Imagekit::ExifDetails, - ?gps: Imagekit::Gps, - ?image: Imagekit::ExifImage, - ?interoperability: Imagekit::Interoperability, - ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Thumbnail - ) -> void - - def to_hash: -> { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail - } - end - end - end - end -end diff --git a/sig/imagekit/models/files/purge_execute_params.rbs b/sig/imagekit/models/files/metadata_get_from_url_params.rbs similarity index 82% rename from sig/imagekit/models/files/purge_execute_params.rbs rename to sig/imagekit/models/files/metadata_get_from_url_params.rbs index ce1c6fff..9a87d773 100644 --- a/sig/imagekit/models/files/purge_execute_params.rbs +++ b/sig/imagekit/models/files/metadata_get_from_url_params.rbs @@ -1,10 +1,10 @@ module Imagekit module Models module Files - type purge_execute_params = + type metadata_get_from_url_params = { url: String } & Imagekit::Internal::Type::request_parameters - class PurgeExecuteParams < Imagekit::Internal::Type::BaseModel + class MetadataGetFromURLParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/files/metadata_get_from_url_response.rbs b/sig/imagekit/models/files/metadata_get_from_url_response.rbs new file mode 100644 index 00000000..0befaf28 --- /dev/null +++ b/sig/imagekit/models/files/metadata_get_from_url_response.rbs @@ -0,0 +1,550 @@ +module Imagekit + module Models + module Files + type metadata_get_from_url_response = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class MetadataGetFromURLResponse < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif? + + def exif=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif? + + def exif=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif + + attr_reader gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps? + + def gps=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps + + attr_reader image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image? + + def image=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image + + attr_reader interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability? + + def interoperability=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail? + + def thumbnail=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + + def initialize: ( + ?exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + ?gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + ?image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + ?interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end + end + end + end + end +end diff --git a/sig/imagekit/models/files/purge_status_params.rbs b/sig/imagekit/models/files/metadata_get_params.rbs similarity index 81% rename from sig/imagekit/models/files/purge_status_params.rbs rename to sig/imagekit/models/files/metadata_get_params.rbs index 6a4a291b..61c39d07 100644 --- a/sig/imagekit/models/files/purge_status_params.rbs +++ b/sig/imagekit/models/files/metadata_get_params.rbs @@ -1,10 +1,10 @@ module Imagekit module Models module Files - type purge_status_params = + type metadata_get_params = { } & Imagekit::Internal::Type::request_parameters - class PurgeStatusParams < Imagekit::Internal::Type::BaseModel + class MetadataGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/files/metadata_get_response.rbs b/sig/imagekit/models/files/metadata_get_response.rbs new file mode 100644 index 00000000..749a3cad --- /dev/null +++ b/sig/imagekit/models/files/metadata_get_response.rbs @@ -0,0 +1,550 @@ +module Imagekit + module Models + module Files + type metadata_get_response = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataGetResponse::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class MetadataGetResponse < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Models::Files::MetadataGetResponse::Exif? + + def exif=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Models::Files::MetadataGetResponse::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Models::Files::MetadataGetResponse::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif? + + def exif=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Exif + + attr_reader gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps? + + def gps=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Gps + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Gps + + attr_reader image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image? + + def image=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Image + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Image + + attr_reader interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability? + + def interoperability=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail? + + def thumbnail=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + + def initialize: ( + ?exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + ?gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + ?image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + ?interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end + end + end + end + end +end diff --git a/sig/imagekit/models/files/metadata_retrieve_response.rbs b/sig/imagekit/models/files/metadata_retrieve_response.rbs deleted file mode 100644 index aed29837..00000000 --- a/sig/imagekit/models/files/metadata_retrieve_response.rbs +++ /dev/null @@ -1,173 +0,0 @@ -module Imagekit - module Models - module Files - type metadata_retrieve_response = - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - class MetadataRetrieveResponse < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_reader density: Integer? - - def density=: (Integer) -> Integer - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif? - - def exif=: ( - Imagekit::Models::Files::MetadataRetrieveResponse::Exif - ) -> Imagekit::Models::Files::MetadataRetrieveResponse::Exif - - attr_reader format_: String? - - def format_=: (String) -> String - - attr_reader has_color_profile: bool? - - def has_color_profile=: (bool) -> bool - - attr_reader has_transparency: bool? - - def has_transparency=: (bool) -> bool - - attr_reader height: Integer? - - def height=: (Integer) -> Integer - - attr_reader p_hash: String? - - def p_hash=: (String) -> String - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader size: Integer? - - def size=: (Integer) -> Integer - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Integer? - - def width=: (Integer) -> Integer - - def initialize: ( - ?audio_codec: String, - ?bit_rate: Integer, - ?density: Integer, - ?duration: Integer, - ?exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif, - ?format_: String, - ?has_color_profile: bool, - ?has_transparency: bool, - ?height: Integer, - ?p_hash: String, - ?quality: Integer, - ?size: Integer, - ?video_codec: String, - ?width: Integer - ) -> void - - def to_hash: -> { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - type exif = - { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::ExifDetails? - - def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails - - attr_reader gps: Imagekit::Gps? - - def gps=: (Imagekit::Gps) -> Imagekit::Gps - - attr_reader image: Imagekit::ExifImage? - - def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage - - attr_reader interoperability: Imagekit::Interoperability? - - def interoperability=: ( - Imagekit::Interoperability - ) -> Imagekit::Interoperability - - attr_reader makernote: ::Hash[Symbol, top]? - - def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader thumbnail: Imagekit::Thumbnail? - - def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail - - def initialize: ( - ?exif: Imagekit::ExifDetails, - ?gps: Imagekit::Gps, - ?image: Imagekit::ExifImage, - ?interoperability: Imagekit::Interoperability, - ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Thumbnail - ) -> void - - def to_hash: -> { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail - } - end - end - end - end -end diff --git a/sig/imagekit/models/files/purge_status_response.rbs b/sig/imagekit/models/files/purge_status_response.rbs deleted file mode 100644 index d1beea8b..00000000 --- a/sig/imagekit/models/files/purge_status_response.rbs +++ /dev/null @@ -1,35 +0,0 @@ -module Imagekit - module Models - module Files - type purge_status_response = - { status: Imagekit::Models::Files::PurgeStatusResponse::status } - - class PurgeStatusResponse < Imagekit::Internal::Type::BaseModel - attr_reader status: Imagekit::Models::Files::PurgeStatusResponse::status? - - def status=: ( - Imagekit::Models::Files::PurgeStatusResponse::status - ) -> Imagekit::Models::Files::PurgeStatusResponse::status - - def initialize: ( - ?status: Imagekit::Models::Files::PurgeStatusResponse::status - ) -> void - - def to_hash: -> { - status: Imagekit::Models::Files::PurgeStatusResponse::status - } - - type status = :Pending | :Completed - - module Status - extend Imagekit::Internal::Type::Enum - - PENDING: :Pending - COMPLETED: :Completed - - def self?.values: -> ::Array[Imagekit::Models::Files::PurgeStatusResponse::status] - end - end - end - end -end diff --git a/sig/imagekit/models/files/version_retrieve_params.rbs b/sig/imagekit/models/files/version_get_params.rbs similarity index 83% rename from sig/imagekit/models/files/version_retrieve_params.rbs rename to sig/imagekit/models/files/version_get_params.rbs index ca629949..9944b0e5 100644 --- a/sig/imagekit/models/files/version_retrieve_params.rbs +++ b/sig/imagekit/models/files/version_get_params.rbs @@ -1,10 +1,10 @@ module Imagekit module Models module Files - type version_retrieve_params = + type version_get_params = { file_id: String } & Imagekit::Internal::Type::request_parameters - class VersionRetrieveParams < Imagekit::Internal::Type::BaseModel + class VersionGetParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/files/version_retrieve_response.rbs b/sig/imagekit/models/files/version_get_response.rbs similarity index 83% rename from sig/imagekit/models/files/version_retrieve_response.rbs rename to sig/imagekit/models/files/version_get_response.rbs index a1d1e342..ca764d51 100644 --- a/sig/imagekit/models/files/version_retrieve_response.rbs +++ b/sig/imagekit/models/files/version_get_response.rbs @@ -1,9 +1,9 @@ module Imagekit module Models module Files - type version_retrieve_response = + type version_get_response = { - ai_tags: ::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag]?, + ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, created_at: String, custom_coordinates: String?, custom_metadata: top, @@ -22,12 +22,12 @@ module Imagekit type: String, updated_at: String, url: String, - version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, width: Float } - class VersionRetrieveResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag]? + class VersionGetResponse < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]? attr_reader created_at: String? @@ -97,18 +97,18 @@ module Imagekit def url=: (String) -> String - attr_reader version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo? + attr_reader version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo? def version_info=: ( - Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo - ) -> Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo + Imagekit::Models::Files::VersionGetResponse::VersionInfo + ) -> Imagekit::Models::Files::VersionGetResponse::VersionInfo attr_reader width: Float? def width=: (Float) -> Float def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag]?, + ?ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, ?created_at: String, ?custom_coordinates: String?, ?custom_metadata: top, @@ -127,12 +127,12 @@ module Imagekit ?type: String, ?updated_at: String, ?url: String, - ?version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + ?version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, ?width: Float ) -> void def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::Files::VersionRetrieveResponse::AITag]?, + ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, created_at: String, custom_coordinates: String?, custom_metadata: top, @@ -151,7 +151,7 @@ module Imagekit type: String, updated_at: String, url: String, - version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo, + version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, width: Float } diff --git a/sig/imagekit/models/bulk_job_copy_folder_params.rbs b/sig/imagekit/models/folder_copy_params.rbs similarity index 89% rename from sig/imagekit/models/bulk_job_copy_folder_params.rbs rename to sig/imagekit/models/folder_copy_params.rbs index 6eb4383f..90f19170 100644 --- a/sig/imagekit/models/bulk_job_copy_folder_params.rbs +++ b/sig/imagekit/models/folder_copy_params.rbs @@ -1,6 +1,6 @@ module Imagekit module Models - type bulk_job_copy_folder_params = + type folder_copy_params = { destination_path: String, source_folder_path: String, @@ -8,7 +8,7 @@ module Imagekit } & Imagekit::Internal::Type::request_parameters - class BulkJobCopyFolderParams < Imagekit::Internal::Type::BaseModel + class FolderCopyParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/bulk_job_copy_folder_response.rbs b/sig/imagekit/models/folder_copy_response.rbs similarity index 61% rename from sig/imagekit/models/bulk_job_copy_folder_response.rbs rename to sig/imagekit/models/folder_copy_response.rbs index 6ee9d3cd..764eaaec 100644 --- a/sig/imagekit/models/bulk_job_copy_folder_response.rbs +++ b/sig/imagekit/models/folder_copy_response.rbs @@ -1,8 +1,8 @@ module Imagekit module Models - type bulk_job_copy_folder_response = { job_id: String } + type folder_copy_response = { job_id: String } - class BulkJobCopyFolderResponse < Imagekit::Internal::Type::BaseModel + class FolderCopyResponse < Imagekit::Internal::Type::BaseModel attr_reader job_id: String? def job_id=: (String) -> String diff --git a/sig/imagekit/models/bulk_job_move_folder_params.rbs b/sig/imagekit/models/folder_move_params.rbs similarity index 86% rename from sig/imagekit/models/bulk_job_move_folder_params.rbs rename to sig/imagekit/models/folder_move_params.rbs index 5bf317fc..50d1d68a 100644 --- a/sig/imagekit/models/bulk_job_move_folder_params.rbs +++ b/sig/imagekit/models/folder_move_params.rbs @@ -1,10 +1,10 @@ module Imagekit module Models - type bulk_job_move_folder_params = + type folder_move_params = { destination_path: String, source_folder_path: String } & Imagekit::Internal::Type::request_parameters - class BulkJobMoveFolderParams < Imagekit::Internal::Type::BaseModel + class FolderMoveParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/bulk_job_move_folder_response.rbs b/sig/imagekit/models/folder_move_response.rbs similarity index 61% rename from sig/imagekit/models/bulk_job_move_folder_response.rbs rename to sig/imagekit/models/folder_move_response.rbs index b3eb218f..5ed07b1c 100644 --- a/sig/imagekit/models/bulk_job_move_folder_response.rbs +++ b/sig/imagekit/models/folder_move_response.rbs @@ -1,8 +1,8 @@ module Imagekit module Models - type bulk_job_move_folder_response = { job_id: String } + type folder_move_response = { job_id: String } - class BulkJobMoveFolderResponse < Imagekit::Internal::Type::BaseModel + class FolderMoveResponse < Imagekit::Internal::Type::BaseModel attr_reader job_id: String? def job_id=: (String) -> String diff --git a/sig/imagekit/models/folder_rename_params.rbs b/sig/imagekit/models/folder_rename_params.rbs new file mode 100644 index 00000000..ddb509d9 --- /dev/null +++ b/sig/imagekit/models/folder_rename_params.rbs @@ -0,0 +1,34 @@ +module Imagekit + module Models + type folder_rename_params = + { folder_path: String, new_folder_name: String, purge_cache: bool } + & Imagekit::Internal::Type::request_parameters + + class FolderRenameParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + attr_accessor folder_path: String + + attr_accessor new_folder_name: String + + attr_reader purge_cache: bool? + + def purge_cache=: (bool) -> bool + + def initialize: ( + folder_path: String, + new_folder_name: String, + ?purge_cache: bool, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + folder_path: String, + new_folder_name: String, + purge_cache: bool, + request_options: Imagekit::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/folder_rename_response.rbs b/sig/imagekit/models/folder_rename_response.rbs new file mode 100644 index 00000000..11edeed4 --- /dev/null +++ b/sig/imagekit/models/folder_rename_response.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type folder_rename_response = { job_id: String } + + class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + attr_reader job_id: String? + + def job_id=: (String) -> String + + def initialize: (?job_id: String) -> void + + def to_hash: -> { job_id: String } + end + end +end diff --git a/sig/imagekit/models/folders/job_get_params.rbs b/sig/imagekit/models/folders/job_get_params.rbs new file mode 100644 index 00000000..ea747749 --- /dev/null +++ b/sig/imagekit/models/folders/job_get_params.rbs @@ -0,0 +1,16 @@ +module Imagekit + module Models + module Folders + type job_get_params = { } & Imagekit::Internal::Type::request_parameters + + class JobGetParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/folders/job_get_response.rbs b/sig/imagekit/models/folders/job_get_response.rbs new file mode 100644 index 00000000..247c4fb2 --- /dev/null +++ b/sig/imagekit/models/folders/job_get_response.rbs @@ -0,0 +1,45 @@ +module Imagekit + module Models + module Folders + type job_get_response = + { + job_id: String, + purge_request_id: String, + status: String, + type: String + } + + class JobGetResponse < Imagekit::Internal::Type::BaseModel + attr_reader job_id: String? + + def job_id=: (String) -> String + + attr_reader purge_request_id: String? + + def purge_request_id=: (String) -> String + + attr_reader status: String? + + def status=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + def initialize: ( + ?job_id: String, + ?purge_request_id: String, + ?status: String, + ?type: String + ) -> void + + def to_hash: -> { + job_id: String, + purge_request_id: String, + status: String, + type: String + } + end + end + end +end diff --git a/sig/imagekit/models/gps.rbs b/sig/imagekit/models/gps.rbs deleted file mode 100644 index d11c6a06..00000000 --- a/sig/imagekit/models/gps.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - end -end diff --git a/sig/imagekit/models/interoperability.rbs b/sig/imagekit/models/interoperability.rbs deleted file mode 100644 index f653174a..00000000 --- a/sig/imagekit/models/interoperability.rbs +++ /dev/null @@ -1,19 +0,0 @@ -module Imagekit - module Models - type interoperability = { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: (?interop_index: String, ?interop_version: String) -> void - - def to_hash: -> { interop_index: String, interop_version: String } - end - end -end diff --git a/sig/imagekit/models/thumbnail.rbs b/sig/imagekit/models/thumbnail.rbs deleted file mode 100644 index 0fcbb367..00000000 --- a/sig/imagekit/models/thumbnail.rbs +++ /dev/null @@ -1,57 +0,0 @@ -module Imagekit - module Models - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end - end -end diff --git a/sig/imagekit/resources/accounts.rbs b/sig/imagekit/resources/accounts.rbs index 7846935f..dfc6188c 100644 --- a/sig/imagekit/resources/accounts.rbs +++ b/sig/imagekit/resources/accounts.rbs @@ -1,11 +1,11 @@ module Imagekit module Resources class Accounts - def get_usage: ( - end_date: Date, - start_date: Date, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::AccountGetUsageResponse + attr_reader usage: Imagekit::Resources::Accounts::Usage + + attr_reader origins: Imagekit::Resources::Accounts::Origins + + attr_reader url_endpoints: Imagekit::Resources::Accounts::URLEndpoints def initialize: (client: Imagekit::Client) -> void end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs new file mode 100644 index 00000000..fc156612 --- /dev/null +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -0,0 +1,71 @@ +module Imagekit + module Resources + class Accounts + class Origins + def create: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Models::Accounts::OriginCreateParams::type_, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?forward_host_header_to_origin: bool, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::origin_create_response + + def update: ( + String id, + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Imagekit::Models::Accounts::OriginUpdateParams::type_, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?forward_host_header_to_origin: bool, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::origin_update_response + + def list: ( + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::origin_list_response + + def delete: (String id, ?request_options: Imagekit::request_opts) -> nil + + def get: ( + String id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::origin_get_response + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/accounts/url_endpoints.rbs b/sig/imagekit/resources/accounts/url_endpoints.rbs new file mode 100644 index 00000000..a9679e07 --- /dev/null +++ b/sig/imagekit/resources/accounts/url_endpoints.rbs @@ -0,0 +1,37 @@ +module Imagekit + module Resources + class Accounts + class URLEndpoints + def create: ( + description: String, + ?origins: ::Array[String], + ?url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::URLEndpointCreateResponse + + def update: ( + String id, + description: String, + ?origins: ::Array[String], + ?url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::URLEndpointUpdateResponse + + def list: ( + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::url_endpoint_list_response + + def delete: (String id, ?request_options: Imagekit::request_opts) -> nil + + def get: ( + String id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::URLEndpointGetResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/accounts/usage.rbs b/sig/imagekit/resources/accounts/usage.rbs new file mode 100644 index 00000000..b4c781db --- /dev/null +++ b/sig/imagekit/resources/accounts/usage.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Resources + class Accounts + class Usage + def get: ( + end_date: Date, + start_date: Date, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Accounts::UsageGetResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/assets.rbs b/sig/imagekit/resources/assets.rbs new file mode 100644 index 00000000..65ba95d1 --- /dev/null +++ b/sig/imagekit/resources/assets.rbs @@ -0,0 +1,18 @@ +module Imagekit + module Resources + class Assets + def list: ( + ?file_type: Imagekit::Models::AssetListParams::file_type, + ?limit: Integer, + ?path: String, + ?search_query: String, + ?skip: Integer, + ?sort: Imagekit::Models::AssetListParams::sort, + ?type: Imagekit::Models::AssetListParams::type_, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::asset_list_response + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/resources/beta.rbs b/sig/imagekit/resources/beta.rbs new file mode 100644 index 00000000..750d302a --- /dev/null +++ b/sig/imagekit/resources/beta.rbs @@ -0,0 +1,9 @@ +module Imagekit + module Resources + class Beta + attr_reader v2: Imagekit::Resources::Beta::V2 + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/resources/beta/v2.rbs b/sig/imagekit/resources/beta/v2.rbs new file mode 100644 index 00000000..3b91ef06 --- /dev/null +++ b/sig/imagekit/resources/beta/v2.rbs @@ -0,0 +1,11 @@ +module Imagekit + module Resources + class Beta + class V2 + attr_reader files: Imagekit::Resources::Beta::V2::Files + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/beta/v2/files.rbs b/sig/imagekit/resources/beta/v2/files.rbs new file mode 100644 index 00000000..1bc818b9 --- /dev/null +++ b/sig/imagekit/resources/beta/v2/files.rbs @@ -0,0 +1,35 @@ +module Imagekit + module Resources + class Beta + class V2 + class Files + def upload: ( + file: Imagekit::Internal::file_input, + file_name: String, + ?token: String, + ?checks: String, + ?custom_coordinates: String, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension], + ?folder: String, + ?is_private_file: bool, + ?is_published: bool, + ?overwrite_ai_tags: bool, + ?overwrite_custom_metadata: bool, + ?overwrite_file: bool, + ?overwrite_tags: bool, + ?response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + ?tags: ::Array[String], + ?transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, + ?use_unique_file_name: bool, + ?webhook_url: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Beta::V2::FileUploadResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end + end +end diff --git a/sig/imagekit/resources/bulk_jobs.rbs b/sig/imagekit/resources/bulk_jobs.rbs deleted file mode 100644 index df4d5a60..00000000 --- a/sig/imagekit/resources/bulk_jobs.rbs +++ /dev/null @@ -1,25 +0,0 @@ -module Imagekit - module Resources - class BulkJobs - def copy_folder: ( - destination_path: String, - source_folder_path: String, - ?include_versions: bool, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::BulkJobCopyFolderResponse - - def move_folder: ( - destination_path: String, - source_folder_path: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::BulkJobMoveFolderResponse - - def retrieve_status: ( - String job_id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::BulkJobRetrieveStatusResponse - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/cache.rbs b/sig/imagekit/resources/cache.rbs new file mode 100644 index 00000000..e8051527 --- /dev/null +++ b/sig/imagekit/resources/cache.rbs @@ -0,0 +1,9 @@ +module Imagekit + module Resources + class Cache + attr_reader invalidation: Imagekit::Resources::Cache::Invalidation + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/resources/files/purge.rbs b/sig/imagekit/resources/cache/invalidation.rbs similarity index 57% rename from sig/imagekit/resources/files/purge.rbs rename to sig/imagekit/resources/cache/invalidation.rbs index 345d9f7b..66bcbae0 100644 --- a/sig/imagekit/resources/files/purge.rbs +++ b/sig/imagekit/resources/cache/invalidation.rbs @@ -1,16 +1,16 @@ module Imagekit module Resources - class Files - class Purge - def execute: ( + class Cache + class Invalidation + def create: ( url: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::PurgeExecuteResponse + ) -> Imagekit::Models::Cache::InvalidationCreateResponse - def status: ( + def get: ( String request_id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::PurgeStatusResponse + ) -> Imagekit::Models::Cache::InvalidationGetResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 97bdb50b..c0aa0d23 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -1,38 +1,30 @@ module Imagekit module Resources class Files - attr_reader details: Imagekit::Resources::Files::Details - - attr_reader batch: Imagekit::Resources::Files::Batch + attr_reader bulk: Imagekit::Resources::Files::Bulk attr_reader versions: Imagekit::Resources::Files::Versions - attr_reader purge: Imagekit::Resources::Files::Purge - attr_reader metadata: Imagekit::Resources::Files::Metadata - def list: ( - ?file_type: String, - ?limit: String, - ?path: String, - ?search_query: String, - ?skip: String, - ?sort: String, - ?type: Imagekit::Models::FileListParams::type_, + def update: ( + String file_id, + ?custom_coordinates: String?, + ?custom_metadata: top, + ?description: String, + ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], + ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, + ?publish: Imagekit::FileUpdateParams::Publish, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::file_list_response + ) -> Imagekit::Models::FileUpdateResponse def delete: ( String file_id, ?request_options: Imagekit::request_opts ) -> nil - def add_tags: ( - file_ids: ::Array[String], - tags: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileAddTagsResponse - def copy: ( destination_path: String, source_file_path: String, @@ -40,24 +32,17 @@ module Imagekit ?request_options: Imagekit::request_opts ) -> top + def get: ( + String file_id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FileGetResponse + def move: ( destination_path: String, source_file_path: String, ?request_options: Imagekit::request_opts ) -> top - def remove_ai_tags: ( - ai_tags: ::Array[String], - file_ids: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileRemoveAITagsResponse - - def remove_tags: ( - file_ids: ::Array[String], - tags: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileRemoveTagsResponse - def rename: ( file_path: String, new_file_name: String, @@ -65,54 +50,32 @@ module Imagekit ?request_options: Imagekit::request_opts ) -> Imagekit::Models::FileRenameResponse - def upload_v1: ( - file: String, + def upload: ( + file: Imagekit::Internal::file_input, file_name: String, ?token: String, ?checks: String, ?custom_coordinates: String, - ?custom_metadata: String, - ?expire: String, - ?extensions: String, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?expire: Integer, + ?extensions: ::Array[Imagekit::Models::FileUploadParams::extension], ?folder: String, - ?is_private_file: Imagekit::Models::FileUploadV1Params::is_private_file, - ?is_published: Imagekit::Models::FileUploadV1Params::is_published, - ?overwrite_ai_tags: Imagekit::Models::FileUploadV1Params::overwrite_ai_tags, - ?overwrite_custom_metadata: Imagekit::Models::FileUploadV1Params::overwrite_custom_metadata, - ?overwrite_file: String, - ?overwrite_tags: Imagekit::Models::FileUploadV1Params::overwrite_tags, + ?is_private_file: bool, + ?is_published: bool, + ?overwrite_ai_tags: bool, + ?overwrite_custom_metadata: bool, + ?overwrite_file: bool, + ?overwrite_tags: bool, ?public_key: String, - ?response_fields: String, + ?response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], ?signature: String, - ?tags: String, - ?transformation: String, - ?use_unique_file_name: Imagekit::Models::FileUploadV1Params::use_unique_file_name, - ?webhook_url: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileUploadV1Response - - def upload_v2: ( - file: String, - file_name: String, - ?token: String, - ?checks: String, - ?custom_coordinates: String, - ?custom_metadata: String, - ?extensions: String, - ?folder: String, - ?is_private_file: Imagekit::Models::FileUploadV2Params::is_private_file, - ?is_published: Imagekit::Models::FileUploadV2Params::is_published, - ?overwrite_ai_tags: Imagekit::Models::FileUploadV2Params::overwrite_ai_tags, - ?overwrite_custom_metadata: Imagekit::Models::FileUploadV2Params::overwrite_custom_metadata, - ?overwrite_file: String, - ?overwrite_tags: Imagekit::Models::FileUploadV2Params::overwrite_tags, - ?response_fields: String, - ?tags: String, - ?transformation: String, - ?use_unique_file_name: Imagekit::Models::FileUploadV2Params::use_unique_file_name, + ?tags: ::Array[String], + ?transformation: Imagekit::FileUploadParams::Transformation, + ?use_unique_file_name: bool, ?webhook_url: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileUploadV2Response + ) -> Imagekit::Models::FileUploadResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/sig/imagekit/resources/files/bulk.rbs b/sig/imagekit/resources/files/bulk.rbs new file mode 100644 index 00000000..a8df17a8 --- /dev/null +++ b/sig/imagekit/resources/files/bulk.rbs @@ -0,0 +1,32 @@ +module Imagekit + module Resources + class Files + class Bulk + def delete: ( + file_ids: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::BulkDeleteResponse + + def add_tags: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::BulkAddTagsResponse + + def remove_ai_tags: ( + ai_tags: ::Array[String], + file_ids: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::BulkRemoveAITagsResponse + + def remove_tags: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::BulkRemoveTagsResponse + + def initialize: (client: Imagekit::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/files/details.rbs b/sig/imagekit/resources/files/details.rbs deleted file mode 100644 index da506ae9..00000000 --- a/sig/imagekit/resources/files/details.rbs +++ /dev/null @@ -1,26 +0,0 @@ -module Imagekit - module Resources - class Files - class Details - def retrieve: ( - String file_id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::DetailRetrieveResponse - - def update: ( - String file_id, - ?custom_coordinates: String?, - ?custom_metadata: top, - ?extensions: ::Array[Imagekit::Models::Files::DetailUpdateParams::extension], - ?remove_ai_tags: Imagekit::Models::Files::DetailUpdateParams::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, - ?publish: Imagekit::Files::DetailUpdateParams::Publish, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::DetailUpdateResponse - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/files/metadata.rbs b/sig/imagekit/resources/files/metadata.rbs index dea8d704..7b40d2ac 100644 --- a/sig/imagekit/resources/files/metadata.rbs +++ b/sig/imagekit/resources/files/metadata.rbs @@ -2,15 +2,15 @@ module Imagekit module Resources class Files class Metadata - def retrieve: ( + def get: ( String file_id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::MetadataRetrieveResponse + ) -> Imagekit::Models::Files::MetadataGetResponse - def from_url: ( + def get_from_url: ( url: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::MetadataFromURLResponse + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/sig/imagekit/resources/files/versions.rbs b/sig/imagekit/resources/files/versions.rbs index 02977214..a1a0934e 100644 --- a/sig/imagekit/resources/files/versions.rbs +++ b/sig/imagekit/resources/files/versions.rbs @@ -2,12 +2,6 @@ module Imagekit module Resources class Files class Versions - def retrieve: ( - String version_id, - file_id: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::VersionRetrieveResponse - def list: ( String file_id, ?request_options: Imagekit::request_opts @@ -19,6 +13,12 @@ module Imagekit ?request_options: Imagekit::request_opts ) -> top + def get: ( + String version_id, + file_id: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::Files::VersionGetResponse + def restore: ( String version_id, file_id: String, diff --git a/sig/imagekit/resources/folder.rbs b/sig/imagekit/resources/folder.rbs deleted file mode 100644 index 40210acb..00000000 --- a/sig/imagekit/resources/folder.rbs +++ /dev/null @@ -1,18 +0,0 @@ -module Imagekit - module Resources - class Folder - def create: ( - folder_name: String, - parent_folder_path: String, - ?request_options: Imagekit::request_opts - ) -> top - - def delete: ( - folder_path: String, - ?request_options: Imagekit::request_opts - ) -> top - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/folders.rbs b/sig/imagekit/resources/folders.rbs new file mode 100644 index 00000000..72cc1ea2 --- /dev/null +++ b/sig/imagekit/resources/folders.rbs @@ -0,0 +1,40 @@ +module Imagekit + module Resources + class Folders + attr_reader job: Imagekit::Resources::Folders::Job + + def create: ( + folder_name: String, + parent_folder_path: String, + ?request_options: Imagekit::request_opts + ) -> top + + def delete: ( + folder_path: String, + ?request_options: Imagekit::request_opts + ) -> top + + def copy: ( + destination_path: String, + source_folder_path: String, + ?include_versions: bool, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FolderCopyResponse + + def move: ( + destination_path: String, + source_folder_path: String, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FolderMoveResponse + + def rename: ( + folder_path: String, + new_folder_name: String, + ?purge_cache: bool, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::FolderRenameResponse + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/sig/imagekit/resources/files/batch.rbs b/sig/imagekit/resources/folders/job.rbs similarity index 53% rename from sig/imagekit/resources/files/batch.rbs rename to sig/imagekit/resources/folders/job.rbs index 7eef2dda..81561a88 100644 --- a/sig/imagekit/resources/files/batch.rbs +++ b/sig/imagekit/resources/folders/job.rbs @@ -1,11 +1,11 @@ module Imagekit module Resources - class Files - class Batch - def delete: ( - file_ids: ::Array[String], + class Folders + class Job + def get: ( + String job_id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::BatchDeleteResponse + ) -> Imagekit::Models::Folders::JobGetResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/client_test.rb b/test/imagekit/client_test.rb index 1b55e779..22cda48d 100644 --- a/test/imagekit/client_test.rb +++ b/test/imagekit/client_test.rb @@ -45,10 +45,7 @@ def test_client_default_request_default_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end assert_requested(:any, /./, times: 3) @@ -66,10 +63,7 @@ def test_client_given_request_default_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end assert_requested(:any, /./, times: 4) @@ -86,8 +80,8 @@ def test_client_default_request_given_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( + file: Pathname(__FILE__), file_name: "fileName", request_options: {max_retries: 3} ) @@ -108,8 +102,8 @@ def test_client_given_request_given_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( + file: Pathname(__FILE__), file_name: "fileName", request_options: {max_retries: 4} ) @@ -134,10 +128,7 @@ def test_client_retry_after_seconds ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end assert_requested(:any, /./, times: 2) @@ -161,10 +152,7 @@ def test_client_retry_after_date assert_raises(Imagekit::Errors::InternalServerError) do Thread.current.thread_variable_set(:time_now, Time.now) - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") Thread.current.thread_variable_set(:time_now, nil) end @@ -188,10 +176,7 @@ def test_client_retry_after_ms ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end assert_requested(:any, /./, times: 2) @@ -209,10 +194,7 @@ def test_retry_count_header ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end 3.times do @@ -231,8 +213,8 @@ def test_omit_retry_count_header ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {"x-stainless-retry-count" => nil}} ) @@ -254,8 +236,8 @@ def test_overwrite_retry_count_header ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {"x-stainless-retry-count" => "42"}} ) @@ -283,8 +265,8 @@ def test_client_redirect_307 ) assert_raises(Imagekit::Errors::APIConnectionError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {}} ) @@ -321,8 +303,8 @@ def test_client_redirect_303 ) assert_raises(Imagekit::Errors::APIConnectionError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {}} ) @@ -354,8 +336,8 @@ def test_client_redirect_auth_keep_same_origin ) assert_raises(Imagekit::Errors::APIConnectionError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {"authorization" => "Bearer xyz"}} ) @@ -390,8 +372,8 @@ def test_client_redirect_auth_strip_cross_origin ) assert_raises(Imagekit::Errors::APIConnectionError) do - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", + image_kit.files.upload( + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {"authorization" => "Bearer xyz"}} ) @@ -413,10 +395,7 @@ def test_default_headers password: "My Password" ) - image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") assert_requested(:any, /./) do |req| headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type") diff --git a/test/imagekit/resource_namespaces.rb b/test/imagekit/resource_namespaces.rb index 7f494522..52347d84 100644 --- a/test/imagekit/resource_namespaces.rb +++ b/test/imagekit/resource_namespaces.rb @@ -3,8 +3,25 @@ module Imagekit module Test module Resources + module Accounts + end + + module Beta + module V2 + end + end + + module Cache + end + module Files end + + module Folders + end + + module V2 + end end end end diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb new file mode 100644 index 00000000..7ab82736 --- /dev/null +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -0,0 +1,113 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Accounts::OriginsTest < Imagekit::Test::ResourceTest + def test_create_required_params + skip("Prism tests are disabled") + + response = + @image_kit.accounts.origins.create( + base_url: "https://akeneo.company.com", + client_id: "akeneo-client-id", + client_secret: "akeneo-client-secret", + name: "US S3 Storage", + password: "strongpassword123", + type: :AKENEO_PIM, + username: "integration-user" + ) + + assert_pattern do + response => Imagekit::Models::Accounts::OriginCreateResponse + end + + assert_pattern do + case response + in Imagekit::Models::Accounts::OriginCreateResponse::S3 + in Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible + in Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup + in Imagekit::Models::Accounts::OriginCreateResponse::WebFolder + in Imagekit::Models::Accounts::OriginCreateResponse::WebProxy + in Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs + in Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim + end + end + end + + def test_update_required_params + skip("Prism tests are disabled") + + response = + @image_kit.accounts.origins.update( + "id", + base_url: "https://akeneo.company.com", + client_id: "akeneo-client-id", + client_secret: "akeneo-client-secret", + name: "US S3 Storage", + password: "strongpassword123", + type: :AKENEO_PIM, + username: "integration-user" + ) + + assert_pattern do + response => Imagekit::Models::Accounts::OriginUpdateResponse + end + + assert_pattern do + case response + in Imagekit::Models::Accounts::OriginUpdateResponse::S3 + in Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible + in Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup + in Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder + in Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy + in Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs + in Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim + end + end + end + + def test_list + skip("Prism tests are disabled") + + response = @image_kit.accounts.origins.list + + assert_pattern do + response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::Accounts::OriginListResponseItem]) + end + end + + def test_delete + skip("Prism tests are disabled") + + response = @image_kit.accounts.origins.delete("id") + + assert_pattern do + response => nil + end + end + + def test_get + skip("Prism tests are disabled") + + response = @image_kit.accounts.origins.get("id") + + assert_pattern do + response => Imagekit::Models::Accounts::OriginGetResponse + end + + assert_pattern do + case response + in Imagekit::Models::Accounts::OriginGetResponse::S3 + in Imagekit::Models::Accounts::OriginGetResponse::S3Compatible + in Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup + in Imagekit::Models::Accounts::OriginGetResponse::WebFolder + in Imagekit::Models::Accounts::OriginGetResponse::WebProxy + in Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs + in Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim + end + end + end +end diff --git a/test/imagekit/resources/accounts/url_endpoints_test.rb b/test/imagekit/resources/accounts/url_endpoints_test.rb new file mode 100644 index 00000000..baa5cf70 --- /dev/null +++ b/test/imagekit/resources/accounts/url_endpoints_test.rb @@ -0,0 +1,85 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Accounts::URLEndpointsTest < Imagekit::Test::ResourceTest + def test_create_required_params + skip("Prism tests are disabled") + + response = @image_kit.accounts.url_endpoints.create(description: "My custom URL endpoint") + + assert_pattern do + response => Imagekit::Models::Accounts::URLEndpointCreateResponse + end + + assert_pattern do + response => { + id: String, + description: String, + origins: ^(Imagekit::Internal::Type::ArrayOf[String]), + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter | nil + } + end + end + + def test_update_required_params + skip("Prism tests are disabled") + + response = @image_kit.accounts.url_endpoints.update("id", description: "My custom URL endpoint") + + assert_pattern do + response => Imagekit::Models::Accounts::URLEndpointUpdateResponse + end + + assert_pattern do + response => { + id: String, + description: String, + origins: ^(Imagekit::Internal::Type::ArrayOf[String]), + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter | nil + } + end + end + + def test_list + skip("Prism tests are disabled") + + response = @image_kit.accounts.url_endpoints.list + + assert_pattern do + response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Accounts::URLEndpointListResponseItem]) + end + end + + def test_delete + skip("Prism tests are disabled") + + response = @image_kit.accounts.url_endpoints.delete("id") + + assert_pattern do + response => nil + end + end + + def test_get + skip("Prism tests are disabled") + + response = @image_kit.accounts.url_endpoints.get("id") + + assert_pattern do + response => Imagekit::Models::Accounts::URLEndpointGetResponse + end + + assert_pattern do + response => { + id: String, + description: String, + origins: ^(Imagekit::Internal::Type::ArrayOf[String]), + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter | nil + } + end + end +end diff --git a/test/imagekit/resources/accounts/usage_test.rb b/test/imagekit/resources/accounts/usage_test.rb new file mode 100644 index 00000000..30337d45 --- /dev/null +++ b/test/imagekit/resources/accounts/usage_test.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Accounts::UsageTest < Imagekit::Test::ResourceTest + def test_get_required_params + skip("Prism tests are disabled") + + response = @image_kit.accounts.usage.get(end_date: "2019-12-27", start_date: "2019-12-27") + + assert_pattern do + response => Imagekit::Models::Accounts::UsageGetResponse + end + + assert_pattern do + response => { + bandwidth_bytes: Integer | nil, + extension_units_count: Integer | nil, + media_library_storage_bytes: Integer | nil, + original_cache_storage_bytes: Integer | nil, + video_processing_units_count: Integer | nil + } + end + end +end diff --git a/test/imagekit/resources/accounts_test.rb b/test/imagekit/resources/accounts_test.rb index e501bb77..73ea1f30 100644 --- a/test/imagekit/resources/accounts_test.rb +++ b/test/imagekit/resources/accounts_test.rb @@ -3,23 +3,4 @@ require_relative "../test_helper" class Imagekit::Test::Resources::AccountsTest < Imagekit::Test::ResourceTest - def test_get_usage_required_params - skip("Prism tests are disabled") - - response = @image_kit.accounts.get_usage(end_date: "2019-12-27", start_date: "2019-12-27") - - assert_pattern do - response => Imagekit::Models::AccountGetUsageResponse - end - - assert_pattern do - response => { - bandwidth_bytes: Integer | nil, - extension_units_count: Integer | nil, - media_library_storage_bytes: Integer | nil, - original_cache_storage_bytes: Integer | nil, - video_processing_units_count: Integer | nil - } - end - end end diff --git a/test/imagekit/resources/assets_test.rb b/test/imagekit/resources/assets_test.rb new file mode 100644 index 00000000..31121c1c --- /dev/null +++ b/test/imagekit/resources/assets_test.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::AssetsTest < Imagekit::Test::ResourceTest + def test_list + skip("Prism tests are disabled") + + response = @image_kit.assets.list + + assert_pattern do + response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::AssetListResponseItem]) + end + end +end diff --git a/test/imagekit/resources/beta/v2/files_test.rb b/test/imagekit/resources/beta/v2/files_test.rb new file mode 100644 index 00000000..ce496d7c --- /dev/null +++ b/test/imagekit/resources/beta/v2/files_test.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +require_relative "../../../test_helper" + +class Imagekit::Test::Resources::Beta::V2::FilesTest < Imagekit::Test::ResourceTest + def test_upload_required_params + skip("Prism tests are disabled") + + response = @image_kit.beta.v2.files.upload(file: Pathname(__FILE__), file_name: "fileName") + + assert_pattern do + response => Imagekit::Models::Beta::V2::FileUploadResponse + end + + assert_pattern do + response => { + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]) | nil, + audio_codec: String | nil, + bit_rate: Integer | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + duration: Integer | nil, + embedded_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail_url: String | nil, + url: String | nil, + version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo | nil, + video_codec: String | nil, + width: Float | nil + } + end + end +end diff --git a/test/imagekit/resources/beta/v2_test.rb b/test/imagekit/resources/beta/v2_test.rb new file mode 100644 index 00000000..e35e2d0d --- /dev/null +++ b/test/imagekit/resources/beta/v2_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Beta::V2Test < Imagekit::Test::ResourceTest +end diff --git a/test/imagekit/resources/beta_test.rb b/test/imagekit/resources/beta_test.rb new file mode 100644 index 00000000..9118a6f1 --- /dev/null +++ b/test/imagekit/resources/beta_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::BetaTest < Imagekit::Test::ResourceTest +end diff --git a/test/imagekit/resources/bulk_jobs_test.rb b/test/imagekit/resources/bulk_jobs_test.rb deleted file mode 100644 index fd8ac3e0..00000000 --- a/test/imagekit/resources/bulk_jobs_test.rb +++ /dev/null @@ -1,63 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::Resources::BulkJobsTest < Imagekit::Test::ResourceTest - def test_copy_folder_required_params - skip("Prism tests are disabled") - - response = - @image_kit.bulk_jobs.copy_folder( - destination_path: "/path/of/destination/folder", - source_folder_path: "/path/of/source/folder" - ) - - assert_pattern do - response => Imagekit::Models::BulkJobCopyFolderResponse - end - - assert_pattern do - response => { - job_id: String | nil - } - end - end - - def test_move_folder_required_params - skip("Prism tests are disabled") - - response = - @image_kit.bulk_jobs.move_folder( - destination_path: "/path/of/destination/folder", - source_folder_path: "/path/of/source/folder" - ) - - assert_pattern do - response => Imagekit::Models::BulkJobMoveFolderResponse - end - - assert_pattern do - response => { - job_id: String | nil - } - end - end - - def test_retrieve_status - skip("Prism tests are disabled") - - response = @image_kit.bulk_jobs.retrieve_status("jobId") - - assert_pattern do - response => Imagekit::Models::BulkJobRetrieveStatusResponse - end - - assert_pattern do - response => { - job_id: String | nil, - status: String | nil, - type: String | nil - } - end - end -end diff --git a/test/imagekit/resources/cache/invalidation_test.rb b/test/imagekit/resources/cache/invalidation_test.rb new file mode 100644 index 00000000..e732093a --- /dev/null +++ b/test/imagekit/resources/cache/invalidation_test.rb @@ -0,0 +1,38 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Cache::InvalidationTest < Imagekit::Test::ResourceTest + def test_create_required_params + skip("Prism tests are disabled") + + response = + @image_kit.cache.invalidation.create(url: "https://ik.imagekit.io/your_imagekit_id/default-image.jpg") + + assert_pattern do + response => Imagekit::Models::Cache::InvalidationCreateResponse + end + + assert_pattern do + response => { + request_id: String | nil + } + end + end + + def test_get + skip("Prism tests are disabled") + + response = @image_kit.cache.invalidation.get("requestId") + + assert_pattern do + response => Imagekit::Models::Cache::InvalidationGetResponse + end + + assert_pattern do + response => { + status: Imagekit::Models::Cache::InvalidationGetResponse::Status | nil + } + end + end +end diff --git a/test/imagekit/resources/cache_test.rb b/test/imagekit/resources/cache_test.rb new file mode 100644 index 00000000..5844ad3c --- /dev/null +++ b/test/imagekit/resources/cache_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::CacheTest < Imagekit::Test::ResourceTest +end diff --git a/test/imagekit/resources/files/batch_test.rb b/test/imagekit/resources/files/batch_test.rb deleted file mode 100644 index 76a0f3ea..00000000 --- a/test/imagekit/resources/files/batch_test.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -require_relative "../../test_helper" - -class Imagekit::Test::Resources::Files::BatchTest < Imagekit::Test::ResourceTest - def test_delete_required_params - skip("Prism tests are disabled") - - response = - @image_kit.files.batch.delete(file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be]) - - assert_pattern do - response => Imagekit::Models::Files::BatchDeleteResponse - end - - assert_pattern do - response => { - successfully_deleted_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil - } - end - end -end diff --git a/test/imagekit/resources/files/bulk_test.rb b/test/imagekit/resources/files/bulk_test.rb new file mode 100644 index 00000000..dc86a12b --- /dev/null +++ b/test/imagekit/resources/files/bulk_test.rb @@ -0,0 +1,82 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Files::BulkTest < Imagekit::Test::ResourceTest + def test_delete_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.bulk.delete(file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be]) + + assert_pattern do + response => Imagekit::Models::Files::BulkDeleteResponse + end + + assert_pattern do + response => { + successfully_deleted_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + } + end + end + + def test_add_tags_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.bulk.add_tags( + file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be], + tags: %w[t-shirt round-neck sale2019] + ) + + assert_pattern do + response => Imagekit::Models::Files::BulkAddTagsResponse + end + + assert_pattern do + response => { + successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + } + end + end + + def test_remove_ai_tags_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.bulk.remove_ai_tags( + ai_tags: %w[t-shirt round-neck sale2019], + file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be] + ) + + assert_pattern do + response => Imagekit::Models::Files::BulkRemoveAITagsResponse + end + + assert_pattern do + response => { + successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + } + end + end + + def test_remove_tags_required_params + skip("Prism tests are disabled") + + response = + @image_kit.files.bulk.remove_tags( + file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be], + tags: %w[t-shirt round-neck sale2019] + ) + + assert_pattern do + response => Imagekit::Models::Files::BulkRemoveTagsResponse + end + + assert_pattern do + response => { + successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + } + end + end +end diff --git a/test/imagekit/resources/files/details_test.rb b/test/imagekit/resources/files/details_test.rb deleted file mode 100644 index 937a1be5..00000000 --- a/test/imagekit/resources/files/details_test.rb +++ /dev/null @@ -1,78 +0,0 @@ -# frozen_string_literal: true - -require_relative "../../test_helper" - -class Imagekit::Test::Resources::Files::DetailsTest < Imagekit::Test::ResourceTest - def test_retrieve - skip("Prism tests are disabled") - - response = @image_kit.files.details.retrieve("fileId") - - assert_pattern do - response => Imagekit::Models::Files::DetailRetrieveResponse - end - - assert_pattern do - response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::DetailRetrieveResponse::AITag]) | nil, - created_at: String | nil, - custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, - file_id: String | nil, - file_path: String | nil, - file_type: String | nil, - has_alpha: Imagekit::Internal::Type::Boolean | nil, - height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, - mime: String | nil, - name: String | nil, - size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, - thumbnail: String | nil, - type: String | nil, - updated_at: String | nil, - url: String | nil, - version_info: Imagekit::Models::Files::DetailRetrieveResponse::VersionInfo | nil, - width: Float | nil - } - end - end - - def test_update - skip("Prism tests are disabled") - - response = @image_kit.files.details.update("fileId") - - assert_pattern do - response => Imagekit::Models::Files::DetailUpdateResponse - end - - assert_pattern do - response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::DetailUpdateResponse::AITag]) | nil, - created_at: String | nil, - custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, - extension_status: Imagekit::Models::Files::DetailUpdateResponse::ExtensionStatus | nil, - file_id: String | nil, - file_path: String | nil, - file_type: String | nil, - has_alpha: Imagekit::Internal::Type::Boolean | nil, - height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, - mime: String | nil, - name: String | nil, - size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, - thumbnail: String | nil, - type: String | nil, - updated_at: String | nil, - url: String | nil, - version_info: Imagekit::Models::Files::DetailUpdateResponse::VersionInfo | nil, - width: Float | nil - } - end - end -end diff --git a/test/imagekit/resources/files/metadata_test.rb b/test/imagekit/resources/files/metadata_test.rb index 076c7531..4bca4ea5 100644 --- a/test/imagekit/resources/files/metadata_test.rb +++ b/test/imagekit/resources/files/metadata_test.rb @@ -3,13 +3,13 @@ require_relative "../../test_helper" class Imagekit::Test::Resources::Files::MetadataTest < Imagekit::Test::ResourceTest - def test_retrieve + def test_get skip("Prism tests are disabled") - response = @image_kit.files.metadata.retrieve("fileId") + response = @image_kit.files.metadata.get("fileId") assert_pattern do - response => Imagekit::Models::Files::MetadataRetrieveResponse + response => Imagekit::Models::Files::MetadataGetResponse end assert_pattern do @@ -18,7 +18,7 @@ def test_retrieve bit_rate: Integer | nil, density: Integer | nil, duration: Integer | nil, - exif: Imagekit::Models::Files::MetadataRetrieveResponse::Exif | nil, + exif: Imagekit::Models::Files::MetadataGetResponse::Exif | nil, format_: String | nil, has_color_profile: Imagekit::Internal::Type::Boolean | nil, has_transparency: Imagekit::Internal::Type::Boolean | nil, @@ -32,13 +32,13 @@ def test_retrieve end end - def test_from_url_required_params + def test_get_from_url_required_params skip("Prism tests are disabled") - response = @image_kit.files.metadata.from_url(url: "url") + response = @image_kit.files.metadata.get_from_url(url: "https://example.com") assert_pattern do - response => Imagekit::Models::Files::MetadataFromURLResponse + response => Imagekit::Models::Files::MetadataGetFromURLResponse end assert_pattern do @@ -47,7 +47,7 @@ def test_from_url_required_params bit_rate: Integer | nil, density: Integer | nil, duration: Integer | nil, - exif: Imagekit::Models::Files::MetadataFromURLResponse::Exif | nil, + exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif | nil, format_: String | nil, has_color_profile: Imagekit::Internal::Type::Boolean | nil, has_transparency: Imagekit::Internal::Type::Boolean | nil, diff --git a/test/imagekit/resources/files/purge_test.rb b/test/imagekit/resources/files/purge_test.rb deleted file mode 100644 index 10bfe7f5..00000000 --- a/test/imagekit/resources/files/purge_test.rb +++ /dev/null @@ -1,38 +0,0 @@ -# frozen_string_literal: true - -require_relative "../../test_helper" - -class Imagekit::Test::Resources::Files::PurgeTest < Imagekit::Test::ResourceTest - def test_execute_required_params - skip("Prism tests are disabled") - - response = - @image_kit.files.purge.execute(url: "https://ik.imagekit.io/your_imagekit_id/default-image.jpg") - - assert_pattern do - response => Imagekit::Models::Files::PurgeExecuteResponse - end - - assert_pattern do - response => { - request_id: String | nil - } - end - end - - def test_status - skip("Prism tests are disabled") - - response = @image_kit.files.purge.status("requestId") - - assert_pattern do - response => Imagekit::Models::Files::PurgeStatusResponse - end - - assert_pattern do - response => { - status: Imagekit::Models::Files::PurgeStatusResponse::Status | nil - } - end - end -end diff --git a/test/imagekit/resources/files/versions_test.rb b/test/imagekit/resources/files/versions_test.rb index ad2cc5d2..3d105892 100644 --- a/test/imagekit/resources/files/versions_test.rb +++ b/test/imagekit/resources/files/versions_test.rb @@ -3,18 +3,38 @@ require_relative "../../test_helper" class Imagekit::Test::Resources::Files::VersionsTest < Imagekit::Test::ResourceTest - def test_retrieve_required_params + def test_list + skip("Prism tests are disabled") + + response = @image_kit.files.versions.list("fileId") + + assert_pattern do + response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionListResponseItem]) + end + end + + def test_delete_required_params + skip("Prism tests are disabled") + + response = @image_kit.files.versions.delete("versionId", file_id: "fileId") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end + + def test_get_required_params skip("Prism tests are disabled") - response = @image_kit.files.versions.retrieve("versionId", file_id: "fileId") + response = @image_kit.files.versions.get("versionId", file_id: "fileId") assert_pattern do - response => Imagekit::Models::Files::VersionRetrieveResponse + response => Imagekit::Models::Files::VersionGetResponse end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRetrieveResponse::AITag]) | nil, + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionGetResponse::AITag]) | nil, created_at: String | nil, custom_coordinates: String | nil, custom_metadata: Imagekit::Internal::Type::Unknown | nil, @@ -33,32 +53,12 @@ def test_retrieve_required_params type: String | nil, updated_at: String | nil, url: String | nil, - version_info: Imagekit::Models::Files::VersionRetrieveResponse::VersionInfo | nil, + version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo | nil, width: Float | nil } end end - def test_list - skip("Prism tests are disabled") - - response = @image_kit.files.versions.list("fileId") - - assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionListResponseItem]) - end - end - - def test_delete_required_params - skip("Prism tests are disabled") - - response = @image_kit.files.versions.delete("versionId", file_id: "fileId") - - assert_pattern do - response => Imagekit::Internal::Type::Unknown - end - end - def test_restore_required_params skip("Prism tests are disabled") diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index 7e678b84..58950ecb 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -3,105 +3,108 @@ require_relative "../test_helper" class Imagekit::Test::Resources::FilesTest < Imagekit::Test::ResourceTest - def test_list + def test_update skip("Prism tests are disabled") - response = @image_kit.files.list + response = @image_kit.files.update("fileId") assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileListResponseItem]) - end - end - - def test_delete - skip("Prism tests are disabled") - - response = @image_kit.files.delete("fileId") - - assert_pattern do - response => nil - end - end - - def test_add_tags_required_params - skip("Prism tests are disabled") - - response = - @image_kit.files.add_tags( - file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be], - tags: %w[t-shirt round-neck sale2019] - ) - - assert_pattern do - response => Imagekit::Models::FileAddTagsResponse + response => Imagekit::Models::FileUpdateResponse end assert_pattern do response => { - successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUpdateResponse::AITag]) | nil, + created_at: String | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + has_alpha: Imagekit::Internal::Type::Boolean | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + mime: String | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail: String | nil, + type: String | nil, + updated_at: String | nil, + url: String | nil, + version_info: Imagekit::Models::FileUpdateResponse::VersionInfo | nil, + width: Float | nil } end end - def test_copy_required_params + def test_delete skip("Prism tests are disabled") - response = - @image_kit.files.copy(destination_path: "/folder/to/copy/into/", source_file_path: "/path/to/file.jpg") + response = @image_kit.files.delete("fileId") assert_pattern do - response => Imagekit::Internal::Type::Unknown + response => nil end end - def test_move_required_params + def test_copy_required_params skip("Prism tests are disabled") response = - @image_kit.files.move(destination_path: "/folder/to/move/into/", source_file_path: "/path/to/file.jpg") + @image_kit.files.copy(destination_path: "/folder/to/copy/into/", source_file_path: "/path/to/file.jpg") assert_pattern do response => Imagekit::Internal::Type::Unknown end end - def test_remove_ai_tags_required_params + def test_get skip("Prism tests are disabled") - response = - @image_kit.files.remove_ai_tags( - ai_tags: %w[t-shirt round-neck sale2019], - file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be] - ) + response = @image_kit.files.get("fileId") assert_pattern do - response => Imagekit::Models::FileRemoveAITagsResponse + response => Imagekit::Models::FileGetResponse end assert_pattern do response => { - successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileGetResponse::AITag]) | nil, + created_at: String | nil, + custom_coordinates: String | nil, + custom_metadata: Imagekit::Internal::Type::Unknown | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + has_alpha: Imagekit::Internal::Type::Boolean | nil, + height: Float | nil, + is_private_file: Imagekit::Internal::Type::Boolean | nil, + is_published: Imagekit::Internal::Type::Boolean | nil, + mime: String | nil, + name: String | nil, + size: Float | nil, + tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + thumbnail: String | nil, + type: String | nil, + updated_at: String | nil, + url: String | nil, + version_info: Imagekit::Models::FileGetResponse::VersionInfo | nil, + width: Float | nil } end end - def test_remove_tags_required_params + def test_move_required_params skip("Prism tests are disabled") response = - @image_kit.files.remove_tags( - file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be], - tags: %w[t-shirt round-neck sale2019] - ) - - assert_pattern do - response => Imagekit::Models::FileRemoveTagsResponse - end + @image_kit.files.move(destination_path: "/folder/to/move/into/", source_file_path: "/path/to/file.jpg") assert_pattern do - response => { - successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil - } + response => Imagekit::Internal::Type::Unknown end end @@ -121,84 +124,38 @@ def test_rename_required_params end end - def test_upload_v1_required_params - skip("Prism tests are disabled") - - response = - @image_kit.files.upload_v1( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) - - assert_pattern do - response => Imagekit::Models::FileUploadV1Response - end - - assert_pattern do - response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadV1Response::AITag]) | nil, - audio_codec: String | nil, - bit_rate: Integer | nil, - custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, - duration: Integer | nil, - embedded_metadata: Imagekit::Models::FileUploadV1Response::EmbeddedMetadata | nil, - extension_status: Imagekit::Models::FileUploadV1Response::ExtensionStatus | nil, - file_id: String | nil, - file_path: String | nil, - file_type: String | nil, - height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, - metadata: Imagekit::Models::FileUploadV1Response::Metadata | nil, - name: String | nil, - size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, - thumbnail_url: String | nil, - url: String | nil, - version_info: Imagekit::Models::FileUploadV1Response::VersionInfo | nil, - video_codec: String | nil, - width: Float | nil - } - end - end - - def test_upload_v2_required_params + def test_upload_required_params skip("Prism tests are disabled") - response = - @image_kit.files.upload_v2( - file: "https://www.example.com/rest-of-the-image-path.jpg", - file_name: "fileName" - ) + response = @image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") assert_pattern do - response => Imagekit::Models::FileUploadV2Response + response => Imagekit::Models::FileUploadResponse end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadV2Response::AITag]) | nil, + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadResponse::AITag]) | nil, audio_codec: String | nil, bit_rate: Integer | nil, custom_coordinates: String | nil, custom_metadata: Imagekit::Internal::Type::Unknown | nil, duration: Integer | nil, - embedded_metadata: Imagekit::Models::FileUploadV2Response::EmbeddedMetadata | nil, - extension_status: Imagekit::Models::FileUploadV2Response::ExtensionStatus | nil, + embedded_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, height: Float | nil, is_private_file: Imagekit::Internal::Type::Boolean | nil, is_published: Imagekit::Internal::Type::Boolean | nil, - metadata: Imagekit::Models::FileUploadV2Response::Metadata | nil, + metadata: Imagekit::Models::FileUploadResponse::Metadata | nil, name: String | nil, size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail_url: String | nil, url: String | nil, - version_info: Imagekit::Models::FileUploadV2Response::VersionInfo | nil, + version_info: Imagekit::Models::FileUploadResponse::VersionInfo | nil, video_codec: String | nil, width: Float | nil } diff --git a/test/imagekit/resources/folder_test.rb b/test/imagekit/resources/folder_test.rb deleted file mode 100644 index dcb8e4fa..00000000 --- a/test/imagekit/resources/folder_test.rb +++ /dev/null @@ -1,25 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::Resources::FolderTest < Imagekit::Test::ResourceTest - def test_create_required_params - skip("Prism tests are disabled") - - response = @image_kit.folder.create(folder_name: "summer", parent_folder_path: "/product/images/") - - assert_pattern do - response => Imagekit::Internal::Type::Unknown - end - end - - def test_delete_required_params - skip("Prism tests are disabled") - - response = @image_kit.folder.delete(folder_path: "/folder/to/delete/") - - assert_pattern do - response => Imagekit::Internal::Type::Unknown - end - end -end diff --git a/test/imagekit/resources/folders/job_test.rb b/test/imagekit/resources/folders/job_test.rb new file mode 100644 index 00000000..07b576d0 --- /dev/null +++ b/test/imagekit/resources/folders/job_test.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekit::Test::Resources::Folders::JobTest < Imagekit::Test::ResourceTest + def test_get + skip("Prism tests are disabled") + + response = @image_kit.folders.job.get("jobId") + + assert_pattern do + response => Imagekit::Models::Folders::JobGetResponse + end + + assert_pattern do + response => { + job_id: String | nil, + purge_request_id: String | nil, + status: String | nil, + type: String | nil + } + end + end +end diff --git a/test/imagekit/resources/folders_test.rb b/test/imagekit/resources/folders_test.rb new file mode 100644 index 00000000..29bc1232 --- /dev/null +++ b/test/imagekit/resources/folders_test.rb @@ -0,0 +1,81 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::FoldersTest < Imagekit::Test::ResourceTest + def test_create_required_params + skip("Prism tests are disabled") + + response = @image_kit.folders.create(folder_name: "summer", parent_folder_path: "/product/images/") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end + + def test_delete_required_params + skip("Prism tests are disabled") + + response = @image_kit.folders.delete(folder_path: "/folder/to/delete/") + + assert_pattern do + response => Imagekit::Internal::Type::Unknown + end + end + + def test_copy_required_params + skip("Prism tests are disabled") + + response = + @image_kit.folders.copy( + destination_path: "/path/of/destination/folder", + source_folder_path: "/path/of/source/folder" + ) + + assert_pattern do + response => Imagekit::Models::FolderCopyResponse + end + + assert_pattern do + response => { + job_id: String | nil + } + end + end + + def test_move_required_params + skip("Prism tests are disabled") + + response = + @image_kit.folders.move( + destination_path: "/path/of/destination/folder", + source_folder_path: "/path/of/source/folder" + ) + + assert_pattern do + response => Imagekit::Models::FolderMoveResponse + end + + assert_pattern do + response => { + job_id: String | nil + } + end + end + + def test_rename_required_params + skip("Prism tests are disabled") + + response = @image_kit.folders.rename(folder_path: "/path/of/folder", new_folder_name: "new-folder-name") + + assert_pattern do + response => Imagekit::Models::FolderRenameResponse + end + + assert_pattern do + response => { + job_id: String | nil + } + end + end +end From 0cdf842ed18e8893015009b8d4731c5929e362a6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 17 Aug 2025 06:20:27 +0000 Subject: [PATCH 004/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 5 + lib/imagekit/internal/type/base_model.rb | 10 +- lib/imagekit/models.rb | 10 + .../models/beta/v2/file_upload_response.rb | 342 +--------- lib/imagekit/models/exif_details.rb | 167 +++++ lib/imagekit/models/exif_image.rb | 77 +++ lib/imagekit/models/file_upload_response.rb | 341 +--------- .../files/metadata_get_from_url_response.rb | 342 +--------- .../models/files/metadata_get_response.rb | 341 +--------- lib/imagekit/models/gps.rb | 17 + lib/imagekit/models/interoperability.rb | 23 + lib/imagekit/models/thumbnail.rb | 47 ++ rbi/imagekit/models.rbi | 10 + .../models/beta/v2/file_upload_response.rbi | 641 +---------------- rbi/imagekit/models/exif_details.rbi | 264 +++++++ rbi/imagekit/models/exif_image.rbi | 127 ++++ rbi/imagekit/models/file_upload_response.rbi | 641 +---------------- .../files/metadata_get_from_url_response.rbi | 642 +----------------- .../models/files/metadata_get_response.rbi | 638 +---------------- rbi/imagekit/models/gps.rbi | 27 + rbi/imagekit/models/interoperability.rbi | 39 ++ rbi/imagekit/models/thumbnail.rbi | 82 +++ sig/imagekit/models.rbs | 10 + .../models/beta/v2/file_upload_response.rbs | 432 +----------- sig/imagekit/models/exif_details.rbs | 197 ++++++ sig/imagekit/models/exif_image.rbs | 92 +++ sig/imagekit/models/file_upload_response.rbs | 429 +----------- .../files/metadata_get_from_url_response.rbs | 429 +----------- .../models/files/metadata_get_response.rbs | 429 +----------- sig/imagekit/models/gps.rbs | 15 + sig/imagekit/models/interoperability.rbs | 19 + sig/imagekit/models/thumbnail.rbs | 57 ++ test/imagekit/resources/shared_test.rb | 6 + 34 files changed, 1541 insertions(+), 5409 deletions(-) create mode 100644 lib/imagekit/models/exif_details.rb create mode 100644 lib/imagekit/models/exif_image.rb create mode 100644 lib/imagekit/models/gps.rb create mode 100644 lib/imagekit/models/interoperability.rb create mode 100644 lib/imagekit/models/thumbnail.rb create mode 100644 rbi/imagekit/models/exif_details.rbi create mode 100644 rbi/imagekit/models/exif_image.rbi create mode 100644 rbi/imagekit/models/gps.rbi create mode 100644 rbi/imagekit/models/interoperability.rbi create mode 100644 rbi/imagekit/models/thumbnail.rbi create mode 100644 sig/imagekit/models/exif_details.rbs create mode 100644 sig/imagekit/models/exif_image.rbs create mode 100644 sig/imagekit/models/gps.rbs create mode 100644 sig/imagekit/models/interoperability.rbs create mode 100644 sig/imagekit/models/thumbnail.rbs create mode 100644 test/imagekit/resources/shared_test.rb diff --git a/.stats.yml b/.stats.yml index ee7ab859..d25e9ed9 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-c01164d5dc8f8c9ab2b7c1a1c793ac522d565f96e569b0e56a4e9353e39bab85.yml openapi_spec_hash: ac7b3a2b968fe86bf7bb81192209123f -config_hash: 8a4138f8d02720b4736ab63effb7fa2d +config_hash: 963efe3c7e328464ca83ae352b29bbb4 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index b4124510..1676573f 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -86,6 +86,8 @@ require_relative "imagekit/models/custom_metadata_field_list_response" require_relative "imagekit/models/custom_metadata_field_update_params" require_relative "imagekit/models/custom_metadata_field_update_response" +require_relative "imagekit/models/exif_details" +require_relative "imagekit/models/exif_image" require_relative "imagekit/models/file_copy_params" require_relative "imagekit/models/file_copy_response" require_relative "imagekit/models/file_delete_params" @@ -131,6 +133,9 @@ require_relative "imagekit/models/folder_rename_response" require_relative "imagekit/models/folders/job_get_params" require_relative "imagekit/models/folders/job_get_response" +require_relative "imagekit/models/gps" +require_relative "imagekit/models/interoperability" +require_relative "imagekit/models/thumbnail" require_relative "imagekit/models" require_relative "imagekit/resources/accounts" require_relative "imagekit/resources/accounts/origins" diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb index a9815d55..be589511 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekit/internal/type/base_model.rb @@ -445,11 +445,11 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `custom_metadata_field_create_response` is a `Imagekit::Models::CustomMetadataFieldCreateResponse` - # custom_metadata_field_create_response => { - # id: id, - # label: label, - # name: name + # # `exif_details` is a `Imagekit::ExifDetails` + # exif_details => { + # aperture_value: aperture_value, + # color_space: color_space, + # create_date: create_date # } def deconstruct_keys(keys) (keys || self.class.known_fields.keys) diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 3cca3149..24871353 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -55,6 +55,10 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + ExifDetails = Imagekit::Models::ExifDetails + + ExifImage = Imagekit::Models::ExifImage + FileCopyParams = Imagekit::Models::FileCopyParams FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -82,4 +86,10 @@ module Imagekit FolderRenameParams = Imagekit::Models::FolderRenameParams Folders = Imagekit::Models::Folders + + Gps = Imagekit::Models::Gps + + Interoperability = Imagekit::Models::Interoperability + + Thumbnail = Imagekit::Models::Thumbnail end diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekit/models/beta/v2/file_upload_response.rb index 16ccd3a9..09df962b 100644 --- a/lib/imagekit/models/beta/v2/file_upload_response.rb +++ b/lib/imagekit/models/beta/v2/file_upload_response.rb @@ -460,27 +460,26 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, nil] - optional :exif, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif } + # @return [Imagekit::Models::ExifDetails, nil] + optional :exif, -> { Imagekit::ExifDetails } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, nil] - optional :gps, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps } + # @return [Imagekit::Models::Gps, nil] + optional :gps, -> { Imagekit::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, nil] - optional :image, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image } + # @return [Imagekit::Models::ExifImage, nil] + optional :image, -> { Imagekit::ExifImage } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, nil] - optional :interoperability, - -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability } + # @return [Imagekit::Models::Interoperability, nil] + optional :interoperability, -> { Imagekit::Interoperability } # @!attribute makernote # @@ -490,332 +489,21 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail } + # @return [Imagekit::Models::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif] Object containing Exif details. + # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. # - # @param gps [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps] Object containing GPS information. + # @param gps [Imagekit::Models::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image] Object containing EXIF image information. + # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability] JSON object. + # @param interoperability [Imagekit::Models::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail] Object containing Thumbnail information. - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#image - class Image < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end + # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. end end diff --git a/lib/imagekit/models/exif_details.rb b/lib/imagekit/models/exif_details.rb new file mode 100644 index 00000000..e6af5a2c --- /dev/null +++ b/lib/imagekit/models/exif_details.rb @@ -0,0 +1,167 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class ExifDetails < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + end +end diff --git a/lib/imagekit/models/exif_image.rb b/lib/imagekit/models/exif_image.rb new file mode 100644 index 00000000..df6a92ed --- /dev/null +++ b/lib/imagekit/models/exif_image.rb @@ -0,0 +1,77 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class ExifImage < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + end +end diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekit/models/file_upload_response.rb index 918672ec..2d00923e 100644 --- a/lib/imagekit/models/file_upload_response.rb +++ b/lib/imagekit/models/file_upload_response.rb @@ -456,26 +456,26 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, nil] - optional :exif, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif } + # @return [Imagekit::Models::ExifDetails, nil] + optional :exif, -> { Imagekit::ExifDetails } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, nil] - optional :gps, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps } + # @return [Imagekit::Models::Gps, nil] + optional :gps, -> { Imagekit::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, nil] - optional :image, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Image } + # @return [Imagekit::Models::ExifImage, nil] + optional :image, -> { Imagekit::ExifImage } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, nil] - optional :interoperability, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability } + # @return [Imagekit::Models::Interoperability, nil] + optional :interoperability, -> { Imagekit::Interoperability } # @!attribute makernote # @@ -485,332 +485,21 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail } + # @return [Imagekit::Models::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif] Object containing Exif details. + # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. # - # @param gps [Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps] Object containing GPS information. + # @param gps [Imagekit::Models::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::FileUploadResponse::Metadata::Exif::Image] Object containing EXIF image information. + # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability] JSON object. + # @param interoperability [Imagekit::Models::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail] Object containing Thumbnail information. - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#image - class Image < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end + # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. end end diff --git a/lib/imagekit/models/files/metadata_get_from_url_response.rb b/lib/imagekit/models/files/metadata_get_from_url_response.rb index 02c5b3b5..ead81933 100644 --- a/lib/imagekit/models/files/metadata_get_from_url_response.rb +++ b/lib/imagekit/models/files/metadata_get_from_url_response.rb @@ -124,27 +124,26 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, nil] - optional :exif, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif } + # @return [Imagekit::Models::ExifDetails, nil] + optional :exif, -> { Imagekit::ExifDetails } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, nil] - optional :gps, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps } + # @return [Imagekit::Models::Gps, nil] + optional :gps, -> { Imagekit::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, nil] - optional :image, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image } + # @return [Imagekit::Models::ExifImage, nil] + optional :image, -> { Imagekit::ExifImage } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, nil] - optional :interoperability, - -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability } + # @return [Imagekit::Models::Interoperability, nil] + optional :interoperability, -> { Imagekit::Interoperability } # @!attribute makernote # @@ -154,332 +153,21 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail } + # @return [Imagekit::Models::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif] Object containing Exif details. + # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. # - # @param gps [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps] Object containing GPS information. + # @param gps [Imagekit::Models::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image] Object containing EXIF image information. + # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability] JSON object. + # @param interoperability [Imagekit::Models::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail] Object containing Thumbnail information. - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#image - class Image < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end + # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. end end end diff --git a/lib/imagekit/models/files/metadata_get_response.rb b/lib/imagekit/models/files/metadata_get_response.rb index aa974f73..62f0c1f6 100644 --- a/lib/imagekit/models/files/metadata_get_response.rb +++ b/lib/imagekit/models/files/metadata_get_response.rb @@ -124,26 +124,26 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, nil] - optional :exif, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Exif } + # @return [Imagekit::Models::ExifDetails, nil] + optional :exif, -> { Imagekit::ExifDetails } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, nil] - optional :gps, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Gps } + # @return [Imagekit::Models::Gps, nil] + optional :gps, -> { Imagekit::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Image, nil] - optional :image, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Image } + # @return [Imagekit::Models::ExifImage, nil] + optional :image, -> { Imagekit::ExifImage } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, nil] - optional :interoperability, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability } + # @return [Imagekit::Models::Interoperability, nil] + optional :interoperability, -> { Imagekit::Interoperability } # @!attribute makernote # @@ -153,332 +153,21 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail } + # @return [Imagekit::Models::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::Files::MetadataGetResponse::Exif::Exif] Object containing Exif details. + # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. # - # @param gps [Imagekit::Models::Files::MetadataGetResponse::Exif::Gps] Object containing GPS information. + # @param gps [Imagekit::Models::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::Files::MetadataGetResponse::Exif::Image] Object containing EXIF image information. + # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability] JSON object. + # @param interoperability [Imagekit::Models::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail] Object containing Thumbnail information. - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#image - class Image < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end + # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. end end end diff --git a/lib/imagekit/models/gps.rb b/lib/imagekit/models/gps.rb new file mode 100644 index 00000000..da477fce --- /dev/null +++ b/lib/imagekit/models/gps.rb @@ -0,0 +1,17 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + end +end diff --git a/lib/imagekit/models/interoperability.rb b/lib/imagekit/models/interoperability.rb new file mode 100644 index 00000000..23925987 --- /dev/null +++ b/lib/imagekit/models/interoperability.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + end +end diff --git a/lib/imagekit/models/thumbnail.rb b/lib/imagekit/models/thumbnail.rb new file mode 100644 index 00000000..8b864ac0 --- /dev/null +++ b/lib/imagekit/models/thumbnail.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end + end +end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 63a6bf4a..a514e6d7 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -21,6 +21,10 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + ExifDetails = Imagekit::Models::ExifDetails + + ExifImage = Imagekit::Models::ExifImage + FileCopyParams = Imagekit::Models::FileCopyParams FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -48,4 +52,10 @@ module Imagekit FolderRenameParams = Imagekit::Models::FolderRenameParams Folders = Imagekit::Models::Folders + + Gps = Imagekit::Models::Gps + + Interoperability = Imagekit::Models::Interoperability + + Thumbnail = Imagekit::Models::Thumbnail end diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekit/models/beta/v2/file_upload_response.rbi index 84d5a5e9..a0ee0029 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_response.rbi @@ -862,73 +862,33 @@ module Imagekit end # Object containing Exif details. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif - ) - ) - end + sig { returns(T.nilable(Imagekit::ExifDetails)) } attr_reader :exif - sig do - params( - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif::OrHash - ).void - end + sig { params(exif: Imagekit::ExifDetails::OrHash).void } attr_writer :exif # Object containing GPS information. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps - ) - ) - end + sig { returns(T.nilable(Imagekit::Gps)) } attr_reader :gps - sig do - params( - gps: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps::OrHash - ).void - end + sig { params(gps: Imagekit::Gps::OrHash).void } attr_writer :gps # Object containing EXIF image information. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image - ) - ) - end + sig { returns(T.nilable(Imagekit::ExifImage)) } attr_reader :image - sig do - params( - image: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image::OrHash - ).void - end + sig { params(image: Imagekit::ExifImage::OrHash).void } attr_writer :image # JSON object. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability - ) - ) - end + sig { returns(T.nilable(Imagekit::Interoperability)) } attr_reader :interoperability sig do params( - interoperability: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability::OrHash + interoperability: Imagekit::Interoperability::OrHash ).void end attr_writer :interoperability @@ -940,36 +900,20 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - ) - ) - end + sig { returns(T.nilable(Imagekit::Thumbnail)) } attr_reader :thumbnail - sig do - params( - thumbnail: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash - ).void - end + sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } attr_writer :thumbnail sig do params( - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif::OrHash, - gps: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps::OrHash, - image: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image::OrHash, - interoperability: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability::OrHash, + exif: Imagekit::ExifDetails::OrHash, + gps: Imagekit::Gps::OrHash, + image: Imagekit::ExifImage::OrHash, + interoperability: Imagekit::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash + thumbnail: Imagekit::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -990,562 +934,17 @@ module Imagekit sig do override.returns( { - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - gps: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - image: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - interoperability: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } ) end def to_hash end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns( - T.attached_class - ) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - - class Image < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params( - interop_index: String, - interop_version: String - ).returns(T.attached_class) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns( - { interop_index: String, interop_version: String } - ) - end - def to_hash - end - end - - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end end end diff --git a/rbi/imagekit/models/exif_details.rbi b/rbi/imagekit/models/exif_details.rbi new file mode 100644 index 00000000..9fa9f276 --- /dev/null +++ b/rbi/imagekit/models/exif_details.rbi @@ -0,0 +1,264 @@ +# typed: strong + +module Imagekit + module Models + class ExifDetails < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::ExifDetails, Imagekit::Internal::AnyHash) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/exif_image.rbi b/rbi/imagekit/models/exif_image.rbi new file mode 100644 index 00000000..cea9754a --- /dev/null +++ b/rbi/imagekit/models/exif_image.rbi @@ -0,0 +1,127 @@ +# typed: strong + +module Imagekit + module Models + class ExifImage < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Imagekit::ExifImage, Imagekit::Internal::AnyHash) } + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekit/models/file_upload_response.rbi index f32cdbe2..94499689 100644 --- a/rbi/imagekit/models/file_upload_response.rbi +++ b/rbi/imagekit/models/file_upload_response.rbi @@ -829,74 +829,32 @@ module Imagekit end # Object containing Exif details. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif - ) - ) - end + sig { returns(T.nilable(Imagekit::ExifDetails)) } attr_reader :exif - sig do - params( - exif: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif::OrHash - ).void - end + sig { params(exif: Imagekit::ExifDetails::OrHash).void } attr_writer :exif # Object containing GPS information. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps - ) - ) - end + sig { returns(T.nilable(Imagekit::Gps)) } attr_reader :gps - sig do - params( - gps: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps::OrHash - ).void - end + sig { params(gps: Imagekit::Gps::OrHash).void } attr_writer :gps # Object containing EXIF image information. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image - ) - ) - end + sig { returns(T.nilable(Imagekit::ExifImage)) } attr_reader :image - sig do - params( - image: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image::OrHash - ).void - end + sig { params(image: Imagekit::ExifImage::OrHash).void } attr_writer :image # JSON object. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability - ) - ) - end + sig { returns(T.nilable(Imagekit::Interoperability)) } attr_reader :interoperability sig do - params( - interoperability: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability::OrHash - ).void + params(interoperability: Imagekit::Interoperability::OrHash).void end attr_writer :interoperability @@ -907,36 +865,20 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - ) - ) - end + sig { returns(T.nilable(Imagekit::Thumbnail)) } attr_reader :thumbnail - sig do - params( - thumbnail: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash - ).void - end + sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } attr_writer :thumbnail sig do params( - exif: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif::OrHash, - gps: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps::OrHash, - image: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image::OrHash, - interoperability: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability::OrHash, + exif: Imagekit::ExifDetails::OrHash, + gps: Imagekit::Gps::OrHash, + image: Imagekit::ExifImage::OrHash, + interoperability: Imagekit::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash + thumbnail: Imagekit::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -957,560 +899,17 @@ module Imagekit sig do override.returns( { - exif: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - image: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - interoperability: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } ) end def to_hash end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns( - T.attached_class - ) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - - class Image < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params(interop_index: String, interop_version: String).returns( - T.attached_class - ) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns( - { interop_index: String, interop_version: String } - ) - end - def to_hash - end - end - - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end end end diff --git a/rbi/imagekit/models/files/metadata_get_from_url_response.rbi b/rbi/imagekit/models/files/metadata_get_from_url_response.rbi index 197185d4..3c451bd2 100644 --- a/rbi/imagekit/models/files/metadata_get_from_url_response.rbi +++ b/rbi/imagekit/models/files/metadata_get_from_url_response.rbi @@ -202,74 +202,32 @@ module Imagekit end # Object containing Exif details. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif - ) - ) - end + sig { returns(T.nilable(Imagekit::ExifDetails)) } attr_reader :exif - sig do - params( - exif: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif::OrHash - ).void - end + sig { params(exif: Imagekit::ExifDetails::OrHash).void } attr_writer :exif # Object containing GPS information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps - ) - ) - end + sig { returns(T.nilable(Imagekit::Gps)) } attr_reader :gps - sig do - params( - gps: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps::OrHash - ).void - end + sig { params(gps: Imagekit::Gps::OrHash).void } attr_writer :gps # Object containing EXIF image information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image - ) - ) - end + sig { returns(T.nilable(Imagekit::ExifImage)) } attr_reader :image - sig do - params( - image: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image::OrHash - ).void - end + sig { params(image: Imagekit::ExifImage::OrHash).void } attr_writer :image # JSON object. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability - ) - ) - end + sig { returns(T.nilable(Imagekit::Interoperability)) } attr_reader :interoperability sig do - params( - interoperability: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability::OrHash - ).void + params(interoperability: Imagekit::Interoperability::OrHash).void end attr_writer :interoperability @@ -280,36 +238,20 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - ) - ) - end + sig { returns(T.nilable(Imagekit::Thumbnail)) } attr_reader :thumbnail - sig do - params( - thumbnail: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail::OrHash - ).void - end + sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } attr_writer :thumbnail sig do params( - exif: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif::OrHash, - gps: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps::OrHash, - image: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image::OrHash, - interoperability: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability::OrHash, + exif: Imagekit::ExifDetails::OrHash, + gps: Imagekit::Gps::OrHash, + image: Imagekit::ExifImage::OrHash, + interoperability: Imagekit::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail::OrHash + thumbnail: Imagekit::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -330,561 +272,17 @@ module Imagekit sig do override.returns( { - exif: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - gps: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - image: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - interoperability: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } ) end def to_hash end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns( - T.attached_class - ) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - - class Image < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params(interop_index: String, interop_version: String).returns( - T.attached_class - ) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns( - { interop_index: String, interop_version: String } - ) - end - def to_hash - end - end - - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end end end end diff --git a/rbi/imagekit/models/files/metadata_get_response.rbi b/rbi/imagekit/models/files/metadata_get_response.rbi index a1d5cf55..3815259b 100644 --- a/rbi/imagekit/models/files/metadata_get_response.rbi +++ b/rbi/imagekit/models/files/metadata_get_response.rbi @@ -198,72 +198,32 @@ module Imagekit end # Object containing Exif details. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif - ) - ) - end + sig { returns(T.nilable(Imagekit::ExifDetails)) } attr_reader :exif - sig do - params( - exif: - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif::OrHash - ).void - end + sig { params(exif: Imagekit::ExifDetails::OrHash).void } attr_writer :exif # Object containing GPS information. - sig do - returns( - T.nilable(Imagekit::Models::Files::MetadataGetResponse::Exif::Gps) - ) - end + sig { returns(T.nilable(Imagekit::Gps)) } attr_reader :gps - sig do - params( - gps: - Imagekit::Models::Files::MetadataGetResponse::Exif::Gps::OrHash - ).void - end + sig { params(gps: Imagekit::Gps::OrHash).void } attr_writer :gps # Object containing EXIF image information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetResponse::Exif::Image - ) - ) - end + sig { returns(T.nilable(Imagekit::ExifImage)) } attr_reader :image - sig do - params( - image: - Imagekit::Models::Files::MetadataGetResponse::Exif::Image::OrHash - ).void - end + sig { params(image: Imagekit::ExifImage::OrHash).void } attr_writer :image # JSON object. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability - ) - ) - end + sig { returns(T.nilable(Imagekit::Interoperability)) } attr_reader :interoperability sig do - params( - interoperability: - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability::OrHash - ).void + params(interoperability: Imagekit::Interoperability::OrHash).void end attr_writer :interoperability @@ -274,36 +234,20 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - ) - ) - end + sig { returns(T.nilable(Imagekit::Thumbnail)) } attr_reader :thumbnail - sig do - params( - thumbnail: - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail::OrHash - ).void - end + sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } attr_writer :thumbnail sig do params( - exif: - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif::OrHash, - gps: - Imagekit::Models::Files::MetadataGetResponse::Exif::Gps::OrHash, - image: - Imagekit::Models::Files::MetadataGetResponse::Exif::Image::OrHash, - interoperability: - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability::OrHash, + exif: Imagekit::ExifDetails::OrHash, + gps: Imagekit::Gps::OrHash, + image: Imagekit::ExifImage::OrHash, + interoperability: Imagekit::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail::OrHash + thumbnail: Imagekit::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -324,559 +268,17 @@ module Imagekit sig do override.returns( { - exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - image: - Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - interoperability: - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } ) end def to_hash end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns( - T.attached_class - ) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - - class Image < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params(interop_index: String, interop_version: String).returns( - T.attached_class - ) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns( - { interop_index: String, interop_version: String } - ) - end - def to_hash - end - end - - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end end end end diff --git a/rbi/imagekit/models/gps.rbi b/rbi/imagekit/models/gps.rbi new file mode 100644 index 00000000..57931ca6 --- /dev/null +++ b/rbi/imagekit/models/gps.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekit + module Models + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Imagekit::Gps, Imagekit::Internal::AnyHash) } + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns(T.attached_class) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/interoperability.rbi b/rbi/imagekit/models/interoperability.rbi new file mode 100644 index 00000000..69123b0b --- /dev/null +++ b/rbi/imagekit/models/interoperability.rbi @@ -0,0 +1,39 @@ +# typed: strong + +module Imagekit + module Models + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Interoperability, Imagekit::Internal::AnyHash) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns({ interop_index: String, interop_version: String }) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/thumbnail.rbi b/rbi/imagekit/models/thumbnail.rbi new file mode 100644 index 00000000..e35978ae --- /dev/null +++ b/rbi/imagekit/models/thumbnail.rbi @@ -0,0 +1,82 @@ +# typed: strong + +module Imagekit + module Models + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Imagekit::Thumbnail, Imagekit::Internal::AnyHash) } + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end +end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 124cbd93..5d21c6e2 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -15,6 +15,10 @@ module Imagekit class CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + class ExifDetails = Imagekit::Models::ExifDetails + + class ExifImage = Imagekit::Models::ExifImage + class FileCopyParams = Imagekit::Models::FileCopyParams class FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -42,4 +46,10 @@ module Imagekit class FolderRenameParams = Imagekit::Models::FolderRenameParams module Folders = Imagekit::Models::Folders + + class Gps = Imagekit::Models::Gps + + class Interoperability = Imagekit::Models::Interoperability + + class Thumbnail = Imagekit::Models::Thumbnail end diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs index 0e30b971..a7a050e8 100644 --- a/sig/imagekit/models/beta/v2/file_upload_response.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_response.rbs @@ -386,438 +386,58 @@ module Imagekit type exif = { - exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif? + attr_reader exif: Imagekit::ExifDetails? - def exif=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif + def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails - attr_reader gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps? + attr_reader gps: Imagekit::Gps? - def gps=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps + def gps=: (Imagekit::Gps) -> Imagekit::Gps - attr_reader image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image? + attr_reader image: Imagekit::ExifImage? - def image=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image + def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage - attr_reader interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability? + attr_reader interoperability: Imagekit::Interoperability? def interoperability=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability + Imagekit::Interoperability + ) -> Imagekit::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail? + attr_reader thumbnail: Imagekit::Thumbnail? - def thumbnail=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail def initialize: ( - ?exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - ?gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - ?image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - ?interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + ?exif: Imagekit::ExifDetails, + ?gps: Imagekit::Gps, + ?image: Imagekit::ExifImage, + ?interoperability: Imagekit::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + ?thumbnail: Imagekit::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } - - type exif = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - - type image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class Image < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - - type interoperability = - { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: ( - ?interop_index: String, - ?interop_version: String - ) -> void - - def to_hash: -> { - interop_index: String, - interop_version: String - } - end - - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end end end diff --git a/sig/imagekit/models/exif_details.rbs b/sig/imagekit/models/exif_details.rbs new file mode 100644 index 00000000..76edd041 --- /dev/null +++ b/sig/imagekit/models/exif_details.rbs @@ -0,0 +1,197 @@ +module Imagekit + module Models + type exif_details = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class ExifDetails < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + end +end diff --git a/sig/imagekit/models/exif_image.rbs b/sig/imagekit/models/exif_image.rbs new file mode 100644 index 00000000..684ef926 --- /dev/null +++ b/sig/imagekit/models/exif_image.rbs @@ -0,0 +1,92 @@ +module Imagekit + module Models + type exif_image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class ExifImage < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + end +end diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs index 7f8e58d4..9d394c87 100644 --- a/sig/imagekit/models/file_upload_response.rbs +++ b/sig/imagekit/models/file_upload_response.rbs @@ -384,435 +384,58 @@ module Imagekit type exif = { - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif? + attr_reader exif: Imagekit::ExifDetails? - def exif=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif + def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails - attr_reader gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps? + attr_reader gps: Imagekit::Gps? - def gps=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps + def gps=: (Imagekit::Gps) -> Imagekit::Gps - attr_reader image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image? + attr_reader image: Imagekit::ExifImage? - def image=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Image + def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage - attr_reader interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability? + attr_reader interoperability: Imagekit::Interoperability? def interoperability=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability + Imagekit::Interoperability + ) -> Imagekit::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail? + attr_reader thumbnail: Imagekit::Thumbnail? - def thumbnail=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail def initialize: ( - ?exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - ?gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - ?image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - ?interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + ?exif: Imagekit::ExifDetails, + ?gps: Imagekit::Gps, + ?image: Imagekit::ExifImage, + ?interoperability: Imagekit::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + ?thumbnail: Imagekit::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } - - type exif = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - - type image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class Image < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - - type interoperability = - { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: ( - ?interop_index: String, - ?interop_version: String - ) -> void - - def to_hash: -> { interop_index: String, interop_version: String } - end - - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end end end diff --git a/sig/imagekit/models/files/metadata_get_from_url_response.rbs b/sig/imagekit/models/files/metadata_get_from_url_response.rbs index 0befaf28..72aff42f 100644 --- a/sig/imagekit/models/files/metadata_get_from_url_response.rbs +++ b/sig/imagekit/models/files/metadata_get_from_url_response.rbs @@ -114,435 +114,58 @@ module Imagekit type exif = { - exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif? + attr_reader exif: Imagekit::ExifDetails? - def exif=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif + def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails - attr_reader gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps? + attr_reader gps: Imagekit::Gps? - def gps=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps + def gps=: (Imagekit::Gps) -> Imagekit::Gps - attr_reader image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image? + attr_reader image: Imagekit::ExifImage? - def image=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image + def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage - attr_reader interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability? + attr_reader interoperability: Imagekit::Interoperability? def interoperability=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability + Imagekit::Interoperability + ) -> Imagekit::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail? + attr_reader thumbnail: Imagekit::Thumbnail? - def thumbnail=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail def initialize: ( - ?exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - ?gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - ?image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - ?interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + ?exif: Imagekit::ExifDetails, + ?gps: Imagekit::Gps, + ?image: Imagekit::ExifImage, + ?interoperability: Imagekit::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + ?thumbnail: Imagekit::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } - - type exif = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - - type image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class Image < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - - type interoperability = - { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: ( - ?interop_index: String, - ?interop_version: String - ) -> void - - def to_hash: -> { interop_index: String, interop_version: String } - end - - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end end end end diff --git a/sig/imagekit/models/files/metadata_get_response.rbs b/sig/imagekit/models/files/metadata_get_response.rbs index 749a3cad..94cb2a3f 100644 --- a/sig/imagekit/models/files/metadata_get_response.rbs +++ b/sig/imagekit/models/files/metadata_get_response.rbs @@ -114,435 +114,58 @@ module Imagekit type exif = { - exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif? + attr_reader exif: Imagekit::ExifDetails? - def exif=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Exif + def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails - attr_reader gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps? + attr_reader gps: Imagekit::Gps? - def gps=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Gps - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Gps + def gps=: (Imagekit::Gps) -> Imagekit::Gps - attr_reader image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image? + attr_reader image: Imagekit::ExifImage? - def image=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Image - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Image + def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage - attr_reader interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability? + attr_reader interoperability: Imagekit::Interoperability? def interoperability=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability + Imagekit::Interoperability + ) -> Imagekit::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail? + attr_reader thumbnail: Imagekit::Thumbnail? - def thumbnail=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail def initialize: ( - ?exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - ?gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - ?image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - ?interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + ?exif: Imagekit::ExifDetails, + ?gps: Imagekit::Gps, + ?image: Imagekit::ExifImage, + ?interoperability: Imagekit::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + ?thumbnail: Imagekit::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + exif: Imagekit::ExifDetails, + gps: Imagekit::Gps, + image: Imagekit::ExifImage, + interoperability: Imagekit::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + thumbnail: Imagekit::Thumbnail } - - type exif = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - - type image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class Image < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - - type interoperability = - { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: ( - ?interop_index: String, - ?interop_version: String - ) -> void - - def to_hash: -> { interop_index: String, interop_version: String } - end - - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end end end end diff --git a/sig/imagekit/models/gps.rbs b/sig/imagekit/models/gps.rbs new file mode 100644 index 00000000..d11c6a06 --- /dev/null +++ b/sig/imagekit/models/gps.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + end +end diff --git a/sig/imagekit/models/interoperability.rbs b/sig/imagekit/models/interoperability.rbs new file mode 100644 index 00000000..f653174a --- /dev/null +++ b/sig/imagekit/models/interoperability.rbs @@ -0,0 +1,19 @@ +module Imagekit + module Models + type interoperability = { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: (?interop_index: String, ?interop_version: String) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + end +end diff --git a/sig/imagekit/models/thumbnail.rbs b/sig/imagekit/models/thumbnail.rbs new file mode 100644 index 00000000..0fcbb367 --- /dev/null +++ b/sig/imagekit/models/thumbnail.rbs @@ -0,0 +1,57 @@ +module Imagekit + module Models + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end + end +end diff --git a/test/imagekit/resources/shared_test.rb b/test/imagekit/resources/shared_test.rb new file mode 100644 index 00000000..be22f0e4 --- /dev/null +++ b/test/imagekit/resources/shared_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::SharedTest < Imagekit::Test::ResourceTest +end From 6ead6835229666f6395be22246cbfdf738c45db4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 17 Aug 2025 06:54:22 +0000 Subject: [PATCH 005/178] feat(api): manual updates --- .stats.yml | 6 +- lib/imagekit.rb | 3 + lib/imagekit/internal/type/base_model.rb | 8 +- lib/imagekit/models.rb | 6 + lib/imagekit/models/asset_list_response.rb | 8 +- .../models/auto_description_extension.rb | 28 ++ lib/imagekit/models/auto_tagging_extension.rb | 45 +++ .../models/beta/v2/file_upload_params.rb | 162 +------- .../models/beta/v2/file_upload_response.rb | 8 +- .../custom_metadata_field_delete_response.rb | 6 +- lib/imagekit/models/file_copy_response.rb | 6 +- lib/imagekit/models/file_get_response.rb | 8 +- lib/imagekit/models/file_move_response.rb | 6 +- lib/imagekit/models/file_update_params.rb | 158 +------- lib/imagekit/models/file_update_response.rb | 8 +- lib/imagekit/models/file_upload_params.rb | 150 +------ lib/imagekit/models/file_upload_response.rb | 8 +- .../models/files/version_delete_response.rb | 6 +- .../models/files/version_get_response.rb | 8 +- .../models/files/version_list_response.rb | 8 +- .../models/files/version_restore_response.rb | 8 +- lib/imagekit/models/folder_create_response.rb | 6 +- lib/imagekit/models/folder_delete_response.rb | 6 +- lib/imagekit/models/removedot_bg_extension.rb | 79 ++++ lib/imagekit/resources/beta/v2/files.rb | 2 +- .../resources/custom_metadata_fields.rb | 4 +- lib/imagekit/resources/files.rb | 14 +- lib/imagekit/resources/files/versions.rb | 4 +- lib/imagekit/resources/folders.rb | 8 +- rbi/imagekit/models.rbi | 6 + rbi/imagekit/models/asset_list_response.rbi | 8 +- .../models/auto_description_extension.rbi | 60 +++ .../models/auto_tagging_extension.rbi | 81 ++++ .../models/beta/v2/file_upload_params.rbi | 367 +---------------- .../models/beta/v2/file_upload_response.rbi | 8 +- .../custom_metadata_field_delete_response.rbi | 19 +- rbi/imagekit/models/file_copy_response.rbi | 15 +- rbi/imagekit/models/file_get_response.rbi | 8 +- rbi/imagekit/models/file_move_response.rbi | 15 +- rbi/imagekit/models/file_update_params.rbi | 375 +----------------- rbi/imagekit/models/file_update_response.rbi | 8 +- rbi/imagekit/models/file_upload_params.rbi | 367 +---------------- rbi/imagekit/models/file_upload_response.rbi | 8 +- .../models/files/version_delete_response.rbi | 19 +- .../models/files/version_get_response.rbi | 8 +- .../models/files/version_list_response.rbi | 8 +- .../models/files/version_restore_response.rbi | 8 +- .../models/folder_create_response.rbi | 19 +- .../models/folder_delete_response.rbi | 19 +- .../models/removedot_bg_extension.rbi | 152 +++++++ rbi/imagekit/resources/beta/v2/files.rbi | 6 +- .../resources/custom_metadata_fields.rbi | 2 +- rbi/imagekit/resources/files.rbi | 18 +- rbi/imagekit/resources/files/versions.rbi | 2 +- rbi/imagekit/resources/folders.rbi | 4 +- sig/imagekit/models.rbs | 6 + sig/imagekit/models/asset_list_response.rbs | 10 +- .../models/auto_description_extension.rbs | 28 ++ .../models/auto_tagging_extension.rbs | 41 ++ .../models/beta/v2/file_upload_params.rbs | 147 +------ .../models/beta/v2/file_upload_response.rbs | 10 +- .../custom_metadata_field_delete_response.rbs | 8 +- sig/imagekit/models/file_copy_response.rbs | 8 +- sig/imagekit/models/file_get_response.rbs | 10 +- sig/imagekit/models/file_move_response.rbs | 8 +- sig/imagekit/models/file_update_params.rbs | 157 +------- sig/imagekit/models/file_update_response.rbs | 10 +- sig/imagekit/models/file_upload_params.rbs | 147 +------ sig/imagekit/models/file_upload_response.rbs | 10 +- .../models/files/version_delete_response.rbs | 8 +- .../models/files/version_get_response.rbs | 10 +- .../models/files/version_list_response.rbs | 10 +- .../models/files/version_restore_response.rbs | 10 +- .../models/folder_create_response.rbs | 8 +- .../models/folder_delete_response.rbs | 8 +- .../models/removedot_bg_extension.rbs | 79 ++++ .../resources/custom_metadata_fields.rbs | 5 +- sig/imagekit/resources/files.rbs | 6 +- sig/imagekit/resources/files/versions.rbs | 2 +- sig/imagekit/resources/folders.rbs | 4 +- test/imagekit/resources/beta/v2/files_test.rb | 2 +- .../resources/custom_metadata_fields_test.rb | 8 +- .../imagekit/resources/files/versions_test.rb | 12 +- test/imagekit/resources/files_test.rb | 22 +- test/imagekit/resources/folders_test.rb | 16 +- 85 files changed, 1070 insertions(+), 2127 deletions(-) create mode 100644 lib/imagekit/models/auto_description_extension.rb create mode 100644 lib/imagekit/models/auto_tagging_extension.rb create mode 100644 lib/imagekit/models/removedot_bg_extension.rb create mode 100644 rbi/imagekit/models/auto_description_extension.rbi create mode 100644 rbi/imagekit/models/auto_tagging_extension.rbi create mode 100644 rbi/imagekit/models/removedot_bg_extension.rbi create mode 100644 sig/imagekit/models/auto_description_extension.rbs create mode 100644 sig/imagekit/models/auto_tagging_extension.rbs create mode 100644 sig/imagekit/models/removedot_bg_extension.rbs diff --git a/.stats.yml b/.stats.yml index d25e9ed9..456c477f 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-c01164d5dc8f8c9ab2b7c1a1c793ac522d565f96e569b0e56a4e9353e39bab85.yml -openapi_spec_hash: ac7b3a2b968fe86bf7bb81192209123f -config_hash: 963efe3c7e328464ca83ae352b29bbb4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-584c2ccf3fc1a3ff3abf26b8d3dace2398d0f9ed6f20e4c411a13a81febb5e98.yml +openapi_spec_hash: 14d1614ea3903d6b53f26e135c9cae81 +config_hash: 7e5c039f375ccdba7cf3e61492a273f2 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 1676573f..3f294bd7 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -72,6 +72,8 @@ require_relative "imagekit/models/accounts/usage_get_response" require_relative "imagekit/models/asset_list_params" require_relative "imagekit/models/asset_list_response" +require_relative "imagekit/models/auto_description_extension" +require_relative "imagekit/models/auto_tagging_extension" require_relative "imagekit/models/beta/v2/file_upload_params" require_relative "imagekit/models/beta/v2/file_upload_response" require_relative "imagekit/models/cache/invalidation_create_params" @@ -135,6 +137,7 @@ require_relative "imagekit/models/folders/job_get_response" require_relative "imagekit/models/gps" require_relative "imagekit/models/interoperability" +require_relative "imagekit/models/removedot_bg_extension" require_relative "imagekit/models/thumbnail" require_relative "imagekit/models" require_relative "imagekit/resources/accounts" diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb index be589511..3fda468e 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekit/internal/type/base_model.rb @@ -445,11 +445,9 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `exif_details` is a `Imagekit::ExifDetails` - # exif_details => { - # aperture_value: aperture_value, - # color_space: color_space, - # create_date: create_date + # # `auto_description_extension` is a `Imagekit::AutoDescriptionExtension` + # auto_description_extension => { + # name: name # } def deconstruct_keys(keys) (keys || self.class.known_fields.keys) diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 24871353..de31b9c5 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -43,6 +43,10 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams + AutoDescriptionExtension = Imagekit::Models::AutoDescriptionExtension + + AutoTaggingExtension = Imagekit::Models::AutoTaggingExtension + Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache @@ -91,5 +95,7 @@ module Imagekit Interoperability = Imagekit::Models::Interoperability + RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension + Thumbnail = Imagekit::Models::Thumbnail end diff --git a/lib/imagekit/models/asset_list_response.rb b/lib/imagekit/models/asset_list_response.rb index e7b39c4e..65d80bea 100644 --- a/lib/imagekit/models/asset_list_response.rb +++ b/lib/imagekit/models/asset_list_response.rb @@ -37,8 +37,10 @@ class FileDetails < Imagekit::Internal::Type::BaseModel # @!attribute custom_metadata # An object with custom metadata for the file. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute file_id # Unique identifier of the asset. @@ -162,7 +164,7 @@ class FileDetails < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # - # @param custom_metadata [Object] An object with custom metadata for the file. + # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. # # @param file_id [String] Unique identifier of the asset. # diff --git a/lib/imagekit/models/auto_description_extension.rb b/lib/imagekit/models/auto_description_extension.rb new file mode 100644 index 00000000..fe58f796 --- /dev/null +++ b/lib/imagekit/models/auto_description_extension.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, Imagekit::Models::AutoDescriptionExtension::Name] + required :name, enum: -> { Imagekit::AutoDescriptionExtension::Name } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. + # + # @see Imagekit::Models::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION = :"ai-auto-description" + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/auto_tagging_extension.rb b/lib/imagekit/models/auto_tagging_extension.rb new file mode 100644 index 00000000..284984f7 --- /dev/null +++ b/lib/imagekit/models/auto_tagging_extension.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekit::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index e3d87a97..89c24d8e 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -87,7 +87,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the image. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Extension] @@ -227,7 +227,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -258,164 +258,14 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension } - - variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension } - - variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name] - required :name, - enum: -> { - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name - } - - # @!attribute options - # - # @return [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options, nil] - optional :options, - -> { - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - } - - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. - # - # @param options [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options] - - # Specifies the background removal extension. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options} - # for more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end + variant -> { Imagekit::RemovedotBgExtension } - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name] - required :name, - enum: -> { - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name - } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end + variant -> { Imagekit::AutoTaggingExtension } - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. - # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name] - required :name, - enum: -> { - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name - } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. - - # Specifies the auto description extension. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION = :"ai-auto-description" - - # @!method self.values - # @return [Array] - end - end + variant -> { Imagekit::AutoDescriptionExtension } # @!method self.variants - # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::RemovedotBgExtension, Imagekit::Models::AutoTaggingExtension, Imagekit::Models::AutoDescriptionExtension)] end module ResponseField diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekit/models/beta/v2/file_upload_response.rb index 09df962b..66d5b5ed 100644 --- a/lib/imagekit/models/beta/v2/file_upload_response.rb +++ b/lib/imagekit/models/beta/v2/file_upload_response.rb @@ -43,8 +43,10 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # API. Send `customMetadata` in `responseFields` in API request to get the value # of this field. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute duration # The duration of the video in seconds (only for video). @@ -193,7 +195,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h # - # @param custom_metadata [Object] A key-value data associated with the asset. Use `responseField` in API request t + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data associated with the asset. Use `responseField` in API request t # # @param duration [Integer] The duration of the video in seconds (only for video). # diff --git a/lib/imagekit/models/custom_metadata_field_delete_response.rb b/lib/imagekit/models/custom_metadata_field_delete_response.rb index 2ac7ffbe..ec5f93b1 100644 --- a/lib/imagekit/models/custom_metadata_field_delete_response.rb +++ b/lib/imagekit/models/custom_metadata_field_delete_response.rb @@ -2,7 +2,9 @@ module Imagekit module Models - # @type [Imagekit::Internal::Type::Converter] - CustomMetadataFieldDeleteResponse = Imagekit::Internal::Type::Unknown + # @see Imagekit::Resources::CustomMetadataFields#delete + class CustomMetadataFieldDeleteResponse < Imagekit::Internal::Type::BaseModel + # @!method initialize + end end end diff --git a/lib/imagekit/models/file_copy_response.rb b/lib/imagekit/models/file_copy_response.rb index 671bd8a6..b783f78a 100644 --- a/lib/imagekit/models/file_copy_response.rb +++ b/lib/imagekit/models/file_copy_response.rb @@ -2,7 +2,9 @@ module Imagekit module Models - # @type [Imagekit::Internal::Type::Converter] - FileCopyResponse = Imagekit::Internal::Type::Unknown + # @see Imagekit::Resources::Files#copy + class FileCopyResponse < Imagekit::Internal::Type::BaseModel + # @!method initialize + end end end diff --git a/lib/imagekit/models/file_get_response.rb b/lib/imagekit/models/file_get_response.rb index 66cca3b6..ac825f59 100644 --- a/lib/imagekit/models/file_get_response.rb +++ b/lib/imagekit/models/file_get_response.rb @@ -29,8 +29,10 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute custom_metadata # An object with custom metadata for the file. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute file_id # Unique identifier of the asset. @@ -152,7 +154,7 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # - # @param custom_metadata [Object] An object with custom metadata for the file. + # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. # # @param file_id [String] Unique identifier of the asset. # diff --git a/lib/imagekit/models/file_move_response.rb b/lib/imagekit/models/file_move_response.rb index d854a7e0..69bb18b1 100644 --- a/lib/imagekit/models/file_move_response.rb +++ b/lib/imagekit/models/file_move_response.rb @@ -2,7 +2,9 @@ module Imagekit module Models - # @type [Imagekit::Internal::Type::Converter] - FileMoveResponse = Imagekit::Internal::Type::Unknown + # @see Imagekit::Resources::Files#move + class FileMoveResponse < Imagekit::Internal::Type::BaseModel + # @!method initialize + end end end diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index f165a717..3da532f3 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -19,8 +19,10 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # value for that key. Before setting any custom metadata on an asset you have to # create the field using custom metadata fields API. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute description # Optional text to describe the contents of the file. @@ -32,7 +34,7 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Extension] } @@ -81,11 +83,11 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, # - # @param custom_metadata [Object] A key-value data to be associated with the asset. To unset a key, send `null` va + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car # @@ -100,152 +102,14 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension } + variant -> { Imagekit::RemovedotBgExtension } - variant -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension } + variant -> { Imagekit::AutoTaggingExtension } - variant -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name } - - # @!attribute options - # - # @return [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options, nil] - optional :options, -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options } - - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. - # - # @param options [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options] - - # Specifies the background removal extension. - # - # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options} - # for more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. - # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. - - # Specifies the auto description extension. - # - # @see Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION = :"ai-auto-description" - - # @!method self.values - # @return [Array] - end - end + variant -> { Imagekit::AutoDescriptionExtension } # @!method self.variants - # @return [Array(Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::RemovedotBgExtension, Imagekit::Models::AutoTaggingExtension, Imagekit::Models::AutoDescriptionExtension)] end # An array of AITags associated with the file that you want to remove, e.g. diff --git a/lib/imagekit/models/file_update_response.rb b/lib/imagekit/models/file_update_response.rb index d38d47d7..9153a95f 100644 --- a/lib/imagekit/models/file_update_response.rb +++ b/lib/imagekit/models/file_update_response.rb @@ -29,8 +29,10 @@ class FileUpdateResponse < Imagekit::Internal::Type::BaseModel # @!attribute custom_metadata # An object with custom metadata for the file. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute extension_status # @@ -157,7 +159,7 @@ class FileUpdateResponse < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # - # @param custom_metadata [Object] An object with custom metadata for the file. + # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. # # @param extension_status [Imagekit::Models::FileUpdateResponse::ExtensionStatus] # diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index e6a25494..2d57e451 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -94,7 +94,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the image. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Extension] } @@ -256,7 +256,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -291,152 +291,14 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension } + variant -> { Imagekit::RemovedotBgExtension } - variant -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension } + variant -> { Imagekit::AutoTaggingExtension } - variant -> { Imagekit::FileUploadParams::Extension::AutoDescriptionExtension } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Name] - required :name, enum: -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name } - - # @!attribute options - # - # @return [Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options, nil] - optional :options, -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options } - - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. - # - # @param options [Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options] - - # Specifies the background removal extension. - # - # @see Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options} - # for more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::Name] - required :name, enum: -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. - # - # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::Name] - required :name, enum: -> { Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. - - # Specifies the auto description extension. - # - # @see Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION = :"ai-auto-description" - - # @!method self.values - # @return [Array] - end - end + variant -> { Imagekit::AutoDescriptionExtension } # @!method self.variants - # @return [Array(Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::RemovedotBgExtension, Imagekit::Models::AutoTaggingExtension, Imagekit::Models::AutoDescriptionExtension)] end module ResponseField diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekit/models/file_upload_response.rb index 2d00923e..82b66760 100644 --- a/lib/imagekit/models/file_upload_response.rb +++ b/lib/imagekit/models/file_upload_response.rb @@ -41,8 +41,10 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # API. Send `customMetadata` in `responseFields` in API request to get the value # of this field. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute duration # The duration of the video in seconds (only for video). @@ -189,7 +191,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h # - # @param custom_metadata [Object] A key-value data associated with the asset. Use `responseField` in API request t + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data associated with the asset. Use `responseField` in API request t # # @param duration [Integer] The duration of the video in seconds (only for video). # diff --git a/lib/imagekit/models/files/version_delete_response.rb b/lib/imagekit/models/files/version_delete_response.rb index ec0283ba..7f044266 100644 --- a/lib/imagekit/models/files/version_delete_response.rb +++ b/lib/imagekit/models/files/version_delete_response.rb @@ -3,8 +3,10 @@ module Imagekit module Models module Files - # @type [Imagekit::Internal::Type::Converter] - VersionDeleteResponse = Imagekit::Internal::Type::Unknown + # @see Imagekit::Resources::Files::Versions#delete + class VersionDeleteResponse < Imagekit::Internal::Type::BaseModel + # @!method initialize + end end end end diff --git a/lib/imagekit/models/files/version_get_response.rb b/lib/imagekit/models/files/version_get_response.rb index c49897e4..5c8c3f49 100644 --- a/lib/imagekit/models/files/version_get_response.rb +++ b/lib/imagekit/models/files/version_get_response.rb @@ -30,8 +30,10 @@ class VersionGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute custom_metadata # An object with custom metadata for the file. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute file_id # Unique identifier of the asset. @@ -155,7 +157,7 @@ class VersionGetResponse < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # - # @param custom_metadata [Object] An object with custom metadata for the file. + # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. # # @param file_id [String] Unique identifier of the asset. # diff --git a/lib/imagekit/models/files/version_list_response.rb b/lib/imagekit/models/files/version_list_response.rb index e7afad53..451397bf 100644 --- a/lib/imagekit/models/files/version_list_response.rb +++ b/lib/imagekit/models/files/version_list_response.rb @@ -29,8 +29,10 @@ class VersionListResponseItem < Imagekit::Internal::Type::BaseModel # @!attribute custom_metadata # An object with custom metadata for the file. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute file_id # Unique identifier of the asset. @@ -154,7 +156,7 @@ class VersionListResponseItem < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # - # @param custom_metadata [Object] An object with custom metadata for the file. + # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. # # @param file_id [String] Unique identifier of the asset. # diff --git a/lib/imagekit/models/files/version_restore_response.rb b/lib/imagekit/models/files/version_restore_response.rb index 641285ea..e5880bd8 100644 --- a/lib/imagekit/models/files/version_restore_response.rb +++ b/lib/imagekit/models/files/version_restore_response.rb @@ -30,8 +30,10 @@ class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel # @!attribute custom_metadata # An object with custom metadata for the file. # - # @return [Object, nil] - optional :custom_metadata, Imagekit::Internal::Type::Unknown, api_name: :customMetadata + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata # @!attribute file_id # Unique identifier of the asset. @@ -155,7 +157,7 @@ class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # - # @param custom_metadata [Object] An object with custom metadata for the file. + # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. # # @param file_id [String] Unique identifier of the asset. # diff --git a/lib/imagekit/models/folder_create_response.rb b/lib/imagekit/models/folder_create_response.rb index 9e305c04..6dab708e 100644 --- a/lib/imagekit/models/folder_create_response.rb +++ b/lib/imagekit/models/folder_create_response.rb @@ -2,7 +2,9 @@ module Imagekit module Models - # @type [Imagekit::Internal::Type::Converter] - FolderCreateResponse = Imagekit::Internal::Type::Unknown + # @see Imagekit::Resources::Folders#create + class FolderCreateResponse < Imagekit::Internal::Type::BaseModel + # @!method initialize + end end end diff --git a/lib/imagekit/models/folder_delete_response.rb b/lib/imagekit/models/folder_delete_response.rb index 7bd5838b..c92e4aa9 100644 --- a/lib/imagekit/models/folder_delete_response.rb +++ b/lib/imagekit/models/folder_delete_response.rb @@ -2,7 +2,9 @@ module Imagekit module Models - # @type [Imagekit::Internal::Type::Converter] - FolderDeleteResponse = Imagekit::Internal::Type::Unknown + # @see Imagekit::Resources::Folders#delete + class FolderDeleteResponse < Imagekit::Internal::Type::BaseModel + # @!method initialize + end end end diff --git a/lib/imagekit/models/removedot_bg_extension.rb b/lib/imagekit/models/removedot_bg_extension.rb new file mode 100644 index 00000000..6b0dbfd1 --- /dev/null +++ b/lib/imagekit/models/removedot_bg_extension.rb @@ -0,0 +1,79 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::RemovedotBgExtension::Name] + required :name, enum: -> { Imagekit::RemovedotBgExtension::Name } + + # @!attribute options + # + # @return [Imagekit::Models::RemovedotBgExtension::Options, nil] + optional :options, -> { Imagekit::RemovedotBgExtension::Options } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::RemovedotBgExtension::Options} for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + end +end diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekit/resources/beta/v2/files.rb index 03370c95..cd7b8e6a 100644 --- a/lib/imagekit/resources/beta/v2/files.rb +++ b/lib/imagekit/resources/beta/v2/files.rb @@ -52,7 +52,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekit/resources/custom_metadata_fields.rb b/lib/imagekit/resources/custom_metadata_fields.rb index cec7db76..1a961c67 100644 --- a/lib/imagekit/resources/custom_metadata_fields.rb +++ b/lib/imagekit/resources/custom_metadata_fields.rb @@ -103,14 +103,14 @@ def list(params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Object] + # @return [Imagekit::Models::CustomMetadataFieldDeleteResponse] # # @see Imagekit::Models::CustomMetadataFieldDeleteParams def delete(id, params = {}) @client.request( method: :delete, path: ["v1/customMetadataFields/%1$s", id], - model: Imagekit::Internal::Type::Unknown, + model: Imagekit::Models::CustomMetadataFieldDeleteResponse, options: params[:request_options] ) end diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 2841eabd..9dbeff89 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -25,11 +25,11 @@ class Files # # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, # - # @param custom_metadata [Object] A key-value data to be associated with the asset. To unset a key, send `null` va + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car # @@ -101,7 +101,7 @@ def delete(file_id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Object] + # @return [Imagekit::Models::FileCopyResponse] # # @see Imagekit::Models::FileCopyParams def copy(params) @@ -110,7 +110,7 @@ def copy(params) method: :post, path: "v1/files/copy", body: parsed, - model: Imagekit::Internal::Type::Unknown, + model: Imagekit::Models::FileCopyResponse, options: options ) end @@ -155,7 +155,7 @@ def get(file_id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Object] + # @return [Imagekit::Models::FileMoveResponse] # # @see Imagekit::Models::FileMoveParams def move(params) @@ -164,7 +164,7 @@ def move(params) method: :post, path: "v1/files/move", body: parsed, - model: Imagekit::Internal::Type::Unknown, + model: Imagekit::Models::FileMoveResponse, options: options ) end @@ -251,7 +251,7 @@ def rename(params) # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekit/resources/files/versions.rb b/lib/imagekit/resources/files/versions.rb index 31d7f743..9c5363d5 100644 --- a/lib/imagekit/resources/files/versions.rb +++ b/lib/imagekit/resources/files/versions.rb @@ -43,7 +43,7 @@ def list(file_id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Object] + # @return [Imagekit::Models::Files::VersionDeleteResponse] # # @see Imagekit::Models::Files::VersionDeleteParams def delete(version_id, params) @@ -55,7 +55,7 @@ def delete(version_id, params) @client.request( method: :delete, path: ["v1/files/%1$s/versions/%2$s", file_id, version_id], - model: Imagekit::Internal::Type::Unknown, + model: Imagekit::Models::Files::VersionDeleteResponse, options: options ) end diff --git a/lib/imagekit/resources/folders.rb b/lib/imagekit/resources/folders.rb index 1fd9304b..ad5e4b10 100644 --- a/lib/imagekit/resources/folders.rb +++ b/lib/imagekit/resources/folders.rb @@ -20,7 +20,7 @@ class Folders # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Object] + # @return [Imagekit::Models::FolderCreateResponse] # # @see Imagekit::Models::FolderCreateParams def create(params) @@ -29,7 +29,7 @@ def create(params) method: :post, path: "v1/folder", body: parsed, - model: Imagekit::Internal::Type::Unknown, + model: Imagekit::Models::FolderCreateResponse, options: options ) end @@ -46,7 +46,7 @@ def create(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Object] + # @return [Imagekit::Models::FolderDeleteResponse] # # @see Imagekit::Models::FolderDeleteParams def delete(params) @@ -55,7 +55,7 @@ def delete(params) method: :delete, path: "v1/folder", body: parsed, - model: Imagekit::Internal::Type::Unknown, + model: Imagekit::Models::FolderDeleteResponse, options: options ) end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index a514e6d7..17732f16 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -5,6 +5,10 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams + AutoDescriptionExtension = Imagekit::Models::AutoDescriptionExtension + + AutoTaggingExtension = Imagekit::Models::AutoTaggingExtension + Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache @@ -57,5 +61,7 @@ module Imagekit Interoperability = Imagekit::Models::Interoperability + RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension + Thumbnail = Imagekit::Models::Thumbnail end diff --git a/rbi/imagekit/models/asset_list_response.rbi b/rbi/imagekit/models/asset_list_response.rbi index ed74b8d4..fea9a9a8 100644 --- a/rbi/imagekit/models/asset_list_response.rbi +++ b/rbi/imagekit/models/asset_list_response.rbi @@ -48,10 +48,10 @@ module Imagekit attr_accessor :custom_coordinates # An object with custom metadata for the file. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata # Unique identifier of the asset. @@ -198,7 +198,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, @@ -283,7 +283,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, diff --git a/rbi/imagekit/models/auto_description_extension.rbi b/rbi/imagekit/models/auto_description_extension.rbi new file mode 100644 index 00000000..2e600f55 --- /dev/null +++ b/rbi/imagekit/models/auto_description_extension.rbi @@ -0,0 +1,60 @@ +# typed: strong + +module Imagekit + module Models + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::AutoDescriptionExtension, Imagekit::Internal::AnyHash) + end + + # Specifies the auto description extension. + sig { returns(Imagekit::AutoDescriptionExtension::Name::OrSymbol) } + attr_accessor :name + + sig do + params( + name: Imagekit::AutoDescriptionExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Specifies the auto description extension. + name: + ) + end + + sig do + override.returns( + { name: Imagekit::AutoDescriptionExtension::Name::OrSymbol } + ) + end + def to_hash + end + + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::AutoDescriptionExtension::Name) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::AutoDescriptionExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::AutoDescriptionExtension::Name::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/auto_tagging_extension.rbi b/rbi/imagekit/models/auto_tagging_extension.rbi new file mode 100644 index 00000000..f9ba57d8 --- /dev/null +++ b/rbi/imagekit/models/auto_tagging_extension.rbi @@ -0,0 +1,81 @@ +# typed: strong + +module Imagekit + module Models + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::AutoTaggingExtension, Imagekit::Internal::AnyHash) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig { returns(Imagekit::AutoTaggingExtension::Name::OrSymbol) } + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::AutoTaggingExtension::Name) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::AutoTaggingExtension::Name::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi index 1ae93408..05b68708 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -96,9 +96,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) ] ) @@ -111,9 +111,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ] ).void @@ -278,9 +278,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ], folder: String, @@ -429,9 +429,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) ], folder: String, @@ -463,349 +463,12 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) end - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the background removal extension. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - returns( - T.nilable( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - ) - ) - end - attr_reader :options - - sig do - params( - options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash - ).void - end - attr_writer :options - - sig do - params( - name: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash - ).returns(T.attached_class) - end - def self.new( - # Specifies the background removal extension. - name:, - options: nil - ) - end - - sig do - override.returns( - { - name: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - } - ) - end - def to_hash - end - - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash - ) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the auto description extension. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - name: - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Specifies the auto description extension. - name: - ) - end - - sig do - override.returns( - { - name: - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - sig do override.returns( T::Array[ diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekit/models/beta/v2/file_upload_response.rbi index a0ee0029..d0c050bb 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_response.rbi @@ -49,10 +49,10 @@ module Imagekit # 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. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata # The duration of the video in seconds (only for video). @@ -242,7 +242,7 @@ module Imagekit audio_codec: String, bit_rate: Integer, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: @@ -354,7 +354,7 @@ module Imagekit audio_codec: String, bit_rate: Integer, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: diff --git a/rbi/imagekit/models/custom_metadata_field_delete_response.rbi b/rbi/imagekit/models/custom_metadata_field_delete_response.rbi index 9bd69519..1e9c8a3f 100644 --- a/rbi/imagekit/models/custom_metadata_field_delete_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_delete_response.rbi @@ -2,7 +2,22 @@ module Imagekit module Models - CustomMetadataFieldDeleteResponse = - T.let(T.anything, Imagekit::Internal::Type::Converter) + class CustomMetadataFieldDeleteResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::CustomMetadataFieldDeleteResponse, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.attached_class) } + def self.new + end + + sig { override.returns({}) } + def to_hash + end + end end end diff --git a/rbi/imagekit/models/file_copy_response.rbi b/rbi/imagekit/models/file_copy_response.rbi index 9a764a05..74ff699c 100644 --- a/rbi/imagekit/models/file_copy_response.rbi +++ b/rbi/imagekit/models/file_copy_response.rbi @@ -2,6 +2,19 @@ module Imagekit module Models - FileCopyResponse = T.let(T.anything, Imagekit::Internal::Type::Converter) + class FileCopyResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Models::FileCopyResponse, Imagekit::Internal::AnyHash) + end + + sig { returns(T.attached_class) } + def self.new + end + + sig { override.returns({}) } + def to_hash + end + end end end diff --git a/rbi/imagekit/models/file_get_response.rbi b/rbi/imagekit/models/file_get_response.rbi index 33c7ef4d..126d608e 100644 --- a/rbi/imagekit/models/file_get_response.rbi +++ b/rbi/imagekit/models/file_get_response.rbi @@ -27,10 +27,10 @@ module Imagekit attr_accessor :custom_coordinates # An object with custom metadata for the file. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata # Unique identifier of the asset. @@ -168,7 +168,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, @@ -248,7 +248,7 @@ module Imagekit T.nilable(T::Array[Imagekit::Models::FileGetResponse::AITag]), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, diff --git a/rbi/imagekit/models/file_move_response.rbi b/rbi/imagekit/models/file_move_response.rbi index cc47405a..d59ff9bd 100644 --- a/rbi/imagekit/models/file_move_response.rbi +++ b/rbi/imagekit/models/file_move_response.rbi @@ -2,6 +2,19 @@ module Imagekit module Models - FileMoveResponse = T.let(T.anything, Imagekit::Internal::Type::Converter) + class FileMoveResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Models::FileMoveResponse, Imagekit::Internal::AnyHash) + end + + sig { returns(T.attached_class) } + def self.new + end + + sig { override.returns({}) } + def to_hash + end + end end end diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index dad7c300..65912c0d 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -19,10 +19,10 @@ module Imagekit # 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. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata # Optional text to describe the contents of the file. @@ -39,9 +39,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) ] ) @@ -54,9 +54,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ] ).void @@ -119,14 +119,14 @@ module Imagekit sig do params( custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], description: String, extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ], remove_ai_tags: @@ -180,14 +180,14 @@ module Imagekit override.returns( { custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], description: String, extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) ], remove_ai_tags: @@ -211,349 +211,12 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) end - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the background removal extension. - sig do - returns( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - returns( - T.nilable( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - ) - ) - end - attr_reader :options - - sig do - params( - options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash - ).void - end - attr_writer :options - - sig do - params( - name: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash - ).returns(T.attached_class) - end - def self.new( - # Specifies the background removal extension. - name:, - options: nil - ) - end - - sig do - override.returns( - { - name: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - } - ) - end - def to_hash - end - - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash - ) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the auto description extension. - sig do - returns( - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - name: - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Specifies the auto description extension. - name: - ) - end - - sig do - override.returns( - { - name: - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - sig do override.returns( T::Array[Imagekit::FileUpdateParams::Extension::Variants] diff --git a/rbi/imagekit/models/file_update_response.rbi b/rbi/imagekit/models/file_update_response.rbi index d6c22bbc..921d7b51 100644 --- a/rbi/imagekit/models/file_update_response.rbi +++ b/rbi/imagekit/models/file_update_response.rbi @@ -32,10 +32,10 @@ module Imagekit attr_accessor :custom_coordinates # An object with custom metadata for the file. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata sig do @@ -190,7 +190,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus::OrHash, file_id: String, @@ -274,7 +274,7 @@ module Imagekit T.nilable(T::Array[Imagekit::Models::FileUpdateResponse::AITag]), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, file_id: String, diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 00f5b321..04a63cca 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -101,9 +101,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) ] ) @@ -116,9 +116,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ] ).void @@ -301,9 +301,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ], folder: String, @@ -473,9 +473,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) ], folder: String, @@ -506,349 +506,12 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension, + Imagekit::AutoTaggingExtension, + Imagekit::AutoDescriptionExtension ) end - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the background removal extension. - sig do - returns( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - returns( - T.nilable( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options - ) - ) - end - attr_reader :options - - sig do - params( - options: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash - ).void - end - attr_writer :options - - sig do - params( - name: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash - ).returns(T.attached_class) - end - def self.new( - # Specifies the background removal extension. - name:, - options: nil - ) - end - - sig do - override.returns( - { - name: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options - } - ) - end - def to_hash - end - - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash - ) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the auto description extension. - sig do - returns( - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - name: - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Specifies the auto description extension. - name: - ) - end - - sig do - override.returns( - { - name: - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - sig do override.returns( T::Array[Imagekit::FileUploadParams::Extension::Variants] diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekit/models/file_upload_response.rbi index 94499689..60ff68c3 100644 --- a/rbi/imagekit/models/file_upload_response.rbi +++ b/rbi/imagekit/models/file_upload_response.rbi @@ -45,10 +45,10 @@ module Imagekit # 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. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata # The duration of the video in seconds (only for video). @@ -223,7 +223,7 @@ module Imagekit audio_codec: String, bit_rate: Integer, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: @@ -330,7 +330,7 @@ module Imagekit audio_codec: String, bit_rate: Integer, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: diff --git a/rbi/imagekit/models/files/version_delete_response.rbi b/rbi/imagekit/models/files/version_delete_response.rbi index f1f1c90e..6d0f6ab9 100644 --- a/rbi/imagekit/models/files/version_delete_response.rbi +++ b/rbi/imagekit/models/files/version_delete_response.rbi @@ -3,8 +3,23 @@ module Imagekit module Models module Files - VersionDeleteResponse = - T.let(T.anything, Imagekit::Internal::Type::Converter) + class VersionDeleteResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::VersionDeleteResponse, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.attached_class) } + def self.new + end + + sig { override.returns({}) } + def to_hash + end + end end end end diff --git a/rbi/imagekit/models/files/version_get_response.rbi b/rbi/imagekit/models/files/version_get_response.rbi index ce4781b3..ee7287ab 100644 --- a/rbi/imagekit/models/files/version_get_response.rbi +++ b/rbi/imagekit/models/files/version_get_response.rbi @@ -35,10 +35,10 @@ module Imagekit attr_accessor :custom_coordinates # An object with custom metadata for the file. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata # Unique identifier of the asset. @@ -183,7 +183,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, @@ -266,7 +266,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, diff --git a/rbi/imagekit/models/files/version_list_response.rbi b/rbi/imagekit/models/files/version_list_response.rbi index 461b995c..857b6a10 100644 --- a/rbi/imagekit/models/files/version_list_response.rbi +++ b/rbi/imagekit/models/files/version_list_response.rbi @@ -35,10 +35,10 @@ module Imagekit attr_accessor :custom_coordinates # An object with custom metadata for the file. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata # Unique identifier of the asset. @@ -185,7 +185,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, @@ -270,7 +270,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, diff --git a/rbi/imagekit/models/files/version_restore_response.rbi b/rbi/imagekit/models/files/version_restore_response.rbi index 2e581928..e98ff1bd 100644 --- a/rbi/imagekit/models/files/version_restore_response.rbi +++ b/rbi/imagekit/models/files/version_restore_response.rbi @@ -35,10 +35,10 @@ module Imagekit attr_accessor :custom_coordinates # An object with custom metadata for the file. - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_reader :custom_metadata - sig { params(custom_metadata: T.anything).void } + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata # Unique identifier of the asset. @@ -185,7 +185,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, @@ -270,7 +270,7 @@ module Imagekit ), created_at: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, diff --git a/rbi/imagekit/models/folder_create_response.rbi b/rbi/imagekit/models/folder_create_response.rbi index eead7e4e..f3d143f9 100644 --- a/rbi/imagekit/models/folder_create_response.rbi +++ b/rbi/imagekit/models/folder_create_response.rbi @@ -2,7 +2,22 @@ module Imagekit module Models - FolderCreateResponse = - T.let(T.anything, Imagekit::Internal::Type::Converter) + class FolderCreateResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FolderCreateResponse, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.attached_class) } + def self.new + end + + sig { override.returns({}) } + def to_hash + end + end end end diff --git a/rbi/imagekit/models/folder_delete_response.rbi b/rbi/imagekit/models/folder_delete_response.rbi index 1bc93ebe..74f9d60b 100644 --- a/rbi/imagekit/models/folder_delete_response.rbi +++ b/rbi/imagekit/models/folder_delete_response.rbi @@ -2,7 +2,22 @@ module Imagekit module Models - FolderDeleteResponse = - T.let(T.anything, Imagekit::Internal::Type::Converter) + class FolderDeleteResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FolderDeleteResponse, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.attached_class) } + def self.new + end + + sig { override.returns({}) } + def to_hash + end + end end end diff --git a/rbi/imagekit/models/removedot_bg_extension.rbi b/rbi/imagekit/models/removedot_bg_extension.rbi new file mode 100644 index 00000000..0d052898 --- /dev/null +++ b/rbi/imagekit/models/removedot_bg_extension.rbi @@ -0,0 +1,152 @@ +# typed: strong + +module Imagekit + module Models + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::RemovedotBgExtension, Imagekit::Internal::AnyHash) + end + + # Specifies the background removal extension. + sig { returns(Imagekit::RemovedotBgExtension::Name::OrSymbol) } + attr_accessor :name + + sig { returns(T.nilable(Imagekit::RemovedotBgExtension::Options)) } + attr_reader :options + + sig do + params(options: Imagekit::RemovedotBgExtension::Options::OrHash).void + end + attr_writer :options + + sig do + params( + name: Imagekit::RemovedotBgExtension::Name::OrSymbol, + options: Imagekit::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil + ) + end + + sig do + override.returns( + { + name: Imagekit::RemovedotBgExtension::Name::OrSymbol, + options: Imagekit::RemovedotBgExtension::Options + } + ) + end + def to_hash + end + + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::RemovedotBgExtension::Name) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::RemovedotBgExtension::Name::TaggedSymbol] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekit/resources/beta/v2/files.rbi index cf3cca05..1ff024e7 100644 --- a/rbi/imagekit/resources/beta/v2/files.rbi +++ b/rbi/imagekit/resources/beta/v2/files.rbi @@ -44,9 +44,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ], folder: String, diff --git a/rbi/imagekit/resources/custom_metadata_fields.rbi b/rbi/imagekit/resources/custom_metadata_fields.rbi index 379a0884..68588ebd 100644 --- a/rbi/imagekit/resources/custom_metadata_fields.rbi +++ b/rbi/imagekit/resources/custom_metadata_fields.rbi @@ -79,7 +79,7 @@ module Imagekit params( id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) + ).returns(Imagekit::Models::CustomMetadataFieldDeleteResponse) end def delete( # Should be a valid custom metadata field id. diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index f704d5bc..c1376cd3 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -19,14 +19,14 @@ module Imagekit params( file_id: String, custom_coordinates: T.nilable(String), - custom_metadata: T.anything, + custom_metadata: T::Hash[Symbol, T.anything], description: String, extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ], remove_ai_tags: @@ -109,7 +109,7 @@ module Imagekit source_file_path: String, include_file_versions: T::Boolean, request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) + ).returns(Imagekit::Models::FileCopyResponse) end def copy( # Full path to the folder you want to copy the above file into. @@ -149,7 +149,7 @@ module Imagekit destination_path: String, source_file_path: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) + ).returns(Imagekit::Models::FileMoveResponse) end def move( # Full path to the folder you want to move the above file into. @@ -244,9 +244,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::RemovedotBgExtension::OrHash, + Imagekit::AutoTaggingExtension::OrHash, + Imagekit::AutoDescriptionExtension::OrHash ) ], folder: String, diff --git a/rbi/imagekit/resources/files/versions.rbi b/rbi/imagekit/resources/files/versions.rbi index 3146f22b..e1dbf411 100644 --- a/rbi/imagekit/resources/files/versions.rbi +++ b/rbi/imagekit/resources/files/versions.rbi @@ -28,7 +28,7 @@ module Imagekit version_id: String, file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) + ).returns(Imagekit::Models::Files::VersionDeleteResponse) end def delete( # The unique `versionId` of the uploaded file. `versionId` is returned in list and diff --git a/rbi/imagekit/resources/folders.rbi b/rbi/imagekit/resources/folders.rbi index 3a10047a..3fd9afd7 100644 --- a/rbi/imagekit/resources/folders.rbi +++ b/rbi/imagekit/resources/folders.rbi @@ -13,7 +13,7 @@ module Imagekit folder_name: String, parent_folder_path: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) + ).returns(Imagekit::Models::FolderCreateResponse) end def create( # The folder will be created with this name. @@ -40,7 +40,7 @@ module Imagekit params( folder_path: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(T.anything) + ).returns(Imagekit::Models::FolderDeleteResponse) end def delete( # Full path to the folder you want to delete. For example `/folder/to/delete/`. diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 5d21c6e2..26410ac4 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -3,6 +3,10 @@ module Imagekit class AssetListParams = Imagekit::Models::AssetListParams + class AutoDescriptionExtension = Imagekit::Models::AutoDescriptionExtension + + class AutoTaggingExtension = Imagekit::Models::AutoTaggingExtension + module Beta = Imagekit::Models::Beta module Cache = Imagekit::Models::Cache @@ -51,5 +55,7 @@ module Imagekit class Interoperability = Imagekit::Models::Interoperability + class RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension + class Thumbnail = Imagekit::Models::Thumbnail end diff --git a/sig/imagekit/models/asset_list_response.rbs b/sig/imagekit/models/asset_list_response.rbs index ca47dadc..5165a46d 100644 --- a/sig/imagekit/models/asset_list_response.rbs +++ b/sig/imagekit/models/asset_list_response.rbs @@ -12,7 +12,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, @@ -41,9 +41,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader file_id: String? @@ -117,7 +117,7 @@ module Imagekit ?ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, ?created_at: String, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, ?file_path: String, ?file_type: String, @@ -141,7 +141,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, diff --git a/sig/imagekit/models/auto_description_extension.rbs b/sig/imagekit/models/auto_description_extension.rbs new file mode 100644 index 00000000..ce8f247b --- /dev/null +++ b/sig/imagekit/models/auto_description_extension.rbs @@ -0,0 +1,28 @@ +module Imagekit + module Models + type auto_description_extension = + { name: Imagekit::Models::AutoDescriptionExtension::name_ } + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::AutoDescriptionExtension::name_ + + def initialize: ( + name: Imagekit::Models::AutoDescriptionExtension::name_ + ) -> void + + def to_hash: -> { + name: Imagekit::Models::AutoDescriptionExtension::name_ + } + + type name_ = :"ai-auto-description" + + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION: :"ai-auto-description" + + def self?.values: -> ::Array[Imagekit::Models::AutoDescriptionExtension::name_] + end + end + end +end diff --git a/sig/imagekit/models/auto_tagging_extension.rbs b/sig/imagekit/models/auto_tagging_extension.rbs new file mode 100644 index 00000000..dd51b977 --- /dev/null +++ b/sig/imagekit/models/auto_tagging_extension.rbs @@ -0,0 +1,41 @@ +module Imagekit + module Models + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::AutoTaggingExtension::name_] + end + end + end +end diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekit/models/beta/v2/file_upload_params.rbs index 8c630015..e880db97 100644 --- a/sig/imagekit/models/beta/v2/file_upload_params.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_params.rbs @@ -162,154 +162,13 @@ module Imagekit } type extension = - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension - | Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension - | Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension + | Imagekit::AutoTaggingExtension + | Imagekit::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union - type removedot_bg_extension = - { - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_ - - attr_reader options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options? - - def options=: ( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - ) -> Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - - def initialize: ( - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - ) -> void - - def to_hash: -> { - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - } - - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_] - end - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? - - def add_shadow=: (bool) -> bool - - attr_reader bg_color: String? - - def bg_color=: (String) -> String - - attr_reader bg_image_url: String? - - def bg_image_url=: (String) -> String - - attr_reader semitransparency: bool? - - def semitransparency=: (bool) -> bool - - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void - - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end - - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ - } - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer - - attr_accessor min_confidence: Integer - - attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ - - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ - ) -> void - - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ - } - - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_] - end - end - - type auto_description_extension = - { - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ - } - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ - - def initialize: ( - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ - ) -> void - - def to_hash: -> { - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ - } - - type name_ = :"ai-auto-description" - - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION: :"ai-auto-description" - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_] - end - end - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] end diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs index a7a050e8..0d69bb75 100644 --- a/sig/imagekit/models/beta/v2/file_upload_response.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_response.rbs @@ -8,7 +8,7 @@ module Imagekit audio_codec: String, bit_rate: Integer, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], duration: Integer, embedded_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, @@ -42,9 +42,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader duration: Integer? @@ -127,7 +127,7 @@ module Imagekit ?audio_codec: String, ?bit_rate: Integer, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?duration: Integer, ?embedded_metadata: ::Hash[Symbol, top], ?extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, @@ -153,7 +153,7 @@ module Imagekit audio_codec: String, bit_rate: Integer, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], duration: Integer, embedded_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, diff --git a/sig/imagekit/models/custom_metadata_field_delete_response.rbs b/sig/imagekit/models/custom_metadata_field_delete_response.rbs index 741f48f7..51fdebeb 100644 --- a/sig/imagekit/models/custom_metadata_field_delete_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_delete_response.rbs @@ -1,5 +1,11 @@ module Imagekit module Models - CustomMetadataFieldDeleteResponse: Imagekit::Internal::Type::Converter + type custom_metadata_field_delete_response = { } + + class CustomMetadataFieldDeleteResponse < Imagekit::Internal::Type::BaseModel + def initialize: -> void + + def to_hash: -> { } + end end end diff --git a/sig/imagekit/models/file_copy_response.rbs b/sig/imagekit/models/file_copy_response.rbs index 7b6a6f8c..037e8a88 100644 --- a/sig/imagekit/models/file_copy_response.rbs +++ b/sig/imagekit/models/file_copy_response.rbs @@ -1,5 +1,11 @@ module Imagekit module Models - FileCopyResponse: Imagekit::Internal::Type::Converter + type file_copy_response = { } + + class FileCopyResponse < Imagekit::Internal::Type::BaseModel + def initialize: -> void + + def to_hash: -> { } + end end end diff --git a/sig/imagekit/models/file_get_response.rbs b/sig/imagekit/models/file_get_response.rbs index 3ed8c9bd..d8a500bf 100644 --- a/sig/imagekit/models/file_get_response.rbs +++ b/sig/imagekit/models/file_get_response.rbs @@ -5,7 +5,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, @@ -34,9 +34,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader file_id: String? @@ -110,7 +110,7 @@ module Imagekit ?ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, ?created_at: String, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, ?file_path: String, ?file_type: String, @@ -134,7 +134,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, diff --git a/sig/imagekit/models/file_move_response.rbs b/sig/imagekit/models/file_move_response.rbs index 88d76170..6e5e95ee 100644 --- a/sig/imagekit/models/file_move_response.rbs +++ b/sig/imagekit/models/file_move_response.rbs @@ -1,5 +1,11 @@ module Imagekit module Models - FileMoveResponse: Imagekit::Internal::Type::Converter + type file_move_response = { } + + class FileMoveResponse < Imagekit::Internal::Type::BaseModel + def initialize: -> void + + def to_hash: -> { } + end end end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index f78fd3ca..8db160b2 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -3,7 +3,7 @@ module Imagekit type file_update_params = { custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], description: String, extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, @@ -19,9 +19,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader description: String? @@ -53,7 +53,7 @@ module Imagekit def initialize: ( ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?description: String, ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, @@ -65,7 +65,7 @@ module Imagekit def to_hash: -> { custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], description: String, extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, @@ -76,154 +76,13 @@ module Imagekit } type extension = - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension - | Imagekit::FileUpdateParams::Extension::AutoTaggingExtension - | Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension + | Imagekit::AutoTaggingExtension + | Imagekit::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union - type removedot_bg_extension = - { - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_ - - attr_reader options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options? - - def options=: ( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - ) -> Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - - def initialize: ( - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - ) -> void - - def to_hash: -> { - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - } - - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_] - end - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? - - def add_shadow=: (bool) -> bool - - attr_reader bg_color: String? - - def bg_color=: (String) -> String - - attr_reader bg_image_url: String? - - def bg_image_url=: (String) -> String - - attr_reader semitransparency: bool? - - def semitransparency=: (bool) -> bool - - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void - - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end - - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - } - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer - - attr_accessor min_confidence: Integer - - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - ) -> void - - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - } - - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_] - end - end - - type auto_description_extension = - { - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - } - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - - def initialize: ( - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - ) -> void - - def to_hash: -> { - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - } - - type name_ = :"ai-auto-description" - - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION: :"ai-auto-description" - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_] - end - end - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::extension] end diff --git a/sig/imagekit/models/file_update_response.rbs b/sig/imagekit/models/file_update_response.rbs index 57792c82..d66b3703 100644 --- a/sig/imagekit/models/file_update_response.rbs +++ b/sig/imagekit/models/file_update_response.rbs @@ -5,7 +5,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, file_id: String, file_path: String, @@ -35,9 +35,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus? @@ -117,7 +117,7 @@ module Imagekit ?ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, ?created_at: String, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, ?file_id: String, ?file_path: String, @@ -142,7 +142,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, file_id: String, file_path: String, diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index b9b40672..9ad2ba7f 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -181,154 +181,13 @@ module Imagekit } type extension = - Imagekit::FileUploadParams::Extension::RemovedotBgExtension - | Imagekit::FileUploadParams::Extension::AutoTaggingExtension - | Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::RemovedotBgExtension + | Imagekit::AutoTaggingExtension + | Imagekit::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union - type removedot_bg_extension = - { - name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options - } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_ - - attr_reader options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options? - - def options=: ( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options - ) -> Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options - - def initialize: ( - name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options - ) -> void - - def to_hash: -> { - name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options - } - - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_] - end - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? - - def add_shadow=: (bool) -> bool - - attr_reader bg_color: String? - - def bg_color=: (String) -> String - - attr_reader bg_image_url: String? - - def bg_image_url=: (String) -> String - - attr_reader semitransparency: bool? - - def semitransparency=: (bool) -> bool - - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void - - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end - - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ - } - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer - - attr_accessor min_confidence: Integer - - attr_accessor name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ - - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ - ) -> void - - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ - } - - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_] - end - end - - type auto_description_extension = - { - name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ - } - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ - - def initialize: ( - name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ - ) -> void - - def to_hash: -> { - name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ - } - - type name_ = :"ai-auto-description" - - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION: :"ai-auto-description" - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_] - end - end - def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::extension] end diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs index 9d394c87..725869ec 100644 --- a/sig/imagekit/models/file_upload_response.rbs +++ b/sig/imagekit/models/file_upload_response.rbs @@ -6,7 +6,7 @@ module Imagekit audio_codec: String, bit_rate: Integer, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], duration: Integer, embedded_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, @@ -40,9 +40,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader duration: Integer? @@ -125,7 +125,7 @@ module Imagekit ?audio_codec: String, ?bit_rate: Integer, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?duration: Integer, ?embedded_metadata: ::Hash[Symbol, top], ?extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, @@ -151,7 +151,7 @@ module Imagekit audio_codec: String, bit_rate: Integer, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], duration: Integer, embedded_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, diff --git a/sig/imagekit/models/files/version_delete_response.rbs b/sig/imagekit/models/files/version_delete_response.rbs index 867baddf..6c5f6681 100644 --- a/sig/imagekit/models/files/version_delete_response.rbs +++ b/sig/imagekit/models/files/version_delete_response.rbs @@ -1,7 +1,13 @@ module Imagekit module Models module Files - VersionDeleteResponse: Imagekit::Internal::Type::Converter + type version_delete_response = { } + + class VersionDeleteResponse < Imagekit::Internal::Type::BaseModel + def initialize: -> void + + def to_hash: -> { } + end end end end diff --git a/sig/imagekit/models/files/version_get_response.rbs b/sig/imagekit/models/files/version_get_response.rbs index ca764d51..bd0fa858 100644 --- a/sig/imagekit/models/files/version_get_response.rbs +++ b/sig/imagekit/models/files/version_get_response.rbs @@ -6,7 +6,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, @@ -35,9 +35,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader file_id: String? @@ -111,7 +111,7 @@ module Imagekit ?ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, ?created_at: String, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, ?file_path: String, ?file_type: String, @@ -135,7 +135,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, diff --git a/sig/imagekit/models/files/version_list_response.rbs b/sig/imagekit/models/files/version_list_response.rbs index 65e0e5b7..069fcdf0 100644 --- a/sig/imagekit/models/files/version_list_response.rbs +++ b/sig/imagekit/models/files/version_list_response.rbs @@ -6,7 +6,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, @@ -35,9 +35,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader file_id: String? @@ -111,7 +111,7 @@ module Imagekit ?ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, ?created_at: String, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, ?file_path: String, ?file_type: String, @@ -135,7 +135,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, diff --git a/sig/imagekit/models/files/version_restore_response.rbs b/sig/imagekit/models/files/version_restore_response.rbs index ef0b35d8..d784a92f 100644 --- a/sig/imagekit/models/files/version_restore_response.rbs +++ b/sig/imagekit/models/files/version_restore_response.rbs @@ -6,7 +6,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, @@ -35,9 +35,9 @@ module Imagekit attr_accessor custom_coordinates: String? - attr_reader custom_metadata: top? + attr_reader custom_metadata: ::Hash[Symbol, top]? - def custom_metadata=: (top) -> top + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] attr_reader file_id: String? @@ -111,7 +111,7 @@ module Imagekit ?ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, ?created_at: String, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, ?file_path: String, ?file_type: String, @@ -135,7 +135,7 @@ module Imagekit ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, created_at: String, custom_coordinates: String?, - custom_metadata: top, + custom_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, diff --git a/sig/imagekit/models/folder_create_response.rbs b/sig/imagekit/models/folder_create_response.rbs index c54daaa5..4cc3bed8 100644 --- a/sig/imagekit/models/folder_create_response.rbs +++ b/sig/imagekit/models/folder_create_response.rbs @@ -1,5 +1,11 @@ module Imagekit module Models - FolderCreateResponse: Imagekit::Internal::Type::Converter + type folder_create_response = { } + + class FolderCreateResponse < Imagekit::Internal::Type::BaseModel + def initialize: -> void + + def to_hash: -> { } + end end end diff --git a/sig/imagekit/models/folder_delete_response.rbs b/sig/imagekit/models/folder_delete_response.rbs index 25459cdc..9dcdda77 100644 --- a/sig/imagekit/models/folder_delete_response.rbs +++ b/sig/imagekit/models/folder_delete_response.rbs @@ -1,5 +1,11 @@ module Imagekit module Models - FolderDeleteResponse: Imagekit::Internal::Type::Converter + type folder_delete_response = { } + + class FolderDeleteResponse < Imagekit::Internal::Type::BaseModel + def initialize: -> void + + def to_hash: -> { } + end end end diff --git a/sig/imagekit/models/removedot_bg_extension.rbs b/sig/imagekit/models/removedot_bg_extension.rbs new file mode 100644 index 00000000..ff2ef781 --- /dev/null +++ b/sig/imagekit/models/removedot_bg_extension.rbs @@ -0,0 +1,79 @@ +module Imagekit + module Models + type removedot_bg_extension = + { + name: Imagekit::Models::RemovedotBgExtension::name_, + options: Imagekit::RemovedotBgExtension::Options + } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::RemovedotBgExtension::name_ + + attr_reader options: Imagekit::RemovedotBgExtension::Options? + + def options=: ( + Imagekit::RemovedotBgExtension::Options + ) -> Imagekit::RemovedotBgExtension::Options + + def initialize: ( + name: Imagekit::Models::RemovedotBgExtension::name_, + ?options: Imagekit::RemovedotBgExtension::Options + ) -> void + + def to_hash: -> { + name: Imagekit::Models::RemovedotBgExtension::name_, + options: Imagekit::RemovedotBgExtension::Options + } + + type name_ = :"remove-bg" + + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG: :"remove-bg" + + def self?.values: -> ::Array[Imagekit::Models::RemovedotBgExtension::name_] + end + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + end +end diff --git a/sig/imagekit/resources/custom_metadata_fields.rbs b/sig/imagekit/resources/custom_metadata_fields.rbs index 3f0a4e3f..1a6850e9 100644 --- a/sig/imagekit/resources/custom_metadata_fields.rbs +++ b/sig/imagekit/resources/custom_metadata_fields.rbs @@ -20,7 +20,10 @@ module Imagekit ?request_options: Imagekit::request_opts ) -> Imagekit::Models::custom_metadata_field_list_response - def delete: (String id, ?request_options: Imagekit::request_opts) -> top + def delete: ( + String id, + ?request_options: Imagekit::request_opts + ) -> Imagekit::Models::CustomMetadataFieldDeleteResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index c0aa0d23..d47cd3f2 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -10,7 +10,7 @@ module Imagekit def update: ( String file_id, ?custom_coordinates: String?, - ?custom_metadata: top, + ?custom_metadata: ::Hash[Symbol, top], ?description: String, ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, @@ -30,7 +30,7 @@ module Imagekit source_file_path: String, ?include_file_versions: bool, ?request_options: Imagekit::request_opts - ) -> top + ) -> Imagekit::Models::FileCopyResponse def get: ( String file_id, @@ -41,7 +41,7 @@ module Imagekit destination_path: String, source_file_path: String, ?request_options: Imagekit::request_opts - ) -> top + ) -> Imagekit::Models::FileMoveResponse def rename: ( file_path: String, diff --git a/sig/imagekit/resources/files/versions.rbs b/sig/imagekit/resources/files/versions.rbs index a1a0934e..16bf7a95 100644 --- a/sig/imagekit/resources/files/versions.rbs +++ b/sig/imagekit/resources/files/versions.rbs @@ -11,7 +11,7 @@ module Imagekit String version_id, file_id: String, ?request_options: Imagekit::request_opts - ) -> top + ) -> Imagekit::Models::Files::VersionDeleteResponse def get: ( String version_id, diff --git a/sig/imagekit/resources/folders.rbs b/sig/imagekit/resources/folders.rbs index 72cc1ea2..f5990d9b 100644 --- a/sig/imagekit/resources/folders.rbs +++ b/sig/imagekit/resources/folders.rbs @@ -7,12 +7,12 @@ module Imagekit folder_name: String, parent_folder_path: String, ?request_options: Imagekit::request_opts - ) -> top + ) -> Imagekit::Models::FolderCreateResponse def delete: ( folder_path: String, ?request_options: Imagekit::request_opts - ) -> top + ) -> Imagekit::Models::FolderDeleteResponse def copy: ( destination_path: String, diff --git a/test/imagekit/resources/beta/v2/files_test.rb b/test/imagekit/resources/beta/v2/files_test.rb index ce496d7c..afc21743 100644 --- a/test/imagekit/resources/beta/v2/files_test.rb +++ b/test/imagekit/resources/beta/v2/files_test.rb @@ -18,7 +18,7 @@ def test_upload_required_params audio_codec: String | nil, bit_rate: Integer | nil, custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, + custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, duration: Integer | nil, embedded_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus | nil, diff --git a/test/imagekit/resources/custom_metadata_fields_test.rb b/test/imagekit/resources/custom_metadata_fields_test.rb index 03889f65..f5a22676 100644 --- a/test/imagekit/resources/custom_metadata_fields_test.rb +++ b/test/imagekit/resources/custom_metadata_fields_test.rb @@ -58,7 +58,13 @@ def test_delete response = @image_kit.custom_metadata_fields.delete("id") assert_pattern do - response => Imagekit::Internal::Type::Unknown + response => Imagekit::Models::CustomMetadataFieldDeleteResponse + end + + assert_pattern do + response => { + **_ + } end end end diff --git a/test/imagekit/resources/files/versions_test.rb b/test/imagekit/resources/files/versions_test.rb index 3d105892..92dcd86c 100644 --- a/test/imagekit/resources/files/versions_test.rb +++ b/test/imagekit/resources/files/versions_test.rb @@ -19,7 +19,13 @@ def test_delete_required_params response = @image_kit.files.versions.delete("versionId", file_id: "fileId") assert_pattern do - response => Imagekit::Internal::Type::Unknown + response => Imagekit::Models::Files::VersionDeleteResponse + end + + assert_pattern do + response => { + **_ + } end end @@ -37,7 +43,7 @@ def test_get_required_params ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionGetResponse::AITag]) | nil, created_at: String | nil, custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, + custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, @@ -73,7 +79,7 @@ def test_restore_required_params ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRestoreResponse::AITag]) | nil, created_at: String | nil, custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, + custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index 58950ecb..e7728461 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -17,7 +17,7 @@ def test_update ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUpdateResponse::AITag]) | nil, created_at: String | nil, custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, + custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus | nil, file_id: String | nil, file_path: String | nil, @@ -57,7 +57,13 @@ def test_copy_required_params @image_kit.files.copy(destination_path: "/folder/to/copy/into/", source_file_path: "/path/to/file.jpg") assert_pattern do - response => Imagekit::Internal::Type::Unknown + response => Imagekit::Models::FileCopyResponse + end + + assert_pattern do + response => { + **_ + } end end @@ -75,7 +81,7 @@ def test_get ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileGetResponse::AITag]) | nil, created_at: String | nil, custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, + custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, @@ -104,7 +110,13 @@ def test_move_required_params @image_kit.files.move(destination_path: "/folder/to/move/into/", source_file_path: "/path/to/file.jpg") assert_pattern do - response => Imagekit::Internal::Type::Unknown + response => Imagekit::Models::FileMoveResponse + end + + assert_pattern do + response => { + **_ + } end end @@ -139,7 +151,7 @@ def test_upload_required_params audio_codec: String | nil, bit_rate: Integer | nil, custom_coordinates: String | nil, - custom_metadata: Imagekit::Internal::Type::Unknown | nil, + custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, duration: Integer | nil, embedded_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus | nil, diff --git a/test/imagekit/resources/folders_test.rb b/test/imagekit/resources/folders_test.rb index 29bc1232..1130e813 100644 --- a/test/imagekit/resources/folders_test.rb +++ b/test/imagekit/resources/folders_test.rb @@ -9,7 +9,13 @@ def test_create_required_params response = @image_kit.folders.create(folder_name: "summer", parent_folder_path: "/product/images/") assert_pattern do - response => Imagekit::Internal::Type::Unknown + response => Imagekit::Models::FolderCreateResponse + end + + assert_pattern do + response => { + **_ + } end end @@ -19,7 +25,13 @@ def test_delete_required_params response = @image_kit.folders.delete(folder_path: "/folder/to/delete/") assert_pattern do - response => Imagekit::Internal::Type::Unknown + response => Imagekit::Models::FolderDeleteResponse + end + + assert_pattern do + response => { + **_ + } end end From 05733ec04af6336ba7ff605d9dc43999e48c1409 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 20 Aug 2025 04:15:15 +0000 Subject: [PATCH 006/178] fix: bump sorbet version and fix new type errors from the breaking change --- .rubocop.yml | 2 +- Gemfile.lock | 88 +++++++++++-------- .../transport/pooled_net_requester.rb | 10 +-- lib/imagekit/internal/type/base_model.rb | 9 +- lib/imagekit/internal/util.rb | 2 +- .../accounts/url_endpoint_create_params.rb | 12 +-- .../accounts/url_endpoint_update_params.rb | 12 +-- .../models/beta/v2/file_upload_params.rb | 36 ++------ lib/imagekit/models/file_upload_params.rb | 26 ++---- rbi/imagekit/errors.rbi | 4 +- .../imagekit/internal/type/base_model_test.rb | 6 ++ test/imagekit/internal/util_test.rb | 12 +-- 12 files changed, 88 insertions(+), 131 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 14777052..47dc74ae 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -149,7 +149,7 @@ Naming/ClassAndModuleCamelCase: Naming/MethodParameterName: Enabled: false -Naming/PredicateName: +Naming/PredicatePrefix: Exclude: - "**/*.rbi" diff --git a/Gemfile.lock b/Gemfile.lock index 67bdf1d8..2c4ef551 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -17,7 +17,7 @@ PATH GEM remote: https://rubygems.org/ specs: - activesupport (8.0.2) + activesupport (8.0.2.1) base64 benchmark (>= 0.3) bigdecimal @@ -33,45 +33,50 @@ GEM addressable (2.8.7) public_suffix (>= 2.0.2, < 7.0) ast (2.4.3) - async (2.24.0) + async (2.27.3) console (~> 1.29) fiber-annotation - io-event (~> 1.9) + io-event (~> 1.11) metrics (~> 0.12) traces (~> 0.15) - base64 (0.2.0) - benchmark (0.4.0) - bigdecimal (3.1.9) + base64 (0.3.0) + benchmark (0.4.1) + bigdecimal (3.2.2) concurrent-ruby (1.3.5) connection_pool (2.5.3) - console (1.30.2) + console (1.33.0) fiber-annotation fiber-local (~> 1.1) json crack (1.0.0) bigdecimal rexml - csv (3.3.4) - drb (2.2.1) + csv (3.3.5) + drb (2.2.3) erubi (1.13.1) + ffi (1.17.2-aarch64-linux-gnu) + ffi (1.17.2-aarch64-linux-musl) + ffi (1.17.2-arm64-darwin) + ffi (1.17.2-x86_64-darwin) ffi (1.17.2-x86_64-linux-gnu) + ffi (1.17.2-x86_64-linux-musl) fiber-annotation (0.2.0) fiber-local (1.1.0) fiber-storage fiber-storage (1.0.1) fileutils (1.7.3) - hashdiff (1.1.2) + hashdiff (1.2.0) i18n (1.14.7) concurrent-ruby (~> 1.0) - io-event (1.10.0) - json (2.11.3) - language_server-protocol (3.17.0.4) + io-event (1.11.2) + json (2.13.2) + language_server-protocol (3.17.0.5) lint_roller (1.1.0) listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) logger (1.7.0) - metrics (0.12.2) + metrics (0.13.0) minitest (5.25.5) minitest-focus (1.4.0) minitest (>= 4, < 6) @@ -84,7 +89,7 @@ GEM mutex_m (0.3.0) netrc (0.11.0) parallel (1.27.0) - parser (3.3.8.0) + parser (3.3.9.0) ast (~> 2.4.1) racc prettier_print (1.2.1) @@ -92,20 +97,19 @@ GEM public_suffix (6.0.2) racc (1.8.1) rainbow (3.1.1) - rake (13.2.1) + rake (13.3.0) rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rbi (0.3.2) + rbi (0.3.6) prism (~> 1.0) rbs (>= 3.4.4) - sorbet-runtime (>= 0.5.9204) - rbs (3.9.2) + rbs (3.9.4) logger redcarpet (3.6.1) - regexp_parser (2.10.0) + regexp_parser (2.11.2) rexml (3.4.1) - rubocop (1.75.5) + rubocop (1.79.2) json (~> 2.3) language_server-protocol (~> 3.17.0.2) lint_roller (~> 1.1.0) @@ -113,25 +117,28 @@ GEM parser (>= 3.3.0.2) rainbow (>= 2.2.2, < 4.0) regexp_parser (>= 2.9.3, < 3.0) - rubocop-ast (>= 1.44.0, < 2.0) + rubocop-ast (>= 1.46.0, < 2.0) ruby-progressbar (~> 1.7) unicode-display_width (>= 2.4.0, < 4.0) - rubocop-ast (1.44.1) + rubocop-ast (1.46.0) parser (>= 3.3.7.2) prism (~> 1.4) ruby-progressbar (1.13.0) securerandom (0.4.1) - sorbet (0.5.12067) - sorbet-static (= 0.5.12067) - sorbet-runtime (0.5.12067) - sorbet-static (0.5.12067-x86_64-linux) - sorbet-static-and-runtime (0.5.12067) - sorbet (= 0.5.12067) - sorbet-runtime (= 0.5.12067) - spoom (1.6.1) + sorbet (0.5.12424) + sorbet-static (= 0.5.12424) + sorbet-runtime (0.5.12424) + sorbet-static (0.5.12424-aarch64-linux) + sorbet-static (0.5.12424-universal-darwin) + sorbet-static (0.5.12424-x86_64-linux) + sorbet-static-and-runtime (0.5.12424) + sorbet (= 0.5.12424) + sorbet-runtime (= 0.5.12424) + spoom (1.6.3) erubi (>= 1.10.0) prism (>= 0.28.0) - rbi (>= 0.2.3) + rbi (>= 0.3.3) + rexml (>= 3.2.6) sorbet-static-and-runtime (>= 0.5.10187) thor (>= 0.19.2) steep (1.10.0) @@ -152,7 +159,7 @@ GEM terminal-table (>= 2, < 5) uri (>= 0.12.0) strscan (3.1.5) - syntax_tree (6.2.0) + syntax_tree (6.3.0) prettier_print (>= 1.2.0) tapioca (0.16.11) benchmark @@ -166,11 +173,11 @@ GEM yard-sorbet terminal-table (4.0.0) unicode-display_width (>= 1.1.1, < 4) - thor (1.3.2) - traces (0.15.2) + thor (1.4.0) + traces (0.17.0) tzinfo (2.0.6) concurrent-ruby (~> 1.0) - unicode-display_width (3.1.4) + unicode-display_width (3.1.5) unicode-emoji (~> 4.0, >= 4.0.4) unicode-emoji (4.0.4) uri (1.0.3) @@ -185,7 +192,14 @@ GEM yard PLATFORMS - x86_64-linux + aarch64-linux + aarch64-linux-gnu + aarch64-linux-musl + arm64-darwin + universal-darwin + x86_64-darwin + x86_64-linux-gnu + x86_64-linux-musl DEPENDENCIES async diff --git a/lib/imagekit/internal/transport/pooled_net_requester.rb b/lib/imagekit/internal/transport/pooled_net_requester.rb index 1acc244b..365d5689 100644 --- a/lib/imagekit/internal/transport/pooled_net_requester.rb +++ b/lib/imagekit/internal/transport/pooled_net_requester.rb @@ -193,15 +193,7 @@ def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS) end define_sorbet_constant!(:Request) do - T.type_alias do - { - method: Symbol, - url: URI::Generic, - headers: T::Hash[String, String], - body: T.anything, - deadline: Float - } - end + T.type_alias { {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} } end end end diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb index 3fda468e..cc17b099 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekit/internal/type/base_model.rb @@ -64,14 +64,7 @@ def fields setter = :"#{name_sym}=" api_name = info.fetch(:api_name, name_sym) nilable = info.fetch(:nil?, false) - const = if required && !nilable - info.fetch( - :const, - Imagekit::Internal::OMIT - ) - else - Imagekit::Internal::OMIT - end + const = required && !nilable ? info.fetch(:const, Imagekit::Internal::OMIT) : Imagekit::Internal::OMIT [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym) diff --git a/lib/imagekit/internal/util.rb b/lib/imagekit/internal/util.rb index f1311ffe..e1561bc5 100644 --- a/lib/imagekit/internal/util.rb +++ b/lib/imagekit/internal/util.rb @@ -244,7 +244,7 @@ class << self # # @return [String] def uri_origin(uri) - "#{uri.scheme}://#{uri.host}#{uri.port == uri.default_port ? '' : ":#{uri.port}"}" + "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}" end # @api private diff --git a/lib/imagekit/models/accounts/url_endpoint_create_params.rb b/lib/imagekit/models/accounts/url_endpoint_create_params.rb index dcdf5068..f8e23117 100644 --- a/lib/imagekit/models/accounts/url_endpoint_create_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_create_params.rb @@ -66,9 +66,7 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type] required :type, - enum: -> { - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type - } + enum: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type } # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. @@ -99,9 +97,7 @@ class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type] required :type, - enum: -> { - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type - } + enum: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type } # @!method initialize(type:) # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type] @@ -122,9 +118,7 @@ class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type] required :type, - enum: -> { - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type - } + enum: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type } # @!method initialize(type:) # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type] diff --git a/lib/imagekit/models/accounts/url_endpoint_update_params.rb b/lib/imagekit/models/accounts/url_endpoint_update_params.rb index 9cc44637..e41a503f 100644 --- a/lib/imagekit/models/accounts/url_endpoint_update_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_update_params.rb @@ -66,9 +66,7 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type] required :type, - enum: -> { - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type - } + enum: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type } # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. @@ -99,9 +97,7 @@ class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type] required :type, - enum: -> { - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type - } + enum: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type } # @!method initialize(type:) # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type] @@ -122,9 +118,7 @@ class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type] required :type, - enum: -> { - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type - } + enum: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type } # @!method initialize(type:) # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type] diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index 89c24d8e..dc601b07 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -89,9 +89,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @return [Array, nil] optional :extensions, - -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Extension] - } + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Extension] } # @!attribute folder # The folder path in which the image has to be uploaded. If the folder(s) didn't @@ -291,9 +289,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @return [Array, nil] optional :post, - -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Transformation::Post] - } + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Transformation::Post] } # @!attribute pre # Transformation string to apply before uploading the file to the Media Library. @@ -325,17 +321,13 @@ class Transformation < Imagekit::Internal::Type::BaseModel module Post extend Imagekit::Internal::Type::Union - variant -> { - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation - } + variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation } variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo } variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail } - variant -> { - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming - } + variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming } class SimplePostTransformation < Imagekit::Internal::Type::BaseModel # @!attribute type @@ -343,9 +335,7 @@ class SimplePostTransformation < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] required :type, - enum: -> { - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type - } + enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type } # @!attribute value # Transformation string (e.g. `w-200,h-200`). @@ -382,9 +372,7 @@ class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] required :type, - enum: -> { - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type - } + enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type } # @!attribute value # Optional transformation string to apply to the output video. @@ -421,9 +409,7 @@ class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] required :type, - enum: -> { - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type - } + enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type } # @!attribute value # Optional transformation string. @@ -460,18 +446,14 @@ class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] required :protocol, - enum: -> { - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol - } + enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol } # @!attribute type # Adaptive Bitrate Streaming (ABS) setup. # # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] required :type, - enum: -> { - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type - } + enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type } # @!attribute value # List of different representations you want to create separated by an underscore. diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index 2d57e451..b0034f10 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -324,9 +324,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @return [Array, nil] optional :post, - -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Transformation::Post] - } + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Transformation::Post] } # @!attribute pre # Transformation string to apply before uploading the file to the Media Library. @@ -372,9 +370,7 @@ class SimplePostTransformation < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] required :type, - enum: -> { - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type - } + enum: -> { Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type } # @!attribute value # Transformation string (e.g. `w-200,h-200`). @@ -410,10 +406,7 @@ class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel # Converts an animated GIF into an MP4. # # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] - required :type, - enum: -> { - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type - } + required :type, enum: -> { Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type } # @!attribute value # Optional transformation string to apply to the output video. @@ -449,10 +442,7 @@ class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel # Generates a thumbnail image. # # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] - required :type, - enum: -> { - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type - } + required :type, enum: -> { Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type } # @!attribute value # Optional transformation string. @@ -489,18 +479,14 @@ class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel # # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] required :protocol, - enum: -> { - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol - } + enum: -> { Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol } # @!attribute type # Adaptive Bitrate Streaming (ABS) setup. # # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] required :type, - enum: -> { - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type - } + enum: -> { Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type } # @!attribute value # List of different representations you want to create separated by an underscore. diff --git a/rbi/imagekit/errors.rbi b/rbi/imagekit/errors.rbi index 62c31cc6..733211e0 100644 --- a/rbi/imagekit/errors.rbi +++ b/rbi/imagekit/errors.rbi @@ -59,10 +59,10 @@ module Imagekit end class APIConnectionError < Imagekit::Errors::APIError - sig { void } + sig { returns(NilClass) } attr_accessor :status - sig { void } + sig { returns(NilClass) } attr_accessor :body # @api private diff --git a/test/imagekit/internal/type/base_model_test.rb b/test/imagekit/internal/type/base_model_test.rb index 458e8287..4373043c 100644 --- a/test/imagekit/internal/type/base_model_test.rb +++ b/test/imagekit/internal/type/base_model_test.rb @@ -157,6 +157,7 @@ def test_dump_retry class Imagekit::Test::EnumModelTest < Minitest::Test class E0 include Imagekit::Internal::Type::Enum + attr_reader :values def initialize(*values) = (@values = values) @@ -476,6 +477,7 @@ def initialize(*variants) = variants.each { variant(_1) } module U1 extend Imagekit::Internal::Type::Union + variant const: :a variant const: 2 end @@ -492,6 +494,7 @@ class M2 < Imagekit::Internal::Type::BaseModel module U2 extend Imagekit::Internal::Type::Union + discriminator :type variant :a, M1 @@ -500,6 +503,7 @@ module U2 module U3 extend Imagekit::Internal::Type::Union + discriminator :type variant :a, M1 @@ -508,6 +512,7 @@ module U3 module U4 extend Imagekit::Internal::Type::Union + discriminator :type variant String @@ -601,6 +606,7 @@ def test_coerce class Imagekit::Test::BaseModelQoLTest < Minitest::Test class E0 include Imagekit::Internal::Type::Enum + attr_reader :values def initialize(*values) = (@values = values) diff --git a/test/imagekit/internal/util_test.rb b/test/imagekit/internal/util_test.rb index ef803a6d..48616831 100644 --- a/test/imagekit/internal/util_test.rb +++ b/test/imagekit/internal/util_test.rb @@ -242,11 +242,7 @@ def test_hash_encode {strio: StringIO.new("a")} => {"strio" => "a"}, {strio: Imagekit::FilePart.new("a")} => {"strio" => "a"}, {pathname: Pathname(__FILE__)} => {"pathname" => -> { _1.read in /^class Imagekit/ }}, - {pathname: Imagekit::FilePart.new(Pathname(__FILE__))} => { - "pathname" => -> { - _1.read in /^class Imagekit/ - } - } + {pathname: Imagekit::FilePart.new(Pathname(__FILE__))} => {"pathname" => -> { _1.read in /^class Imagekit/ }} } cases.each do |body, testcase| encoded = Imagekit::Internal::Util.encode_content(headers, body) @@ -324,9 +320,9 @@ def test_rewind_chain end def test_external_iteration - it = [1, 2, 3].to_enum - first = it.next - fused = Imagekit::Internal::Util.fused_enum(it, external: true) + iter = [1, 2, 3].to_enum + first = iter.next + fused = Imagekit::Internal::Util.fused_enum(iter, external: true) assert_equal(1, first) assert_equal([2, 3], fused.to_a) From cf945850d4ef698744fc80e7817b09354ef5ef67 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 06:54:02 +0000 Subject: [PATCH 007/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 6 + lib/imagekit/client.rb | 4 + lib/imagekit/internal/type/union.rb | 18 +- lib/imagekit/models.rb | 10 + lib/imagekit/models/unwrap_webhook_event.rb | 18 + ...o_transformation_accepted_webhook_event.rb | 241 +++++ ...ideo_transformation_error_webhook_event.rb | 271 ++++++ ...ideo_transformation_ready_webhook_event.rb | 321 +++++++ lib/imagekit/models/webhook_unwrap_params.rb | 14 + lib/imagekit/resources/webhooks.rb | 22 + rbi/imagekit/client.rbi | 3 + rbi/imagekit/models.rbi | 13 + rbi/imagekit/models/unwrap_webhook_event.rbi | 22 + ..._transformation_accepted_webhook_event.rbi | 644 ++++++++++++++ ...deo_transformation_error_webhook_event.rbi | 733 ++++++++++++++++ ...deo_transformation_ready_webhook_event.rbi | 820 ++++++++++++++++++ rbi/imagekit/models/webhook_unwrap_params.rbi | 27 + rbi/imagekit/resources/webhooks.rbi | 27 + sig/imagekit/client.rbs | 2 + sig/imagekit/models.rbs | 10 + sig/imagekit/models/unwrap_webhook_event.rbs | 14 + ..._transformation_accepted_webhook_event.rbs | 261 ++++++ ...deo_transformation_error_webhook_event.rbs | 300 +++++++ ...deo_transformation_ready_webhook_event.rbs | 359 ++++++++ sig/imagekit/models/webhook_unwrap_params.rbs | 15 + sig/imagekit/resources/webhooks.rbs | 13 + test/imagekit/resources/webhooks_test.rb | 6 + 28 files changed, 4186 insertions(+), 10 deletions(-) create mode 100644 lib/imagekit/models/unwrap_webhook_event.rb create mode 100644 lib/imagekit/models/video_transformation_accepted_webhook_event.rb create mode 100644 lib/imagekit/models/video_transformation_error_webhook_event.rb create mode 100644 lib/imagekit/models/video_transformation_ready_webhook_event.rb create mode 100644 lib/imagekit/models/webhook_unwrap_params.rb create mode 100644 lib/imagekit/resources/webhooks.rb create mode 100644 rbi/imagekit/models/unwrap_webhook_event.rbi create mode 100644 rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi create mode 100644 rbi/imagekit/models/video_transformation_error_webhook_event.rbi create mode 100644 rbi/imagekit/models/video_transformation_ready_webhook_event.rbi create mode 100644 rbi/imagekit/models/webhook_unwrap_params.rbi create mode 100644 rbi/imagekit/resources/webhooks.rbi create mode 100644 sig/imagekit/models/unwrap_webhook_event.rbs create mode 100644 sig/imagekit/models/video_transformation_accepted_webhook_event.rbs create mode 100644 sig/imagekit/models/video_transformation_error_webhook_event.rbs create mode 100644 sig/imagekit/models/video_transformation_ready_webhook_event.rbs create mode 100644 sig/imagekit/models/webhook_unwrap_params.rbs create mode 100644 sig/imagekit/resources/webhooks.rbs create mode 100644 test/imagekit/resources/webhooks_test.rb diff --git a/.stats.yml b/.stats.yml index 456c477f..94f1f4d5 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-584c2ccf3fc1a3ff3abf26b8d3dace2398d0f9ed6f20e4c411a13a81febb5e98.yml openapi_spec_hash: 14d1614ea3903d6b53f26e135c9cae81 -config_hash: 7e5c039f375ccdba7cf3e61492a273f2 +config_hash: 984f0887e4e3ebc749cd79d0512fea75 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 3f294bd7..b9d2d482 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -139,6 +139,11 @@ require_relative "imagekit/models/interoperability" require_relative "imagekit/models/removedot_bg_extension" require_relative "imagekit/models/thumbnail" +require_relative "imagekit/models/unwrap_webhook_event" +require_relative "imagekit/models/video_transformation_accepted_webhook_event" +require_relative "imagekit/models/video_transformation_error_webhook_event" +require_relative "imagekit/models/video_transformation_ready_webhook_event" +require_relative "imagekit/models/webhook_unwrap_params" require_relative "imagekit/models" require_relative "imagekit/resources/accounts" require_relative "imagekit/resources/accounts/origins" @@ -157,3 +162,4 @@ require_relative "imagekit/resources/files/versions" require_relative "imagekit/resources/folders" require_relative "imagekit/resources/folders/job" +require_relative "imagekit/resources/webhooks" diff --git a/lib/imagekit/client.rb b/lib/imagekit/client.rb index d14fcfbe..e44d7323 100644 --- a/lib/imagekit/client.rb +++ b/lib/imagekit/client.rb @@ -44,6 +44,9 @@ class Client < Imagekit::Internal::Transport::BaseClient # @return [Imagekit::Resources::Beta] attr_reader :beta + # @return [Imagekit::Resources::Webhooks] + attr_reader :webhooks + # @api private # # @return [Hash{String=>String}] @@ -111,6 +114,7 @@ def initialize( @folders = Imagekit::Resources::Folders.new(client: self) @accounts = Imagekit::Resources::Accounts.new(client: self) @beta = Imagekit::Resources::Beta.new(client: self) + @webhooks = Imagekit::Resources::Webhooks.new(client: self) end end end diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb index dba16007..9a0e4a5a 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekit/internal/type/union.rb @@ -6,16 +6,16 @@ module Type # @api private # # @example - # # `origin_create_response` is a `Imagekit::Models::Accounts::OriginCreateResponse` - # case origin_create_response - # when Imagekit::Models::Accounts::OriginCreateResponse::S3 - # puts(origin_create_response.id) - # when Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible - # puts(origin_create_response.bucket) - # when Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup - # puts(origin_create_response.include_canonical_header) + # # `unwrap_webhook_event` is a `Imagekit::UnwrapWebhookEvent` + # case unwrap_webhook_event + # when Imagekit::VideoTransformationAcceptedWebhookEvent + # puts(unwrap_webhook_event.id) + # when Imagekit::VideoTransformationReadyWebhookEvent + # puts(unwrap_webhook_event.created_at) + # when Imagekit::VideoTransformationErrorWebhookEvent + # puts(unwrap_webhook_event.data) # else - # puts(origin_create_response) + # puts(unwrap_webhook_event) # end module Union include Imagekit::Internal::Type::Converter diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index de31b9c5..85b43a4e 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -98,4 +98,14 @@ module Imagekit RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension Thumbnail = Imagekit::Models::Thumbnail + + UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + + VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent + + VideoTransformationErrorWebhookEvent = Imagekit::Models::VideoTransformationErrorWebhookEvent + + VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + + WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams end diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb new file mode 100644 index 00000000..be01dd2a --- /dev/null +++ b/lib/imagekit/models/unwrap_webhook_event.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module UnwrapWebhookEvent + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::VideoTransformationAcceptedWebhookEvent } + + variant -> { Imagekit::VideoTransformationReadyWebhookEvent } + + variant -> { Imagekit::VideoTransformationErrorWebhookEvent } + + # @!method self.variants + # @return [Array(Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent)] + end + end +end diff --git a/lib/imagekit/models/video_transformation_accepted_webhook_event.rb b/lib/imagekit/models/video_transformation_accepted_webhook_event.rb new file mode 100644 index 00000000..d320d09c --- /dev/null +++ b/lib/imagekit/models/video_transformation_accepted_webhook_event.rb @@ -0,0 +1,241 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the event. + # + # @return [String] + required :id, String + + # @!attribute created_at + # + # @return [Time] + required :created_at, Time + + # @!attribute data + # + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data] + required :data, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data } + + # @!attribute request + # + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] + required :request, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Request } + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Type] + required :type, enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Type } + + # @!method initialize(id:, created_at:, data:, request:, type:) + # @param id [String] Unique identifier for the event. + # + # @param created_at [Time] + # + # @param data [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data] + # + # @param request [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] + # + # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Type] + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#data + class Data < Imagekit::Internal::Type::BaseModel + # @!attribute asset + # + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset } + + # @!attribute transformation + # + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation } + + # @!method initialize(asset:, transformation:) + # @param asset [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation] + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data#asset + class Asset < Imagekit::Internal::Type::BaseModel + # @!attribute url + # Source asset URL. + # + # @return [String] + required :url, String + + # @!method initialize(url:) + # @param url [String] Source asset URL. + end + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data#transformation + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type } + + # @!attribute options + # + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options } + + # @!method initialize(type:, options: nil) + # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type] + # @param options [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options] + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation#type + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION = :"video-transformation" + GIF_TO_VIDEO = :"gif-to-video" + VIDEO_THUMBNAIL = :"video-thumbnail" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + optional :audio_codec, + enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec } + + # @!attribute auto_rotate + # + # @return [Boolean, nil] + optional :auto_rotate, Imagekit::Internal::Type::Boolean + + # @!attribute format_ + # + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format, nil] + optional :format_, + enum: -> { + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format + }, + api_name: :format + + # @!attribute quality + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute stream_protocol + # + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + optional :stream_protocol, + enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol } + + # @!attribute variants + # + # @return [Array, nil] + optional :variants, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute video_codec + # + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + optional :video_codec, + enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec } + + # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param auto_rotate [Boolean] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format] + # @param quality [Integer] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param variants [Array] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec] + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#audio_codec + module AudioCodec + extend Imagekit::Internal::Type::Enum + + AAC = :aac + OPUS = :opus + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#format_ + module Format + extend Imagekit::Internal::Type::Enum + + MP4 = :mp4 + WEBM = :webm + JPG = :jpg + PNG = :png + WEBP = :webp + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#stream_protocol + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + HLS = :HLS + DASH = :DASH + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#video_codec + module VideoCodec + extend Imagekit::Internal::Type::Enum + + H264 = :h264 + VP9 = :vp9 + + # @!method self.values + # @return [Array] + end + end + end + end + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#request + class Request < Imagekit::Internal::Type::BaseModel + # @!attribute url + # URL of the submitted request. + # + # @return [String] + required :url, String + + # @!attribute x_request_id + # Unique ID for the originating request. + # + # @return [String] + required :x_request_id, String + + # @!attribute user_agent + # User-Agent header of the originating request. + # + # @return [String, nil] + optional :user_agent, String + + # @!method initialize(url:, x_request_id:, user_agent: nil) + # @param url [String] URL of the submitted request. + # + # @param x_request_id [String] Unique ID for the originating request. + # + # @param user_agent [String] User-Agent header of the originating request. + end + + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#type + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION_ACCEPTED = :"video.transformation.accepted" + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/video_transformation_error_webhook_event.rb b/lib/imagekit/models/video_transformation_error_webhook_event.rb new file mode 100644 index 00000000..5a6f478c --- /dev/null +++ b/lib/imagekit/models/video_transformation_error_webhook_event.rb @@ -0,0 +1,271 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the event. + # + # @return [String] + required :id, String + + # @!attribute created_at + # + # @return [Time] + required :created_at, Time + + # @!attribute data + # + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data] + required :data, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data } + + # @!attribute request + # + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] + required :request, -> { Imagekit::VideoTransformationErrorWebhookEvent::Request } + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Type] + required :type, enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Type } + + # @!method initialize(id:, created_at:, data:, request:, type:) + # @param id [String] Unique identifier for the event. + # + # @param created_at [Time] + # + # @param data [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data] + # + # @param request [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] + # + # @param type [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Type] + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#data + class Data < Imagekit::Internal::Type::BaseModel + # @!attribute asset + # + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset } + + # @!attribute transformation + # + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation } + + # @!method initialize(asset:, transformation:) + # @param asset [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation] + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data#asset + class Asset < Imagekit::Internal::Type::BaseModel + # @!attribute url + # Source asset URL. + # + # @return [String] + required :url, String + + # @!method initialize(url:) + # @param url [String] Source asset URL. + end + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data#transformation + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type } + + # @!attribute error + # + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, nil] + optional :error, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error } + + # @!attribute options + # + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options } + + # @!method initialize(type:, error: nil, options: nil) + # @param type [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Type] + # @param error [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error] + # @param options [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options] + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#type + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION = :"video-transformation" + GIF_TO_VIDEO = :"gif-to-video" + VIDEO_THUMBNAIL = :"video-thumbnail" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#error + class Error < Imagekit::Internal::Type::BaseModel + # @!attribute reason + # + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason] + required :reason, + enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason } + + # @!method initialize(reason:) + # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason] + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error#reason + module Reason + extend Imagekit::Internal::Type::Enum + + ENCODING_FAILED = :encoding_failed + DOWNLOAD_FAILED = :download_failed + INTERNAL_SERVER_ERROR = :internal_server_error + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + optional :audio_codec, + enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec } + + # @!attribute auto_rotate + # + # @return [Boolean, nil] + optional :auto_rotate, Imagekit::Internal::Type::Boolean + + # @!attribute format_ + # + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format, nil] + optional :format_, + enum: -> { + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format + }, + api_name: :format + + # @!attribute quality + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute stream_protocol + # + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + optional :stream_protocol, + enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol } + + # @!attribute variants + # + # @return [Array, nil] + optional :variants, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute video_codec + # + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + optional :video_codec, + enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec } + + # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param auto_rotate [Boolean] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format] + # @param quality [Integer] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param variants [Array] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec] + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#audio_codec + module AudioCodec + extend Imagekit::Internal::Type::Enum + + AAC = :aac + OPUS = :opus + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#format_ + module Format + extend Imagekit::Internal::Type::Enum + + MP4 = :mp4 + WEBM = :webm + JPG = :jpg + PNG = :png + WEBP = :webp + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#stream_protocol + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + HLS = :HLS + DASH = :DASH + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#video_codec + module VideoCodec + extend Imagekit::Internal::Type::Enum + + H264 = :h264 + VP9 = :vp9 + + # @!method self.values + # @return [Array] + end + end + end + end + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#request + class Request < Imagekit::Internal::Type::BaseModel + # @!attribute url + # URL of the submitted request. + # + # @return [String] + required :url, String + + # @!attribute x_request_id + # Unique ID for the originating request. + # + # @return [String] + required :x_request_id, String + + # @!attribute user_agent + # User-Agent header of the originating request. + # + # @return [String, nil] + optional :user_agent, String + + # @!method initialize(url:, x_request_id:, user_agent: nil) + # @param url [String] URL of the submitted request. + # + # @param x_request_id [String] Unique ID for the originating request. + # + # @param user_agent [String] User-Agent header of the originating request. + end + + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#type + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION_ERROR = :"video.transformation.error" + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/video_transformation_ready_webhook_event.rb b/lib/imagekit/models/video_transformation_ready_webhook_event.rb new file mode 100644 index 00000000..39db5f20 --- /dev/null +++ b/lib/imagekit/models/video_transformation_ready_webhook_event.rb @@ -0,0 +1,321 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the event. + # + # @return [String] + required :id, String + + # @!attribute created_at + # + # @return [Time] + required :created_at, Time + + # @!attribute data + # + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data] + required :data, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data } + + # @!attribute request + # + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] + required :request, -> { Imagekit::VideoTransformationReadyWebhookEvent::Request } + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Type] + required :type, enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Type } + + # @!attribute timings + # + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings, nil] + optional :timings, -> { Imagekit::VideoTransformationReadyWebhookEvent::Timings } + + # @!method initialize(id:, created_at:, data:, request:, type:, timings: nil) + # @param id [String] Unique identifier for the event. + # + # @param created_at [Time] + # + # @param data [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data] + # + # @param request [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] + # + # @param type [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Type] + # + # @param timings [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings] + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#data + class Data < Imagekit::Internal::Type::BaseModel + # @!attribute asset + # + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset } + + # @!attribute transformation + # + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation } + + # @!method initialize(asset:, transformation:) + # @param asset [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation] + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data#asset + class Asset < Imagekit::Internal::Type::BaseModel + # @!attribute url + # Source asset URL. + # + # @return [String] + required :url, String + + # @!method initialize(url:) + # @param url [String] Source asset URL. + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data#transformation + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type } + + # @!attribute options + # + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options } + + # @!attribute output + # + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output, nil] + optional :output, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output } + + # @!method initialize(type:, options: nil, output: nil) + # @param type [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Type] + # @param options [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options] + # @param output [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output] + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#type + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION = :"video-transformation" + GIF_TO_VIDEO = :"gif-to-video" + VIDEO_THUMBNAIL = :"video-thumbnail" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + optional :audio_codec, + enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec } + + # @!attribute auto_rotate + # + # @return [Boolean, nil] + optional :auto_rotate, Imagekit::Internal::Type::Boolean + + # @!attribute format_ + # + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format, nil] + optional :format_, + enum: -> { + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format + }, + api_name: :format + + # @!attribute quality + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute stream_protocol + # + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + optional :stream_protocol, + enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol } + + # @!attribute variants + # + # @return [Array, nil] + optional :variants, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute video_codec + # + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + optional :video_codec, + enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec } + + # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param auto_rotate [Boolean] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format] + # @param quality [Integer] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param variants [Array] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec] + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#audio_codec + module AudioCodec + extend Imagekit::Internal::Type::Enum + + AAC = :aac + OPUS = :opus + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#format_ + module Format + extend Imagekit::Internal::Type::Enum + + MP4 = :mp4 + WEBM = :webm + JPG = :jpg + PNG = :png + WEBP = :webp + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#stream_protocol + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + HLS = :HLS + DASH = :DASH + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#video_codec + module VideoCodec + extend Imagekit::Internal::Type::Enum + + H264 = :h264 + VP9 = :vp9 + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#output + class Output < Imagekit::Internal::Type::BaseModel + # @!attribute url + # + # @return [String] + required :url, String + + # @!attribute video_metadata + # + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata, nil] + optional :video_metadata, + -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata } + + # @!method initialize(url:, video_metadata: nil) + # @param url [String] + # @param video_metadata [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata] + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output#video_metadata + class VideoMetadata < Imagekit::Internal::Type::BaseModel + # @!attribute bitrate + # + # @return [Integer] + required :bitrate, Integer + + # @!attribute duration + # + # @return [Float] + required :duration, Float + + # @!attribute height + # + # @return [Integer] + required :height, Integer + + # @!attribute width + # + # @return [Integer] + required :width, Integer + + # @!method initialize(bitrate:, duration:, height:, width:) + # @param bitrate [Integer] + # @param duration [Float] + # @param height [Integer] + # @param width [Integer] + end + end + end + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#request + class Request < Imagekit::Internal::Type::BaseModel + # @!attribute url + # URL of the submitted request. + # + # @return [String] + required :url, String + + # @!attribute x_request_id + # Unique ID for the originating request. + # + # @return [String] + required :x_request_id, String + + # @!attribute user_agent + # User-Agent header of the originating request. + # + # @return [String, nil] + optional :user_agent, String + + # @!method initialize(url:, x_request_id:, user_agent: nil) + # @param url [String] URL of the submitted request. + # + # @param x_request_id [String] Unique ID for the originating request. + # + # @param user_agent [String] User-Agent header of the originating request. + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#type + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION_READY = :"video.transformation.ready" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#timings + class Timings < Imagekit::Internal::Type::BaseModel + # @!attribute download_duration + # Milliseconds spent downloading the source. + # + # @return [Integer, nil] + optional :download_duration, Integer + + # @!attribute encoding_duration + # Milliseconds spent encoding. + # + # @return [Integer, nil] + optional :encoding_duration, Integer + + # @!method initialize(download_duration: nil, encoding_duration: nil) + # @param download_duration [Integer] Milliseconds spent downloading the source. + # + # @param encoding_duration [Integer] Milliseconds spent encoding. + end + end + end +end diff --git a/lib/imagekit/models/webhook_unwrap_params.rb b/lib/imagekit/models/webhook_unwrap_params.rb new file mode 100644 index 00000000..d93a86a9 --- /dev/null +++ b/lib/imagekit/models/webhook_unwrap_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Webhooks#unwrap + class WebhookUnwrapParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/resources/webhooks.rb b/lib/imagekit/resources/webhooks.rb new file mode 100644 index 00000000..74a02ca7 --- /dev/null +++ b/lib/imagekit/resources/webhooks.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekit + module Resources + class Webhooks + # @param payload [String] The raw webhook payload as a string + # + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] + def unwrap(payload) + parsed = JSON.parse(payload, symbolize_names: true) + Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnwrapWebhookEvent, parsed) + end + + # @api private + # + # @param client [Imagekit::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/rbi/imagekit/client.rbi b/rbi/imagekit/client.rbi index 07b9089f..be03b7df 100644 --- a/rbi/imagekit/client.rbi +++ b/rbi/imagekit/client.rbi @@ -39,6 +39,9 @@ module Imagekit sig { returns(Imagekit::Resources::Beta) } attr_reader :beta + sig { returns(Imagekit::Resources::Webhooks) } + attr_reader :webhooks + # @api private sig { override.returns(T::Hash[String, String]) } private def auth_headers diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 17732f16..a485090e 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -64,4 +64,17 @@ module Imagekit RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension Thumbnail = Imagekit::Models::Thumbnail + + UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + + VideoTransformationAcceptedWebhookEvent = + Imagekit::Models::VideoTransformationAcceptedWebhookEvent + + VideoTransformationErrorWebhookEvent = + Imagekit::Models::VideoTransformationErrorWebhookEvent + + VideoTransformationReadyWebhookEvent = + Imagekit::Models::VideoTransformationReadyWebhookEvent + + WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams end diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi new file mode 100644 index 00000000..457c223b --- /dev/null +++ b/rbi/imagekit/models/unwrap_webhook_event.rbi @@ -0,0 +1,22 @@ +# typed: strong + +module Imagekit + module Models + module UnwrapWebhookEvent + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationErrorWebhookEvent + ) + end + + sig { override.returns(T::Array[Imagekit::UnwrapWebhookEvent::Variants]) } + def self.variants + end + end + end +end diff --git a/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi b/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi new file mode 100644 index 00000000..7ffb9501 --- /dev/null +++ b/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi @@ -0,0 +1,644 @@ +# typed: strong + +module Imagekit + module Models + class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the event. + sig { returns(String) } + attr_accessor :id + + sig { returns(Time) } + attr_accessor :created_at + + sig { returns(Imagekit::VideoTransformationAcceptedWebhookEvent::Data) } + attr_reader :data + + sig do + params( + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash + ).void + end + attr_writer :data + + sig do + returns(Imagekit::VideoTransformationAcceptedWebhookEvent::Request) + end + attr_reader :request + + sig do + params( + request: + Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash + ).void + end + attr_writer :request + + sig do + returns( + Imagekit::VideoTransformationAcceptedWebhookEvent::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + id: String, + created_at: Time, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash, + request: + Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash, + type: + Imagekit::VideoTransformationAcceptedWebhookEvent::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the event. + id:, + created_at:, + data:, + request:, + type: + ) + end + + sig do + override.returns( + { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + type: + Imagekit::VideoTransformationAcceptedWebhookEvent::Type::TaggedSymbol + } + ) + end + def to_hash + end + + class Data < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset + ) + end + attr_reader :asset + + sig do + params( + asset: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset::OrHash + ).void + end + attr_writer :asset + + sig do + returns( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + ) + end + attr_reader :transformation + + sig do + params( + transformation: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::OrHash + ).void + end + attr_writer :transformation + + sig do + params( + asset: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset::OrHash, + transformation: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::OrHash + ).returns(T.attached_class) + end + def self.new(asset:, transformation:) + end + + sig do + override.returns( + { + asset: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + transformation: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + } + ) + end + def to_hash + end + + class Asset < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + Imagekit::Internal::AnyHash + ) + end + + # Source asset URL. + sig { returns(String) } + attr_accessor :url + + sig { params(url: String).returns(T.attached_class) } + def self.new( + # Source asset URL. + url: + ) + end + + sig { override.returns({ url: String }) } + def to_hash + end + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + type: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::OrSymbol, + options: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::OrHash + ).returns(T.attached_class) + end + def self.new(type:, options: nil) + end + + sig do + override.returns( + { + type: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol, + options: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VIDEO_TRANSFORMATION = + T.let( + :"video-transformation", + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + GIF_TO_VIDEO = + T.let( + :"gif-to-video", + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + VIDEO_THUMBNAIL = + T.let( + :"video-thumbnail", + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + ) + end + attr_reader :audio_codec + + sig do + params( + audio_codec: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + ).void + end + attr_writer :audio_codec + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :auto_rotate + + sig { params(auto_rotate: T::Boolean).void } + attr_writer :auto_rotate + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + ) + end + attr_reader :format_ + + sig do + params( + format_: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::OrSymbol + ).void + end + attr_writer :format_ + + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + ) + end + attr_reader :stream_protocol + + sig do + params( + stream_protocol: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + ).void + end + attr_writer :stream_protocol + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :variants + + sig { params(variants: T::Array[String]).void } + attr_writer :variants + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + ) + end + attr_reader :video_codec + + sig do + params( + video_codec: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + ).void + end + attr_writer :video_codec + + sig do + params( + audio_codec: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + auto_rotate: T::Boolean, + format_: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + quality: Integer, + stream_protocol: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + variants: T::Array[String], + video_codec: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + ).returns(T.attached_class) + end + def self.new( + audio_codec: nil, + auto_rotate: nil, + format_: nil, + quality: nil, + stream_protocol: nil, + variants: nil, + video_codec: nil + ) + end + + sig do + override.returns( + { + audio_codec: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + auto_rotate: T::Boolean, + format_: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + quality: Integer, + stream_protocol: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + variants: T::Array[String], + video_codec: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + } + ) + end + def to_hash + end + + module AudioCodec + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AAC = + T.let( + :aac, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + OPUS = + T.let( + :opus, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ] + ) + end + def self.values + end + end + + module Format + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + MP4 = + T.let( + :mp4, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + WEBM = + T.let( + :webm, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + JPG = + T.let( + :jpg, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + PNG = + T.let( + :png, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + WEBP = + T.let( + :webp, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ] + ) + end + def self.values + end + end + + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HLS = + T.let( + :HLS, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + DASH = + T.let( + :DASH, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ] + ) + end + def self.values + end + end + + module VideoCodec + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + H264 = + T.let( + :h264, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + VP9 = + T.let( + :vp9, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end + + class Request < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + Imagekit::Internal::AnyHash + ) + end + + # URL of the submitted request. + sig { returns(String) } + attr_accessor :url + + # Unique ID for the originating request. + sig { returns(String) } + attr_accessor :x_request_id + + # User-Agent header of the originating request. + sig { returns(T.nilable(String)) } + attr_reader :user_agent + + sig { params(user_agent: String).void } + attr_writer :user_agent + + sig do + params(url: String, x_request_id: String, user_agent: String).returns( + T.attached_class + ) + end + def self.new( + # URL of the submitted request. + url:, + # Unique ID for the originating request. + x_request_id:, + # User-Agent header of the originating request. + user_agent: nil + ) + end + + sig do + override.returns( + { url: String, x_request_id: String, user_agent: String } + ) + end + def to_hash + end + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VIDEO_TRANSFORMATION_ACCEPTED = + T.let( + :"video.transformation.accepted", + Imagekit::VideoTransformationAcceptedWebhookEvent::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationAcceptedWebhookEvent::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/video_transformation_error_webhook_event.rbi b/rbi/imagekit/models/video_transformation_error_webhook_event.rbi new file mode 100644 index 00000000..1e34479d --- /dev/null +++ b/rbi/imagekit/models/video_transformation_error_webhook_event.rbi @@ -0,0 +1,733 @@ +# typed: strong + +module Imagekit + module Models + class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationErrorWebhookEvent, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the event. + sig { returns(String) } + attr_accessor :id + + sig { returns(Time) } + attr_accessor :created_at + + sig { returns(Imagekit::VideoTransformationErrorWebhookEvent::Data) } + attr_reader :data + + sig do + params( + data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash + ).void + end + attr_writer :data + + sig { returns(Imagekit::VideoTransformationErrorWebhookEvent::Request) } + attr_reader :request + + sig do + params( + request: + Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash + ).void + end + attr_writer :request + + sig do + returns( + Imagekit::VideoTransformationErrorWebhookEvent::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + params( + id: String, + created_at: Time, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash, + request: + Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash, + type: Imagekit::VideoTransformationErrorWebhookEvent::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the event. + id:, + created_at:, + data:, + request:, + type: + ) + end + + sig do + override.returns( + { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data, + request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + type: + Imagekit::VideoTransformationErrorWebhookEvent::Type::TaggedSymbol + } + ) + end + def to_hash + end + + class Data < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationErrorWebhookEvent::Data, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns(Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset) + end + attr_reader :asset + + sig do + params( + asset: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset::OrHash + ).void + end + attr_writer :asset + + sig do + returns( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + ) + end + attr_reader :transformation + + sig do + params( + transformation: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::OrHash + ).void + end + attr_writer :transformation + + sig do + params( + asset: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset::OrHash, + transformation: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::OrHash + ).returns(T.attached_class) + end + def self.new(asset:, transformation:) + end + + sig do + override.returns( + { + asset: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + transformation: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + } + ) + end + def to_hash + end + + class Asset < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + Imagekit::Internal::AnyHash + ) + end + + # Source asset URL. + sig { returns(String) } + attr_accessor :url + + sig { params(url: String).returns(T.attached_class) } + def self.new( + # Source asset URL. + url: + ) + end + + sig { override.returns({ url: String }) } + def to_hash + end + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error + ) + ) + end + attr_reader :error + + sig do + params( + error: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::OrHash + ).void + end + attr_writer :error + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + type: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::OrSymbol, + error: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::OrHash, + options: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::OrHash + ).returns(T.attached_class) + end + def self.new(type:, error: nil, options: nil) + end + + sig do + override.returns( + { + type: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol, + error: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + options: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VIDEO_TRANSFORMATION = + T.let( + :"video-transformation", + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + GIF_TO_VIDEO = + T.let( + :"gif-to-video", + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + VIDEO_THUMBNAIL = + T.let( + :"video-thumbnail", + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Error < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + ) + end + attr_accessor :reason + + sig do + params( + reason: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::OrSymbol + ).returns(T.attached_class) + end + def self.new(reason:) + end + + sig do + override.returns( + { + reason: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + } + ) + end + def to_hash + end + + module Reason + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ENCODING_FAILED = + T.let( + :encoding_failed, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + ) + DOWNLOAD_FAILED = + T.let( + :download_failed, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + ) + INTERNAL_SERVER_ERROR = + T.let( + :internal_server_error, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + ) + end + attr_reader :audio_codec + + sig do + params( + audio_codec: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + ).void + end + attr_writer :audio_codec + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :auto_rotate + + sig { params(auto_rotate: T::Boolean).void } + attr_writer :auto_rotate + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + ) + end + attr_reader :format_ + + sig do + params( + format_: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::OrSymbol + ).void + end + attr_writer :format_ + + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + ) + end + attr_reader :stream_protocol + + sig do + params( + stream_protocol: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + ).void + end + attr_writer :stream_protocol + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :variants + + sig { params(variants: T::Array[String]).void } + attr_writer :variants + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + ) + end + attr_reader :video_codec + + sig do + params( + video_codec: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + ).void + end + attr_writer :video_codec + + sig do + params( + audio_codec: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + auto_rotate: T::Boolean, + format_: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + quality: Integer, + stream_protocol: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + variants: T::Array[String], + video_codec: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + ).returns(T.attached_class) + end + def self.new( + audio_codec: nil, + auto_rotate: nil, + format_: nil, + quality: nil, + stream_protocol: nil, + variants: nil, + video_codec: nil + ) + end + + sig do + override.returns( + { + audio_codec: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + auto_rotate: T::Boolean, + format_: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + quality: Integer, + stream_protocol: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + variants: T::Array[String], + video_codec: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + } + ) + end + def to_hash + end + + module AudioCodec + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AAC = + T.let( + :aac, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + OPUS = + T.let( + :opus, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ] + ) + end + def self.values + end + end + + module Format + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + MP4 = + T.let( + :mp4, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + WEBM = + T.let( + :webm, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + JPG = + T.let( + :jpg, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + PNG = + T.let( + :png, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + WEBP = + T.let( + :webp, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ] + ) + end + def self.values + end + end + + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HLS = + T.let( + :HLS, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + DASH = + T.let( + :DASH, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ] + ) + end + def self.values + end + end + + module VideoCodec + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + H264 = + T.let( + :h264, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + VP9 = + T.let( + :vp9, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end + + class Request < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationErrorWebhookEvent::Request, + Imagekit::Internal::AnyHash + ) + end + + # URL of the submitted request. + sig { returns(String) } + attr_accessor :url + + # Unique ID for the originating request. + sig { returns(String) } + attr_accessor :x_request_id + + # User-Agent header of the originating request. + sig { returns(T.nilable(String)) } + attr_reader :user_agent + + sig { params(user_agent: String).void } + attr_writer :user_agent + + sig do + params(url: String, x_request_id: String, user_agent: String).returns( + T.attached_class + ) + end + def self.new( + # URL of the submitted request. + url:, + # Unique ID for the originating request. + x_request_id:, + # User-Agent header of the originating request. + user_agent: nil + ) + end + + sig do + override.returns( + { url: String, x_request_id: String, user_agent: String } + ) + end + def to_hash + end + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::VideoTransformationErrorWebhookEvent::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VIDEO_TRANSFORMATION_ERROR = + T.let( + :"video.transformation.error", + Imagekit::VideoTransformationErrorWebhookEvent::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationErrorWebhookEvent::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi b/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi new file mode 100644 index 00000000..a98a2c94 --- /dev/null +++ b/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi @@ -0,0 +1,820 @@ +# typed: strong + +module Imagekit + module Models + class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the event. + sig { returns(String) } + attr_accessor :id + + sig { returns(Time) } + attr_accessor :created_at + + sig { returns(Imagekit::VideoTransformationReadyWebhookEvent::Data) } + attr_reader :data + + sig do + params( + data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash + ).void + end + attr_writer :data + + sig { returns(Imagekit::VideoTransformationReadyWebhookEvent::Request) } + attr_reader :request + + sig do + params( + request: + Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash + ).void + end + attr_writer :request + + sig do + returns( + Imagekit::VideoTransformationReadyWebhookEvent::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + returns( + T.nilable(Imagekit::VideoTransformationReadyWebhookEvent::Timings) + ) + end + attr_reader :timings + + sig do + params( + timings: + Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash + ).void + end + attr_writer :timings + + sig do + params( + id: String, + created_at: Time, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash, + request: + Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash, + type: Imagekit::VideoTransformationReadyWebhookEvent::Type::OrSymbol, + timings: + Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the event. + id:, + created_at:, + data:, + request:, + type:, + timings: nil + ) + end + + sig do + override.returns( + { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data, + request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + type: + Imagekit::VideoTransformationReadyWebhookEvent::Type::TaggedSymbol, + timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + } + ) + end + def to_hash + end + + class Data < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent::Data, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns(Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset) + end + attr_reader :asset + + sig do + params( + asset: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset::OrHash + ).void + end + attr_writer :asset + + sig do + returns( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + ) + end + attr_reader :transformation + + sig do + params( + transformation: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::OrHash + ).void + end + attr_writer :transformation + + sig do + params( + asset: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset::OrHash, + transformation: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::OrHash + ).returns(T.attached_class) + end + def self.new(asset:, transformation:) + end + + sig do + override.returns( + { + asset: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + transformation: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + } + ) + end + def to_hash + end + + class Asset < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + Imagekit::Internal::AnyHash + ) + end + + # Source asset URL. + sig { returns(String) } + attr_accessor :url + + sig { params(url: String).returns(T.attached_class) } + def self.new( + # Source asset URL. + url: + ) + end + + sig { override.returns({ url: String }) } + def to_hash + end + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + end + attr_accessor :type + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::OrHash + ).void + end + attr_writer :options + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + ) + ) + end + attr_reader :output + + sig do + params( + output: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::OrHash + ).void + end + attr_writer :output + + sig do + params( + type: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::OrSymbol, + options: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::OrHash, + output: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::OrHash + ).returns(T.attached_class) + end + def self.new(type:, options: nil, output: nil) + end + + sig do + override.returns( + { + type: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol, + options: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + output: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VIDEO_TRANSFORMATION = + T.let( + :"video-transformation", + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + GIF_TO_VIDEO = + T.let( + :"gif-to-video", + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + VIDEO_THUMBNAIL = + T.let( + :"video-thumbnail", + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + ) + end + attr_reader :audio_codec + + sig do + params( + audio_codec: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + ).void + end + attr_writer :audio_codec + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :auto_rotate + + sig { params(auto_rotate: T::Boolean).void } + attr_writer :auto_rotate + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + ) + end + attr_reader :format_ + + sig do + params( + format_: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::OrSymbol + ).void + end + attr_writer :format_ + + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + ) + end + attr_reader :stream_protocol + + sig do + params( + stream_protocol: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + ).void + end + attr_writer :stream_protocol + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :variants + + sig { params(variants: T::Array[String]).void } + attr_writer :variants + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + ) + end + attr_reader :video_codec + + sig do + params( + video_codec: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + ).void + end + attr_writer :video_codec + + sig do + params( + audio_codec: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + auto_rotate: T::Boolean, + format_: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + quality: Integer, + stream_protocol: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + variants: T::Array[String], + video_codec: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + ).returns(T.attached_class) + end + def self.new( + audio_codec: nil, + auto_rotate: nil, + format_: nil, + quality: nil, + stream_protocol: nil, + variants: nil, + video_codec: nil + ) + end + + sig do + override.returns( + { + audio_codec: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + auto_rotate: T::Boolean, + format_: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + quality: Integer, + stream_protocol: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + variants: T::Array[String], + video_codec: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + } + ) + end + def to_hash + end + + module AudioCodec + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AAC = + T.let( + :aac, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + OPUS = + T.let( + :opus, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + ] + ) + end + def self.values + end + end + + module Format + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + MP4 = + T.let( + :mp4, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + WEBM = + T.let( + :webm, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + JPG = + T.let( + :jpg, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + PNG = + T.let( + :png, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + WEBP = + T.let( + :webp, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + ] + ) + end + def self.values + end + end + + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HLS = + T.let( + :HLS, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + DASH = + T.let( + :DASH, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + ] + ) + end + def self.values + end + end + + module VideoCodec + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + H264 = + T.let( + :h264, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + VP9 = + T.let( + :vp9, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class Output < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :url + + sig do + returns( + T.nilable( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + ) + ) + end + attr_reader :video_metadata + + sig do + params( + video_metadata: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata::OrHash + ).void + end + attr_writer :video_metadata + + sig do + params( + url: String, + video_metadata: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata::OrHash + ).returns(T.attached_class) + end + def self.new(url:, video_metadata: nil) + end + + sig do + override.returns( + { + url: String, + video_metadata: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + } + ) + end + def to_hash + end + + class VideoMetadata < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(Integer) } + attr_accessor :bitrate + + sig { returns(Float) } + attr_accessor :duration + + sig { returns(Integer) } + attr_accessor :height + + sig { returns(Integer) } + attr_accessor :width + + sig do + params( + bitrate: Integer, + duration: Float, + height: Integer, + width: Integer + ).returns(T.attached_class) + end + def self.new(bitrate:, duration:, height:, width:) + end + + sig do + override.returns( + { + bitrate: Integer, + duration: Float, + height: Integer, + width: Integer + } + ) + end + def to_hash + end + end + end + end + end + + class Request < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent::Request, + Imagekit::Internal::AnyHash + ) + end + + # URL of the submitted request. + sig { returns(String) } + attr_accessor :url + + # Unique ID for the originating request. + sig { returns(String) } + attr_accessor :x_request_id + + # User-Agent header of the originating request. + sig { returns(T.nilable(String)) } + attr_reader :user_agent + + sig { params(user_agent: String).void } + attr_writer :user_agent + + sig do + params(url: String, x_request_id: String, user_agent: String).returns( + T.attached_class + ) + end + def self.new( + # URL of the submitted request. + url:, + # Unique ID for the originating request. + x_request_id:, + # User-Agent header of the originating request. + user_agent: nil + ) + end + + sig do + override.returns( + { url: String, x_request_id: String, user_agent: String } + ) + end + def to_hash + end + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::VideoTransformationReadyWebhookEvent::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VIDEO_TRANSFORMATION_READY = + T.let( + :"video.transformation.ready", + Imagekit::VideoTransformationReadyWebhookEvent::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::VideoTransformationReadyWebhookEvent::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Timings < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::VideoTransformationReadyWebhookEvent::Timings, + Imagekit::Internal::AnyHash + ) + end + + # Milliseconds spent downloading the source. + sig { returns(T.nilable(Integer)) } + attr_reader :download_duration + + sig { params(download_duration: Integer).void } + attr_writer :download_duration + + # Milliseconds spent encoding. + sig { returns(T.nilable(Integer)) } + attr_reader :encoding_duration + + sig { params(encoding_duration: Integer).void } + attr_writer :encoding_duration + + sig do + params( + download_duration: Integer, + encoding_duration: Integer + ).returns(T.attached_class) + end + def self.new( + # Milliseconds spent downloading the source. + download_duration: nil, + # Milliseconds spent encoding. + encoding_duration: nil + ) + end + + sig do + override.returns( + { download_duration: Integer, encoding_duration: Integer } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/webhook_unwrap_params.rbi b/rbi/imagekit/models/webhook_unwrap_params.rbi new file mode 100644 index 00000000..b3db3d7b --- /dev/null +++ b/rbi/imagekit/models/webhook_unwrap_params.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekit + module Models + class WebhookUnwrapParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekit::WebhookUnwrapParams, Imagekit::Internal::AnyHash) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/resources/webhooks.rbi b/rbi/imagekit/resources/webhooks.rbi new file mode 100644 index 00000000..fb943264 --- /dev/null +++ b/rbi/imagekit/resources/webhooks.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekit + module Resources + class Webhooks + sig do + params(payload: String).returns( + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationErrorWebhookEvent + ) + ) + end + def unwrap( + # The raw webhook payload as a string + payload + ) + end + + # @api private + sig { params(client: Imagekit::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/sig/imagekit/client.rbs b/sig/imagekit/client.rbs index a2b509d3..5e7f6ff8 100644 --- a/sig/imagekit/client.rbs +++ b/sig/imagekit/client.rbs @@ -26,6 +26,8 @@ module Imagekit attr_reader beta: Imagekit::Resources::Beta + attr_reader webhooks: Imagekit::Resources::Webhooks + private def auth_headers: -> ::Hash[String, String] def base_url_overridden?: -> bool diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 26410ac4..fd98f8ce 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -58,4 +58,14 @@ module Imagekit class RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension class Thumbnail = Imagekit::Models::Thumbnail + + module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + + class VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent + + class VideoTransformationErrorWebhookEvent = Imagekit::Models::VideoTransformationErrorWebhookEvent + + class VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + + class WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams end diff --git a/sig/imagekit/models/unwrap_webhook_event.rbs b/sig/imagekit/models/unwrap_webhook_event.rbs new file mode 100644 index 00000000..b9101a5f --- /dev/null +++ b/sig/imagekit/models/unwrap_webhook_event.rbs @@ -0,0 +1,14 @@ +module Imagekit + module Models + type unwrap_webhook_event = + Imagekit::VideoTransformationAcceptedWebhookEvent + | Imagekit::VideoTransformationReadyWebhookEvent + | Imagekit::VideoTransformationErrorWebhookEvent + + module UnwrapWebhookEvent + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::unwrap_webhook_event] + end + end +end diff --git a/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs b/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs new file mode 100644 index 00000000..de9ee101 --- /dev/null +++ b/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs @@ -0,0 +1,261 @@ +module Imagekit + module Models + type video_transformation_accepted_webhook_event = + { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_ + } + + class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor created_at: Time + + attr_accessor data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data + + attr_accessor request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request + + attr_accessor type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_ + + def initialize: ( + id: String, + created_at: Time, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_ + ) -> void + + def to_hash: -> { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_ + } + + type data = + { + asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + } + + class Data < Imagekit::Internal::Type::BaseModel + attr_accessor asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset + + attr_accessor transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + + def initialize: ( + asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + ) -> void + + def to_hash: -> { + asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + } + + type asset = { url: String } + + class Asset < Imagekit::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + + type transformation = + { + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_ + + attr_reader options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options? + + def options=: ( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + + def initialize: ( + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, + ?options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + ) -> void + + def to_hash: -> { + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + } + + type type_ = + :"video-transformation" | :"gif-to-video" | :"video-thumbnail" + + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION: :"video-transformation" + GIF_TO_VIDEO: :"gif-to-video" + VIDEO_THUMBNAIL: :"video-thumbnail" + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_] + end + + type options = + { + audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec? + + def audio_codec=: ( + Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec + + attr_reader auto_rotate: bool? + + def auto_rotate=: (bool) -> bool + + attr_reader format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_? + + def format_=: ( + Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_ + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol? + + def stream_protocol=: ( + Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol + + attr_reader variants: ::Array[String]? + + def variants=: (::Array[String]) -> ::Array[String] + + attr_reader video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec? + + def video_codec=: ( + Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + + def initialize: ( + ?audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + ?auto_rotate: bool, + ?format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + ?quality: Integer, + ?stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + ?variants: ::Array[String], + ?video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + ) -> void + + def to_hash: -> { + audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + } + + type audio_codec = :aac | :opus + + module AudioCodec + extend Imagekit::Internal::Type::Enum + + AAC: :aac + OPUS: :opus + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec] + end + + type format_ = :mp4 | :webm | :jpg | :png | :webp + + module Format + extend Imagekit::Internal::Type::Enum + + MP4: :mp4 + WEBM: :webm + JPG: :jpg + PNG: :png + WEBP: :webp + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_] + end + + type stream_protocol = :HLS | :DASH + + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + HLS: :HLS + DASH: :DASH + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol] + end + + type video_codec = :h264 | :vp9 + + module VideoCodec + extend Imagekit::Internal::Type::Enum + + H264: :h264 + VP9: :vp9 + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec] + end + end + end + end + + type request = { url: String, x_request_id: String, user_agent: String } + + class Request < Imagekit::Internal::Type::BaseModel + attr_accessor url: String + + attr_accessor x_request_id: String + + attr_reader user_agent: String? + + def user_agent=: (String) -> String + + def initialize: ( + url: String, + x_request_id: String, + ?user_agent: String + ) -> void + + def to_hash: -> { + url: String, + x_request_id: String, + user_agent: String + } + end + + type type_ = :"video.transformation.accepted" + + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION_ACCEPTED: :"video.transformation.accepted" + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_] + end + end + end +end diff --git a/sig/imagekit/models/video_transformation_error_webhook_event.rbs b/sig/imagekit/models/video_transformation_error_webhook_event.rbs new file mode 100644 index 00000000..48939423 --- /dev/null +++ b/sig/imagekit/models/video_transformation_error_webhook_event.rbs @@ -0,0 +1,300 @@ +module Imagekit + module Models + type video_transformation_error_webhook_event = + { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data, + request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::type_ + } + + class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor created_at: Time + + attr_accessor data: Imagekit::VideoTransformationErrorWebhookEvent::Data + + attr_accessor request: Imagekit::VideoTransformationErrorWebhookEvent::Request + + attr_accessor type: Imagekit::Models::VideoTransformationErrorWebhookEvent::type_ + + def initialize: ( + id: String, + created_at: Time, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data, + request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::type_ + ) -> void + + def to_hash: -> { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data, + request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::type_ + } + + type data = + { + asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + } + + class Data < Imagekit::Internal::Type::BaseModel + attr_accessor asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset + + attr_accessor transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + + def initialize: ( + asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + ) -> void + + def to_hash: -> { + asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + } + + type asset = { url: String } + + class Asset < Imagekit::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + + type transformation = + { + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, + error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_ + + attr_reader error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error? + + def error=: ( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error + ) -> Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error + + attr_reader options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options? + + def options=: ( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + + def initialize: ( + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, + ?error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + ?options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + ) -> void + + def to_hash: -> { + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, + error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + } + + type type_ = + :"video-transformation" | :"gif-to-video" | :"video-thumbnail" + + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION: :"video-transformation" + GIF_TO_VIDEO: :"gif-to-video" + VIDEO_THUMBNAIL: :"video-thumbnail" + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_] + end + + type error = + { + reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + } + + class Error < Imagekit::Internal::Type::BaseModel + attr_accessor reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + + def initialize: ( + reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + ) -> void + + def to_hash: -> { + reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + } + + type reason = + :encoding_failed | :download_failed | :internal_server_error + + module Reason + extend Imagekit::Internal::Type::Enum + + ENCODING_FAILED: :encoding_failed + DOWNLOAD_FAILED: :download_failed + INTERNAL_SERVER_ERROR: :internal_server_error + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason] + end + end + + type options = + { + audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec? + + def audio_codec=: ( + Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec + + attr_reader auto_rotate: bool? + + def auto_rotate=: (bool) -> bool + + attr_reader format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_? + + def format_=: ( + Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_ + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol? + + def stream_protocol=: ( + Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol + + attr_reader variants: ::Array[String]? + + def variants=: (::Array[String]) -> ::Array[String] + + attr_reader video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec? + + def video_codec=: ( + Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + + def initialize: ( + ?audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + ?auto_rotate: bool, + ?format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + ?quality: Integer, + ?stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + ?variants: ::Array[String], + ?video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + ) -> void + + def to_hash: -> { + audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + } + + type audio_codec = :aac | :opus + + module AudioCodec + extend Imagekit::Internal::Type::Enum + + AAC: :aac + OPUS: :opus + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec] + end + + type format_ = :mp4 | :webm | :jpg | :png | :webp + + module Format + extend Imagekit::Internal::Type::Enum + + MP4: :mp4 + WEBM: :webm + JPG: :jpg + PNG: :png + WEBP: :webp + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_] + end + + type stream_protocol = :HLS | :DASH + + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + HLS: :HLS + DASH: :DASH + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol] + end + + type video_codec = :h264 | :vp9 + + module VideoCodec + extend Imagekit::Internal::Type::Enum + + H264: :h264 + VP9: :vp9 + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec] + end + end + end + end + + type request = { url: String, x_request_id: String, user_agent: String } + + class Request < Imagekit::Internal::Type::BaseModel + attr_accessor url: String + + attr_accessor x_request_id: String + + attr_reader user_agent: String? + + def user_agent=: (String) -> String + + def initialize: ( + url: String, + x_request_id: String, + ?user_agent: String + ) -> void + + def to_hash: -> { + url: String, + x_request_id: String, + user_agent: String + } + end + + type type_ = :"video.transformation.error" + + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION_ERROR: :"video.transformation.error" + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::type_] + end + end + end +end diff --git a/sig/imagekit/models/video_transformation_ready_webhook_event.rbs b/sig/imagekit/models/video_transformation_ready_webhook_event.rbs new file mode 100644 index 00000000..7cc3b772 --- /dev/null +++ b/sig/imagekit/models/video_transformation_ready_webhook_event.rbs @@ -0,0 +1,359 @@ +module Imagekit + module Models + type video_transformation_ready_webhook_event = + { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data, + request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::type_, + timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + } + + class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor created_at: Time + + attr_accessor data: Imagekit::VideoTransformationReadyWebhookEvent::Data + + attr_accessor request: Imagekit::VideoTransformationReadyWebhookEvent::Request + + attr_accessor type: Imagekit::Models::VideoTransformationReadyWebhookEvent::type_ + + attr_reader timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings? + + def timings=: ( + Imagekit::VideoTransformationReadyWebhookEvent::Timings + ) -> Imagekit::VideoTransformationReadyWebhookEvent::Timings + + def initialize: ( + id: String, + created_at: Time, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data, + request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::type_, + ?timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + ) -> void + + def to_hash: -> { + id: String, + created_at: Time, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data, + request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::type_, + timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + } + + type data = + { + asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + } + + class Data < Imagekit::Internal::Type::BaseModel + attr_accessor asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset + + attr_accessor transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + + def initialize: ( + asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + ) -> void + + def to_hash: -> { + asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + } + + type asset = { url: String } + + class Asset < Imagekit::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + + type transformation = + { + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_ + + attr_reader options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options? + + def options=: ( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options + + attr_reader output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output? + + def output=: ( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + + def initialize: ( + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, + ?options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + ?output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + ) -> void + + def to_hash: -> { + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + } + + type type_ = + :"video-transformation" | :"gif-to-video" | :"video-thumbnail" + + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION: :"video-transformation" + GIF_TO_VIDEO: :"gif-to-video" + VIDEO_THUMBNAIL: :"video-thumbnail" + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_] + end + + type options = + { + audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec? + + def audio_codec=: ( + Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec + + attr_reader auto_rotate: bool? + + def auto_rotate=: (bool) -> bool + + attr_reader format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_? + + def format_=: ( + Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_ + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol? + + def stream_protocol=: ( + Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol + + attr_reader variants: ::Array[String]? + + def variants=: (::Array[String]) -> ::Array[String] + + attr_reader video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec? + + def video_codec=: ( + Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + + def initialize: ( + ?audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + ?auto_rotate: bool, + ?format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + ?quality: Integer, + ?stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + ?variants: ::Array[String], + ?video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + ) -> void + + def to_hash: -> { + audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + } + + type audio_codec = :aac | :opus + + module AudioCodec + extend Imagekit::Internal::Type::Enum + + AAC: :aac + OPUS: :opus + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec] + end + + type format_ = :mp4 | :webm | :jpg | :png | :webp + + module Format + extend Imagekit::Internal::Type::Enum + + MP4: :mp4 + WEBM: :webm + JPG: :jpg + PNG: :png + WEBP: :webp + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_] + end + + type stream_protocol = :HLS | :DASH + + module StreamProtocol + extend Imagekit::Internal::Type::Enum + + HLS: :HLS + DASH: :DASH + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol] + end + + type video_codec = :h264 | :vp9 + + module VideoCodec + extend Imagekit::Internal::Type::Enum + + H264: :h264 + VP9: :vp9 + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec] + end + end + + type output = + { + url: String, + video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + } + + class Output < Imagekit::Internal::Type::BaseModel + attr_accessor url: String + + attr_reader video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata? + + def video_metadata=: ( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + + def initialize: ( + url: String, + ?video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + ) -> void + + def to_hash: -> { + url: String, + video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + } + + type video_metadata = + { + bitrate: Integer, + duration: Float, + height: Integer, + width: Integer + } + + class VideoMetadata < Imagekit::Internal::Type::BaseModel + attr_accessor bitrate: Integer + + attr_accessor duration: Float + + attr_accessor height: Integer + + attr_accessor width: Integer + + def initialize: ( + bitrate: Integer, + duration: Float, + height: Integer, + width: Integer + ) -> void + + def to_hash: -> { + bitrate: Integer, + duration: Float, + height: Integer, + width: Integer + } + end + end + end + end + + type request = { url: String, x_request_id: String, user_agent: String } + + class Request < Imagekit::Internal::Type::BaseModel + attr_accessor url: String + + attr_accessor x_request_id: String + + attr_reader user_agent: String? + + def user_agent=: (String) -> String + + def initialize: ( + url: String, + x_request_id: String, + ?user_agent: String + ) -> void + + def to_hash: -> { + url: String, + x_request_id: String, + user_agent: String + } + end + + type type_ = :"video.transformation.ready" + + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO_TRANSFORMATION_READY: :"video.transformation.ready" + + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::type_] + end + + type timings = { download_duration: Integer, encoding_duration: Integer } + + class Timings < Imagekit::Internal::Type::BaseModel + attr_reader download_duration: Integer? + + def download_duration=: (Integer) -> Integer + + attr_reader encoding_duration: Integer? + + def encoding_duration=: (Integer) -> Integer + + def initialize: ( + ?download_duration: Integer, + ?encoding_duration: Integer + ) -> void + + def to_hash: -> { + download_duration: Integer, + encoding_duration: Integer + } + end + end + end +end diff --git a/sig/imagekit/models/webhook_unwrap_params.rbs b/sig/imagekit/models/webhook_unwrap_params.rbs new file mode 100644 index 00000000..e321d3b5 --- /dev/null +++ b/sig/imagekit/models/webhook_unwrap_params.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type webhook_unwrap_params = + { } & Imagekit::Internal::Type::request_parameters + + class WebhookUnwrapParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end +end diff --git a/sig/imagekit/resources/webhooks.rbs b/sig/imagekit/resources/webhooks.rbs new file mode 100644 index 00000000..2f752968 --- /dev/null +++ b/sig/imagekit/resources/webhooks.rbs @@ -0,0 +1,13 @@ +module Imagekit + module Resources + class Webhooks + def unwrap: ( + String payload + ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent + | Imagekit::VideoTransformationReadyWebhookEvent + | Imagekit::VideoTransformationErrorWebhookEvent) + + def initialize: (client: Imagekit::Client) -> void + end + end +end diff --git a/test/imagekit/resources/webhooks_test.rb b/test/imagekit/resources/webhooks_test.rb new file mode 100644 index 00000000..2b78db80 --- /dev/null +++ b/test/imagekit/resources/webhooks_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::WebhooksTest < Imagekit::Test::ResourceTest +end From 4066c5c881b8ad6aea679e6a837b720a7653fdbd Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 07:46:49 +0000 Subject: [PATCH 008/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 5 ++++ lib/imagekit/internal/type/union.rb | 12 ++++---- lib/imagekit/models.rb | 4 +++ .../models/unsafe_unwrap_webhook_event.rb | 18 +++++++++++ .../models/webhook_unsafe_unwrap_params.rb | 14 +++++++++ lib/imagekit/resources/webhooks.rb | 8 +++++ rbi/imagekit/models.rbi | 4 +++ .../models/unsafe_unwrap_webhook_event.rbi | 24 +++++++++++++++ .../models/webhook_unsafe_unwrap_params.rbi | 30 +++++++++++++++++++ rbi/imagekit/resources/webhooks.rbi | 15 ++++++++++ sig/imagekit/models.rbs | 4 +++ .../models/unsafe_unwrap_webhook_event.rbs | 14 +++++++++ .../models/webhook_unsafe_unwrap_params.rbs | 15 ++++++++++ sig/imagekit/resources/webhooks.rbs | 6 ++++ 15 files changed, 168 insertions(+), 7 deletions(-) create mode 100644 lib/imagekit/models/unsafe_unwrap_webhook_event.rb create mode 100644 lib/imagekit/models/webhook_unsafe_unwrap_params.rb create mode 100644 rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi create mode 100644 rbi/imagekit/models/webhook_unsafe_unwrap_params.rbi create mode 100644 sig/imagekit/models/unsafe_unwrap_webhook_event.rbs create mode 100644 sig/imagekit/models/webhook_unsafe_unwrap_params.rbs diff --git a/.stats.yml b/.stats.yml index 94f1f4d5..ede64f59 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-584c2ccf3fc1a3ff3abf26b8d3dace2398d0f9ed6f20e4c411a13a81febb5e98.yml openapi_spec_hash: 14d1614ea3903d6b53f26e135c9cae81 -config_hash: 984f0887e4e3ebc749cd79d0512fea75 +config_hash: 9f3c729a01b07940df835ef5ec13119a diff --git a/lib/imagekit.rb b/lib/imagekit.rb index b9d2d482..7375e99d 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -139,10 +139,15 @@ require_relative "imagekit/models/interoperability" require_relative "imagekit/models/removedot_bg_extension" require_relative "imagekit/models/thumbnail" +require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" require_relative "imagekit/models/video_transformation_accepted_webhook_event" +require_relative "imagekit/models/video_transformation_accepted_webhook_event" +require_relative "imagekit/models/video_transformation_error_webhook_event" require_relative "imagekit/models/video_transformation_error_webhook_event" require_relative "imagekit/models/video_transformation_ready_webhook_event" +require_relative "imagekit/models/video_transformation_ready_webhook_event" +require_relative "imagekit/models/webhook_unsafe_unwrap_params" require_relative "imagekit/models/webhook_unwrap_params" require_relative "imagekit/models" require_relative "imagekit/resources/accounts" diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb index 9a0e4a5a..bd79904f 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekit/internal/type/union.rb @@ -6,16 +6,16 @@ module Type # @api private # # @example - # # `unwrap_webhook_event` is a `Imagekit::UnwrapWebhookEvent` - # case unwrap_webhook_event + # # `unsafe_unwrap_webhook_event` is a `Imagekit::UnsafeUnwrapWebhookEvent` + # case unsafe_unwrap_webhook_event # when Imagekit::VideoTransformationAcceptedWebhookEvent - # puts(unwrap_webhook_event.id) + # puts(unsafe_unwrap_webhook_event.id) # when Imagekit::VideoTransformationReadyWebhookEvent - # puts(unwrap_webhook_event.created_at) + # puts(unsafe_unwrap_webhook_event.created_at) # when Imagekit::VideoTransformationErrorWebhookEvent - # puts(unwrap_webhook_event.data) + # puts(unsafe_unwrap_webhook_event.data) # else - # puts(unwrap_webhook_event) + # puts(unsafe_unwrap_webhook_event) # end module Union include Imagekit::Internal::Type::Converter diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 85b43a4e..5edf6927 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -99,6 +99,8 @@ module Imagekit Thumbnail = Imagekit::Models::Thumbnail + UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent + UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent @@ -107,5 +109,7 @@ module Imagekit VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams + WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams end diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb new file mode 100644 index 00000000..5b7cab93 --- /dev/null +++ b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module UnsafeUnwrapWebhookEvent + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::VideoTransformationAcceptedWebhookEvent } + + variant -> { Imagekit::VideoTransformationReadyWebhookEvent } + + variant -> { Imagekit::VideoTransformationErrorWebhookEvent } + + # @!method self.variants + # @return [Array(Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent)] + end + end +end diff --git a/lib/imagekit/models/webhook_unsafe_unwrap_params.rb b/lib/imagekit/models/webhook_unsafe_unwrap_params.rb new file mode 100644 index 00000000..15530402 --- /dev/null +++ b/lib/imagekit/models/webhook_unsafe_unwrap_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Webhooks#unsafe_unwrap + class WebhookUnsafeUnwrapParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/resources/webhooks.rb b/lib/imagekit/resources/webhooks.rb index 74a02ca7..4c50cd1b 100644 --- a/lib/imagekit/resources/webhooks.rb +++ b/lib/imagekit/resources/webhooks.rb @@ -3,6 +3,14 @@ module Imagekit module Resources class Webhooks + # @param payload [String] The raw webhook payload as a string + # + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] + def unsafe_unwrap(payload) + parsed = JSON.parse(payload, symbolize_names: true) + Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnsafeUnwrapWebhookEvent, parsed) + end + # @param payload [String] The raw webhook payload as a string # # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index a485090e..8671d608 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -65,6 +65,8 @@ module Imagekit Thumbnail = Imagekit::Models::Thumbnail + UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent + UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent VideoTransformationAcceptedWebhookEvent = @@ -76,5 +78,7 @@ module Imagekit VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams + WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams end diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi new file mode 100644 index 00000000..d9881aea --- /dev/null +++ b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi @@ -0,0 +1,24 @@ +# typed: strong + +module Imagekit + module Models + module UnsafeUnwrapWebhookEvent + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationErrorWebhookEvent + ) + end + + sig do + override.returns(T::Array[Imagekit::UnsafeUnwrapWebhookEvent::Variants]) + end + def self.variants + end + end + end +end diff --git a/rbi/imagekit/models/webhook_unsafe_unwrap_params.rbi b/rbi/imagekit/models/webhook_unsafe_unwrap_params.rbi new file mode 100644 index 00000000..60cbea60 --- /dev/null +++ b/rbi/imagekit/models/webhook_unsafe_unwrap_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Imagekit + module Models + class WebhookUnsafeUnwrapParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekit::WebhookUnsafeUnwrapParams, + Imagekit::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekit::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/resources/webhooks.rbi b/rbi/imagekit/resources/webhooks.rbi index fb943264..dbb2ddc0 100644 --- a/rbi/imagekit/resources/webhooks.rbi +++ b/rbi/imagekit/resources/webhooks.rbi @@ -3,6 +3,21 @@ module Imagekit module Resources class Webhooks + sig do + params(payload: String).returns( + T.any( + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationErrorWebhookEvent + ) + ) + end + def unsafe_unwrap( + # The raw webhook payload as a string + payload + ) + end + sig do params(payload: String).returns( T.any( diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index fd98f8ce..39772157 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -59,6 +59,8 @@ module Imagekit class Thumbnail = Imagekit::Models::Thumbnail + module UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent + module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent class VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent @@ -67,5 +69,7 @@ module Imagekit class VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + class WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams + class WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams end diff --git a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs new file mode 100644 index 00000000..04a9fefb --- /dev/null +++ b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs @@ -0,0 +1,14 @@ +module Imagekit + module Models + type unsafe_unwrap_webhook_event = + Imagekit::VideoTransformationAcceptedWebhookEvent + | Imagekit::VideoTransformationReadyWebhookEvent + | Imagekit::VideoTransformationErrorWebhookEvent + + module UnsafeUnwrapWebhookEvent + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::unsafe_unwrap_webhook_event] + end + end +end diff --git a/sig/imagekit/models/webhook_unsafe_unwrap_params.rbs b/sig/imagekit/models/webhook_unsafe_unwrap_params.rbs new file mode 100644 index 00000000..6b7b0859 --- /dev/null +++ b/sig/imagekit/models/webhook_unsafe_unwrap_params.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type webhook_unsafe_unwrap_params = + { } & Imagekit::Internal::Type::request_parameters + + class WebhookUnsafeUnwrapParams < Imagekit::Internal::Type::BaseModel + extend Imagekit::Internal::Type::RequestParameters::Converter + include Imagekit::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekit::request_opts) -> void + + def to_hash: -> { request_options: Imagekit::RequestOptions } + end + end +end diff --git a/sig/imagekit/resources/webhooks.rbs b/sig/imagekit/resources/webhooks.rbs index 2f752968..703798fe 100644 --- a/sig/imagekit/resources/webhooks.rbs +++ b/sig/imagekit/resources/webhooks.rbs @@ -1,6 +1,12 @@ module Imagekit module Resources class Webhooks + def unsafe_unwrap: ( + String payload + ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent + | Imagekit::VideoTransformationReadyWebhookEvent + | Imagekit::VideoTransformationErrorWebhookEvent) + def unwrap: ( String payload ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent From 5f53d9862a11496619dc0f1bba6e171930d46e97 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 07:59:56 +0000 Subject: [PATCH 009/178] feat(api): manual updates --- .stats.yml | 2 +- README.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.stats.yml b/.stats.yml index ede64f59..980c9061 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-584c2ccf3fc1a3ff3abf26b8d3dace2398d0f9ed6f20e4c411a13a81febb5e98.yml openapi_spec_hash: 14d1614ea3903d6b53f26e135c9cae81 -config_hash: 9f3c729a01b07940df835ef5ec13119a +config_hash: 91beba074bbcedbfda383cf006796fa1 diff --git a/README.md b/README.md index 35b67f2e..7ef0c91b 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ image_kit = Imagekit::Client.new( password: ENV["ORG_MY_PASSWORD_TOKEN"] # This is the default and can be omitted ) -response = image_kit.files.upload(file_name: "fileName") +response = image_kit.files.upload(file_name: "file-name.jpg") puts(response.videoCodec) ``` @@ -62,7 +62,7 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload(file_name: "fileName") + file = image_kit.files.upload(file_name: "file-name.jpg") rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -105,7 +105,7 @@ image_kit = Imagekit::Client.new( ) # Or, configure per-request: -image_kit.files.upload(file_name: "fileName", request_options: {max_retries: 5}) +image_kit.files.upload(file_name: "file-name.jpg", request_options: {max_retries: 5}) ``` ### Timeouts @@ -119,7 +119,7 @@ image_kit = Imagekit::Client.new( ) # Or, configure per-request: -image_kit.files.upload(file_name: "fileName", request_options: {timeout: 5}) +image_kit.files.upload(file_name: "file-name.jpg", request_options: {timeout: 5}) ``` On timeout, `Imagekit::Errors::APITimeoutError` is raised. @@ -151,7 +151,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file_name: "fileName", + file_name: "file-name.jpg", request_options: { extra_query: {my_query_parameter: value}, extra_body: {my_body_parameter: value}, @@ -197,17 +197,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload(file_name: "fileName") +image_kit.files.upload(file_name: "file-name.jpg") ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload(file_name: "fileName") +image_kit.files.upload(file_name: "file-name.jpg") # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new(file_name: "fileName") +params = Imagekit::FileUploadParams.new(file_name: "file-name.jpg") image_kit.files.upload(**params) ``` From bd204edbd68eebe5ef35a88161b600de81ace85b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 08:02:17 +0000 Subject: [PATCH 010/178] feat(api): manual updates --- .stats.yml | 2 +- README.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.stats.yml b/.stats.yml index 980c9061..ede64f59 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-584c2ccf3fc1a3ff3abf26b8d3dace2398d0f9ed6f20e4c411a13a81febb5e98.yml openapi_spec_hash: 14d1614ea3903d6b53f26e135c9cae81 -config_hash: 91beba074bbcedbfda383cf006796fa1 +config_hash: 9f3c729a01b07940df835ef5ec13119a diff --git a/README.md b/README.md index 7ef0c91b..35b67f2e 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ image_kit = Imagekit::Client.new( password: ENV["ORG_MY_PASSWORD_TOKEN"] # This is the default and can be omitted ) -response = image_kit.files.upload(file_name: "file-name.jpg") +response = image_kit.files.upload(file_name: "fileName") puts(response.videoCodec) ``` @@ -62,7 +62,7 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload(file_name: "file-name.jpg") + file = image_kit.files.upload(file_name: "fileName") rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -105,7 +105,7 @@ image_kit = Imagekit::Client.new( ) # Or, configure per-request: -image_kit.files.upload(file_name: "file-name.jpg", request_options: {max_retries: 5}) +image_kit.files.upload(file_name: "fileName", request_options: {max_retries: 5}) ``` ### Timeouts @@ -119,7 +119,7 @@ image_kit = Imagekit::Client.new( ) # Or, configure per-request: -image_kit.files.upload(file_name: "file-name.jpg", request_options: {timeout: 5}) +image_kit.files.upload(file_name: "fileName", request_options: {timeout: 5}) ``` On timeout, `Imagekit::Errors::APITimeoutError` is raised. @@ -151,7 +151,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file_name: "file-name.jpg", + file_name: "fileName", request_options: { extra_query: {my_query_parameter: value}, extra_body: {my_body_parameter: value}, @@ -197,17 +197,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload(file_name: "file-name.jpg") +image_kit.files.upload(file_name: "fileName") ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload(file_name: "file-name.jpg") +image_kit.files.upload(file_name: "fileName") # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new(file_name: "file-name.jpg") +params = Imagekit::FileUploadParams.new(file_name: "fileName") image_kit.files.upload(**params) ``` From 40f17afaa55ba0d69c3ec69d11a7541f0fa6b20f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 08:04:16 +0000 Subject: [PATCH 011/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 8 - lib/imagekit/internal/type/base_model.rb | 6 +- lib/imagekit/models.rb | 16 - .../models/auto_description_extension.rb | 28 - lib/imagekit/models/auto_tagging_extension.rb | 45 -- .../models/beta/v2/file_upload_params.rb | 151 +++- .../models/beta/v2/file_upload_response.rb | 342 +++++++++- lib/imagekit/models/exif_details.rb | 167 ----- lib/imagekit/models/exif_image.rb | 77 --- lib/imagekit/models/file_update_params.rb | 150 +++- lib/imagekit/models/file_upload_params.rb | 150 +++- lib/imagekit/models/file_upload_response.rb | 341 +++++++++- .../files/metadata_get_from_url_response.rb | 342 +++++++++- .../models/files/metadata_get_response.rb | 341 +++++++++- lib/imagekit/models/gps.rb | 17 - lib/imagekit/models/interoperability.rb | 23 - lib/imagekit/models/removedot_bg_extension.rb | 79 --- lib/imagekit/models/thumbnail.rb | 47 -- lib/imagekit/resources/beta/v2/files.rb | 2 +- lib/imagekit/resources/files.rb | 4 +- rbi/imagekit/models.rbi | 16 - .../models/auto_description_extension.rbi | 60 -- .../models/auto_tagging_extension.rbi | 81 --- .../models/beta/v2/file_upload_params.rbi | 367 +++++++++- .../models/beta/v2/file_upload_response.rbi | 641 ++++++++++++++++- rbi/imagekit/models/exif_details.rbi | 264 ------- rbi/imagekit/models/exif_image.rbi | 127 ---- rbi/imagekit/models/file_update_params.rbi | 367 +++++++++- rbi/imagekit/models/file_upload_params.rbi | 367 +++++++++- rbi/imagekit/models/file_upload_response.rbi | 641 ++++++++++++++++- .../files/metadata_get_from_url_response.rbi | 642 +++++++++++++++++- .../models/files/metadata_get_response.rbi | 638 ++++++++++++++++- rbi/imagekit/models/gps.rbi | 27 - rbi/imagekit/models/interoperability.rbi | 39 -- .../models/removedot_bg_extension.rbi | 152 ----- rbi/imagekit/models/thumbnail.rbi | 82 --- rbi/imagekit/resources/beta/v2/files.rbi | 6 +- rbi/imagekit/resources/files.rbi | 12 +- sig/imagekit/models.rbs | 16 - .../models/auto_description_extension.rbs | 28 - .../models/auto_tagging_extension.rbs | 41 -- .../models/beta/v2/file_upload_params.rbs | 147 +++- .../models/beta/v2/file_upload_response.rbs | 432 +++++++++++- sig/imagekit/models/exif_details.rbs | 197 ------ sig/imagekit/models/exif_image.rbs | 92 --- sig/imagekit/models/file_update_params.rbs | 147 +++- sig/imagekit/models/file_upload_params.rbs | 147 +++- sig/imagekit/models/file_upload_response.rbs | 429 +++++++++++- .../files/metadata_get_from_url_response.rbs | 429 +++++++++++- .../models/files/metadata_get_response.rbs | 429 +++++++++++- sig/imagekit/models/gps.rbs | 15 - sig/imagekit/models/interoperability.rbs | 19 - .../models/removedot_bg_extension.rbs | 79 --- sig/imagekit/models/thumbnail.rbs | 57 -- test/imagekit/resources/shared_test.rb | 6 - 56 files changed, 7341 insertions(+), 2236 deletions(-) delete mode 100644 lib/imagekit/models/auto_description_extension.rb delete mode 100644 lib/imagekit/models/auto_tagging_extension.rb delete mode 100644 lib/imagekit/models/exif_details.rb delete mode 100644 lib/imagekit/models/exif_image.rb delete mode 100644 lib/imagekit/models/gps.rb delete mode 100644 lib/imagekit/models/interoperability.rb delete mode 100644 lib/imagekit/models/removedot_bg_extension.rb delete mode 100644 lib/imagekit/models/thumbnail.rb delete mode 100644 rbi/imagekit/models/auto_description_extension.rbi delete mode 100644 rbi/imagekit/models/auto_tagging_extension.rbi delete mode 100644 rbi/imagekit/models/exif_details.rbi delete mode 100644 rbi/imagekit/models/exif_image.rbi delete mode 100644 rbi/imagekit/models/gps.rbi delete mode 100644 rbi/imagekit/models/interoperability.rbi delete mode 100644 rbi/imagekit/models/removedot_bg_extension.rbi delete mode 100644 rbi/imagekit/models/thumbnail.rbi delete mode 100644 sig/imagekit/models/auto_description_extension.rbs delete mode 100644 sig/imagekit/models/auto_tagging_extension.rbs delete mode 100644 sig/imagekit/models/exif_details.rbs delete mode 100644 sig/imagekit/models/exif_image.rbs delete mode 100644 sig/imagekit/models/gps.rbs delete mode 100644 sig/imagekit/models/interoperability.rbs delete mode 100644 sig/imagekit/models/removedot_bg_extension.rbs delete mode 100644 sig/imagekit/models/thumbnail.rbs delete mode 100644 test/imagekit/resources/shared_test.rb diff --git a/.stats.yml b/.stats.yml index ede64f59..254a6c30 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-584c2ccf3fc1a3ff3abf26b8d3dace2398d0f9ed6f20e4c411a13a81febb5e98.yml openapi_spec_hash: 14d1614ea3903d6b53f26e135c9cae81 -config_hash: 9f3c729a01b07940df835ef5ec13119a +config_hash: e2f52106d0ea435659ba3ff7074406f5 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 7375e99d..c44707e5 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -72,8 +72,6 @@ require_relative "imagekit/models/accounts/usage_get_response" require_relative "imagekit/models/asset_list_params" require_relative "imagekit/models/asset_list_response" -require_relative "imagekit/models/auto_description_extension" -require_relative "imagekit/models/auto_tagging_extension" require_relative "imagekit/models/beta/v2/file_upload_params" require_relative "imagekit/models/beta/v2/file_upload_response" require_relative "imagekit/models/cache/invalidation_create_params" @@ -88,8 +86,6 @@ require_relative "imagekit/models/custom_metadata_field_list_response" require_relative "imagekit/models/custom_metadata_field_update_params" require_relative "imagekit/models/custom_metadata_field_update_response" -require_relative "imagekit/models/exif_details" -require_relative "imagekit/models/exif_image" require_relative "imagekit/models/file_copy_params" require_relative "imagekit/models/file_copy_response" require_relative "imagekit/models/file_delete_params" @@ -135,10 +131,6 @@ require_relative "imagekit/models/folder_rename_response" require_relative "imagekit/models/folders/job_get_params" require_relative "imagekit/models/folders/job_get_response" -require_relative "imagekit/models/gps" -require_relative "imagekit/models/interoperability" -require_relative "imagekit/models/removedot_bg_extension" -require_relative "imagekit/models/thumbnail" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" require_relative "imagekit/models/video_transformation_accepted_webhook_event" diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb index cc17b099..808cf57e 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekit/internal/type/base_model.rb @@ -438,8 +438,10 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `auto_description_extension` is a `Imagekit::AutoDescriptionExtension` - # auto_description_extension => { + # # `custom_metadata_field_create_response` is a `Imagekit::Models::CustomMetadataFieldCreateResponse` + # custom_metadata_field_create_response => { + # id: id, + # label: label, # name: name # } def deconstruct_keys(keys) diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 5edf6927..15a31d95 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -43,10 +43,6 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams - AutoDescriptionExtension = Imagekit::Models::AutoDescriptionExtension - - AutoTaggingExtension = Imagekit::Models::AutoTaggingExtension - Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache @@ -59,10 +55,6 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams - ExifDetails = Imagekit::Models::ExifDetails - - ExifImage = Imagekit::Models::ExifImage - FileCopyParams = Imagekit::Models::FileCopyParams FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -91,14 +83,6 @@ module Imagekit Folders = Imagekit::Models::Folders - Gps = Imagekit::Models::Gps - - Interoperability = Imagekit::Models::Interoperability - - RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension - - Thumbnail = Imagekit::Models::Thumbnail - UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent diff --git a/lib/imagekit/models/auto_description_extension.rb b/lib/imagekit/models/auto_description_extension.rb deleted file mode 100644 index fe58f796..00000000 --- a/lib/imagekit/models/auto_description_extension.rb +++ /dev/null @@ -1,28 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. - # - # @return [Symbol, Imagekit::Models::AutoDescriptionExtension::Name] - required :name, enum: -> { Imagekit::AutoDescriptionExtension::Name } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::AutoDescriptionExtension::Name] Specifies the auto description extension. - - # Specifies the auto description extension. - # - # @see Imagekit::Models::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION = :"ai-auto-description" - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/imagekit/models/auto_tagging_extension.rb b/lib/imagekit/models/auto_tagging_extension.rb deleted file mode 100644 index 284984f7..00000000 --- a/lib/imagekit/models/auto_tagging_extension.rb +++ /dev/null @@ -1,45 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::AutoTaggingExtension::Name] - required :name, enum: -> { Imagekit::AutoTaggingExtension::Name } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index dc601b07..2ea95bd9 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -87,7 +87,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the image. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Extension] } @@ -225,7 +225,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -256,14 +256,153 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::RemovedotBgExtension } + variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension } - variant -> { Imagekit::AutoTaggingExtension } + variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension } - variant -> { Imagekit::AutoDescriptionExtension } + variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name] + required :name, enum: -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name } + + # @!attribute options + # + # @return [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options, nil] + optional :options, -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name] + required :name, + enum: -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION = :"ai-auto-description" + + # @!method self.values + # @return [Array] + end + end # @!method self.variants - # @return [Array(Imagekit::Models::RemovedotBgExtension, Imagekit::Models::AutoTaggingExtension, Imagekit::Models::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension)] end module ResponseField diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekit/models/beta/v2/file_upload_response.rb index 66d5b5ed..58e36783 100644 --- a/lib/imagekit/models/beta/v2/file_upload_response.rb +++ b/lib/imagekit/models/beta/v2/file_upload_response.rb @@ -462,26 +462,27 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::ExifDetails, nil] - optional :exif, -> { Imagekit::ExifDetails } + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, nil] + optional :exif, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::Gps, nil] - optional :gps, -> { Imagekit::Gps } + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, nil] + optional :gps, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::ExifImage, nil] - optional :image, -> { Imagekit::ExifImage } + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, nil] + optional :image, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::Interoperability, nil] - optional :interoperability, -> { Imagekit::Interoperability } + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, nil] + optional :interoperability, + -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability } # @!attribute makernote # @@ -491,21 +492,332 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Thumbnail } + # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. + # @param exif [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif] Object containing Exif details. # - # @param gps [Imagekit::Models::Gps] Object containing GPS information. + # @param gps [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. + # @param image [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::Interoperability] JSON object. + # @param interoperability [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. + # @param thumbnail [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end end end diff --git a/lib/imagekit/models/exif_details.rb b/lib/imagekit/models/exif_details.rb deleted file mode 100644 index e6af5a2c..00000000 --- a/lib/imagekit/models/exif_details.rb +++ /dev/null @@ -1,167 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class ExifDetails < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - end -end diff --git a/lib/imagekit/models/exif_image.rb b/lib/imagekit/models/exif_image.rb deleted file mode 100644 index df6a92ed..00000000 --- a/lib/imagekit/models/exif_image.rb +++ /dev/null @@ -1,77 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class ExifImage < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - end -end diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index 3da532f3..fb5b5ccc 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -34,7 +34,7 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Extension] } @@ -87,7 +87,7 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car # @@ -102,14 +102,152 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::RemovedotBgExtension } + variant -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension } - variant -> { Imagekit::AutoTaggingExtension } + variant -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension } - variant -> { Imagekit::AutoDescriptionExtension } + variant -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name } + + # @!attribute options + # + # @return [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options, nil] + optional :options, -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. + # + # @see Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION = :"ai-auto-description" + + # @!method self.values + # @return [Array] + end + end # @!method self.variants - # @return [Array(Imagekit::Models::RemovedotBgExtension, Imagekit::Models::AutoTaggingExtension, Imagekit::Models::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension)] end # An array of AITags associated with the file that you want to remove, e.g. diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index b0034f10..41b027ab 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -94,7 +94,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the image. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Extension] } @@ -256,7 +256,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -291,14 +291,152 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::RemovedotBgExtension } + variant -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension } - variant -> { Imagekit::AutoTaggingExtension } + variant -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension } - variant -> { Imagekit::AutoDescriptionExtension } + variant -> { Imagekit::FileUploadParams::Extension::AutoDescriptionExtension } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Name] + required :name, enum: -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name } + + # @!attribute options + # + # @return [Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options, nil] + optional :options, -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::Name] + required :name, enum: -> { Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. + # + # @see Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION = :"ai-auto-description" + + # @!method self.values + # @return [Array] + end + end # @!method self.variants - # @return [Array(Imagekit::Models::RemovedotBgExtension, Imagekit::Models::AutoTaggingExtension, Imagekit::Models::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension)] end module ResponseField diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekit/models/file_upload_response.rb index 82b66760..d45a8b89 100644 --- a/lib/imagekit/models/file_upload_response.rb +++ b/lib/imagekit/models/file_upload_response.rb @@ -458,26 +458,26 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::ExifDetails, nil] - optional :exif, -> { Imagekit::ExifDetails } + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, nil] + optional :exif, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::Gps, nil] - optional :gps, -> { Imagekit::Gps } + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, nil] + optional :gps, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::ExifImage, nil] - optional :image, -> { Imagekit::ExifImage } + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, nil] + optional :image, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Image } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::Interoperability, nil] - optional :interoperability, -> { Imagekit::Interoperability } + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, nil] + optional :interoperability, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability } # @!attribute makernote # @@ -487,21 +487,332 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Thumbnail } + # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. + # @param exif [Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif] Object containing Exif details. # - # @param gps [Imagekit::Models::Gps] Object containing GPS information. + # @param gps [Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. + # @param image [Imagekit::Models::FileUploadResponse::Metadata::Exif::Image] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::Interoperability] JSON object. + # @param interoperability [Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. + # @param thumbnail [Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end end end diff --git a/lib/imagekit/models/files/metadata_get_from_url_response.rb b/lib/imagekit/models/files/metadata_get_from_url_response.rb index ead81933..02c5b3b5 100644 --- a/lib/imagekit/models/files/metadata_get_from_url_response.rb +++ b/lib/imagekit/models/files/metadata_get_from_url_response.rb @@ -124,26 +124,27 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::ExifDetails, nil] - optional :exif, -> { Imagekit::ExifDetails } + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, nil] + optional :exif, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::Gps, nil] - optional :gps, -> { Imagekit::Gps } + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, nil] + optional :gps, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::ExifImage, nil] - optional :image, -> { Imagekit::ExifImage } + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, nil] + optional :image, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::Interoperability, nil] - optional :interoperability, -> { Imagekit::Interoperability } + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, nil] + optional :interoperability, + -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability } # @!attribute makernote # @@ -153,21 +154,332 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Thumbnail } + # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. + # @param exif [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif] Object containing Exif details. # - # @param gps [Imagekit::Models::Gps] Object containing GPS information. + # @param gps [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. + # @param image [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::Interoperability] JSON object. + # @param interoperability [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. + # @param thumbnail [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end end end end diff --git a/lib/imagekit/models/files/metadata_get_response.rb b/lib/imagekit/models/files/metadata_get_response.rb index 62f0c1f6..aa974f73 100644 --- a/lib/imagekit/models/files/metadata_get_response.rb +++ b/lib/imagekit/models/files/metadata_get_response.rb @@ -124,26 +124,26 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::ExifDetails, nil] - optional :exif, -> { Imagekit::ExifDetails } + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, nil] + optional :exif, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Exif } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::Gps, nil] - optional :gps, -> { Imagekit::Gps } + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, nil] + optional :gps, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::ExifImage, nil] - optional :image, -> { Imagekit::ExifImage } + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Image, nil] + optional :image, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Image } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::Interoperability, nil] - optional :interoperability, -> { Imagekit::Interoperability } + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, nil] + optional :interoperability, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability } # @!attribute makernote # @@ -153,21 +153,332 @@ class Exif < Imagekit::Internal::Type::BaseModel # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Thumbnail } + # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::ExifDetails] Object containing Exif details. + # @param exif [Imagekit::Models::Files::MetadataGetResponse::Exif::Exif] Object containing Exif details. # - # @param gps [Imagekit::Models::Gps] Object containing GPS information. + # @param gps [Imagekit::Models::Files::MetadataGetResponse::Exif::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::ExifImage] Object containing EXIF image information. + # @param image [Imagekit::Models::Files::MetadataGetResponse::Exif::Image] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::Interoperability] JSON object. + # @param interoperability [Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::Thumbnail] Object containing Thumbnail information. + # @param thumbnail [Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::Files::MetadataGetResponse::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end end end end diff --git a/lib/imagekit/models/gps.rb b/lib/imagekit/models/gps.rb deleted file mode 100644 index da477fce..00000000 --- a/lib/imagekit/models/gps.rb +++ /dev/null @@ -1,17 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - end -end diff --git a/lib/imagekit/models/interoperability.rb b/lib/imagekit/models/interoperability.rb deleted file mode 100644 index 23925987..00000000 --- a/lib/imagekit/models/interoperability.rb +++ /dev/null @@ -1,23 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - end -end diff --git a/lib/imagekit/models/removedot_bg_extension.rb b/lib/imagekit/models/removedot_bg_extension.rb deleted file mode 100644 index 6b0dbfd1..00000000 --- a/lib/imagekit/models/removedot_bg_extension.rb +++ /dev/null @@ -1,79 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, Imagekit::Models::RemovedotBgExtension::Name] - required :name, enum: -> { Imagekit::RemovedotBgExtension::Name } - - # @!attribute options - # - # @return [Imagekit::Models::RemovedotBgExtension::Options, nil] - optional :options, -> { Imagekit::RemovedotBgExtension::Options } - - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::RemovedotBgExtension::Name] Specifies the background removal extension. - # - # @param options [Imagekit::Models::RemovedotBgExtension::Options] - - # Specifies the background removal extension. - # - # @see Imagekit::Models::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::RemovedotBgExtension#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::RemovedotBgExtension::Options} for more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - end -end diff --git a/lib/imagekit/models/thumbnail.rb b/lib/imagekit/models/thumbnail.rb deleted file mode 100644 index 8b864ac0..00000000 --- a/lib/imagekit/models/thumbnail.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end - end -end diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekit/resources/beta/v2/files.rb index cd7b8e6a..03370c95 100644 --- a/lib/imagekit/resources/beta/v2/files.rb +++ b/lib/imagekit/resources/beta/v2/files.rb @@ -52,7 +52,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 9dbeff89..e8a7a4c7 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -29,7 +29,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car # @@ -251,7 +251,7 @@ def rename(params) # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 8671d608..85969296 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -5,10 +5,6 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams - AutoDescriptionExtension = Imagekit::Models::AutoDescriptionExtension - - AutoTaggingExtension = Imagekit::Models::AutoTaggingExtension - Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache @@ -25,10 +21,6 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams - ExifDetails = Imagekit::Models::ExifDetails - - ExifImage = Imagekit::Models::ExifImage - FileCopyParams = Imagekit::Models::FileCopyParams FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -57,14 +49,6 @@ module Imagekit Folders = Imagekit::Models::Folders - Gps = Imagekit::Models::Gps - - Interoperability = Imagekit::Models::Interoperability - - RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension - - Thumbnail = Imagekit::Models::Thumbnail - UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent diff --git a/rbi/imagekit/models/auto_description_extension.rbi b/rbi/imagekit/models/auto_description_extension.rbi deleted file mode 100644 index 2e600f55..00000000 --- a/rbi/imagekit/models/auto_description_extension.rbi +++ /dev/null @@ -1,60 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::AutoDescriptionExtension, Imagekit::Internal::AnyHash) - end - - # Specifies the auto description extension. - sig { returns(Imagekit::AutoDescriptionExtension::Name::OrSymbol) } - attr_accessor :name - - sig do - params( - name: Imagekit::AutoDescriptionExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Specifies the auto description extension. - name: - ) - end - - sig do - override.returns( - { name: Imagekit::AutoDescriptionExtension::Name::OrSymbol } - ) - end - def to_hash - end - - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::AutoDescriptionExtension::Name) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::AutoDescriptionExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Imagekit::AutoDescriptionExtension::Name::TaggedSymbol] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/imagekit/models/auto_tagging_extension.rbi b/rbi/imagekit/models/auto_tagging_extension.rbi deleted file mode 100644 index f9ba57d8..00000000 --- a/rbi/imagekit/models/auto_tagging_extension.rbi +++ /dev/null @@ -1,81 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::AutoTaggingExtension, Imagekit::Internal::AnyHash) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig { returns(Imagekit::AutoTaggingExtension::Name::OrSymbol) } - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::AutoTaggingExtension::Name) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Imagekit::AutoTaggingExtension::Name::TaggedSymbol] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi index 05b68708..1ae93408 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -96,9 +96,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension ) ] ) @@ -111,9 +111,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash ) ] ).void @@ -278,9 +278,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash ) ], folder: String, @@ -429,9 +429,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension ) ], folder: String, @@ -463,12 +463,349 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension ) end + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + returns( + T.nilable( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + name: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil + ) + end + + sig do + override.returns( + { + name: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + } + ) + end + def to_hash + end + + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + name: + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Specifies the auto description extension. + name: + ) + end + + sig do + override.returns( + { + name: + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + sig do override.returns( T::Array[ diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekit/models/beta/v2/file_upload_response.rbi index d0c050bb..2399fd0b 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_response.rbi @@ -862,33 +862,73 @@ module Imagekit end # Object containing Exif details. - sig { returns(T.nilable(Imagekit::ExifDetails)) } + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif + ) + ) + end attr_reader :exif - sig { params(exif: Imagekit::ExifDetails::OrHash).void } + sig do + params( + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif::OrHash + ).void + end attr_writer :exif # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Gps)) } + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps + ) + ) + end attr_reader :gps - sig { params(gps: Imagekit::Gps::OrHash).void } + sig do + params( + gps: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps::OrHash + ).void + end attr_writer :gps # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::ExifImage)) } + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image + ) + ) + end attr_reader :image - sig { params(image: Imagekit::ExifImage::OrHash).void } + sig do + params( + image: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image::OrHash + ).void + end attr_writer :image # JSON object. - sig { returns(T.nilable(Imagekit::Interoperability)) } + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability + ) + ) + end attr_reader :interoperability sig do params( - interoperability: Imagekit::Interoperability::OrHash + interoperability: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability::OrHash ).void end attr_writer :interoperability @@ -900,20 +940,36 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Thumbnail)) } + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + ) + ) + end attr_reader :thumbnail - sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } + sig do + params( + thumbnail: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash + ).void + end attr_writer :thumbnail sig do params( - exif: Imagekit::ExifDetails::OrHash, - gps: Imagekit::Gps::OrHash, - image: Imagekit::ExifImage::OrHash, - interoperability: Imagekit::Interoperability::OrHash, + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif::OrHash, + gps: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps::OrHash, + image: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image::OrHash, + interoperability: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail::OrHash + thumbnail: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -934,17 +990,562 @@ module Imagekit sig do override.returns( { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + gps: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + image: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + interoperability: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail + thumbnail: + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail } ) end def to_hash end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns( + T.attached_class + ) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params( + interop_index: String, + interop_version: String + ).returns(T.attached_class) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns( + { interop_index: String, interop_version: String } + ) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end end end diff --git a/rbi/imagekit/models/exif_details.rbi b/rbi/imagekit/models/exif_details.rbi deleted file mode 100644 index 9fa9f276..00000000 --- a/rbi/imagekit/models/exif_details.rbi +++ /dev/null @@ -1,264 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class ExifDetails < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::ExifDetails, Imagekit::Internal::AnyHash) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/exif_image.rbi b/rbi/imagekit/models/exif_image.rbi deleted file mode 100644 index cea9754a..00000000 --- a/rbi/imagekit/models/exif_image.rbi +++ /dev/null @@ -1,127 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class ExifImage < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias { T.any(Imagekit::ExifImage, Imagekit::Internal::AnyHash) } - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index 65912c0d..9d2a7633 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -39,9 +39,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension ) ] ) @@ -54,9 +54,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash ) ] ).void @@ -124,9 +124,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash ) ], remove_ai_tags: @@ -185,9 +185,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension ) ], remove_ai_tags: @@ -211,12 +211,349 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension ) end + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig do + returns( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + returns( + T.nilable( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + name: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil + ) + end + + sig do + override.returns( + { + name: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + } + ) + end + def to_hash + end + + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig do + returns( + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + name: + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Specifies the auto description extension. + name: + ) + end + + sig do + override.returns( + { + name: + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + sig do override.returns( T::Array[Imagekit::FileUpdateParams::Extension::Variants] diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 04a63cca..00f5b321 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -101,9 +101,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension ) ] ) @@ -116,9 +116,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash ) ] ).void @@ -301,9 +301,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash ) ], folder: String, @@ -473,9 +473,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension ) ], folder: String, @@ -506,12 +506,349 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::RemovedotBgExtension, - Imagekit::AutoTaggingExtension, - Imagekit::AutoDescriptionExtension + Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension ) end + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig do + returns( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + returns( + T.nilable( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + name: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil + ) + end + + sig do + override.returns( + { + name: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + } + ) + end + def to_hash + end + + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig do + returns( + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + name: + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Specifies the auto description extension. + name: + ) + end + + sig do + override.returns( + { + name: + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + sig do override.returns( T::Array[Imagekit::FileUploadParams::Extension::Variants] diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekit/models/file_upload_response.rbi index 60ff68c3..3baec054 100644 --- a/rbi/imagekit/models/file_upload_response.rbi +++ b/rbi/imagekit/models/file_upload_response.rbi @@ -829,32 +829,74 @@ module Imagekit end # Object containing Exif details. - sig { returns(T.nilable(Imagekit::ExifDetails)) } + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif + ) + ) + end attr_reader :exif - sig { params(exif: Imagekit::ExifDetails::OrHash).void } + sig do + params( + exif: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif::OrHash + ).void + end attr_writer :exif # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Gps)) } + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps + ) + ) + end attr_reader :gps - sig { params(gps: Imagekit::Gps::OrHash).void } + sig do + params( + gps: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps::OrHash + ).void + end attr_writer :gps # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::ExifImage)) } + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image + ) + ) + end attr_reader :image - sig { params(image: Imagekit::ExifImage::OrHash).void } + sig do + params( + image: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image::OrHash + ).void + end attr_writer :image # JSON object. - sig { returns(T.nilable(Imagekit::Interoperability)) } + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability + ) + ) + end attr_reader :interoperability sig do - params(interoperability: Imagekit::Interoperability::OrHash).void + params( + interoperability: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability::OrHash + ).void end attr_writer :interoperability @@ -865,20 +907,36 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Thumbnail)) } + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + ) + ) + end attr_reader :thumbnail - sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } + sig do + params( + thumbnail: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash + ).void + end attr_writer :thumbnail sig do params( - exif: Imagekit::ExifDetails::OrHash, - gps: Imagekit::Gps::OrHash, - image: Imagekit::ExifImage::OrHash, - interoperability: Imagekit::Interoperability::OrHash, + exif: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif::OrHash, + gps: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps::OrHash, + image: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image::OrHash, + interoperability: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail::OrHash + thumbnail: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -899,17 +957,560 @@ module Imagekit sig do override.returns( { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + image: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + interoperability: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail + thumbnail: + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail } ) end def to_hash end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns( + T.attached_class + ) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns( + { interop_index: String, interop_version: String } + ) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end end end diff --git a/rbi/imagekit/models/files/metadata_get_from_url_response.rbi b/rbi/imagekit/models/files/metadata_get_from_url_response.rbi index 3c451bd2..197185d4 100644 --- a/rbi/imagekit/models/files/metadata_get_from_url_response.rbi +++ b/rbi/imagekit/models/files/metadata_get_from_url_response.rbi @@ -202,32 +202,74 @@ module Imagekit end # Object containing Exif details. - sig { returns(T.nilable(Imagekit::ExifDetails)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif + ) + ) + end attr_reader :exif - sig { params(exif: Imagekit::ExifDetails::OrHash).void } + sig do + params( + exif: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif::OrHash + ).void + end attr_writer :exif # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Gps)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps + ) + ) + end attr_reader :gps - sig { params(gps: Imagekit::Gps::OrHash).void } + sig do + params( + gps: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps::OrHash + ).void + end attr_writer :gps # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::ExifImage)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image + ) + ) + end attr_reader :image - sig { params(image: Imagekit::ExifImage::OrHash).void } + sig do + params( + image: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image::OrHash + ).void + end attr_writer :image # JSON object. - sig { returns(T.nilable(Imagekit::Interoperability)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability + ) + ) + end attr_reader :interoperability sig do - params(interoperability: Imagekit::Interoperability::OrHash).void + params( + interoperability: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability::OrHash + ).void end attr_writer :interoperability @@ -238,20 +280,36 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Thumbnail)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + ) + ) + end attr_reader :thumbnail - sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } + sig do + params( + thumbnail: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail::OrHash + ).void + end attr_writer :thumbnail sig do params( - exif: Imagekit::ExifDetails::OrHash, - gps: Imagekit::Gps::OrHash, - image: Imagekit::ExifImage::OrHash, - interoperability: Imagekit::Interoperability::OrHash, + exif: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif::OrHash, + gps: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps::OrHash, + image: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image::OrHash, + interoperability: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail::OrHash + thumbnail: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -272,17 +330,561 @@ module Imagekit sig do override.returns( { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + gps: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + image: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + interoperability: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail + thumbnail: + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail } ) end def to_hash end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns( + T.attached_class + ) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns( + { interop_index: String, interop_version: String } + ) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end end end end diff --git a/rbi/imagekit/models/files/metadata_get_response.rbi b/rbi/imagekit/models/files/metadata_get_response.rbi index 3815259b..a1d5cf55 100644 --- a/rbi/imagekit/models/files/metadata_get_response.rbi +++ b/rbi/imagekit/models/files/metadata_get_response.rbi @@ -198,32 +198,72 @@ module Imagekit end # Object containing Exif details. - sig { returns(T.nilable(Imagekit::ExifDetails)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif + ) + ) + end attr_reader :exif - sig { params(exif: Imagekit::ExifDetails::OrHash).void } + sig do + params( + exif: + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif::OrHash + ).void + end attr_writer :exif # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Gps)) } + sig do + returns( + T.nilable(Imagekit::Models::Files::MetadataGetResponse::Exif::Gps) + ) + end attr_reader :gps - sig { params(gps: Imagekit::Gps::OrHash).void } + sig do + params( + gps: + Imagekit::Models::Files::MetadataGetResponse::Exif::Gps::OrHash + ).void + end attr_writer :gps # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::ExifImage)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetResponse::Exif::Image + ) + ) + end attr_reader :image - sig { params(image: Imagekit::ExifImage::OrHash).void } + sig do + params( + image: + Imagekit::Models::Files::MetadataGetResponse::Exif::Image::OrHash + ).void + end attr_writer :image # JSON object. - sig { returns(T.nilable(Imagekit::Interoperability)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability + ) + ) + end attr_reader :interoperability sig do - params(interoperability: Imagekit::Interoperability::OrHash).void + params( + interoperability: + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability::OrHash + ).void end attr_writer :interoperability @@ -234,20 +274,36 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Thumbnail)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + ) + ) + end attr_reader :thumbnail - sig { params(thumbnail: Imagekit::Thumbnail::OrHash).void } + sig do + params( + thumbnail: + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail::OrHash + ).void + end attr_writer :thumbnail sig do params( - exif: Imagekit::ExifDetails::OrHash, - gps: Imagekit::Gps::OrHash, - image: Imagekit::ExifImage::OrHash, - interoperability: Imagekit::Interoperability::OrHash, + exif: + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif::OrHash, + gps: + Imagekit::Models::Files::MetadataGetResponse::Exif::Gps::OrHash, + image: + Imagekit::Models::Files::MetadataGetResponse::Exif::Image::OrHash, + interoperability: + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail::OrHash + thumbnail: + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -268,17 +324,559 @@ module Imagekit sig do override.returns( { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + image: + Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + interoperability: + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Thumbnail + thumbnail: + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail } ) end def to_hash end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns( + T.attached_class + ) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns( + { interop_index: String, interop_version: String } + ) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end end end end diff --git a/rbi/imagekit/models/gps.rbi b/rbi/imagekit/models/gps.rbi deleted file mode 100644 index 57931ca6..00000000 --- a/rbi/imagekit/models/gps.rbi +++ /dev/null @@ -1,27 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias { T.any(Imagekit::Gps, Imagekit::Internal::AnyHash) } - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns(T.attached_class) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/interoperability.rbi b/rbi/imagekit/models/interoperability.rbi deleted file mode 100644 index 69123b0b..00000000 --- a/rbi/imagekit/models/interoperability.rbi +++ /dev/null @@ -1,39 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::Interoperability, Imagekit::Internal::AnyHash) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params(interop_index: String, interop_version: String).returns( - T.attached_class - ) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns({ interop_index: String, interop_version: String }) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/removedot_bg_extension.rbi b/rbi/imagekit/models/removedot_bg_extension.rbi deleted file mode 100644 index 0d052898..00000000 --- a/rbi/imagekit/models/removedot_bg_extension.rbi +++ /dev/null @@ -1,152 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::RemovedotBgExtension, Imagekit::Internal::AnyHash) - end - - # Specifies the background removal extension. - sig { returns(Imagekit::RemovedotBgExtension::Name::OrSymbol) } - attr_accessor :name - - sig { returns(T.nilable(Imagekit::RemovedotBgExtension::Options)) } - attr_reader :options - - sig do - params(options: Imagekit::RemovedotBgExtension::Options::OrHash).void - end - attr_writer :options - - sig do - params( - name: Imagekit::RemovedotBgExtension::Name::OrSymbol, - options: Imagekit::RemovedotBgExtension::Options::OrHash - ).returns(T.attached_class) - end - def self.new( - # Specifies the background removal extension. - name:, - options: nil - ) - end - - sig do - override.returns( - { - name: Imagekit::RemovedotBgExtension::Name::OrSymbol, - options: Imagekit::RemovedotBgExtension::Options - } - ) - end - def to_hash - end - - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::RemovedotBgExtension::Name) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Imagekit::RemovedotBgExtension::Name::TaggedSymbol] - ) - end - def self.values - end - end - - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::RemovedotBgExtension::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/thumbnail.rbi b/rbi/imagekit/models/thumbnail.rbi deleted file mode 100644 index e35978ae..00000000 --- a/rbi/imagekit/models/thumbnail.rbi +++ /dev/null @@ -1,82 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias { T.any(Imagekit::Thumbnail, Imagekit::Internal::AnyHash) } - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekit/resources/beta/v2/files.rbi index 1ff024e7..cf3cca05 100644 --- a/rbi/imagekit/resources/beta/v2/files.rbi +++ b/rbi/imagekit/resources/beta/v2/files.rbi @@ -44,9 +44,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash ) ], folder: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index c1376cd3..dbf5ec42 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -24,9 +24,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash ) ], remove_ai_tags: @@ -244,9 +244,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::RemovedotBgExtension::OrHash, - Imagekit::AutoTaggingExtension::OrHash, - Imagekit::AutoDescriptionExtension::OrHash + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash ) ], folder: String, diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 39772157..e7b3dc30 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -3,10 +3,6 @@ module Imagekit class AssetListParams = Imagekit::Models::AssetListParams - class AutoDescriptionExtension = Imagekit::Models::AutoDescriptionExtension - - class AutoTaggingExtension = Imagekit::Models::AutoTaggingExtension - module Beta = Imagekit::Models::Beta module Cache = Imagekit::Models::Cache @@ -19,10 +15,6 @@ module Imagekit class CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams - class ExifDetails = Imagekit::Models::ExifDetails - - class ExifImage = Imagekit::Models::ExifImage - class FileCopyParams = Imagekit::Models::FileCopyParams class FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -51,14 +43,6 @@ module Imagekit module Folders = Imagekit::Models::Folders - class Gps = Imagekit::Models::Gps - - class Interoperability = Imagekit::Models::Interoperability - - class RemovedotBgExtension = Imagekit::Models::RemovedotBgExtension - - class Thumbnail = Imagekit::Models::Thumbnail - module UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent diff --git a/sig/imagekit/models/auto_description_extension.rbs b/sig/imagekit/models/auto_description_extension.rbs deleted file mode 100644 index ce8f247b..00000000 --- a/sig/imagekit/models/auto_description_extension.rbs +++ /dev/null @@ -1,28 +0,0 @@ -module Imagekit - module Models - type auto_description_extension = - { name: Imagekit::Models::AutoDescriptionExtension::name_ } - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::AutoDescriptionExtension::name_ - - def initialize: ( - name: Imagekit::Models::AutoDescriptionExtension::name_ - ) -> void - - def to_hash: -> { - name: Imagekit::Models::AutoDescriptionExtension::name_ - } - - type name_ = :"ai-auto-description" - - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION: :"ai-auto-description" - - def self?.values: -> ::Array[Imagekit::Models::AutoDescriptionExtension::name_] - end - end - end -end diff --git a/sig/imagekit/models/auto_tagging_extension.rbs b/sig/imagekit/models/auto_tagging_extension.rbs deleted file mode 100644 index dd51b977..00000000 --- a/sig/imagekit/models/auto_tagging_extension.rbs +++ /dev/null @@ -1,41 +0,0 @@ -module Imagekit - module Models - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::AutoTaggingExtension::name_ - } - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer - - attr_accessor min_confidence: Integer - - attr_accessor name: Imagekit::Models::AutoTaggingExtension::name_ - - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::AutoTaggingExtension::name_ - ) -> void - - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::AutoTaggingExtension::name_ - } - - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" - - def self?.values: -> ::Array[Imagekit::Models::AutoTaggingExtension::name_] - end - end - end -end diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekit/models/beta/v2/file_upload_params.rbs index e880db97..8c630015 100644 --- a/sig/imagekit/models/beta/v2/file_upload_params.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_params.rbs @@ -162,13 +162,154 @@ module Imagekit } type extension = - Imagekit::RemovedotBgExtension - | Imagekit::AutoTaggingExtension - | Imagekit::AutoDescriptionExtension + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension + | Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension + | Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union + type removedot_bg_extension = + { + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_ + + attr_reader options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options? + + def options=: ( + Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + ) -> Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + + def initialize: ( + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + ) -> void + + def to_hash: -> { + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + type name_ = :"remove-bg" + + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG: :"remove-bg" + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_] + end + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_] + end + end + + type auto_description_extension = + { + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + } + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + + def initialize: ( + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + ) -> void + + def to_hash: -> { + name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + } + + type name_ = :"ai-auto-description" + + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION: :"ai-auto-description" + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_] + end + end + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] end diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs index 0d69bb75..1d8a524d 100644 --- a/sig/imagekit/models/beta/v2/file_upload_response.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_response.rbs @@ -386,58 +386,438 @@ module Imagekit type exif = { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail + thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail } class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::ExifDetails? + attr_reader exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif? - def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails + def exif=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif - attr_reader gps: Imagekit::Gps? + attr_reader gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps? - def gps=: (Imagekit::Gps) -> Imagekit::Gps + def gps=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps - attr_reader image: Imagekit::ExifImage? + attr_reader image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image? - def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage + def image=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image - attr_reader interoperability: Imagekit::Interoperability? + attr_reader interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability? def interoperability=: ( - Imagekit::Interoperability - ) -> Imagekit::Interoperability + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Thumbnail? + attr_reader thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail? - def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail + def thumbnail=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail def initialize: ( - ?exif: Imagekit::ExifDetails, - ?gps: Imagekit::Gps, - ?image: Imagekit::ExifImage, - ?interoperability: Imagekit::Interoperability, + ?exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + ?gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + ?image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + ?interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Thumbnail + ?thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, + image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, + interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail + thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { + interop_index: String, + interop_version: String + } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end end end diff --git a/sig/imagekit/models/exif_details.rbs b/sig/imagekit/models/exif_details.rbs deleted file mode 100644 index 76edd041..00000000 --- a/sig/imagekit/models/exif_details.rbs +++ /dev/null @@ -1,197 +0,0 @@ -module Imagekit - module Models - type exif_details = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class ExifDetails < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - end -end diff --git a/sig/imagekit/models/exif_image.rbs b/sig/imagekit/models/exif_image.rbs deleted file mode 100644 index 684ef926..00000000 --- a/sig/imagekit/models/exif_image.rbs +++ /dev/null @@ -1,92 +0,0 @@ -module Imagekit - module Models - type exif_image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class ExifImage < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - end -end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index 8db160b2..efeb8866 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -76,13 +76,154 @@ module Imagekit } type extension = - Imagekit::RemovedotBgExtension - | Imagekit::AutoTaggingExtension - | Imagekit::AutoDescriptionExtension + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension + | Imagekit::FileUpdateParams::Extension::AutoTaggingExtension + | Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union + type removedot_bg_extension = + { + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_ + + attr_reader options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options? + + def options=: ( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ) -> Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + + def initialize: ( + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + } + + type name_ = :"remove-bg" + + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG: :"remove-bg" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_] + end + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_] + end + end + + type auto_description_extension = + { + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + } + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + + def initialize: ( + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + } + + type name_ = :"ai-auto-description" + + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION: :"ai-auto-description" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_] + end + end + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::extension] end diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index 9ad2ba7f..b9b40672 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -181,13 +181,154 @@ module Imagekit } type extension = - Imagekit::RemovedotBgExtension - | Imagekit::AutoTaggingExtension - | Imagekit::AutoDescriptionExtension + Imagekit::FileUploadParams::Extension::RemovedotBgExtension + | Imagekit::FileUploadParams::Extension::AutoTaggingExtension + | Imagekit::FileUploadParams::Extension::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union + type removedot_bg_extension = + { + name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_ + + attr_reader options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options? + + def options=: ( + Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + ) -> Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + + def initialize: ( + name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + } + + type name_ = :"remove-bg" + + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG: :"remove-bg" + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_] + end + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_] + end + end + + type auto_description_extension = + { + name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + } + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + + def initialize: ( + name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + } + + type name_ = :"ai-auto-description" + + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION: :"ai-auto-description" + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_] + end + end + def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::extension] end diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs index 725869ec..bcf2de3c 100644 --- a/sig/imagekit/models/file_upload_response.rbs +++ b/sig/imagekit/models/file_upload_response.rbs @@ -384,58 +384,435 @@ module Imagekit type exif = { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail + thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail } class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::ExifDetails? + attr_reader exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif? - def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails + def exif=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif - attr_reader gps: Imagekit::Gps? + attr_reader gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps? - def gps=: (Imagekit::Gps) -> Imagekit::Gps + def gps=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps - attr_reader image: Imagekit::ExifImage? + attr_reader image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image? - def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage + def image=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Image + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Image - attr_reader interoperability: Imagekit::Interoperability? + attr_reader interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability? def interoperability=: ( - Imagekit::Interoperability - ) -> Imagekit::Interoperability + Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Thumbnail? + attr_reader thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail? - def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail + def thumbnail=: ( + Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail + ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail def initialize: ( - ?exif: Imagekit::ExifDetails, - ?gps: Imagekit::Gps, - ?image: Imagekit::ExifImage, - ?interoperability: Imagekit::Interoperability, + ?exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + ?gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + ?image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + ?interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Thumbnail + ?thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, + gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, + image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, + interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail + thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end end end diff --git a/sig/imagekit/models/files/metadata_get_from_url_response.rbs b/sig/imagekit/models/files/metadata_get_from_url_response.rbs index 72aff42f..0befaf28 100644 --- a/sig/imagekit/models/files/metadata_get_from_url_response.rbs +++ b/sig/imagekit/models/files/metadata_get_from_url_response.rbs @@ -114,58 +114,435 @@ module Imagekit type exif = { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail + thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail } class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::ExifDetails? + attr_reader exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif? - def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails + def exif=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif - attr_reader gps: Imagekit::Gps? + attr_reader gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps? - def gps=: (Imagekit::Gps) -> Imagekit::Gps + def gps=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps - attr_reader image: Imagekit::ExifImage? + attr_reader image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image? - def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage + def image=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image - attr_reader interoperability: Imagekit::Interoperability? + attr_reader interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability? def interoperability=: ( - Imagekit::Interoperability - ) -> Imagekit::Interoperability + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Thumbnail? + attr_reader thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail? - def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail + def thumbnail=: ( + Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail + ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail def initialize: ( - ?exif: Imagekit::ExifDetails, - ?gps: Imagekit::Gps, - ?image: Imagekit::ExifImage, - ?interoperability: Imagekit::Interoperability, + ?exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + ?gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + ?image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + ?interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Thumbnail + ?thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, + image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, + interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail + thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end end end end diff --git a/sig/imagekit/models/files/metadata_get_response.rbs b/sig/imagekit/models/files/metadata_get_response.rbs index 94cb2a3f..749a3cad 100644 --- a/sig/imagekit/models/files/metadata_get_response.rbs +++ b/sig/imagekit/models/files/metadata_get_response.rbs @@ -114,58 +114,435 @@ module Imagekit type exif = { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail + thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail } class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::ExifDetails? + attr_reader exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif? - def exif=: (Imagekit::ExifDetails) -> Imagekit::ExifDetails + def exif=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Exif + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Exif - attr_reader gps: Imagekit::Gps? + attr_reader gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps? - def gps=: (Imagekit::Gps) -> Imagekit::Gps + def gps=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Gps + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Gps - attr_reader image: Imagekit::ExifImage? + attr_reader image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image? - def image=: (Imagekit::ExifImage) -> Imagekit::ExifImage + def image=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Image + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Image - attr_reader interoperability: Imagekit::Interoperability? + attr_reader interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability? def interoperability=: ( - Imagekit::Interoperability - ) -> Imagekit::Interoperability + Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Thumbnail? + attr_reader thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail? - def thumbnail=: (Imagekit::Thumbnail) -> Imagekit::Thumbnail + def thumbnail=: ( + Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail + ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail def initialize: ( - ?exif: Imagekit::ExifDetails, - ?gps: Imagekit::Gps, - ?image: Imagekit::ExifImage, - ?interoperability: Imagekit::Interoperability, + ?exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + ?gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + ?image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + ?interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Thumbnail + ?thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::ExifDetails, - gps: Imagekit::Gps, - image: Imagekit::ExifImage, - interoperability: Imagekit::Interoperability, + exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, + gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, + image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, + interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Thumbnail + thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end end end end diff --git a/sig/imagekit/models/gps.rbs b/sig/imagekit/models/gps.rbs deleted file mode 100644 index d11c6a06..00000000 --- a/sig/imagekit/models/gps.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - end -end diff --git a/sig/imagekit/models/interoperability.rbs b/sig/imagekit/models/interoperability.rbs deleted file mode 100644 index f653174a..00000000 --- a/sig/imagekit/models/interoperability.rbs +++ /dev/null @@ -1,19 +0,0 @@ -module Imagekit - module Models - type interoperability = { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: (?interop_index: String, ?interop_version: String) -> void - - def to_hash: -> { interop_index: String, interop_version: String } - end - end -end diff --git a/sig/imagekit/models/removedot_bg_extension.rbs b/sig/imagekit/models/removedot_bg_extension.rbs deleted file mode 100644 index ff2ef781..00000000 --- a/sig/imagekit/models/removedot_bg_extension.rbs +++ /dev/null @@ -1,79 +0,0 @@ -module Imagekit - module Models - type removedot_bg_extension = - { - name: Imagekit::Models::RemovedotBgExtension::name_, - options: Imagekit::RemovedotBgExtension::Options - } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::RemovedotBgExtension::name_ - - attr_reader options: Imagekit::RemovedotBgExtension::Options? - - def options=: ( - Imagekit::RemovedotBgExtension::Options - ) -> Imagekit::RemovedotBgExtension::Options - - def initialize: ( - name: Imagekit::Models::RemovedotBgExtension::name_, - ?options: Imagekit::RemovedotBgExtension::Options - ) -> void - - def to_hash: -> { - name: Imagekit::Models::RemovedotBgExtension::name_, - options: Imagekit::RemovedotBgExtension::Options - } - - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::RemovedotBgExtension::name_] - end - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? - - def add_shadow=: (bool) -> bool - - attr_reader bg_color: String? - - def bg_color=: (String) -> String - - attr_reader bg_image_url: String? - - def bg_image_url=: (String) -> String - - attr_reader semitransparency: bool? - - def semitransparency=: (bool) -> bool - - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void - - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end - end -end diff --git a/sig/imagekit/models/thumbnail.rbs b/sig/imagekit/models/thumbnail.rbs deleted file mode 100644 index 0fcbb367..00000000 --- a/sig/imagekit/models/thumbnail.rbs +++ /dev/null @@ -1,57 +0,0 @@ -module Imagekit - module Models - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end - end -end diff --git a/test/imagekit/resources/shared_test.rb b/test/imagekit/resources/shared_test.rb deleted file mode 100644 index be22f0e4..00000000 --- a/test/imagekit/resources/shared_test.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::Resources::SharedTest < Imagekit::Test::ResourceTest -end From f1ddcd0dbb5b45d28e253efe48ffe282c201e795 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 08:13:16 +0000 Subject: [PATCH 012/178] feat(api): manual updates --- .stats.yml | 6 +- .../models/accounts/origin_create_response.rb | 42 +++++++------- .../models/accounts/origin_get_response.rb | 42 +++++++------- .../models/accounts/origin_list_response.rb | 42 +++++++------- .../models/accounts/origin_update_response.rb | 42 +++++++------- .../accounts/origin_create_response.rbi | 42 +++++++------- .../models/accounts/origin_get_response.rbi | 42 +++++++------- .../models/accounts/origin_list_response.rbi | 42 +++++++------- .../accounts/origin_update_response.rbi | 42 +++++++------- .../accounts/origin_create_response.rbs | 56 +++++++++---------- .../models/accounts/origin_get_response.rbs | 56 +++++++++---------- .../models/accounts/origin_list_response.rbs | 56 +++++++++---------- .../accounts/origin_update_response.rbs | 56 +++++++++---------- 13 files changed, 283 insertions(+), 283 deletions(-) diff --git a/.stats.yml b/.stats.yml index 254a6c30..91f8d8ce 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-584c2ccf3fc1a3ff3abf26b8d3dace2398d0f9ed6f20e4c411a13a81febb5e98.yml -openapi_spec_hash: 14d1614ea3903d6b53f26e135c9cae81 -config_hash: e2f52106d0ea435659ba3ff7074406f5 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-a1cf25a2c075ef11eea56c771578a9c36aa5f37677389988c9fb0c776399bc1b.yml +openapi_spec_hash: 8fed9fded4a79267764133be71b296e6 +config_hash: e212bc0b32d2d9fe583f77bccfae0375 diff --git a/lib/imagekit/models/accounts/origin_create_response.rb b/lib/imagekit/models/accounts/origin_create_response.rb index 9e6fc80d..0fa2dc4c 100644 --- a/lib/imagekit/models/accounts/origin_create_response.rb +++ b/lib/imagekit/models/accounts/origin_create_response.rb @@ -49,8 +49,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -84,7 +84,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3::Type] # @@ -131,8 +131,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute s3_force_path_style # Use path-style S3 URLs? @@ -175,7 +175,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # @@ -218,8 +218,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -254,7 +254,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type] # @@ -275,8 +275,8 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!attribute base_url # Root URL for the web folder origin. # - # @return [Object] - required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + # @return [String] + required :base_url, String, api_name: :baseUrl # @!attribute forward_host_header_to_origin # Forward the Host header to origin? @@ -326,7 +326,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url [Object] Root URL for the web folder origin. + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # @@ -436,8 +436,8 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute prefix # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -474,7 +474,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] + # @param prefix [String] # # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type] # @@ -518,8 +518,8 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute prefix # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -556,7 +556,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] + # @param prefix [String] # # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type] # @@ -577,8 +577,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!attribute base_url # Akeneo instance base URL. # - # @return [Object] - required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + # @return [String] + required :base_url, String, api_name: :baseUrl # @!attribute include_canonical_header # Whether to send a Canonical header. @@ -620,7 +620,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url [Object] Akeneo instance base URL. + # @param base_url [String] Akeneo instance base URL. # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # diff --git a/lib/imagekit/models/accounts/origin_get_response.rb b/lib/imagekit/models/accounts/origin_get_response.rb index 10323deb..b43cbb15 100644 --- a/lib/imagekit/models/accounts/origin_get_response.rb +++ b/lib/imagekit/models/accounts/origin_get_response.rb @@ -49,8 +49,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -84,7 +84,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3::Type] # @@ -131,8 +131,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute s3_force_path_style # Use path-style S3 URLs? @@ -174,7 +174,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # @@ -217,8 +217,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -253,7 +253,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type] # @@ -274,8 +274,8 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!attribute base_url # Root URL for the web folder origin. # - # @return [Object] - required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + # @return [String] + required :base_url, String, api_name: :baseUrl # @!attribute forward_host_header_to_origin # Forward the Host header to origin? @@ -325,7 +325,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url [Object] Root URL for the web folder origin. + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # @@ -435,8 +435,8 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute prefix # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -473,7 +473,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] + # @param prefix [String] # # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type] # @@ -517,8 +517,8 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute prefix # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -555,7 +555,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] + # @param prefix [String] # # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type] # @@ -576,8 +576,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!attribute base_url # Akeneo instance base URL. # - # @return [Object] - required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + # @return [String] + required :base_url, String, api_name: :baseUrl # @!attribute include_canonical_header # Whether to send a Canonical header. @@ -619,7 +619,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url [Object] Akeneo instance base URL. + # @param base_url [String] Akeneo instance base URL. # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index 3c9271bf..b2675a4c 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -47,8 +47,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -82,7 +82,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3::Type] # @@ -129,8 +129,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute s3_force_path_style # Use path-style S3 URLs? @@ -173,7 +173,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # @@ -216,8 +216,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -252,7 +252,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type] # @@ -273,8 +273,8 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!attribute base_url # Root URL for the web folder origin. # - # @return [Object] - required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + # @return [String] + required :base_url, String, api_name: :baseUrl # @!attribute forward_host_header_to_origin # Forward the Host header to origin? @@ -325,7 +325,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url [Object] Root URL for the web folder origin. + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # @@ -435,8 +435,8 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute prefix # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -474,7 +474,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] + # @param prefix [String] # # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type] # @@ -518,8 +518,8 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute prefix # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -556,7 +556,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] + # @param prefix [String] # # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type] # @@ -577,8 +577,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!attribute base_url # Akeneo instance base URL. # - # @return [Object] - required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + # @return [String] + required :base_url, String, api_name: :baseUrl # @!attribute include_canonical_header # Whether to send a Canonical header. @@ -621,7 +621,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url [Object] Akeneo instance base URL. + # @param base_url [String] Akeneo instance base URL. # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # diff --git a/lib/imagekit/models/accounts/origin_update_response.rb b/lib/imagekit/models/accounts/origin_update_response.rb index 88d8b216..fec36bd8 100644 --- a/lib/imagekit/models/accounts/origin_update_response.rb +++ b/lib/imagekit/models/accounts/origin_update_response.rb @@ -49,8 +49,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -84,7 +84,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type] # @@ -131,8 +131,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute s3_force_path_style # Use path-style S3 URLs? @@ -175,7 +175,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # @@ -218,8 +218,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!attribute prefix # Path prefix inside the bucket. # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -254,7 +254,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] Path prefix inside the bucket. + # @param prefix [String] Path prefix inside the bucket. # # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type] # @@ -275,8 +275,8 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!attribute base_url # Root URL for the web folder origin. # - # @return [Object] - required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + # @return [String] + required :base_url, String, api_name: :baseUrl # @!attribute forward_host_header_to_origin # Forward the Host header to origin? @@ -326,7 +326,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url [Object] Root URL for the web folder origin. + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # @@ -436,8 +436,8 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute prefix # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -474,7 +474,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] + # @param prefix [String] # # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type] # @@ -518,8 +518,8 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute prefix # - # @return [Object] - required :prefix, Imagekit::Internal::Type::Unknown + # @return [String] + required :prefix, String # @!attribute type # @@ -556,7 +556,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param prefix [Object] + # @param prefix [String] # # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type] # @@ -577,8 +577,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!attribute base_url # Akeneo instance base URL. # - # @return [Object] - required :base_url, Imagekit::Internal::Type::Unknown, api_name: :baseUrl + # @return [String] + required :base_url, String, api_name: :baseUrl # @!attribute include_canonical_header # Whether to send a Canonical header. @@ -620,7 +620,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url [Object] Akeneo instance base URL. + # @param base_url [String] Akeneo instance base URL. # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # diff --git a/rbi/imagekit/models/accounts/origin_create_response.rbi b/rbi/imagekit/models/accounts/origin_create_response.rbi index 3fdd0694..6a969bd2 100644 --- a/rbi/imagekit/models/accounts/origin_create_response.rbi +++ b/rbi/imagekit/models/accounts/origin_create_response.rbi @@ -43,7 +43,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -71,7 +71,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::OrSymbol, base_url_for_canonical_header: String @@ -102,7 +102,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -168,7 +168,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix # Use path-style S3 URLs? @@ -201,7 +201,7 @@ module Imagekit endpoint: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, s3_force_path_style: T::Boolean, type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::OrSymbol, @@ -238,7 +238,7 @@ module Imagekit endpoint: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, s3_force_path_style: T::Boolean, type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol, @@ -301,7 +301,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -329,7 +329,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::OrSymbol, base_url_for_canonical_header: String @@ -360,7 +360,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -410,7 +410,7 @@ module Imagekit end # Root URL for the web folder origin. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :base_url # Forward the Host header to origin? @@ -447,7 +447,7 @@ module Imagekit sig do params( id: String, - base_url: T.anything, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, @@ -478,7 +478,7 @@ module Imagekit override.returns( { id: String, - base_url: T.anything, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, @@ -649,7 +649,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -678,7 +678,7 @@ module Imagekit client_email: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::OrSymbol, base_url_for_canonical_header: String @@ -709,7 +709,7 @@ module Imagekit client_email: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -772,7 +772,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -801,7 +801,7 @@ module Imagekit container: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::OrSymbol, base_url_for_canonical_header: String @@ -832,7 +832,7 @@ module Imagekit container: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -882,7 +882,7 @@ module Imagekit end # Akeneo instance base URL. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :base_url # Whether to send a Canonical header. @@ -915,7 +915,7 @@ module Imagekit sig do params( id: String, - base_url: T.anything, + base_url: String, include_canonical_header: T::Boolean, name: String, type: @@ -943,7 +943,7 @@ module Imagekit override.returns( { id: String, - base_url: T.anything, + base_url: String, include_canonical_header: T::Boolean, name: String, type: diff --git a/rbi/imagekit/models/accounts/origin_get_response.rbi b/rbi/imagekit/models/accounts/origin_get_response.rbi index 16d88f4a..ee18f2fe 100644 --- a/rbi/imagekit/models/accounts/origin_get_response.rbi +++ b/rbi/imagekit/models/accounts/origin_get_response.rbi @@ -43,7 +43,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -71,7 +71,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::S3::Type::OrSymbol, base_url_for_canonical_header: String @@ -102,7 +102,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -168,7 +168,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix # Use path-style S3 URLs? @@ -201,7 +201,7 @@ module Imagekit endpoint: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, s3_force_path_style: T::Boolean, type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::OrSymbol, @@ -238,7 +238,7 @@ module Imagekit endpoint: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, s3_force_path_style: T::Boolean, type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol, @@ -301,7 +301,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -329,7 +329,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::OrSymbol, base_url_for_canonical_header: String @@ -360,7 +360,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -410,7 +410,7 @@ module Imagekit end # Root URL for the web folder origin. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :base_url # Forward the Host header to origin? @@ -447,7 +447,7 @@ module Imagekit sig do params( id: String, - base_url: T.anything, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, @@ -478,7 +478,7 @@ module Imagekit override.returns( { id: String, - base_url: T.anything, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, @@ -649,7 +649,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -678,7 +678,7 @@ module Imagekit client_email: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::OrSymbol, base_url_for_canonical_header: String @@ -709,7 +709,7 @@ module Imagekit client_email: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -772,7 +772,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -801,7 +801,7 @@ module Imagekit container: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::OrSymbol, base_url_for_canonical_header: String @@ -832,7 +832,7 @@ module Imagekit container: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -882,7 +882,7 @@ module Imagekit end # Akeneo instance base URL. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :base_url # Whether to send a Canonical header. @@ -915,7 +915,7 @@ module Imagekit sig do params( id: String, - base_url: T.anything, + base_url: String, include_canonical_header: T::Boolean, name: String, type: @@ -943,7 +943,7 @@ module Imagekit override.returns( { id: String, - base_url: T.anything, + base_url: String, include_canonical_header: T::Boolean, name: String, type: diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index 5b0b3c35..8c5280cd 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -43,7 +43,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -71,7 +71,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::OrSymbol, base_url_for_canonical_header: String @@ -102,7 +102,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -168,7 +168,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix # Use path-style S3 URLs? @@ -201,7 +201,7 @@ module Imagekit endpoint: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, s3_force_path_style: T::Boolean, type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::OrSymbol, @@ -238,7 +238,7 @@ module Imagekit endpoint: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, s3_force_path_style: T::Boolean, type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol, @@ -301,7 +301,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -329,7 +329,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::OrSymbol, base_url_for_canonical_header: String @@ -360,7 +360,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -410,7 +410,7 @@ module Imagekit end # Root URL for the web folder origin. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :base_url # Forward the Host header to origin? @@ -447,7 +447,7 @@ module Imagekit sig do params( id: String, - base_url: T.anything, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, @@ -478,7 +478,7 @@ module Imagekit override.returns( { id: String, - base_url: T.anything, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, @@ -649,7 +649,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -678,7 +678,7 @@ module Imagekit client_email: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::OrSymbol, base_url_for_canonical_header: String @@ -709,7 +709,7 @@ module Imagekit client_email: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -772,7 +772,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -801,7 +801,7 @@ module Imagekit container: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::OrSymbol, base_url_for_canonical_header: String @@ -832,7 +832,7 @@ module Imagekit container: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -882,7 +882,7 @@ module Imagekit end # Akeneo instance base URL. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :base_url # Whether to send a Canonical header. @@ -915,7 +915,7 @@ module Imagekit sig do params( id: String, - base_url: T.anything, + base_url: String, include_canonical_header: T::Boolean, name: String, type: @@ -943,7 +943,7 @@ module Imagekit override.returns( { id: String, - base_url: T.anything, + base_url: String, include_canonical_header: T::Boolean, name: String, type: diff --git a/rbi/imagekit/models/accounts/origin_update_response.rbi b/rbi/imagekit/models/accounts/origin_update_response.rbi index 57a8a3bc..40f85070 100644 --- a/rbi/imagekit/models/accounts/origin_update_response.rbi +++ b/rbi/imagekit/models/accounts/origin_update_response.rbi @@ -43,7 +43,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -71,7 +71,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::OrSymbol, base_url_for_canonical_header: String @@ -102,7 +102,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -168,7 +168,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix # Use path-style S3 URLs? @@ -201,7 +201,7 @@ module Imagekit endpoint: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, s3_force_path_style: T::Boolean, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::OrSymbol, @@ -238,7 +238,7 @@ module Imagekit endpoint: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, s3_force_path_style: T::Boolean, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol, @@ -301,7 +301,7 @@ module Imagekit attr_accessor :name # Path prefix inside the bucket. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -329,7 +329,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::OrSymbol, base_url_for_canonical_header: String @@ -360,7 +360,7 @@ module Imagekit bucket: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -410,7 +410,7 @@ module Imagekit end # Root URL for the web folder origin. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :base_url # Forward the Host header to origin? @@ -447,7 +447,7 @@ module Imagekit sig do params( id: String, - base_url: T.anything, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, @@ -478,7 +478,7 @@ module Imagekit override.returns( { id: String, - base_url: T.anything, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, @@ -649,7 +649,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -678,7 +678,7 @@ module Imagekit client_email: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::OrSymbol, base_url_for_canonical_header: String @@ -709,7 +709,7 @@ module Imagekit client_email: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -772,7 +772,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :prefix sig do @@ -801,7 +801,7 @@ module Imagekit container: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::OrSymbol, base_url_for_canonical_header: String @@ -832,7 +832,7 @@ module Imagekit container: String, include_canonical_header: T::Boolean, name: String, - prefix: T.anything, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol, base_url_for_canonical_header: String @@ -882,7 +882,7 @@ module Imagekit end # Akeneo instance base URL. - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :base_url # Whether to send a Canonical header. @@ -915,7 +915,7 @@ module Imagekit sig do params( id: String, - base_url: T.anything, + base_url: String, include_canonical_header: T::Boolean, name: String, type: @@ -943,7 +943,7 @@ module Imagekit override.returns( { id: String, - base_url: T.anything, + base_url: String, include_canonical_header: T::Boolean, name: String, type: diff --git a/sig/imagekit/models/accounts/origin_create_response.rbs b/sig/imagekit/models/accounts/origin_create_response.rbs index e333344e..974647ad 100644 --- a/sig/imagekit/models/accounts/origin_create_response.rbs +++ b/sig/imagekit/models/accounts/origin_create_response.rbs @@ -20,7 +20,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, base_url_for_canonical_header: String } @@ -32,7 +32,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_ @@ -47,7 +47,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, ?base_url_for_canonical_header: String ) -> void @@ -57,7 +57,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, base_url_for_canonical_header: String } @@ -80,7 +80,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, :s3_force_path_style => bool, type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, base_url_for_canonical_header: String @@ -95,7 +95,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor s3_force_path_style: bool @@ -113,7 +113,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, s3_force_path_style: bool, type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, ?base_url_for_canonical_header: String @@ -125,7 +125,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, :s3_force_path_style => bool, type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, base_url_for_canonical_header: String @@ -148,7 +148,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, base_url_for_canonical_header: String } @@ -160,7 +160,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_ @@ -175,7 +175,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, ?base_url_for_canonical_header: String ) -> void @@ -185,7 +185,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, base_url_for_canonical_header: String } @@ -204,7 +204,7 @@ module Imagekit type web_folder = { id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -213,7 +213,7 @@ module Imagekit } class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: top + attr_accessor base_url: String attr_accessor forward_host_header_to_origin: bool @@ -231,7 +231,7 @@ module Imagekit def initialize: ( id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -241,7 +241,7 @@ module Imagekit def to_hash: -> { id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -316,7 +316,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, base_url_for_canonical_header: String } @@ -330,7 +330,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_ @@ -346,7 +346,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, ?base_url_for_canonical_header: String ) -> void @@ -357,7 +357,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, base_url_for_canonical_header: String } @@ -380,7 +380,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, base_url_for_canonical_header: String } @@ -394,7 +394,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_ @@ -410,7 +410,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, ?base_url_for_canonical_header: String ) -> void @@ -421,7 +421,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, base_url_for_canonical_header: String } @@ -440,7 +440,7 @@ module Imagekit type akeneo_pim = { id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, @@ -448,7 +448,7 @@ module Imagekit } class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: top + attr_accessor base_url: String attr_accessor include_canonical_header: bool @@ -464,7 +464,7 @@ module Imagekit def initialize: ( id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, @@ -473,7 +473,7 @@ module Imagekit def to_hash: -> { id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, diff --git a/sig/imagekit/models/accounts/origin_get_response.rbs b/sig/imagekit/models/accounts/origin_get_response.rbs index 3ac55b9e..b640c28f 100644 --- a/sig/imagekit/models/accounts/origin_get_response.rbs +++ b/sig/imagekit/models/accounts/origin_get_response.rbs @@ -20,7 +20,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, base_url_for_canonical_header: String } @@ -32,7 +32,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_ @@ -47,7 +47,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, ?base_url_for_canonical_header: String ) -> void @@ -57,7 +57,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, base_url_for_canonical_header: String } @@ -80,7 +80,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, :s3_force_path_style => bool, type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, base_url_for_canonical_header: String @@ -95,7 +95,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor s3_force_path_style: bool @@ -113,7 +113,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, s3_force_path_style: bool, type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, ?base_url_for_canonical_header: String @@ -125,7 +125,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, :s3_force_path_style => bool, type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, base_url_for_canonical_header: String @@ -148,7 +148,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, base_url_for_canonical_header: String } @@ -160,7 +160,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_ @@ -175,7 +175,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, ?base_url_for_canonical_header: String ) -> void @@ -185,7 +185,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, base_url_for_canonical_header: String } @@ -204,7 +204,7 @@ module Imagekit type web_folder = { id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -213,7 +213,7 @@ module Imagekit } class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: top + attr_accessor base_url: String attr_accessor forward_host_header_to_origin: bool @@ -231,7 +231,7 @@ module Imagekit def initialize: ( id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -241,7 +241,7 @@ module Imagekit def to_hash: -> { id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -316,7 +316,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, base_url_for_canonical_header: String } @@ -330,7 +330,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_ @@ -346,7 +346,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, ?base_url_for_canonical_header: String ) -> void @@ -357,7 +357,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, base_url_for_canonical_header: String } @@ -380,7 +380,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, base_url_for_canonical_header: String } @@ -394,7 +394,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_ @@ -410,7 +410,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, ?base_url_for_canonical_header: String ) -> void @@ -421,7 +421,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, base_url_for_canonical_header: String } @@ -440,7 +440,7 @@ module Imagekit type akeneo_pim = { id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, @@ -448,7 +448,7 @@ module Imagekit } class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: top + attr_accessor base_url: String attr_accessor include_canonical_header: bool @@ -464,7 +464,7 @@ module Imagekit def initialize: ( id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, @@ -473,7 +473,7 @@ module Imagekit def to_hash: -> { id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index 9dd3ae4b..a70b584e 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -20,7 +20,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, base_url_for_canonical_header: String } @@ -32,7 +32,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_ @@ -47,7 +47,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, ?base_url_for_canonical_header: String ) -> void @@ -57,7 +57,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, base_url_for_canonical_header: String } @@ -80,7 +80,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, :s3_force_path_style => bool, type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, base_url_for_canonical_header: String @@ -95,7 +95,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor s3_force_path_style: bool @@ -113,7 +113,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, s3_force_path_style: bool, type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, ?base_url_for_canonical_header: String @@ -125,7 +125,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, :s3_force_path_style => bool, type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, base_url_for_canonical_header: String @@ -148,7 +148,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, base_url_for_canonical_header: String } @@ -160,7 +160,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_ @@ -175,7 +175,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, ?base_url_for_canonical_header: String ) -> void @@ -185,7 +185,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, base_url_for_canonical_header: String } @@ -204,7 +204,7 @@ module Imagekit type web_folder = { id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -213,7 +213,7 @@ module Imagekit } class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: top + attr_accessor base_url: String attr_accessor forward_host_header_to_origin: bool @@ -231,7 +231,7 @@ module Imagekit def initialize: ( id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -241,7 +241,7 @@ module Imagekit def to_hash: -> { id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -316,7 +316,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, base_url_for_canonical_header: String } @@ -330,7 +330,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_ @@ -346,7 +346,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, ?base_url_for_canonical_header: String ) -> void @@ -357,7 +357,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, base_url_for_canonical_header: String } @@ -380,7 +380,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, base_url_for_canonical_header: String } @@ -394,7 +394,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_ @@ -410,7 +410,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, ?base_url_for_canonical_header: String ) -> void @@ -421,7 +421,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, base_url_for_canonical_header: String } @@ -440,7 +440,7 @@ module Imagekit type akeneo_pim = { id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, @@ -448,7 +448,7 @@ module Imagekit } class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: top + attr_accessor base_url: String attr_accessor include_canonical_header: bool @@ -464,7 +464,7 @@ module Imagekit def initialize: ( id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, @@ -473,7 +473,7 @@ module Imagekit def to_hash: -> { id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, diff --git a/sig/imagekit/models/accounts/origin_update_response.rbs b/sig/imagekit/models/accounts/origin_update_response.rbs index f82f6496..897e6df2 100644 --- a/sig/imagekit/models/accounts/origin_update_response.rbs +++ b/sig/imagekit/models/accounts/origin_update_response.rbs @@ -20,7 +20,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, base_url_for_canonical_header: String } @@ -32,7 +32,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_ @@ -47,7 +47,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, ?base_url_for_canonical_header: String ) -> void @@ -57,7 +57,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, base_url_for_canonical_header: String } @@ -80,7 +80,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, :s3_force_path_style => bool, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, base_url_for_canonical_header: String @@ -95,7 +95,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor s3_force_path_style: bool @@ -113,7 +113,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, s3_force_path_style: bool, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, ?base_url_for_canonical_header: String @@ -125,7 +125,7 @@ module Imagekit endpoint: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, :s3_force_path_style => bool, type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, base_url_for_canonical_header: String @@ -148,7 +148,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, base_url_for_canonical_header: String } @@ -160,7 +160,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_ @@ -175,7 +175,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, ?base_url_for_canonical_header: String ) -> void @@ -185,7 +185,7 @@ module Imagekit bucket: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, base_url_for_canonical_header: String } @@ -204,7 +204,7 @@ module Imagekit type web_folder = { id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -213,7 +213,7 @@ module Imagekit } class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: top + attr_accessor base_url: String attr_accessor forward_host_header_to_origin: bool @@ -231,7 +231,7 @@ module Imagekit def initialize: ( id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -241,7 +241,7 @@ module Imagekit def to_hash: -> { id: String, - base_url: top, + base_url: String, forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, @@ -316,7 +316,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, base_url_for_canonical_header: String } @@ -330,7 +330,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_ @@ -346,7 +346,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, ?base_url_for_canonical_header: String ) -> void @@ -357,7 +357,7 @@ module Imagekit client_email: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, base_url_for_canonical_header: String } @@ -380,7 +380,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, base_url_for_canonical_header: String } @@ -394,7 +394,7 @@ module Imagekit attr_accessor name: String - attr_accessor prefix: top + attr_accessor prefix: String attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_ @@ -410,7 +410,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, ?base_url_for_canonical_header: String ) -> void @@ -421,7 +421,7 @@ module Imagekit container: String, include_canonical_header: bool, name: String, - prefix: top, + prefix: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, base_url_for_canonical_header: String } @@ -440,7 +440,7 @@ module Imagekit type akeneo_pim = { id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, @@ -448,7 +448,7 @@ module Imagekit } class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: top + attr_accessor base_url: String attr_accessor include_canonical_header: bool @@ -464,7 +464,7 @@ module Imagekit def initialize: ( id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, @@ -473,7 +473,7 @@ module Imagekit def to_hash: -> { id: String, - base_url: top, + base_url: String, include_canonical_header: bool, name: String, type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, From 3dd56ff7aa3dec197b58da4dc48f03e6079f7bf1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 08:17:32 +0000 Subject: [PATCH 013/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit/models/file_update_params.rb | 548 +++++----- lib/imagekit/resources/files.rb | 20 +- rbi/imagekit/models/file_update_params.rbi | 1048 +++++++++++--------- rbi/imagekit/resources/files.rbi | 52 +- sig/imagekit/models/file_update_params.rbs | 393 ++++---- sig/imagekit/resources/files.rbs | 9 +- 7 files changed, 1105 insertions(+), 967 deletions(-) diff --git a/.stats.yml b/.stats.yml index 91f8d8ce..0384e026 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-a1cf25a2c075ef11eea56c771578a9c36aa5f37677389988c9fb0c776399bc1b.yml openapi_spec_hash: 8fed9fded4a79267764133be71b296e6 -config_hash: e212bc0b32d2d9fe583f77bccfae0375 +config_hash: 398ac75e62a73363899d6839f61a5977 diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index fb5b5ccc..3dcd61e1 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -7,304 +7,338 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute custom_coordinates - # 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. + # @!attribute update # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + # @return [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus, nil] + optional :update, union: -> { Imagekit::FileUpdateParams::Update } - # @!attribute custom_metadata - # 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. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - - # @!attribute description - # Optional text to describe the contents of the file. - # - # @return [String, nil] - optional :description, String - - # @!attribute extensions - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - # - # @return [Array, nil] - optional :extensions, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Extension] } - - # @!attribute remove_ai_tags - # 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. - # - # @return [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags, nil] - optional :remove_ai_tags, - union: -> { - Imagekit::FileUpdateParams::RemoveAITags - }, - api_name: :removeAITags - - # @!attribute tags - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute webhook_url - # 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 [String, nil] - optional :webhook_url, String, api_name: :webhookUrl - - # @!attribute publish - # Configure the publication status of a file and its versions. - # - # @return [Imagekit::Models::FileUpdateParams::Publish, nil] - optional :publish, -> { Imagekit::FileUpdateParams::Publish } - - # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams} for more details. - # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param description [String] Optional text to describe the contents of the file. - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. - # + # @!method initialize(update: nil, request_options: {}) + # @param update [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus] # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - module Extension + module Update extend Imagekit::Internal::Type::Union - variant -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension } - - variant -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension } + variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails } - variant -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension } + variant -> { Imagekit::FileUpdateParams::Update::ChangePublicationStatus } - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + # @!attribute custom_coordinates + # 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. # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name } + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - # @!attribute options + # @!attribute custom_metadata + # 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. # - # @return [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options, nil] - optional :options, -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options } + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # @!attribute description + # Optional text to describe the contents of the file. # - # @param options [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options] + # @return [String, nil] + optional :description, String - # Specifies the background removal extension. + # @!attribute extensions + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. # - # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" + # @return [Array, nil] + optional :extensions, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension] } - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options} - # for more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. + # @!attribute remove_ai_tags + # An array of AITags associated with the file that you want to remove, e.g. + # `["car", "vehicle", "motorsports"]`. # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. + # If you want to remove all AITags associated with the file, send a string - + # "all". # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. + # Note: The remove operation for `AITags` executes before any of the `extensions` + # are processed. # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # @return [Array, Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags, nil] + optional :remove_ai_tags, + union: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags }, + api_name: :removeAITags + + # @!attribute tags + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute webhook_url + # 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 name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + # @return [String, nil] + optional :webhook_url, String, api_name: :webhookUrl - # Specifies the auto-tagging extension used. + # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails} for more + # details. # - # @see Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + + module Extension + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension } + + variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension } + + variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension } + + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name] + required :name, + enum: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name } + + # @!attribute options + # + # @return [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options, nil] + optional :options, + -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options } + + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # + # @param options [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options] + + # Specifies the background removal extension. + # + # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name] + required :name, + enum: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name] + required :name, + enum: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. + # + # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION = :"ai-auto-description" + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension)] end - end - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. + # An array of AITags associated with the file that you want to remove, e.g. + # `["car", "vehicle", "motorsports"]`. # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. - - # Specifies the auto description extension. + # 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. # - # @see Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum + # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails#remove_ai_tags + module RemoveAITags + extend Imagekit::Internal::Type::Union - AI_AUTO_DESCRIPTION = :"ai-auto-description" + variant -> { Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::StringArray } - # @!method self.values - # @return [Array] - end - end + variant const: -> { Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::ALL } - # @!method self.variants - # @return [Array(Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension)] - end + # @!method self.variants + # @return [Array(Array, Symbol)] - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(T::Array[String], Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::TaggedSymbol) } + end - variant -> { Imagekit::Models::FileUpdateParams::RemoveAITags::StringArray } + # @type [Imagekit::Internal::Type::Converter] + StringArray = Imagekit::Internal::Type::ArrayOf[String] - variant const: -> { Imagekit::Models::FileUpdateParams::RemoveAITags::ALL } + # @!group - # @!method self.variants - # @return [Array(Array, Symbol)] + ALL = :all - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(T::Array[String], Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol) } + # @!endgroup + end end - # @type [Imagekit::Internal::Type::Converter] - StringArray = Imagekit::Internal::Type::ArrayOf[String] + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + # @!attribute publish + # Configure the publication status of a file and its versions. + # + # @return [Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish, nil] + optional :publish, -> { Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish } - # @!group + # @!method initialize(publish: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus} for more + # details. + # + # @param publish [Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. - ALL = :all + # @see Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus#publish + class Publish < Imagekit::Internal::Type::BaseModel + # @!attribute is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @return [Boolean] + required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - # @!endgroup - end + # @!attribute include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + # + # @return [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + + # @!method initialize(is_published:, include_file_versions: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish} + # for more details. + # + # Configure the publication status of a file and its versions. + # + # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p + end + end - class Publish < Imagekit::Internal::Type::BaseModel - # @!attribute is_published - # Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @return [Boolean] - required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute include_file_versions - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - # - # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions - - # @!method initialize(is_published:, include_file_versions: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Publish} for more details. - # - # Configure the publication status of a file and its versions. - # - # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p + # @!method self.variants + # @return [Array(Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus)] end end end diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index e8a7a4c7..6ab7ca55 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -19,25 +19,11 @@ class Files # You can update `tags`, `customCoordinates`, `customMetadata`, publication # status, remove existing `AITags` and apply extensions using this API. # - # @overload update(file_id, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) + # @overload update(file_id, update: nil, request_options: {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param description [String] Optional text to describe the contents of the file. - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. + # @param update [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus] # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -49,7 +35,7 @@ def update(file_id, params = {}) @client.request( method: :patch, path: ["v1/files/%1$s/details", file_id], - body: parsed, + body: parsed[:update], model: Imagekit::Models::FileUpdateResponse, options: options ) diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index 9d2a7633..f3acd59c 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -11,193 +11,50 @@ module Imagekit T.any(Imagekit::FileUpdateParams, Imagekit::Internal::AnyHash) end - # 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. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # 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. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Optional text to describe the contents of the file. - sig { returns(T.nilable(String)) } - attr_reader :description - - sig { params(description: String).void } - attr_writer :description - - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - sig do - returns( - T.nilable( - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension - ) - ] - ) - ) - end - attr_reader :extensions - - sig do - params( - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash - ) - ] - ).void - end - attr_writer :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. sig do returns( T.nilable( T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + Imagekit::FileUpdateParams::Update::UpdateFileDetails, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus ) ) ) end - attr_reader :remove_ai_tags + attr_reader :update sig do params( - remove_ai_tags: + update: T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash ) ).void end - attr_writer :remove_ai_tags - - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :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. - sig { returns(T.nilable(String)) } - attr_reader :webhook_url - - sig { params(webhook_url: String).void } - attr_writer :webhook_url - - # Configure the publication status of a file and its versions. - sig { returns(T.nilable(Imagekit::FileUpdateParams::Publish)) } - attr_reader :publish - - sig { params(publish: Imagekit::FileUpdateParams::Publish::OrHash).void } - attr_writer :publish + attr_writer :update sig do params( - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash - ) - ], - remove_ai_tags: + update: T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash ), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new( - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, - # Configure the publication status of a file and its versions. - publish: nil, - request_options: {} - ) + def self.new(update: nil, request_options: {}) end sig do override.returns( { - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension - ) - ], - remove_ai_tags: + update: T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + Imagekit::FileUpdateParams::Update::UpdateFileDetails, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus ), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish, request_options: Imagekit::RequestOptions } ) @@ -205,451 +62,722 @@ module Imagekit def to_hash end - module Extension + module Update extend Imagekit::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + Imagekit::FileUpdateParams::Update::UpdateFileDetails, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus ) end - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Internal::AnyHash ) end - # Specifies the background removal extension. + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. sig do returns( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol + T.nilable( + T::Array[ + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension + ) + ] + ) ) end - attr_accessor :name + attr_reader :extensions + sig do + params( + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::OrHash + ) + ] + ).void + end + attr_writer :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. sig do returns( T.nilable( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + T.any( + T::Array[String], + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::OrSymbol + ) ) ) end - attr_reader :options + attr_reader :remove_ai_tags sig do params( - options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::OrSymbol + ) ).void end - attr_writer :options + attr_writer :remove_ai_tags + + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url sig do params( - name: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::OrHash + ) + ], + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::OrSymbol + ), + tags: T.nilable(T::Array[String]), + webhook_url: String ).returns(T.attached_class) end def self.new( - # Specifies the background removal extension. - name:, - options: nil + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil ) end sig do override.returns( { - name: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension + ) + ], + remove_ai_tags: + T.any( + T::Array[String], + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::OrSymbol + ), + tags: T.nilable(T::Array[String]), + webhook_url: String } ) end def to_hash end - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum + module Extension + extend Imagekit::Internal::Type::Union - TaggedSymbol = + Variants = T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension ) end - OrSymbol = T.type_alias { T.any(Symbol, String) } - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig do + returns( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::OrSymbol + ) + end + attr_accessor :name - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] + sig do + returns( + T.nilable( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options + ) + ) + end + attr_reader :options + + sig do + params( + options: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + name: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options::OrHash + ).returns(T.attached_class) + end + def self.new( + # Specifies the background removal extension. + name:, + options: nil ) - end - def self.values - end - end + end - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options, - Imagekit::Internal::AnyHash + sig do + override.returns( + { + name: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options + } ) end + def to_hash + end - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end - sig { params(bg_color: String).void } - attr_writer :bg_color + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig do + returns( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::OrSymbol + ) + end + attr_accessor :name - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency + sig do + params( + name: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Specifies the auto description extension. + name: + ) + end - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency + sig do + override.returns( + { + name: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::OrSymbol + } + ) + end + def to_hash + end - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end end sig do override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } + T::Array[ + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::Variants + ] ) end - def to_hash + def self.variants end end - end - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + T::Array[String], + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::TaggedSymbol + ) + end + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::Variants + ] ) end + def self.variants + end - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum + StringArray = + T.let( + Imagekit::Internal::Type::ArrayOf[String], + Imagekit::Internal::Type::Converter + ) TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags ) end OrSymbol = T.type_alias { T.any(Symbol, String) } - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = + ALL = T.let( - :"aws-auto-tagging", - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + :all, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::TaggedSymbol ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end end end - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus, Imagekit::Internal::AnyHash ) end - # Specifies the auto description extension. + # Configure the publication status of a file and its versions. sig do returns( - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + T.nilable( + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + ) ) end - attr_accessor :name + attr_reader :publish + + sig do + params( + publish: + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish::OrHash + ).void + end + attr_writer :publish sig do params( - name: - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + publish: + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish::OrHash ).returns(T.attached_class) end def self.new( - # Specifies the auto description extension. - name: + # Configure the publication status of a file and its versions. + publish: nil ) end sig do override.returns( { - name: - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol + publish: + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish } ) end def to_hash end - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = + class Publish < Imagekit::Internal::Type::BaseModel + OrHash = T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name + T.any( + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish, + Imagekit::Internal::AnyHash ) end - OrSymbol = T.type_alias { T.any(Symbol, String) } - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ) + # Set to `true` to publish the file. Set to `false` to unpublish the file. + sig { returns(T::Boolean) } + attr_accessor :is_published + + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions + + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions + + # Configure the publication status of a file and its versions. + sig do + params( + is_published: T::Boolean, + include_file_versions: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Set to `true` to publish the file. Set to `false` to unpublish the file. + is_published:, + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + include_file_versions: nil + ) + end sig do override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ] + { is_published: T::Boolean, include_file_versions: T::Boolean } ) end - def self.values + def to_hash end end end sig do override.returns( - T::Array[Imagekit::FileUpdateParams::Extension::Variants] - ) - end - def self.variants - end - end - - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol - ) - end - - sig do - override.returns( - T::Array[Imagekit::FileUpdateParams::RemoveAITags::Variants] + T::Array[Imagekit::FileUpdateParams::Update::Variants] ) end def self.variants end - - StringArray = - T.let( - Imagekit::Internal::Type::ArrayOf[String], - Imagekit::Internal::Type::Converter - ) - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUpdateParams::RemoveAITags) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ALL = - T.let(:all, Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol) - end - - class Publish < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Publish, - Imagekit::Internal::AnyHash - ) - end - - # Set to `true` to publish the file. Set to `false` to unpublish the file. - sig { returns(T::Boolean) } - attr_accessor :is_published - - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_file_versions - - sig { params(include_file_versions: T::Boolean).void } - attr_writer :include_file_versions - - # Configure the publication status of a file and its versions. - sig do - params( - is_published: T::Boolean, - include_file_versions: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Set to `true` to publish the file. Set to `false` to unpublish the file. - is_published:, - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - include_file_versions: nil - ) - end - - sig do - override.returns( - { is_published: T::Boolean, include_file_versions: T::Boolean } - ) - end - def to_hash - end end end end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index dbf5ec42..a6241a22 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -18,25 +18,11 @@ module Imagekit sig do params( file_id: String, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash - ) - ], - remove_ai_tags: + update: T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol + Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash ), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::FileUpdateResponse) end @@ -44,37 +30,7 @@ module Imagekit # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. file_id, - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, - # Configure the publication status of a file and its versions. - publish: nil, + update: nil, request_options: {} ) end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index efeb8866..786cfc9c 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -1,259 +1,300 @@ module Imagekit module Models type file_update_params = - { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], - remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish - } + { update: Imagekit::Models::FileUpdateParams::update } & Imagekit::Internal::Type::request_parameters class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader extensions: ::Array[Imagekit::Models::FileUpdateParams::extension]? - - def extensions=: ( - ::Array[Imagekit::Models::FileUpdateParams::extension] - ) -> ::Array[Imagekit::Models::FileUpdateParams::extension] - - attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags? - - def remove_ai_tags=: ( - Imagekit::Models::FileUpdateParams::remove_ai_tags - ) -> Imagekit::Models::FileUpdateParams::remove_ai_tags + attr_reader update: Imagekit::Models::FileUpdateParams::update? - attr_accessor tags: ::Array[String]? - - attr_reader webhook_url: String? - - def webhook_url=: (String) -> String - - attr_reader publish: Imagekit::FileUpdateParams::Publish? - - def publish=: ( - Imagekit::FileUpdateParams::Publish - ) -> Imagekit::FileUpdateParams::Publish + def update=: ( + Imagekit::Models::FileUpdateParams::update + ) -> Imagekit::Models::FileUpdateParams::update def initialize: ( - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], - ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, - ?publish: Imagekit::FileUpdateParams::Publish, + ?update: Imagekit::Models::FileUpdateParams::update, ?request_options: Imagekit::request_opts ) -> void def to_hash: -> { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], - remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish, + update: Imagekit::Models::FileUpdateParams::update, request_options: Imagekit::RequestOptions } - type extension = - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension - | Imagekit::FileUpdateParams::Extension::AutoTaggingExtension - | Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + type update = + Imagekit::FileUpdateParams::Update::UpdateFileDetails + | Imagekit::FileUpdateParams::Update::ChangePublicationStatus - module Extension + module Update extend Imagekit::Internal::Type::Union - type removedot_bg_extension = + type update_file_details = { - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String } - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_ + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension]? - attr_reader options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options? + def extensions=: ( + ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] + ) -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] - def options=: ( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - ) -> Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags? + + def remove_ai_tags=: ( + Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags + ) -> Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags + + attr_accessor tags: ::Array[String]? + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String def initialize: ( - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + ?remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String ) -> void def to_hash: -> { - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String } - type name_ = :"remove-bg" + type extension = + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension + | Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension + | Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension - module Name - extend Imagekit::Internal::Type::Enum + module Extension + extend Imagekit::Internal::Type::Union - REMOVE_BG: :"remove-bg" + type removedot_bg_extension = + { + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options + } - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_] - end + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_ - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } + attr_reader options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options? - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? + def options=: ( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options + ) -> Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options - def add_shadow=: (bool) -> bool + def initialize: ( + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options + ) -> void - attr_reader bg_color: String? + def to_hash: -> { + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options + } - def bg_color=: (String) -> String + type name_ = :"remove-bg" - attr_reader bg_image_url: String? + module Name + extend Imagekit::Internal::Type::Enum - def bg_image_url=: (String) -> String + REMOVE_BG: :"remove-bg" - attr_reader semitransparency: bool? + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_] + end - def semitransparency=: (bool) -> bool + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end + def add_shadow=: (bool) -> bool - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - } + attr_reader bg_color: String? - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer + def bg_color=: (String) -> String - attr_accessor min_confidence: Integer + attr_reader bg_image_url: String? - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + def bg_image_url=: (String) -> String - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - ) -> void + attr_reader semitransparency: bool? - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - } + def semitransparency=: (bool) -> bool - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void - module Name - extend Imagekit::Internal::Type::Enum + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ + } - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_] - end - end + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer - type auto_description_extension = - { - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - } + attr_accessor min_confidence: Integer - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + attr_accessor name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ - def initialize: ( - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - ) -> void + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ + ) -> void - def to_hash: -> { - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - } + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_] + end + end + + type auto_description_extension = + { + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_ + } + + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_ + + def initialize: ( + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_ + ) -> void + + def to_hash: -> { + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_ + } + + type name_ = :"ai-auto-description" + + module Name + extend Imagekit::Internal::Type::Enum + + AI_AUTO_DESCRIPTION: :"ai-auto-description" - type name_ = :"ai-auto-description" + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_] + end + end - module Name - extend Imagekit::Internal::Type::Enum + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] + end + + type remove_ai_tags = ::Array[String] | :all + + module RemoveAITags + extend Imagekit::Internal::Type::Union - AI_AUTO_DESCRIPTION: :"ai-auto-description" + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags] - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_] + StringArray: Imagekit::Internal::Type::Converter + + ALL: :all end end - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::extension] - end + type change_publication_status = + { + publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + } - type remove_ai_tags = ::Array[String] | :all + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + attr_reader publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish? - module RemoveAITags - extend Imagekit::Internal::Type::Union + def publish=: ( + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + ) -> Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::remove_ai_tags] + def initialize: ( + ?publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + ) -> void - StringArray: Imagekit::Internal::Type::Converter + def to_hash: -> { + publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + } - ALL: :all - end + type publish = { is_published: bool, include_file_versions: bool } - type publish = { is_published: bool, include_file_versions: bool } + class Publish < Imagekit::Internal::Type::BaseModel + attr_accessor is_published: bool - class Publish < Imagekit::Internal::Type::BaseModel - attr_accessor is_published: bool + attr_reader include_file_versions: bool? - attr_reader include_file_versions: bool? + def include_file_versions=: (bool) -> bool - def include_file_versions=: (bool) -> bool + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void - def initialize: ( - is_published: bool, - ?include_file_versions: bool - ) -> void + def to_hash: -> { is_published: bool, include_file_versions: bool } + end + end - def to_hash: -> { is_published: bool, include_file_versions: bool } + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::update] end end end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index d47cd3f2..f4a55fa5 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -9,14 +9,7 @@ module Imagekit def update: ( String file_id, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], - ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, - ?publish: Imagekit::FileUpdateParams::Publish, + ?update: Imagekit::Models::FileUpdateParams::update, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::FileUpdateResponse From 8166ebef81498c39dc01eef60f115134389e75a0 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 08:23:45 +0000 Subject: [PATCH 014/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit/models/file_update_params.rb | 548 +++++----- lib/imagekit/resources/files.rb | 20 +- rbi/imagekit/models/file_update_params.rbi | 1048 +++++++++----------- rbi/imagekit/resources/files.rbi | 52 +- sig/imagekit/models/file_update_params.rbs | 393 ++++---- sig/imagekit/resources/files.rbs | 9 +- 7 files changed, 967 insertions(+), 1105 deletions(-) diff --git a/.stats.yml b/.stats.yml index 0384e026..91f8d8ce 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-a1cf25a2c075ef11eea56c771578a9c36aa5f37677389988c9fb0c776399bc1b.yml openapi_spec_hash: 8fed9fded4a79267764133be71b296e6 -config_hash: 398ac75e62a73363899d6839f61a5977 +config_hash: e212bc0b32d2d9fe583f77bccfae0375 diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index 3dcd61e1..fb5b5ccc 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -7,338 +7,304 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute update + # @!attribute custom_coordinates + # 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. # - # @return [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus, nil] - optional :update, union: -> { Imagekit::FileUpdateParams::Update } + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - # @!method initialize(update: nil, request_options: {}) - # @param update [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus] + # @!attribute custom_metadata + # 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. + # + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata + + # @!attribute description + # Optional text to describe the contents of the file. + # + # @return [String, nil] + optional :description, String + + # @!attribute extensions + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + # + # @return [Array, nil] + optional :extensions, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Extension] } + + # @!attribute remove_ai_tags + # 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. + # + # @return [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags, nil] + optional :remove_ai_tags, + union: -> { + Imagekit::FileUpdateParams::RemoveAITags + }, + api_name: :removeAITags + + # @!attribute tags + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!attribute publish + # Configure the publication status of a file and its versions. + # + # @return [Imagekit::Models::FileUpdateParams::Publish, nil] + optional :publish, -> { Imagekit::FileUpdateParams::Publish } + + # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams} for more details. + # + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - module Update + module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails } + variant -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension } - variant -> { Imagekit::FileUpdateParams::Update::ChangePublicationStatus } + variant -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension } - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel - # @!attribute custom_coordinates - # 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. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + variant -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension } - # @!attribute custom_metadata - # 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. + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name } - # @!attribute description - # Optional text to describe the contents of the file. + # @!attribute options # - # @return [String, nil] - optional :description, String + # @return [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options, nil] + optional :options, -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options } - # @!attribute extensions - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. + # @!method initialize(name:, options: nil) + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. # - # @return [Array, nil] - optional :extensions, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension] } + # @param options [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options] - # @!attribute remove_ai_tags - # 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. - # - # @return [Array, Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags, nil] - optional :remove_ai_tags, - union: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags }, - api_name: :removeAITags - - # @!attribute tags - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute webhook_url - # 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. + # Specifies the background removal extension. # - # @return [String, nil] - optional :webhook_url, String, api_name: :webhookUrl + # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#name + module Name + extend Imagekit::Internal::Type::Enum - # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails} for more - # details. - # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + REMOVE_BG = :"remove-bg" + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. # - # @param description [String] Optional text to describe the contents of the file. + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. # - # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - - module Extension - extend Imagekit::Internal::Type::Union - - variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension } - - variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension } - - variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name] - required :name, - enum: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name } - - # @!attribute options - # - # @return [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options, nil] - optional :options, - -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options } - - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. - # - # @param options [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options] - - # Specifies the background removal extension. - # - # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options} - # for more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name] - required :name, - enum: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. - # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name] - required :name, - enum: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. - - # Specifies the auto description extension. - # - # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION = :"ai-auto-description" - - # @!method self.values - # @return [Array] - end - end - - # @!method self.variants - # @return [Array(Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension)] + # @see Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] end + end - # 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". + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. # - # Note: The remove operation for `AITags` executes before any of the `extensions` - # are processed. + # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] + required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name } + + # @!method initialize(name:) + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + + # Specifies the auto description extension. # - # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails#remove_ai_tags - module RemoveAITags - extend Imagekit::Internal::Type::Union + # @see Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension#name + module Name + extend Imagekit::Internal::Type::Enum - variant -> { Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::StringArray } + AI_AUTO_DESCRIPTION = :"ai-auto-description" - variant const: -> { Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::ALL } + # @!method self.values + # @return [Array] + end + end - # @!method self.variants - # @return [Array(Array, Symbol)] + # @!method self.variants + # @return [Array(Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension)] + end - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(T::Array[String], Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::TaggedSymbol) } - end + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union - # @type [Imagekit::Internal::Type::Converter] - StringArray = Imagekit::Internal::Type::ArrayOf[String] + variant -> { Imagekit::Models::FileUpdateParams::RemoveAITags::StringArray } - # @!group + variant const: -> { Imagekit::Models::FileUpdateParams::RemoveAITags::ALL } - ALL = :all + # @!method self.variants + # @return [Array(Array, Symbol)] - # @!endgroup - end + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(T::Array[String], Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol) } end - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - # @!attribute publish - # Configure the publication status of a file and its versions. - # - # @return [Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish, nil] - optional :publish, -> { Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish } + # @type [Imagekit::Internal::Type::Converter] + StringArray = Imagekit::Internal::Type::ArrayOf[String] - # @!method initialize(publish: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus} for more - # details. - # - # @param publish [Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. + # @!group - # @see Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus#publish - class Publish < Imagekit::Internal::Type::BaseModel - # @!attribute is_published - # Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @return [Boolean] - required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + ALL = :all - # @!attribute include_file_versions - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - # - # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions - - # @!method initialize(is_published:, include_file_versions: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish} - # for more details. - # - # Configure the publication status of a file and its versions. - # - # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p - end - end + # @!endgroup + end - # @!method self.variants - # @return [Array(Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus)] + class Publish < Imagekit::Internal::Type::BaseModel + # @!attribute is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @return [Boolean] + required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + # + # @return [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + + # @!method initialize(is_published:, include_file_versions: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Publish} for more details. + # + # Configure the publication status of a file and its versions. + # + # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p end end end diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 6ab7ca55..e8a7a4c7 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -19,11 +19,25 @@ class Files # You can update `tags`, `customCoordinates`, `customMetadata`, publication # status, remove existing `AITags` and apply extensions using this API. # - # @overload update(file_id, update: nil, request_options: {}) + # @overload update(file_id, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param update [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus] + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -35,7 +49,7 @@ def update(file_id, params = {}) @client.request( method: :patch, path: ["v1/files/%1$s/details", file_id], - body: parsed[:update], + body: parsed, model: Imagekit::Models::FileUpdateResponse, options: options ) diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index f3acd59c..9d2a7633 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -11,50 +11,193 @@ module Imagekit T.any(Imagekit::FileUpdateParams, Imagekit::Internal::AnyHash) end + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + sig do + returns( + T.nilable( + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + ) + ] + ) + ) + end + attr_reader :extensions + + sig do + params( + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + ) + ] + ).void + end + attr_writer :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. sig do returns( T.nilable( T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol ) ) ) end - attr_reader :update + attr_reader :remove_ai_tags sig do params( - update: + remove_ai_tags: T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol ) ).void end - attr_writer :update + attr_writer :remove_ai_tags + + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + # Configure the publication status of a file and its versions. + sig { returns(T.nilable(Imagekit::FileUpdateParams::Publish)) } + attr_reader :publish + + sig { params(publish: Imagekit::FileUpdateParams::Publish::OrHash).void } + attr_writer :publish sig do params( - update: + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + ) + ], + remove_ai_tags: T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(update: nil, request_options: {}) + def self.new( + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, + # Configure the publication status of a file and its versions. + publish: nil, + request_options: {} + ) end sig do override.returns( { - update: + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + ) + ], + remove_ai_tags: T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish, request_options: Imagekit::RequestOptions } ) @@ -62,722 +205,451 @@ module Imagekit def to_hash end - module Update + module Extension extend Imagekit::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension ) end - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails, + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, Imagekit::Internal::AnyHash ) end - # 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. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # 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. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Optional text to describe the contents of the file. - sig { returns(T.nilable(String)) } - attr_reader :description - - sig { params(description: String).void } - attr_writer :description - - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. + # Specifies the background removal extension. sig do returns( - T.nilable( - T::Array[ - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension - ) - ] - ) + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol ) end - attr_reader :extensions + attr_accessor :name - sig do - params( - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::OrHash - ) - ] - ).void - end - attr_writer :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. sig do returns( T.nilable( - T.any( - T::Array[String], - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::OrSymbol - ) + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options ) ) end - attr_reader :remove_ai_tags + attr_reader :options sig do params( - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::OrSymbol - ) + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash ).void end - attr_writer :remove_ai_tags - - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :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. - sig { returns(T.nilable(String)) } - attr_reader :webhook_url - - sig { params(webhook_url: String).void } - attr_writer :webhook_url + attr_writer :options sig do params( - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::OrHash - ) - ], - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::OrSymbol - ), - tags: T.nilable(T::Array[String]), - webhook_url: String + name: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash ).returns(T.attached_class) end def self.new( - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil + # Specifies the background removal extension. + name:, + options: nil ) end sig do override.returns( { - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension - ) - ], - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::OrSymbol - ), - tags: T.nilable(T::Array[String]), - webhook_url: String + name: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + options: + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options } ) end def to_hash end - module Extension - extend Imagekit::Internal::Type::Union + # Specifies the background removal extension. + module Name + extend Imagekit::Internal::Type::Enum - Variants = + TaggedSymbol = T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension - ) - end - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the background removal extension. - sig do - returns( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::OrSymbol + T.all( + Symbol, + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name ) end - attr_accessor :name + OrSymbol = T.type_alias { T.any(Symbol, String) } - sig do - returns( - T.nilable( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options - ) - ) - end - attr_reader :options + REMOVE_BG = + T.let( + :"remove-bg", + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ) - sig do - params( - options: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options::OrHash - ).void - end - attr_writer :options - - sig do - params( - name: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options::OrHash - ).returns(T.attached_class) - end - def self.new( - # Specifies the background removal extension. - name:, - options: nil + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol + ] ) - end + end + def self.values + end + end - sig do - override.returns( - { - name: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::OrSymbol, - options: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options - } + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options, + Imagekit::Internal::AnyHash ) end - def to_hash - end - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash - ) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end + sig { params(bg_color: String).void } + attr_writer :bg_color - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the auto description extension. - sig do - returns( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::OrSymbol - ) - end - attr_accessor :name + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url - sig do - params( - name: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Specifies the auto description extension. - name: - ) - end + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency - sig do - override.returns( - { - name: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::OrSymbol - } - ) - end - def to_hash - end + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) end sig do override.returns( - T::Array[ - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::Variants - ] + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } ) end - def self.variants + def to_hash end end + end - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - T::Array[String], - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::TaggedSymbol - ) - end - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::Variants - ] + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash ) end - def self.variants - end - StringArray = - T.let( - Imagekit::Internal::Type::ArrayOf[String], - Imagekit::Internal::Type::Converter - ) + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name ) end OrSymbol = T.type_alias { T.any(Symbol, String) } - ALL = + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = T.let( - :all, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::TaggedSymbol + :"aws-auto-tagging", + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end end end - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Update::ChangePublicationStatus, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension, Imagekit::Internal::AnyHash ) end - # Configure the publication status of a file and its versions. + # Specifies the auto description extension. sig do returns( - T.nilable( - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - ) + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol ) end - attr_reader :publish - - sig do - params( - publish: - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish::OrHash - ).void - end - attr_writer :publish + attr_accessor :name sig do params( - publish: - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish::OrHash + name: + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol ).returns(T.attached_class) end def self.new( - # Configure the publication status of a file and its versions. - publish: nil + # Specifies the auto description extension. + name: ) end sig do override.returns( { - publish: - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + name: + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol } ) end def to_hash end - class Publish < Imagekit::Internal::Type::BaseModel - OrHash = + # Specifies the auto description extension. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish, - Imagekit::Internal::AnyHash + T.all( + Symbol, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name ) end + OrSymbol = T.type_alias { T.any(Symbol, String) } - # Set to `true` to publish the file. Set to `false` to unpublish the file. - sig { returns(T::Boolean) } - attr_accessor :is_published - - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_file_versions - - sig { params(include_file_versions: T::Boolean).void } - attr_writer :include_file_versions - - # Configure the publication status of a file and its versions. - sig do - params( - is_published: T::Boolean, - include_file_versions: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Set to `true` to publish the file. Set to `false` to unpublish the file. - is_published:, - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - include_file_versions: nil - ) - end + AI_AUTO_DESCRIPTION = + T.let( + :"ai-auto-description", + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ) sig do override.returns( - { is_published: T::Boolean, include_file_versions: T::Boolean } + T::Array[ + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol + ] ) end - def to_hash + def self.values end end end sig do override.returns( - T::Array[Imagekit::FileUpdateParams::Update::Variants] + T::Array[Imagekit::FileUpdateParams::Extension::Variants] + ) + end + def self.variants + end + end + + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol + ) + end + + sig do + override.returns( + T::Array[Imagekit::FileUpdateParams::RemoveAITags::Variants] ) end def self.variants end + + StringArray = + T.let( + Imagekit::Internal::Type::ArrayOf[String], + Imagekit::Internal::Type::Converter + ) + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::FileUpdateParams::RemoveAITags) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ALL = + T.let(:all, Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol) + end + + class Publish < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Publish, + Imagekit::Internal::AnyHash + ) + end + + # Set to `true` to publish the file. Set to `false` to unpublish the file. + sig { returns(T::Boolean) } + attr_accessor :is_published + + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions + + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions + + # Configure the publication status of a file and its versions. + sig do + params( + is_published: T::Boolean, + include_file_versions: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Set to `true` to publish the file. Set to `false` to unpublish the file. + is_published:, + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + include_file_versions: nil + ) + end + + sig do + override.returns( + { is_published: T::Boolean, include_file_versions: T::Boolean } + ) + end + def to_hash + end end end end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index a6241a22..dbf5ec42 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -18,11 +18,25 @@ module Imagekit sig do params( file_id: String, - update: + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, + Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + ) + ], + remove_ai_tags: T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash + T::Array[String], + Imagekit::FileUpdateParams::RemoveAITags::OrSymbol ), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::FileUpdateResponse) end @@ -30,7 +44,37 @@ module Imagekit # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. file_id, - update: nil, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, + # Configure the publication status of a file and its versions. + publish: nil, request_options: {} ) end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index 786cfc9c..efeb8866 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -1,300 +1,259 @@ module Imagekit module Models type file_update_params = - { update: Imagekit::Models::FileUpdateParams::update } + { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], + remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish + } & Imagekit::Internal::Type::request_parameters class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_reader update: Imagekit::Models::FileUpdateParams::update? - - def update=: ( - Imagekit::Models::FileUpdateParams::update - ) -> Imagekit::Models::FileUpdateParams::update + attr_accessor custom_coordinates: String? - def initialize: ( - ?update: Imagekit::Models::FileUpdateParams::update, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - update: Imagekit::Models::FileUpdateParams::update, - request_options: Imagekit::RequestOptions - } + attr_reader custom_metadata: ::Hash[Symbol, top]? - type update = - Imagekit::FileUpdateParams::Update::UpdateFileDetails - | Imagekit::FileUpdateParams::Update::ChangePublicationStatus + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - module Update - extend Imagekit::Internal::Type::Union + attr_reader description: String? - type update_file_details = - { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], - remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String - } + def description=: (String) -> String - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel - attr_accessor custom_coordinates: String? + attr_reader extensions: ::Array[Imagekit::Models::FileUpdateParams::extension]? - attr_reader custom_metadata: ::Hash[Symbol, top]? + def extensions=: ( + ::Array[Imagekit::Models::FileUpdateParams::extension] + ) -> ::Array[Imagekit::Models::FileUpdateParams::extension] - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags? - attr_reader description: String? + def remove_ai_tags=: ( + Imagekit::Models::FileUpdateParams::remove_ai_tags + ) -> Imagekit::Models::FileUpdateParams::remove_ai_tags - def description=: (String) -> String + attr_accessor tags: ::Array[String]? - attr_reader extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension]? + attr_reader webhook_url: String? - def extensions=: ( - ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] - ) -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] + def webhook_url=: (String) -> String - attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags? + attr_reader publish: Imagekit::FileUpdateParams::Publish? - def remove_ai_tags=: ( - Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags - ) -> Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags + def publish=: ( + Imagekit::FileUpdateParams::Publish + ) -> Imagekit::FileUpdateParams::Publish - attr_accessor tags: ::Array[String]? + def initialize: ( + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], + ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, + ?publish: Imagekit::FileUpdateParams::Publish, + ?request_options: Imagekit::request_opts + ) -> void - attr_reader webhook_url: String? + def to_hash: -> { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], + remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish, + request_options: Imagekit::RequestOptions + } - def webhook_url=: (String) -> String + type extension = + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension + | Imagekit::FileUpdateParams::Extension::AutoTaggingExtension + | Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension - def initialize: ( - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], - ?remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String - ) -> void + module Extension + extend Imagekit::Internal::Type::Union - def to_hash: -> { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], - remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String + type removedot_bg_extension = + { + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options } - type extension = - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension - | Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension - | Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension - - module Extension - extend Imagekit::Internal::Type::Union - - type removedot_bg_extension = - { - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options - } - - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_ - - attr_reader options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options? + class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_ - def options=: ( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options - ) -> Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options + attr_reader options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options? - def initialize: ( - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options - ) -> void + def options=: ( + Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ) -> Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - def to_hash: -> { - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::Options - } - - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemovedotBgExtension::name_] - end - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } + def initialize: ( + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + ?options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ) -> void - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? + def to_hash: -> { + name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, + options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + } - def add_shadow=: (bool) -> bool + type name_ = :"remove-bg" - attr_reader bg_color: String? + module Name + extend Imagekit::Internal::Type::Enum - def bg_color=: (String) -> String + REMOVE_BG: :"remove-bg" - attr_reader bg_image_url: String? + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_] + end - def bg_image_url=: (String) -> String + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } - attr_reader semitransparency: bool? + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? - def semitransparency=: (bool) -> bool + def add_shadow=: (bool) -> bool - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void + attr_reader bg_color: String? - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end + def bg_color=: (String) -> String - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ - } + attr_reader bg_image_url: String? - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer + def bg_image_url=: (String) -> String - attr_accessor min_confidence: Integer + attr_reader semitransparency: bool? - attr_accessor name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ + def semitransparency=: (bool) -> bool - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ - ) -> void + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ - } + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + } - module Name - extend Imagekit::Internal::Type::Enum + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" + attr_accessor min_confidence: Integer - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_] - end - end + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - type auto_description_extension = - { - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_ - } + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + ) -> void - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_ + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + } - def initialize: ( - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_ - ) -> void + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - def to_hash: -> { - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_ - } + module Name + extend Imagekit::Internal::Type::Enum - type name_ = :"ai-auto-description" + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" - module Name - extend Imagekit::Internal::Type::Enum + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_] + end + end - AI_AUTO_DESCRIPTION: :"ai-auto-description" + type auto_description_extension = + { + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + } - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoDescriptionExtension::name_] - end - end + class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] - end + def initialize: ( + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + ) -> void - type remove_ai_tags = ::Array[String] | :all + def to_hash: -> { + name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + } - module RemoveAITags - extend Imagekit::Internal::Type::Union + type name_ = :"ai-auto-description" - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags] + module Name + extend Imagekit::Internal::Type::Enum - StringArray: Imagekit::Internal::Type::Converter + AI_AUTO_DESCRIPTION: :"ai-auto-description" - ALL: :all + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_] end end - type change_publication_status = - { - publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - } + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::extension] + end - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - attr_reader publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish? + type remove_ai_tags = ::Array[String] | :all - def publish=: ( - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - ) -> Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + module RemoveAITags + extend Imagekit::Internal::Type::Union - def initialize: ( - ?publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - ) -> void + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::remove_ai_tags] - def to_hash: -> { - publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - } + StringArray: Imagekit::Internal::Type::Converter - type publish = { is_published: bool, include_file_versions: bool } + ALL: :all + end - class Publish < Imagekit::Internal::Type::BaseModel - attr_accessor is_published: bool + type publish = { is_published: bool, include_file_versions: bool } - attr_reader include_file_versions: bool? + class Publish < Imagekit::Internal::Type::BaseModel + attr_accessor is_published: bool - def include_file_versions=: (bool) -> bool + attr_reader include_file_versions: bool? - def initialize: ( - is_published: bool, - ?include_file_versions: bool - ) -> void + def include_file_versions=: (bool) -> bool - def to_hash: -> { is_published: bool, include_file_versions: bool } - end - end + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::update] + def to_hash: -> { is_published: bool, include_file_versions: bool } end end end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index f4a55fa5..d47cd3f2 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -9,7 +9,14 @@ module Imagekit def update: ( String file_id, - ?update: Imagekit::Models::FileUpdateParams::update, + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], + ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, + ?publish: Imagekit::FileUpdateParams::Publish, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::FileUpdateResponse From 7db40087c4696d56dbce666934d8df715d2d293a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 08:30:05 +0000 Subject: [PATCH 015/178] codegen metadata --- .stats.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index 91f8d8ce..2b058894 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-a1cf25a2c075ef11eea56c771578a9c36aa5f37677389988c9fb0c776399bc1b.yml -openapi_spec_hash: 8fed9fded4a79267764133be71b296e6 -config_hash: e212bc0b32d2d9fe583f77bccfae0375 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-ba44a73e45777c7f0831ac2026a9b63ae01f681b6acff7c7f80d7294d1f4ee4a.yml +openapi_spec_hash: df7bdce53da43b2ceae08a2a47bd1b52 +config_hash: b75c4e4432c2d0650589863f8336849b From 22879551b076c711631357c1d13b7796e0036dc9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 08:33:37 +0000 Subject: [PATCH 016/178] feat(api): manual updates --- .stats.yml | 4 +- lib/imagekit/models/file_update_params.rb | 70 ++++------ lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models/file_update_params.rbi | 148 +++++---------------- rbi/imagekit/resources/files.rbi | 6 +- sig/imagekit/models/file_update_params.rbs | 65 +++------ 6 files changed, 82 insertions(+), 213 deletions(-) diff --git a/.stats.yml b/.stats.yml index 2b058894..dc773365 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-ba44a73e45777c7f0831ac2026a9b63ae01f681b6acff7c7f80d7294d1f4ee4a.yml -openapi_spec_hash: df7bdce53da43b2ceae08a2a47bd1b52 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-7df229db9f102454c11cef7c98953e5b6463221dd4be66cdb4f4e93f41d447ae.yml +openapi_spec_hash: ecaba4c44e684a0611699e09fca9891b config_hash: b75c4e4432c2d0650589863f8336849b diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index fb5b5ccc..ad7b1938 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -34,7 +34,7 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Extension] } @@ -87,7 +87,7 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car # @@ -102,42 +102,32 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension } + discriminator :name - variant -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension } + variant :"remove-bg", -> { Imagekit::FileUpdateParams::Extension::RemoveBg } + + variant :"ai-auto-description", -> { Imagekit::FileUpdateParams::Extension::AIAutoDescription } - variant -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension } + variant -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension } - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekit::Internal::Type::BaseModel # @!attribute name # Specifies the background removal extension. # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name } + # @return [Symbol, :"remove-bg"] + required :name, const: :"remove-bg" # @!attribute options # - # @return [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options, nil] - optional :options, -> { Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options } + # @return [Imagekit::Models::FileUpdateParams::Extension::RemoveBg::Options, nil] + optional :options, -> { Imagekit::FileUpdateParams::Extension::RemoveBg::Options } - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # @!method initialize(options: nil, name: :"remove-bg") + # @param options [Imagekit::Models::FileUpdateParams::Extension::RemoveBg::Options] # - # @param options [Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options] + # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. - # Specifies the background removal extension. - # - # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension#options + # @see Imagekit::Models::FileUpdateParams::Extension::RemoveBg#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute add_shadow # Whether to add an artificial shadow to the result. Default is false. Note: @@ -170,8 +160,8 @@ class Options < Imagekit::Internal::Type::BaseModel # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::Options} - # for more details. + # {Imagekit::Models::FileUpdateParams::Extension::RemoveBg::Options} for more + # details. # # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin # @@ -223,31 +213,19 @@ module Name end end - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekit::Internal::Type::BaseModel # @!attribute name # Specifies the auto description extension. # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. - - # Specifies the auto description extension. - # - # @see Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION = :"ai-auto-description" + # @return [Symbol, :"ai-auto-description"] + required :name, const: :"ai-auto-description" - # @!method self.values - # @return [Array] - end + # @!method initialize(name: :"ai-auto-description") + # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. end # @!method self.variants - # @return [Array(Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::FileUpdateParams::Extension::RemoveBg, Imagekit::Models::FileUpdateParams::Extension::AIAutoDescription, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension)] end # An array of AITags associated with the file that you want to remove, e.g. diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index e8a7a4c7..f2035a13 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -29,7 +29,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car # diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index 9d2a7633..2a25eca1 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -39,9 +39,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + Imagekit::FileUpdateParams::Extension::RemoveBg, + Imagekit::FileUpdateParams::Extension::AIAutoDescription, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension ) ] ) @@ -54,9 +54,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::FileUpdateParams::Extension::RemoveBg::OrHash, + Imagekit::FileUpdateParams::Extension::AIAutoDescription::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash ) ] ).void @@ -124,9 +124,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::FileUpdateParams::Extension::RemoveBg::OrHash, + Imagekit::FileUpdateParams::Extension::AIAutoDescription::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash ) ], remove_ai_tags: @@ -185,9 +185,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + Imagekit::FileUpdateParams::Extension::RemoveBg, + Imagekit::FileUpdateParams::Extension::AIAutoDescription, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension ) ], remove_ai_tags: @@ -211,33 +211,29 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension + Imagekit::FileUpdateParams::Extension::RemoveBg, + Imagekit::FileUpdateParams::Extension::AIAutoDescription, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension ) end - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension, + Imagekit::FileUpdateParams::Extension::RemoveBg, Imagekit::Internal::AnyHash ) end # Specifies the background removal extension. - sig do - returns( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :name sig do returns( T.nilable( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + Imagekit::FileUpdateParams::Extension::RemoveBg::Options ) ) end @@ -246,74 +242,42 @@ module Imagekit sig do params( options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + Imagekit::FileUpdateParams::Extension::RemoveBg::Options::OrHash ).void end attr_writer :options sig do params( - name: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options::OrHash + Imagekit::FileUpdateParams::Extension::RemoveBg::Options::OrHash, + name: Symbol ).returns(T.attached_class) end def self.new( + options: nil, # Specifies the background removal extension. - name:, - options: nil + name: :"remove-bg" ) end sig do override.returns( { - name: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::OrSymbol, + name: Symbol, options: - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + Imagekit::FileUpdateParams::Extension::RemoveBg::Options } ) end def to_hash end - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - class Options < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options, + Imagekit::FileUpdateParams::Extension::RemoveBg::Options, Imagekit::Internal::AnyHash ) end @@ -483,75 +447,29 @@ module Imagekit end end - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension, + Imagekit::FileUpdateParams::Extension::AIAutoDescription, Imagekit::Internal::AnyHash ) end # Specifies the auto description extension. - sig do - returns( - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :name - sig do - params( - name: - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ).returns(T.attached_class) - end + sig { params(name: Symbol).returns(T.attached_class) } def self.new( # Specifies the auto description extension. - name: + name: :"ai-auto-description" ) end - sig do - override.returns( - { - name: - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::OrSymbol - } - ) - end + sig { override.returns({ name: Symbol }) } def to_hash end - - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index dbf5ec42..5d2929cb 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -24,9 +24,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::FileUpdateParams::Extension::RemoveBg::OrHash, + Imagekit::FileUpdateParams::Extension::AIAutoDescription::OrHash, + Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash ) ], remove_ai_tags: diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index efeb8866..659c5a64 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -76,48 +76,38 @@ module Imagekit } type extension = - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension + Imagekit::FileUpdateParams::Extension::RemoveBg + | Imagekit::FileUpdateParams::Extension::AIAutoDescription | Imagekit::FileUpdateParams::Extension::AutoTaggingExtension - | Imagekit::FileUpdateParams::Extension::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union - type removedot_bg_extension = + type remove_bg = { - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + name: :"remove-bg", + options: Imagekit::FileUpdateParams::Extension::RemoveBg::Options } - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_ + class RemoveBg < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"remove-bg" - attr_reader options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options? + attr_reader options: Imagekit::FileUpdateParams::Extension::RemoveBg::Options? def options=: ( - Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options - ) -> Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + Imagekit::FileUpdateParams::Extension::RemoveBg::Options + ) -> Imagekit::FileUpdateParams::Extension::RemoveBg::Options def initialize: ( - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + ?options: Imagekit::FileUpdateParams::Extension::RemoveBg::Options, + ?name: :"remove-bg" ) -> void def to_hash: -> { - name: Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUpdateParams::Extension::RemovedotBgExtension::Options + name: :"remove-bg", + options: Imagekit::FileUpdateParams::Extension::RemoveBg::Options } - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::RemovedotBgExtension::name_] - end - type options = { add_shadow: bool, @@ -197,31 +187,14 @@ module Imagekit end end - type auto_description_extension = - { - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - } - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ + type ai_auto_description = { name: :"ai-auto-description" } - def initialize: ( - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - ) -> void - - def to_hash: -> { - name: Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_ - } + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"ai-auto-description" - type name_ = :"ai-auto-description" + def initialize: (?name: :"ai-auto-description") -> void - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION: :"ai-auto-description" - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoDescriptionExtension::name_] - end + def to_hash: -> { name: :"ai-auto-description" } end def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::extension] From c17463abad966573c66996d80c124323e2a3a4ee Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 09:58:08 +0000 Subject: [PATCH 017/178] feat(api): manual updates --- .stats.yml | 4 +- .../accounts/url_endpoint_create_params.rb | 79 +--- .../accounts/url_endpoint_update_params.rb | 79 +--- .../models/beta/v2/file_upload_params.rb | 200 +++----- lib/imagekit/models/file_upload_params.rb | 203 +++----- .../resources/accounts/url_endpoints.rb | 4 +- lib/imagekit/resources/beta/v2/files.rb | 2 +- lib/imagekit/resources/files.rb | 2 +- .../accounts/url_endpoint_create_params.rbi | 198 ++------ .../accounts/url_endpoint_update_params.rbi | 198 ++------ .../models/beta/v2/file_upload_params.rbi | 442 ++++-------------- rbi/imagekit/models/file_upload_params.rbi | 442 ++++-------------- .../resources/accounts/url_endpoints.rbi | 12 +- rbi/imagekit/resources/beta/v2/files.rbi | 6 +- rbi/imagekit/resources/files.rbi | 6 +- .../accounts/url_endpoint_create_params.rbs | 87 +--- .../accounts/url_endpoint_update_params.rbs | 87 +--- .../models/beta/v2/file_upload_params.rbs | 197 ++------ sig/imagekit/models/file_upload_params.rbs | 197 ++------ 19 files changed, 591 insertions(+), 1854 deletions(-) diff --git a/.stats.yml b/.stats.yml index dc773365..9d8aa405 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-7df229db9f102454c11cef7c98953e5b6463221dd4be66cdb4f4e93f41d447ae.yml -openapi_spec_hash: ecaba4c44e684a0611699e09fca9891b +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-6c237ebd6f81741286e7cfbaeac1356da3e18c7fe43b74d6c358d62bfb40dbb9.yml +openapi_spec_hash: ad6a65d74e3eb865a5d2915177f92ea7 config_hash: b75c4e4432c2d0650589863f8336849b diff --git a/lib/imagekit/models/accounts/url_endpoint_create_params.rb b/lib/imagekit/models/accounts/url_endpoint_create_params.rb index f8e23117..a4280d24 100644 --- a/lib/imagekit/models/accounts/url_endpoint_create_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_create_params.rb @@ -32,7 +32,7 @@ class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter, nil] + # @return [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Akamai, nil] optional :url_rewriter, union: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter }, api_name: :urlRewriter @@ -47,7 +47,7 @@ class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Akamai] Configuration for third-party URL rewriting. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] @@ -55,18 +55,19 @@ class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel module URLRewriter extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter } + discriminator :type - variant -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter } + variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary } - variant -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter } + variant :IMGIX, -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + variant :AKAMAI, -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai } + + class Cloudinary < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type] - required :type, - enum: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type } + # @return [Symbol, :CLOUDINARY] + required :type, const: :CLOUDINARY # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. @@ -76,66 +77,34 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel Imagekit::Internal::Type::Boolean, api_name: :preserveAssetDeliveryTypes - # @!method initialize(type:, preserve_asset_delivery_types: nil) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type] - # + # @!method initialize(preserve_asset_delivery_types: nil, type: :CLOUDINARY) # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. - - # @see Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY = :CLOUDINARY - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :CLOUDINARY] end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type] - required :type, - enum: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type } + # @return [Symbol, :IMGIX] + required :type, const: :IMGIX - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - IMGIX = :IMGIX - - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :IMGIX) + # @param type [Symbol, :IMGIX] end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type] - required :type, - enum: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - AKAMAI = :AKAMAI + # @return [Symbol, :AKAMAI] + required :type, const: :AKAMAI - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :AKAMAI) + # @param type [Symbol, :AKAMAI] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter)] + # @return [Array(Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Akamai)] end end end diff --git a/lib/imagekit/models/accounts/url_endpoint_update_params.rb b/lib/imagekit/models/accounts/url_endpoint_update_params.rb index e41a503f..bfe08c46 100644 --- a/lib/imagekit/models/accounts/url_endpoint_update_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_update_params.rb @@ -32,7 +32,7 @@ class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter, nil] + # @return [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai, nil] optional :url_rewriter, union: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter }, api_name: :urlRewriter @@ -47,7 +47,7 @@ class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai] Configuration for third-party URL rewriting. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] @@ -55,18 +55,19 @@ class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel module URLRewriter extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter } + discriminator :type - variant -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter } + variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary } - variant -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter } + variant :IMGIX, -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + variant :AKAMAI, -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai } + + class Cloudinary < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type] - required :type, - enum: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type } + # @return [Symbol, :CLOUDINARY] + required :type, const: :CLOUDINARY # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. @@ -76,66 +77,34 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel Imagekit::Internal::Type::Boolean, api_name: :preserveAssetDeliveryTypes - # @!method initialize(type:, preserve_asset_delivery_types: nil) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type] - # + # @!method initialize(preserve_asset_delivery_types: nil, type: :CLOUDINARY) # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. - - # @see Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY = :CLOUDINARY - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :CLOUDINARY] end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type] - required :type, - enum: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type } + # @return [Symbol, :IMGIX] + required :type, const: :IMGIX - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - IMGIX = :IMGIX - - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :IMGIX) + # @param type [Symbol, :IMGIX] end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type] - required :type, - enum: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - AKAMAI = :AKAMAI + # @return [Symbol, :AKAMAI] + required :type, const: :AKAMAI - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :AKAMAI) + # @param type [Symbol, :AKAMAI] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter)] + # @return [Array(Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai)] end end end diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index 2ea95bd9..044d0f30 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -87,7 +87,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the image. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Extension] } @@ -225,7 +225,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -256,42 +256,32 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension } + discriminator :name - variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension } + variant :"remove-bg", -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg } + + variant :"ai-auto-description", -> { Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription } - variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension } + variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension } - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekit::Internal::Type::BaseModel # @!attribute name # Specifies the background removal extension. # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name] - required :name, enum: -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name } + # @return [Symbol, :"remove-bg"] + required :name, const: :"remove-bg" # @!attribute options # - # @return [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options, nil] - optional :options, -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options } - - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. - # - # @param options [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options] + # @return [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg::Options, nil] + optional :options, -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options } - # Specifies the background removal extension. + # @!method initialize(options: nil, name: :"remove-bg") + # @param options [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg::Options] # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG = :"remove-bg" + # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension#options + # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute add_shadow # Whether to add an artificial shadow to the result. Default is false. Note: @@ -324,8 +314,8 @@ class Options < Imagekit::Internal::Type::BaseModel # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options} - # for more details. + # {Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg::Options} for + # more details. # # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin # @@ -377,32 +367,19 @@ module Name end end - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekit::Internal::Type::BaseModel # @!attribute name # Specifies the auto description extension. # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name] - required :name, - enum: -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. + # @return [Symbol, :"ai-auto-description"] + required :name, const: :"ai-auto-description" - # Specifies the auto description extension. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION = :"ai-auto-description" - - # @!method self.values - # @return [Array] - end + # @!method initialize(name: :"ai-auto-description") + # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. end # @!method self.variants - # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AIAutoDescription, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension)] end module ResponseField @@ -426,7 +403,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # Each item must match one of the following types: `transformation`, # `gif-to-video`, `thumbnail`, `abs`. # - # @return [Array, nil] + # @return [Array, nil] optional :post, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Transformation::Post] } @@ -453,28 +430,29 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # You can mix and match any combination of post-processing types. # - # @param post [Array] List of transformations to apply _after_ the file is uploaded. + # @param post [Array] List of transformations to apply _after_ the file is uploaded. # # @param pre [String] Transformation string to apply before uploading the file to the Media Library. U module Post extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation } + discriminator :type - variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo } + variant :transformation, -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation } - variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail } + variant :"gif-to-video", -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo } - variant -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming } + variant :thumbnail, -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail } - class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + variant :abs, -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs } + + class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # Transformation type. # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] - required :type, - enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type } + # @return [Symbol, :transformation] + required :type, const: :transformation # @!attribute value # Transformation string (e.g. `w-200,h-200`). @@ -483,35 +461,22 @@ class SimplePostTransformation < Imagekit::Internal::Type::BaseModel # @return [String] required :value, String - # @!method initialize(type:, value:) + # @!method initialize(value:, type: :transformation) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation} + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Transformation} # for more details. # - # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] Transformation type. - # # @param value [String] Transformation string (e.g. `w-200,h-200`). - - # Transformation type. # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation#type - module Type - extend Imagekit::Internal::Type::Enum - - TRANSFORMATION = :transformation - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :transformation] Transformation type. end - class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekit::Internal::Type::BaseModel # @!attribute type # Converts an animated GIF into an MP4. # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] - required :type, - enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type } + # @return [Symbol, :"gif-to-video"] + required :type, const: :"gif-to-video" # @!attribute value # Optional transformation string to apply to the output video. @@ -520,35 +485,22 @@ class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :value, String - # @!method initialize(type:, value: nil) + # @!method initialize(value: nil, type: :"gif-to-video") # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo} + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo} # for more details. # - # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] Converts an animated GIF into an MP4. - # # @param value [String] Optional transformation string to apply to the output video. - - # Converts an animated GIF into an MP4. # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo#type - module Type - extend Imagekit::Internal::Type::Enum - - GIF_TO_VIDEO = :"gif-to-video" - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :"gif-to-video"] Converts an animated GIF into an MP4. end - class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekit::Internal::Type::BaseModel # @!attribute type # Generates a thumbnail image. # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] - required :type, - enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type } + # @return [Symbol, :thumbnail] + required :type, const: :thumbnail # @!attribute value # Optional transformation string. @@ -557,42 +509,28 @@ class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :value, String - # @!method initialize(type:, value: nil) + # @!method initialize(value: nil, type: :thumbnail) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail} + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail} # for more details. # - # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] Generates a thumbnail image. - # # @param value [String] Optional transformation string. - - # Generates a thumbnail image. # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail#type - module Type - extend Imagekit::Internal::Type::Enum - - THUMBNAIL = :thumbnail - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :thumbnail] Generates a thumbnail image. end - class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + class Abs < Imagekit::Internal::Type::BaseModel # @!attribute protocol # Streaming protocol to use (`hls` or `dash`). # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] - required :protocol, - enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol } + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol] + required :protocol, enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol } # @!attribute type # Adaptive Bitrate Streaming (ABS) setup. # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] - required :type, - enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type } + # @return [Symbol, :abs] + required :type, const: :abs # @!attribute value # List of different representations you want to create separated by an underscore. @@ -600,20 +538,20 @@ class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel # @return [String] required :value, String - # @!method initialize(protocol:, type:, value:) + # @!method initialize(protocol:, value:, type: :abs) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming} - # for more details. + # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs} for + # more details. # - # @param protocol [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] Streaming protocol to use (`hls` or `dash`). - # - # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] Adaptive Bitrate Streaming (ABS) setup. + # @param protocol [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol] Streaming protocol to use (`hls` or `dash`). # # @param value [String] List of different representations you want to create separated by an underscore. + # + # @param type [Symbol, :abs] Adaptive Bitrate Streaming (ABS) setup. # Streaming protocol to use (`hls` or `dash`). # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming#protocol + # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs#protocol module Protocol extend Imagekit::Internal::Type::Enum @@ -623,22 +561,10 @@ module Protocol # @!method self.values # @return [Array] end - - # Adaptive Bitrate Streaming (ABS) setup. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming#type - module Type - extend Imagekit::Internal::Type::Enum - - ABS = :abs - - # @!method self.values - # @return [Array] - end end # @!method self.variants - # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming)] + # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Transformation, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs)] end end end diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index 41b027ab..f1a86697 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -94,7 +94,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the image. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Extension] } @@ -256,7 +256,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -291,42 +291,32 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel module Extension extend Imagekit::Internal::Type::Union - variant -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension } + discriminator :name - variant -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension } + variant :"remove-bg", -> { Imagekit::FileUploadParams::Extension::RemoveBg } + + variant :"ai-auto-description", -> { Imagekit::FileUploadParams::Extension::AIAutoDescription } - variant -> { Imagekit::FileUploadParams::Extension::AutoDescriptionExtension } + variant -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension } - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekit::Internal::Type::BaseModel # @!attribute name # Specifies the background removal extension. # - # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Name] - required :name, enum: -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name } + # @return [Symbol, :"remove-bg"] + required :name, const: :"remove-bg" # @!attribute options # - # @return [Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options, nil] - optional :options, -> { Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options } + # @return [Imagekit::Models::FileUploadParams::Extension::RemoveBg::Options, nil] + optional :options, -> { Imagekit::FileUploadParams::Extension::RemoveBg::Options } - # @!method initialize(name:, options: nil) - # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Name] Specifies the background removal extension. + # @!method initialize(options: nil, name: :"remove-bg") + # @param options [Imagekit::Models::FileUploadParams::Extension::RemoveBg::Options] # - # @param options [Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options] - - # Specifies the background removal extension. - # - # @see Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension#name - module Name - extend Imagekit::Internal::Type::Enum + # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. - REMOVE_BG = :"remove-bg" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension#options + # @see Imagekit::Models::FileUploadParams::Extension::RemoveBg#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute add_shadow # Whether to add an artificial shadow to the result. Default is false. Note: @@ -359,8 +349,8 @@ class Options < Imagekit::Internal::Type::BaseModel # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::Options} - # for more details. + # {Imagekit::Models::FileUploadParams::Extension::RemoveBg::Options} for more + # details. # # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin # @@ -412,31 +402,19 @@ module Name end end - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekit::Internal::Type::BaseModel # @!attribute name # Specifies the auto description extension. # - # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::Name] - required :name, enum: -> { Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name } - - # @!method initialize(name:) - # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::Name] Specifies the auto description extension. - - # Specifies the auto description extension. - # - # @see Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - AI_AUTO_DESCRIPTION = :"ai-auto-description" + # @return [Symbol, :"ai-auto-description"] + required :name, const: :"ai-auto-description" - # @!method self.values - # @return [Array] - end + # @!method initialize(name: :"ai-auto-description") + # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. end # @!method self.variants - # @return [Array(Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension, Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension)] + # @return [Array(Imagekit::Models::FileUploadParams::Extension::RemoveBg, Imagekit::Models::FileUploadParams::Extension::AIAutoDescription, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension)] end module ResponseField @@ -460,7 +438,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # Each item must match one of the following types: `transformation`, # `gif-to-video`, `thumbnail`, `abs`. # - # @return [Array, nil] + # @return [Array, nil] optional :post, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Transformation::Post] } @@ -487,28 +465,29 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # You can mix and match any combination of post-processing types. # - # @param post [Array] List of transformations to apply _after_ the file is uploaded. + # @param post [Array] List of transformations to apply _after_ the file is uploaded. # # @param pre [String] Transformation string to apply before uploading the file to the Media Library. U module Post extend Imagekit::Internal::Type::Union - variant -> { Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation } + discriminator :type - variant -> { Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo } + variant :transformation, -> { Imagekit::FileUploadParams::Transformation::Post::Transformation } - variant -> { Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail } + variant :"gif-to-video", -> { Imagekit::FileUploadParams::Transformation::Post::GifToVideo } - variant -> { Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming } + variant :thumbnail, -> { Imagekit::FileUploadParams::Transformation::Post::Thumbnail } - class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + variant :abs, -> { Imagekit::FileUploadParams::Transformation::Post::Abs } + + class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # Transformation type. # - # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] - required :type, - enum: -> { Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type } + # @return [Symbol, :transformation] + required :type, const: :transformation # @!attribute value # Transformation string (e.g. `w-200,h-200`). @@ -517,34 +496,22 @@ class SimplePostTransformation < Imagekit::Internal::Type::BaseModel # @return [String] required :value, String - # @!method initialize(type:, value:) + # @!method initialize(value:, type: :transformation) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation} - # for more details. - # - # @param type [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::Type] Transformation type. + # {Imagekit::Models::FileUploadParams::Transformation::Post::Transformation} for + # more details. # # @param value [String] Transformation string (e.g. `w-200,h-200`). - - # Transformation type. # - # @see Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation#type - module Type - extend Imagekit::Internal::Type::Enum - - TRANSFORMATION = :transformation - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :transformation] Transformation type. end - class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekit::Internal::Type::BaseModel # @!attribute type # Converts an animated GIF into an MP4. # - # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] - required :type, enum: -> { Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type } + # @return [Symbol, :"gif-to-video"] + required :type, const: :"gif-to-video" # @!attribute value # Optional transformation string to apply to the output video. @@ -553,34 +520,22 @@ class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :value, String - # @!method initialize(type:, value: nil) + # @!method initialize(value: nil, type: :"gif-to-video") # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo} - # for more details. - # - # @param type [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type] Converts an animated GIF into an MP4. + # {Imagekit::Models::FileUploadParams::Transformation::Post::GifToVideo} for more + # details. # # @param value [String] Optional transformation string to apply to the output video. - - # Converts an animated GIF into an MP4. # - # @see Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo#type - module Type - extend Imagekit::Internal::Type::Enum - - GIF_TO_VIDEO = :"gif-to-video" - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :"gif-to-video"] Converts an animated GIF into an MP4. end - class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekit::Internal::Type::BaseModel # @!attribute type # Generates a thumbnail image. # - # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] - required :type, enum: -> { Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type } + # @return [Symbol, :thumbnail] + required :type, const: :thumbnail # @!attribute value # Optional transformation string. @@ -589,42 +544,28 @@ class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :value, String - # @!method initialize(type:, value: nil) + # @!method initialize(value: nil, type: :thumbnail) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail} - # for more details. - # - # @param type [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type] Generates a thumbnail image. + # {Imagekit::Models::FileUploadParams::Transformation::Post::Thumbnail} for more + # details. # # @param value [String] Optional transformation string. - - # Generates a thumbnail image. # - # @see Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail#type - module Type - extend Imagekit::Internal::Type::Enum - - THUMBNAIL = :thumbnail - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :thumbnail] Generates a thumbnail image. end - class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + class Abs < Imagekit::Internal::Type::BaseModel # @!attribute protocol # Streaming protocol to use (`hls` or `dash`). # - # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] - required :protocol, - enum: -> { Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol } + # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::Abs::Protocol] + required :protocol, enum: -> { Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol } # @!attribute type # Adaptive Bitrate Streaming (ABS) setup. # - # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] - required :type, - enum: -> { Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type } + # @return [Symbol, :abs] + required :type, const: :abs # @!attribute value # List of different representations you want to create separated by an underscore. @@ -632,20 +573,20 @@ class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel # @return [String] required :value, String - # @!method initialize(protocol:, type:, value:) + # @!method initialize(protocol:, value:, type: :abs) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming} - # for more details. + # {Imagekit::Models::FileUploadParams::Transformation::Post::Abs} for more + # details. # - # @param protocol [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol] Streaming protocol to use (`hls` or `dash`). - # - # @param type [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type] Adaptive Bitrate Streaming (ABS) setup. + # @param protocol [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::Abs::Protocol] Streaming protocol to use (`hls` or `dash`). # # @param value [String] List of different representations you want to create separated by an underscore. + # + # @param type [Symbol, :abs] Adaptive Bitrate Streaming (ABS) setup. # Streaming protocol to use (`hls` or `dash`). # - # @see Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming#protocol + # @see Imagekit::Models::FileUploadParams::Transformation::Post::Abs#protocol module Protocol extend Imagekit::Internal::Type::Enum @@ -655,22 +596,10 @@ module Protocol # @!method self.values # @return [Array] end - - # Adaptive Bitrate Streaming (ABS) setup. - # - # @see Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming#type - module Type - extend Imagekit::Internal::Type::Enum - - ABS = :abs - - # @!method self.values - # @return [Array] - end end # @!method self.variants - # @return [Array(Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation, Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo, Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail, Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming)] + # @return [Array(Imagekit::Models::FileUploadParams::Transformation::Post::Transformation, Imagekit::Models::FileUploadParams::Transformation::Post::GifToVideo, Imagekit::Models::FileUploadParams::Transformation::Post::Thumbnail, Imagekit::Models::FileUploadParams::Transformation::Post::Abs)] end end end diff --git a/lib/imagekit/resources/accounts/url_endpoints.rb b/lib/imagekit/resources/accounts/url_endpoints.rb index a65ea4e7..ff599297 100644 --- a/lib/imagekit/resources/accounts/url_endpoints.rb +++ b/lib/imagekit/resources/accounts/url_endpoints.rb @@ -18,7 +18,7 @@ class URLEndpoints # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Akamai] Configuration for third-party URL rewriting. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -52,7 +52,7 @@ def create(params) # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai] Configuration for third-party URL rewriting. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekit/resources/beta/v2/files.rb index 03370c95..c50545df 100644 --- a/lib/imagekit/resources/beta/v2/files.rb +++ b/lib/imagekit/resources/beta/v2/files.rb @@ -52,7 +52,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index f2035a13..fbbf9a49 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -251,7 +251,7 @@ def rename(params) # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi index 3cc8ddff..d3d5e5b4 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi @@ -41,9 +41,9 @@ module Imagekit returns( T.nilable( T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai ) ) ) @@ -54,9 +54,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai::OrHash ) ).void end @@ -69,9 +69,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) @@ -100,9 +100,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai ), request_options: Imagekit::RequestOptions } @@ -118,26 +118,22 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai ) end - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Internal::AnyHash ) end - sig do - returns( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # Whether to preserve `/` in the rewritten URL. @@ -149,190 +145,66 @@ module Imagekit sig do params( - type: - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol, - preserve_asset_delivery_types: T::Boolean + preserve_asset_delivery_types: T::Boolean, + type: Symbol ).returns(T.attached_class) end def self.new( - type:, # Whether to preserve `/` in the rewritten URL. - preserve_asset_delivery_types: nil + preserve_asset_delivery_types: nil, + type: :CLOUDINARY ) end sig do override.returns( - { - type: - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol, - preserve_asset_delivery_types: T::Boolean - } + { type: Symbol, preserve_asset_delivery_types: T::Boolean } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY = - T.let( - :CLOUDINARY, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Internal::AnyHash ) end - sig do - returns( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :IMGIX) end - sig do - override.returns( - { - type: - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IMGIX = - T.let( - :IMGIX, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai, Imagekit::Internal::AnyHash ) end - sig do - returns( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :AKAMAI) end - sig do - override.returns( - { - type: - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKAMAI = - T.let( - :AKAMAI, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi index f5e6d031..fb549c5f 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi @@ -41,9 +41,9 @@ module Imagekit returns( T.nilable( T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai ) ) ) @@ -54,9 +54,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai::OrHash ) ).void end @@ -69,9 +69,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) @@ -100,9 +100,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai ), request_options: Imagekit::RequestOptions } @@ -118,26 +118,22 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai ) end - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Internal::AnyHash ) end - sig do - returns( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # Whether to preserve `/` in the rewritten URL. @@ -149,190 +145,66 @@ module Imagekit sig do params( - type: - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol, - preserve_asset_delivery_types: T::Boolean + preserve_asset_delivery_types: T::Boolean, + type: Symbol ).returns(T.attached_class) end def self.new( - type:, # Whether to preserve `/` in the rewritten URL. - preserve_asset_delivery_types: nil + preserve_asset_delivery_types: nil, + type: :CLOUDINARY ) end sig do override.returns( - { - type: - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol, - preserve_asset_delivery_types: T::Boolean - } + { type: Symbol, preserve_asset_delivery_types: T::Boolean } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY = - T.let( - :CLOUDINARY, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Internal::AnyHash ) end - sig do - returns( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :IMGIX) end - sig do - override.returns( - { - type: - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::OrSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IMGIX = - T.let( - :IMGIX, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai, Imagekit::Internal::AnyHash ) end - sig do - returns( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :AKAMAI) end - sig do - override.returns( - { - type: - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKAMAI = - T.let( - :AKAMAI, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi index 1ae93408..d33124a6 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -96,9 +96,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg, + Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension ) ] ) @@ -111,9 +111,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash ) ] ).void @@ -278,9 +278,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash ) ], folder: String, @@ -429,9 +429,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg, + Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension ) ], folder: String, @@ -463,33 +463,29 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg, + Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension ) end - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg, Imagekit::Internal::AnyHash ) end # Specifies the background removal extension. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :name sig do returns( T.nilable( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options ) ) end @@ -498,74 +494,42 @@ module Imagekit sig do params( options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options::OrHash ).void end attr_writer :options sig do params( - name: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options::OrHash, + name: Symbol ).returns(T.attached_class) end def self.new( + options: nil, # Specifies the background removal extension. - name:, - options: nil + name: :"remove-bg" ) end sig do override.returns( { - name: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + name: Symbol, options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options } ) end def to_hash end - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - class Options < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options, + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options, Imagekit::Internal::AnyHash ) end @@ -735,75 +699,29 @@ module Imagekit end end - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension, + Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription, Imagekit::Internal::AnyHash ) end # Specifies the auto description extension. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :name - sig do - params( - name: - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ).returns(T.attached_class) - end + sig { params(name: Symbol).returns(T.attached_class) } def self.new( # Specifies the auto description extension. - name: + name: :"ai-auto-description" ) end - sig do - override.returns( - { - name: - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - } - ) - end + sig { override.returns({ name: Symbol }) } def to_hash end - - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do @@ -893,10 +811,10 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs ) ] ) @@ -909,10 +827,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::OrHash + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::OrHash ) ] ).void @@ -943,10 +861,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::OrHash + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail::OrHash, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::OrHash ) ], pre: String @@ -969,10 +887,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs ) ], pre: String @@ -988,28 +906,24 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs ) end - class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation, Imagekit::Internal::AnyHash ) end # Transformation type. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # Transformation string (e.g. `w-200,h-200`). @@ -1018,79 +932,33 @@ module Imagekit attr_accessor :value sig do - params( - type: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol, - value: String - ).returns(T.attached_class) + params(value: String, type: Symbol).returns(T.attached_class) end def self.new( - # Transformation type. - type:, # Transformation string (e.g. `w-200,h-200`). # Same syntax as ImageKit URL-based transformations. - value: + value:, + # Transformation type. + type: :transformation ) end - sig do - override.returns( - { - type: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol, - value: String - } - ) - end + sig { override.returns({ type: Symbol, value: String }) } def to_hash end - - # Transformation type. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRANSFORMATION = - T.let( - :transformation, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, Imagekit::Internal::AnyHash ) end # Converts an animated GIF into an MP4. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # Optional transformation string to apply to the output video. @@ -1102,79 +970,33 @@ module Imagekit attr_writer :value sig do - params( - type: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol, - value: String - ).returns(T.attached_class) + params(value: String, type: Symbol).returns(T.attached_class) end def self.new( - # Converts an animated GIF into an MP4. - type:, # Optional transformation string to apply to the output video. # **Example**: `q-80` - value: nil + value: nil, + # Converts an animated GIF into an MP4. + type: :"gif-to-video" ) end - sig do - override.returns( - { - type: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol, - value: String - } - ) - end + sig { override.returns({ type: Symbol, value: String }) } def to_hash end - - # Converts an animated GIF into an MP4. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GIF_TO_VIDEO = - T.let( - :"gif-to-video", - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, Imagekit::Internal::AnyHash ) end # Generates a thumbnail image. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # Optional transformation string. @@ -1186,69 +1008,27 @@ module Imagekit attr_writer :value sig do - params( - type: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol, - value: String - ).returns(T.attached_class) + params(value: String, type: Symbol).returns(T.attached_class) end def self.new( - # Generates a thumbnail image. - type:, # Optional transformation string. # **Example**: `w-150,h-150` - value: nil + value: nil, + # Generates a thumbnail image. + type: :thumbnail ) end - sig do - override.returns( - { - type: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol, - value: String - } - ) - end + sig { override.returns({ type: Symbol, value: String }) } def to_hash end - - # Generates a thumbnail image. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - THUMBNAIL = - T.let( - :thumbnail, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + class Abs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs, Imagekit::Internal::AnyHash ) end @@ -1256,17 +1036,13 @@ module Imagekit # Streaming protocol to use (`hls` or `dash`). sig do returns( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol ) end attr_accessor :protocol # Adaptive Bitrate Streaming (ABS) setup. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # List of different representations you want to create separated by an underscore. @@ -1276,19 +1052,18 @@ module Imagekit sig do params( protocol: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol, - type: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol, - value: String + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, + value: String, + type: Symbol ).returns(T.attached_class) end def self.new( # Streaming protocol to use (`hls` or `dash`). protocol:, - # Adaptive Bitrate Streaming (ABS) setup. - type:, # List of different representations you want to create separated by an underscore. - value: + value:, + # Adaptive Bitrate Streaming (ABS) setup. + type: :abs ) end @@ -1296,9 +1071,8 @@ module Imagekit override.returns( { protocol: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol, - type: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol, + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, + type: Symbol, value: String } ) @@ -1314,7 +1088,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1322,48 +1096,18 @@ module Imagekit HLS = T.let( :hls, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ) DASH = T.let( :dash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Adaptive Bitrate Streaming (ABS) setup. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ABS = - T.let( - :abs, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::TaggedSymbol + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::TaggedSymbol + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 00f5b321..4d836828 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -101,9 +101,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::FileUploadParams::Extension::RemoveBg, + Imagekit::FileUploadParams::Extension::AIAutoDescription, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension ) ] ) @@ -116,9 +116,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::FileUploadParams::Extension::RemoveBg::OrHash, + Imagekit::FileUploadParams::Extension::AIAutoDescription::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash ) ] ).void @@ -301,9 +301,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::FileUploadParams::Extension::RemoveBg::OrHash, + Imagekit::FileUploadParams::Extension::AIAutoDescription::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash ) ], folder: String, @@ -473,9 +473,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::FileUploadParams::Extension::RemoveBg, + Imagekit::FileUploadParams::Extension::AIAutoDescription, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension ) ], folder: String, @@ -506,33 +506,29 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension + Imagekit::FileUploadParams::Extension::RemoveBg, + Imagekit::FileUploadParams::Extension::AIAutoDescription, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension ) end - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension, + Imagekit::FileUploadParams::Extension::RemoveBg, Imagekit::Internal::AnyHash ) end # Specifies the background removal extension. - sig do - returns( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :name sig do returns( T.nilable( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + Imagekit::FileUploadParams::Extension::RemoveBg::Options ) ) end @@ -541,74 +537,42 @@ module Imagekit sig do params( options: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + Imagekit::FileUploadParams::Extension::RemoveBg::Options::OrHash ).void end attr_writer :options sig do params( - name: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, options: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options::OrHash + Imagekit::FileUploadParams::Extension::RemoveBg::Options::OrHash, + name: Symbol ).returns(T.attached_class) end def self.new( + options: nil, # Specifies the background removal extension. - name:, - options: nil + name: :"remove-bg" ) end sig do override.returns( { - name: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::OrSymbol, + name: Symbol, options: - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + Imagekit::FileUploadParams::Extension::RemoveBg::Options } ) end def to_hash end - # Specifies the background removal extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - REMOVE_BG = - T.let( - :"remove-bg", - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - class Options < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options, + Imagekit::FileUploadParams::Extension::RemoveBg::Options, Imagekit::Internal::AnyHash ) end @@ -778,75 +742,29 @@ module Imagekit end end - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension, + Imagekit::FileUploadParams::Extension::AIAutoDescription, Imagekit::Internal::AnyHash ) end # Specifies the auto description extension. - sig do - returns( - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :name - sig do - params( - name: - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - ).returns(T.attached_class) - end + sig { params(name: Symbol).returns(T.attached_class) } def self.new( # Specifies the auto description extension. - name: + name: :"ai-auto-description" ) end - sig do - override.returns( - { - name: - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::OrSymbol - } - ) - end + sig { override.returns({ name: Symbol }) } def to_hash end - - # Specifies the auto description extension. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AI_AUTO_DESCRIPTION = - T.let( - :"ai-auto-description", - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do @@ -926,10 +844,10 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation, - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo, - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + Imagekit::FileUploadParams::Transformation::Post::Transformation, + Imagekit::FileUploadParams::Transformation::Post::GifToVideo, + Imagekit::FileUploadParams::Transformation::Post::Thumbnail, + Imagekit::FileUploadParams::Transformation::Post::Abs ) ] ) @@ -942,10 +860,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::OrHash, - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::OrHash, - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::OrHash, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::OrHash + Imagekit::FileUploadParams::Transformation::Post::Transformation::OrHash, + Imagekit::FileUploadParams::Transformation::Post::GifToVideo::OrHash, + Imagekit::FileUploadParams::Transformation::Post::Thumbnail::OrHash, + Imagekit::FileUploadParams::Transformation::Post::Abs::OrHash ) ] ).void @@ -976,10 +894,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::OrHash, - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::OrHash, - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::OrHash, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::OrHash + Imagekit::FileUploadParams::Transformation::Post::Transformation::OrHash, + Imagekit::FileUploadParams::Transformation::Post::GifToVideo::OrHash, + Imagekit::FileUploadParams::Transformation::Post::Thumbnail::OrHash, + Imagekit::FileUploadParams::Transformation::Post::Abs::OrHash ) ], pre: String @@ -1002,10 +920,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation, - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo, - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + Imagekit::FileUploadParams::Transformation::Post::Transformation, + Imagekit::FileUploadParams::Transformation::Post::GifToVideo, + Imagekit::FileUploadParams::Transformation::Post::Thumbnail, + Imagekit::FileUploadParams::Transformation::Post::Abs ) ], pre: String @@ -1021,28 +939,24 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation, - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo, - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + Imagekit::FileUploadParams::Transformation::Post::Transformation, + Imagekit::FileUploadParams::Transformation::Post::GifToVideo, + Imagekit::FileUploadParams::Transformation::Post::Thumbnail, + Imagekit::FileUploadParams::Transformation::Post::Abs ) end - class SimplePostTransformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation, + Imagekit::FileUploadParams::Transformation::Post::Transformation, Imagekit::Internal::AnyHash ) end # Transformation type. - sig do - returns( - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # Transformation string (e.g. `w-200,h-200`). @@ -1051,79 +965,33 @@ module Imagekit attr_accessor :value sig do - params( - type: - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol, - value: String - ).returns(T.attached_class) + params(value: String, type: Symbol).returns(T.attached_class) end def self.new( - # Transformation type. - type:, # Transformation string (e.g. `w-200,h-200`). # Same syntax as ImageKit URL-based transformations. - value: + value:, + # Transformation type. + type: :transformation ) end - sig do - override.returns( - { - type: - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::OrSymbol, - value: String - } - ) - end + sig { override.returns({ type: Symbol, value: String }) } def to_hash end - - # Transformation type. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRANSFORMATION = - T.let( - :transformation, - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo, + Imagekit::FileUploadParams::Transformation::Post::GifToVideo, Imagekit::Internal::AnyHash ) end # Converts an animated GIF into an MP4. - sig do - returns( - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # Optional transformation string to apply to the output video. @@ -1135,79 +1003,33 @@ module Imagekit attr_writer :value sig do - params( - type: - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol, - value: String - ).returns(T.attached_class) + params(value: String, type: Symbol).returns(T.attached_class) end def self.new( - # Converts an animated GIF into an MP4. - type:, # Optional transformation string to apply to the output video. # **Example**: `q-80` - value: nil + value: nil, + # Converts an animated GIF into an MP4. + type: :"gif-to-video" ) end - sig do - override.returns( - { - type: - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::OrSymbol, - value: String - } - ) - end + sig { override.returns({ type: Symbol, value: String }) } def to_hash end - - # Converts an animated GIF into an MP4. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GIF_TO_VIDEO = - T.let( - :"gif-to-video", - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail, + Imagekit::FileUploadParams::Transformation::Post::Thumbnail, Imagekit::Internal::AnyHash ) end # Generates a thumbnail image. - sig do - returns( - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # Optional transformation string. @@ -1219,69 +1041,27 @@ module Imagekit attr_writer :value sig do - params( - type: - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol, - value: String - ).returns(T.attached_class) + params(value: String, type: Symbol).returns(T.attached_class) end def self.new( - # Generates a thumbnail image. - type:, # Optional transformation string. # **Example**: `w-150,h-150` - value: nil + value: nil, + # Generates a thumbnail image. + type: :thumbnail ) end - sig do - override.returns( - { - type: - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::OrSymbol, - value: String - } - ) - end + sig { override.returns({ type: Symbol, value: String }) } def to_hash end - - # Generates a thumbnail image. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - THUMBNAIL = - T.let( - :thumbnail, - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end - class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel + class Abs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming, + Imagekit::FileUploadParams::Transformation::Post::Abs, Imagekit::Internal::AnyHash ) end @@ -1289,17 +1069,13 @@ module Imagekit # Streaming protocol to use (`hls` or `dash`). sig do returns( - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol + Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol ) end attr_accessor :protocol # Adaptive Bitrate Streaming (ABS) setup. - sig do - returns( - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # List of different representations you want to create separated by an underscore. @@ -1309,19 +1085,18 @@ module Imagekit sig do params( protocol: - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol, - type: - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol, - value: String + Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, + value: String, + type: Symbol ).returns(T.attached_class) end def self.new( # Streaming protocol to use (`hls` or `dash`). protocol:, - # Adaptive Bitrate Streaming (ABS) setup. - type:, # List of different representations you want to create separated by an underscore. - value: + value:, + # Adaptive Bitrate Streaming (ABS) setup. + type: :abs ) end @@ -1329,9 +1104,8 @@ module Imagekit override.returns( { protocol: - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::OrSymbol, - type: - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::OrSymbol, + Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, + type: Symbol, value: String } ) @@ -1347,7 +1121,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol + Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1355,48 +1129,18 @@ module Imagekit HLS = T.let( :hls, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol + Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ) DASH = T.let( :dash, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Protocol::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Adaptive Bitrate Streaming (ABS) setup. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ABS = - T.let( - :abs, - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::TaggedSymbol + Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::Type::TaggedSymbol + Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ] ) end diff --git a/rbi/imagekit/resources/accounts/url_endpoints.rbi b/rbi/imagekit/resources/accounts/url_endpoints.rbi index 2a0a81f1..684d4632 100644 --- a/rbi/imagekit/resources/accounts/url_endpoints.rbi +++ b/rbi/imagekit/resources/accounts/url_endpoints.rbi @@ -13,9 +13,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::URLEndpointCreateResponse) @@ -46,9 +46,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::URLEndpointUpdateResponse) diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekit/resources/beta/v2/files.rbi index cf3cca05..9c757f11 100644 --- a/rbi/imagekit/resources/beta/v2/files.rbi +++ b/rbi/imagekit/resources/beta/v2/files.rbi @@ -44,9 +44,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription::OrHash, + Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash ) ], folder: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 5d2929cb..29175193 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -244,9 +244,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash, - Imagekit::FileUploadParams::Extension::AutoDescriptionExtension::OrHash + Imagekit::FileUploadParams::Extension::RemoveBg::OrHash, + Imagekit::FileUploadParams::Extension::AIAutoDescription::OrHash, + Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash ) ], folder: String, diff --git a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs index 5490dc25..a321175f 100644 --- a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs @@ -47,99 +47,52 @@ module Imagekit } type url_rewriter = - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter - | Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter - | Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter + Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary + | Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix + | Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai module URLRewriter extend Imagekit::Internal::Type::Union - type cloudinary_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_, - preserve_asset_delivery_types: bool - } + type cloudinary = + { type: :CLOUDINARY, preserve_asset_delivery_types: bool } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_ + class Cloudinary < Imagekit::Internal::Type::BaseModel + attr_accessor type: :CLOUDINARY attr_reader preserve_asset_delivery_types: bool? def preserve_asset_delivery_types=: (bool) -> bool def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_, - ?preserve_asset_delivery_types: bool + ?preserve_asset_delivery_types: bool, + ?type: :CLOUDINARY ) -> void def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_, + type: :CLOUDINARY, preserve_asset_delivery_types: bool } - - type type_ = :CLOUDINARY - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY: :CLOUDINARY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::CloudinaryURLRewriter::type_] - end end - type imgix_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_ - } - - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_ - } - - type type_ = :IMGIX + type imgix = { type: :IMGIX } - module Type - extend Imagekit::Internal::Type::Enum + class Imgix < Imagekit::Internal::Type::BaseModel + attr_accessor type: :IMGIX - IMGIX: :IMGIX + def initialize: (?type: :IMGIX) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::ImgixURLRewriter::type_] - end + def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_ - } - - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_ - } - - type type_ = :AKAMAI + type akamai = { type: :AKAMAI } - module Type - extend Imagekit::Internal::Type::Enum + class Akamai < Imagekit::Internal::Type::BaseModel + attr_accessor type: :AKAMAI - AKAMAI: :AKAMAI + def initialize: (?type: :AKAMAI) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::AkamaiURLRewriter::type_] - end + def to_hash: -> { type: :AKAMAI } end def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter] diff --git a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs index fd065303..b027b9b5 100644 --- a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs @@ -47,99 +47,52 @@ module Imagekit } type url_rewriter = - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter - | Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter - | Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter + Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary + | Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix + | Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai module URLRewriter extend Imagekit::Internal::Type::Union - type cloudinary_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_, - preserve_asset_delivery_types: bool - } + type cloudinary = + { type: :CLOUDINARY, preserve_asset_delivery_types: bool } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_ + class Cloudinary < Imagekit::Internal::Type::BaseModel + attr_accessor type: :CLOUDINARY attr_reader preserve_asset_delivery_types: bool? def preserve_asset_delivery_types=: (bool) -> bool def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_, - ?preserve_asset_delivery_types: bool + ?preserve_asset_delivery_types: bool, + ?type: :CLOUDINARY ) -> void def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_, + type: :CLOUDINARY, preserve_asset_delivery_types: bool } - - type type_ = :CLOUDINARY - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY: :CLOUDINARY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::CloudinaryURLRewriter::type_] - end end - type imgix_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_ - } - - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_ - } - - type type_ = :IMGIX + type imgix = { type: :IMGIX } - module Type - extend Imagekit::Internal::Type::Enum + class Imgix < Imagekit::Internal::Type::BaseModel + attr_accessor type: :IMGIX - IMGIX: :IMGIX + def initialize: (?type: :IMGIX) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::ImgixURLRewriter::type_] - end + def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_ - } - - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_ - } - - type type_ = :AKAMAI + type akamai = { type: :AKAMAI } - module Type - extend Imagekit::Internal::Type::Enum + class Akamai < Imagekit::Internal::Type::BaseModel + attr_accessor type: :AKAMAI - AKAMAI: :AKAMAI + def initialize: (?type: :AKAMAI) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::AkamaiURLRewriter::type_] - end + def to_hash: -> { type: :AKAMAI } end def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter] diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekit/models/beta/v2/file_upload_params.rbs index 8c630015..0546ac88 100644 --- a/sig/imagekit/models/beta/v2/file_upload_params.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_params.rbs @@ -162,48 +162,38 @@ module Imagekit } type extension = - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg + | Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription | Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension - | Imagekit::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union - type removedot_bg_extension = + type remove_bg = { - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + name: :"remove-bg", + options: Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options } - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_ + class RemoveBg < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"remove-bg" - attr_reader options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options? + attr_reader options: Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options? def options=: ( - Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options - ) -> Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options + ) -> Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options def initialize: ( - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + ?options: Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options, + ?name: :"remove-bg" ) -> void def to_hash: -> { - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::Options + name: :"remove-bg", + options: Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options } - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemovedotBgExtension::name_] - end - type options = { add_shadow: bool, @@ -283,31 +273,14 @@ module Imagekit end end - type auto_description_extension = - { - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ - } - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ + type ai_auto_description = { name: :"ai-auto-description" } - def initialize: ( - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ - ) -> void + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"ai-auto-description" - def to_hash: -> { - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_ - } - - type name_ = :"ai-auto-description" - - module Name - extend Imagekit::Internal::Type::Enum + def initialize: (?name: :"ai-auto-description") -> void - AI_AUTO_DESCRIPTION: :"ai-auto-description" - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoDescriptionExtension::name_] - end + def to_hash: -> { name: :"ai-auto-description" } end def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] @@ -364,137 +337,77 @@ module Imagekit } type post = - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation - | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo - | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail - | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation + | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo + | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail + | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs module Post extend Imagekit::Internal::Type::Union - type simple_post_transformation = - { - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, - value: String - } + type transformation = { type: :transformation, value: String } - class SimplePostTransformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_ + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: :transformation attr_accessor value: String - def initialize: ( - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, - value: String - ) -> void + def initialize: (value: String, ?type: :transformation) -> void - def to_hash: -> { - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, - value: String - } - - type type_ = :transformation - - module Type - extend Imagekit::Internal::Type::Enum - - TRANSFORMATION: :transformation - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::SimplePostTransformation::type_] - end + def to_hash: -> { type: :transformation, value: String } end - type convert_gif_to_video = - { - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, - value: String - } + type gif_to_video = { type: :"gif-to-video", value: String } - class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_ + class GifToVideo < Imagekit::Internal::Type::BaseModel + attr_accessor type: :"gif-to-video" attr_reader value: String? def value=: (String) -> String - def initialize: ( - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, - ?value: String - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, - value: String - } - - type type_ = :"gif-to-video" - - module Type - extend Imagekit::Internal::Type::Enum + def initialize: (?value: String, ?type: :"gif-to-video") -> void - GIF_TO_VIDEO: :"gif-to-video" - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_] - end + def to_hash: -> { type: :"gif-to-video", value: String } end - type generate_a_thumbnail = - { - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, - value: String - } + type thumbnail = { type: :thumbnail, value: String } - class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_ + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_accessor type: :thumbnail attr_reader value: String? def value=: (String) -> String - def initialize: ( - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, - ?value: String - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, - value: String - } - - type type_ = :thumbnail - - module Type - extend Imagekit::Internal::Type::Enum - - THUMBNAIL: :thumbnail + def initialize: (?value: String, ?type: :thumbnail) -> void - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_] - end + def to_hash: -> { type: :thumbnail, value: String } end - type adaptive_bitrate_streaming = + type abs = { - protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, + type: :abs, value: String } - class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel - attr_accessor protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol + class Abs < Imagekit::Internal::Type::BaseModel + attr_accessor protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol - attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_ + attr_accessor type: :abs attr_accessor value: String def initialize: ( - protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, - value: String + protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, + value: String, + ?type: :abs ) -> void def to_hash: -> { - protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, - type: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, + type: :abs, value: String } @@ -506,17 +419,7 @@ module Imagekit HLS: :hls DASH: :dash - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol] - end - - type type_ = :abs - - module Type - extend Imagekit::Internal::Type::Enum - - ABS: :abs - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_] + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol] end end diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index b9b40672..4a2ea622 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -181,48 +181,38 @@ module Imagekit } type extension = - Imagekit::FileUploadParams::Extension::RemovedotBgExtension + Imagekit::FileUploadParams::Extension::RemoveBg + | Imagekit::FileUploadParams::Extension::AIAutoDescription | Imagekit::FileUploadParams::Extension::AutoTaggingExtension - | Imagekit::FileUploadParams::Extension::AutoDescriptionExtension module Extension extend Imagekit::Internal::Type::Union - type removedot_bg_extension = + type remove_bg = { - name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + name: :"remove-bg", + options: Imagekit::FileUploadParams::Extension::RemoveBg::Options } - class RemovedotBgExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_ + class RemoveBg < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"remove-bg" - attr_reader options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options? + attr_reader options: Imagekit::FileUploadParams::Extension::RemoveBg::Options? def options=: ( - Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options - ) -> Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + Imagekit::FileUploadParams::Extension::RemoveBg::Options + ) -> Imagekit::FileUploadParams::Extension::RemoveBg::Options def initialize: ( - name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, - ?options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + ?options: Imagekit::FileUploadParams::Extension::RemoveBg::Options, + ?name: :"remove-bg" ) -> void def to_hash: -> { - name: Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_, - options: Imagekit::FileUploadParams::Extension::RemovedotBgExtension::Options + name: :"remove-bg", + options: Imagekit::FileUploadParams::Extension::RemoveBg::Options } - type name_ = :"remove-bg" - - module Name - extend Imagekit::Internal::Type::Enum - - REMOVE_BG: :"remove-bg" - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::RemovedotBgExtension::name_] - end - type options = { add_shadow: bool, @@ -302,31 +292,14 @@ module Imagekit end end - type auto_description_extension = - { - name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ - } - - class AutoDescriptionExtension < Imagekit::Internal::Type::BaseModel - attr_accessor name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ + type ai_auto_description = { name: :"ai-auto-description" } - def initialize: ( - name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ - ) -> void + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"ai-auto-description" - def to_hash: -> { - name: Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_ - } - - type name_ = :"ai-auto-description" - - module Name - extend Imagekit::Internal::Type::Enum + def initialize: (?name: :"ai-auto-description") -> void - AI_AUTO_DESCRIPTION: :"ai-auto-description" - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::AutoDescriptionExtension::name_] - end + def to_hash: -> { name: :"ai-auto-description" } end def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::extension] @@ -383,137 +356,77 @@ module Imagekit } type post = - Imagekit::FileUploadParams::Transformation::Post::SimplePostTransformation - | Imagekit::FileUploadParams::Transformation::Post::ConvertGifToVideo - | Imagekit::FileUploadParams::Transformation::Post::GenerateAThumbnail - | Imagekit::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming + Imagekit::FileUploadParams::Transformation::Post::Transformation + | Imagekit::FileUploadParams::Transformation::Post::GifToVideo + | Imagekit::FileUploadParams::Transformation::Post::Thumbnail + | Imagekit::FileUploadParams::Transformation::Post::Abs module Post extend Imagekit::Internal::Type::Union - type simple_post_transformation = - { - type: Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, - value: String - } + type transformation = { type: :transformation, value: String } - class SimplePostTransformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_ + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: :transformation attr_accessor value: String - def initialize: ( - type: Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, - value: String - ) -> void + def initialize: (value: String, ?type: :transformation) -> void - def to_hash: -> { - type: Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_, - value: String - } - - type type_ = :transformation - - module Type - extend Imagekit::Internal::Type::Enum - - TRANSFORMATION: :transformation - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::SimplePostTransformation::type_] - end + def to_hash: -> { type: :transformation, value: String } end - type convert_gif_to_video = - { - type: Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, - value: String - } + type gif_to_video = { type: :"gif-to-video", value: String } - class ConvertGifToVideo < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_ + class GifToVideo < Imagekit::Internal::Type::BaseModel + attr_accessor type: :"gif-to-video" attr_reader value: String? def value=: (String) -> String - def initialize: ( - type: Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, - ?value: String - ) -> void - - def to_hash: -> { - type: Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_, - value: String - } - - type type_ = :"gif-to-video" - - module Type - extend Imagekit::Internal::Type::Enum + def initialize: (?value: String, ?type: :"gif-to-video") -> void - GIF_TO_VIDEO: :"gif-to-video" - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::ConvertGifToVideo::type_] - end + def to_hash: -> { type: :"gif-to-video", value: String } end - type generate_a_thumbnail = - { - type: Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, - value: String - } + type thumbnail = { type: :thumbnail, value: String } - class GenerateAThumbnail < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_ + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_accessor type: :thumbnail attr_reader value: String? def value=: (String) -> String - def initialize: ( - type: Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, - ?value: String - ) -> void - - def to_hash: -> { - type: Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_, - value: String - } - - type type_ = :thumbnail - - module Type - extend Imagekit::Internal::Type::Enum - - THUMBNAIL: :thumbnail + def initialize: (?value: String, ?type: :thumbnail) -> void - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::GenerateAThumbnail::type_] - end + def to_hash: -> { type: :thumbnail, value: String } end - type adaptive_bitrate_streaming = + type abs = { - protocol: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, - type: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + protocol: Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol, + type: :abs, value: String } - class AdaptiveBitrateStreaming < Imagekit::Internal::Type::BaseModel - attr_accessor protocol: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol + class Abs < Imagekit::Internal::Type::BaseModel + attr_accessor protocol: Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol - attr_accessor type: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_ + attr_accessor type: :abs attr_accessor value: String def initialize: ( - protocol: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, - type: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, - value: String + protocol: Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol, + value: String, + ?type: :abs ) -> void def to_hash: -> { - protocol: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol, - type: Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_, + protocol: Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol, + type: :abs, value: String } @@ -525,17 +438,7 @@ module Imagekit HLS: :hls DASH: :dash - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::protocol] - end - - type type_ = :abs - - module Type - extend Imagekit::Internal::Type::Enum - - ABS: :abs - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::AdaptiveBitrateStreaming::type_] + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol] end end From 5a8dca418bf75c204a4e797ee2e2c634800f56e4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 10:15:12 +0000 Subject: [PATCH 018/178] feat(api): manual updates --- .stats.yml | 4 +- .../models/accounts/origin_create_params.rb | 19 +- .../models/accounts/origin_create_response.rb | 120 ++------ .../models/accounts/origin_get_response.rb | 120 ++------ .../models/accounts/origin_list_response.rb | 121 ++------ .../models/accounts/origin_update_params.rb | 19 +- .../models/accounts/origin_update_response.rb | 120 ++------ .../accounts/url_endpoint_create_response.rb | 57 +--- .../accounts/url_endpoint_get_response.rb | 57 +--- .../accounts/url_endpoint_list_response.rb | 57 +--- .../accounts/url_endpoint_update_response.rb | 57 +--- lib/imagekit/models/file_update_params.rb | 18 +- lib/imagekit/resources/accounts/origins.rb | 12 +- lib/imagekit/resources/files.rb | 2 +- .../models/accounts/origin_create_params.rbi | 34 +-- .../accounts/origin_create_response.rbi | 282 +++--------------- .../models/accounts/origin_get_response.rbi | 282 +++--------------- .../models/accounts/origin_list_response.rbi | 282 +++--------------- .../models/accounts/origin_update_params.rbi | 34 +-- .../accounts/origin_update_response.rbi | 282 +++--------------- .../accounts/url_endpoint_create_response.rbi | 152 +--------- .../accounts/url_endpoint_get_response.rbi | 152 +--------- .../accounts/url_endpoint_list_response.rbi | 152 +--------- .../accounts/url_endpoint_update_response.rbi | 152 +--------- rbi/imagekit/models/file_update_params.rbi | 50 +--- rbi/imagekit/resources/accounts/origins.rbi | 8 +- rbi/imagekit/resources/files.rbi | 6 +- .../models/accounts/origin_create_params.rbs | 18 +- .../accounts/origin_create_response.rbs | 120 ++------ .../models/accounts/origin_get_response.rbs | 120 ++------ .../models/accounts/origin_list_response.rbs | 120 ++------ .../models/accounts/origin_update_params.rbs | 18 +- .../accounts/origin_update_response.rbs | 120 ++------ .../accounts/url_endpoint_create_response.rbs | 71 +---- .../accounts/url_endpoint_get_response.rbs | 71 +---- .../accounts/url_endpoint_list_response.rbs | 71 +---- .../accounts/url_endpoint_update_response.rbs | 71 +---- sig/imagekit/models/file_update_params.rbs | 2 - sig/imagekit/resources/accounts/origins.rbs | 4 +- 39 files changed, 579 insertions(+), 2878 deletions(-) diff --git a/.stats.yml b/.stats.yml index 9d8aa405..9c64de6b 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-6c237ebd6f81741286e7cfbaeac1356da3e18c7fe43b74d6c358d62bfb40dbb9.yml -openapi_spec_hash: ad6a65d74e3eb865a5d2915177f92ea7 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-5ed7a3dbaf059adbd91e86cd61520f59c5fdcc8df3f561df9ab07d7afb722f18.yml +openapi_spec_hash: 51d4d2be59d5d3f81a695a9b8786c77e config_hash: b75c4e4432c2d0650589863f8336849b diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index 493d614a..6cbcb1eb 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -33,8 +33,8 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] - required :type, enum: -> { Imagekit::Accounts::OriginCreateParams::Type } + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -130,7 +130,7 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # @return [String] required :username, String - # @!method initialize(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # @!method initialize(access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) # @param access_key [String] Access key for the bucket. # # @param bucket [String] @@ -139,8 +139,6 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # # @param secret_key [String] Secret key for the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] - # # @param endpoint [String] Custom S3-compatible endpoint. # # @param base_url [String] Akeneo instance base URL. @@ -173,16 +171,9 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # + # @param type [Symbol, :AKENEO_PIM] + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM = :AKENEO_PIM - - # @!method self.values - # @return [Array] - end end end end diff --git a/lib/imagekit/models/accounts/origin_create_response.rb b/lib/imagekit/models/accounts/origin_create_response.rb index 0fa2dc4c..6a3e8c83 100644 --- a/lib/imagekit/models/accounts/origin_create_response.rb +++ b/lib/imagekit/models/accounts/origin_create_response.rb @@ -223,8 +223,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type } + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -241,7 +241,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup} for more # details. @@ -256,19 +256,9 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param prefix [String] Path prefix inside the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :CLOUDINARY_BACKUP] end class WebFolder < Imagekit::Internal::Type::BaseModel @@ -302,8 +292,8 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type } + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -320,7 +310,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginCreateResponse::WebFolder} for more details. # @@ -334,19 +324,9 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginCreateResponse::WebFolder#type - module Type - extend Imagekit::Internal::Type::Enum - - WEB_FOLDER = :WEB_FOLDER - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel @@ -366,8 +346,8 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type } + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -384,7 +364,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginCreateResponse::WebProxy} for more details. # @@ -394,19 +374,9 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginCreateResponse::WebProxy#type - module Type - extend Imagekit::Internal::Type::Enum - - WEB_PROXY = :WEB_PROXY - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :WEB_PROXY] end class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel @@ -441,8 +411,8 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type } + # @return [Symbol, :GCS] + required :type, const: :GCS # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -459,7 +429,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs} for # more details. @@ -476,19 +446,9 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # # @param prefix [String] # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs#type - module Type - extend Imagekit::Internal::Type::Enum - - GCS = :GCS - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :GCS] end class AzureBlobStorage < Imagekit::Internal::Type::BaseModel @@ -523,8 +483,8 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type } + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -541,7 +501,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage} for more # details. @@ -558,19 +518,9 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # # @param prefix [String] # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage#type - module Type - extend Imagekit::Internal::Type::Enum - - AZURE_BLOB = :AZURE_BLOB - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :AZURE_BLOB] end class AkeneoPim < Imagekit::Internal::Type::BaseModel @@ -596,8 +546,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type } + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -614,7 +564,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, base_url:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim} for more details. # @@ -626,19 +576,9 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim#type - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM = :AKENEO_PIM - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants diff --git a/lib/imagekit/models/accounts/origin_get_response.rb b/lib/imagekit/models/accounts/origin_get_response.rb index b43cbb15..1d73dbc7 100644 --- a/lib/imagekit/models/accounts/origin_get_response.rb +++ b/lib/imagekit/models/accounts/origin_get_response.rb @@ -222,8 +222,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type } + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -240,7 +240,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup} for more # details. @@ -255,19 +255,9 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param prefix [String] Path prefix inside the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :CLOUDINARY_BACKUP] end class WebFolder < Imagekit::Internal::Type::BaseModel @@ -301,8 +291,8 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type } + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -319,7 +309,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginGetResponse::WebFolder} for more details. # @@ -333,19 +323,9 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginGetResponse::WebFolder#type - module Type - extend Imagekit::Internal::Type::Enum - - WEB_FOLDER = :WEB_FOLDER - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel @@ -365,8 +345,8 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type } + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -383,7 +363,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginGetResponse::WebProxy} for more details. # @@ -393,19 +373,9 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginGetResponse::WebProxy#type - module Type - extend Imagekit::Internal::Type::Enum - - WEB_PROXY = :WEB_PROXY - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :WEB_PROXY] end class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel @@ -440,8 +410,8 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type } + # @return [Symbol, :GCS] + required :type, const: :GCS # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -458,7 +428,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs} for more # details. @@ -475,19 +445,9 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # # @param prefix [String] # - # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs#type - module Type - extend Imagekit::Internal::Type::Enum - - GCS = :GCS - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :GCS] end class AzureBlobStorage < Imagekit::Internal::Type::BaseModel @@ -522,8 +482,8 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type } + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -540,7 +500,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage} for more # details. @@ -557,19 +517,9 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # # @param prefix [String] # - # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage#type - module Type - extend Imagekit::Internal::Type::Enum - - AZURE_BLOB = :AZURE_BLOB - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :AZURE_BLOB] end class AkeneoPim < Imagekit::Internal::Type::BaseModel @@ -595,8 +545,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type } + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -613,7 +563,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, base_url:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim} for more details. # @@ -625,19 +575,9 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim#type - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM = :AKENEO_PIM - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index b2675a4c..b977073a 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -221,8 +221,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type } + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -239,7 +239,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup} for more # details. @@ -254,19 +254,9 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param prefix [String] Path prefix inside the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :CLOUDINARY_BACKUP] end class WebFolder < Imagekit::Internal::Type::BaseModel @@ -300,8 +290,8 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type } + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -318,7 +308,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginListResponseItem::WebFolder} for more # details. @@ -333,19 +323,9 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginListResponseItem::WebFolder#type - module Type - extend Imagekit::Internal::Type::Enum - - WEB_FOLDER = :WEB_FOLDER - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel @@ -365,8 +345,8 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type } + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -383,7 +363,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginListResponseItem::WebProxy} for more details. # @@ -393,19 +373,9 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginListResponseItem::WebProxy#type - module Type - extend Imagekit::Internal::Type::Enum - - WEB_PROXY = :WEB_PROXY - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :WEB_PROXY] end class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel @@ -440,9 +410,8 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type } + # @return [Symbol, :GCS] + required :type, const: :GCS # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -459,7 +428,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs} for # more details. @@ -476,19 +445,9 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # # @param prefix [String] # - # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs#type - module Type - extend Imagekit::Internal::Type::Enum - - GCS = :GCS - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :GCS] end class AzureBlobStorage < Imagekit::Internal::Type::BaseModel @@ -523,8 +482,8 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type } + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -541,7 +500,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage} for more # details. @@ -558,19 +517,9 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # # @param prefix [String] # - # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage#type - module Type - extend Imagekit::Internal::Type::Enum - - AZURE_BLOB = :AZURE_BLOB - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :AZURE_BLOB] end class AkeneoPim < Imagekit::Internal::Type::BaseModel @@ -596,8 +545,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type } + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -614,7 +563,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, base_url:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim} for more # details. @@ -627,19 +576,9 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim#type - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM = :AKENEO_PIM - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index f4d05699..8c3a2942 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -33,8 +33,8 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] - required :type, enum: -> { Imagekit::Accounts::OriginUpdateParams::Type } + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -130,7 +130,7 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # @return [String] required :username, String - # @!method initialize(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # @!method initialize(access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) # @param access_key [String] Access key for the bucket. # # @param bucket [String] @@ -139,8 +139,6 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # # @param secret_key [String] Secret key for the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] - # # @param endpoint [String] Custom S3-compatible endpoint. # # @param base_url [String] Akeneo instance base URL. @@ -173,16 +171,9 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # + # @param type [Symbol, :AKENEO_PIM] + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM = :AKENEO_PIM - - # @!method self.values - # @return [Array] - end end end end diff --git a/lib/imagekit/models/accounts/origin_update_response.rb b/lib/imagekit/models/accounts/origin_update_response.rb index fec36bd8..a823f431 100644 --- a/lib/imagekit/models/accounts/origin_update_response.rb +++ b/lib/imagekit/models/accounts/origin_update_response.rb @@ -223,8 +223,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type } + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -241,7 +241,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup} for more # details. @@ -256,19 +256,9 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param prefix [String] Path prefix inside the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :CLOUDINARY_BACKUP] end class WebFolder < Imagekit::Internal::Type::BaseModel @@ -302,8 +292,8 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type } + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -320,7 +310,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder} for more details. # @@ -334,19 +324,9 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder#type - module Type - extend Imagekit::Internal::Type::Enum - - WEB_FOLDER = :WEB_FOLDER - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel @@ -366,8 +346,8 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type } + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -384,7 +364,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy} for more details. # @@ -394,19 +374,9 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy#type - module Type - extend Imagekit::Internal::Type::Enum - - WEB_PROXY = :WEB_PROXY - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :WEB_PROXY] end class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel @@ -441,8 +411,8 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type } + # @return [Symbol, :GCS] + required :type, const: :GCS # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -459,7 +429,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs} for # more details. @@ -476,19 +446,9 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # # @param prefix [String] # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs#type - module Type - extend Imagekit::Internal::Type::Enum - - GCS = :GCS - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :GCS] end class AzureBlobStorage < Imagekit::Internal::Type::BaseModel @@ -523,8 +483,8 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type } + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -541,7 +501,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage} for more # details. @@ -558,19 +518,9 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # # @param prefix [String] # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage#type - module Type - extend Imagekit::Internal::Type::Enum - - AZURE_BLOB = :AZURE_BLOB - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :AZURE_BLOB] end class AkeneoPim < Imagekit::Internal::Type::BaseModel @@ -596,8 +546,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type } + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -614,7 +564,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, base_url:, include_canonical_header:, name:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim} for more details. # @@ -626,19 +576,9 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param name [String] Display name of the origin. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim#type - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM = :AKENEO_PIM - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants diff --git a/lib/imagekit/models/accounts/url_endpoint_create_response.rb b/lib/imagekit/models/accounts/url_endpoint_create_response.rb index 2420347f..b670f18a 100644 --- a/lib/imagekit/models/accounts/url_endpoint_create_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_create_response.rb @@ -83,66 +83,33 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type } + # @return [Symbol, :CLOUDINARY] + required :type, const: :CLOUDINARY - # @!method initialize(preserve_asset_delivery_types:, type:) + # @!method initialize(preserve_asset_delivery_types:, type: :CLOUDINARY) # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. # - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY = :CLOUDINARY - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :CLOUDINARY] end class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum + # @return [Symbol, :IMGIX] + required :type, const: :IMGIX - IMGIX = :IMGIX - - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :IMGIX) + # @param type [Symbol, :IMGIX] end class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - AKAMAI = :AKAMAI + # @return [Symbol, :AKAMAI] + required :type, const: :AKAMAI - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :AKAMAI) + # @param type [Symbol, :AKAMAI] end # @!method self.variants diff --git a/lib/imagekit/models/accounts/url_endpoint_get_response.rb b/lib/imagekit/models/accounts/url_endpoint_get_response.rb index a9846424..9a28c444 100644 --- a/lib/imagekit/models/accounts/url_endpoint_get_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_get_response.rb @@ -83,66 +83,33 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type } + # @return [Symbol, :CLOUDINARY] + required :type, const: :CLOUDINARY - # @!method initialize(preserve_asset_delivery_types:, type:) + # @!method initialize(preserve_asset_delivery_types:, type: :CLOUDINARY) # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. # - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY = :CLOUDINARY - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :CLOUDINARY] end class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum + # @return [Symbol, :IMGIX] + required :type, const: :IMGIX - IMGIX = :IMGIX - - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :IMGIX) + # @param type [Symbol, :IMGIX] end class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - AKAMAI = :AKAMAI + # @return [Symbol, :AKAMAI] + required :type, const: :AKAMAI - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :AKAMAI) + # @param type [Symbol, :AKAMAI] end # @!method self.variants diff --git a/lib/imagekit/models/accounts/url_endpoint_list_response.rb b/lib/imagekit/models/accounts/url_endpoint_list_response.rb index 5d026596..917c0369 100644 --- a/lib/imagekit/models/accounts/url_endpoint_list_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_list_response.rb @@ -82,66 +82,33 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type } + # @return [Symbol, :CLOUDINARY] + required :type, const: :CLOUDINARY - # @!method initialize(preserve_asset_delivery_types:, type:) + # @!method initialize(preserve_asset_delivery_types:, type: :CLOUDINARY) # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. # - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY = :CLOUDINARY - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :CLOUDINARY] end class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum + # @return [Symbol, :IMGIX] + required :type, const: :IMGIX - IMGIX = :IMGIX - - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :IMGIX) + # @param type [Symbol, :IMGIX] end class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - AKAMAI = :AKAMAI + # @return [Symbol, :AKAMAI] + required :type, const: :AKAMAI - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :AKAMAI) + # @param type [Symbol, :AKAMAI] end # @!method self.variants diff --git a/lib/imagekit/models/accounts/url_endpoint_update_response.rb b/lib/imagekit/models/accounts/url_endpoint_update_response.rb index 0feeb937..a2915c6f 100644 --- a/lib/imagekit/models/accounts/url_endpoint_update_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_update_response.rb @@ -83,66 +83,33 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type } + # @return [Symbol, :CLOUDINARY] + required :type, const: :CLOUDINARY - # @!method initialize(preserve_asset_delivery_types:, type:) + # @!method initialize(preserve_asset_delivery_types:, type: :CLOUDINARY) # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. # - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY = :CLOUDINARY - - # @!method self.values - # @return [Array] - end + # @param type [Symbol, :CLOUDINARY] end class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum + # @return [Symbol, :IMGIX] + required :type, const: :IMGIX - IMGIX = :IMGIX - - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :IMGIX) + # @param type [Symbol, :IMGIX] end class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type] - required :type, - enum: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type } - - # @!method initialize(type:) - # @param type [Symbol, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type] - - # @see Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter#type - module Type - extend Imagekit::Internal::Type::Enum - - AKAMAI = :AKAMAI + # @return [Symbol, :AKAMAI] + required :type, const: :AKAMAI - # @!method self.values - # @return [Array] - end + # @!method initialize(type: :AKAMAI) + # @param type [Symbol, :AKAMAI] end # @!method self.variants diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index ad7b1938..659ee7a2 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -48,7 +48,7 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # Note: The remove operation for `AITags` executes before any of the `extensions` # are processed. # - # @return [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags, nil] + # @return [Array, Symbol, :all, nil] optional :remove_ai_tags, union: -> { Imagekit::FileUpdateParams::RemoveAITags @@ -89,7 +89,7 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel # # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # - # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car # # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul # @@ -241,23 +241,13 @@ module RemoveAITags variant -> { Imagekit::Models::FileUpdateParams::RemoveAITags::StringArray } - variant const: -> { Imagekit::Models::FileUpdateParams::RemoveAITags::ALL } + variant const: :all # @!method self.variants - # @return [Array(Array, Symbol)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(T::Array[String], Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol) } - end + # @return [Array(Array, Symbol, :all)] # @type [Imagekit::Internal::Type::Converter] StringArray = Imagekit::Internal::Type::ArrayOf[String] - - # @!group - - ALL = :all - - # @!endgroup end class Publish < Imagekit::Internal::Type::BaseModel diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index 5f58e195..ea7a06b8 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -7,7 +7,7 @@ class Origins # **Note:** This API is currently in beta. # Creates a new origin and returns the origin object. # - # @overload create(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # @overload create(access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) # # @param access_key [String] Access key for the bucket. # @@ -17,8 +17,6 @@ class Origins # # @param secret_key [String] Secret key for the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] - # # @param endpoint [String] Custom S3-compatible endpoint. # # @param base_url [String] Akeneo instance base URL. @@ -51,6 +49,8 @@ class Origins # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # + # @param type [Symbol, :AKENEO_PIM] + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] @@ -73,7 +73,7 @@ def create(params) # **Note:** This API is currently in beta. # Updates the origin identified by `id` and returns the updated origin object. # - # @overload update(id, access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # @overload update(id, access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -85,8 +85,6 @@ def create(params) # # @param secret_key [String] Secret key for the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] - # # @param endpoint [String] Custom S3-compatible endpoint. # # @param base_url [String] Akeneo instance base URL. @@ -119,6 +117,8 @@ def create(params) # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # + # @param type [Symbol, :AKENEO_PIM] + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index fbbf9a49..be7c1626 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -31,7 +31,7 @@ class Files # # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # - # @param remove_ai_tags [Array, Symbol, Imagekit::Models::FileUpdateParams::RemoveAITags] An array of AITags associated with the file that you want to remove, e.g. `["car + # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car # # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul # diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index 9f3c9806..cd637d2b 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -30,7 +30,7 @@ module Imagekit sig { returns(String) } attr_accessor :secret_key - sig { returns(Imagekit::Accounts::OriginCreateParams::Type::OrSymbol) } + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -112,7 +112,6 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, endpoint: String, base_url: String, client_email: String, @@ -129,6 +128,7 @@ module Imagekit prefix: String, s3_force_path_style: T::Boolean, forward_host_header_to_origin: T::Boolean, + type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end @@ -140,7 +140,6 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, - type:, # Custom S3-compatible endpoint. endpoint:, # Akeneo instance base URL. @@ -167,6 +166,7 @@ module Imagekit s3_force_path_style: nil, # Forward the Host header to origin? forward_host_header_to_origin: nil, + type: :AKENEO_PIM, request_options: {} ) end @@ -178,7 +178,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, + type: Symbol, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -201,32 +201,6 @@ module Imagekit end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::Accounts::OriginCreateParams::Type) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKENEO_PIM = - T.let( - :AKENEO_PIM, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end end end diff --git a/rbi/imagekit/models/accounts/origin_create_response.rbi b/rbi/imagekit/models/accounts/origin_create_response.rbi index 6a969bd2..1c2abf81 100644 --- a/rbi/imagekit/models/accounts/origin_create_response.rbi +++ b/rbi/imagekit/models/accounts/origin_create_response.rbi @@ -304,11 +304,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -330,9 +326,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -347,9 +342,9 @@ module Imagekit name:, # Path prefix inside the bucket. prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :CLOUDINARY_BACKUP ) end @@ -361,43 +356,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY_BACKUP = - T.let( - :CLOUDINARY_BACKUP, - Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class WebFolder < Imagekit::Internal::Type::BaseModel @@ -425,11 +390,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -451,9 +412,8 @@ module Imagekit forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -468,9 +428,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :WEB_FOLDER ) end @@ -482,43 +442,13 @@ module Imagekit forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WEB_FOLDER = - T.let( - :WEB_FOLDER, - Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class WebProxy < Imagekit::Internal::Type::BaseModel @@ -538,11 +468,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -562,9 +488,8 @@ module Imagekit id: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -575,9 +500,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :WEB_PROXY ) end @@ -587,43 +512,13 @@ module Imagekit id: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WEB_PROXY = - T.let( - :WEB_PROXY, - Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel @@ -652,11 +547,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -679,9 +570,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -695,9 +585,9 @@ module Imagekit # Display name of the origin. name:, prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :GCS ) end @@ -710,43 +600,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GCS = - T.let( - :GCS, - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AzureBlobStorage < Imagekit::Internal::Type::BaseModel @@ -775,11 +635,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -802,9 +658,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -818,9 +673,9 @@ module Imagekit # Display name of the origin. name:, prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :AZURE_BLOB ) end @@ -833,43 +688,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AZURE_BLOB = - T.let( - :AZURE_BLOB, - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AkeneoPim < Imagekit::Internal::Type::BaseModel @@ -893,11 +718,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -918,9 +739,8 @@ module Imagekit base_url: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -933,9 +753,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :AKENEO_PIM ) end @@ -946,43 +766,13 @@ module Imagekit base_url: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKENEO_PIM = - T.let( - :AKENEO_PIM, - Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/accounts/origin_get_response.rbi b/rbi/imagekit/models/accounts/origin_get_response.rbi index ee18f2fe..e0abd0ac 100644 --- a/rbi/imagekit/models/accounts/origin_get_response.rbi +++ b/rbi/imagekit/models/accounts/origin_get_response.rbi @@ -304,11 +304,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -330,9 +326,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -347,9 +342,9 @@ module Imagekit name:, # Path prefix inside the bucket. prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :CLOUDINARY_BACKUP ) end @@ -361,43 +356,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY_BACKUP = - T.let( - :CLOUDINARY_BACKUP, - Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class WebFolder < Imagekit::Internal::Type::BaseModel @@ -425,11 +390,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -451,9 +412,8 @@ module Imagekit forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -468,9 +428,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :WEB_FOLDER ) end @@ -482,43 +442,13 @@ module Imagekit forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WEB_FOLDER = - T.let( - :WEB_FOLDER, - Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginGetResponse::WebFolder::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class WebProxy < Imagekit::Internal::Type::BaseModel @@ -538,11 +468,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -562,9 +488,8 @@ module Imagekit id: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -575,9 +500,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :WEB_PROXY ) end @@ -587,43 +512,13 @@ module Imagekit id: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WEB_PROXY = - T.let( - :WEB_PROXY, - Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginGetResponse::WebProxy::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel @@ -652,11 +547,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -679,9 +570,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -695,9 +585,9 @@ module Imagekit # Display name of the origin. name:, prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :GCS ) end @@ -710,43 +600,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GCS = - T.let( - :GCS, - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AzureBlobStorage < Imagekit::Internal::Type::BaseModel @@ -775,11 +635,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -802,9 +658,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -818,9 +673,9 @@ module Imagekit # Display name of the origin. name:, prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :AZURE_BLOB ) end @@ -833,43 +688,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AZURE_BLOB = - T.let( - :AZURE_BLOB, - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AkeneoPim < Imagekit::Internal::Type::BaseModel @@ -893,11 +718,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -918,9 +739,8 @@ module Imagekit base_url: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -933,9 +753,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :AKENEO_PIM ) end @@ -946,43 +766,13 @@ module Imagekit base_url: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKENEO_PIM = - T.let( - :AKENEO_PIM, - Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index 8c5280cd..aa7377b2 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -304,11 +304,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -330,9 +326,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -347,9 +342,9 @@ module Imagekit name:, # Path prefix inside the bucket. prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :CLOUDINARY_BACKUP ) end @@ -361,43 +356,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY_BACKUP = - T.let( - :CLOUDINARY_BACKUP, - Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class WebFolder < Imagekit::Internal::Type::BaseModel @@ -425,11 +390,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -451,9 +412,8 @@ module Imagekit forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -468,9 +428,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :WEB_FOLDER ) end @@ -482,43 +442,13 @@ module Imagekit forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WEB_FOLDER = - T.let( - :WEB_FOLDER, - Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class WebProxy < Imagekit::Internal::Type::BaseModel @@ -538,11 +468,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -562,9 +488,8 @@ module Imagekit id: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -575,9 +500,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :WEB_PROXY ) end @@ -587,43 +512,13 @@ module Imagekit id: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WEB_PROXY = - T.let( - :WEB_PROXY, - Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel @@ -652,11 +547,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -679,9 +570,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -695,9 +585,9 @@ module Imagekit # Display name of the origin. name:, prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :GCS ) end @@ -710,43 +600,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GCS = - T.let( - :GCS, - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AzureBlobStorage < Imagekit::Internal::Type::BaseModel @@ -775,11 +635,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -802,9 +658,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -818,9 +673,9 @@ module Imagekit # Display name of the origin. name:, prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :AZURE_BLOB ) end @@ -833,43 +688,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AZURE_BLOB = - T.let( - :AZURE_BLOB, - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AkeneoPim < Imagekit::Internal::Type::BaseModel @@ -893,11 +718,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -918,9 +739,8 @@ module Imagekit base_url: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -933,9 +753,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :AKENEO_PIM ) end @@ -946,43 +766,13 @@ module Imagekit base_url: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKENEO_PIM = - T.let( - :AKENEO_PIM, - Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index 589c337f..d5ad1e3b 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -30,7 +30,7 @@ module Imagekit sig { returns(String) } attr_accessor :secret_key - sig { returns(Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol) } + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -112,7 +112,6 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, endpoint: String, base_url: String, client_email: String, @@ -129,6 +128,7 @@ module Imagekit prefix: String, s3_force_path_style: T::Boolean, forward_host_header_to_origin: T::Boolean, + type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end @@ -140,7 +140,6 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, - type:, # Custom S3-compatible endpoint. endpoint:, # Akeneo instance base URL. @@ -167,6 +166,7 @@ module Imagekit s3_force_path_style: nil, # Forward the Host header to origin? forward_host_header_to_origin: nil, + type: :AKENEO_PIM, request_options: {} ) end @@ -178,7 +178,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, + type: Symbol, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -201,32 +201,6 @@ module Imagekit end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::Accounts::OriginUpdateParams::Type) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKENEO_PIM = - T.let( - :AKENEO_PIM, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end end end diff --git a/rbi/imagekit/models/accounts/origin_update_response.rbi b/rbi/imagekit/models/accounts/origin_update_response.rbi index 40f85070..9bcf3267 100644 --- a/rbi/imagekit/models/accounts/origin_update_response.rbi +++ b/rbi/imagekit/models/accounts/origin_update_response.rbi @@ -304,11 +304,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -330,9 +326,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -347,9 +342,9 @@ module Imagekit name:, # Path prefix inside the bucket. prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :CLOUDINARY_BACKUP ) end @@ -361,43 +356,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY_BACKUP = - T.let( - :CLOUDINARY_BACKUP, - Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class WebFolder < Imagekit::Internal::Type::BaseModel @@ -425,11 +390,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -451,9 +412,8 @@ module Imagekit forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -468,9 +428,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :WEB_FOLDER ) end @@ -482,43 +442,13 @@ module Imagekit forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WEB_FOLDER = - T.let( - :WEB_FOLDER, - Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class WebProxy < Imagekit::Internal::Type::BaseModel @@ -538,11 +468,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -562,9 +488,8 @@ module Imagekit id: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -575,9 +500,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :WEB_PROXY ) end @@ -587,43 +512,13 @@ module Imagekit id: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WEB_PROXY = - T.let( - :WEB_PROXY, - Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel @@ -652,11 +547,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -679,9 +570,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -695,9 +585,9 @@ module Imagekit # Display name of the origin. name:, prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :GCS ) end @@ -710,43 +600,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GCS = - T.let( - :GCS, - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AzureBlobStorage < Imagekit::Internal::Type::BaseModel @@ -775,11 +635,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -802,9 +658,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -818,9 +673,9 @@ module Imagekit # Display name of the origin. name:, prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :AZURE_BLOB ) end @@ -833,43 +688,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AZURE_BLOB = - T.let( - :AZURE_BLOB, - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AkeneoPim < Imagekit::Internal::Type::BaseModel @@ -893,11 +718,7 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig do - returns( - Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -918,9 +739,8 @@ module Imagekit base_url: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -933,9 +753,9 @@ module Imagekit include_canonical_header:, # Display name of the origin. name:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :AKENEO_PIM ) end @@ -946,43 +766,13 @@ module Imagekit base_url: String, include_canonical_header: T::Boolean, name: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKENEO_PIM = - T.let( - :AKENEO_PIM, - Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi index e2df38b0..872f62da 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi @@ -130,67 +130,29 @@ module Imagekit sig { returns(T::Boolean) } attr_accessor :preserve_asset_delivery_types - sig do - returns( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type sig do params( preserve_asset_delivery_types: T::Boolean, - type: - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + type: Symbol ).returns(T.attached_class) end def self.new( # Whether to preserve `/` in the rewritten URL. preserve_asset_delivery_types:, - type: + type: :CLOUDINARY ) end sig do override.returns( - { - preserve_asset_delivery_types: T::Boolean, - type: - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - } + { preserve_asset_delivery_types: T::Boolean, type: Symbol } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY = - T.let( - :CLOUDINARY, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel @@ -202,61 +164,16 @@ module Imagekit ) end - sig do - returns( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :IMGIX) end - sig do - override.returns( - { - type: - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IMGIX = - T.let( - :IMGIX, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel @@ -268,61 +185,16 @@ module Imagekit ) end - sig do - returns( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :AKAMAI) end - sig do - override.returns( - { - type: - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKAMAI = - T.let( - :AKAMAI, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi index 5dcfb6a1..db774dc9 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi @@ -130,67 +130,29 @@ module Imagekit sig { returns(T::Boolean) } attr_accessor :preserve_asset_delivery_types - sig do - returns( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type sig do params( preserve_asset_delivery_types: T::Boolean, - type: - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + type: Symbol ).returns(T.attached_class) end def self.new( # Whether to preserve `/` in the rewritten URL. preserve_asset_delivery_types:, - type: + type: :CLOUDINARY ) end sig do override.returns( - { - preserve_asset_delivery_types: T::Boolean, - type: - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - } + { preserve_asset_delivery_types: T::Boolean, type: Symbol } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY = - T.let( - :CLOUDINARY, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel @@ -202,61 +164,16 @@ module Imagekit ) end - sig do - returns( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :IMGIX) end - sig do - override.returns( - { - type: - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IMGIX = - T.let( - :IMGIX, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel @@ -268,61 +185,16 @@ module Imagekit ) end - sig do - returns( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :AKAMAI) end - sig do - override.returns( - { - type: - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKAMAI = - T.let( - :AKAMAI, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi index 49979644..3b857f7d 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi @@ -130,67 +130,29 @@ module Imagekit sig { returns(T::Boolean) } attr_accessor :preserve_asset_delivery_types - sig do - returns( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type sig do params( preserve_asset_delivery_types: T::Boolean, - type: - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + type: Symbol ).returns(T.attached_class) end def self.new( # Whether to preserve `/` in the rewritten URL. preserve_asset_delivery_types:, - type: + type: :CLOUDINARY ) end sig do override.returns( - { - preserve_asset_delivery_types: T::Boolean, - type: - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - } + { preserve_asset_delivery_types: T::Boolean, type: Symbol } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY = - T.let( - :CLOUDINARY, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel @@ -202,61 +164,16 @@ module Imagekit ) end - sig do - returns( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :IMGIX) end - sig do - override.returns( - { - type: - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IMGIX = - T.let( - :IMGIX, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel @@ -268,61 +185,16 @@ module Imagekit ) end - sig do - returns( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :AKAMAI) end - sig do - override.returns( - { - type: - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKAMAI = - T.let( - :AKAMAI, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi index 9b9871a4..3a0dc779 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi @@ -130,67 +130,29 @@ module Imagekit sig { returns(T::Boolean) } attr_accessor :preserve_asset_delivery_types - sig do - returns( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type sig do params( preserve_asset_delivery_types: T::Boolean, - type: - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::OrSymbol + type: Symbol ).returns(T.attached_class) end def self.new( # Whether to preserve `/` in the rewritten URL. preserve_asset_delivery_types:, - type: + type: :CLOUDINARY ) end sig do override.returns( - { - preserve_asset_delivery_types: T::Boolean, - type: - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - } + { preserve_asset_delivery_types: T::Boolean, type: Symbol } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLOUDINARY = - T.let( - :CLOUDINARY, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel @@ -202,61 +164,16 @@ module Imagekit ) end - sig do - returns( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :IMGIX) end - sig do - override.returns( - { - type: - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IMGIX = - T.let( - :IMGIX, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel @@ -268,61 +185,16 @@ module Imagekit ) end - sig do - returns( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type - sig do - params( - type: - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new(type:) + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :AKAMAI) end - sig do - override.returns( - { - type: - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - } - ) - end + sig { override.returns({ type: Symbol }) } def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - AKAMAI = - T.let( - :AKAMAI, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end sig do diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index 2a25eca1..3da6056a 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -71,27 +71,10 @@ module Imagekit # # Note: The remove operation for `AITags` executes before any of the `extensions` # are processed. - sig do - returns( - T.nilable( - T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol - ) - ) - ) - end + sig { returns(T.nilable(T.any(T::Array[String], Symbol))) } attr_reader :remove_ai_tags - sig do - params( - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol - ) - ).void - end + sig { params(remove_ai_tags: T.any(T::Array[String], Symbol)).void } attr_writer :remove_ai_tags # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send @@ -129,11 +112,7 @@ module Imagekit Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash ) ], - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol - ), + remove_ai_tags: T.any(T::Array[String], Symbol), tags: T.nilable(T::Array[String]), webhook_url: String, publish: Imagekit::FileUpdateParams::Publish::OrHash, @@ -190,11 +169,7 @@ module Imagekit Imagekit::FileUpdateParams::Extension::AutoTaggingExtension ) ], - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol - ), + remove_ai_tags: T.any(T::Array[String], Symbol), tags: T.nilable(T::Array[String]), webhook_url: String, publish: Imagekit::FileUpdateParams::Publish, @@ -492,13 +467,7 @@ module Imagekit module RemoveAITags extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol - ) - end + Variants = T.type_alias { T.any(T::Array[String], Symbol) } sig do override.returns( @@ -513,15 +482,6 @@ module Imagekit Imagekit::Internal::Type::ArrayOf[String], Imagekit::Internal::Type::Converter ) - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::FileUpdateParams::RemoveAITags) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ALL = - T.let(:all, Imagekit::FileUpdateParams::RemoveAITags::TaggedSymbol) end class Publish < Imagekit::Internal::Type::BaseModel diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index 73b6f746..69bb4057 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -12,7 +12,6 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, endpoint: String, base_url: String, client_email: String, @@ -29,6 +28,7 @@ module Imagekit prefix: String, s3_force_path_style: T::Boolean, forward_host_header_to_origin: T::Boolean, + type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginCreateResponse::Variants) end @@ -40,7 +40,6 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, - type:, # Custom S3-compatible endpoint. endpoint:, # Akeneo instance base URL. @@ -67,6 +66,7 @@ module Imagekit s3_force_path_style: nil, # Forward the Host header to origin? forward_host_header_to_origin: nil, + type: :AKENEO_PIM, request_options: {} ) end @@ -80,7 +80,6 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, endpoint: String, base_url: String, client_email: String, @@ -97,6 +96,7 @@ module Imagekit prefix: String, s3_force_path_style: T::Boolean, forward_host_header_to_origin: T::Boolean, + type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginUpdateResponse::Variants) end @@ -111,7 +111,6 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, - type:, # Custom S3-compatible endpoint. endpoint:, # Akeneo instance base URL. @@ -138,6 +137,7 @@ module Imagekit s3_force_path_style: nil, # Forward the Host header to origin? forward_host_header_to_origin: nil, + type: :AKENEO_PIM, request_options: {} ) end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 29175193..d637ea8d 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -29,11 +29,7 @@ module Imagekit Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash ) ], - remove_ai_tags: - T.any( - T::Array[String], - Imagekit::FileUpdateParams::RemoveAITags::OrSymbol - ), + remove_ai_tags: T.any(T::Array[String], Symbol), tags: T.nilable(T::Array[String]), webhook_url: String, publish: Imagekit::FileUpdateParams::Publish::OrHash, diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index 679133d0..abacd268 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -7,7 +7,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Models::Accounts::OriginCreateParams::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -39,7 +39,7 @@ module Imagekit attr_accessor secret_key: String - attr_accessor type: Imagekit::Models::Accounts::OriginCreateParams::type_ + attr_accessor type: :AKENEO_PIM attr_reader base_url_for_canonical_header: String? @@ -88,7 +88,6 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Models::Accounts::OriginCreateParams::type_, endpoint: String, base_url: String, client_email: String, @@ -105,6 +104,7 @@ module Imagekit ?prefix: String, ?s3_force_path_style: bool, ?forward_host_header_to_origin: bool, + ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> void @@ -113,7 +113,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Models::Accounts::OriginCreateParams::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -132,16 +132,6 @@ module Imagekit username: String, request_options: Imagekit::RequestOptions } - - type type_ = :AKENEO_PIM - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM: :AKENEO_PIM - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateParams::type_] - end end end end diff --git a/sig/imagekit/models/accounts/origin_create_response.rbs b/sig/imagekit/models/accounts/origin_create_response.rbs index 974647ad..9e692c0b 100644 --- a/sig/imagekit/models/accounts/origin_create_response.rbs +++ b/sig/imagekit/models/accounts/origin_create_response.rbs @@ -149,7 +149,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, + type: :CLOUDINARY_BACKUP, base_url_for_canonical_header: String } @@ -162,7 +162,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_ + attr_accessor type: :CLOUDINARY_BACKUP attr_reader base_url_for_canonical_header: String? @@ -176,8 +176,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { @@ -186,19 +186,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_, + type: :CLOUDINARY_BACKUP, base_url_for_canonical_header: String } - - type type_ = :CLOUDINARY_BACKUP - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup::type_] - end end type web_folder = @@ -208,7 +198,7 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_, + type: :WEB_FOLDER, base_url_for_canonical_header: String } @@ -221,7 +211,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_ + attr_accessor type: :WEB_FOLDER attr_reader base_url_for_canonical_header: String? @@ -235,8 +225,8 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :WEB_FOLDER ) -> void def to_hash: -> { @@ -245,19 +235,9 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_, + type: :WEB_FOLDER, base_url_for_canonical_header: String } - - type type_ = :WEB_FOLDER - - module Type - extend Imagekit::Internal::Type::Enum - - WEB_FOLDER: :WEB_FOLDER - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::WebFolder::type_] - end end type web_proxy = @@ -265,7 +245,7 @@ module Imagekit id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_, + type: :WEB_PROXY, base_url_for_canonical_header: String } @@ -274,7 +254,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_ + attr_accessor type: :WEB_PROXY attr_reader base_url_for_canonical_header: String? @@ -286,27 +266,17 @@ module Imagekit id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :WEB_PROXY ) -> void def to_hash: -> { id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_, + type: :WEB_PROXY, base_url_for_canonical_header: String } - - type type_ = :WEB_PROXY - - module Type - extend Imagekit::Internal::Type::Enum - - WEB_PROXY: :WEB_PROXY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::WebProxy::type_] - end end type google_cloud_storage_gcs = @@ -317,7 +287,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, + type: :GCS, base_url_for_canonical_header: String } @@ -332,7 +302,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_ + attr_accessor type: :GCS attr_reader base_url_for_canonical_header: String? @@ -347,8 +317,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :GCS ) -> void def to_hash: -> { @@ -358,19 +328,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_, + type: :GCS, base_url_for_canonical_header: String } - - type type_ = :GCS - - module Type - extend Imagekit::Internal::Type::Enum - - GCS: :GCS - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs::type_] - end end type azure_blob_storage = @@ -381,7 +341,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, + type: :AZURE_BLOB, base_url_for_canonical_header: String } @@ -396,7 +356,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_ + attr_accessor type: :AZURE_BLOB attr_reader base_url_for_canonical_header: String? @@ -411,8 +371,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :AZURE_BLOB ) -> void def to_hash: -> { @@ -422,19 +382,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_, + type: :AZURE_BLOB, base_url_for_canonical_header: String } - - type type_ = :AZURE_BLOB - - module Type - extend Imagekit::Internal::Type::Enum - - AZURE_BLOB: :AZURE_BLOB - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage::type_] - end end type akeneo_pim = @@ -443,7 +393,7 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String } @@ -454,7 +404,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_ + attr_accessor type: :AKENEO_PIM attr_reader base_url_for_canonical_header: String? @@ -467,8 +417,8 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :AKENEO_PIM ) -> void def to_hash: -> { @@ -476,19 +426,9 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String } - - type type_ = :AKENEO_PIM - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM: :AKENEO_PIM - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim::type_] - end end def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_create_response] diff --git a/sig/imagekit/models/accounts/origin_get_response.rbs b/sig/imagekit/models/accounts/origin_get_response.rbs index b640c28f..53dda258 100644 --- a/sig/imagekit/models/accounts/origin_get_response.rbs +++ b/sig/imagekit/models/accounts/origin_get_response.rbs @@ -149,7 +149,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, + type: :CLOUDINARY_BACKUP, base_url_for_canonical_header: String } @@ -162,7 +162,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_ + attr_accessor type: :CLOUDINARY_BACKUP attr_reader base_url_for_canonical_header: String? @@ -176,8 +176,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { @@ -186,19 +186,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_, + type: :CLOUDINARY_BACKUP, base_url_for_canonical_header: String } - - type type_ = :CLOUDINARY_BACKUP - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup::type_] - end end type web_folder = @@ -208,7 +198,7 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_, + type: :WEB_FOLDER, base_url_for_canonical_header: String } @@ -221,7 +211,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_ + attr_accessor type: :WEB_FOLDER attr_reader base_url_for_canonical_header: String? @@ -235,8 +225,8 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :WEB_FOLDER ) -> void def to_hash: -> { @@ -245,19 +235,9 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_, + type: :WEB_FOLDER, base_url_for_canonical_header: String } - - type type_ = :WEB_FOLDER - - module Type - extend Imagekit::Internal::Type::Enum - - WEB_FOLDER: :WEB_FOLDER - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::WebFolder::type_] - end end type web_proxy = @@ -265,7 +245,7 @@ module Imagekit id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_, + type: :WEB_PROXY, base_url_for_canonical_header: String } @@ -274,7 +254,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_ + attr_accessor type: :WEB_PROXY attr_reader base_url_for_canonical_header: String? @@ -286,27 +266,17 @@ module Imagekit id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :WEB_PROXY ) -> void def to_hash: -> { id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_, + type: :WEB_PROXY, base_url_for_canonical_header: String } - - type type_ = :WEB_PROXY - - module Type - extend Imagekit::Internal::Type::Enum - - WEB_PROXY: :WEB_PROXY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::WebProxy::type_] - end end type google_cloud_storage_gcs = @@ -317,7 +287,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, + type: :GCS, base_url_for_canonical_header: String } @@ -332,7 +302,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_ + attr_accessor type: :GCS attr_reader base_url_for_canonical_header: String? @@ -347,8 +317,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :GCS ) -> void def to_hash: -> { @@ -358,19 +328,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_, + type: :GCS, base_url_for_canonical_header: String } - - type type_ = :GCS - - module Type - extend Imagekit::Internal::Type::Enum - - GCS: :GCS - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs::type_] - end end type azure_blob_storage = @@ -381,7 +341,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, + type: :AZURE_BLOB, base_url_for_canonical_header: String } @@ -396,7 +356,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_ + attr_accessor type: :AZURE_BLOB attr_reader base_url_for_canonical_header: String? @@ -411,8 +371,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :AZURE_BLOB ) -> void def to_hash: -> { @@ -422,19 +382,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_, + type: :AZURE_BLOB, base_url_for_canonical_header: String } - - type type_ = :AZURE_BLOB - - module Type - extend Imagekit::Internal::Type::Enum - - AZURE_BLOB: :AZURE_BLOB - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage::type_] - end end type akeneo_pim = @@ -443,7 +393,7 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String } @@ -454,7 +404,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_ + attr_accessor type: :AKENEO_PIM attr_reader base_url_for_canonical_header: String? @@ -467,8 +417,8 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :AKENEO_PIM ) -> void def to_hash: -> { @@ -476,19 +426,9 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String } - - type type_ = :AKENEO_PIM - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM: :AKENEO_PIM - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim::type_] - end end def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_get_response] diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index a70b584e..8bd9e105 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -149,7 +149,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, + type: :CLOUDINARY_BACKUP, base_url_for_canonical_header: String } @@ -162,7 +162,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_ + attr_accessor type: :CLOUDINARY_BACKUP attr_reader base_url_for_canonical_header: String? @@ -176,8 +176,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { @@ -186,19 +186,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_, + type: :CLOUDINARY_BACKUP, base_url_for_canonical_header: String } - - type type_ = :CLOUDINARY_BACKUP - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup::type_] - end end type web_folder = @@ -208,7 +198,7 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_, + type: :WEB_FOLDER, base_url_for_canonical_header: String } @@ -221,7 +211,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_ + attr_accessor type: :WEB_FOLDER attr_reader base_url_for_canonical_header: String? @@ -235,8 +225,8 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :WEB_FOLDER ) -> void def to_hash: -> { @@ -245,19 +235,9 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_, + type: :WEB_FOLDER, base_url_for_canonical_header: String } - - type type_ = :WEB_FOLDER - - module Type - extend Imagekit::Internal::Type::Enum - - WEB_FOLDER: :WEB_FOLDER - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::WebFolder::type_] - end end type web_proxy = @@ -265,7 +245,7 @@ module Imagekit id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_, + type: :WEB_PROXY, base_url_for_canonical_header: String } @@ -274,7 +254,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_ + attr_accessor type: :WEB_PROXY attr_reader base_url_for_canonical_header: String? @@ -286,27 +266,17 @@ module Imagekit id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :WEB_PROXY ) -> void def to_hash: -> { id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_, + type: :WEB_PROXY, base_url_for_canonical_header: String } - - type type_ = :WEB_PROXY - - module Type - extend Imagekit::Internal::Type::Enum - - WEB_PROXY: :WEB_PROXY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::WebProxy::type_] - end end type google_cloud_storage_gcs = @@ -317,7 +287,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, + type: :GCS, base_url_for_canonical_header: String } @@ -332,7 +302,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_ + attr_accessor type: :GCS attr_reader base_url_for_canonical_header: String? @@ -347,8 +317,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :GCS ) -> void def to_hash: -> { @@ -358,19 +328,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_, + type: :GCS, base_url_for_canonical_header: String } - - type type_ = :GCS - - module Type - extend Imagekit::Internal::Type::Enum - - GCS: :GCS - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs::type_] - end end type azure_blob_storage = @@ -381,7 +341,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, + type: :AZURE_BLOB, base_url_for_canonical_header: String } @@ -396,7 +356,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_ + attr_accessor type: :AZURE_BLOB attr_reader base_url_for_canonical_header: String? @@ -411,8 +371,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :AZURE_BLOB ) -> void def to_hash: -> { @@ -422,19 +382,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_, + type: :AZURE_BLOB, base_url_for_canonical_header: String } - - type type_ = :AZURE_BLOB - - module Type - extend Imagekit::Internal::Type::Enum - - AZURE_BLOB: :AZURE_BLOB - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage::type_] - end end type akeneo_pim = @@ -443,7 +393,7 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String } @@ -454,7 +404,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_ + attr_accessor type: :AKENEO_PIM attr_reader base_url_for_canonical_header: String? @@ -467,8 +417,8 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :AKENEO_PIM ) -> void def to_hash: -> { @@ -476,19 +426,9 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String } - - type type_ = :AKENEO_PIM - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM: :AKENEO_PIM - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim::type_] - end end def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_list_response_item] diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index ff5d0ad2..921bd49d 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -7,7 +7,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Models::Accounts::OriginUpdateParams::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -39,7 +39,7 @@ module Imagekit attr_accessor secret_key: String - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateParams::type_ + attr_accessor type: :AKENEO_PIM attr_reader base_url_for_canonical_header: String? @@ -88,7 +88,6 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Models::Accounts::OriginUpdateParams::type_, endpoint: String, base_url: String, client_email: String, @@ -105,6 +104,7 @@ module Imagekit ?prefix: String, ?s3_force_path_style: bool, ?forward_host_header_to_origin: bool, + ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> void @@ -113,7 +113,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Models::Accounts::OriginUpdateParams::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -132,16 +132,6 @@ module Imagekit username: String, request_options: Imagekit::RequestOptions } - - type type_ = :AKENEO_PIM - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM: :AKENEO_PIM - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateParams::type_] - end end end end diff --git a/sig/imagekit/models/accounts/origin_update_response.rbs b/sig/imagekit/models/accounts/origin_update_response.rbs index 897e6df2..08e062da 100644 --- a/sig/imagekit/models/accounts/origin_update_response.rbs +++ b/sig/imagekit/models/accounts/origin_update_response.rbs @@ -149,7 +149,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, + type: :CLOUDINARY_BACKUP, base_url_for_canonical_header: String } @@ -162,7 +162,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_ + attr_accessor type: :CLOUDINARY_BACKUP attr_reader base_url_for_canonical_header: String? @@ -176,8 +176,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { @@ -186,19 +186,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_, + type: :CLOUDINARY_BACKUP, base_url_for_canonical_header: String } - - type type_ = :CLOUDINARY_BACKUP - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup::type_] - end end type web_folder = @@ -208,7 +198,7 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_, + type: :WEB_FOLDER, base_url_for_canonical_header: String } @@ -221,7 +211,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_ + attr_accessor type: :WEB_FOLDER attr_reader base_url_for_canonical_header: String? @@ -235,8 +225,8 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :WEB_FOLDER ) -> void def to_hash: -> { @@ -245,19 +235,9 @@ module Imagekit forward_host_header_to_origin: bool, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_, + type: :WEB_FOLDER, base_url_for_canonical_header: String } - - type type_ = :WEB_FOLDER - - module Type - extend Imagekit::Internal::Type::Enum - - WEB_FOLDER: :WEB_FOLDER - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder::type_] - end end type web_proxy = @@ -265,7 +245,7 @@ module Imagekit id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_, + type: :WEB_PROXY, base_url_for_canonical_header: String } @@ -274,7 +254,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_ + attr_accessor type: :WEB_PROXY attr_reader base_url_for_canonical_header: String? @@ -286,27 +266,17 @@ module Imagekit id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :WEB_PROXY ) -> void def to_hash: -> { id: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_, + type: :WEB_PROXY, base_url_for_canonical_header: String } - - type type_ = :WEB_PROXY - - module Type - extend Imagekit::Internal::Type::Enum - - WEB_PROXY: :WEB_PROXY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy::type_] - end end type google_cloud_storage_gcs = @@ -317,7 +287,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, + type: :GCS, base_url_for_canonical_header: String } @@ -332,7 +302,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_ + attr_accessor type: :GCS attr_reader base_url_for_canonical_header: String? @@ -347,8 +317,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :GCS ) -> void def to_hash: -> { @@ -358,19 +328,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_, + type: :GCS, base_url_for_canonical_header: String } - - type type_ = :GCS - - module Type - extend Imagekit::Internal::Type::Enum - - GCS: :GCS - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs::type_] - end end type azure_blob_storage = @@ -381,7 +341,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, + type: :AZURE_BLOB, base_url_for_canonical_header: String } @@ -396,7 +356,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_ + attr_accessor type: :AZURE_BLOB attr_reader base_url_for_canonical_header: String? @@ -411,8 +371,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :AZURE_BLOB ) -> void def to_hash: -> { @@ -422,19 +382,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_, + type: :AZURE_BLOB, base_url_for_canonical_header: String } - - type type_ = :AZURE_BLOB - - module Type - extend Imagekit::Internal::Type::Enum - - AZURE_BLOB: :AZURE_BLOB - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage::type_] - end end type akeneo_pim = @@ -443,7 +393,7 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String } @@ -454,7 +404,7 @@ module Imagekit attr_accessor name: String - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_ + attr_accessor type: :AKENEO_PIM attr_reader base_url_for_canonical_header: String? @@ -467,8 +417,8 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :AKENEO_PIM ) -> void def to_hash: -> { @@ -476,19 +426,9 @@ module Imagekit base_url: String, include_canonical_header: bool, name: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_, + type: :AKENEO_PIM, base_url_for_canonical_header: String } - - type type_ = :AKENEO_PIM - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM: :AKENEO_PIM - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim::type_] - end end def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_update_response] diff --git a/sig/imagekit/models/accounts/url_endpoint_create_response.rbs b/sig/imagekit/models/accounts/url_endpoint_create_response.rbs index 5b033e19..d9eb5699 100644 --- a/sig/imagekit/models/accounts/url_endpoint_create_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_create_response.rbs @@ -50,89 +50,42 @@ module Imagekit extend Imagekit::Internal::Type::Union type cloudinary_url_rewriter = - { - preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_ - } + { preserve_asset_delivery_types: bool, type: :CLOUDINARY } class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool - attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_ + attr_accessor type: :CLOUDINARY def initialize: ( preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_ + ?type: :CLOUDINARY ) -> void def to_hash: -> { preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_ + type: :CLOUDINARY } - - type type_ = :CLOUDINARY - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY: :CLOUDINARY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::type_] - end end - type imgix_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_ - } + type imgix_url_rewriter = { type: :IMGIX } class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_ - } - - type type_ = :IMGIX - - module Type - extend Imagekit::Internal::Type::Enum + attr_accessor type: :IMGIX - IMGIX: :IMGIX + def initialize: (?type: :IMGIX) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::type_] - end + def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_ - } + type akamai_url_rewriter = { type: :AKAMAI } class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_ - } - - type type_ = :AKAMAI - - module Type - extend Imagekit::Internal::Type::Enum + attr_accessor type: :AKAMAI - AKAMAI: :AKAMAI + def initialize: (?type: :AKAMAI) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::type_] - end + def to_hash: -> { type: :AKAMAI } end def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter] diff --git a/sig/imagekit/models/accounts/url_endpoint_get_response.rbs b/sig/imagekit/models/accounts/url_endpoint_get_response.rbs index 205407ad..54065ae0 100644 --- a/sig/imagekit/models/accounts/url_endpoint_get_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_get_response.rbs @@ -50,89 +50,42 @@ module Imagekit extend Imagekit::Internal::Type::Union type cloudinary_url_rewriter = - { - preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_ - } + { preserve_asset_delivery_types: bool, type: :CLOUDINARY } class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool - attr_accessor type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_ + attr_accessor type: :CLOUDINARY def initialize: ( preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_ + ?type: :CLOUDINARY ) -> void def to_hash: -> { preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_ + type: :CLOUDINARY } - - type type_ = :CLOUDINARY - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY: :CLOUDINARY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::type_] - end end - type imgix_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_ - } + type imgix_url_rewriter = { type: :IMGIX } class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_ - } - - type type_ = :IMGIX - - module Type - extend Imagekit::Internal::Type::Enum + attr_accessor type: :IMGIX - IMGIX: :IMGIX + def initialize: (?type: :IMGIX) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::type_] - end + def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_ - } + type akamai_url_rewriter = { type: :AKAMAI } class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_ - } - - type type_ = :AKAMAI - - module Type - extend Imagekit::Internal::Type::Enum + attr_accessor type: :AKAMAI - AKAMAI: :AKAMAI + def initialize: (?type: :AKAMAI) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::type_] - end + def to_hash: -> { type: :AKAMAI } end def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter] diff --git a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs index d8394666..22b6347a 100644 --- a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs @@ -50,89 +50,42 @@ module Imagekit extend Imagekit::Internal::Type::Union type cloudinary_url_rewriter = - { - preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_ - } + { preserve_asset_delivery_types: bool, type: :CLOUDINARY } class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool - attr_accessor type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_ + attr_accessor type: :CLOUDINARY def initialize: ( preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_ + ?type: :CLOUDINARY ) -> void def to_hash: -> { preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_ + type: :CLOUDINARY } - - type type_ = :CLOUDINARY - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY: :CLOUDINARY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::type_] - end end - type imgix_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_ - } + type imgix_url_rewriter = { type: :IMGIX } class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_ - } - - type type_ = :IMGIX - - module Type - extend Imagekit::Internal::Type::Enum + attr_accessor type: :IMGIX - IMGIX: :IMGIX + def initialize: (?type: :IMGIX) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::type_] - end + def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_ - } + type akamai_url_rewriter = { type: :AKAMAI } class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_ - } - - type type_ = :AKAMAI - - module Type - extend Imagekit::Internal::Type::Enum + attr_accessor type: :AKAMAI - AKAMAI: :AKAMAI + def initialize: (?type: :AKAMAI) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::type_] - end + def to_hash: -> { type: :AKAMAI } end def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter] diff --git a/sig/imagekit/models/accounts/url_endpoint_update_response.rbs b/sig/imagekit/models/accounts/url_endpoint_update_response.rbs index d32f91c7..85daa156 100644 --- a/sig/imagekit/models/accounts/url_endpoint_update_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_update_response.rbs @@ -50,89 +50,42 @@ module Imagekit extend Imagekit::Internal::Type::Union type cloudinary_url_rewriter = - { - preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_ - } + { preserve_asset_delivery_types: bool, type: :CLOUDINARY } class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool - attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_ + attr_accessor type: :CLOUDINARY def initialize: ( preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_ + ?type: :CLOUDINARY ) -> void def to_hash: -> { preserve_asset_delivery_types: bool, - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_ + type: :CLOUDINARY } - - type type_ = :CLOUDINARY - - module Type - extend Imagekit::Internal::Type::Enum - - CLOUDINARY: :CLOUDINARY - - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::type_] - end end - type imgix_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_ - } + type imgix_url_rewriter = { type: :IMGIX } class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_ - } - - type type_ = :IMGIX - - module Type - extend Imagekit::Internal::Type::Enum + attr_accessor type: :IMGIX - IMGIX: :IMGIX + def initialize: (?type: :IMGIX) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::type_] - end + def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = - { - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_ - } + type akamai_url_rewriter = { type: :AKAMAI } class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_ - - def initialize: ( - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_ - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_ - } - - type type_ = :AKAMAI - - module Type - extend Imagekit::Internal::Type::Enum + attr_accessor type: :AKAMAI - AKAMAI: :AKAMAI + def initialize: (?type: :AKAMAI) -> void - def self?.values: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::type_] - end + def to_hash: -> { type: :AKAMAI } end def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter] diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index 659c5a64..0a0678c9 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -208,8 +208,6 @@ module Imagekit def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::remove_ai_tags] StringArray: Imagekit::Internal::Type::Converter - - ALL: :all end type publish = { is_published: bool, include_file_versions: bool } diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index fc156612..2b3e4510 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -7,7 +7,6 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Models::Accounts::OriginCreateParams::type_, endpoint: String, base_url: String, client_email: String, @@ -24,6 +23,7 @@ module Imagekit ?prefix: String, ?s3_force_path_style: bool, ?forward_host_header_to_origin: bool, + ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_create_response @@ -33,7 +33,6 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Imagekit::Models::Accounts::OriginUpdateParams::type_, endpoint: String, base_url: String, client_email: String, @@ -50,6 +49,7 @@ module Imagekit ?prefix: String, ?s3_force_path_style: bool, ?forward_host_header_to_origin: bool, + ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_update_response From dab5d109dfc3cb4b8e25d0ef9f618d5f2603fe7d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 10:21:31 +0000 Subject: [PATCH 019/178] feat(api): manual updates --- .stats.yml | 4 +- .../models/accounts/origin_create_response.rb | 40 ++------ .../models/accounts/origin_get_response.rb | 40 ++------ .../models/accounts/origin_list_response.rb | 40 ++------ .../models/accounts/origin_update_response.rb | 40 ++------ ...o_transformation_accepted_webhook_event.rb | 18 +--- ...ideo_transformation_error_webhook_event.rb | 18 +--- ...ideo_transformation_ready_webhook_event.rb | 20 +--- .../accounts/origin_create_response.rbi | 94 +++---------------- .../models/accounts/origin_get_response.rbi | 94 +++---------------- .../models/accounts/origin_list_response.rbi | 94 +++---------------- .../accounts/origin_update_response.rbi | 94 +++---------------- ..._transformation_accepted_webhook_event.rbi | 43 +-------- ...deo_transformation_error_webhook_event.rbi | 39 +------- ...deo_transformation_ready_webhook_event.rbi | 43 ++------- .../accounts/origin_create_response.rbs | 40 ++------ .../models/accounts/origin_get_response.rbs | 40 ++------ .../models/accounts/origin_list_response.rbs | 40 ++------ .../accounts/origin_update_response.rbs | 40 ++------ ..._transformation_accepted_webhook_event.rbs | 18 +--- ...deo_transformation_error_webhook_event.rbs | 18 +--- ...deo_transformation_ready_webhook_event.rbs | 20 +--- 22 files changed, 170 insertions(+), 767 deletions(-) diff --git a/.stats.yml b/.stats.yml index 9c64de6b..fedb1ee0 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-5ed7a3dbaf059adbd91e86cd61520f59c5fdcc8df3f561df9ab07d7afb722f18.yml -openapi_spec_hash: 51d4d2be59d5d3f81a695a9b8786c77e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-cb2369e849b98127ee6a2cbd01d928e4546d29c1a0a8e64e9b46f90189c1a992.yml +openapi_spec_hash: f8e732e88daf7c4bfbeb2bd2cdba2cec config_hash: b75c4e4432c2d0650589863f8336849b diff --git a/lib/imagekit/models/accounts/origin_create_response.rb b/lib/imagekit/models/accounts/origin_create_response.rb index 6a3e8c83..6ecd917b 100644 --- a/lib/imagekit/models/accounts/origin_create_response.rb +++ b/lib/imagekit/models/accounts/origin_create_response.rb @@ -54,8 +54,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::S3::Type } + # @return [Symbol, :S3] + required :type, const: :S3 # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -72,7 +72,7 @@ class S3 < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginCreateResponse::S3} for more details. # @@ -86,19 +86,9 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param prefix [String] Path prefix inside the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginCreateResponse::S3#type - module Type - extend Imagekit::Internal::Type::Enum - - S3 = :S3 - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -142,8 +132,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type } + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -160,7 +150,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible} for more # details. @@ -179,19 +169,9 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible#type - module Type - extend Imagekit::Internal::Type::Enum - - S3_COMPATIBLE = :S3_COMPATIBLE - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel diff --git a/lib/imagekit/models/accounts/origin_get_response.rb b/lib/imagekit/models/accounts/origin_get_response.rb index 1d73dbc7..448ba33e 100644 --- a/lib/imagekit/models/accounts/origin_get_response.rb +++ b/lib/imagekit/models/accounts/origin_get_response.rb @@ -54,8 +54,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::S3::Type } + # @return [Symbol, :S3] + required :type, const: :S3 # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -72,7 +72,7 @@ class S3 < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginGetResponse::S3} for more details. # @@ -86,19 +86,9 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param prefix [String] Path prefix inside the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginGetResponse::S3#type - module Type - extend Imagekit::Internal::Type::Enum - - S3 = :S3 - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -142,8 +132,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type } + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -160,7 +150,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginGetResponse::S3Compatible} for more details. # @@ -178,19 +168,9 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # - # @param type [Symbol, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginGetResponse::S3Compatible#type - module Type - extend Imagekit::Internal::Type::Enum - - S3_COMPATIBLE = :S3_COMPATIBLE - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index b977073a..51131946 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -52,8 +52,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::S3::Type } + # @return [Symbol, :S3] + required :type, const: :S3 # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -70,7 +70,7 @@ class S3 < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginListResponseItem::S3} for more details. # @@ -84,19 +84,9 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param prefix [String] Path prefix inside the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginListResponseItem::S3#type - module Type - extend Imagekit::Internal::Type::Enum - - S3 = :S3 - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -140,8 +130,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type } + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -158,7 +148,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible} for more # details. @@ -177,19 +167,9 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # - # @param type [Symbol, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible#type - module Type - extend Imagekit::Internal::Type::Enum - - S3_COMPATIBLE = :S3_COMPATIBLE - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel diff --git a/lib/imagekit/models/accounts/origin_update_response.rb b/lib/imagekit/models/accounts/origin_update_response.rb index a823f431..d0416176 100644 --- a/lib/imagekit/models/accounts/origin_update_response.rb +++ b/lib/imagekit/models/accounts/origin_update_response.rb @@ -54,8 +54,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type } + # @return [Symbol, :S3] + required :type, const: :S3 # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -72,7 +72,7 @@ class S3 < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginUpdateResponse::S3} for more details. # @@ -86,19 +86,9 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param prefix [String] Path prefix inside the bucket. # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginUpdateResponse::S3#type - module Type - extend Imagekit::Internal::Type::Enum - - S3 = :S3 - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -142,8 +132,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type] - required :type, enum: -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type } + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -160,7 +150,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel required :id, String end - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, type:, base_url_for_canonical_header: nil) + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) # Some parameter documentations has been truncated, see # {Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible} for more # details. @@ -179,19 +169,9 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type] - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - - # @see Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible#type - module Type - extend Imagekit::Internal::Type::Enum - - S3_COMPATIBLE = :S3_COMPATIBLE - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel diff --git a/lib/imagekit/models/video_transformation_accepted_webhook_event.rb b/lib/imagekit/models/video_transformation_accepted_webhook_event.rb index d320d09c..4b238162 100644 --- a/lib/imagekit/models/video_transformation_accepted_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_accepted_webhook_event.rb @@ -26,10 +26,10 @@ class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseMo # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Type] - required :type, enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Type } + # @return [Symbol, :"video.transformation.accepted"] + required :type, const: :"video.transformation.accepted" - # @!method initialize(id:, created_at:, data:, request:, type:) + # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.accepted") # @param id [String] Unique identifier for the event. # # @param created_at [Time] @@ -38,7 +38,7 @@ class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseMo # # @param request [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] # - # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Type] + # @param type [Symbol, :"video.transformation.accepted"] # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#data class Data < Imagekit::Internal::Type::BaseModel @@ -226,16 +226,6 @@ class Request < Imagekit::Internal::Type::BaseModel # # @param user_agent [String] User-Agent header of the originating request. end - - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#type - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION_ACCEPTED = :"video.transformation.accepted" - - # @!method self.values - # @return [Array] - end end end end diff --git a/lib/imagekit/models/video_transformation_error_webhook_event.rb b/lib/imagekit/models/video_transformation_error_webhook_event.rb index 5a6f478c..c639c0a7 100644 --- a/lib/imagekit/models/video_transformation_error_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_error_webhook_event.rb @@ -26,10 +26,10 @@ class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Type] - required :type, enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Type } + # @return [Symbol, :"video.transformation.error"] + required :type, const: :"video.transformation.error" - # @!method initialize(id:, created_at:, data:, request:, type:) + # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.error") # @param id [String] Unique identifier for the event. # # @param created_at [Time] @@ -38,7 +38,7 @@ class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # # @param request [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] # - # @param type [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Type] + # @param type [Symbol, :"video.transformation.error"] # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#data class Data < Imagekit::Internal::Type::BaseModel @@ -256,16 +256,6 @@ class Request < Imagekit::Internal::Type::BaseModel # # @param user_agent [String] User-Agent header of the originating request. end - - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#type - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION_ERROR = :"video.transformation.error" - - # @!method self.values - # @return [Array] - end end end end diff --git a/lib/imagekit/models/video_transformation_ready_webhook_event.rb b/lib/imagekit/models/video_transformation_ready_webhook_event.rb index 39db5f20..812ea710 100644 --- a/lib/imagekit/models/video_transformation_ready_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_ready_webhook_event.rb @@ -26,15 +26,15 @@ class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Type] - required :type, enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Type } + # @return [Symbol, :"video.transformation.ready"] + required :type, const: :"video.transformation.ready" # @!attribute timings # # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings, nil] optional :timings, -> { Imagekit::VideoTransformationReadyWebhookEvent::Timings } - # @!method initialize(id:, created_at:, data:, request:, type:, timings: nil) + # @!method initialize(id:, created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") # @param id [String] Unique identifier for the event. # # @param created_at [Time] @@ -43,9 +43,9 @@ class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel # # @param request [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] # - # @param type [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Type] - # # @param timings [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings] + # + # @param type [Symbol, :"video.transformation.ready"] # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#data class Data < Imagekit::Internal::Type::BaseModel @@ -287,16 +287,6 @@ class Request < Imagekit::Internal::Type::BaseModel # @param user_agent [String] User-Agent header of the originating request. end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#type - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION_READY = :"video.transformation.ready" - - # @!method self.values - # @return [Array] - end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#timings class Timings < Imagekit::Internal::Type::BaseModel # @!attribute download_duration diff --git a/rbi/imagekit/models/accounts/origin_create_response.rbi b/rbi/imagekit/models/accounts/origin_create_response.rbi index 1c2abf81..aaf69d31 100644 --- a/rbi/imagekit/models/accounts/origin_create_response.rbi +++ b/rbi/imagekit/models/accounts/origin_create_response.rbi @@ -46,11 +46,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -72,9 +68,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -89,9 +84,9 @@ module Imagekit name:, # Path prefix inside the bucket. prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :S3 ) end @@ -103,43 +98,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginCreateResponse::S3::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - S3 = - T.let( - :S3, - Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginCreateResponse::S3::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -175,11 +140,7 @@ module Imagekit sig { returns(T::Boolean) } attr_accessor :s3_force_path_style - sig do - returns( - Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -203,9 +164,8 @@ module Imagekit name: String, prefix: String, s3_force_path_style: T::Boolean, - type: - Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -224,9 +184,9 @@ module Imagekit prefix:, # Use path-style S3 URLs? s3_force_path_style:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :S3_COMPATIBLE ) end @@ -240,43 +200,13 @@ module Imagekit name: String, prefix: String, s3_force_path_style: T::Boolean, - type: - Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - S3_COMPATIBLE = - T.let( - :S3_COMPATIBLE, - Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel diff --git a/rbi/imagekit/models/accounts/origin_get_response.rbi b/rbi/imagekit/models/accounts/origin_get_response.rbi index e0abd0ac..56dd3259 100644 --- a/rbi/imagekit/models/accounts/origin_get_response.rbi +++ b/rbi/imagekit/models/accounts/origin_get_response.rbi @@ -46,11 +46,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -72,9 +68,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::S3::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -89,9 +84,9 @@ module Imagekit name:, # Path prefix inside the bucket. prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :S3 ) end @@ -103,43 +98,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginGetResponse::S3::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - S3 = - T.let( - :S3, - Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginGetResponse::S3::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -175,11 +140,7 @@ module Imagekit sig { returns(T::Boolean) } attr_accessor :s3_force_path_style - sig do - returns( - Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -203,9 +164,8 @@ module Imagekit name: String, prefix: String, s3_force_path_style: T::Boolean, - type: - Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -224,9 +184,9 @@ module Imagekit prefix:, # Use path-style S3 URLs? s3_force_path_style:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :S3_COMPATIBLE ) end @@ -240,43 +200,13 @@ module Imagekit name: String, prefix: String, s3_force_path_style: T::Boolean, - type: - Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - S3_COMPATIBLE = - T.let( - :S3_COMPATIBLE, - Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index aa7377b2..6e17786c 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -46,11 +46,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -72,9 +68,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -89,9 +84,9 @@ module Imagekit name:, # Path prefix inside the bucket. prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :S3 ) end @@ -103,43 +98,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginListResponseItem::S3::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - S3 = - T.let( - :S3, - Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::S3::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -175,11 +140,7 @@ module Imagekit sig { returns(T::Boolean) } attr_accessor :s3_force_path_style - sig do - returns( - Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -203,9 +164,8 @@ module Imagekit name: String, prefix: String, s3_force_path_style: T::Boolean, - type: - Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -224,9 +184,9 @@ module Imagekit prefix:, # Use path-style S3 URLs? s3_force_path_style:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :S3_COMPATIBLE ) end @@ -240,43 +200,13 @@ module Imagekit name: String, prefix: String, s3_force_path_style: T::Boolean, - type: - Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - S3_COMPATIBLE = - T.let( - :S3_COMPATIBLE, - Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel diff --git a/rbi/imagekit/models/accounts/origin_update_response.rbi b/rbi/imagekit/models/accounts/origin_update_response.rbi index 9bcf3267..80d6db77 100644 --- a/rbi/imagekit/models/accounts/origin_update_response.rbi +++ b/rbi/imagekit/models/accounts/origin_update_response.rbi @@ -46,11 +46,7 @@ module Imagekit sig { returns(String) } attr_accessor :prefix - sig do - returns( - Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -72,9 +68,8 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -89,9 +84,9 @@ module Imagekit name:, # Path prefix inside the bucket. prefix:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :S3 ) end @@ -103,43 +98,13 @@ module Imagekit include_canonical_header: T::Boolean, name: String, prefix: String, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - S3 = - T.let( - :S3, - Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginUpdateResponse::S3::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -175,11 +140,7 @@ module Imagekit sig { returns(T::Boolean) } attr_accessor :s3_force_path_style - sig do - returns( - Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -203,9 +164,8 @@ module Imagekit name: String, prefix: String, s3_force_path_style: T::Boolean, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::OrSymbol, - base_url_for_canonical_header: String + base_url_for_canonical_header: String, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -224,9 +184,9 @@ module Imagekit prefix:, # Use path-style S3 URLs? s3_force_path_style:, - type:, # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil + base_url_for_canonical_header: nil, + type: :S3_COMPATIBLE ) end @@ -240,43 +200,13 @@ module Imagekit name: String, prefix: String, s3_force_path_style: T::Boolean, - type: - Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol, + type: Symbol, base_url_for_canonical_header: String } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - S3_COMPATIBLE = - T.let( - :S3_COMPATIBLE, - Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel diff --git a/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi b/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi index 7ffb9501..5433ace6 100644 --- a/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi @@ -41,11 +41,7 @@ module Imagekit end attr_writer :request - sig do - returns( - Imagekit::VideoTransformationAcceptedWebhookEvent::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type sig do @@ -55,8 +51,7 @@ module Imagekit data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash, request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash, - type: - Imagekit::VideoTransformationAcceptedWebhookEvent::Type::OrSymbol + type: Symbol ).returns(T.attached_class) end def self.new( @@ -65,7 +60,7 @@ module Imagekit created_at:, data:, request:, - type: + type: :"video.transformation.accepted" ) end @@ -76,8 +71,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, - type: - Imagekit::VideoTransformationAcceptedWebhookEvent::Type::TaggedSymbol + type: Symbol } ) end @@ -610,35 +604,6 @@ module Imagekit def to_hash end end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - VIDEO_TRANSFORMATION_ACCEPTED = - T.let( - :"video.transformation.accepted", - Imagekit::VideoTransformationAcceptedWebhookEvent::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end end end diff --git a/rbi/imagekit/models/video_transformation_error_webhook_event.rbi b/rbi/imagekit/models/video_transformation_error_webhook_event.rbi index 1e34479d..dc3438bf 100644 --- a/rbi/imagekit/models/video_transformation_error_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_error_webhook_event.rbi @@ -39,11 +39,7 @@ module Imagekit end attr_writer :request - sig do - returns( - Imagekit::VideoTransformationErrorWebhookEvent::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type sig do @@ -53,7 +49,7 @@ module Imagekit data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash, request: Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash, - type: Imagekit::VideoTransformationErrorWebhookEvent::Type::OrSymbol + type: Symbol ).returns(T.attached_class) end def self.new( @@ -62,7 +58,7 @@ module Imagekit created_at:, data:, request:, - type: + type: :"video.transformation.error" ) end @@ -73,8 +69,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationErrorWebhookEvent::Data, request: Imagekit::VideoTransformationErrorWebhookEvent::Request, - type: - Imagekit::VideoTransformationErrorWebhookEvent::Type::TaggedSymbol + type: Symbol } ) end @@ -702,32 +697,6 @@ module Imagekit def to_hash end end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::VideoTransformationErrorWebhookEvent::Type) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - VIDEO_TRANSFORMATION_ERROR = - T.let( - :"video.transformation.error", - Imagekit::VideoTransformationErrorWebhookEvent::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Type::TaggedSymbol - ] - ) - end - def self.values - end - end end end end diff --git a/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi b/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi index a98a2c94..406bcf19 100644 --- a/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi @@ -39,11 +39,7 @@ module Imagekit end attr_writer :request - sig do - returns( - Imagekit::VideoTransformationReadyWebhookEvent::Type::TaggedSymbol - ) - end + sig { returns(Symbol) } attr_accessor :type sig do @@ -68,9 +64,9 @@ module Imagekit data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash, request: Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash, - type: Imagekit::VideoTransformationReadyWebhookEvent::Type::OrSymbol, timings: - Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash + Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash, + type: Symbol ).returns(T.attached_class) end def self.new( @@ -79,8 +75,8 @@ module Imagekit created_at:, data:, request:, - type:, - timings: nil + timings: nil, + type: :"video.transformation.ready" ) end @@ -91,8 +87,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationReadyWebhookEvent::Data, request: Imagekit::VideoTransformationReadyWebhookEvent::Request, - type: - Imagekit::VideoTransformationReadyWebhookEvent::Type::TaggedSymbol, + type: Symbol, timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings } ) @@ -744,32 +739,6 @@ module Imagekit end end - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::VideoTransformationReadyWebhookEvent::Type) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - VIDEO_TRANSFORMATION_READY = - T.let( - :"video.transformation.ready", - Imagekit::VideoTransformationReadyWebhookEvent::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - class Timings < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/sig/imagekit/models/accounts/origin_create_response.rbs b/sig/imagekit/models/accounts/origin_create_response.rbs index 9e692c0b..a0d34926 100644 --- a/sig/imagekit/models/accounts/origin_create_response.rbs +++ b/sig/imagekit/models/accounts/origin_create_response.rbs @@ -21,7 +21,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, + type: :S3, base_url_for_canonical_header: String } @@ -34,7 +34,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_ + attr_accessor type: :S3 attr_reader base_url_for_canonical_header: String? @@ -48,8 +48,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :S3 ) -> void def to_hash: -> { @@ -58,19 +58,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginCreateResponse::S3::type_, + type: :S3, base_url_for_canonical_header: String } - - type type_ = :S3 - - module Type - extend Imagekit::Internal::Type::Enum - - S3: :S3 - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::S3::type_] - end end type s3_compatible = @@ -82,7 +72,7 @@ module Imagekit name: String, prefix: String, :s3_force_path_style => bool, - type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, + type: :S3_COMPATIBLE, base_url_for_canonical_header: String } @@ -99,7 +89,7 @@ module Imagekit attr_accessor s3_force_path_style: bool - attr_accessor type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_ + attr_accessor type: :S3_COMPATIBLE attr_reader base_url_for_canonical_header: String? @@ -115,8 +105,8 @@ module Imagekit name: String, prefix: String, s3_force_path_style: bool, - type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { @@ -127,19 +117,9 @@ module Imagekit name: String, prefix: String, :s3_force_path_style => bool, - type: Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_, + type: :S3_COMPATIBLE, base_url_for_canonical_header: String } - - type type_ = :S3_COMPATIBLE - - module Type - extend Imagekit::Internal::Type::Enum - - S3_COMPATIBLE: :S3_COMPATIBLE - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible::type_] - end end type cloudinary_backup = diff --git a/sig/imagekit/models/accounts/origin_get_response.rbs b/sig/imagekit/models/accounts/origin_get_response.rbs index 53dda258..df065c46 100644 --- a/sig/imagekit/models/accounts/origin_get_response.rbs +++ b/sig/imagekit/models/accounts/origin_get_response.rbs @@ -21,7 +21,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, + type: :S3, base_url_for_canonical_header: String } @@ -34,7 +34,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_ + attr_accessor type: :S3 attr_reader base_url_for_canonical_header: String? @@ -48,8 +48,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :S3 ) -> void def to_hash: -> { @@ -58,19 +58,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginGetResponse::S3::type_, + type: :S3, base_url_for_canonical_header: String } - - type type_ = :S3 - - module Type - extend Imagekit::Internal::Type::Enum - - S3: :S3 - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::S3::type_] - end end type s3_compatible = @@ -82,7 +72,7 @@ module Imagekit name: String, prefix: String, :s3_force_path_style => bool, - type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, + type: :S3_COMPATIBLE, base_url_for_canonical_header: String } @@ -99,7 +89,7 @@ module Imagekit attr_accessor s3_force_path_style: bool - attr_accessor type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_ + attr_accessor type: :S3_COMPATIBLE attr_reader base_url_for_canonical_header: String? @@ -115,8 +105,8 @@ module Imagekit name: String, prefix: String, s3_force_path_style: bool, - type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { @@ -127,19 +117,9 @@ module Imagekit name: String, prefix: String, :s3_force_path_style => bool, - type: Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_, + type: :S3_COMPATIBLE, base_url_for_canonical_header: String } - - type type_ = :S3_COMPATIBLE - - module Type - extend Imagekit::Internal::Type::Enum - - S3_COMPATIBLE: :S3_COMPATIBLE - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginGetResponse::S3Compatible::type_] - end end type cloudinary_backup = diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index 8bd9e105..8bff5606 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -21,7 +21,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, + type: :S3, base_url_for_canonical_header: String } @@ -34,7 +34,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_ + attr_accessor type: :S3 attr_reader base_url_for_canonical_header: String? @@ -48,8 +48,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :S3 ) -> void def to_hash: -> { @@ -58,19 +58,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginListResponseItem::S3::type_, + type: :S3, base_url_for_canonical_header: String } - - type type_ = :S3 - - module Type - extend Imagekit::Internal::Type::Enum - - S3: :S3 - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::S3::type_] - end end type s3_compatible = @@ -82,7 +72,7 @@ module Imagekit name: String, prefix: String, :s3_force_path_style => bool, - type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, + type: :S3_COMPATIBLE, base_url_for_canonical_header: String } @@ -99,7 +89,7 @@ module Imagekit attr_accessor s3_force_path_style: bool - attr_accessor type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_ + attr_accessor type: :S3_COMPATIBLE attr_reader base_url_for_canonical_header: String? @@ -115,8 +105,8 @@ module Imagekit name: String, prefix: String, s3_force_path_style: bool, - type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { @@ -127,19 +117,9 @@ module Imagekit name: String, prefix: String, :s3_force_path_style => bool, - type: Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_, + type: :S3_COMPATIBLE, base_url_for_canonical_header: String } - - type type_ = :S3_COMPATIBLE - - module Type - extend Imagekit::Internal::Type::Enum - - S3_COMPATIBLE: :S3_COMPATIBLE - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible::type_] - end end type cloudinary_backup = diff --git a/sig/imagekit/models/accounts/origin_update_response.rbs b/sig/imagekit/models/accounts/origin_update_response.rbs index 08e062da..4a911ecc 100644 --- a/sig/imagekit/models/accounts/origin_update_response.rbs +++ b/sig/imagekit/models/accounts/origin_update_response.rbs @@ -21,7 +21,7 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, + type: :S3, base_url_for_canonical_header: String } @@ -34,7 +34,7 @@ module Imagekit attr_accessor prefix: String - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_ + attr_accessor type: :S3 attr_reader base_url_for_canonical_header: String? @@ -48,8 +48,8 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :S3 ) -> void def to_hash: -> { @@ -58,19 +58,9 @@ module Imagekit include_canonical_header: bool, name: String, prefix: String, - type: Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_, + type: :S3, base_url_for_canonical_header: String } - - type type_ = :S3 - - module Type - extend Imagekit::Internal::Type::Enum - - S3: :S3 - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::S3::type_] - end end type s3_compatible = @@ -82,7 +72,7 @@ module Imagekit name: String, prefix: String, :s3_force_path_style => bool, - type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, + type: :S3_COMPATIBLE, base_url_for_canonical_header: String } @@ -99,7 +89,7 @@ module Imagekit attr_accessor s3_force_path_style: bool - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_ + attr_accessor type: :S3_COMPATIBLE attr_reader base_url_for_canonical_header: String? @@ -115,8 +105,8 @@ module Imagekit name: String, prefix: String, s3_force_path_style: bool, - type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, - ?base_url_for_canonical_header: String + ?base_url_for_canonical_header: String, + ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { @@ -127,19 +117,9 @@ module Imagekit name: String, prefix: String, :s3_force_path_style => bool, - type: Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_, + type: :S3_COMPATIBLE, base_url_for_canonical_header: String } - - type type_ = :S3_COMPATIBLE - - module Type - extend Imagekit::Internal::Type::Enum - - S3_COMPATIBLE: :S3_COMPATIBLE - - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible::type_] - end end type cloudinary_backup = diff --git a/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs b/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs index de9ee101..2e9ad468 100644 --- a/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs @@ -6,7 +6,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_ + type: :"video.transformation.accepted" } class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel @@ -18,14 +18,14 @@ module Imagekit attr_accessor request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request - attr_accessor type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_ + attr_accessor type: :"video.transformation.accepted" def initialize: ( id: String, created_at: Time, data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_ + ?type: :"video.transformation.accepted" ) -> void def to_hash: -> { @@ -33,7 +33,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_ + type: :"video.transformation.accepted" } type data = @@ -246,16 +246,6 @@ module Imagekit user_agent: String } end - - type type_ = :"video.transformation.accepted" - - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION_ACCEPTED: :"video.transformation.accepted" - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::type_] - end end end end diff --git a/sig/imagekit/models/video_transformation_error_webhook_event.rbs b/sig/imagekit/models/video_transformation_error_webhook_event.rbs index 48939423..4eada151 100644 --- a/sig/imagekit/models/video_transformation_error_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_error_webhook_event.rbs @@ -6,7 +6,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationErrorWebhookEvent::Data, request: Imagekit::VideoTransformationErrorWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::type_ + type: :"video.transformation.error" } class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel @@ -18,14 +18,14 @@ module Imagekit attr_accessor request: Imagekit::VideoTransformationErrorWebhookEvent::Request - attr_accessor type: Imagekit::Models::VideoTransformationErrorWebhookEvent::type_ + attr_accessor type: :"video.transformation.error" def initialize: ( id: String, created_at: Time, data: Imagekit::VideoTransformationErrorWebhookEvent::Data, request: Imagekit::VideoTransformationErrorWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::type_ + ?type: :"video.transformation.error" ) -> void def to_hash: -> { @@ -33,7 +33,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationErrorWebhookEvent::Data, request: Imagekit::VideoTransformationErrorWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::type_ + type: :"video.transformation.error" } type data = @@ -285,16 +285,6 @@ module Imagekit user_agent: String } end - - type type_ = :"video.transformation.error" - - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION_ERROR: :"video.transformation.error" - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::type_] - end end end end diff --git a/sig/imagekit/models/video_transformation_ready_webhook_event.rbs b/sig/imagekit/models/video_transformation_ready_webhook_event.rbs index 7cc3b772..1a6a7a2c 100644 --- a/sig/imagekit/models/video_transformation_ready_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_ready_webhook_event.rbs @@ -6,7 +6,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationReadyWebhookEvent::Data, request: Imagekit::VideoTransformationReadyWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::type_, + type: :"video.transformation.ready", timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings } @@ -19,7 +19,7 @@ module Imagekit attr_accessor request: Imagekit::VideoTransformationReadyWebhookEvent::Request - attr_accessor type: Imagekit::Models::VideoTransformationReadyWebhookEvent::type_ + attr_accessor type: :"video.transformation.ready" attr_reader timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings? @@ -32,8 +32,8 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationReadyWebhookEvent::Data, request: Imagekit::VideoTransformationReadyWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::type_, - ?timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + ?timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings, + ?type: :"video.transformation.ready" ) -> void def to_hash: -> { @@ -41,7 +41,7 @@ module Imagekit created_at: Time, data: Imagekit::VideoTransformationReadyWebhookEvent::Data, request: Imagekit::VideoTransformationReadyWebhookEvent::Request, - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::type_, + type: :"video.transformation.ready", timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings } @@ -323,16 +323,6 @@ module Imagekit } end - type type_ = :"video.transformation.ready" - - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION_READY: :"video.transformation.ready" - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::type_] - end - type timings = { download_duration: Integer, encoding_duration: Integer } class Timings < Imagekit::Internal::Type::BaseModel From 168ca0045855a917bd2de2b735f9bec7699d023e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 10:58:58 +0000 Subject: [PATCH 020/178] feat(api): manual updates --- .stats.yml | 2 +- README.md | 40 ++++++++++++++++++++++++++++++++-------- 2 files changed, 33 insertions(+), 9 deletions(-) diff --git a/.stats.yml b/.stats.yml index fedb1ee0..3ae65fac 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-cb2369e849b98127ee6a2cbd01d928e4546d29c1a0a8e64e9b46f90189c1a992.yml openapi_spec_hash: f8e732e88daf7c4bfbeb2bd2cdba2cec -config_hash: b75c4e4432c2d0650589863f8336849b +config_hash: c9b1142a72b93ad4d66f0433dca1392e diff --git a/README.md b/README.md index 35b67f2e..6462d0fe 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,10 @@ image_kit = Imagekit::Client.new( password: ENV["ORG_MY_PASSWORD_TOKEN"] # This is the default and can be omitted ) -response = image_kit.files.upload(file_name: "fileName") +response = image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) puts(response.videoCodec) ``` @@ -62,7 +65,10 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload(file_name: "fileName") + file = image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" + ) rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -105,7 +111,11 @@ image_kit = Imagekit::Client.new( ) # Or, configure per-request: -image_kit.files.upload(file_name: "fileName", request_options: {max_retries: 5}) +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg", + request_options: {max_retries: 5} +) ``` ### Timeouts @@ -119,7 +129,11 @@ image_kit = Imagekit::Client.new( ) # Or, configure per-request: -image_kit.files.upload(file_name: "fileName", request_options: {timeout: 5}) +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg", + request_options: {timeout: 5} +) ``` On timeout, `Imagekit::Errors::APITimeoutError` is raised. @@ -151,7 +165,8 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file_name: "fileName", + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg", request_options: { extra_query: {my_query_parameter: value}, extra_body: {my_body_parameter: value}, @@ -197,17 +212,26 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload(file_name: "fileName") +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload(file_name: "fileName") +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new(file_name: "fileName") +params = Imagekit::FileUploadParams.new( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) image_kit.files.upload(**params) ``` From 51f77b27884995182d7790324b219cf711fc764a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 11:19:03 +0000 Subject: [PATCH 021/178] feat(api): manual updates --- .stats.yml | 4 +-- .../custom_metadata_field_create_params.rb | 33 ++++++++++++++----- .../custom_metadata_field_create_response.rb | 33 ++++++++++++++----- .../custom_metadata_field_list_response.rb | 33 ++++++++++++++----- .../custom_metadata_field_update_params.rb | 33 ++++++++++++++----- .../custom_metadata_field_update_response.rb | 33 ++++++++++++++----- .../custom_metadata_field_create_params.rbi | 32 +++++++++++++----- .../custom_metadata_field_create_response.rbi | 32 +++++++++++++----- .../custom_metadata_field_list_response.rbi | 32 +++++++++++++----- .../custom_metadata_field_update_params.rbi | 32 +++++++++++++----- .../custom_metadata_field_update_response.rbi | 32 +++++++++++++----- .../custom_metadata_field_create_params.rbs | 22 ++++++++----- .../custom_metadata_field_create_response.rbs | 22 ++++++++----- .../custom_metadata_field_list_response.rbs | 22 ++++++++----- .../custom_metadata_field_update_params.rbs | 22 ++++++++----- .../custom_metadata_field_update_response.rbs | 22 ++++++++----- 16 files changed, 317 insertions(+), 122 deletions(-) diff --git a/.stats.yml b/.stats.yml index 3ae65fac..fe627405 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-cb2369e849b98127ee6a2cbd01d928e4546d29c1a0a8e64e9b46f90189c1a992.yml -openapi_spec_hash: f8e732e88daf7c4bfbeb2bd2cdba2cec +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-cb74df1af0b7cdd4f66573d2d002f003b74702172ddd2c8495c465a7706c4d66.yml +openapi_spec_hash: 9a1fb60cda92b3e693e8c0f0fde0508a config_hash: c9b1142a72b93ad4d66f0433dca1392e diff --git a/lib/imagekit/models/custom_metadata_field_create_params.rb b/lib/imagekit/models/custom_metadata_field_create_params.rb index 4d9dc5f4..b7147b81 100644 --- a/lib/imagekit/models/custom_metadata_field_create_params.rb +++ b/lib/imagekit/models/custom_metadata_field_create_params.rb @@ -156,22 +156,39 @@ module Type module DefaultValue extend Imagekit::Internal::Type::Union - variant String + # Primitive JSON scalar. + variant union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember0 } - variant Float + variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalar2DArray } - variant Imagekit::Internal::Type::Boolean + # Primitive JSON scalar. + module UnionMember0 + extend Imagekit::Internal::Type::Union - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3Array } + # Primitive JSON scalar. + variant String + + # Primitive JSON scalar. + variant Float + + # Primitive JSON scalar. + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end - module UnionMember3 + # Primitive JSON scalar. + module JsonScalarArray extend Imagekit::Internal::Type::Union + # Primitive JSON scalar. variant String + # Primitive JSON scalar. variant Float + # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -182,9 +199,9 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = + JsonScalar2DArray = Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3 + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalarArray }] end diff --git a/lib/imagekit/models/custom_metadata_field_create_response.rb b/lib/imagekit/models/custom_metadata_field_create_response.rb index 9c4703af..99ae7578 100644 --- a/lib/imagekit/models/custom_metadata_field_create_response.rb +++ b/lib/imagekit/models/custom_metadata_field_create_response.rb @@ -155,22 +155,39 @@ module Type module DefaultValue extend Imagekit::Internal::Type::Union - variant String + # Primitive JSON scalar. + variant union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember0 } - variant Float + variant -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalar2DArray } - variant Imagekit::Internal::Type::Boolean + # Primitive JSON scalar. + module UnionMember0 + extend Imagekit::Internal::Type::Union - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3Array } + # Primitive JSON scalar. + variant String + + # Primitive JSON scalar. + variant Float + + # Primitive JSON scalar. + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end - module UnionMember3 + # Primitive JSON scalar. + module JsonScalarArray extend Imagekit::Internal::Type::Union + # Primitive JSON scalar. variant String + # Primitive JSON scalar. variant Float + # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -181,8 +198,8 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3 }] + JsonScalar2DArray = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalarArray }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/lib/imagekit/models/custom_metadata_field_list_response.rb b/lib/imagekit/models/custom_metadata_field_list_response.rb index 68723e84..4252e487 100644 --- a/lib/imagekit/models/custom_metadata_field_list_response.rb +++ b/lib/imagekit/models/custom_metadata_field_list_response.rb @@ -155,22 +155,39 @@ module Type module DefaultValue extend Imagekit::Internal::Type::Union - variant String + # Primitive JSON scalar. + variant union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember0 } - variant Float + variant -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalar2DArray } - variant Imagekit::Internal::Type::Boolean + # Primitive JSON scalar. + module UnionMember0 + extend Imagekit::Internal::Type::Union - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3Array } + # Primitive JSON scalar. + variant String + + # Primitive JSON scalar. + variant Float + + # Primitive JSON scalar. + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end - module UnionMember3 + # Primitive JSON scalar. + module JsonScalarArray extend Imagekit::Internal::Type::Union + # Primitive JSON scalar. variant String + # Primitive JSON scalar. variant Float + # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -181,8 +198,8 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3 }] + JsonScalar2DArray = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalarArray }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/lib/imagekit/models/custom_metadata_field_update_params.rb b/lib/imagekit/models/custom_metadata_field_update_params.rb index 25a71fc3..81f8b256 100644 --- a/lib/imagekit/models/custom_metadata_field_update_params.rb +++ b/lib/imagekit/models/custom_metadata_field_update_params.rb @@ -130,22 +130,39 @@ class Schema < Imagekit::Internal::Type::BaseModel module DefaultValue extend Imagekit::Internal::Type::Union - variant String + # Primitive JSON scalar. + variant union: -> { Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember0 } - variant Float + variant -> { Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalar2DArray } - variant Imagekit::Internal::Type::Boolean + # Primitive JSON scalar. + module UnionMember0 + extend Imagekit::Internal::Type::Union - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3Array } + # Primitive JSON scalar. + variant String + + # Primitive JSON scalar. + variant Float + + # Primitive JSON scalar. + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end - module UnionMember3 + # Primitive JSON scalar. + module JsonScalarArray extend Imagekit::Internal::Type::Union + # Primitive JSON scalar. variant String + # Primitive JSON scalar. variant Float + # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -156,9 +173,9 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = + JsonScalar2DArray = Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3 + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalarArray }] end diff --git a/lib/imagekit/models/custom_metadata_field_update_response.rb b/lib/imagekit/models/custom_metadata_field_update_response.rb index 3d7c18ee..3107f42a 100644 --- a/lib/imagekit/models/custom_metadata_field_update_response.rb +++ b/lib/imagekit/models/custom_metadata_field_update_response.rb @@ -155,22 +155,39 @@ module Type module DefaultValue extend Imagekit::Internal::Type::Union - variant String + # Primitive JSON scalar. + variant union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember0 } - variant Float + variant -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalar2DArray } - variant Imagekit::Internal::Type::Boolean + # Primitive JSON scalar. + module UnionMember0 + extend Imagekit::Internal::Type::Union - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3Array } + # Primitive JSON scalar. + variant String + + # Primitive JSON scalar. + variant Float + + # Primitive JSON scalar. + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end - module UnionMember3 + # Primitive JSON scalar. + module JsonScalarArray extend Imagekit::Internal::Type::Union + # Primitive JSON scalar. variant String + # Primitive JSON scalar. variant Float + # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -181,8 +198,8 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3 }] + JsonScalar2DArray = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalarArray }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/rbi/imagekit/models/custom_metadata_field_create_params.rbi b/rbi/imagekit/models/custom_metadata_field_create_params.rbi index f52db847..343e4328 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_params.rbi @@ -339,16 +339,15 @@ module Imagekit Variants = T.type_alias do T.any( - String, - Float, - T::Boolean, + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember0::Variants, T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3::Variants + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalarArray::Variants ] ) end - module UnionMember3 + # Primitive JSON scalar. + module UnionMember0 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -356,7 +355,24 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3::Variants + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember0::Variants + ] + ) + end + def self.variants + end + end + + # Primitive JSON scalar. + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalarArray::Variants ] ) end @@ -374,11 +390,11 @@ module Imagekit def self.variants end - UnionMember3Array = + JsonScalar2DArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3 + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalarArray ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_create_response.rbi b/rbi/imagekit/models/custom_metadata_field_create_response.rbi index 73022a7e..46a983b1 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_response.rbi @@ -334,16 +334,15 @@ module Imagekit Variants = T.type_alias do T.any( - String, - Float, - T::Boolean, + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember0::Variants, T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalarArray::Variants ] ) end - module UnionMember3 + # Primitive JSON scalar. + module UnionMember0 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -351,7 +350,24 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember0::Variants + ] + ) + end + def self.variants + end + end + + # Primitive JSON scalar. + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalarArray::Variants ] ) end @@ -369,11 +385,11 @@ module Imagekit def self.variants end - UnionMember3Array = + JsonScalar2DArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3 + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalarArray ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_list_response.rbi b/rbi/imagekit/models/custom_metadata_field_list_response.rbi index 04bcfa37..0ada430d 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_list_response.rbi @@ -335,16 +335,15 @@ module Imagekit Variants = T.type_alias do T.any( - String, - Float, - T::Boolean, + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember0::Variants, T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalarArray::Variants ] ) end - module UnionMember3 + # Primitive JSON scalar. + module UnionMember0 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -352,7 +351,24 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember0::Variants + ] + ) + end + def self.variants + end + end + + # Primitive JSON scalar. + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalarArray::Variants ] ) end @@ -370,11 +386,11 @@ module Imagekit def self.variants end - UnionMember3Array = + JsonScalar2DArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3 + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalarArray ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_update_params.rbi b/rbi/imagekit/models/custom_metadata_field_update_params.rbi index 72ea1598..81b51f9c 100644 --- a/rbi/imagekit/models/custom_metadata_field_update_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_update_params.rbi @@ -272,16 +272,15 @@ module Imagekit Variants = T.type_alias do T.any( - String, - Float, - T::Boolean, + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember0::Variants, T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3::Variants + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalarArray::Variants ] ) end - module UnionMember3 + # Primitive JSON scalar. + module UnionMember0 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -289,7 +288,24 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3::Variants + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember0::Variants + ] + ) + end + def self.variants + end + end + + # Primitive JSON scalar. + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalarArray::Variants ] ) end @@ -307,11 +323,11 @@ module Imagekit def self.variants end - UnionMember3Array = + JsonScalar2DArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3 + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalarArray ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_update_response.rbi b/rbi/imagekit/models/custom_metadata_field_update_response.rbi index 6ecfa020..cb2d5d3a 100644 --- a/rbi/imagekit/models/custom_metadata_field_update_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_update_response.rbi @@ -334,16 +334,15 @@ module Imagekit Variants = T.type_alias do T.any( - String, - Float, - T::Boolean, + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember0::Variants, T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalarArray::Variants ] ) end - module UnionMember3 + # Primitive JSON scalar. + module UnionMember0 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -351,7 +350,24 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember0::Variants + ] + ) + end + def self.variants + end + end + + # Primitive JSON scalar. + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalarArray::Variants ] ) end @@ -369,11 +385,11 @@ module Imagekit def self.variants end - UnionMember3Array = + JsonScalar2DArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3 + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalarArray ], Imagekit::Internal::Type::Converter ) diff --git a/sig/imagekit/models/custom_metadata_field_create_params.rbs b/sig/imagekit/models/custom_metadata_field_create_params.rbs index 667751cd..80601aab 100644 --- a/sig/imagekit/models/custom_metadata_field_create_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_params.rbs @@ -129,25 +129,31 @@ module Imagekit end type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member3] + Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member0 + | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::json_scalar_array] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type union_member0 = String | Float | bool - module UnionMember3 + module UnionMember0 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member0] + end + + type json_scalar_array = String | Float | bool + + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::json_scalar_array] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + JsonScalar2DArray: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_create_response.rbs b/sig/imagekit/models/custom_metadata_field_create_response.rbs index dc03ab3c..c9b5e898 100644 --- a/sig/imagekit/models/custom_metadata_field_create_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_response.rbs @@ -128,25 +128,31 @@ module Imagekit end type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member3] + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member0 + | ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::json_scalar_array] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type union_member0 = String | Float | bool - module UnionMember3 + module UnionMember0 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member0] + end + + type json_scalar_array = String | Float | bool + + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::json_scalar_array] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + JsonScalar2DArray: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_list_response.rbs b/sig/imagekit/models/custom_metadata_field_list_response.rbs index 9ff08639..05874de6 100644 --- a/sig/imagekit/models/custom_metadata_field_list_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_list_response.rbs @@ -128,25 +128,31 @@ module Imagekit end type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member3] + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member0 + | ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::json_scalar_array] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type union_member0 = String | Float | bool - module UnionMember3 + module UnionMember0 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member0] + end + + type json_scalar_array = String | Float | bool + + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::json_scalar_array] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + JsonScalar2DArray: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_update_params.rbs b/sig/imagekit/models/custom_metadata_field_update_params.rbs index d6f1b888..60afee2b 100644 --- a/sig/imagekit/models/custom_metadata_field_update_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_update_params.rbs @@ -102,25 +102,31 @@ module Imagekit } type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member3] + Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member0 + | ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::json_scalar_array] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type union_member0 = String | Float | bool - module UnionMember3 + module UnionMember0 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member0] + end + + type json_scalar_array = String | Float | bool + + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::json_scalar_array] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + JsonScalar2DArray: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_update_response.rbs b/sig/imagekit/models/custom_metadata_field_update_response.rbs index 5d806344..886f771b 100644 --- a/sig/imagekit/models/custom_metadata_field_update_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_update_response.rbs @@ -128,25 +128,31 @@ module Imagekit end type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member3] + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member0 + | ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::json_scalar_array] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type union_member0 = String | Float | bool - module UnionMember3 + module UnionMember0 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member0] + end + + type json_scalar_array = String | Float | bool + + module JsonScalarArray + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::json_scalar_array] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + JsonScalar2DArray: Imagekit::Internal::Type::Converter end type max_value = String | Float From f0c449fca9297209897c2370ee9b88a958d05e02 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 11:24:11 +0000 Subject: [PATCH 022/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index fe627405..134be349 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-cb74df1af0b7cdd4f66573d2d002f003b74702172ddd2c8495c465a7706c4d66.yml -openapi_spec_hash: 9a1fb60cda92b3e693e8c0f0fde0508a +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-6db4fc859c70677af91f711d10e420694e96273880b0dc7931be2c7cf7a68586.yml +openapi_spec_hash: d4060e780214d95ccd90306aa8f2e28b config_hash: c9b1142a72b93ad4d66f0433dca1392e From 742557995f217e211d343c9f649d16ac7e5f088f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 11:31:05 +0000 Subject: [PATCH 023/178] feat(api): manual updates --- .stats.yml | 4 +-- .../custom_metadata_field_create_params.rb | 33 +++++-------------- .../custom_metadata_field_create_response.rb | 33 +++++-------------- .../custom_metadata_field_list_response.rb | 33 +++++-------------- .../custom_metadata_field_update_params.rb | 33 +++++-------------- .../custom_metadata_field_update_response.rb | 33 +++++-------------- .../custom_metadata_field_create_params.rbi | 32 +++++------------- .../custom_metadata_field_create_response.rbi | 32 +++++------------- .../custom_metadata_field_list_response.rbi | 32 +++++------------- .../custom_metadata_field_update_params.rbi | 32 +++++------------- .../custom_metadata_field_update_response.rbi | 32 +++++------------- .../custom_metadata_field_create_params.rbs | 22 +++++-------- .../custom_metadata_field_create_response.rbs | 22 +++++-------- .../custom_metadata_field_list_response.rbs | 22 +++++-------- .../custom_metadata_field_update_params.rbs | 22 +++++-------- .../custom_metadata_field_update_response.rbs | 22 +++++-------- 16 files changed, 122 insertions(+), 317 deletions(-) diff --git a/.stats.yml b/.stats.yml index 134be349..3ae65fac 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-6db4fc859c70677af91f711d10e420694e96273880b0dc7931be2c7cf7a68586.yml -openapi_spec_hash: d4060e780214d95ccd90306aa8f2e28b +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-cb2369e849b98127ee6a2cbd01d928e4546d29c1a0a8e64e9b46f90189c1a992.yml +openapi_spec_hash: f8e732e88daf7c4bfbeb2bd2cdba2cec config_hash: c9b1142a72b93ad4d66f0433dca1392e diff --git a/lib/imagekit/models/custom_metadata_field_create_params.rb b/lib/imagekit/models/custom_metadata_field_create_params.rb index b7147b81..4d9dc5f4 100644 --- a/lib/imagekit/models/custom_metadata_field_create_params.rb +++ b/lib/imagekit/models/custom_metadata_field_create_params.rb @@ -156,39 +156,22 @@ module Type module DefaultValue extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. - variant union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember0 } - - variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalar2DArray } - - # Primitive JSON scalar. - module UnionMember0 - extend Imagekit::Internal::Type::Union - - # Primitive JSON scalar. - variant String + variant String - # Primitive JSON scalar. - variant Float + variant Float - # Primitive JSON scalar. - variant Imagekit::Internal::Type::Boolean + variant Imagekit::Internal::Type::Boolean - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3Array } - # Primitive JSON scalar. - module JsonScalarArray + module UnionMember3 extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. variant String - # Primitive JSON scalar. variant Float - # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -199,9 +182,9 @@ module JsonScalarArray # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - JsonScalar2DArray = + UnionMember3Array = Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalarArray + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3 }] end diff --git a/lib/imagekit/models/custom_metadata_field_create_response.rb b/lib/imagekit/models/custom_metadata_field_create_response.rb index 99ae7578..9c4703af 100644 --- a/lib/imagekit/models/custom_metadata_field_create_response.rb +++ b/lib/imagekit/models/custom_metadata_field_create_response.rb @@ -155,39 +155,22 @@ module Type module DefaultValue extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. - variant union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember0 } - - variant -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalar2DArray } - - # Primitive JSON scalar. - module UnionMember0 - extend Imagekit::Internal::Type::Union - - # Primitive JSON scalar. - variant String + variant String - # Primitive JSON scalar. - variant Float + variant Float - # Primitive JSON scalar. - variant Imagekit::Internal::Type::Boolean + variant Imagekit::Internal::Type::Boolean - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3Array } - # Primitive JSON scalar. - module JsonScalarArray + module UnionMember3 extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. variant String - # Primitive JSON scalar. variant Float - # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -198,8 +181,8 @@ module JsonScalarArray # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - JsonScalar2DArray = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalarArray }] + UnionMember3Array = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3 }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/lib/imagekit/models/custom_metadata_field_list_response.rb b/lib/imagekit/models/custom_metadata_field_list_response.rb index 4252e487..68723e84 100644 --- a/lib/imagekit/models/custom_metadata_field_list_response.rb +++ b/lib/imagekit/models/custom_metadata_field_list_response.rb @@ -155,39 +155,22 @@ module Type module DefaultValue extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. - variant union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember0 } - - variant -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalar2DArray } - - # Primitive JSON scalar. - module UnionMember0 - extend Imagekit::Internal::Type::Union - - # Primitive JSON scalar. - variant String + variant String - # Primitive JSON scalar. - variant Float + variant Float - # Primitive JSON scalar. - variant Imagekit::Internal::Type::Boolean + variant Imagekit::Internal::Type::Boolean - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3Array } - # Primitive JSON scalar. - module JsonScalarArray + module UnionMember3 extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. variant String - # Primitive JSON scalar. variant Float - # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -198,8 +181,8 @@ module JsonScalarArray # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - JsonScalar2DArray = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalarArray }] + UnionMember3Array = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3 }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/lib/imagekit/models/custom_metadata_field_update_params.rb b/lib/imagekit/models/custom_metadata_field_update_params.rb index 81f8b256..25a71fc3 100644 --- a/lib/imagekit/models/custom_metadata_field_update_params.rb +++ b/lib/imagekit/models/custom_metadata_field_update_params.rb @@ -130,39 +130,22 @@ class Schema < Imagekit::Internal::Type::BaseModel module DefaultValue extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. - variant union: -> { Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember0 } - - variant -> { Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalar2DArray } - - # Primitive JSON scalar. - module UnionMember0 - extend Imagekit::Internal::Type::Union - - # Primitive JSON scalar. - variant String + variant String - # Primitive JSON scalar. - variant Float + variant Float - # Primitive JSON scalar. - variant Imagekit::Internal::Type::Boolean + variant Imagekit::Internal::Type::Boolean - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3Array } - # Primitive JSON scalar. - module JsonScalarArray + module UnionMember3 extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. variant String - # Primitive JSON scalar. variant Float - # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -173,9 +156,9 @@ module JsonScalarArray # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - JsonScalar2DArray = + UnionMember3Array = Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalarArray + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3 }] end diff --git a/lib/imagekit/models/custom_metadata_field_update_response.rb b/lib/imagekit/models/custom_metadata_field_update_response.rb index 3107f42a..3d7c18ee 100644 --- a/lib/imagekit/models/custom_metadata_field_update_response.rb +++ b/lib/imagekit/models/custom_metadata_field_update_response.rb @@ -155,39 +155,22 @@ module Type module DefaultValue extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. - variant union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember0 } - - variant -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalar2DArray } - - # Primitive JSON scalar. - module UnionMember0 - extend Imagekit::Internal::Type::Union - - # Primitive JSON scalar. - variant String + variant String - # Primitive JSON scalar. - variant Float + variant Float - # Primitive JSON scalar. - variant Imagekit::Internal::Type::Boolean + variant Imagekit::Internal::Type::Boolean - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3Array } - # Primitive JSON scalar. - module JsonScalarArray + module UnionMember3 extend Imagekit::Internal::Type::Union - # Primitive JSON scalar. variant String - # Primitive JSON scalar. variant Float - # Primitive JSON scalar. variant Imagekit::Internal::Type::Boolean # @!method self.variants @@ -198,8 +181,8 @@ module JsonScalarArray # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - JsonScalar2DArray = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalarArray }] + UnionMember3Array = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3 }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/rbi/imagekit/models/custom_metadata_field_create_params.rbi b/rbi/imagekit/models/custom_metadata_field_create_params.rbi index 343e4328..f52db847 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_params.rbi @@ -339,15 +339,16 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember0::Variants, + String, + Float, + T::Boolean, T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3::Variants ] ) end - # Primitive JSON scalar. - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -355,24 +356,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember0::Variants - ] - ) - end - def self.variants - end - end - - # Primitive JSON scalar. - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3::Variants ] ) end @@ -390,11 +374,11 @@ module Imagekit def self.variants end - JsonScalar2DArray = + UnionMember3Array = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::JsonScalarArray + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3 ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_create_response.rbi b/rbi/imagekit/models/custom_metadata_field_create_response.rbi index 46a983b1..73022a7e 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_response.rbi @@ -334,15 +334,16 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember0::Variants, + String, + Float, + T::Boolean, T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3::Variants ] ) end - # Primitive JSON scalar. - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -350,24 +351,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember0::Variants - ] - ) - end - def self.variants - end - end - - # Primitive JSON scalar. - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3::Variants ] ) end @@ -385,11 +369,11 @@ module Imagekit def self.variants end - JsonScalar2DArray = + UnionMember3Array = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::JsonScalarArray + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3 ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_list_response.rbi b/rbi/imagekit/models/custom_metadata_field_list_response.rbi index 0ada430d..04bcfa37 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_list_response.rbi @@ -335,15 +335,16 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember0::Variants, + String, + Float, + T::Boolean, T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3::Variants ] ) end - # Primitive JSON scalar. - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -351,24 +352,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember0::Variants - ] - ) - end - def self.variants - end - end - - # Primitive JSON scalar. - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3::Variants ] ) end @@ -386,11 +370,11 @@ module Imagekit def self.variants end - JsonScalar2DArray = + UnionMember3Array = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::JsonScalarArray + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3 ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_update_params.rbi b/rbi/imagekit/models/custom_metadata_field_update_params.rbi index 81b51f9c..72ea1598 100644 --- a/rbi/imagekit/models/custom_metadata_field_update_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_update_params.rbi @@ -272,15 +272,16 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember0::Variants, + String, + Float, + T::Boolean, T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3::Variants ] ) end - # Primitive JSON scalar. - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -288,24 +289,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember0::Variants - ] - ) - end - def self.variants - end - end - - # Primitive JSON scalar. - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3::Variants ] ) end @@ -323,11 +307,11 @@ module Imagekit def self.variants end - JsonScalar2DArray = + UnionMember3Array = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::JsonScalarArray + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3 ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_update_response.rbi b/rbi/imagekit/models/custom_metadata_field_update_response.rbi index cb2d5d3a..6ecfa020 100644 --- a/rbi/imagekit/models/custom_metadata_field_update_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_update_response.rbi @@ -334,15 +334,16 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember0::Variants, + String, + Float, + T::Boolean, T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3::Variants ] ) end - # Primitive JSON scalar. - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -350,24 +351,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember0::Variants - ] - ) - end - def self.variants - end - end - - # Primitive JSON scalar. - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalarArray::Variants + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3::Variants ] ) end @@ -385,11 +369,11 @@ module Imagekit def self.variants end - JsonScalar2DArray = + UnionMember3Array = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::JsonScalarArray + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3 ], Imagekit::Internal::Type::Converter ) diff --git a/sig/imagekit/models/custom_metadata_field_create_params.rbs b/sig/imagekit/models/custom_metadata_field_create_params.rbs index 80601aab..667751cd 100644 --- a/sig/imagekit/models/custom_metadata_field_create_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_params.rbs @@ -129,31 +129,25 @@ module Imagekit end type default_value = - Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member0 - | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::json_scalar_array] + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member3] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member0 = String | Float | bool + type union_member3 = String | Float | bool - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member0] - end - - type json_scalar_array = String | Float | bool - - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::json_scalar_array] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member3] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value] - JsonScalar2DArray: Imagekit::Internal::Type::Converter + UnionMember3Array: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_create_response.rbs b/sig/imagekit/models/custom_metadata_field_create_response.rbs index c9b5e898..dc03ab3c 100644 --- a/sig/imagekit/models/custom_metadata_field_create_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_response.rbs @@ -128,31 +128,25 @@ module Imagekit end type default_value = - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member0 - | ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::json_scalar_array] + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member3] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member0 = String | Float | bool + type union_member3 = String | Float | bool - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member0] - end - - type json_scalar_array = String | Float | bool - - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::json_scalar_array] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member3] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value] - JsonScalar2DArray: Imagekit::Internal::Type::Converter + UnionMember3Array: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_list_response.rbs b/sig/imagekit/models/custom_metadata_field_list_response.rbs index 05874de6..9ff08639 100644 --- a/sig/imagekit/models/custom_metadata_field_list_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_list_response.rbs @@ -128,31 +128,25 @@ module Imagekit end type default_value = - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member0 - | ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::json_scalar_array] + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member3] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member0 = String | Float | bool + type union_member3 = String | Float | bool - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member0] - end - - type json_scalar_array = String | Float | bool - - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::json_scalar_array] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member3] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value] - JsonScalar2DArray: Imagekit::Internal::Type::Converter + UnionMember3Array: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_update_params.rbs b/sig/imagekit/models/custom_metadata_field_update_params.rbs index 60afee2b..d6f1b888 100644 --- a/sig/imagekit/models/custom_metadata_field_update_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_update_params.rbs @@ -102,31 +102,25 @@ module Imagekit } type default_value = - Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member0 - | ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::json_scalar_array] + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member3] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member0 = String | Float | bool + type union_member3 = String | Float | bool - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member0] - end - - type json_scalar_array = String | Float | bool - - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::json_scalar_array] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member3] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value] - JsonScalar2DArray: Imagekit::Internal::Type::Converter + UnionMember3Array: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_update_response.rbs b/sig/imagekit/models/custom_metadata_field_update_response.rbs index 886f771b..5d806344 100644 --- a/sig/imagekit/models/custom_metadata_field_update_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_update_response.rbs @@ -128,31 +128,25 @@ module Imagekit end type default_value = - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member0 - | ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::json_scalar_array] + String + | Float + | bool + | ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member3] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member0 = String | Float | bool + type union_member3 = String | Float | bool - module UnionMember0 + module UnionMember3 extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member0] - end - - type json_scalar_array = String | Float | bool - - module JsonScalarArray - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::json_scalar_array] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member3] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value] - JsonScalar2DArray: Imagekit::Internal::Type::Converter + UnionMember3Array: Imagekit::Internal::Type::Converter end type max_value = String | Float From 33eade3d5b60a8a30fec945ef25490a2611f5110 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 11:34:51 +0000 Subject: [PATCH 024/178] feat(api): manual updates --- .stats.yml | 4 ++-- .../models/custom_metadata_field_create_params.rb | 12 ++++++------ .../models/custom_metadata_field_create_params.rbi | 10 +++++----- .../models/custom_metadata_field_create_params.rbs | 10 +++++----- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.stats.yml b/.stats.yml index 3ae65fac..1bb527b9 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-cb2369e849b98127ee6a2cbd01d928e4546d29c1a0a8e64e9b46f90189c1a992.yml -openapi_spec_hash: f8e732e88daf7c4bfbeb2bd2cdba2cec +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-7da4f48715dfd85e3bbc25086d62dc4959fb6bd1a9c3fd3933cfe0e80f6ae244.yml +openapi_spec_hash: 260d09fbed77316aae394877e5239398 config_hash: c9b1142a72b93ad4d66f0433dca1392e diff --git a/lib/imagekit/models/custom_metadata_field_create_params.rb b/lib/imagekit/models/custom_metadata_field_create_params.rb index 4d9dc5f4..eedb3815 100644 --- a/lib/imagekit/models/custom_metadata_field_create_params.rb +++ b/lib/imagekit/models/custom_metadata_field_create_params.rb @@ -163,9 +163,9 @@ module DefaultValue variant Imagekit::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3Array } + variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeFieldArray } - module UnionMember3 + module ArrayForMultiSelectTypeField extend Imagekit::Internal::Type::Union variant String @@ -182,10 +182,10 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = - Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3 - }] + ArrayForMultiSelectTypeFieldArray = + Imagekit::Internal::Type::ArrayOf[ + union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeField } + ] end # Maximum value of the field. Only set this property if field type is `Date` or diff --git a/rbi/imagekit/models/custom_metadata_field_create_params.rbi b/rbi/imagekit/models/custom_metadata_field_create_params.rbi index f52db847..fea17937 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_params.rbi @@ -343,12 +343,12 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3::Variants + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeField::Variants ] ) end - module UnionMember3 + module ArrayForMultiSelectTypeField extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -356,7 +356,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3::Variants + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeField::Variants ] ) end @@ -374,11 +374,11 @@ module Imagekit def self.variants end - UnionMember3Array = + ArrayForMultiSelectTypeFieldArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::UnionMember3 + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeField ], Imagekit::Internal::Type::Converter ) diff --git a/sig/imagekit/models/custom_metadata_field_create_params.rbs b/sig/imagekit/models/custom_metadata_field_create_params.rbs index 667751cd..86783ab3 100644 --- a/sig/imagekit/models/custom_metadata_field_create_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_params.rbs @@ -132,22 +132,22 @@ module Imagekit String | Float | bool - | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member3] + | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::array_for_multi_select_type_field] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type array_for_multi_select_type_field = String | Float | bool - module UnionMember3 + module ArrayForMultiSelectTypeField extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::array_for_multi_select_type_field] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + ArrayForMultiSelectTypeFieldArray: Imagekit::Internal::Type::Converter end type max_value = String | Float From 375b85086d0e711244a58df18c574ea8efe03a15 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 11:37:33 +0000 Subject: [PATCH 025/178] feat(api): manual updates --- .stats.yml | 4 ++-- .../models/custom_metadata_field_create_params.rb | 12 ++++++------ .../models/custom_metadata_field_create_response.rb | 8 ++++---- .../models/custom_metadata_field_list_response.rb | 8 ++++---- .../models/custom_metadata_field_update_params.rb | 8 ++++---- .../models/custom_metadata_field_update_response.rb | 8 ++++---- .../models/custom_metadata_field_create_params.rbi | 10 +++++----- .../models/custom_metadata_field_create_response.rbi | 10 +++++----- .../models/custom_metadata_field_list_response.rbi | 10 +++++----- .../models/custom_metadata_field_update_params.rbi | 10 +++++----- .../models/custom_metadata_field_update_response.rbi | 10 +++++----- .../models/custom_metadata_field_create_params.rbs | 10 +++++----- .../models/custom_metadata_field_create_response.rbs | 10 +++++----- .../models/custom_metadata_field_list_response.rbs | 10 +++++----- .../models/custom_metadata_field_update_params.rbs | 10 +++++----- .../models/custom_metadata_field_update_response.rbs | 10 +++++----- 16 files changed, 74 insertions(+), 74 deletions(-) diff --git a/.stats.yml b/.stats.yml index 1bb527b9..825ee654 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-7da4f48715dfd85e3bbc25086d62dc4959fb6bd1a9c3fd3933cfe0e80f6ae244.yml -openapi_spec_hash: 260d09fbed77316aae394877e5239398 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-76afc867b06fdc43b339f2c7d19f25a46481b25e8264ca24ea43daa1ea9234fc.yml +openapi_spec_hash: a1455d2ab02c48a14551362dd8ec2261 config_hash: c9b1142a72b93ad4d66f0433dca1392e diff --git a/lib/imagekit/models/custom_metadata_field_create_params.rb b/lib/imagekit/models/custom_metadata_field_create_params.rb index eedb3815..58a2f328 100644 --- a/lib/imagekit/models/custom_metadata_field_create_params.rb +++ b/lib/imagekit/models/custom_metadata_field_create_params.rb @@ -163,9 +163,9 @@ module DefaultValue variant Imagekit::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeFieldArray } + variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::MixedArray } - module ArrayForMultiSelectTypeField + module Mixed extend Imagekit::Internal::Type::Union variant String @@ -182,10 +182,10 @@ module ArrayForMultiSelectTypeField # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - ArrayForMultiSelectTypeFieldArray = - Imagekit::Internal::Type::ArrayOf[ - union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeField } - ] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed + }] end # Maximum value of the field. Only set this property if field type is `Date` or diff --git a/lib/imagekit/models/custom_metadata_field_create_response.rb b/lib/imagekit/models/custom_metadata_field_create_response.rb index 9c4703af..951221d6 100644 --- a/lib/imagekit/models/custom_metadata_field_create_response.rb +++ b/lib/imagekit/models/custom_metadata_field_create_response.rb @@ -162,9 +162,9 @@ module DefaultValue variant Imagekit::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3Array } + variant -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::MixedArray } - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union variant String @@ -181,8 +181,8 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3 }] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Mixed }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/lib/imagekit/models/custom_metadata_field_list_response.rb b/lib/imagekit/models/custom_metadata_field_list_response.rb index 68723e84..b171dc0d 100644 --- a/lib/imagekit/models/custom_metadata_field_list_response.rb +++ b/lib/imagekit/models/custom_metadata_field_list_response.rb @@ -162,9 +162,9 @@ module DefaultValue variant Imagekit::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3Array } + variant -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::MixedArray } - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union variant String @@ -181,8 +181,8 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3 }] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Mixed }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/lib/imagekit/models/custom_metadata_field_update_params.rb b/lib/imagekit/models/custom_metadata_field_update_params.rb index 25a71fc3..f991da44 100644 --- a/lib/imagekit/models/custom_metadata_field_update_params.rb +++ b/lib/imagekit/models/custom_metadata_field_update_params.rb @@ -137,9 +137,9 @@ module DefaultValue variant Imagekit::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3Array } + variant -> { Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::MixedArray } - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union variant String @@ -156,9 +156,9 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = + MixedArray = Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3 + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed }] end diff --git a/lib/imagekit/models/custom_metadata_field_update_response.rb b/lib/imagekit/models/custom_metadata_field_update_response.rb index 3d7c18ee..5c68c8b5 100644 --- a/lib/imagekit/models/custom_metadata_field_update_response.rb +++ b/lib/imagekit/models/custom_metadata_field_update_response.rb @@ -162,9 +162,9 @@ module DefaultValue variant Imagekit::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3Array } + variant -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::MixedArray } - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union variant String @@ -181,8 +181,8 @@ module UnionMember3 # @return [Array(String, Float, Boolean, Array)] # @type [Imagekit::Internal::Type::Converter] - UnionMember3Array = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3 }] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Mixed }] end # Maximum value of the field. Only set if field type is `Date` or `Number`. For diff --git a/rbi/imagekit/models/custom_metadata_field_create_params.rbi b/rbi/imagekit/models/custom_metadata_field_create_params.rbi index fea17937..78abcceb 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_params.rbi @@ -343,12 +343,12 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeField::Variants + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed::Variants ] ) end - module ArrayForMultiSelectTypeField + module Mixed extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -356,7 +356,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeField::Variants + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed::Variants ] ) end @@ -374,11 +374,11 @@ module Imagekit def self.variants end - ArrayForMultiSelectTypeFieldArray = + MixedArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::ArrayForMultiSelectTypeField + Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_create_response.rbi b/rbi/imagekit/models/custom_metadata_field_create_response.rbi index 73022a7e..e34bb551 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_create_response.rbi @@ -338,12 +338,12 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Mixed::Variants ] ) end - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -351,7 +351,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Mixed::Variants ] ) end @@ -369,11 +369,11 @@ module Imagekit def self.variants end - UnionMember3Array = + MixedArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::UnionMember3 + Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Mixed ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_list_response.rbi b/rbi/imagekit/models/custom_metadata_field_list_response.rbi index 04bcfa37..14bb8140 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_list_response.rbi @@ -339,12 +339,12 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Mixed::Variants ] ) end - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -352,7 +352,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Mixed::Variants ] ) end @@ -370,11 +370,11 @@ module Imagekit def self.variants end - UnionMember3Array = + MixedArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::UnionMember3 + Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Mixed ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_update_params.rbi b/rbi/imagekit/models/custom_metadata_field_update_params.rbi index 72ea1598..d94d36f6 100644 --- a/rbi/imagekit/models/custom_metadata_field_update_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_update_params.rbi @@ -276,12 +276,12 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3::Variants + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed::Variants ] ) end - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -289,7 +289,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3::Variants + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed::Variants ] ) end @@ -307,11 +307,11 @@ module Imagekit def self.variants end - UnionMember3Array = + MixedArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::UnionMember3 + Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/custom_metadata_field_update_response.rbi b/rbi/imagekit/models/custom_metadata_field_update_response.rbi index 6ecfa020..6d053beb 100644 --- a/rbi/imagekit/models/custom_metadata_field_update_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_update_response.rbi @@ -338,12 +338,12 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Mixed::Variants ] ) end - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } @@ -351,7 +351,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3::Variants + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Mixed::Variants ] ) end @@ -369,11 +369,11 @@ module Imagekit def self.variants end - UnionMember3Array = + MixedArray = T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::UnionMember3 + Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Mixed ], Imagekit::Internal::Type::Converter ) diff --git a/sig/imagekit/models/custom_metadata_field_create_params.rbs b/sig/imagekit/models/custom_metadata_field_create_params.rbs index 86783ab3..1d4f85db 100644 --- a/sig/imagekit/models/custom_metadata_field_create_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_params.rbs @@ -132,22 +132,22 @@ module Imagekit String | Float | bool - | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::array_for_multi_select_type_field] + | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::mixed] module DefaultValue extend Imagekit::Internal::Type::Union - type array_for_multi_select_type_field = String | Float | bool + type mixed = String | Float | bool - module ArrayForMultiSelectTypeField + module Mixed extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::array_for_multi_select_type_field] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::mixed] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value] - ArrayForMultiSelectTypeFieldArray: Imagekit::Internal::Type::Converter + MixedArray: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_create_response.rbs b/sig/imagekit/models/custom_metadata_field_create_response.rbs index dc03ab3c..935841e0 100644 --- a/sig/imagekit/models/custom_metadata_field_create_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_create_response.rbs @@ -131,22 +131,22 @@ module Imagekit String | Float | bool - | ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member3] + | ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::mixed] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type mixed = String | Float | bool - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::mixed] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + MixedArray: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_list_response.rbs b/sig/imagekit/models/custom_metadata_field_list_response.rbs index 9ff08639..3e856b70 100644 --- a/sig/imagekit/models/custom_metadata_field_list_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_list_response.rbs @@ -131,22 +131,22 @@ module Imagekit String | Float | bool - | ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member3] + | ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::mixed] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type mixed = String | Float | bool - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::mixed] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + MixedArray: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_update_params.rbs b/sig/imagekit/models/custom_metadata_field_update_params.rbs index d6f1b888..9da6ca07 100644 --- a/sig/imagekit/models/custom_metadata_field_update_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_update_params.rbs @@ -105,22 +105,22 @@ module Imagekit String | Float | bool - | ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member3] + | ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::mixed] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type mixed = String | Float | bool - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::mixed] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + MixedArray: Imagekit::Internal::Type::Converter end type max_value = String | Float diff --git a/sig/imagekit/models/custom_metadata_field_update_response.rbs b/sig/imagekit/models/custom_metadata_field_update_response.rbs index 5d806344..118286b5 100644 --- a/sig/imagekit/models/custom_metadata_field_update_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_update_response.rbs @@ -131,22 +131,22 @@ module Imagekit String | Float | bool - | ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member3] + | ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::mixed] module DefaultValue extend Imagekit::Internal::Type::Union - type union_member3 = String | Float | bool + type mixed = String | Float | bool - module UnionMember3 + module Mixed extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::union_member3] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::mixed] end def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value] - UnionMember3Array: Imagekit::Internal::Type::Converter + MixedArray: Imagekit::Internal::Type::Converter end type max_value = String | Float From 3f6b0762122ff1056021cec98e0b2f69b387780d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 11:46:58 +0000 Subject: [PATCH 026/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 825ee654..aff1f7d8 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-76afc867b06fdc43b339f2c7d19f25a46481b25e8264ca24ea43daa1ea9234fc.yml -openapi_spec_hash: a1455d2ab02c48a14551362dd8ec2261 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d9f06036e82cb9fcefe298e18ab40671a4454cf02c433e42c7281391543fde39.yml +openapi_spec_hash: bfad95cff6d56f887ac5ecfa1ab2c7dd config_hash: c9b1142a72b93ad4d66f0433dca1392e From 7d7e7ffbd3edcb6a0eae4cc7a0fcfe9e71a6fda2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 12:17:51 +0000 Subject: [PATCH 027/178] codegen metadata --- .stats.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index aff1f7d8..5a33818e 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-d9f06036e82cb9fcefe298e18ab40671a4454cf02c433e42c7281391543fde39.yml -openapi_spec_hash: bfad95cff6d56f887ac5ecfa1ab2c7dd -config_hash: c9b1142a72b93ad4d66f0433dca1392e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-ce1742072cca1d90af9b0be8cc75dac4f2d5b3258041c3cede545e6521f4d72a.yml +openapi_spec_hash: 5e896419003b5ef3728293241e9dd37e +config_hash: ecd4e1fc35135b5e53487ca547e46fd7 From c0e4c05d1127a2db9d3aa97c34156f9dd1956b55 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 12:18:45 +0000 Subject: [PATCH 028/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 5a33818e..ba9b6e53 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-ce1742072cca1d90af9b0be8cc75dac4f2d5b3258041c3cede545e6521f4d72a.yml -openapi_spec_hash: 5e896419003b5ef3728293241e9dd37e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-a49c22a93734b90653ada66f9b336a7da952642572330f9713282ea6fc06990a.yml +openapi_spec_hash: 7e0a9ea9ef3fad500e045c0c3bc69762 config_hash: ecd4e1fc35135b5e53487ca547e46fd7 From f4ec60344ddc9e0874610bb345c3cb6971bdd581 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 12:29:26 +0000 Subject: [PATCH 029/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index ba9b6e53..bdd3cece 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-a49c22a93734b90653ada66f9b336a7da952642572330f9713282ea6fc06990a.yml -openapi_spec_hash: 7e0a9ea9ef3fad500e045c0c3bc69762 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-76afc867b06fdc43b339f2c7d19f25a46481b25e8264ca24ea43daa1ea9234fc.yml +openapi_spec_hash: a1455d2ab02c48a14551362dd8ec2261 config_hash: ecd4e1fc35135b5e53487ca547e46fd7 From 12e433c122cb1c6bbe8dd57c2c3f132e34ee9083 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 12:35:09 +0000 Subject: [PATCH 030/178] feat(api): manual updates --- .stats.yml | 4 +- .../models/accounts/origin_create_params.rb | 26 +++++-- .../models/accounts/origin_update_params.rb | 26 +++++-- lib/imagekit/resources/accounts/origins.rb | 12 ++-- .../models/accounts/origin_create_params.rbi | 69 +++++++++++++++++-- .../models/accounts/origin_update_params.rbi | 69 +++++++++++++++++-- rbi/imagekit/resources/accounts/origins.rbi | 8 +-- .../models/accounts/origin_create_params.rbs | 33 +++++++-- .../models/accounts/origin_update_params.rbs | 33 +++++++-- sig/imagekit/resources/accounts/origins.rbs | 4 +- 10 files changed, 244 insertions(+), 40 deletions(-) diff --git a/.stats.yml b/.stats.yml index bdd3cece..fbcd50b8 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-76afc867b06fdc43b339f2c7d19f25a46481b25e8264ca24ea43daa1ea9234fc.yml -openapi_spec_hash: a1455d2ab02c48a14551362dd8ec2261 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-4abcc684cb38a6caeb1d20789c3f42f050aa02a1e11cd15b56a758b269961368.yml +openapi_spec_hash: c197897c7befdd521213bdaabbf8b134 config_hash: ecd4e1fc35135b5e53487ca547e46fd7 diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index 6cbcb1eb..5f1c3365 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -33,8 +33,8 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM + # @return [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] + required :type, enum: -> { Imagekit::Accounts::OriginCreateParams::Type } # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -130,7 +130,7 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # @return [String] required :username, String - # @!method initialize(access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) + # @!method initialize(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) # @param access_key [String] Access key for the bucket. # # @param bucket [String] @@ -139,6 +139,8 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # # @param secret_key [String] Secret key for the bucket. # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] + # # @param endpoint [String] Custom S3-compatible endpoint. # # @param base_url [String] Akeneo instance base URL. @@ -171,9 +173,23 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # - # @param type [Symbol, :AKENEO_PIM] - # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM = :AKENEO_PIM + S3 = :S3 + S3_COMPATIBLE = :S3_COMPATIBLE + CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP + WEB_FOLDER = :WEB_FOLDER + WEB_PROXY = :WEB_PROXY + GCS = :GCS + AZURE_BLOB = :AZURE_BLOB + + # @!method self.values + # @return [Array] + end end end end diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index 8c3a2942..314cdc17 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -33,8 +33,8 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM + # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] + required :type, enum: -> { Imagekit::Accounts::OriginUpdateParams::Type } # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). @@ -130,7 +130,7 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # @return [String] required :username, String - # @!method initialize(access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) + # @!method initialize(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) # @param access_key [String] Access key for the bucket. # # @param bucket [String] @@ -139,6 +139,8 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # # @param secret_key [String] Secret key for the bucket. # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] + # # @param endpoint [String] Custom S3-compatible endpoint. # # @param base_url [String] Akeneo instance base URL. @@ -171,9 +173,23 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # - # @param type [Symbol, :AKENEO_PIM] - # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM = :AKENEO_PIM + S3 = :S3 + S3_COMPATIBLE = :S3_COMPATIBLE + CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP + WEB_FOLDER = :WEB_FOLDER + WEB_PROXY = :WEB_PROXY + GCS = :GCS + AZURE_BLOB = :AZURE_BLOB + + # @!method self.values + # @return [Array] + end end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index ea7a06b8..5f58e195 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -7,7 +7,7 @@ class Origins # **Note:** This API is currently in beta. # Creates a new origin and returns the origin object. # - # @overload create(access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) + # @overload create(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) # # @param access_key [String] Access key for the bucket. # @@ -17,6 +17,8 @@ class Origins # # @param secret_key [String] Secret key for the bucket. # + # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] + # # @param endpoint [String] Custom S3-compatible endpoint. # # @param base_url [String] Akeneo instance base URL. @@ -49,8 +51,6 @@ class Origins # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # - # @param type [Symbol, :AKENEO_PIM] - # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] @@ -73,7 +73,7 @@ def create(params) # **Note:** This API is currently in beta. # Updates the origin identified by `id` and returns the updated origin object. # - # @overload update(id, access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) + # @overload update(id, access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -85,6 +85,8 @@ def create(params) # # @param secret_key [String] Secret key for the bucket. # + # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] + # # @param endpoint [String] Custom S3-compatible endpoint. # # @param base_url [String] Akeneo instance base URL. @@ -117,8 +119,6 @@ def create(params) # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # - # @param type [Symbol, :AKENEO_PIM] - # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index cd637d2b..71855ea5 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -30,7 +30,7 @@ module Imagekit sig { returns(String) } attr_accessor :secret_key - sig { returns(Symbol) } + sig { returns(Imagekit::Accounts::OriginCreateParams::Type::OrSymbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -112,6 +112,7 @@ module Imagekit bucket: String, name: String, secret_key: String, + type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, endpoint: String, base_url: String, client_email: String, @@ -128,7 +129,6 @@ module Imagekit prefix: String, s3_force_path_style: T::Boolean, forward_host_header_to_origin: T::Boolean, - type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end @@ -140,6 +140,7 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, + type:, # Custom S3-compatible endpoint. endpoint:, # Akeneo instance base URL. @@ -166,7 +167,6 @@ module Imagekit s3_force_path_style: nil, # Forward the Host header to origin? forward_host_header_to_origin: nil, - type: :AKENEO_PIM, request_options: {} ) end @@ -178,7 +178,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Symbol, + type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -201,6 +201,67 @@ module Imagekit end def to_hash end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Accounts::OriginCreateParams::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKENEO_PIM = + T.let( + :AKENEO_PIM, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + S3 = + T.let( + :S3, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + S3_COMPATIBLE = + T.let( + :S3_COMPATIBLE, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + CLOUDINARY_BACKUP = + T.let( + :CLOUDINARY_BACKUP, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + WEB_FOLDER = + T.let( + :WEB_FOLDER, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + WEB_PROXY = + T.let( + :WEB_PROXY, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + GCS = + T.let( + :GCS, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + AZURE_BLOB = + T.let( + :AZURE_BLOB, + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end end end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index d5ad1e3b..c7c5f878 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -30,7 +30,7 @@ module Imagekit sig { returns(String) } attr_accessor :secret_key - sig { returns(Symbol) } + sig { returns(Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol) } attr_accessor :type # URL used in the Canonical header (if enabled). @@ -112,6 +112,7 @@ module Imagekit bucket: String, name: String, secret_key: String, + type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, endpoint: String, base_url: String, client_email: String, @@ -128,7 +129,6 @@ module Imagekit prefix: String, s3_force_path_style: T::Boolean, forward_host_header_to_origin: T::Boolean, - type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end @@ -140,6 +140,7 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, + type:, # Custom S3-compatible endpoint. endpoint:, # Akeneo instance base URL. @@ -166,7 +167,6 @@ module Imagekit s3_force_path_style: nil, # Forward the Host header to origin? forward_host_header_to_origin: nil, - type: :AKENEO_PIM, request_options: {} ) end @@ -178,7 +178,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: Symbol, + type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -201,6 +201,67 @@ module Imagekit end def to_hash end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Accounts::OriginUpdateParams::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AKENEO_PIM = + T.let( + :AKENEO_PIM, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + S3 = + T.let( + :S3, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + S3_COMPATIBLE = + T.let( + :S3_COMPATIBLE, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + CLOUDINARY_BACKUP = + T.let( + :CLOUDINARY_BACKUP, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + WEB_FOLDER = + T.let( + :WEB_FOLDER, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + WEB_PROXY = + T.let( + :WEB_PROXY, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + GCS = + T.let( + :GCS, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + AZURE_BLOB = + T.let( + :AZURE_BLOB, + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end end end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index 69bb4057..73b6f746 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -12,6 +12,7 @@ module Imagekit bucket: String, name: String, secret_key: String, + type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, endpoint: String, base_url: String, client_email: String, @@ -28,7 +29,6 @@ module Imagekit prefix: String, s3_force_path_style: T::Boolean, forward_host_header_to_origin: T::Boolean, - type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginCreateResponse::Variants) end @@ -40,6 +40,7 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, + type:, # Custom S3-compatible endpoint. endpoint:, # Akeneo instance base URL. @@ -66,7 +67,6 @@ module Imagekit s3_force_path_style: nil, # Forward the Host header to origin? forward_host_header_to_origin: nil, - type: :AKENEO_PIM, request_options: {} ) end @@ -80,6 +80,7 @@ module Imagekit bucket: String, name: String, secret_key: String, + type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, endpoint: String, base_url: String, client_email: String, @@ -96,7 +97,6 @@ module Imagekit prefix: String, s3_force_path_style: T::Boolean, forward_host_header_to_origin: T::Boolean, - type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginUpdateResponse::Variants) end @@ -111,6 +111,7 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, + type:, # Custom S3-compatible endpoint. endpoint:, # Akeneo instance base URL. @@ -137,7 +138,6 @@ module Imagekit s3_force_path_style: nil, # Forward the Host header to origin? forward_host_header_to_origin: nil, - type: :AKENEO_PIM, request_options: {} ) end diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index abacd268..09e61b9b 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -7,7 +7,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: :AKENEO_PIM, + type: Imagekit::Models::Accounts::OriginCreateParams::type_, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -39,7 +39,7 @@ module Imagekit attr_accessor secret_key: String - attr_accessor type: :AKENEO_PIM + attr_accessor type: Imagekit::Models::Accounts::OriginCreateParams::type_ attr_reader base_url_for_canonical_header: String? @@ -88,6 +88,7 @@ module Imagekit bucket: String, name: String, secret_key: String, + type: Imagekit::Models::Accounts::OriginCreateParams::type_, endpoint: String, base_url: String, client_email: String, @@ -104,7 +105,6 @@ module Imagekit ?prefix: String, ?s3_force_path_style: bool, ?forward_host_header_to_origin: bool, - ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> void @@ -113,7 +113,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: :AKENEO_PIM, + type: Imagekit::Models::Accounts::OriginCreateParams::type_, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -132,6 +132,31 @@ module Imagekit username: String, request_options: Imagekit::RequestOptions } + + type type_ = + :AKENEO_PIM + | :S3 + | :S3_COMPATIBLE + | :CLOUDINARY_BACKUP + | :WEB_FOLDER + | :WEB_PROXY + | :GCS + | :AZURE_BLOB + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM: :AKENEO_PIM + S3: :S3 + S3_COMPATIBLE: :S3_COMPATIBLE + CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP + WEB_FOLDER: :WEB_FOLDER + WEB_PROXY: :WEB_PROXY + GCS: :GCS + AZURE_BLOB: :AZURE_BLOB + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateParams::type_] + end end end end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index 921bd49d..322ba4f9 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -7,7 +7,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: :AKENEO_PIM, + type: Imagekit::Models::Accounts::OriginUpdateParams::type_, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -39,7 +39,7 @@ module Imagekit attr_accessor secret_key: String - attr_accessor type: :AKENEO_PIM + attr_accessor type: Imagekit::Models::Accounts::OriginUpdateParams::type_ attr_reader base_url_for_canonical_header: String? @@ -88,6 +88,7 @@ module Imagekit bucket: String, name: String, secret_key: String, + type: Imagekit::Models::Accounts::OriginUpdateParams::type_, endpoint: String, base_url: String, client_email: String, @@ -104,7 +105,6 @@ module Imagekit ?prefix: String, ?s3_force_path_style: bool, ?forward_host_header_to_origin: bool, - ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> void @@ -113,7 +113,7 @@ module Imagekit bucket: String, name: String, secret_key: String, - type: :AKENEO_PIM, + type: Imagekit::Models::Accounts::OriginUpdateParams::type_, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -132,6 +132,31 @@ module Imagekit username: String, request_options: Imagekit::RequestOptions } + + type type_ = + :AKENEO_PIM + | :S3 + | :S3_COMPATIBLE + | :CLOUDINARY_BACKUP + | :WEB_FOLDER + | :WEB_PROXY + | :GCS + | :AZURE_BLOB + + module Type + extend Imagekit::Internal::Type::Enum + + AKENEO_PIM: :AKENEO_PIM + S3: :S3 + S3_COMPATIBLE: :S3_COMPATIBLE + CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP + WEB_FOLDER: :WEB_FOLDER + WEB_PROXY: :WEB_PROXY + GCS: :GCS + AZURE_BLOB: :AZURE_BLOB + + def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateParams::type_] + end end end end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index 2b3e4510..fc156612 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -7,6 +7,7 @@ module Imagekit bucket: String, name: String, secret_key: String, + type: Imagekit::Models::Accounts::OriginCreateParams::type_, endpoint: String, base_url: String, client_email: String, @@ -23,7 +24,6 @@ module Imagekit ?prefix: String, ?s3_force_path_style: bool, ?forward_host_header_to_origin: bool, - ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_create_response @@ -33,6 +33,7 @@ module Imagekit bucket: String, name: String, secret_key: String, + type: Imagekit::Models::Accounts::OriginUpdateParams::type_, endpoint: String, base_url: String, client_email: String, @@ -49,7 +50,6 @@ module Imagekit ?prefix: String, ?s3_force_path_style: bool, ?forward_host_header_to_origin: bool, - ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_update_response From 02b5cac75d0bff88668ea7815b69f397cc842bc6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 12:43:50 +0000 Subject: [PATCH 031/178] feat(api): manual updates --- .stats.yml | 4 +- .../models/accounts/origin_create_params.rb | 183 +------------ .../models/accounts/origin_update_params.rb | 183 +------------ lib/imagekit/resources/accounts/origins.rb | 93 +------ .../models/accounts/origin_create_params.rbi | 242 ++---------------- .../models/accounts/origin_update_params.rbi | 242 ++---------------- rbi/imagekit/resources/accounts/origins.rbi | 117 +-------- .../models/accounts/origin_create_params.rbs | 145 +---------- .../models/accounts/origin_update_params.rbs | 145 +---------- sig/imagekit/resources/accounts/origins.rbs | 44 +--- .../resources/accounts/origins_test.rb | 23 +- 11 files changed, 80 insertions(+), 1341 deletions(-) diff --git a/.stats.yml b/.stats.yml index fbcd50b8..0604c950 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-4abcc684cb38a6caeb1d20789c3f42f050aa02a1e11cd15b56a758b269961368.yml -openapi_spec_hash: c197897c7befdd521213bdaabbf8b134 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-3fced4085838ae20641cfa2775c6d36757bbaae28415892b2e9ee438e3b56a85.yml +openapi_spec_hash: 58327d97499fdad00856caa35ca3f16a config_hash: ecd4e1fc35135b5e53487ca547e46fd7 diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index 5f1c3365..030b32d9 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -8,187 +8,16 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute access_key - # Access key for the bucket. + # @!attribute body # - # @return [String] - required :access_key, String, api_name: :accessKey + # @return [Imagekit::Models::Accounts::OriginCreateParams::Body] + required :body, -> { Imagekit::Accounts::OriginCreateParams::Body } - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] - required :type, enum: -> { Imagekit::Accounts::OriginCreateParams::Type } - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey - - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken - - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret - - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param base_url [String] Akeneo instance base URL. - # - # @param client_email [String] - # - # @param private_key [String] - # - # @param account_name [String] - # - # @param container [String] - # - # @param sas_token [String] - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # + # @!method initialize(body:, request_options: {}) + # @param body [Imagekit::Models::Accounts::OriginCreateParams::Body] # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM = :AKENEO_PIM - S3 = :S3 - S3_COMPATIBLE = :S3_COMPATIBLE - CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP - WEB_FOLDER = :WEB_FOLDER - WEB_PROXY = :WEB_PROXY - GCS = :GCS - AZURE_BLOB = :AZURE_BLOB - - # @!method self.values - # @return [Array] + class Body < Imagekit::Internal::Type::BaseModel end end end diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index 314cdc17..e958dfb6 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -8,187 +8,16 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute access_key - # Access key for the bucket. + # @!attribute body # - # @return [String] - required :access_key, String, api_name: :accessKey + # @return [Imagekit::Models::Accounts::OriginUpdateParams::Body] + required :body, -> { Imagekit::Accounts::OriginUpdateParams::Body } - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] - required :type, enum: -> { Imagekit::Accounts::OriginUpdateParams::Type } - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey - - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken - - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret - - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param base_url [String] Akeneo instance base URL. - # - # @param client_email [String] - # - # @param private_key [String] - # - # @param account_name [String] - # - # @param container [String] - # - # @param sas_token [String] - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # + # @!method initialize(body:, request_options: {}) + # @param body [Imagekit::Models::Accounts::OriginUpdateParams::Body] # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM = :AKENEO_PIM - S3 = :S3 - S3_COMPATIBLE = :S3_COMPATIBLE - CLOUDINARY_BACKUP = :CLOUDINARY_BACKUP - WEB_FOLDER = :WEB_FOLDER - WEB_PROXY = :WEB_PROXY - GCS = :GCS - AZURE_BLOB = :AZURE_BLOB - - # @!method self.values - # @return [Array] + class Body < Imagekit::Internal::Type::BaseModel end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index 5f58e195..97bdbf19 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -7,50 +7,9 @@ class Origins # **Note:** This API is currently in beta. # Creates a new origin and returns the origin object. # - # @overload create(access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) - # - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param type [Symbol, Imagekit::Models::Accounts::OriginCreateParams::Type] - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param base_url [String] Akeneo instance base URL. - # - # @param client_email [String] - # - # @param private_key [String] - # - # @param account_name [String] - # - # @param container [String] - # - # @param sas_token [String] - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # @overload create(body:, request_options: {}) # + # @param body [Imagekit::Models::Accounts::OriginCreateParams::Body] # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] @@ -61,7 +20,7 @@ def create(params) @client.request( method: :post, path: "v1/accounts/origins", - body: parsed, + body: parsed[:body], model: Imagekit::Models::Accounts::OriginCreateResponse, options: options ) @@ -73,51 +32,11 @@ def create(params) # **Note:** This API is currently in beta. # Updates the origin identified by `id` and returns the updated origin object. # - # @overload update(id, access_key:, bucket:, name:, secret_key:, type:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, request_options: {}) + # @overload update(id, body:, request_options: {}) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param type [Symbol, Imagekit::Models::Accounts::OriginUpdateParams::Type] - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param base_url [String] Akeneo instance base URL. - # - # @param client_email [String] - # - # @param private_key [String] - # - # @param account_name [String] - # - # @param container [String] - # - # @param sas_token [String] - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # @param body [Imagekit::Models::Accounts::OriginUpdateParams::Body] # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -129,7 +48,7 @@ def update(id, params) @client.request( method: :put, path: ["v1/accounts/origins/%1$s", id], - body: parsed, + body: parsed[:body], model: Imagekit::Models::Accounts::OriginUpdateResponse, options: options ) diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index 71855ea5..865cf690 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -15,186 +15,29 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key + sig { returns(Imagekit::Accounts::OriginCreateParams::Body) } + attr_reader :body - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Imagekit::Accounts::OriginCreateParams::Type::OrSymbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - sig { returns(String) } - attr_accessor :client_email - - sig { returns(String) } - attr_accessor :private_key - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - sig { returns(String) } - attr_accessor :sas_token - - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret - - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - - # Akeneo API username. - sig { returns(String) } - attr_accessor :username + sig do + params( + body: Imagekit::Accounts::OriginCreateParams::Body::OrHash + ).void + end + attr_writer :body sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - forward_host_header_to_origin: T::Boolean, + body: Imagekit::Accounts::OriginCreateParams::Body::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new( - # Access key for the bucket. - access_key:, - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - type:, - # Custom S3-compatible endpoint. - endpoint:, - # Akeneo instance base URL. - base_url:, - client_email:, - private_key:, - account_name:, - container:, - sas_token:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - request_options: {} - ) + def self.new(body:, request_options: {}) end sig do override.returns( { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - endpoint: String, - s3_force_path_style: T::Boolean, - base_url: String, - forward_host_header_to_origin: T::Boolean, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, + body: Imagekit::Accounts::OriginCreateParams::Body, request_options: Imagekit::RequestOptions } ) @@ -202,64 +45,17 @@ module Imagekit def to_hash end - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = + class Body < Imagekit::Internal::Type::BaseModel + OrHash = T.type_alias do - T.all(Symbol, Imagekit::Accounts::OriginCreateParams::Type) + T.any( + Imagekit::Accounts::OriginCreateParams::Body, + Imagekit::Internal::AnyHash + ) end - OrSymbol = T.type_alias { T.any(Symbol, String) } - AKENEO_PIM = - T.let( - :AKENEO_PIM, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - S3 = - T.let( - :S3, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - S3_COMPATIBLE = - T.let( - :S3_COMPATIBLE, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - CLOUDINARY_BACKUP = - T.let( - :CLOUDINARY_BACKUP, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - WEB_FOLDER = - T.let( - :WEB_FOLDER, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - WEB_PROXY = - T.let( - :WEB_PROXY, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - GCS = - T.let( - :GCS, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - AZURE_BLOB = - T.let( - :AZURE_BLOB, - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::OriginCreateParams::Type::TaggedSymbol - ] - ) - end - def self.values + sig { override.returns({}) } + def to_hash end end end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index c7c5f878..aa98a53f 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -15,186 +15,29 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key + sig { returns(Imagekit::Accounts::OriginUpdateParams::Body) } + attr_reader :body - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - sig { returns(String) } - attr_accessor :client_email - - sig { returns(String) } - attr_accessor :private_key - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - sig { returns(String) } - attr_accessor :sas_token - - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret - - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - - # Akeneo API username. - sig { returns(String) } - attr_accessor :username + sig do + params( + body: Imagekit::Accounts::OriginUpdateParams::Body::OrHash + ).void + end + attr_writer :body sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - forward_host_header_to_origin: T::Boolean, + body: Imagekit::Accounts::OriginUpdateParams::Body::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new( - # Access key for the bucket. - access_key:, - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - type:, - # Custom S3-compatible endpoint. - endpoint:, - # Akeneo instance base URL. - base_url:, - client_email:, - private_key:, - account_name:, - container:, - sas_token:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - request_options: {} - ) + def self.new(body:, request_options: {}) end sig do override.returns( { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - endpoint: String, - s3_force_path_style: T::Boolean, - base_url: String, - forward_host_header_to_origin: T::Boolean, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, + body: Imagekit::Accounts::OriginUpdateParams::Body, request_options: Imagekit::RequestOptions } ) @@ -202,64 +45,17 @@ module Imagekit def to_hash end - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = + class Body < Imagekit::Internal::Type::BaseModel + OrHash = T.type_alias do - T.all(Symbol, Imagekit::Accounts::OriginUpdateParams::Type) + T.any( + Imagekit::Accounts::OriginUpdateParams::Body, + Imagekit::Internal::AnyHash + ) end - OrSymbol = T.type_alias { T.any(Symbol, String) } - AKENEO_PIM = - T.let( - :AKENEO_PIM, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - S3 = - T.let( - :S3, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - S3_COMPATIBLE = - T.let( - :S3_COMPATIBLE, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - CLOUDINARY_BACKUP = - T.let( - :CLOUDINARY_BACKUP, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - WEB_FOLDER = - T.let( - :WEB_FOLDER, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - WEB_PROXY = - T.let( - :WEB_PROXY, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - GCS = - T.let( - :GCS, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - AZURE_BLOB = - T.let( - :AZURE_BLOB, - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::OriginUpdateParams::Type::TaggedSymbol - ] - ) - end - def self.values + sig { override.returns({}) } + def to_hash end end end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index 73b6f746..cd765247 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -8,67 +8,11 @@ module Imagekit # Creates a new origin and returns the origin object. sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Accounts::OriginCreateParams::Type::OrSymbol, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - forward_host_header_to_origin: T::Boolean, + body: Imagekit::Accounts::OriginCreateParams::Body::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginCreateResponse::Variants) end - def create( - # Access key for the bucket. - access_key:, - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - type:, - # Custom S3-compatible endpoint. - endpoint:, - # Akeneo instance base URL. - base_url:, - client_email:, - private_key:, - account_name:, - container:, - sas_token:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - request_options: {} - ) + def create(body:, request_options: {}) end # **Note:** This API is currently in beta. @@ -76,27 +20,7 @@ module Imagekit sig do params( id: String, - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Accounts::OriginUpdateParams::Type::OrSymbol, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - forward_host_header_to_origin: T::Boolean, + body: Imagekit::Accounts::OriginUpdateParams::Body::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginUpdateResponse::Variants) end @@ -104,40 +28,7 @@ module Imagekit # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. id, - # Access key for the bucket. - access_key:, - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - type:, - # Custom S3-compatible endpoint. - endpoint:, - # Akeneo instance base URL. - base_url:, - client_email:, - private_key:, - account_name:, - container:, - sas_token:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, + body:, request_options: {} ) end diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index 09e61b9b..cebae609 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -2,160 +2,29 @@ module Imagekit module Models module Accounts type origin_create_params = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Models::Accounts::OriginCreateParams::type_, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - endpoint: String, - :s3_force_path_style => bool, - base_url: String, - forward_host_header_to_origin: bool, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String - } + { body: Imagekit::Accounts::OriginCreateParams::Body } & Imagekit::Internal::Type::request_parameters class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: Imagekit::Models::Accounts::OriginCreateParams::type_ - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_accessor endpoint: String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - attr_accessor base_url: String - - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_accessor client_email: String - - attr_accessor private_key: String - - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor sas_token: String - - attr_accessor client_id: String - - attr_accessor client_secret: String - - attr_accessor password: String - - attr_accessor username: String + attr_accessor body: Imagekit::Accounts::OriginCreateParams::Body def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Models::Accounts::OriginCreateParams::type_, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?forward_host_header_to_origin: bool, + body: Imagekit::Accounts::OriginCreateParams::Body, ?request_options: Imagekit::request_opts ) -> void def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Models::Accounts::OriginCreateParams::type_, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - endpoint: String, - :s3_force_path_style => bool, - base_url: String, - forward_host_header_to_origin: bool, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, + body: Imagekit::Accounts::OriginCreateParams::Body, request_options: Imagekit::RequestOptions } - type type_ = - :AKENEO_PIM - | :S3 - | :S3_COMPATIBLE - | :CLOUDINARY_BACKUP - | :WEB_FOLDER - | :WEB_PROXY - | :GCS - | :AZURE_BLOB - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM: :AKENEO_PIM - S3: :S3 - S3_COMPATIBLE: :S3_COMPATIBLE - CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP - WEB_FOLDER: :WEB_FOLDER - WEB_PROXY: :WEB_PROXY - GCS: :GCS - AZURE_BLOB: :AZURE_BLOB + type body = { } - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginCreateParams::type_] + class Body < Imagekit::Internal::Type::BaseModel + def to_hash: -> { } end end end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index 322ba4f9..4e022678 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -2,160 +2,29 @@ module Imagekit module Models module Accounts type origin_update_params = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Models::Accounts::OriginUpdateParams::type_, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - endpoint: String, - :s3_force_path_style => bool, - base_url: String, - forward_host_header_to_origin: bool, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String - } + { body: Imagekit::Accounts::OriginUpdateParams::Body } & Imagekit::Internal::Type::request_parameters class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: Imagekit::Models::Accounts::OriginUpdateParams::type_ - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_accessor endpoint: String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - attr_accessor base_url: String - - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_accessor client_email: String - - attr_accessor private_key: String - - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor sas_token: String - - attr_accessor client_id: String - - attr_accessor client_secret: String - - attr_accessor password: String - - attr_accessor username: String + attr_accessor body: Imagekit::Accounts::OriginUpdateParams::Body def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Models::Accounts::OriginUpdateParams::type_, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?forward_host_header_to_origin: bool, + body: Imagekit::Accounts::OriginUpdateParams::Body, ?request_options: Imagekit::request_opts ) -> void def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Models::Accounts::OriginUpdateParams::type_, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - endpoint: String, - :s3_force_path_style => bool, - base_url: String, - forward_host_header_to_origin: bool, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, + body: Imagekit::Accounts::OriginUpdateParams::Body, request_options: Imagekit::RequestOptions } - type type_ = - :AKENEO_PIM - | :S3 - | :S3_COMPATIBLE - | :CLOUDINARY_BACKUP - | :WEB_FOLDER - | :WEB_PROXY - | :GCS - | :AZURE_BLOB - - module Type - extend Imagekit::Internal::Type::Enum - - AKENEO_PIM: :AKENEO_PIM - S3: :S3 - S3_COMPATIBLE: :S3_COMPATIBLE - CLOUDINARY_BACKUP: :CLOUDINARY_BACKUP - WEB_FOLDER: :WEB_FOLDER - WEB_PROXY: :WEB_PROXY - GCS: :GCS - AZURE_BLOB: :AZURE_BLOB + type body = { } - def self?.values: -> ::Array[Imagekit::Models::Accounts::OriginUpdateParams::type_] + class Body < Imagekit::Internal::Type::BaseModel + def to_hash: -> { } end end end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index fc156612..defab3ee 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -3,53 +3,13 @@ module Imagekit class Accounts class Origins def create: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Models::Accounts::OriginCreateParams::type_, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?forward_host_header_to_origin: bool, + body: Imagekit::Accounts::OriginCreateParams::Body, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_create_response def update: ( String id, - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Imagekit::Models::Accounts::OriginUpdateParams::type_, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?forward_host_header_to_origin: bool, + body: Imagekit::Accounts::OriginUpdateParams::Body, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_update_response diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index 7ab82736..d5093101 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -6,16 +6,7 @@ class Imagekit::Test::Resources::Accounts::OriginsTest < Imagekit::Test::Resourc def test_create_required_params skip("Prism tests are disabled") - response = - @image_kit.accounts.origins.create( - base_url: "https://akeneo.company.com", - client_id: "akeneo-client-id", - client_secret: "akeneo-client-secret", - name: "US S3 Storage", - password: "strongpassword123", - type: :AKENEO_PIM, - username: "integration-user" - ) + response = @image_kit.accounts.origins.create(body: {name: "name", type: :S3}) assert_pattern do response => Imagekit::Models::Accounts::OriginCreateResponse @@ -38,17 +29,7 @@ def test_create_required_params def test_update_required_params skip("Prism tests are disabled") - response = - @image_kit.accounts.origins.update( - "id", - base_url: "https://akeneo.company.com", - client_id: "akeneo-client-id", - client_secret: "akeneo-client-secret", - name: "US S3 Storage", - password: "strongpassword123", - type: :AKENEO_PIM, - username: "integration-user" - ) + response = @image_kit.accounts.origins.update("id", body: {name: "name", type: :S3}) assert_pattern do response => Imagekit::Models::Accounts::OriginUpdateResponse From 586e762970ac7185a265644bcbb943db807e6e38 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 12:51:45 +0000 Subject: [PATCH 032/178] feat(api): manual updates --- .stats.yml | 6 +- .../models/accounts/origin_create_params.rb | 549 +++++++++++- .../models/accounts/origin_update_params.rb | 171 +++- lib/imagekit/resources/accounts/origins.rb | 53 +- .../models/accounts/origin_create_params.rbi | 817 +++++++++++++++++- .../models/accounts/origin_update_params.rbi | 193 ++++- rbi/imagekit/resources/accounts/origins.rbi | 75 +- .../models/accounts/origin_create_params.rbs | 471 +++++++++- .../models/accounts/origin_update_params.rbs | 126 ++- sig/imagekit/resources/accounts/origins.rbs | 24 +- .../resources/accounts/origins_test.rb | 23 +- 11 files changed, 2419 insertions(+), 89 deletions(-) diff --git a/.stats.yml b/.stats.yml index 0604c950..4fc82ca0 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-3fced4085838ae20641cfa2775c6d36757bbaae28415892b2e9ee438e3b56a85.yml -openapi_spec_hash: 58327d97499fdad00856caa35ca3f16a -config_hash: ecd4e1fc35135b5e53487ca547e46fd7 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-76afc867b06fdc43b339f2c7d19f25a46481b25e8264ca24ea43daa1ea9234fc.yml +openapi_spec_hash: a1455d2ab02c48a14551362dd8ec2261 +config_hash: 396f0b1c74b8b5bc4dd6b5d87e374d90 diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index 030b32d9..66343a66 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -8,16 +8,553 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute body + # @!attribute origin + # Schema for origin resources. # - # @return [Imagekit::Models::Accounts::OriginCreateParams::Body] - required :body, -> { Imagekit::Accounts::OriginCreateParams::Body } + # @return [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] + required :origin, union: -> { Imagekit::Accounts::OriginCreateParams::Origin } - # @!method initialize(body:, request_options: {}) - # @param body [Imagekit::Models::Accounts::OriginCreateParams::Body] + # @!method initialize(origin:, request_options: {}) + # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin resources. + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - class Body < Imagekit::Internal::Type::BaseModel + # Schema for origin resources. + module Origin + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Accounts::OriginCreateParams::Origin::S3 } + + variant -> { Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible } + + variant -> { Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup } + + variant -> { Imagekit::Accounts::OriginCreateParams::Origin::WebFolder } + + variant -> { Imagekit::Accounts::OriginCreateParams::Origin::WebProxy } + + variant -> { Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs } + + variant -> { Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage } + + variant -> { Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3] + required :type, const: :S3 + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :S3] + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, :S3_COMPATIBLE] + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :CLOUDINARY_BACKUP] + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. + # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_FOLDER] + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_PROXY] + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute type + # + # @return [Symbol, :GCS] + required :type, const: :GCS + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @param bucket [String] + # + # @param client_email [String] + # + # @param name [String] Display name of the origin. + # + # @param private_key [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :GCS] + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute type + # + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @param account_name [String] + # + # @param container [String] + # + # @param name [String] Display name of the origin. + # + # @param sas_token [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :AZURE_BLOB] + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute type + # + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + # @param base_url [String] Akeneo instance base URL. + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param name [String] Display name of the origin. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :AKENEO_PIM] + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index e958dfb6..8c3a2942 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -8,17 +8,172 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute body + # @!attribute access_key + # Access key for the bucket. # - # @return [Imagekit::Models::Accounts::OriginUpdateParams::Body] - required :body, -> { Imagekit::Accounts::OriginUpdateParams::Body } + # @return [String] + required :access_key, String, api_name: :accessKey - # @!method initialize(body:, request_options: {}) - # @param body [Imagekit::Models::Accounts::OriginUpdateParams::Body] - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String - class Body < Imagekit::Internal::Type::BaseModel - end + # @!method initialize(access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param base_url [String] Akeneo instance base URL. + # + # @param client_email [String] + # + # @param private_key [String] + # + # @param account_name [String] + # + # @param container [String] + # + # @param sas_token [String] + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param type [Symbol, :AKENEO_PIM] + # + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index 97bdbf19..d0046767 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -7,9 +7,10 @@ class Origins # **Note:** This API is currently in beta. # Creates a new origin and returns the origin object. # - # @overload create(body:, request_options: {}) + # @overload create(origin:, request_options: {}) + # + # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin resources. # - # @param body [Imagekit::Models::Accounts::OriginCreateParams::Body] # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] @@ -20,7 +21,7 @@ def create(params) @client.request( method: :post, path: "v1/accounts/origins", - body: parsed[:body], + body: parsed[:origin], model: Imagekit::Models::Accounts::OriginCreateResponse, options: options ) @@ -32,11 +33,51 @@ def create(params) # **Note:** This API is currently in beta. # Updates the origin identified by `id` and returns the updated origin object. # - # @overload update(id, body:, request_options: {}) + # @overload update(id, access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param body [Imagekit::Models::Accounts::OriginUpdateParams::Body] + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param base_url [String] Akeneo instance base URL. + # + # @param client_email [String] + # + # @param private_key [String] + # + # @param account_name [String] + # + # @param container [String] + # + # @param sas_token [String] + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param type [Symbol, :AKENEO_PIM] # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -48,7 +89,7 @@ def update(id, params) @client.request( method: :put, path: ["v1/accounts/origins/%1$s", id], - body: parsed[:body], + body: parsed, model: Imagekit::Models::Accounts::OriginUpdateResponse, options: options ) diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index 865cf690..8a0edd57 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -15,29 +15,60 @@ module Imagekit ) end - sig { returns(Imagekit::Accounts::OriginCreateParams::Body) } - attr_reader :body - + # Schema for origin resources. sig do - params( - body: Imagekit::Accounts::OriginCreateParams::Body::OrHash - ).void + returns( + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, + Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim + ) + ) end - attr_writer :body + attr_accessor :origin sig do params( - body: Imagekit::Accounts::OriginCreateParams::Body::OrHash, + origin: + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash + ), request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(body:, request_options: {}) + def self.new( + # Schema for origin resources. + origin:, + request_options: {} + ) end sig do override.returns( { - body: Imagekit::Accounts::OriginCreateParams::Body, + origin: + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, + Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim + ), request_options: Imagekit::RequestOptions } ) @@ -45,17 +76,771 @@ module Imagekit def to_hash end - class Body < Imagekit::Internal::Type::BaseModel - OrHash = + # Schema for origin resources. + module Origin + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias do T.any( - Imagekit::Accounts::OriginCreateParams::Body, - Imagekit::Internal::AnyHash + Imagekit::Accounts::OriginCreateParams::Origin::S3, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, + Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :S3 + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } ) end + def to_hash + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig do + params( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + type: :S3_COMPATIBLE + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean + } + ) + end + def to_hash + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :CLOUDINARY_BACKUP + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(String) } + attr_accessor :base_url + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + name: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Root URL for the web folder origin. + base_url:, + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_FOLDER + ) + end - sig { override.returns({}) } - def to_hash + sig do + override.returns( + { + base_url: String, + name: String, + type: Symbol, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + name: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_PROXY + ) + end + + sig do + override.returns( + { + name: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + bucket: String, + client_email: String, + name: String, + private_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + bucket:, + client_email:, + # Display name of the origin. + name:, + private_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :GCS + ) + end + + sig do + override.returns( + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :sas_token + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + account_name: String, + container: String, + name: String, + sas_token: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + account_name:, + container:, + # Display name of the origin. + name:, + sas_token:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :AZURE_BLOB + ) + end + + sig do + override.returns( + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + sig { returns(Symbol) } + attr_accessor :type + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Akeneo instance base URL. + base_url:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Display name of the origin. + name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :AKENEO_PIM + ) + end + + sig do + override.returns( + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: Symbol, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + sig do + override.returns( + T::Array[Imagekit::Accounts::OriginCreateParams::Origin::Variants] + ) + end + def self.variants end end end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index aa98a53f..d5ad1e3b 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -15,49 +15,192 @@ module Imagekit ) end - sig { returns(Imagekit::Accounts::OriginUpdateParams::Body) } - attr_reader :body + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key - sig do - params( - body: Imagekit::Accounts::OriginUpdateParams::Body::OrHash - ).void - end - attr_writer :body + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + sig { returns(String) } + attr_accessor :client_email + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + sig { returns(String) } + attr_accessor :sas_token + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username sig do params( - body: Imagekit::Accounts::OriginUpdateParams::Body::OrHash, + access_key: String, + bucket: String, + name: String, + secret_key: String, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + forward_host_header_to_origin: T::Boolean, + type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(body:, request_options: {}) + def self.new( + # Access key for the bucket. + access_key:, + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # Custom S3-compatible endpoint. + endpoint:, + # Akeneo instance base URL. + base_url:, + client_email:, + private_key:, + account_name:, + container:, + sas_token:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + type: :AKENEO_PIM, + request_options: {} + ) end sig do override.returns( { - body: Imagekit::Accounts::OriginUpdateParams::Body, + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + endpoint: String, + s3_force_path_style: T::Boolean, + base_url: String, + forward_host_header_to_origin: T::Boolean, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, request_options: Imagekit::RequestOptions } ) end def to_hash end - - class Body < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Body, - Imagekit::Internal::AnyHash - ) - end - - sig { override.returns({}) } - def to_hash - end - end end end end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index cd765247..48eef32b 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -8,11 +8,25 @@ module Imagekit # Creates a new origin and returns the origin object. sig do params( - body: Imagekit::Accounts::OriginCreateParams::Body::OrHash, + origin: + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash + ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginCreateResponse::Variants) end - def create(body:, request_options: {}) + def create( + # Schema for origin resources. + origin:, + request_options: {} + ) end # **Note:** This API is currently in beta. @@ -20,7 +34,27 @@ module Imagekit sig do params( id: String, - body: Imagekit::Accounts::OriginUpdateParams::Body::OrHash, + access_key: String, + bucket: String, + name: String, + secret_key: String, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + forward_host_header_to_origin: T::Boolean, + type: Symbol, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginUpdateResponse::Variants) end @@ -28,7 +62,40 @@ module Imagekit # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. id, - body:, + # Access key for the bucket. + access_key:, + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # Custom S3-compatible endpoint. + endpoint:, + # Akeneo instance base URL. + base_url:, + client_email:, + private_key:, + account_name:, + container:, + sas_token:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + type: :AKENEO_PIM, request_options: {} ) end diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index cebae609..b4cd0ed6 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -2,29 +2,486 @@ module Imagekit module Models module Accounts type origin_create_params = - { body: Imagekit::Accounts::OriginCreateParams::Body } + { origin: Imagekit::Models::Accounts::OriginCreateParams::origin } & Imagekit::Internal::Type::request_parameters class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor body: Imagekit::Accounts::OriginCreateParams::Body + attr_accessor origin: Imagekit::Models::Accounts::OriginCreateParams::origin def initialize: ( - body: Imagekit::Accounts::OriginCreateParams::Body, + origin: Imagekit::Models::Accounts::OriginCreateParams::origin, ?request_options: Imagekit::request_opts ) -> void def to_hash: -> { - body: Imagekit::Accounts::OriginCreateParams::Body, + origin: Imagekit::Models::Accounts::OriginCreateParams::origin, request_options: Imagekit::RequestOptions } - type body = { } + type origin = + Imagekit::Accounts::OriginCreateParams::Origin::S3 + | Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible + | Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup + | Imagekit::Accounts::OriginCreateParams::Origin::WebFolder + | Imagekit::Accounts::OriginCreateParams::Origin::WebProxy + | Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs + | Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage + | Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - class Body < Imagekit::Internal::Type::BaseModel - def to_hash: -> { } + module Origin + extend Imagekit::Internal::Type::Union + + type s3 = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3 + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :S3 + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type s3_compatible = + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3_COMPATIBLE + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + def initialize: ( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?type: :S3_COMPATIBLE + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + end + + type cloudinary_backup = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :CLOUDINARY_BACKUP + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :CLOUDINARY_BACKUP + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type web_folder = + { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor name: String + + attr_accessor type: :WEB_FOLDER + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + name: String, + ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, + ?type: :WEB_FOLDER + ) -> void + + def to_hash: -> { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + end + + type web_proxy = + { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor type: :WEB_PROXY + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + name: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :WEB_PROXY + ) -> void + + def to_hash: -> { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + type google_cloud_storage_gcs = + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor name: String + + attr_accessor private_key: String + + attr_accessor type: :GCS + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + bucket: String, + client_email: String, + name: String, + private_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :GCS + ) -> void + + def to_hash: -> { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type azure_blob_storage = + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor name: String + + attr_accessor sas_token: String + + attr_accessor type: :AZURE_BLOB + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + account_name: String, + container: String, + name: String, + sas_token: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :AZURE_BLOB + ) -> void + + def to_hash: -> { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type akeneo_pim = + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor name: String + + attr_accessor password: String + + attr_accessor type: :AKENEO_PIM + + attr_accessor username: String + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :AKENEO_PIM + ) -> void + + def to_hash: -> { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::OriginCreateParams::origin] end end end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index 4e022678..921bd49d 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -2,30 +2,136 @@ module Imagekit module Models module Accounts type origin_update_params = - { body: Imagekit::Accounts::OriginUpdateParams::Body } + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :AKENEO_PIM, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + endpoint: String, + :s3_force_path_style => bool, + base_url: String, + forward_host_header_to_origin: bool, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String + } & Imagekit::Internal::Type::request_parameters class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor body: Imagekit::Accounts::OriginUpdateParams::Body + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :AKENEO_PIM + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_accessor endpoint: String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + attr_accessor base_url: String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_accessor client_email: String + + attr_accessor private_key: String + + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor sas_token: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor password: String + + attr_accessor username: String def initialize: ( - body: Imagekit::Accounts::OriginUpdateParams::Body, + access_key: String, + bucket: String, + name: String, + secret_key: String, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?forward_host_header_to_origin: bool, + ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> void def to_hash: -> { - body: Imagekit::Accounts::OriginUpdateParams::Body, + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :AKENEO_PIM, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + endpoint: String, + :s3_force_path_style => bool, + base_url: String, + forward_host_header_to_origin: bool, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, request_options: Imagekit::RequestOptions } - - type body = { } - - class Body < Imagekit::Internal::Type::BaseModel - def to_hash: -> { } - end end end end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index defab3ee..34fc0f00 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -3,13 +3,33 @@ module Imagekit class Accounts class Origins def create: ( - body: Imagekit::Accounts::OriginCreateParams::Body, + origin: Imagekit::Models::Accounts::OriginCreateParams::origin, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_create_response def update: ( String id, - body: Imagekit::Accounts::OriginUpdateParams::Body, + access_key: String, + bucket: String, + name: String, + secret_key: String, + endpoint: String, + base_url: String, + client_email: String, + private_key: String, + account_name: String, + container: String, + sas_token: String, + client_id: String, + client_secret: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?forward_host_header_to_origin: bool, + ?type: :AKENEO_PIM, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_update_response diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index d5093101..d36ac5f9 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -6,7 +6,16 @@ class Imagekit::Test::Resources::Accounts::OriginsTest < Imagekit::Test::Resourc def test_create_required_params skip("Prism tests are disabled") - response = @image_kit.accounts.origins.create(body: {name: "name", type: :S3}) + response = + @image_kit.accounts.origins.create( + origin: { + accessKey: "AKIATEST123", + bucket: "test-bucket", + name: "My S3 Origin", + secretKey: "secrettest123", + type: :S3 + } + ) assert_pattern do response => Imagekit::Models::Accounts::OriginCreateResponse @@ -29,7 +38,17 @@ def test_create_required_params def test_update_required_params skip("Prism tests are disabled") - response = @image_kit.accounts.origins.update("id", body: {name: "name", type: :S3}) + response = + @image_kit.accounts.origins.update( + "id", + base_url: "https://akeneo.company.com", + client_id: "akeneo-client-id", + client_secret: "akeneo-client-secret", + name: "US S3 Storage", + password: "strongpassword123", + type: :AKENEO_PIM, + username: "integration-user" + ) assert_pattern do response => Imagekit::Models::Accounts::OriginUpdateResponse From ff7768d2989da44aef632b4fea14180ae1bf70c9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 13:05:02 +0000 Subject: [PATCH 033/178] feat(api): manual updates --- .stats.yml | 2 +- .../models/accounts/origin_update_params.rb | 668 +++++++++--- lib/imagekit/models/file_update_params.rb | 495 ++++----- lib/imagekit/resources/accounts/origins.rb | 46 +- lib/imagekit/resources/files.rb | 20 +- .../models/accounts/origin_update_params.rbi | 958 +++++++++++++++--- rbi/imagekit/models/file_update_params.rbi | 860 +++++++++------- rbi/imagekit/resources/accounts/origins.rbi | 68 +- rbi/imagekit/resources/files.rbi | 52 +- .../models/accounts/origin_update_params.rbs | 545 ++++++++-- sig/imagekit/models/file_update_params.rbs | 353 ++++--- sig/imagekit/resources/accounts/origins.rbs | 22 +- sig/imagekit/resources/files.rbs | 9 +- .../resources/accounts/origins_test.rb | 14 +- 14 files changed, 2760 insertions(+), 1352 deletions(-) diff --git a/.stats.yml b/.stats.yml index 4fc82ca0..4f127f14 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-76afc867b06fdc43b339f2c7d19f25a46481b25e8264ca24ea43daa1ea9234fc.yml openapi_spec_hash: a1455d2ab02c48a14551362dd8ec2261 -config_hash: 396f0b1c74b8b5bc4dd6b5d87e374d90 +config_hash: c434cea5e670c34d574784866661bebd diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index 8c3a2942..bdc47c57 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -8,172 +8,554 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute access_key - # Access key for the bucket. + # @!attribute origin + # Schema for origin resources. # - # @return [String] - required :access_key, String, api_name: :accessKey + # @return [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] + required :origin, union: -> { Imagekit::Accounts::OriginUpdateParams::Origin } - # @!attribute bucket + # @!method initialize(origin:, request_options: {}) + # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin resources. # - # @return [String] - required :bucket, String + # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String + # Schema for origin resources. + module Origin + extend Imagekit::Internal::Type::Union - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey + variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3 } - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM + variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible } - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup } - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader + variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder } - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String + variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy } - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String + variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs } - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage } - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl + variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim } - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey - # @!attribute container - # - # @return [String] - required :container, String + # @!attribute type + # + # @return [Symbol, :S3] + required :type, const: :S3 - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :S3] + end - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey - # @!method initialize(access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param base_url [String] Akeneo instance base URL. - # - # @param client_email [String] - # - # @param private_key [String] - # - # @param account_name [String] - # - # @param container [String] - # - # @param sas_token [String] - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param type [Symbol, :AKENEO_PIM] - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, :S3_COMPATIBLE] + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :CLOUDINARY_BACKUP] + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. + # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_FOLDER] + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_PROXY] + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute type + # + # @return [Symbol, :GCS] + required :type, const: :GCS + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @param bucket [String] + # + # @param client_email [String] + # + # @param name [String] Display name of the origin. + # + # @param private_key [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :GCS] + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute type + # + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @param account_name [String] + # + # @param container [String] + # + # @param name [String] Display name of the origin. + # + # @param sas_token [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :AZURE_BLOB] + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute type + # + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + # @param base_url [String] Akeneo instance base URL. + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param name [String] Display name of the origin. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :AKENEO_PIM] + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim)] + end end end end diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index 659ee7a2..7efbdd37 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -7,272 +7,305 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute custom_coordinates - # 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. + # @!attribute update # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + # @return [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus, nil] + optional :update, union: -> { Imagekit::FileUpdateParams::Update } - # @!attribute custom_metadata - # 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. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - - # @!attribute description - # Optional text to describe the contents of the file. - # - # @return [String, nil] - optional :description, String - - # @!attribute extensions - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - # - # @return [Array, nil] - optional :extensions, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Extension] } - - # @!attribute remove_ai_tags - # 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. - # - # @return [Array, Symbol, :all, nil] - optional :remove_ai_tags, - union: -> { - Imagekit::FileUpdateParams::RemoveAITags - }, - api_name: :removeAITags - - # @!attribute tags - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute webhook_url - # 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 [String, nil] - optional :webhook_url, String, api_name: :webhookUrl - - # @!attribute publish - # Configure the publication status of a file and its versions. - # - # @return [Imagekit::Models::FileUpdateParams::Publish, nil] - optional :publish, -> { Imagekit::FileUpdateParams::Publish } - - # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams} for more details. - # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param description [String] Optional text to describe the contents of the file. - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. - # + # @!method initialize(update: nil, request_options: {}) + # @param update [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus] # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - module Extension + module Update extend Imagekit::Internal::Type::Union - discriminator :name - - variant :"remove-bg", -> { Imagekit::FileUpdateParams::Extension::RemoveBg } - - variant :"ai-auto-description", -> { Imagekit::FileUpdateParams::Extension::AIAutoDescription } + variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails } - variant -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension } + variant -> { Imagekit::FileUpdateParams::Update::ChangePublicationStatus } - class RemoveBg < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + # @!attribute custom_coordinates + # 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. # - # @return [Symbol, :"remove-bg"] - required :name, const: :"remove-bg" + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - # @!attribute options + # @!attribute custom_metadata + # 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. # - # @return [Imagekit::Models::FileUpdateParams::Extension::RemoveBg::Options, nil] - optional :options, -> { Imagekit::FileUpdateParams::Extension::RemoveBg::Options } + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata - # @!method initialize(options: nil, name: :"remove-bg") - # @param options [Imagekit::Models::FileUpdateParams::Extension::RemoveBg::Options] + # @!attribute description + # Optional text to describe the contents of the file. # - # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. - - # @see Imagekit::Models::FileUpdateParams::Extension::RemoveBg#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String + # @return [String, nil] + optional :description, String - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Extension::RemoveBg::Options} for more - # details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. + # @!attribute extensions + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags + # @return [Array, nil] + optional :extensions, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension] } - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. + # @!attribute remove_ai_tags + # An array of AITags associated with the file that you want to remove, e.g. + # `["car", "vehicle", "motorsports"]`. # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. + # If you want to remove all AITags associated with the file, send a string - + # "all". # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] - required :name, enum: -> { Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name } + # Note: The remove operation for `AITags` executes before any of the `extensions` + # are processed. + # + # @return [Array, Symbol, :all, nil] + optional :remove_ai_tags, + union: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags }, + api_name: :removeAITags + + # @!attribute tags + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails} for more + # details. + # + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # @param description [String] Optional text to describe the contents of the file. # - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + + module Extension + extend Imagekit::Internal::Type::Union + + discriminator :name + + variant :"remove-bg", -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg } + + variant :"ai-auto-description", + -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription } + + variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension } + + class RemoveBg < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, :"remove-bg"] + required :name, const: :"remove-bg" + + # @!attribute options + # + # @return [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options, nil] + optional :options, + -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options } + + # @!method initialize(options: nil, name: :"remove-bg") + # @param options [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options] + # + # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. + + # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options} + # for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name] + required :name, + enum: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, :"ai-auto-description"] + required :name, const: :"ai-auto-description" + + # @!method initialize(name: :"ai-auto-description") + # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. + end + + # @!method self.variants + # @return [Array(Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension)] + end - # Specifies the auto-tagging extension used. + # 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". # - # @see Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum + # Note: The remove operation for `AITags` executes before any of the `extensions` + # are processed. + # + # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails#remove_ai_tags + module RemoveAITags + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::StringArray } - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" + variant const: :all - # @!method self.values - # @return [Array] + # @!method self.variants + # @return [Array(Array, Symbol, :all)] + + # @type [Imagekit::Internal::Type::Converter] + StringArray = Imagekit::Internal::Type::ArrayOf[String] end end - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + # @!attribute publish + # Configure the publication status of a file and its versions. # - # @return [Symbol, :"ai-auto-description"] - required :name, const: :"ai-auto-description" - - # @!method initialize(name: :"ai-auto-description") - # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. - end + # @return [Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish, nil] + optional :publish, -> { Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish } - # @!method self.variants - # @return [Array(Imagekit::Models::FileUpdateParams::Extension::RemoveBg, Imagekit::Models::FileUpdateParams::Extension::AIAutoDescription, Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension)] - end + # @!method initialize(publish: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus} for more + # details. + # + # @param publish [Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union + # @see Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus#publish + class Publish < Imagekit::Internal::Type::BaseModel + # @!attribute is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @return [Boolean] + required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - variant -> { Imagekit::Models::FileUpdateParams::RemoveAITags::StringArray } + # @!attribute include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + # + # @return [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions - variant const: :all + # @!method initialize(is_published:, include_file_versions: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish} + # for more details. + # + # Configure the publication status of a file and its versions. + # + # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p + end + end # @!method self.variants - # @return [Array(Array, Symbol, :all)] - - # @type [Imagekit::Internal::Type::Converter] - StringArray = Imagekit::Internal::Type::ArrayOf[String] - end - - class Publish < Imagekit::Internal::Type::BaseModel - # @!attribute is_published - # Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @return [Boolean] - required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute include_file_versions - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - # - # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions - - # @!method initialize(is_published:, include_file_versions: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Publish} for more details. - # - # Configure the publication status of a file and its versions. - # - # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p + # @return [Array(Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus)] end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index d0046767..2af136b6 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -33,51 +33,11 @@ def create(params) # **Note:** This API is currently in beta. # Updates the origin identified by `id` and returns the updated origin object. # - # @overload update(id, access_key:, bucket:, name:, secret_key:, endpoint:, base_url:, client_email:, private_key:, account_name:, container:, sas_token:, client_id:, client_secret:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, forward_host_header_to_origin: nil, type: :AKENEO_PIM, request_options: {}) + # @overload update(id, origin:, request_options: {}) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param base_url [String] Akeneo instance base URL. - # - # @param client_email [String] - # - # @param private_key [String] - # - # @param account_name [String] - # - # @param container [String] - # - # @param sas_token [String] - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param type [Symbol, :AKENEO_PIM] + # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -89,7 +49,7 @@ def update(id, params) @client.request( method: :put, path: ["v1/accounts/origins/%1$s", id], - body: parsed, + body: parsed[:origin], model: Imagekit::Models::Accounts::OriginUpdateResponse, options: options ) diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index be7c1626..4298e6ea 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -19,25 +19,11 @@ class Files # You can update `tags`, `customCoordinates`, `customMetadata`, publication # status, remove existing `AITags` and apply extensions using this API. # - # @overload update(file_id, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) + # @overload update(file_id, update: nil, request_options: {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param description [String] Optional text to describe the contents of the file. - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. + # @param update [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus] # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -49,7 +35,7 @@ def update(file_id, params = {}) @client.request( method: :patch, path: ["v1/files/%1$s/details", file_id], - body: parsed, + body: parsed[:update], model: Imagekit::Models::FileUpdateResponse, options: options ) diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index d5ad1e3b..299bb528 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -15,191 +15,833 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key + # Schema for origin resources. + sig do + returns( + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, + Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim + ) + ) + end + attr_accessor :origin - sig { returns(String) } - attr_accessor :bucket + sig do + params( + origin: + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for origin resources. + origin:, + request_options: {} + ) + end - # Display name of the origin. - sig { returns(String) } - attr_accessor :name + sig do + override.returns( + { + origin: + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, + Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim + ), + request_options: Imagekit::RequestOptions + } + ) + end + def to_hash + end - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key + # Schema for origin resources. + module Origin + extend Imagekit::Internal::Type::Union - sig { returns(Symbol) } - attr_accessor :type + Variants = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, + Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim + ) + end - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3, + Imagekit::Internal::AnyHash + ) + end - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header + # Display name of the origin. + sig { returns(String) } + attr_accessor :name - sig { returns(T.nilable(String)) } - attr_reader :prefix + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key - sig { params(prefix: String).void } - attr_writer :prefix + sig { returns(Symbol) } + attr_accessor :type - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin + sig { params(prefix: String).void } + attr_writer :prefix - sig { returns(String) } - attr_accessor :client_email + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :S3 + ) + end - sig { returns(String) } - attr_accessor :private_key + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end - sig { returns(String) } - attr_accessor :account_name + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, + Imagekit::Internal::AnyHash + ) + end - sig { returns(String) } - attr_accessor :container + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key - sig { returns(String) } - attr_accessor :sas_token + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret + # Display name of the origin. + sig { returns(String) } + attr_accessor :name - # Akeneo API password. - sig { returns(String) } - attr_accessor :password + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key - # Akeneo API username. - sig { returns(String) } - attr_accessor :username + sig { returns(Symbol) } + attr_accessor :type - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - forward_host_header_to_origin: T::Boolean, - type: Symbol, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # Custom S3-compatible endpoint. - endpoint:, - # Akeneo instance base URL. - base_url:, - client_email:, - private_key:, - account_name:, - container:, - sas_token:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - type: :AKENEO_PIM, - request_options: {} - ) - end + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - endpoint: String, - s3_force_path_style: T::Boolean, - base_url: String, - forward_host_header_to_origin: T::Boolean, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig do + params( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + type: :S3_COMPATIBLE + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean + } + ) + end + def to_hash + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :CLOUDINARY_BACKUP + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(String) } + attr_accessor :base_url + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + name: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Root URL for the web folder origin. + base_url:, + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_FOLDER + ) + end + + sig do + override.returns( + { + base_url: String, + name: String, + type: Symbol, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + name: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_PROXY + ) + end + + sig do + override.returns( + { + name: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + bucket: String, + client_email: String, + name: String, + private_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + bucket:, + client_email:, + # Display name of the origin. + name:, + private_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :GCS + ) + end + + sig do + override.returns( + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :sas_token + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + account_name: String, + container: String, + name: String, + sas_token: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + account_name:, + container:, + # Display name of the origin. + name:, + sas_token:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :AZURE_BLOB + ) + end + + sig do + override.returns( + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + sig { returns(Symbol) } + attr_accessor :type + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Akeneo instance base URL. + base_url:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Display name of the origin. + name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :AKENEO_PIM + ) + end + + sig do + override.returns( + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: Symbol, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + sig do + override.returns( + T::Array[Imagekit::Accounts::OriginUpdateParams::Origin::Variants] + ) + end + def self.variants + end end end end diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index 3da6056a..bbe71faf 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -11,168 +11,50 @@ module Imagekit T.any(Imagekit::FileUpdateParams, Imagekit::Internal::AnyHash) end - # 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. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # 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. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Optional text to describe the contents of the file. - sig { returns(T.nilable(String)) } - attr_reader :description - - sig { params(description: String).void } - attr_writer :description - - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. sig do returns( T.nilable( - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemoveBg, - Imagekit::FileUpdateParams::Extension::AIAutoDescription, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension - ) - ] + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus + ) ) ) end - attr_reader :extensions + attr_reader :update sig do params( - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemoveBg::OrHash, - Imagekit::FileUpdateParams::Extension::AIAutoDescription::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash - ) - ] + update: + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash + ) ).void end - attr_writer :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. - sig { returns(T.nilable(T.any(T::Array[String], Symbol))) } - attr_reader :remove_ai_tags - - sig { params(remove_ai_tags: T.any(T::Array[String], Symbol)).void } - attr_writer :remove_ai_tags - - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :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. - sig { returns(T.nilable(String)) } - attr_reader :webhook_url - - sig { params(webhook_url: String).void } - attr_writer :webhook_url - - # Configure the publication status of a file and its versions. - sig { returns(T.nilable(Imagekit::FileUpdateParams::Publish)) } - attr_reader :publish - - sig { params(publish: Imagekit::FileUpdateParams::Publish::OrHash).void } - attr_writer :publish + attr_writer :update sig do params( - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemoveBg::OrHash, - Imagekit::FileUpdateParams::Extension::AIAutoDescription::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish::OrHash, + update: + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash + ), request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new( - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, - # Configure the publication status of a file and its versions. - publish: nil, - request_options: {} - ) + def self.new(update: nil, request_options: {}) end sig do override.returns( { - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemoveBg, - Imagekit::FileUpdateParams::Extension::AIAutoDescription, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish, + update: + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus + ), request_options: Imagekit::RequestOptions } ) @@ -180,354 +62,594 @@ module Imagekit def to_hash end - module Extension + module Update extend Imagekit::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemoveBg, - Imagekit::FileUpdateParams::Extension::AIAutoDescription, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension + Imagekit::FileUpdateParams::Update::UpdateFileDetails, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus ) end - class RemoveBg < Imagekit::Internal::Type::BaseModel + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemoveBg, + Imagekit::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Internal::AnyHash ) end - # Specifies the background removal extension. - sig { returns(Symbol) } - attr_accessor :name + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. sig do returns( T.nilable( - Imagekit::FileUpdateParams::Extension::RemoveBg::Options + T::Array[ + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension + ) + ] ) ) end - attr_reader :options + attr_reader :extensions sig do params( - options: - Imagekit::FileUpdateParams::Extension::RemoveBg::Options::OrHash + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::OrHash, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription::OrHash, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::OrHash + ) + ] ).void end - attr_writer :options + attr_writer :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. + sig { returns(T.nilable(T.any(T::Array[String], Symbol))) } + attr_reader :remove_ai_tags + + sig { params(remove_ai_tags: T.any(T::Array[String], Symbol)).void } + attr_writer :remove_ai_tags + + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url sig do params( - options: - Imagekit::FileUpdateParams::Extension::RemoveBg::Options::OrHash, - name: Symbol + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::OrHash, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription::OrHash, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::OrHash + ) + ], + remove_ai_tags: T.any(T::Array[String], Symbol), + tags: T.nilable(T::Array[String]), + webhook_url: String ).returns(T.attached_class) end def self.new( - options: nil, - # Specifies the background removal extension. - name: :"remove-bg" + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil ) end sig do override.returns( { - name: Symbol, - options: - Imagekit::FileUpdateParams::Extension::RemoveBg::Options + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension + ) + ], + remove_ai_tags: T.any(T::Array[String], Symbol), + tags: T.nilable(T::Array[String]), + webhook_url: String } ) end def to_hash end - class Options < Imagekit::Internal::Type::BaseModel - OrHash = + module Extension + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::RemoveBg::Options, - Imagekit::Internal::AnyHash + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension ) end - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow + class RemoveBg < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig { returns(Symbol) } + attr_accessor :name + + sig do + returns( + T.nilable( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options + ) + ) + end + attr_reader :options - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow + sig do + params( + options: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + options: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options::OrHash, + name: Symbol + ).returns(T.attached_class) + end + def self.new( + options: nil, + # Specifies the background removal extension. + name: :"remove-bg" + ) + end - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color + sig do + override.returns( + { + name: Symbol, + options: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options + } + ) + end + def to_hash + end - sig { params(bg_color: String).void } - attr_writer :bg_color + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig { returns(Symbol) } + attr_accessor :name + + sig { params(name: Symbol).returns(T.attached_class) } + def self.new( + # Specifies the auto description extension. + name: :"ai-auto-description" + ) + end + + sig { override.returns({ name: Symbol }) } + def to_hash + end + end sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) + override.returns( + T::Array[ + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::Variants + ] + ) end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) + def self.variants end + end + + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(T::Array[String], Symbol) } sig do override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } + T::Array[ + Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::Variants + ] ) end - def to_hash + def self.variants end + + StringArray = + T.let( + Imagekit::Internal::Type::ArrayOf[String], + Imagekit::Internal::Type::Converter + ) end end - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus, Imagekit::Internal::AnyHash ) end - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. + # Configure the publication status of a file and its versions. sig do returns( - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + T.nilable( + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + ) ) end - attr_accessor :name + attr_reader :publish + + sig do + params( + publish: + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish::OrHash + ).void + end + attr_writer :publish sig do params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + publish: + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish::OrHash ).returns(T.attached_class) end def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: + # Configure the publication status of a file and its versions. + publish: nil ) end sig do override.returns( { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::OrSymbol + publish: + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish } ) end def to_hash end - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = + class Publish < Imagekit::Internal::Type::BaseModel + OrHash = T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name + T.any( + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish, + Imagekit::Internal::AnyHash ) end - OrSymbol = T.type_alias { T.any(Symbol, String) } - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) + # Set to `true` to publish the file. Set to `false` to unpublish the file. + sig { returns(T::Boolean) } + attr_accessor :is_published + + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions + + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions + # Configure the publication status of a file and its versions. sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) + params( + is_published: T::Boolean, + include_file_versions: T::Boolean + ).returns(T.attached_class) end - def self.values + def self.new( + # Set to `true` to publish the file. Set to `false` to unpublish the file. + is_published:, + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + include_file_versions: nil + ) end - end - end - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Extension::AIAutoDescription, - Imagekit::Internal::AnyHash + sig do + override.returns( + { is_published: T::Boolean, include_file_versions: T::Boolean } ) end - - # Specifies the auto description extension. - sig { returns(Symbol) } - attr_accessor :name - - sig { params(name: Symbol).returns(T.attached_class) } - def self.new( - # Specifies the auto description extension. - name: :"ai-auto-description" - ) - end - - sig { override.returns({ name: Symbol }) } - def to_hash + def to_hash + end end end sig do override.returns( - T::Array[Imagekit::FileUpdateParams::Extension::Variants] - ) - end - def self.variants - end - end - - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(T::Array[String], Symbol) } - - sig do - override.returns( - T::Array[Imagekit::FileUpdateParams::RemoveAITags::Variants] + T::Array[Imagekit::FileUpdateParams::Update::Variants] ) end def self.variants end - - StringArray = - T.let( - Imagekit::Internal::Type::ArrayOf[String], - Imagekit::Internal::Type::Converter - ) - end - - class Publish < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Publish, - Imagekit::Internal::AnyHash - ) - end - - # Set to `true` to publish the file. Set to `false` to unpublish the file. - sig { returns(T::Boolean) } - attr_accessor :is_published - - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_file_versions - - sig { params(include_file_versions: T::Boolean).void } - attr_writer :include_file_versions - - # Configure the publication status of a file and its versions. - sig do - params( - is_published: T::Boolean, - include_file_versions: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Set to `true` to publish the file. Set to `false` to unpublish the file. - is_published:, - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - include_file_versions: nil - ) - end - - sig do - override.returns( - { is_published: T::Boolean, include_file_versions: T::Boolean } - ) - end - def to_hash - end end end end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index 48eef32b..78a702b5 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -34,27 +34,17 @@ module Imagekit sig do params( id: String, - access_key: String, - bucket: String, - name: String, - secret_key: String, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - forward_host_header_to_origin: T::Boolean, - type: Symbol, + origin: + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash + ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginUpdateResponse::Variants) end @@ -62,40 +52,8 @@ module Imagekit # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. id, - # Access key for the bucket. - access_key:, - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # Custom S3-compatible endpoint. - endpoint:, - # Akeneo instance base URL. - base_url:, - client_email:, - private_key:, - account_name:, - container:, - sas_token:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - type: :AKENEO_PIM, + # Schema for origin resources. + origin:, request_options: {} ) end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index d637ea8d..101a3ace 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -18,21 +18,11 @@ module Imagekit sig do params( file_id: String, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::FileUpdateParams::Extension::RemoveBg::OrHash, - Imagekit::FileUpdateParams::Extension::AIAutoDescription::OrHash, - Imagekit::FileUpdateParams::Extension::AutoTaggingExtension::OrHash - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish::OrHash, + update: + T.any( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash + ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::FileUpdateResponse) end @@ -40,37 +30,7 @@ module Imagekit # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. file_id, - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, - # Configure the publication status of a file and its versions. - publish: nil, + update: nil, request_options: {} ) end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index 921bd49d..1ab3f5f6 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -2,136 +2,487 @@ module Imagekit module Models module Accounts type origin_update_params = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - endpoint: String, - :s3_force_path_style => bool, - base_url: String, - forward_host_header_to_origin: bool, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String - } + { origin: Imagekit::Models::Accounts::OriginUpdateParams::origin } & Imagekit::Internal::Type::request_parameters class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor access_key: String + attr_accessor origin: Imagekit::Models::Accounts::OriginUpdateParams::origin - attr_accessor bucket: String + def initialize: ( + origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, + ?request_options: Imagekit::request_opts + ) -> void - attr_accessor name: String + def to_hash: -> { + origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, + request_options: Imagekit::RequestOptions + } - attr_accessor secret_key: String + type origin = + Imagekit::Accounts::OriginUpdateParams::Origin::S3 + | Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible + | Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup + | Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder + | Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy + | Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs + | Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage + | Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - attr_accessor type: :AKENEO_PIM + module Origin + extend Imagekit::Internal::Type::Union - attr_reader base_url_for_canonical_header: String? + type s3 = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } - def base_url_for_canonical_header=: (String) -> String + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String - attr_reader include_canonical_header: bool? + attr_accessor bucket: String - def include_canonical_header=: (bool) -> bool + attr_accessor name: String - attr_reader prefix: String? + attr_accessor secret_key: String - def prefix=: (String) -> String + attr_accessor type: :S3 - attr_accessor endpoint: String + attr_reader base_url_for_canonical_header: String? - attr_reader s3_force_path_style: bool? + def base_url_for_canonical_header=: (String) -> String - def s3_force_path_style=: (bool) -> bool + attr_reader include_canonical_header: bool? - attr_accessor base_url: String + def include_canonical_header=: (bool) -> bool - attr_reader forward_host_header_to_origin: bool? + attr_reader prefix: String? - def forward_host_header_to_origin=: (bool) -> bool + def prefix=: (String) -> String - attr_accessor client_email: String + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :S3 + ) -> void - attr_accessor private_key: String + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end - attr_accessor account_name: String + type s3_compatible = + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } - attr_accessor container: String + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String - attr_accessor sas_token: String + attr_accessor bucket: String - attr_accessor client_id: String + attr_accessor endpoint: String - attr_accessor client_secret: String + attr_accessor name: String - attr_accessor password: String + attr_accessor secret_key: String - attr_accessor username: String + attr_accessor type: :S3_COMPATIBLE - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?forward_host_header_to_origin: bool, - ?type: :AKENEO_PIM, - ?request_options: Imagekit::request_opts - ) -> void + attr_reader base_url_for_canonical_header: String? - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - endpoint: String, - :s3_force_path_style => bool, - base_url: String, - forward_host_header_to_origin: bool, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - request_options: Imagekit::RequestOptions - } + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + def initialize: ( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?type: :S3_COMPATIBLE + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + end + + type cloudinary_backup = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :CLOUDINARY_BACKUP + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :CLOUDINARY_BACKUP + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type web_folder = + { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor name: String + + attr_accessor type: :WEB_FOLDER + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + name: String, + ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, + ?type: :WEB_FOLDER + ) -> void + + def to_hash: -> { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + end + + type web_proxy = + { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor type: :WEB_PROXY + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + name: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :WEB_PROXY + ) -> void + + def to_hash: -> { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + type google_cloud_storage_gcs = + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor name: String + + attr_accessor private_key: String + + attr_accessor type: :GCS + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + bucket: String, + client_email: String, + name: String, + private_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :GCS + ) -> void + + def to_hash: -> { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type azure_blob_storage = + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor name: String + + attr_accessor sas_token: String + + attr_accessor type: :AZURE_BLOB + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + account_name: String, + container: String, + name: String, + sas_token: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :AZURE_BLOB + ) -> void + + def to_hash: -> { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type akeneo_pim = + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor name: String + + attr_accessor password: String + + attr_accessor type: :AKENEO_PIM + + attr_accessor username: String + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :AKENEO_PIM + ) -> void + + def to_hash: -> { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::OriginUpdateParams::origin] + end end end end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index 0a0678c9..3ffb7254 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -1,230 +1,271 @@ module Imagekit module Models type file_update_params = - { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], - remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish - } + { update: Imagekit::Models::FileUpdateParams::update } & Imagekit::Internal::Type::request_parameters class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader extensions: ::Array[Imagekit::Models::FileUpdateParams::extension]? - - def extensions=: ( - ::Array[Imagekit::Models::FileUpdateParams::extension] - ) -> ::Array[Imagekit::Models::FileUpdateParams::extension] - - attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags? + attr_reader update: Imagekit::Models::FileUpdateParams::update? - def remove_ai_tags=: ( - Imagekit::Models::FileUpdateParams::remove_ai_tags - ) -> Imagekit::Models::FileUpdateParams::remove_ai_tags - - attr_accessor tags: ::Array[String]? - - attr_reader webhook_url: String? - - def webhook_url=: (String) -> String - - attr_reader publish: Imagekit::FileUpdateParams::Publish? - - def publish=: ( - Imagekit::FileUpdateParams::Publish - ) -> Imagekit::FileUpdateParams::Publish + def update=: ( + Imagekit::Models::FileUpdateParams::update + ) -> Imagekit::Models::FileUpdateParams::update def initialize: ( - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], - ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, - ?publish: Imagekit::FileUpdateParams::Publish, + ?update: Imagekit::Models::FileUpdateParams::update, ?request_options: Imagekit::request_opts ) -> void def to_hash: -> { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], - remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish, + update: Imagekit::Models::FileUpdateParams::update, request_options: Imagekit::RequestOptions } - type extension = - Imagekit::FileUpdateParams::Extension::RemoveBg - | Imagekit::FileUpdateParams::Extension::AIAutoDescription - | Imagekit::FileUpdateParams::Extension::AutoTaggingExtension + type update = + Imagekit::FileUpdateParams::Update::UpdateFileDetails + | Imagekit::FileUpdateParams::Update::ChangePublicationStatus - module Extension + module Update extend Imagekit::Internal::Type::Union - type remove_bg = + type update_file_details = { - name: :"remove-bg", - options: Imagekit::FileUpdateParams::Extension::RemoveBg::Options + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String } - class RemoveBg < Imagekit::Internal::Type::BaseModel - attr_accessor name: :"remove-bg" + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? - attr_reader options: Imagekit::FileUpdateParams::Extension::RemoveBg::Options? + def description=: (String) -> String - def options=: ( - Imagekit::FileUpdateParams::Extension::RemoveBg::Options - ) -> Imagekit::FileUpdateParams::Extension::RemoveBg::Options + attr_reader extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension]? + + def extensions=: ( + ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] + ) -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] + + attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags? + + def remove_ai_tags=: ( + Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags + ) -> Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags + + attr_accessor tags: ::Array[String]? + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String def initialize: ( - ?options: Imagekit::FileUpdateParams::Extension::RemoveBg::Options, - ?name: :"remove-bg" + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + ?remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String ) -> void def to_hash: -> { - name: :"remove-bg", - options: Imagekit::FileUpdateParams::Extension::RemoveBg::Options + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String } - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } + type extension = + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg + | Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription + | Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? + module Extension + extend Imagekit::Internal::Type::Union - def add_shadow=: (bool) -> bool + type remove_bg = + { + name: :"remove-bg", + options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options + } - attr_reader bg_color: String? + class RemoveBg < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"remove-bg" - def bg_color=: (String) -> String + attr_reader options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options? - attr_reader bg_image_url: String? + def options=: ( + Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options + ) -> Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options - def bg_image_url=: (String) -> String + def initialize: ( + ?options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options, + ?name: :"remove-bg" + ) -> void - attr_reader semitransparency: bool? + def to_hash: -> { + name: :"remove-bg", + options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options + } - def semitransparency=: (bool) -> bool + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end + def add_shadow=: (bool) -> bool - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - } + attr_reader bg_color: String? - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer + def bg_color=: (String) -> String - attr_accessor min_confidence: Integer + attr_reader bg_image_url: String? - attr_accessor name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ + def bg_image_url=: (String) -> String - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - ) -> void + attr_reader semitransparency: bool? - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_ - } + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ + ) -> void - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ + } - module Name - extend Imagekit::Internal::Type::Enum + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" + module Name + extend Imagekit::Internal::Type::Enum - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Extension::AutoTaggingExtension::name_] + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_] + end + end + + type ai_auto_description = { name: :"ai-auto-description" } + + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"ai-auto-description" + + def initialize: (?name: :"ai-auto-description") -> void + + def to_hash: -> { name: :"ai-auto-description" } + end + + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] end - end - type ai_auto_description = { name: :"ai-auto-description" } + type remove_ai_tags = ::Array[String] | :all - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - attr_accessor name: :"ai-auto-description" + module RemoveAITags + extend Imagekit::Internal::Type::Union - def initialize: (?name: :"ai-auto-description") -> void + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags] - def to_hash: -> { name: :"ai-auto-description" } + StringArray: Imagekit::Internal::Type::Converter + end end - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::extension] - end + type change_publication_status = + { + publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + } - type remove_ai_tags = ::Array[String] | :all + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + attr_reader publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish? - module RemoveAITags - extend Imagekit::Internal::Type::Union + def publish=: ( + Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + ) -> Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::remove_ai_tags] + def initialize: ( + ?publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + ) -> void - StringArray: Imagekit::Internal::Type::Converter - end + def to_hash: -> { + publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + } - type publish = { is_published: bool, include_file_versions: bool } + type publish = { is_published: bool, include_file_versions: bool } - class Publish < Imagekit::Internal::Type::BaseModel - attr_accessor is_published: bool + class Publish < Imagekit::Internal::Type::BaseModel + attr_accessor is_published: bool - attr_reader include_file_versions: bool? + attr_reader include_file_versions: bool? - def include_file_versions=: (bool) -> bool + def include_file_versions=: (bool) -> bool - def initialize: ( - is_published: bool, - ?include_file_versions: bool - ) -> void + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void + + def to_hash: -> { is_published: bool, include_file_versions: bool } + end + end - def to_hash: -> { is_published: bool, include_file_versions: bool } + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::update] end end end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index 34fc0f00..2503c671 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -9,27 +9,7 @@ module Imagekit def update: ( String id, - access_key: String, - bucket: String, - name: String, - secret_key: String, - endpoint: String, - base_url: String, - client_email: String, - private_key: String, - account_name: String, - container: String, - sas_token: String, - client_id: String, - client_secret: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?forward_host_header_to_origin: bool, - ?type: :AKENEO_PIM, + origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_update_response diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index d47cd3f2..f4a55fa5 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -9,14 +9,7 @@ module Imagekit def update: ( String file_id, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: ::Array[Imagekit::Models::FileUpdateParams::extension], - ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, - ?publish: Imagekit::FileUpdateParams::Publish, + ?update: Imagekit::Models::FileUpdateParams::update, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::FileUpdateResponse diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index d36ac5f9..82ef338d 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -41,13 +41,13 @@ def test_update_required_params response = @image_kit.accounts.origins.update( "id", - base_url: "https://akeneo.company.com", - client_id: "akeneo-client-id", - client_secret: "akeneo-client-secret", - name: "US S3 Storage", - password: "strongpassword123", - type: :AKENEO_PIM, - username: "integration-user" + origin: { + accessKey: "AKIATEST123", + bucket: "test-bucket", + name: "My S3 Origin", + secretKey: "secrettest123", + type: :S3 + } ) assert_pattern do From 972dc0f99117aa5f29308408266359af9196b2a1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 13:09:24 +0000 Subject: [PATCH 034/178] feat(api): manual updates --- .stats.yml | 4 +- lib/imagekit/internal/type/union.rb | 30 ++- .../models/accounts/origin_create_params.rb | 28 +- .../models/accounts/origin_create_response.rb | 30 +-- .../models/accounts/origin_get_response.rb | 30 +-- .../models/accounts/origin_list_response.rb | 29 ++- .../models/accounts/origin_update_params.rb | 28 +- .../models/accounts/origin_update_response.rb | 30 +-- .../accounts/url_endpoint_create_response.rb | 20 +- .../accounts/url_endpoint_get_response.rb | 20 +- .../accounts/url_endpoint_list_response.rb | 21 +- .../accounts/url_endpoint_update_response.rb | 20 +- lib/imagekit/resources/accounts/origins.rb | 12 +- .../models/accounts/origin_create_params.rbi | 24 +- .../accounts/origin_create_response.rbi | 12 +- .../models/accounts/origin_get_response.rbi | 12 +- .../models/accounts/origin_list_response.rbi | 12 +- .../models/accounts/origin_update_params.rbi | 24 +- .../accounts/origin_update_response.rbi | 12 +- .../accounts/url_endpoint_create_response.rbi | 30 +-- .../accounts/url_endpoint_get_response.rbi | 30 +-- .../accounts/url_endpoint_list_response.rbi | 30 +-- .../accounts/url_endpoint_update_response.rbi | 30 +-- rbi/imagekit/resources/accounts/origins.rbi | 8 +- .../models/accounts/origin_create_params.rbs | 12 +- .../accounts/origin_create_response.rbs | 12 +- .../models/accounts/origin_get_response.rbs | 12 +- .../models/accounts/origin_list_response.rbs | 12 +- .../models/accounts/origin_update_params.rbs | 12 +- .../accounts/origin_update_response.rbs | 12 +- .../accounts/url_endpoint_create_response.rbs | 18 +- .../accounts/url_endpoint_get_response.rbs | 18 +- .../accounts/url_endpoint_list_response.rbs | 18 +- .../accounts/url_endpoint_update_response.rbs | 18 +- .../resources/accounts/origins_test.rb | 246 +++++++++++++++++- 35 files changed, 588 insertions(+), 328 deletions(-) diff --git a/.stats.yml b/.stats.yml index 4f127f14..61a94110 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-76afc867b06fdc43b339f2c7d19f25a46481b25e8264ca24ea43daa1ea9234fc.yml -openapi_spec_hash: a1455d2ab02c48a14551362dd8ec2261 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-4bc3e70493ee36b6dd29a92334f55232a5429d1bf03139d1f072f854c3ba5a6e.yml +openapi_spec_hash: 9b8384f2a421b73c3f03d1ca84c26113 config_hash: c434cea5e670c34d574784866661bebd diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb index bd79904f..9b6baee9 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekit/internal/type/union.rb @@ -6,16 +6,28 @@ module Type # @api private # # @example - # # `unsafe_unwrap_webhook_event` is a `Imagekit::UnsafeUnwrapWebhookEvent` - # case unsafe_unwrap_webhook_event - # when Imagekit::VideoTransformationAcceptedWebhookEvent - # puts(unsafe_unwrap_webhook_event.id) - # when Imagekit::VideoTransformationReadyWebhookEvent - # puts(unsafe_unwrap_webhook_event.created_at) - # when Imagekit::VideoTransformationErrorWebhookEvent - # puts(unsafe_unwrap_webhook_event.data) + # # `origin_create_response` is a `Imagekit::Models::Accounts::OriginCreateResponse` + # case origin_create_response + # when Imagekit::Models::Accounts::OriginCreateResponse::S3 + # puts(origin_create_response.id) + # when Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible + # puts(origin_create_response.bucket) + # when Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup + # puts(origin_create_response.include_canonical_header) # else - # puts(unsafe_unwrap_webhook_event) + # puts(origin_create_response) + # end + # + # @example + # case origin_create_response + # in {type: :S3, id: id, bucket: bucket, include_canonical_header: include_canonical_header} + # puts(id) + # in {type: :S3_COMPATIBLE, id: id, bucket: bucket, endpoint: endpoint} + # puts(bucket) + # in {type: :CLOUDINARY_BACKUP, id: id, bucket: bucket, include_canonical_header: include_canonical_header} + # puts(include_canonical_header) + # else + # puts(origin_create_response) # end module Union include Imagekit::Internal::Type::Converter diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index 66343a66..d91d1635 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -11,11 +11,11 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel # @!attribute origin # Schema for origin resources. # - # @return [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] required :origin, union: -> { Imagekit::Accounts::OriginCreateParams::Origin } # @!method initialize(origin:, request_options: {}) - # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin resources. + # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] @@ -23,21 +23,23 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel module Origin extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Accounts::OriginCreateParams::Origin::S3 } + discriminator :type - variant -> { Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible } + variant :S3, -> { Imagekit::Accounts::OriginCreateParams::Origin::S3 } - variant -> { Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible } - variant -> { Imagekit::Accounts::OriginCreateParams::Origin::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup } - variant -> { Imagekit::Accounts::OriginCreateParams::Origin::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginCreateParams::Origin::WebFolder } - variant -> { Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Accounts::OriginCreateParams::Origin::WebProxy } - variant -> { Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage } + variant :GCS, -> { Imagekit::Accounts::OriginCreateParams::Origin::Gcs } - variant -> { Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel # @!attribute access_key @@ -349,7 +351,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -413,7 +415,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -554,7 +556,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_create_response.rb b/lib/imagekit/models/accounts/origin_create_response.rb index 6ecd917b..01e0c545 100644 --- a/lib/imagekit/models/accounts/origin_create_response.rb +++ b/lib/imagekit/models/accounts/origin_create_response.rb @@ -9,21 +9,23 @@ module Accounts module OriginCreateResponse extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::S3 } + discriminator :type - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible } + variant :S3, -> { Imagekit::Models::Accounts::OriginCreateResponse::S3 } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage } + variant :GCS, -> { Imagekit::Models::Accounts::OriginCreateResponse::Gcs } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket @@ -359,7 +361,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -411,8 +413,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs} for - # more details. + # {Imagekit::Models::Accounts::OriginCreateResponse::Gcs} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -431,7 +432,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -483,8 +484,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage} for more - # details. + # {Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -562,7 +562,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_get_response.rb b/lib/imagekit/models/accounts/origin_get_response.rb index 448ba33e..f2faf7ad 100644 --- a/lib/imagekit/models/accounts/origin_get_response.rb +++ b/lib/imagekit/models/accounts/origin_get_response.rb @@ -9,21 +9,23 @@ module Accounts module OriginGetResponse extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::OriginGetResponse::S3 } + discriminator :type - variant -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible } + variant :S3, -> { Imagekit::Models::Accounts::OriginGetResponse::S3 } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage } + variant :GCS, -> { Imagekit::Models::Accounts::OriginGetResponse::Gcs } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket @@ -358,7 +360,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -410,8 +412,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs} for more - # details. + # {Imagekit::Models::Accounts::OriginGetResponse::Gcs} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -430,7 +431,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -482,8 +483,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage} for more - # details. + # {Imagekit::Models::Accounts::OriginGetResponse::AzureBlob} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -561,7 +561,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index 51131946..104d6194 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -7,21 +7,23 @@ module Accounts module OriginListResponseItem extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::S3 } + discriminator :type - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible } + variant :S3, -> { Imagekit::Models::Accounts::OriginListResponseItem::S3 } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage } + variant :GCS, -> { Imagekit::Models::Accounts::OriginListResponseItem::Gcs } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket @@ -358,7 +360,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -410,8 +412,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs} for - # more details. + # {Imagekit::Models::Accounts::OriginListResponseItem::Gcs} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -430,7 +431,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -482,7 +483,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage} for more + # {Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob} for more # details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create @@ -562,7 +563,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginListResponseItem::S3, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginListResponseItem::S3, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, Imagekit::Models::Accounts::OriginListResponseItem::Gcs, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim)] end # @type [Imagekit::Internal::Type::Converter] diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index bdc47c57..e2cd97cf 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -11,11 +11,11 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel # @!attribute origin # Schema for origin resources. # - # @return [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] required :origin, union: -> { Imagekit::Accounts::OriginUpdateParams::Origin } # @!method initialize(origin:, request_options: {}) - # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin resources. + # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] @@ -23,21 +23,23 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel module Origin extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3 } + discriminator :type - variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible } + variant :S3, -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3 } - variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible } - variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup } - variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder } - variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy } - variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage } + variant :GCS, -> { Imagekit::Accounts::OriginUpdateParams::Origin::Gcs } - variant -> { Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel # @!attribute access_key @@ -349,7 +351,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -413,7 +415,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -554,7 +556,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_update_response.rb b/lib/imagekit/models/accounts/origin_update_response.rb index d0416176..eae3c9c5 100644 --- a/lib/imagekit/models/accounts/origin_update_response.rb +++ b/lib/imagekit/models/accounts/origin_update_response.rb @@ -9,21 +9,23 @@ module Accounts module OriginUpdateResponse extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3 } + discriminator :type - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible } + variant :S3, -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3 } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage } + variant :GCS, -> { Imagekit::Models::Accounts::OriginUpdateResponse::Gcs } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket @@ -359,7 +361,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -411,8 +413,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs} for - # more details. + # {Imagekit::Models::Accounts::OriginUpdateResponse::Gcs} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -431,7 +432,7 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -483,8 +484,7 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage} for more - # details. + # {Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -562,7 +562,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/url_endpoint_create_response.rb b/lib/imagekit/models/accounts/url_endpoint_create_response.rb index b670f18a..bec8e174 100644 --- a/lib/imagekit/models/accounts/url_endpoint_create_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_create_response.rb @@ -29,7 +29,7 @@ class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter, nil] + # @return [Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai, nil] optional :url_rewriter, union: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter }, api_name: :urlRewriter @@ -58,7 +58,7 @@ class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. # Configuration for third-party URL rewriting. # @@ -66,13 +66,15 @@ class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel module URLRewriter extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter } + discriminator :type - variant -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter } + variant :CLOUDINARY, -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary } - variant -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter } + variant :IMGIX, -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + variant :AKAMAI, -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai } + + class Cloudinary < Imagekit::Internal::Type::BaseModel # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. # @@ -92,7 +94,7 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :CLOUDINARY] end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :IMGIX] @@ -102,7 +104,7 @@ class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :IMGIX] end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :AKAMAI] @@ -113,7 +115,7 @@ class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter)] + # @return [Array(Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai)] end end end diff --git a/lib/imagekit/models/accounts/url_endpoint_get_response.rb b/lib/imagekit/models/accounts/url_endpoint_get_response.rb index 9a28c444..07bbaea0 100644 --- a/lib/imagekit/models/accounts/url_endpoint_get_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_get_response.rb @@ -29,7 +29,7 @@ class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter, nil] + # @return [Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai, nil] optional :url_rewriter, union: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter }, api_name: :urlRewriter @@ -58,7 +58,7 @@ class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. # Configuration for third-party URL rewriting. # @@ -66,13 +66,15 @@ class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel module URLRewriter extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter } + discriminator :type - variant -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter } + variant :CLOUDINARY, -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary } - variant -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter } + variant :IMGIX, -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + variant :AKAMAI, -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai } + + class Cloudinary < Imagekit::Internal::Type::BaseModel # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. # @@ -92,7 +94,7 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :CLOUDINARY] end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :IMGIX] @@ -102,7 +104,7 @@ class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :IMGIX] end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :AKAMAI] @@ -113,7 +115,7 @@ class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter)] + # @return [Array(Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai)] end end end diff --git a/lib/imagekit/models/accounts/url_endpoint_list_response.rb b/lib/imagekit/models/accounts/url_endpoint_list_response.rb index 917c0369..1d8b7aae 100644 --- a/lib/imagekit/models/accounts/url_endpoint_list_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_list_response.rb @@ -28,7 +28,7 @@ class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter, nil] + # @return [Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai, nil] optional :url_rewriter, union: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter }, api_name: :urlRewriter @@ -57,7 +57,7 @@ class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai] Configuration for third-party URL rewriting. # Configuration for third-party URL rewriting. # @@ -65,13 +65,16 @@ class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel module URLRewriter extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter } + discriminator :type - variant -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter } + variant :CLOUDINARY, + -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary } - variant -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter } + variant :IMGIX, -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + variant :AKAMAI, -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai } + + class Cloudinary < Imagekit::Internal::Type::BaseModel # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. # @@ -91,7 +94,7 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :CLOUDINARY] end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :IMGIX] @@ -101,7 +104,7 @@ class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :IMGIX] end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :AKAMAI] @@ -112,7 +115,7 @@ class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter)] + # @return [Array(Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai)] end end diff --git a/lib/imagekit/models/accounts/url_endpoint_update_response.rb b/lib/imagekit/models/accounts/url_endpoint_update_response.rb index a2915c6f..ba87d374 100644 --- a/lib/imagekit/models/accounts/url_endpoint_update_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_update_response.rb @@ -29,7 +29,7 @@ class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter, nil] + # @return [Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai, nil] optional :url_rewriter, union: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter }, api_name: :urlRewriter @@ -58,7 +58,7 @@ class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. # Configuration for third-party URL rewriting. # @@ -66,13 +66,15 @@ class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel module URLRewriter extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter } + discriminator :type - variant -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter } + variant :CLOUDINARY, -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary } - variant -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter } + variant :IMGIX, -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + variant :AKAMAI, -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai } + + class Cloudinary < Imagekit::Internal::Type::BaseModel # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. # @@ -92,7 +94,7 @@ class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :CLOUDINARY] end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :IMGIX] @@ -102,7 +104,7 @@ class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :IMGIX] end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :AKAMAI] @@ -113,7 +115,7 @@ class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter)] + # @return [Array(Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai)] end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index 2af136b6..a7f4281e 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -9,11 +9,11 @@ class Origins # # @overload create(origin:, request_options: {}) # - # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin resources. + # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginCreateParams def create(params) @@ -37,11 +37,11 @@ def create(params) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin resources. + # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginUpdateParams def update(id, params) @@ -62,7 +62,7 @@ def update(id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::Accounts::OriginListParams def list(params = {}) @@ -111,7 +111,7 @@ def delete(id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginGetParams def get(id, params = {}) diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index 8a0edd57..0ab207a8 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -24,8 +24,8 @@ module Imagekit Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim ) ) @@ -41,8 +41,8 @@ module Imagekit Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob::OrHash, Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash @@ -65,8 +65,8 @@ module Imagekit Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim ), request_options: Imagekit::RequestOptions @@ -88,8 +88,8 @@ module Imagekit Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim ) end @@ -552,11 +552,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Internal::AnyHash ) end @@ -642,11 +642,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/origin_create_response.rbi b/rbi/imagekit/models/accounts/origin_create_response.rbi index aaf69d31..dc8ab505 100644 --- a/rbi/imagekit/models/accounts/origin_create_response.rbi +++ b/rbi/imagekit/models/accounts/origin_create_response.rbi @@ -15,8 +15,8 @@ module Imagekit Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginCreateResponse::Gcs, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim ) end @@ -451,11 +451,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Internal::AnyHash ) end @@ -539,11 +539,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/origin_get_response.rbi b/rbi/imagekit/models/accounts/origin_get_response.rbi index 56dd3259..acbc7270 100644 --- a/rbi/imagekit/models/accounts/origin_get_response.rbi +++ b/rbi/imagekit/models/accounts/origin_get_response.rbi @@ -15,8 +15,8 @@ module Imagekit Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginGetResponse::Gcs, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim ) end @@ -451,11 +451,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Internal::AnyHash ) end @@ -539,11 +539,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index 6e17786c..26f5914e 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -15,8 +15,8 @@ module Imagekit Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, + Imagekit::Models::Accounts::OriginListResponseItem::Gcs, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim ) end @@ -451,11 +451,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginListResponseItem::Gcs, Imagekit::Internal::AnyHash ) end @@ -539,11 +539,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index 299bb528..66a7c75e 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -24,8 +24,8 @@ module Imagekit Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim ) ) @@ -41,8 +41,8 @@ module Imagekit Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob::OrHash, Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash @@ -65,8 +65,8 @@ module Imagekit Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim ), request_options: Imagekit::RequestOptions @@ -88,8 +88,8 @@ module Imagekit Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim ) end @@ -552,11 +552,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Internal::AnyHash ) end @@ -642,11 +642,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/origin_update_response.rbi b/rbi/imagekit/models/accounts/origin_update_response.rbi index 80d6db77..6d07d92c 100644 --- a/rbi/imagekit/models/accounts/origin_update_response.rbi +++ b/rbi/imagekit/models/accounts/origin_update_response.rbi @@ -15,8 +15,8 @@ module Imagekit Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim ) end @@ -451,11 +451,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Internal::AnyHash ) end @@ -539,11 +539,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi index 872f62da..20f97a9c 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi @@ -41,9 +41,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary::OrHash, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix::OrHash, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai::OrHash ) ).void end @@ -64,9 +64,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary::OrHash, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix::OrHash, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai::OrHash ) ).returns(T.attached_class) end @@ -111,17 +111,17 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai ) end - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, Imagekit::Internal::AnyHash ) end @@ -155,11 +155,11 @@ module Imagekit end end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, Imagekit::Internal::AnyHash ) end @@ -176,11 +176,11 @@ module Imagekit end end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter, + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi index db774dc9..c50dc4fe 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi @@ -41,9 +41,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary::OrHash, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix::OrHash, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai::OrHash ) ).void end @@ -64,9 +64,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary::OrHash, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix::OrHash, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai::OrHash ) ).returns(T.attached_class) end @@ -111,17 +111,17 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai ) end - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, Imagekit::Internal::AnyHash ) end @@ -155,11 +155,11 @@ module Imagekit end end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, Imagekit::Internal::AnyHash ) end @@ -176,11 +176,11 @@ module Imagekit end end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter, + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi index 3b857f7d..23c9e464 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi @@ -41,9 +41,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary::OrHash, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix::OrHash, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai::OrHash ) ).void end @@ -64,9 +64,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary::OrHash, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix::OrHash, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai::OrHash ) ).returns(T.attached_class) end @@ -111,17 +111,17 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai ) end - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, Imagekit::Internal::AnyHash ) end @@ -155,11 +155,11 @@ module Imagekit end end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, Imagekit::Internal::AnyHash ) end @@ -176,11 +176,11 @@ module Imagekit end end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter, + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi index 3a0dc779..337cd8ba 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi @@ -41,9 +41,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary::OrHash, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix::OrHash, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai::OrHash ) ).void end @@ -64,9 +64,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter::OrHash, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter::OrHash + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary::OrHash, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix::OrHash, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai::OrHash ) ).returns(T.attached_class) end @@ -111,17 +111,17 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai ) end - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, Imagekit::Internal::AnyHash ) end @@ -155,11 +155,11 @@ module Imagekit end end - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, Imagekit::Internal::AnyHash ) end @@ -176,11 +176,11 @@ module Imagekit end end - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter, + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index 78a702b5..7d81464f 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -15,8 +15,8 @@ module Imagekit Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob::OrHash, Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash @@ -41,8 +41,8 @@ module Imagekit Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob::OrHash, Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index b4cd0ed6..83e146cf 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -27,8 +27,8 @@ module Imagekit | Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup | Imagekit::Accounts::OriginCreateParams::Origin::WebFolder | Imagekit::Accounts::OriginCreateParams::Origin::WebProxy - | Imagekit::Accounts::OriginCreateParams::Origin::GoogleCloudStorageGcs - | Imagekit::Accounts::OriginCreateParams::Origin::AzureBlobStorage + | Imagekit::Accounts::OriginCreateParams::Origin::Gcs + | Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob | Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim module Origin @@ -304,7 +304,7 @@ module Imagekit } end - type google_cloud_storage_gcs = + type gcs = { bucket: String, client_email: String, @@ -316,7 +316,7 @@ module Imagekit prefix: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String @@ -362,7 +362,7 @@ module Imagekit } end - type azure_blob_storage = + type azure_blob = { account_name: String, container: String, @@ -374,7 +374,7 @@ module Imagekit prefix: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String diff --git a/sig/imagekit/models/accounts/origin_create_response.rbs b/sig/imagekit/models/accounts/origin_create_response.rbs index a0d34926..0d71ff69 100644 --- a/sig/imagekit/models/accounts/origin_create_response.rbs +++ b/sig/imagekit/models/accounts/origin_create_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginCreateResponse::WebFolder | Imagekit::Models::Accounts::OriginCreateResponse::WebProxy - | Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs - | Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginCreateResponse::Gcs + | Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob | Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim module OriginCreateResponse @@ -259,7 +259,7 @@ module Imagekit } end - type google_cloud_storage_gcs = + type gcs = { id: String, bucket: String, @@ -271,7 +271,7 @@ module Imagekit base_url_for_canonical_header: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String @@ -313,7 +313,7 @@ module Imagekit } end - type azure_blob_storage = + type azure_blob = { id: String, account_name: String, @@ -325,7 +325,7 @@ module Imagekit base_url_for_canonical_header: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String diff --git a/sig/imagekit/models/accounts/origin_get_response.rbs b/sig/imagekit/models/accounts/origin_get_response.rbs index df065c46..68bc3616 100644 --- a/sig/imagekit/models/accounts/origin_get_response.rbs +++ b/sig/imagekit/models/accounts/origin_get_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginGetResponse::WebFolder | Imagekit::Models::Accounts::OriginGetResponse::WebProxy - | Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs - | Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginGetResponse::Gcs + | Imagekit::Models::Accounts::OriginGetResponse::AzureBlob | Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim module OriginGetResponse @@ -259,7 +259,7 @@ module Imagekit } end - type google_cloud_storage_gcs = + type gcs = { id: String, bucket: String, @@ -271,7 +271,7 @@ module Imagekit base_url_for_canonical_header: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String @@ -313,7 +313,7 @@ module Imagekit } end - type azure_blob_storage = + type azure_blob = { id: String, account_name: String, @@ -325,7 +325,7 @@ module Imagekit base_url_for_canonical_header: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index 8bff5606..6950ef03 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup | Imagekit::Models::Accounts::OriginListResponseItem::WebFolder | Imagekit::Models::Accounts::OriginListResponseItem::WebProxy - | Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs - | Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage + | Imagekit::Models::Accounts::OriginListResponseItem::Gcs + | Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob | Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim module OriginListResponseItem @@ -259,7 +259,7 @@ module Imagekit } end - type google_cloud_storage_gcs = + type gcs = { id: String, bucket: String, @@ -271,7 +271,7 @@ module Imagekit base_url_for_canonical_header: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String @@ -313,7 +313,7 @@ module Imagekit } end - type azure_blob_storage = + type azure_blob = { id: String, account_name: String, @@ -325,7 +325,7 @@ module Imagekit base_url_for_canonical_header: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index 1ab3f5f6..d7ef8f51 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -27,8 +27,8 @@ module Imagekit | Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup | Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder | Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy - | Imagekit::Accounts::OriginUpdateParams::Origin::GoogleCloudStorageGcs - | Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlobStorage + | Imagekit::Accounts::OriginUpdateParams::Origin::Gcs + | Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob | Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim module Origin @@ -304,7 +304,7 @@ module Imagekit } end - type google_cloud_storage_gcs = + type gcs = { bucket: String, client_email: String, @@ -316,7 +316,7 @@ module Imagekit prefix: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String @@ -362,7 +362,7 @@ module Imagekit } end - type azure_blob_storage = + type azure_blob = { account_name: String, container: String, @@ -374,7 +374,7 @@ module Imagekit prefix: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String diff --git a/sig/imagekit/models/accounts/origin_update_response.rbs b/sig/imagekit/models/accounts/origin_update_response.rbs index 4a911ecc..11d8ae94 100644 --- a/sig/imagekit/models/accounts/origin_update_response.rbs +++ b/sig/imagekit/models/accounts/origin_update_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder | Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy - | Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs - | Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginUpdateResponse::Gcs + | Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob | Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim module OriginUpdateResponse @@ -259,7 +259,7 @@ module Imagekit } end - type google_cloud_storage_gcs = + type gcs = { id: String, bucket: String, @@ -271,7 +271,7 @@ module Imagekit base_url_for_canonical_header: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String @@ -313,7 +313,7 @@ module Imagekit } end - type azure_blob_storage = + type azure_blob = { id: String, account_name: String, @@ -325,7 +325,7 @@ module Imagekit base_url_for_canonical_header: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String diff --git a/sig/imagekit/models/accounts/url_endpoint_create_response.rbs b/sig/imagekit/models/accounts/url_endpoint_create_response.rbs index d9eb5699..4cb7d592 100644 --- a/sig/imagekit/models/accounts/url_endpoint_create_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_create_response.rbs @@ -42,17 +42,17 @@ module Imagekit } type url_rewriter = - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::CloudinaryURLRewriter - | Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::ImgixURLRewriter - | Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::AkamaiURLRewriter + Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary + | Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix + | Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai module URLRewriter extend Imagekit::Internal::Type::Union - type cloudinary_url_rewriter = + type cloudinary = { preserve_asset_delivery_types: bool, type: :CLOUDINARY } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool attr_accessor type: :CLOUDINARY @@ -68,9 +68,9 @@ module Imagekit } end - type imgix_url_rewriter = { type: :IMGIX } + type imgix = { type: :IMGIX } - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel attr_accessor type: :IMGIX def initialize: (?type: :IMGIX) -> void @@ -78,9 +78,9 @@ module Imagekit def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = { type: :AKAMAI } + type akamai = { type: :AKAMAI } - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel attr_accessor type: :AKAMAI def initialize: (?type: :AKAMAI) -> void diff --git a/sig/imagekit/models/accounts/url_endpoint_get_response.rbs b/sig/imagekit/models/accounts/url_endpoint_get_response.rbs index 54065ae0..c0658a6a 100644 --- a/sig/imagekit/models/accounts/url_endpoint_get_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_get_response.rbs @@ -42,17 +42,17 @@ module Imagekit } type url_rewriter = - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::CloudinaryURLRewriter - | Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::ImgixURLRewriter - | Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::AkamaiURLRewriter + Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary + | Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix + | Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai module URLRewriter extend Imagekit::Internal::Type::Union - type cloudinary_url_rewriter = + type cloudinary = { preserve_asset_delivery_types: bool, type: :CLOUDINARY } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool attr_accessor type: :CLOUDINARY @@ -68,9 +68,9 @@ module Imagekit } end - type imgix_url_rewriter = { type: :IMGIX } + type imgix = { type: :IMGIX } - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel attr_accessor type: :IMGIX def initialize: (?type: :IMGIX) -> void @@ -78,9 +78,9 @@ module Imagekit def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = { type: :AKAMAI } + type akamai = { type: :AKAMAI } - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel attr_accessor type: :AKAMAI def initialize: (?type: :AKAMAI) -> void diff --git a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs index 22b6347a..c07ee939 100644 --- a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs @@ -42,17 +42,17 @@ module Imagekit } type url_rewriter = - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::CloudinaryURLRewriter - | Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::ImgixURLRewriter - | Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::AkamaiURLRewriter + Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary + | Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix + | Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai module URLRewriter extend Imagekit::Internal::Type::Union - type cloudinary_url_rewriter = + type cloudinary = { preserve_asset_delivery_types: bool, type: :CLOUDINARY } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool attr_accessor type: :CLOUDINARY @@ -68,9 +68,9 @@ module Imagekit } end - type imgix_url_rewriter = { type: :IMGIX } + type imgix = { type: :IMGIX } - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel attr_accessor type: :IMGIX def initialize: (?type: :IMGIX) -> void @@ -78,9 +78,9 @@ module Imagekit def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = { type: :AKAMAI } + type akamai = { type: :AKAMAI } - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel attr_accessor type: :AKAMAI def initialize: (?type: :AKAMAI) -> void diff --git a/sig/imagekit/models/accounts/url_endpoint_update_response.rbs b/sig/imagekit/models/accounts/url_endpoint_update_response.rbs index 85daa156..1e29910d 100644 --- a/sig/imagekit/models/accounts/url_endpoint_update_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_update_response.rbs @@ -42,17 +42,17 @@ module Imagekit } type url_rewriter = - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::CloudinaryURLRewriter - | Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::ImgixURLRewriter - | Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::AkamaiURLRewriter + Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary + | Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix + | Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai module URLRewriter extend Imagekit::Internal::Type::Union - type cloudinary_url_rewriter = + type cloudinary = { preserve_asset_delivery_types: bool, type: :CLOUDINARY } - class CloudinaryURLRewriter < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekit::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool attr_accessor type: :CLOUDINARY @@ -68,9 +68,9 @@ module Imagekit } end - type imgix_url_rewriter = { type: :IMGIX } + type imgix = { type: :IMGIX } - class ImgixURLRewriter < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekit::Internal::Type::BaseModel attr_accessor type: :IMGIX def initialize: (?type: :IMGIX) -> void @@ -78,9 +78,9 @@ module Imagekit def to_hash: -> { type: :IMGIX } end - type akamai_url_rewriter = { type: :AKAMAI } + type akamai = { type: :AKAMAI } - class AkamaiURLRewriter < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekit::Internal::Type::BaseModel attr_accessor type: :AKAMAI def initialize: (?type: :AKAMAI) -> void diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index 82ef338d..18ed7728 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -28,11 +28,89 @@ def test_create_required_params in Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginCreateResponse::WebFolder in Imagekit::Models::Accounts::OriginCreateResponse::WebProxy - in Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs - in Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginCreateResponse::Gcs + in Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob in Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim end end + + assert_pattern do + case response + in { + type: :S3, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :S3_COMPATIBLE, + id: String, + bucket: String, + endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil + } + in { + type: :CLOUDINARY_BACKUP, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_FOLDER, + id: String, + base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :GCS, + id: String, + bucket: String, + client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AZURE_BLOB, + id: String, + account_name: String, + container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AKENEO_PIM, + id: String, + base_url: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + end + end end def test_update_required_params @@ -61,11 +139,89 @@ def test_update_required_params in Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder in Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy - in Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs - in Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginUpdateResponse::Gcs + in Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob in Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim end end + + assert_pattern do + case response + in { + type: :S3, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :S3_COMPATIBLE, + id: String, + bucket: String, + endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil + } + in { + type: :CLOUDINARY_BACKUP, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_FOLDER, + id: String, + base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :GCS, + id: String, + bucket: String, + client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AZURE_BLOB, + id: String, + account_name: String, + container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AKENEO_PIM, + id: String, + base_url: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + end + end end def test_list @@ -104,10 +260,88 @@ def test_get in Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginGetResponse::WebFolder in Imagekit::Models::Accounts::OriginGetResponse::WebProxy - in Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs - in Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginGetResponse::Gcs + in Imagekit::Models::Accounts::OriginGetResponse::AzureBlob in Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim end end + + assert_pattern do + case response + in { + type: :S3, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :S3_COMPATIBLE, + id: String, + bucket: String, + endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil + } + in { + type: :CLOUDINARY_BACKUP, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_FOLDER, + id: String, + base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :GCS, + id: String, + bucket: String, + client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AZURE_BLOB, + id: String, + account_name: String, + container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AKENEO_PIM, + id: String, + base_url: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + end + end end end From f7e672f96e90ebb60f942fbb04452707fd52922a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 13:35:14 +0000 Subject: [PATCH 035/178] codegen metadata --- .stats.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index 61a94110..878cd0fc 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-4bc3e70493ee36b6dd29a92334f55232a5429d1bf03139d1f072f854c3ba5a6e.yml -openapi_spec_hash: 9b8384f2a421b73c3f03d1ca84c26113 -config_hash: c434cea5e670c34d574784866661bebd +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-5e37410c61128e976acdb1c3a0df26552e969187d32f4af52555eeb9685d6bc2.yml +openapi_spec_hash: b3d4d81f84221c6bc87065590a907004 +config_hash: 040d180c4960ee032ba08946d86c8764 From fbdfea1a38b83a01545916940bc52e3080c64402 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 13:37:28 +0000 Subject: [PATCH 036/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 878cd0fc..27d4d89c 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-5e37410c61128e976acdb1c3a0df26552e969187d32f4af52555eeb9685d6bc2.yml -openapi_spec_hash: b3d4d81f84221c6bc87065590a907004 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-4bc3e70493ee36b6dd29a92334f55232a5429d1bf03139d1f072f854c3ba5a6e.yml +openapi_spec_hash: 9b8384f2a421b73c3f03d1ca84c26113 config_hash: 040d180c4960ee032ba08946d86c8764 From 98d1674263461433bba1adf65b01d0db79f4548b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 02:11:20 +0000 Subject: [PATCH 037/178] chore: add json schema comment for rubocop.yml --- .rubocop.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.rubocop.yml b/.rubocop.yml index 47dc74ae..f79bc9ed 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,3 +1,4 @@ +# yaml-language-server: $schema=https://www.rubyschema.org/rubocop.json --- # Explicitly disable pending cops for now. This is the default behaviour but # this avoids a large warning every time we run it. @@ -8,7 +9,7 @@ AllCops: - "bin/*" NewCops: enable SuggestExtensions: false - TargetRubyVersion: 3.2.0 + TargetRubyVersion: 3.2 # Whether MFA is required or not should be left to the token configuration. Gemspec/RequireMFA: From c89924c2273b2c61f6324128dd0c9fb9692dc662 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 03:02:04 +0000 Subject: [PATCH 038/178] feat(api): manual updates --- .stats.yml | 4 +- lib/imagekit/models/asset_list_response.rb | 63 ++++++---- lib/imagekit/models/file_get_response.rb | 31 +++-- lib/imagekit/models/file_update_response.rb | 31 +++-- .../models/files/version_get_response.rb | 31 +++-- .../models/files/version_list_response.rb | 31 +++-- .../models/files/version_restore_response.rb | 31 +++-- lib/imagekit/resources/assets.rb | 2 +- rbi/imagekit/models/asset_list_response.rbi | 110 +++++++++++++----- rbi/imagekit/models/file_get_response.rbi | 57 +++++++-- rbi/imagekit/models/file_update_response.rbi | 57 +++++++-- .../models/files/version_get_response.rbi | 67 +++++++++-- .../models/files/version_list_response.rbi | 72 ++++++++++-- .../models/files/version_restore_response.rbi | 72 ++++++++++-- sig/imagekit/models/asset_list_response.rbs | 85 ++++++++------ sig/imagekit/models/file_get_response.rbs | 43 ++++--- sig/imagekit/models/file_update_response.rbs | 43 ++++--- .../models/files/version_get_response.rbs | 43 ++++--- .../models/files/version_list_response.rbs | 43 ++++--- .../models/files/version_restore_response.rbs | 43 ++++--- .../imagekit/resources/files/versions_test.rb | 12 +- test/imagekit/resources/files_test.rb | 12 +- 22 files changed, 697 insertions(+), 286 deletions(-) diff --git a/.stats.yml b/.stats.yml index 27d4d89c..9ac0471d 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-4bc3e70493ee36b6dd29a92334f55232a5429d1bf03139d1f072f854c3ba5a6e.yml -openapi_spec_hash: 9b8384f2a421b73c3f03d1ca84c26113 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml +openapi_spec_hash: 98642308bee81ac776b7b1843089b888 config_hash: 040d180c4960ee032ba08946d86c8764 diff --git a/lib/imagekit/models/asset_list_response.rb b/lib/imagekit/models/asset_list_response.rb index 65d80bea..414666bd 100644 --- a/lib/imagekit/models/asset_list_response.rb +++ b/lib/imagekit/models/asset_list_response.rb @@ -6,11 +6,13 @@ module Models module AssetListResponseItem extend Imagekit::Internal::Type::Union + discriminator :type + + variant :folder, -> { Imagekit::Models::AssetListResponseItem::Folder } + # Object containing details of a file or file version. variant -> { Imagekit::Models::AssetListResponseItem::FileDetails } - variant -> { Imagekit::Models::AssetListResponseItem::FolderDetails } - class FileDetails < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. @@ -25,8 +27,8 @@ class FileDetails < Imagekit::Internal::Type::BaseModel # Date and time when the file was uploaded. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :created_at, String, api_name: :createdAt + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt # @!attribute custom_coordinates # An string with custom coordinates of the file. @@ -122,15 +124,15 @@ class FileDetails < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [String, nil] - optional :type, String + # @return [Symbol, Imagekit::Models::AssetListResponseItem::FileDetails::Type, nil] + optional :type, enum: -> { Imagekit::Models::AssetListResponseItem::FileDetails::Type } # @!attribute updated_at # Date and time when the file was last updated. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :updated_at, String, api_name: :updatedAt + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt # @!attribute url # URL of the file. @@ -160,7 +162,7 @@ class FileDetails < Imagekit::Internal::Type::BaseModel # # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # - # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # @@ -190,9 +192,9 @@ class FileDetails < Imagekit::Internal::Type::BaseModel # # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th # - # @param type [String] Type of the asset. + # @param type [Symbol, Imagekit::Models::AssetListResponseItem::FileDetails::Type] Type of the asset. # - # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo # # @param url [String] URL of the file. # @@ -231,6 +233,19 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end + # Type of the asset. + # + # @see Imagekit::Models::AssetListResponseItem::FileDetails#type + module Type + extend Imagekit::Internal::Type::Enum + + FILE = :file + FILE_VERSION = :"file-version" + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::AssetListResponseItem::FileDetails#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id @@ -254,13 +269,13 @@ class VersionInfo < Imagekit::Internal::Type::BaseModel end end - class FolderDetails < Imagekit::Internal::Type::BaseModel + class Folder < Imagekit::Internal::Type::BaseModel # @!attribute created_at # Date and time when the folder was created. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :created_at, String, api_name: :createdAt + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt # @!attribute folder_id # Unique identifier of the asset. @@ -286,21 +301,21 @@ class FolderDetails < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [Symbol, Imagekit::Models::AssetListResponseItem::FolderDetails::Type, nil] - optional :type, enum: -> { Imagekit::Models::AssetListResponseItem::FolderDetails::Type } + # @return [Symbol, Imagekit::Models::AssetListResponseItem::Folder::Type, nil] + optional :type, enum: -> { Imagekit::Models::AssetListResponseItem::Folder::Type } # @!attribute updated_at # Date and time when the folder was last updated. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :updated_at, String, api_name: :updatedAt + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt # @!method initialize(created_at: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::AssetListResponseItem::FolderDetails} for more details. + # {Imagekit::Models::AssetListResponseItem::Folder} for more details. # - # @param created_at [String] Date and time when the folder was created. The date and time is in ISO8601 forma + # @param created_at [Time] Date and time when the folder was created. The date and time is in ISO8601 forma # # @param folder_id [String] Unique identifier of the asset. # @@ -308,13 +323,13 @@ class FolderDetails < Imagekit::Internal::Type::BaseModel # # @param name [String] Name of the asset. # - # @param type [Symbol, Imagekit::Models::AssetListResponseItem::FolderDetails::Type] Type of the asset. + # @param type [Symbol, Imagekit::Models::AssetListResponseItem::Folder::Type] Type of the asset. # - # @param updated_at [String] Date and time when the folder was last updated. The date and time is in ISO8601 + # @param updated_at [Time] Date and time when the folder was last updated. The date and time is in ISO8601 # Type of the asset. # - # @see Imagekit::Models::AssetListResponseItem::FolderDetails#type + # @see Imagekit::Models::AssetListResponseItem::Folder#type module Type extend Imagekit::Internal::Type::Enum @@ -326,7 +341,7 @@ module Type end # @!method self.variants - # @return [Array(Imagekit::Models::AssetListResponseItem::FileDetails, Imagekit::Models::AssetListResponseItem::FolderDetails)] + # @return [Array(Imagekit::Models::AssetListResponseItem::Folder, Imagekit::Models::AssetListResponseItem::FileDetails)] end # @type [Imagekit::Internal::Type::Converter] diff --git a/lib/imagekit/models/file_get_response.rb b/lib/imagekit/models/file_get_response.rb index ac825f59..af01ea2d 100644 --- a/lib/imagekit/models/file_get_response.rb +++ b/lib/imagekit/models/file_get_response.rb @@ -17,8 +17,8 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # Date and time when the file was uploaded. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :created_at, String, api_name: :createdAt + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt # @!attribute custom_coordinates # An string with custom coordinates of the file. @@ -114,15 +114,15 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [String, nil] - optional :type, String + # @return [Symbol, Imagekit::Models::FileGetResponse::Type, nil] + optional :type, enum: -> { Imagekit::Models::FileGetResponse::Type } # @!attribute updated_at # Date and time when the file was last updated. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :updated_at, String, api_name: :updatedAt + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt # @!attribute url # URL of the file. @@ -150,7 +150,7 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # - # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # @@ -180,9 +180,9 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th # - # @param type [String] Type of the asset. + # @param type [Symbol, Imagekit::Models::FileGetResponse::Type] Type of the asset. # - # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo # # @param url [String] URL of the file. # @@ -221,6 +221,19 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end + # Type of the asset. + # + # @see Imagekit::Models::FileGetResponse#type + module Type + extend Imagekit::Internal::Type::Enum + + FILE = :file + FILE_VERSION = :"file-version" + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::FileGetResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/models/file_update_response.rb b/lib/imagekit/models/file_update_response.rb index 9153a95f..da0d9eae 100644 --- a/lib/imagekit/models/file_update_response.rb +++ b/lib/imagekit/models/file_update_response.rb @@ -17,8 +17,8 @@ class FileUpdateResponse < Imagekit::Internal::Type::BaseModel # Date and time when the file was uploaded. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :created_at, String, api_name: :createdAt + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt # @!attribute custom_coordinates # An string with custom coordinates of the file. @@ -121,15 +121,15 @@ class FileUpdateResponse < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [String, nil] - optional :type, String + # @return [Symbol, Imagekit::Models::FileUpdateResponse::Type, nil] + optional :type, enum: -> { Imagekit::Models::FileUpdateResponse::Type } # @!attribute updated_at # Date and time when the file was last updated. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :updated_at, String, api_name: :updatedAt + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt # @!attribute url # URL of the file. @@ -155,7 +155,7 @@ class FileUpdateResponse < Imagekit::Internal::Type::BaseModel # # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # - # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # @@ -187,9 +187,9 @@ class FileUpdateResponse < Imagekit::Internal::Type::BaseModel # # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th # - # @param type [String] Type of the asset. + # @param type [Symbol, Imagekit::Models::FileUpdateResponse::Type] Type of the asset. # - # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo # # @param url [String] URL of the file. # @@ -313,6 +313,19 @@ module RemoveBg end end + # Type of the asset. + # + # @see Imagekit::Models::FileUpdateResponse#type + module Type + extend Imagekit::Internal::Type::Enum + + FILE = :file + FILE_VERSION = :"file-version" + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::FileUpdateResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/models/files/version_get_response.rb b/lib/imagekit/models/files/version_get_response.rb index 5c8c3f49..e314ae5c 100644 --- a/lib/imagekit/models/files/version_get_response.rb +++ b/lib/imagekit/models/files/version_get_response.rb @@ -18,8 +18,8 @@ class VersionGetResponse < Imagekit::Internal::Type::BaseModel # Date and time when the file was uploaded. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :created_at, String, api_name: :createdAt + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt # @!attribute custom_coordinates # An string with custom coordinates of the file. @@ -115,15 +115,15 @@ class VersionGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [String, nil] - optional :type, String + # @return [Symbol, Imagekit::Models::Files::VersionGetResponse::Type, nil] + optional :type, enum: -> { Imagekit::Models::Files::VersionGetResponse::Type } # @!attribute updated_at # Date and time when the file was last updated. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :updated_at, String, api_name: :updatedAt + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt # @!attribute url # URL of the file. @@ -153,7 +153,7 @@ class VersionGetResponse < Imagekit::Internal::Type::BaseModel # # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # - # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # @@ -183,9 +183,9 @@ class VersionGetResponse < Imagekit::Internal::Type::BaseModel # # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th # - # @param type [String] Type of the asset. + # @param type [Symbol, Imagekit::Models::Files::VersionGetResponse::Type] Type of the asset. # - # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo # # @param url [String] URL of the file. # @@ -224,6 +224,19 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end + # Type of the asset. + # + # @see Imagekit::Models::Files::VersionGetResponse#type + module Type + extend Imagekit::Internal::Type::Enum + + FILE = :file + FILE_VERSION = :"file-version" + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::Files::VersionGetResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/models/files/version_list_response.rb b/lib/imagekit/models/files/version_list_response.rb index 451397bf..8f5ef79e 100644 --- a/lib/imagekit/models/files/version_list_response.rb +++ b/lib/imagekit/models/files/version_list_response.rb @@ -17,8 +17,8 @@ class VersionListResponseItem < Imagekit::Internal::Type::BaseModel # Date and time when the file was uploaded. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :created_at, String, api_name: :createdAt + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt # @!attribute custom_coordinates # An string with custom coordinates of the file. @@ -114,15 +114,15 @@ class VersionListResponseItem < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [String, nil] - optional :type, String + # @return [Symbol, Imagekit::Models::Files::VersionListResponseItem::Type, nil] + optional :type, enum: -> { Imagekit::Models::Files::VersionListResponseItem::Type } # @!attribute updated_at # Date and time when the file was last updated. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :updated_at, String, api_name: :updatedAt + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt # @!attribute url # URL of the file. @@ -152,7 +152,7 @@ class VersionListResponseItem < Imagekit::Internal::Type::BaseModel # # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # - # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # @@ -182,9 +182,9 @@ class VersionListResponseItem < Imagekit::Internal::Type::BaseModel # # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th # - # @param type [String] Type of the asset. + # @param type [Symbol, Imagekit::Models::Files::VersionListResponseItem::Type] Type of the asset. # - # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo # # @param url [String] URL of the file. # @@ -223,6 +223,19 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end + # Type of the asset. + # + # @see Imagekit::Models::Files::VersionListResponseItem#type + module Type + extend Imagekit::Internal::Type::Enum + + FILE = :file + FILE_VERSION = :"file-version" + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::Files::VersionListResponseItem#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/models/files/version_restore_response.rb b/lib/imagekit/models/files/version_restore_response.rb index e5880bd8..6378ccb1 100644 --- a/lib/imagekit/models/files/version_restore_response.rb +++ b/lib/imagekit/models/files/version_restore_response.rb @@ -18,8 +18,8 @@ class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel # Date and time when the file was uploaded. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :created_at, String, api_name: :createdAt + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt # @!attribute custom_coordinates # An string with custom coordinates of the file. @@ -115,15 +115,15 @@ class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [String, nil] - optional :type, String + # @return [Symbol, Imagekit::Models::Files::VersionRestoreResponse::Type, nil] + optional :type, enum: -> { Imagekit::Models::Files::VersionRestoreResponse::Type } # @!attribute updated_at # Date and time when the file was last updated. The date and time is in ISO8601 # format. # - # @return [String, nil] - optional :updated_at, String, api_name: :updatedAt + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt # @!attribute url # URL of the file. @@ -153,7 +153,7 @@ class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel # # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # - # @param created_at [String] Date and time when the file was uploaded. The date and time is in ISO8601 format + # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. # @@ -183,9 +183,9 @@ class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel # # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th # - # @param type [String] Type of the asset. + # @param type [Symbol, Imagekit::Models::Files::VersionRestoreResponse::Type] Type of the asset. # - # @param updated_at [String] Date and time when the file was last updated. The date and time is in ISO8601 fo + # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo # # @param url [String] URL of the file. # @@ -224,6 +224,19 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end + # Type of the asset. + # + # @see Imagekit::Models::Files::VersionRestoreResponse#type + module Type + extend Imagekit::Internal::Type::Enum + + FILE = :file + FILE_VERSION = :"file-version" + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::Files::VersionRestoreResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/resources/assets.rb b/lib/imagekit/resources/assets.rb index 25634fa5..8b0987b3 100644 --- a/lib/imagekit/resources/assets.rb +++ b/lib/imagekit/resources/assets.rb @@ -29,7 +29,7 @@ class Assets # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::AssetListParams def list(params = {}) diff --git a/rbi/imagekit/models/asset_list_response.rbi b/rbi/imagekit/models/asset_list_response.rbi index fea9a9a8..05150a53 100644 --- a/rbi/imagekit/models/asset_list_response.rbi +++ b/rbi/imagekit/models/asset_list_response.rbi @@ -9,8 +9,8 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::AssetListResponseItem::FileDetails, - Imagekit::Models::AssetListResponseItem::FolderDetails + Imagekit::Models::AssetListResponseItem::Folder, + Imagekit::Models::AssetListResponseItem::FileDetails ) end @@ -37,10 +37,10 @@ module Imagekit # Date and time when the file was uploaded. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :created_at - sig { params(created_at: String).void } + sig { params(created_at: Time).void } attr_writer :created_at # An string with custom coordinates of the file. @@ -141,18 +141,29 @@ module Imagekit attr_writer :thumbnail # Type of the asset. - sig { returns(T.nilable(String)) } + sig do + returns( + T.nilable( + Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + Imagekit::Models::AssetListResponseItem::FileDetails::Type::OrSymbol + ).void + end attr_writer :type # Date and time when the file was last updated. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :updated_at - sig { params(updated_at: String).void } + sig { params(updated_at: Time).void } attr_writer :updated_at # URL of the file. @@ -196,7 +207,7 @@ module Imagekit Imagekit::Models::AssetListResponseItem::FileDetails::AITag::OrHash ] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -211,8 +222,9 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: + Imagekit::Models::AssetListResponseItem::FileDetails::Type::OrSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo::OrHash, @@ -281,7 +293,7 @@ module Imagekit Imagekit::Models::AssetListResponseItem::FileDetails::AITag ] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -296,8 +308,9 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: + Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, @@ -364,6 +377,41 @@ module Imagekit end end + # Type of the asset. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::AssetListResponseItem::FileDetails::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FILE = + T.let( + :file, + Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol + ) + FILE_VERSION = + T.let( + :"file-version", + Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do @@ -403,21 +451,21 @@ module Imagekit end end - class FolderDetails < Imagekit::Internal::Type::BaseModel + class Folder < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::AssetListResponseItem::FolderDetails, + Imagekit::Models::AssetListResponseItem::Folder, Imagekit::Internal::AnyHash ) end # Date and time when the folder was created. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :created_at - sig { params(created_at: String).void } + sig { params(created_at: Time).void } attr_writer :created_at # Unique identifier of the asset. @@ -448,7 +496,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::AssetListResponseItem::FolderDetails::Type::TaggedSymbol + Imagekit::Models::AssetListResponseItem::Folder::Type::TaggedSymbol ) ) end @@ -457,28 +505,28 @@ module Imagekit sig do params( type: - Imagekit::Models::AssetListResponseItem::FolderDetails::Type::OrSymbol + Imagekit::Models::AssetListResponseItem::Folder::Type::OrSymbol ).void end attr_writer :type # Date and time when the folder was last updated. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :updated_at - sig { params(updated_at: String).void } + sig { params(updated_at: Time).void } attr_writer :updated_at sig do params( - created_at: String, + created_at: Time, folder_id: String, folder_path: String, name: String, type: - Imagekit::Models::AssetListResponseItem::FolderDetails::Type::OrSymbol, - updated_at: String + Imagekit::Models::AssetListResponseItem::Folder::Type::OrSymbol, + updated_at: Time ).returns(T.attached_class) end def self.new( @@ -505,13 +553,13 @@ module Imagekit sig do override.returns( { - created_at: String, + created_at: Time, folder_id: String, folder_path: String, name: String, type: - Imagekit::Models::AssetListResponseItem::FolderDetails::Type::TaggedSymbol, - updated_at: String + Imagekit::Models::AssetListResponseItem::Folder::Type::TaggedSymbol, + updated_at: Time } ) end @@ -526,7 +574,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::Models::AssetListResponseItem::FolderDetails::Type + Imagekit::Models::AssetListResponseItem::Folder::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -534,13 +582,13 @@ module Imagekit FOLDER = T.let( :folder, - Imagekit::Models::AssetListResponseItem::FolderDetails::Type::TaggedSymbol + Imagekit::Models::AssetListResponseItem::Folder::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::AssetListResponseItem::FolderDetails::Type::TaggedSymbol + Imagekit::Models::AssetListResponseItem::Folder::Type::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/file_get_response.rbi b/rbi/imagekit/models/file_get_response.rbi index 126d608e..b60d2ee3 100644 --- a/rbi/imagekit/models/file_get_response.rbi +++ b/rbi/imagekit/models/file_get_response.rbi @@ -16,10 +16,10 @@ module Imagekit # Date and time when the file was uploaded. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :created_at - sig { params(created_at: String).void } + sig { params(created_at: Time).void } attr_writer :created_at # An string with custom coordinates of the file. @@ -120,18 +120,24 @@ module Imagekit attr_writer :thumbnail # Type of the asset. - sig { returns(T.nilable(String)) } + sig do + returns( + T.nilable(Imagekit::Models::FileGetResponse::Type::TaggedSymbol) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params(type: Imagekit::Models::FileGetResponse::Type::OrSymbol).void + end attr_writer :type # Date and time when the file was last updated. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :updated_at - sig { params(updated_at: String).void } + sig { params(updated_at: Time).void } attr_writer :updated_at # URL of the file. @@ -166,7 +172,7 @@ module Imagekit T.nilable( T::Array[Imagekit::Models::FileGetResponse::AITag::OrHash] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -181,8 +187,8 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::FileGetResponse::Type::OrSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::FileGetResponse::VersionInfo::OrHash, width: Float @@ -246,7 +252,7 @@ module Imagekit { ai_tags: T.nilable(T::Array[Imagekit::Models::FileGetResponse::AITag]), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -261,8 +267,8 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::FileGetResponse::Type::TaggedSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::FileGetResponse::VersionInfo, width: Float @@ -326,6 +332,33 @@ module Imagekit end end + # Type of the asset. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Models::FileGetResponse::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FILE = + T.let(:file, Imagekit::Models::FileGetResponse::Type::TaggedSymbol) + FILE_VERSION = + T.let( + :"file-version", + Imagekit::Models::FileGetResponse::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::Models::FileGetResponse::Type::TaggedSymbol] + ) + end + def self.values + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/file_update_response.rbi b/rbi/imagekit/models/file_update_response.rbi index 921d7b51..d763bde8 100644 --- a/rbi/imagekit/models/file_update_response.rbi +++ b/rbi/imagekit/models/file_update_response.rbi @@ -21,10 +21,10 @@ module Imagekit # Date and time when the file was uploaded. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :created_at - sig { params(created_at: String).void } + sig { params(created_at: Time).void } attr_writer :created_at # An string with custom coordinates of the file. @@ -140,18 +140,24 @@ module Imagekit attr_writer :thumbnail # Type of the asset. - sig { returns(T.nilable(String)) } + sig do + returns( + T.nilable(Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params(type: Imagekit::Models::FileUpdateResponse::Type::OrSymbol).void + end attr_writer :type # Date and time when the file was last updated. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :updated_at - sig { params(updated_at: String).void } + sig { params(updated_at: Time).void } attr_writer :updated_at # URL of the file. @@ -188,7 +194,7 @@ module Imagekit T.nilable( T::Array[Imagekit::Models::FileUpdateResponse::AITag::OrHash] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], extension_status: @@ -205,8 +211,8 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::FileUpdateResponse::Type::OrSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::FileUpdateResponse::VersionInfo::OrHash, @@ -272,7 +278,7 @@ module Imagekit { ai_tags: T.nilable(T::Array[Imagekit::Models::FileUpdateResponse::AITag]), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], extension_status: @@ -289,8 +295,8 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, width: Float @@ -625,6 +631,33 @@ module Imagekit end end + # Type of the asset. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Models::FileUpdateResponse::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FILE = + T.let(:file, Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol) + FILE_VERSION = + T.let( + :"file-version", + Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol] + ) + end + def self.values + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/files/version_get_response.rbi b/rbi/imagekit/models/files/version_get_response.rbi index ee7287ab..c12a13c4 100644 --- a/rbi/imagekit/models/files/version_get_response.rbi +++ b/rbi/imagekit/models/files/version_get_response.rbi @@ -24,10 +24,10 @@ module Imagekit # Date and time when the file was uploaded. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :created_at - sig { params(created_at: String).void } + sig { params(created_at: Time).void } attr_writer :created_at # An string with custom coordinates of the file. @@ -128,18 +128,28 @@ module Imagekit attr_writer :thumbnail # Type of the asset. - sig { returns(T.nilable(String)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: Imagekit::Models::Files::VersionGetResponse::Type::OrSymbol + ).void + end attr_writer :type # Date and time when the file was last updated. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :updated_at - sig { params(updated_at: String).void } + sig { params(updated_at: Time).void } attr_writer :updated_at # URL of the file. @@ -181,7 +191,7 @@ module Imagekit Imagekit::Models::Files::VersionGetResponse::AITag::OrHash ] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -196,8 +206,8 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::Files::VersionGetResponse::Type::OrSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo::OrHash, @@ -264,7 +274,7 @@ module Imagekit T.nilable( T::Array[Imagekit::Models::Files::VersionGetResponse::AITag] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -279,8 +289,9 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: + Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, @@ -347,6 +358,38 @@ module Imagekit end end + # Type of the asset. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Models::Files::VersionGetResponse::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FILE = + T.let( + :file, + Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol + ) + FILE_VERSION = + T.let( + :"file-version", + Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/files/version_list_response.rbi b/rbi/imagekit/models/files/version_list_response.rbi index 857b6a10..ca296d45 100644 --- a/rbi/imagekit/models/files/version_list_response.rbi +++ b/rbi/imagekit/models/files/version_list_response.rbi @@ -24,10 +24,10 @@ module Imagekit # Date and time when the file was uploaded. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :created_at - sig { params(created_at: String).void } + sig { params(created_at: Time).void } attr_writer :created_at # An string with custom coordinates of the file. @@ -128,18 +128,29 @@ module Imagekit attr_writer :thumbnail # Type of the asset. - sig { returns(T.nilable(String)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + Imagekit::Models::Files::VersionListResponseItem::Type::OrSymbol + ).void + end attr_writer :type # Date and time when the file was last updated. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :updated_at - sig { params(updated_at: String).void } + sig { params(updated_at: Time).void } attr_writer :updated_at # URL of the file. @@ -183,7 +194,7 @@ module Imagekit Imagekit::Models::Files::VersionListResponseItem::AITag::OrHash ] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -198,8 +209,9 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: + Imagekit::Models::Files::VersionListResponseItem::Type::OrSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo::OrHash, @@ -268,7 +280,7 @@ module Imagekit Imagekit::Models::Files::VersionListResponseItem::AITag ] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -283,8 +295,9 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: + Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, @@ -351,6 +364,41 @@ module Imagekit end end + # Type of the asset. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Files::VersionListResponseItem::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FILE = + T.let( + :file, + Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol + ) + FILE_VERSION = + T.let( + :"file-version", + Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/files/version_restore_response.rbi b/rbi/imagekit/models/files/version_restore_response.rbi index e98ff1bd..c6622167 100644 --- a/rbi/imagekit/models/files/version_restore_response.rbi +++ b/rbi/imagekit/models/files/version_restore_response.rbi @@ -24,10 +24,10 @@ module Imagekit # Date and time when the file was uploaded. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :created_at - sig { params(created_at: String).void } + sig { params(created_at: Time).void } attr_writer :created_at # An string with custom coordinates of the file. @@ -128,18 +128,29 @@ module Imagekit attr_writer :thumbnail # Type of the asset. - sig { returns(T.nilable(String)) } + sig do + returns( + T.nilable( + Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + Imagekit::Models::Files::VersionRestoreResponse::Type::OrSymbol + ).void + end attr_writer :type # Date and time when the file was last updated. The date and time is in ISO8601 # format. - sig { returns(T.nilable(String)) } + sig { returns(T.nilable(Time)) } attr_reader :updated_at - sig { params(updated_at: String).void } + sig { params(updated_at: Time).void } attr_writer :updated_at # URL of the file. @@ -183,7 +194,7 @@ module Imagekit Imagekit::Models::Files::VersionRestoreResponse::AITag::OrHash ] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -198,8 +209,9 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: + Imagekit::Models::Files::VersionRestoreResponse::Type::OrSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo::OrHash, @@ -268,7 +280,7 @@ module Imagekit Imagekit::Models::Files::VersionRestoreResponse::AITag ] ), - created_at: String, + created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], file_id: String, @@ -283,8 +295,9 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: String, - updated_at: String, + type: + Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, @@ -351,6 +364,41 @@ module Imagekit end end + # Type of the asset. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Files::VersionRestoreResponse::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FILE = + T.let( + :file, + Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol + ) + FILE_VERSION = + T.let( + :"file-version", + Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/sig/imagekit/models/asset_list_response.rbs b/sig/imagekit/models/asset_list_response.rbs index 5165a46d..2c81feb7 100644 --- a/sig/imagekit/models/asset_list_response.rbs +++ b/sig/imagekit/models/asset_list_response.rbs @@ -1,8 +1,8 @@ module Imagekit module Models type asset_list_response_item = - Imagekit::Models::AssetListResponseItem::FileDetails - | Imagekit::Models::AssetListResponseItem::FolderDetails + Imagekit::Models::AssetListResponseItem::Folder + | Imagekit::Models::AssetListResponseItem::FileDetails module AssetListResponseItem extend Imagekit::Internal::Type::Union @@ -10,7 +10,7 @@ module Imagekit type file_details = { ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -25,8 +25,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::AssetListResponseItem::FileDetails::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, width: Float @@ -35,9 +35,9 @@ module Imagekit class FileDetails < Imagekit::Internal::Type::BaseModel attr_accessor ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]? - attr_reader created_at: String? + attr_reader created_at: Time? - def created_at=: (String) -> String + def created_at=: (Time) -> Time attr_accessor custom_coordinates: String? @@ -91,13 +91,15 @@ module Imagekit def thumbnail=: (String) -> String - attr_reader type: String? + attr_reader type: Imagekit::Models::AssetListResponseItem::FileDetails::type_? - def type=: (String) -> String + def type=: ( + Imagekit::Models::AssetListResponseItem::FileDetails::type_ + ) -> Imagekit::Models::AssetListResponseItem::FileDetails::type_ - attr_reader updated_at: String? + attr_reader updated_at: Time? - def updated_at=: (String) -> String + def updated_at=: (Time) -> Time attr_reader url: String? @@ -115,7 +117,7 @@ module Imagekit def initialize: ( ?ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, - ?created_at: String, + ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, @@ -130,8 +132,8 @@ module Imagekit ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, - ?type: String, - ?updated_at: String, + ?type: Imagekit::Models::AssetListResponseItem::FileDetails::type_, + ?updated_at: Time, ?url: String, ?version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, ?width: Float @@ -139,7 +141,7 @@ module Imagekit def to_hash: -> { ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -154,8 +156,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::AssetListResponseItem::FileDetails::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, width: Float @@ -185,6 +187,17 @@ module Imagekit def to_hash: -> { confidence: Float, name: String, source: String } end + type type_ = :file | :"file-version" + + module Type + extend Imagekit::Internal::Type::Enum + + FILE: :file + FILE_VERSION: :"file-version" + + def self?.values: -> ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::type_] + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel @@ -202,20 +215,20 @@ module Imagekit end end - type folder_details = + type folder = { - created_at: String, + created_at: Time, folder_id: String, folder_path: String, name: String, - type: Imagekit::Models::AssetListResponseItem::FolderDetails::type_, - updated_at: String + type: Imagekit::Models::AssetListResponseItem::Folder::type_, + updated_at: Time } - class FolderDetails < Imagekit::Internal::Type::BaseModel - attr_reader created_at: String? + class Folder < Imagekit::Internal::Type::BaseModel + attr_reader created_at: Time? - def created_at=: (String) -> String + def created_at=: (Time) -> Time attr_reader folder_id: String? @@ -229,32 +242,32 @@ module Imagekit def name=: (String) -> String - attr_reader type: Imagekit::Models::AssetListResponseItem::FolderDetails::type_? + attr_reader type: Imagekit::Models::AssetListResponseItem::Folder::type_? def type=: ( - Imagekit::Models::AssetListResponseItem::FolderDetails::type_ - ) -> Imagekit::Models::AssetListResponseItem::FolderDetails::type_ + Imagekit::Models::AssetListResponseItem::Folder::type_ + ) -> Imagekit::Models::AssetListResponseItem::Folder::type_ - attr_reader updated_at: String? + attr_reader updated_at: Time? - def updated_at=: (String) -> String + def updated_at=: (Time) -> Time def initialize: ( - ?created_at: String, + ?created_at: Time, ?folder_id: String, ?folder_path: String, ?name: String, - ?type: Imagekit::Models::AssetListResponseItem::FolderDetails::type_, - ?updated_at: String + ?type: Imagekit::Models::AssetListResponseItem::Folder::type_, + ?updated_at: Time ) -> void def to_hash: -> { - created_at: String, + created_at: Time, folder_id: String, folder_path: String, name: String, - type: Imagekit::Models::AssetListResponseItem::FolderDetails::type_, - updated_at: String + type: Imagekit::Models::AssetListResponseItem::Folder::type_, + updated_at: Time } type type_ = :folder @@ -264,7 +277,7 @@ module Imagekit FOLDER: :folder - def self?.values: -> ::Array[Imagekit::Models::AssetListResponseItem::FolderDetails::type_] + def self?.values: -> ::Array[Imagekit::Models::AssetListResponseItem::Folder::type_] end end diff --git a/sig/imagekit/models/file_get_response.rbs b/sig/imagekit/models/file_get_response.rbs index d8a500bf..472ec97e 100644 --- a/sig/imagekit/models/file_get_response.rbs +++ b/sig/imagekit/models/file_get_response.rbs @@ -3,7 +3,7 @@ module Imagekit type file_get_response = { ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -18,8 +18,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::FileGetResponse::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::FileGetResponse::VersionInfo, width: Float @@ -28,9 +28,9 @@ module Imagekit class FileGetResponse < Imagekit::Internal::Type::BaseModel attr_accessor ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]? - attr_reader created_at: String? + attr_reader created_at: Time? - def created_at=: (String) -> String + def created_at=: (Time) -> Time attr_accessor custom_coordinates: String? @@ -84,13 +84,15 @@ module Imagekit def thumbnail=: (String) -> String - attr_reader type: String? + attr_reader type: Imagekit::Models::FileGetResponse::type_? - def type=: (String) -> String + def type=: ( + Imagekit::Models::FileGetResponse::type_ + ) -> Imagekit::Models::FileGetResponse::type_ - attr_reader updated_at: String? + attr_reader updated_at: Time? - def updated_at=: (String) -> String + def updated_at=: (Time) -> Time attr_reader url: String? @@ -108,7 +110,7 @@ module Imagekit def initialize: ( ?ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, - ?created_at: String, + ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, @@ -123,8 +125,8 @@ module Imagekit ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, - ?type: String, - ?updated_at: String, + ?type: Imagekit::Models::FileGetResponse::type_, + ?updated_at: Time, ?url: String, ?version_info: Imagekit::Models::FileGetResponse::VersionInfo, ?width: Float @@ -132,7 +134,7 @@ module Imagekit def to_hash: -> { ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -147,8 +149,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::FileGetResponse::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::FileGetResponse::VersionInfo, width: Float @@ -178,6 +180,17 @@ module Imagekit def to_hash: -> { confidence: Float, name: String, source: String } end + type type_ = :file | :"file-version" + + module Type + extend Imagekit::Internal::Type::Enum + + FILE: :file + FILE_VERSION: :"file-version" + + def self?.values: -> ::Array[Imagekit::Models::FileGetResponse::type_] + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/models/file_update_response.rbs b/sig/imagekit/models/file_update_response.rbs index d66b3703..26fb47f8 100644 --- a/sig/imagekit/models/file_update_response.rbs +++ b/sig/imagekit/models/file_update_response.rbs @@ -3,7 +3,7 @@ module Imagekit type file_update_response = { ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, @@ -19,8 +19,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::FileUpdateResponse::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, width: Float @@ -29,9 +29,9 @@ module Imagekit class FileUpdateResponse < Imagekit::Internal::Type::BaseModel attr_accessor ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]? - attr_reader created_at: String? + attr_reader created_at: Time? - def created_at=: (String) -> String + def created_at=: (Time) -> Time attr_accessor custom_coordinates: String? @@ -91,13 +91,15 @@ module Imagekit def thumbnail=: (String) -> String - attr_reader type: String? + attr_reader type: Imagekit::Models::FileUpdateResponse::type_? - def type=: (String) -> String + def type=: ( + Imagekit::Models::FileUpdateResponse::type_ + ) -> Imagekit::Models::FileUpdateResponse::type_ - attr_reader updated_at: String? + attr_reader updated_at: Time? - def updated_at=: (String) -> String + def updated_at=: (Time) -> Time attr_reader url: String? @@ -115,7 +117,7 @@ module Imagekit def initialize: ( ?ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, - ?created_at: String, + ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], ?extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, @@ -131,8 +133,8 @@ module Imagekit ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, - ?type: String, - ?updated_at: String, + ?type: Imagekit::Models::FileUpdateResponse::type_, + ?updated_at: Time, ?url: String, ?version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, ?width: Float @@ -140,7 +142,7 @@ module Imagekit def to_hash: -> { ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, @@ -156,8 +158,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::FileUpdateResponse::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, width: Float @@ -283,6 +285,17 @@ module Imagekit end end + type type_ = :file | :"file-version" + + module Type + extend Imagekit::Internal::Type::Enum + + FILE: :file + FILE_VERSION: :"file-version" + + def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::type_] + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/models/files/version_get_response.rbs b/sig/imagekit/models/files/version_get_response.rbs index bd0fa858..87a89323 100644 --- a/sig/imagekit/models/files/version_get_response.rbs +++ b/sig/imagekit/models/files/version_get_response.rbs @@ -4,7 +4,7 @@ module Imagekit type version_get_response = { ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -19,8 +19,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::Files::VersionGetResponse::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, width: Float @@ -29,9 +29,9 @@ module Imagekit class VersionGetResponse < Imagekit::Internal::Type::BaseModel attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]? - attr_reader created_at: String? + attr_reader created_at: Time? - def created_at=: (String) -> String + def created_at=: (Time) -> Time attr_accessor custom_coordinates: String? @@ -85,13 +85,15 @@ module Imagekit def thumbnail=: (String) -> String - attr_reader type: String? + attr_reader type: Imagekit::Models::Files::VersionGetResponse::type_? - def type=: (String) -> String + def type=: ( + Imagekit::Models::Files::VersionGetResponse::type_ + ) -> Imagekit::Models::Files::VersionGetResponse::type_ - attr_reader updated_at: String? + attr_reader updated_at: Time? - def updated_at=: (String) -> String + def updated_at=: (Time) -> Time attr_reader url: String? @@ -109,7 +111,7 @@ module Imagekit def initialize: ( ?ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, - ?created_at: String, + ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, @@ -124,8 +126,8 @@ module Imagekit ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, - ?type: String, - ?updated_at: String, + ?type: Imagekit::Models::Files::VersionGetResponse::type_, + ?updated_at: Time, ?url: String, ?version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, ?width: Float @@ -133,7 +135,7 @@ module Imagekit def to_hash: -> { ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -148,8 +150,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::Files::VersionGetResponse::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, width: Float @@ -179,6 +181,17 @@ module Imagekit def to_hash: -> { confidence: Float, name: String, source: String } end + type type_ = :file | :"file-version" + + module Type + extend Imagekit::Internal::Type::Enum + + FILE: :file + FILE_VERSION: :"file-version" + + def self?.values: -> ::Array[Imagekit::Models::Files::VersionGetResponse::type_] + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/models/files/version_list_response.rbs b/sig/imagekit/models/files/version_list_response.rbs index 069fcdf0..e2485ef8 100644 --- a/sig/imagekit/models/files/version_list_response.rbs +++ b/sig/imagekit/models/files/version_list_response.rbs @@ -4,7 +4,7 @@ module Imagekit type version_list_response_item = { ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -19,8 +19,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::Files::VersionListResponseItem::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, width: Float @@ -29,9 +29,9 @@ module Imagekit class VersionListResponseItem < Imagekit::Internal::Type::BaseModel attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]? - attr_reader created_at: String? + attr_reader created_at: Time? - def created_at=: (String) -> String + def created_at=: (Time) -> Time attr_accessor custom_coordinates: String? @@ -85,13 +85,15 @@ module Imagekit def thumbnail=: (String) -> String - attr_reader type: String? + attr_reader type: Imagekit::Models::Files::VersionListResponseItem::type_? - def type=: (String) -> String + def type=: ( + Imagekit::Models::Files::VersionListResponseItem::type_ + ) -> Imagekit::Models::Files::VersionListResponseItem::type_ - attr_reader updated_at: String? + attr_reader updated_at: Time? - def updated_at=: (String) -> String + def updated_at=: (Time) -> Time attr_reader url: String? @@ -109,7 +111,7 @@ module Imagekit def initialize: ( ?ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, - ?created_at: String, + ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, @@ -124,8 +126,8 @@ module Imagekit ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, - ?type: String, - ?updated_at: String, + ?type: Imagekit::Models::Files::VersionListResponseItem::type_, + ?updated_at: Time, ?url: String, ?version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, ?width: Float @@ -133,7 +135,7 @@ module Imagekit def to_hash: -> { ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -148,8 +150,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::Files::VersionListResponseItem::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, width: Float @@ -179,6 +181,17 @@ module Imagekit def to_hash: -> { confidence: Float, name: String, source: String } end + type type_ = :file | :"file-version" + + module Type + extend Imagekit::Internal::Type::Enum + + FILE: :file + FILE_VERSION: :"file-version" + + def self?.values: -> ::Array[Imagekit::Models::Files::VersionListResponseItem::type_] + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/models/files/version_restore_response.rbs b/sig/imagekit/models/files/version_restore_response.rbs index d784a92f..55dac25b 100644 --- a/sig/imagekit/models/files/version_restore_response.rbs +++ b/sig/imagekit/models/files/version_restore_response.rbs @@ -4,7 +4,7 @@ module Imagekit type version_restore_response = { ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -19,8 +19,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::Files::VersionRestoreResponse::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, width: Float @@ -29,9 +29,9 @@ module Imagekit class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]? - attr_reader created_at: String? + attr_reader created_at: Time? - def created_at=: (String) -> String + def created_at=: (Time) -> Time attr_accessor custom_coordinates: String? @@ -85,13 +85,15 @@ module Imagekit def thumbnail=: (String) -> String - attr_reader type: String? + attr_reader type: Imagekit::Models::Files::VersionRestoreResponse::type_? - def type=: (String) -> String + def type=: ( + Imagekit::Models::Files::VersionRestoreResponse::type_ + ) -> Imagekit::Models::Files::VersionRestoreResponse::type_ - attr_reader updated_at: String? + attr_reader updated_at: Time? - def updated_at=: (String) -> String + def updated_at=: (Time) -> Time attr_reader url: String? @@ -109,7 +111,7 @@ module Imagekit def initialize: ( ?ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, - ?created_at: String, + ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], ?file_id: String, @@ -124,8 +126,8 @@ module Imagekit ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, - ?type: String, - ?updated_at: String, + ?type: Imagekit::Models::Files::VersionRestoreResponse::type_, + ?updated_at: Time, ?url: String, ?version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, ?width: Float @@ -133,7 +135,7 @@ module Imagekit def to_hash: -> { ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, - created_at: String, + created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], file_id: String, @@ -148,8 +150,8 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: String, - updated_at: String, + type: Imagekit::Models::Files::VersionRestoreResponse::type_, + updated_at: Time, url: String, version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, width: Float @@ -179,6 +181,17 @@ module Imagekit def to_hash: -> { confidence: Float, name: String, source: String } end + type type_ = :file | :"file-version" + + module Type + extend Imagekit::Internal::Type::Enum + + FILE: :file + FILE_VERSION: :"file-version" + + def self?.values: -> ::Array[Imagekit::Models::Files::VersionRestoreResponse::type_] + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/test/imagekit/resources/files/versions_test.rb b/test/imagekit/resources/files/versions_test.rb index 92dcd86c..ca9fa54b 100644 --- a/test/imagekit/resources/files/versions_test.rb +++ b/test/imagekit/resources/files/versions_test.rb @@ -41,7 +41,7 @@ def test_get_required_params assert_pattern do response => { ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionGetResponse::AITag]) | nil, - created_at: String | nil, + created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, file_id: String | nil, @@ -56,8 +56,8 @@ def test_get_required_params size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: String | nil, - updated_at: String | nil, + type: Imagekit::Models::Files::VersionGetResponse::Type | nil, + updated_at: Time | nil, url: String | nil, version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo | nil, width: Float | nil @@ -77,7 +77,7 @@ def test_restore_required_params assert_pattern do response => { ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRestoreResponse::AITag]) | nil, - created_at: String | nil, + created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, file_id: String | nil, @@ -92,8 +92,8 @@ def test_restore_required_params size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: String | nil, - updated_at: String | nil, + type: Imagekit::Models::Files::VersionRestoreResponse::Type | nil, + updated_at: Time | nil, url: String | nil, version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo | nil, width: Float | nil diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index e7728461..3661e07d 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -15,7 +15,7 @@ def test_update assert_pattern do response => { ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUpdateResponse::AITag]) | nil, - created_at: String | nil, + created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus | nil, @@ -31,8 +31,8 @@ def test_update size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: String | nil, - updated_at: String | nil, + type: Imagekit::Models::FileUpdateResponse::Type | nil, + updated_at: Time | nil, url: String | nil, version_info: Imagekit::Models::FileUpdateResponse::VersionInfo | nil, width: Float | nil @@ -79,7 +79,7 @@ def test_get assert_pattern do response => { ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileGetResponse::AITag]) | nil, - created_at: String | nil, + created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, file_id: String | nil, @@ -94,8 +94,8 @@ def test_get size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: String | nil, - updated_at: String | nil, + type: Imagekit::Models::FileGetResponse::Type | nil, + updated_at: Time | nil, url: String | nil, version_info: Imagekit::Models::FileGetResponse::VersionInfo | nil, width: Float | nil From aeccea411ed6a91b77b4d416627c53cc0acf9c44 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 03:15:02 +0000 Subject: [PATCH 039/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 3 +- lib/imagekit/internal/type/base_model.rb | 4 +- lib/imagekit/models.rb | 2 + ...e_response.rb => custom_metadata_field.rb} | 48 +- .../custom_metadata_field_list_response.rb | 233 +--------- .../custom_metadata_field_update_response.rb | 235 ---------- .../resources/custom_metadata_fields.rb | 12 +- rbi/imagekit/models.rbi | 2 + ...response.rbi => custom_metadata_field.rbi} | 108 ++--- .../custom_metadata_field_list_response.rbi | 438 +----------------- .../custom_metadata_field_update_response.rbi | 438 ------------------ .../resources/custom_metadata_fields.rbi | 8 +- sig/imagekit/models.rbs | 2 + ...response.rbs => custom_metadata_field.rbs} | 82 ++-- .../custom_metadata_field_list_response.rbs | 177 +------ .../custom_metadata_field_update_response.rbs | 178 ------- .../resources/custom_metadata_fields.rbs | 4 +- .../resources/custom_metadata_fields_test.rb | 10 +- 19 files changed, 140 insertions(+), 1846 deletions(-) rename lib/imagekit/models/{custom_metadata_field_create_response.rb => custom_metadata_field.rb} (80%) delete mode 100644 lib/imagekit/models/custom_metadata_field_update_response.rb rename rbi/imagekit/models/{custom_metadata_field_create_response.rbi => custom_metadata_field.rbi} (69%) delete mode 100644 rbi/imagekit/models/custom_metadata_field_update_response.rbi rename sig/imagekit/models/{custom_metadata_field_create_response.rbs => custom_metadata_field.rbs} (53%) delete mode 100644 sig/imagekit/models/custom_metadata_field_update_response.rbs diff --git a/.stats.yml b/.stats.yml index 9ac0471d..ec9a7553 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-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml openapi_spec_hash: 98642308bee81ac776b7b1843089b888 -config_hash: 040d180c4960ee032ba08946d86c8764 +config_hash: 733231d3642f7945a9459fbc90ddfb8e diff --git a/lib/imagekit.rb b/lib/imagekit.rb index c44707e5..e55549d2 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -78,14 +78,13 @@ require_relative "imagekit/models/cache/invalidation_create_response" require_relative "imagekit/models/cache/invalidation_get_params" require_relative "imagekit/models/cache/invalidation_get_response" +require_relative "imagekit/models/custom_metadata_field" require_relative "imagekit/models/custom_metadata_field_create_params" -require_relative "imagekit/models/custom_metadata_field_create_response" require_relative "imagekit/models/custom_metadata_field_delete_params" require_relative "imagekit/models/custom_metadata_field_delete_response" require_relative "imagekit/models/custom_metadata_field_list_params" require_relative "imagekit/models/custom_metadata_field_list_response" require_relative "imagekit/models/custom_metadata_field_update_params" -require_relative "imagekit/models/custom_metadata_field_update_response" require_relative "imagekit/models/file_copy_params" require_relative "imagekit/models/file_copy_response" require_relative "imagekit/models/file_delete_params" diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb index 808cf57e..33ab960f 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekit/internal/type/base_model.rb @@ -438,8 +438,8 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `custom_metadata_field_create_response` is a `Imagekit::Models::CustomMetadataFieldCreateResponse` - # custom_metadata_field_create_response => { + # # `custom_metadata_field` is a `Imagekit::CustomMetadataField` + # custom_metadata_field => { # id: id, # label: label, # name: name diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 15a31d95..107d5262 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -47,6 +47,8 @@ module Imagekit Cache = Imagekit::Models::Cache + CustomMetadataField = Imagekit::Models::CustomMetadataField + CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams CustomMetadataFieldDeleteParams = Imagekit::Models::CustomMetadataFieldDeleteParams diff --git a/lib/imagekit/models/custom_metadata_field_create_response.rb b/lib/imagekit/models/custom_metadata_field.rb similarity index 80% rename from lib/imagekit/models/custom_metadata_field_create_response.rb rename to lib/imagekit/models/custom_metadata_field.rb index 951221d6..c82382bc 100644 --- a/lib/imagekit/models/custom_metadata_field_create_response.rb +++ b/lib/imagekit/models/custom_metadata_field.rb @@ -3,7 +3,7 @@ module Imagekit module Models # @see Imagekit::Resources::CustomMetadataFields#create - class CustomMetadataFieldCreateResponse < Imagekit::Internal::Type::BaseModel + class CustomMetadataField < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the custom metadata field. Use this to update the field. # @@ -28,12 +28,12 @@ class CustomMetadataFieldCreateResponse < Imagekit::Internal::Type::BaseModel # @!attribute schema # An object that describes the rules for the custom metadata field value. # - # @return [Imagekit::Models::CustomMetadataFieldCreateResponse::Schema] - required :schema, -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema } + # @return [Imagekit::Models::CustomMetadataField::Schema] + required :schema, -> { Imagekit::CustomMetadataField::Schema } # @!method initialize(id:, label:, name:, schema:) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldCreateResponse} for more details. + # {Imagekit::Models::CustomMetadataField} for more details. # # Object containing details of a custom metadata field. # @@ -43,15 +43,15 @@ class CustomMetadataFieldCreateResponse < Imagekit::Internal::Type::BaseModel # # @param name [String] API name of the custom metadata field. This becomes the key while setting `custo # - # @param schema [Imagekit::Models::CustomMetadataFieldCreateResponse::Schema] An object that describes the rules for the custom metadata field value. + # @param schema [Imagekit::Models::CustomMetadataField::Schema] An object that describes the rules for the custom metadata field value. - # @see Imagekit::Models::CustomMetadataFieldCreateResponse#schema + # @see Imagekit::Models::CustomMetadataField#schema class Schema < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the custom metadata field. # - # @return [Symbol, Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type] - required :type, enum: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type } + # @return [Symbol, Imagekit::Models::CustomMetadataField::Schema::Type] + required :type, enum: -> { Imagekit::CustomMetadataField::Schema::Type } # @!attribute default_value # The default value for this custom metadata field. Date type of default value @@ -59,7 +59,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, Boolean, Array, nil] optional :default_value, - union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue }, + union: -> { Imagekit::CustomMetadataField::Schema::DefaultValue }, api_name: :defaultValue # @!attribute is_value_required @@ -81,7 +81,9 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :max_value, - union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue }, + union: -> { + Imagekit::CustomMetadataField::Schema::MaxValue + }, api_name: :maxValue # @!attribute min_length @@ -97,7 +99,9 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :min_value, - union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue }, + union: -> { + Imagekit::CustomMetadataField::Schema::MinValue + }, api_name: :minValue # @!attribute select_options @@ -105,16 +109,18 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [Array, nil] optional :select_options, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption] }, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::CustomMetadataField::Schema::SelectOption] + }, api_name: :selectOptions # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldCreateResponse::Schema} for more details. + # {Imagekit::Models::CustomMetadataField::Schema} for more details. # # An object that describes the rules for the custom metadata field value. # - # @param type [Symbol, Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type] Type of the custom metadata field. + # @param type [Symbol, Imagekit::Models::CustomMetadataField::Schema::Type] Type of the custom metadata field. # # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Date type of default value dep # @@ -132,7 +138,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # Type of the custom metadata field. # - # @see Imagekit::Models::CustomMetadataFieldCreateResponse::Schema#type + # @see Imagekit::Models::CustomMetadataField::Schema#type module Type extend Imagekit::Internal::Type::Enum @@ -151,7 +157,7 @@ module Type # The default value for this custom metadata field. Date type of default value # depends on the field type. # - # @see Imagekit::Models::CustomMetadataFieldCreateResponse::Schema#default_value + # @see Imagekit::Models::CustomMetadataField::Schema#default_value module DefaultValue extend Imagekit::Internal::Type::Union @@ -162,7 +168,7 @@ module DefaultValue variant Imagekit::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::MixedArray } + variant -> { Imagekit::Models::CustomMetadataField::Schema::DefaultValue::MixedArray } module Mixed extend Imagekit::Internal::Type::Union @@ -182,14 +188,16 @@ module Mixed # @type [Imagekit::Internal::Type::Converter] MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Mixed }] + Imagekit::Internal::Type::ArrayOf[union: -> { + Imagekit::CustomMetadataField::Schema::DefaultValue::Mixed + }] end # 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. # - # @see Imagekit::Models::CustomMetadataFieldCreateResponse::Schema#max_value + # @see Imagekit::Models::CustomMetadataField::Schema#max_value module MaxValue extend Imagekit::Internal::Type::Union @@ -205,7 +213,7 @@ module MaxValue # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::CustomMetadataFieldCreateResponse::Schema#min_value + # @see Imagekit::Models::CustomMetadataField::Schema#min_value module MinValue extend Imagekit::Internal::Type::Union diff --git a/lib/imagekit/models/custom_metadata_field_list_response.rb b/lib/imagekit/models/custom_metadata_field_list_response.rb index b171dc0d..78a32292 100644 --- a/lib/imagekit/models/custom_metadata_field_list_response.rb +++ b/lib/imagekit/models/custom_metadata_field_list_response.rb @@ -2,238 +2,7 @@ module Imagekit module Models - class CustomMetadataFieldListResponseItem < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the custom metadata field. Use this to update the field. - # - # @return [String] - required :id, String - - # @!attribute label - # 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. - # - # @return [String] - required :label, String - - # @!attribute name - # 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. - # - # @return [String] - required :name, String - - # @!attribute schema - # An object that describes the rules for the custom metadata field value. - # - # @return [Imagekit::Models::CustomMetadataFieldListResponseItem::Schema] - required :schema, -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema } - - # @!method initialize(id:, label:, name:, schema:) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldListResponseItem} for more details. - # - # Object containing details of a custom metadata field. - # - # @param id [String] Unique identifier for the custom metadata field. Use this to update the field. - # - # @param label [String] Human readable name of the custom metadata field. This name is displayed as form - # - # @param name [String] API name of the custom metadata field. This becomes the key while setting `custo - # - # @param schema [Imagekit::Models::CustomMetadataFieldListResponseItem::Schema] An object that describes the rules for the custom metadata field value. - - # @see Imagekit::Models::CustomMetadataFieldListResponseItem#schema - class Schema < Imagekit::Internal::Type::BaseModel - # @!attribute type - # Type of the custom metadata field. - # - # @return [Symbol, Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type] - required :type, enum: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type } - - # @!attribute default_value - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - # - # @return [String, Float, Boolean, Array, nil] - optional :default_value, - union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue }, - api_name: :defaultValue - - # @!attribute is_value_required - # Specifies if the this custom metadata field is required or not. - # - # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired - - # @!attribute max_length - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @return [Float, nil] - optional :max_length, Float, api_name: :maxLength - - # @!attribute max_value - # 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. - # - # @return [String, Float, nil] - optional :max_value, - union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue }, - api_name: :maxValue - - # @!attribute min_length - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @return [Float, nil] - optional :min_length, Float, api_name: :minLength - - # @!attribute min_value - # 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. - # - # @return [String, Float, nil] - optional :min_value, - union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue }, - api_name: :minValue - - # @!attribute select_options - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - # - # @return [Array, nil] - optional :select_options, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption] }, - api_name: :selectOptions - - # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldListResponseItem::Schema} for more - # details. - # - # An object that describes the rules for the custom metadata field value. - # - # @param type [Symbol, Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type] Type of the custom metadata field. - # - # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Date type of default value dep - # - # @param is_value_required [Boolean] Specifies if the this custom metadata field is required or not. - # - # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D - # - # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D - # - # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - - # Type of the custom metadata field. - # - # @see Imagekit::Models::CustomMetadataFieldListResponseItem::Schema#type - module Type - extend Imagekit::Internal::Type::Enum - - TEXT = :Text - TEXTAREA = :Textarea - NUMBER = :Number - DATE = :Date - BOOLEAN = :Boolean - SINGLE_SELECT = :SingleSelect - MULTI_SELECT = :MultiSelect - - # @!method self.values - # @return [Array] - end - - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - # - # @see Imagekit::Models::CustomMetadataFieldListResponseItem::Schema#default_value - module DefaultValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::MixedArray } - - module Mixed - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end - - # @!method self.variants - # @return [Array(String, Float, Boolean, Array)] - - # @type [Imagekit::Internal::Type::Converter] - MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Mixed }] - end - - # 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. - # - # @see Imagekit::Models::CustomMetadataFieldListResponseItem::Schema#max_value - module MaxValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end - - # 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. - # - # @see Imagekit::Models::CustomMetadataFieldListResponseItem::Schema#min_value - module MinValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end - - module SelectOption - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end - end - end - # @type [Imagekit::Internal::Type::Converter] - CustomMetadataFieldListResponse = - Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Models::CustomMetadataFieldListResponseItem }] + CustomMetadataFieldListResponse = Imagekit::Internal::Type::ArrayOf[-> { Imagekit::CustomMetadataField }] end end diff --git a/lib/imagekit/models/custom_metadata_field_update_response.rb b/lib/imagekit/models/custom_metadata_field_update_response.rb deleted file mode 100644 index 5c68c8b5..00000000 --- a/lib/imagekit/models/custom_metadata_field_update_response.rb +++ /dev/null @@ -1,235 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::CustomMetadataFields#update - class CustomMetadataFieldUpdateResponse < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the custom metadata field. Use this to update the field. - # - # @return [String] - required :id, String - - # @!attribute label - # 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. - # - # @return [String] - required :label, String - - # @!attribute name - # 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. - # - # @return [String] - required :name, String - - # @!attribute schema - # An object that describes the rules for the custom metadata field value. - # - # @return [Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema] - required :schema, -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema } - - # @!method initialize(id:, label:, name:, schema:) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldUpdateResponse} for more details. - # - # Object containing details of a custom metadata field. - # - # @param id [String] Unique identifier for the custom metadata field. Use this to update the field. - # - # @param label [String] Human readable name of the custom metadata field. This name is displayed as form - # - # @param name [String] API name of the custom metadata field. This becomes the key while setting `custo - # - # @param schema [Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema] An object that describes the rules for the custom metadata field value. - - # @see Imagekit::Models::CustomMetadataFieldUpdateResponse#schema - class Schema < Imagekit::Internal::Type::BaseModel - # @!attribute type - # Type of the custom metadata field. - # - # @return [Symbol, Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type] - required :type, enum: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type } - - # @!attribute default_value - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - # - # @return [String, Float, Boolean, Array, nil] - optional :default_value, - union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue }, - api_name: :defaultValue - - # @!attribute is_value_required - # Specifies if the this custom metadata field is required or not. - # - # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired - - # @!attribute max_length - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @return [Float, nil] - optional :max_length, Float, api_name: :maxLength - - # @!attribute max_value - # 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. - # - # @return [String, Float, nil] - optional :max_value, - union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue }, - api_name: :maxValue - - # @!attribute min_length - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @return [Float, nil] - optional :min_length, Float, api_name: :minLength - - # @!attribute min_value - # 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. - # - # @return [String, Float, nil] - optional :min_value, - union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue }, - api_name: :minValue - - # @!attribute select_options - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - # - # @return [Array, nil] - optional :select_options, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption] }, - api_name: :selectOptions - - # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema} for more details. - # - # An object that describes the rules for the custom metadata field value. - # - # @param type [Symbol, Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type] Type of the custom metadata field. - # - # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Date type of default value dep - # - # @param is_value_required [Boolean] Specifies if the this custom metadata field is required or not. - # - # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D - # - # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D - # - # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - - # Type of the custom metadata field. - # - # @see Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema#type - module Type - extend Imagekit::Internal::Type::Enum - - TEXT = :Text - TEXTAREA = :Textarea - NUMBER = :Number - DATE = :Date - BOOLEAN = :Boolean - SINGLE_SELECT = :SingleSelect - MULTI_SELECT = :MultiSelect - - # @!method self.values - # @return [Array] - end - - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - # - # @see Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema#default_value - module DefaultValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::MixedArray } - - module Mixed - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end - - # @!method self.variants - # @return [Array(String, Float, Boolean, Array)] - - # @type [Imagekit::Internal::Type::Converter] - MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Mixed }] - end - - # 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. - # - # @see Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema#max_value - module MaxValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end - - # 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. - # - # @see Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema#min_value - module MinValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end - - module SelectOption - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end - end - end - end -end diff --git a/lib/imagekit/resources/custom_metadata_fields.rb b/lib/imagekit/resources/custom_metadata_fields.rb index 1a961c67..29da6980 100644 --- a/lib/imagekit/resources/custom_metadata_fields.rb +++ b/lib/imagekit/resources/custom_metadata_fields.rb @@ -21,7 +21,7 @@ class CustomMetadataFields # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::CustomMetadataFieldCreateResponse] + # @return [Imagekit::Models::CustomMetadataField] # # @see Imagekit::Models::CustomMetadataFieldCreateParams def create(params) @@ -30,7 +30,7 @@ def create(params) method: :post, path: "v1/customMetadataFields", body: parsed, - model: Imagekit::Models::CustomMetadataFieldCreateResponse, + model: Imagekit::CustomMetadataField, options: options ) end @@ -50,7 +50,7 @@ def create(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::CustomMetadataFieldUpdateResponse] + # @return [Imagekit::Models::CustomMetadataField] # # @see Imagekit::Models::CustomMetadataFieldUpdateParams def update(id, params = {}) @@ -59,7 +59,7 @@ def update(id, params = {}) method: :patch, path: ["v1/customMetadataFields/%1$s", id], body: parsed, - model: Imagekit::Models::CustomMetadataFieldUpdateResponse, + model: Imagekit::CustomMetadataField, options: options ) end @@ -77,7 +77,7 @@ def update(id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::CustomMetadataFieldListParams def list(params = {}) @@ -86,7 +86,7 @@ def list(params = {}) method: :get, path: "v1/customMetadataFields", query: parsed.transform_keys(include_deleted: "includeDeleted"), - model: Imagekit::Internal::Type::ArrayOf[Imagekit::Models::CustomMetadataFieldListResponseItem], + model: Imagekit::Internal::Type::ArrayOf[Imagekit::CustomMetadataField], options: options ) end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 85969296..b0b43162 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -9,6 +9,8 @@ module Imagekit Cache = Imagekit::Models::Cache + CustomMetadataField = Imagekit::Models::CustomMetadataField + CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams diff --git a/rbi/imagekit/models/custom_metadata_field_create_response.rbi b/rbi/imagekit/models/custom_metadata_field.rbi similarity index 69% rename from rbi/imagekit/models/custom_metadata_field_create_response.rbi rename to rbi/imagekit/models/custom_metadata_field.rbi index e34bb551..eb7b8b93 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field.rbi @@ -2,13 +2,10 @@ module Imagekit module Models - class CustomMetadataFieldCreateResponse < Imagekit::Internal::Type::BaseModel + class CustomMetadataField < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do - T.any( - Imagekit::Models::CustomMetadataFieldCreateResponse, - Imagekit::Internal::AnyHash - ) + T.any(Imagekit::CustomMetadataField, Imagekit::Internal::AnyHash) end # Unique identifier for the custom metadata field. Use this to update the field. @@ -27,17 +24,10 @@ module Imagekit attr_accessor :name # An object that describes the rules for the custom metadata field value. - sig do - returns(Imagekit::Models::CustomMetadataFieldCreateResponse::Schema) - end + sig { returns(Imagekit::CustomMetadataField::Schema) } attr_reader :schema - sig do - params( - schema: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::OrHash - ).void - end + sig { params(schema: Imagekit::CustomMetadataField::Schema::OrHash).void } attr_writer :schema # Object containing details of a custom metadata field. @@ -46,8 +36,7 @@ module Imagekit id: String, label: String, name: String, - schema: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::OrHash + schema: Imagekit::CustomMetadataField::Schema::OrHash ).returns(T.attached_class) end def self.new( @@ -71,7 +60,7 @@ module Imagekit id: String, label: String, name: String, - schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + schema: Imagekit::CustomMetadataField::Schema } ) end @@ -82,16 +71,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema, + Imagekit::CustomMetadataField::Schema, Imagekit::Internal::AnyHash ) end # Type of the custom metadata field. sig do - returns( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol - ) + returns(Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol) end attr_accessor :type @@ -100,7 +87,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants + Imagekit::CustomMetadataField::Schema::DefaultValue::Variants ) ) end @@ -109,7 +96,7 @@ module Imagekit sig do params( default_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants + Imagekit::CustomMetadataField::Schema::DefaultValue::Variants ).void end attr_writer :default_value @@ -133,17 +120,14 @@ module Imagekit # field, it will be a numeric value. sig do returns( - T.nilable( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants - ) + T.nilable(Imagekit::CustomMetadataField::Schema::MaxValue::Variants) ) end attr_reader :max_value sig do params( - max_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants + max_value: Imagekit::CustomMetadataField::Schema::MaxValue::Variants ).void end attr_writer :max_value @@ -160,17 +144,14 @@ module Imagekit # field, it will be a numeric value. sig do returns( - T.nilable( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants - ) + T.nilable(Imagekit::CustomMetadataField::Schema::MinValue::Variants) ) end attr_reader :min_value sig do params( - min_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants + min_value: Imagekit::CustomMetadataField::Schema::MinValue::Variants ).void end attr_writer :min_value @@ -180,7 +161,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + Imagekit::CustomMetadataField::Schema::SelectOption::Variants ] ) ) @@ -191,7 +172,7 @@ module Imagekit params( select_options: T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + Imagekit::CustomMetadataField::Schema::SelectOption::Variants ] ).void end @@ -200,20 +181,19 @@ module Imagekit # An object that describes the rules for the custom metadata field value. sig do params( - type: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::OrSymbol, + type: Imagekit::CustomMetadataField::Schema::Type::OrSymbol, default_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants, + Imagekit::CustomMetadataField::Schema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants, + Imagekit::CustomMetadataField::Schema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants, + Imagekit::CustomMetadataField::Schema::MinValue::Variants, select_options: T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + Imagekit::CustomMetadataField::Schema::SelectOption::Variants ] ).returns(T.attached_class) end @@ -245,20 +225,19 @@ module Imagekit sig do override.returns( { - type: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol, + type: Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol, default_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants, + Imagekit::CustomMetadataField::Schema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants, + Imagekit::CustomMetadataField::Schema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants, + Imagekit::CustomMetadataField::Schema::MinValue::Variants, select_options: T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + Imagekit::CustomMetadataField::Schema::SelectOption::Variants ] } ) @@ -272,53 +251,50 @@ module Imagekit TaggedSymbol = T.type_alias do - T.all( - Symbol, - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type - ) + T.all(Symbol, Imagekit::CustomMetadataField::Schema::Type) end OrSymbol = T.type_alias { T.any(Symbol, String) } TEXT = T.let( :Text, - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol ) TEXTAREA = T.let( :Textarea, - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol ) NUMBER = T.let( :Number, - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol ) DATE = T.let( :Date, - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol ) BOOLEAN = T.let( :Boolean, - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol ) SINGLE_SELECT = T.let( :SingleSelect, - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol ) MULTI_SELECT = T.let( :MultiSelect, - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::Type::TaggedSymbol + Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol ] ) end @@ -338,7 +314,7 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Mixed::Variants + Imagekit::CustomMetadataField::Schema::DefaultValue::Mixed::Variants ] ) end @@ -351,7 +327,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Mixed::Variants + Imagekit::CustomMetadataField::Schema::DefaultValue::Mixed::Variants ] ) end @@ -362,7 +338,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Variants + Imagekit::CustomMetadataField::Schema::DefaultValue::Variants ] ) end @@ -373,7 +349,7 @@ module Imagekit T.let( Imagekit::Internal::Type::ArrayOf[ union: - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::Mixed + Imagekit::CustomMetadataField::Schema::DefaultValue::Mixed ], Imagekit::Internal::Type::Converter ) @@ -390,7 +366,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MaxValue::Variants + Imagekit::CustomMetadataField::Schema::MaxValue::Variants ] ) end @@ -409,7 +385,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::MinValue::Variants + Imagekit::CustomMetadataField::Schema::MinValue::Variants ] ) end @@ -425,7 +401,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::SelectOption::Variants + Imagekit::CustomMetadataField::Schema::SelectOption::Variants ] ) end diff --git a/rbi/imagekit/models/custom_metadata_field_list_response.rbi b/rbi/imagekit/models/custom_metadata_field_list_response.rbi index 14bb8140..ca0368f0 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_response.rbi +++ b/rbi/imagekit/models/custom_metadata_field_list_response.rbi @@ -2,445 +2,9 @@ module Imagekit module Models - class CustomMetadataFieldListResponseItem < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::CustomMetadataFieldListResponseItem, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier for the custom metadata field. Use this to update the field. - sig { returns(String) } - attr_accessor :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. - sig { returns(String) } - attr_accessor :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. - sig { returns(String) } - attr_accessor :name - - # An object that describes the rules for the custom metadata field value. - sig do - returns(Imagekit::Models::CustomMetadataFieldListResponseItem::Schema) - end - attr_reader :schema - - sig do - params( - schema: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::OrHash - ).void - end - attr_writer :schema - - # Object containing details of a custom metadata field. - sig do - params( - id: String, - label: String, - name: String, - schema: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::OrHash - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the custom metadata field. Use this to update the field. - 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. - 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. - name:, - # An object that describes the rules for the custom metadata field value. - schema: - ) - end - - sig do - override.returns( - { - id: String, - label: String, - name: String, - schema: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema - } - ) - end - def to_hash - end - - class Schema < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema, - Imagekit::Internal::AnyHash - ) - end - - # Type of the custom metadata field. - sig do - returns( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ) - end - attr_accessor :type - - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - sig do - returns( - T.nilable( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants - ) - ) - end - attr_reader :default_value - - sig do - params( - default_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants - ).void - end - attr_writer :default_value - - # Specifies if the this custom metadata field is required or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_value_required - - sig { params(is_value_required: T::Boolean).void } - attr_writer :is_value_required - - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - sig { returns(T.nilable(Float)) } - attr_reader :max_length - - sig { params(max_length: Float).void } - attr_writer :max_length - - # 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. - sig do - returns( - T.nilable( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants - ) - ) - end - attr_reader :max_value - - sig do - params( - max_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants - ).void - end - attr_writer :max_value - - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - sig { returns(T.nilable(Float)) } - attr_reader :min_length - - sig { params(min_length: Float).void } - attr_writer :min_length - - # 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. - sig do - returns( - T.nilable( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants - ) - ) - end - attr_reader :min_value - - sig do - params( - min_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants - ).void - end - attr_writer :min_value - - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - sig do - returns( - T.nilable( - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants - ] - ) - ) - end - attr_reader :select_options - - sig do - params( - select_options: - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants - ] - ).void - end - attr_writer :select_options - - # An object that describes the rules for the custom metadata field value. - sig do - params( - type: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::OrSymbol, - default_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants, - is_value_required: T::Boolean, - max_length: Float, - max_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants, - min_length: Float, - min_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants, - select_options: - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants - ] - ).returns(T.attached_class) - end - def self.new( - # Type of the custom metadata field. - type:, - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - default_value: nil, - # Specifies if the this custom metadata field is required or not. - is_value_required: nil, - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - max_length: nil, - # 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. - max_value: nil, - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - min_length: nil, - # 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. - min_value: nil, - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - select_options: nil - ) - end - - sig do - override.returns( - { - type: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol, - default_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants, - is_value_required: T::Boolean, - max_length: Float, - max_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants, - min_length: Float, - min_value: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants, - select_options: - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants - ] - } - ) - end - def to_hash - end - - # Type of the custom metadata field. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TEXT = - T.let( - :Text, - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ) - TEXTAREA = - T.let( - :Textarea, - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ) - NUMBER = - T.let( - :Number, - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ) - DATE = - T.let( - :Date, - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ) - BOOLEAN = - T.let( - :Boolean, - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ) - SINGLE_SELECT = - T.let( - :SingleSelect, - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ) - MULTI_SELECT = - T.let( - :MultiSelect, - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - module DefaultValue - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - String, - Float, - T::Boolean, - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Mixed::Variants - ] - ) - end - - module Mixed - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Mixed::Variants - ] - ) - end - def self.variants - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Variants - ] - ) - end - def self.variants - end - - MixedArray = - T.let( - Imagekit::Internal::Type::ArrayOf[ - union: - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::Mixed - ], - Imagekit::Internal::Type::Converter - ) - end - - # 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. - module MaxValue - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MaxValue::Variants - ] - ) - end - def self.variants - end - end - - # 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. - module MinValue - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::MinValue::Variants - ] - ) - end - def self.variants - end - end - - module SelectOption - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::SelectOption::Variants - ] - ) - end - def self.variants - end - end - end - end - CustomMetadataFieldListResponse = T.let( - Imagekit::Internal::Type::ArrayOf[ - Imagekit::Models::CustomMetadataFieldListResponseItem - ], + Imagekit::Internal::Type::ArrayOf[Imagekit::CustomMetadataField], Imagekit::Internal::Type::Converter ) end diff --git a/rbi/imagekit/models/custom_metadata_field_update_response.rbi b/rbi/imagekit/models/custom_metadata_field_update_response.rbi deleted file mode 100644 index 6d053beb..00000000 --- a/rbi/imagekit/models/custom_metadata_field_update_response.rbi +++ /dev/null @@ -1,438 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class CustomMetadataFieldUpdateResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::CustomMetadataFieldUpdateResponse, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier for the custom metadata field. Use this to update the field. - sig { returns(String) } - attr_accessor :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. - sig { returns(String) } - attr_accessor :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. - sig { returns(String) } - attr_accessor :name - - # An object that describes the rules for the custom metadata field value. - sig do - returns(Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema) - end - attr_reader :schema - - sig do - params( - schema: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::OrHash - ).void - end - attr_writer :schema - - # Object containing details of a custom metadata field. - sig do - params( - id: String, - label: String, - name: String, - schema: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::OrHash - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the custom metadata field. Use this to update the field. - 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. - 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. - name:, - # An object that describes the rules for the custom metadata field value. - schema: - ) - end - - sig do - override.returns( - { - id: String, - label: String, - name: String, - schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema - } - ) - end - def to_hash - end - - class Schema < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema, - Imagekit::Internal::AnyHash - ) - end - - # Type of the custom metadata field. - sig do - returns( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ) - end - attr_accessor :type - - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - sig do - returns( - T.nilable( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants - ) - ) - end - attr_reader :default_value - - sig do - params( - default_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants - ).void - end - attr_writer :default_value - - # Specifies if the this custom metadata field is required or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_value_required - - sig { params(is_value_required: T::Boolean).void } - attr_writer :is_value_required - - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - sig { returns(T.nilable(Float)) } - attr_reader :max_length - - sig { params(max_length: Float).void } - attr_writer :max_length - - # 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. - sig do - returns( - T.nilable( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants - ) - ) - end - attr_reader :max_value - - sig do - params( - max_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants - ).void - end - attr_writer :max_value - - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - sig { returns(T.nilable(Float)) } - attr_reader :min_length - - sig { params(min_length: Float).void } - attr_writer :min_length - - # 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. - sig do - returns( - T.nilable( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants - ) - ) - end - attr_reader :min_value - - sig do - params( - min_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants - ).void - end - attr_writer :min_value - - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - sig do - returns( - T.nilable( - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants - ] - ) - ) - end - attr_reader :select_options - - sig do - params( - select_options: - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants - ] - ).void - end - attr_writer :select_options - - # An object that describes the rules for the custom metadata field value. - sig do - params( - type: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::OrSymbol, - default_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants, - is_value_required: T::Boolean, - max_length: Float, - max_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants, - min_length: Float, - min_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants, - select_options: - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants - ] - ).returns(T.attached_class) - end - def self.new( - # Type of the custom metadata field. - type:, - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - default_value: nil, - # Specifies if the this custom metadata field is required or not. - is_value_required: nil, - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - max_length: nil, - # 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. - max_value: nil, - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - min_length: nil, - # 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. - min_value: nil, - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - select_options: nil - ) - end - - sig do - override.returns( - { - type: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol, - default_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants, - is_value_required: T::Boolean, - max_length: Float, - max_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants, - min_length: Float, - min_value: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants, - select_options: - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants - ] - } - ) - end - def to_hash - end - - # Type of the custom metadata field. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TEXT = - T.let( - :Text, - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ) - TEXTAREA = - T.let( - :Textarea, - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ) - NUMBER = - T.let( - :Number, - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ) - DATE = - T.let( - :Date, - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ) - BOOLEAN = - T.let( - :Boolean, - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ) - SINGLE_SELECT = - T.let( - :SingleSelect, - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ) - MULTI_SELECT = - T.let( - :MultiSelect, - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - - # The default value for this custom metadata field. Date type of default value - # depends on the field type. - module DefaultValue - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - String, - Float, - T::Boolean, - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Mixed::Variants - ] - ) - end - - module Mixed - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Mixed::Variants - ] - ) - end - def self.variants - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Variants - ] - ) - end - def self.variants - end - - MixedArray = - T.let( - Imagekit::Internal::Type::ArrayOf[ - union: - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::Mixed - ], - Imagekit::Internal::Type::Converter - ) - end - - # 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. - module MaxValue - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MaxValue::Variants - ] - ) - end - def self.variants - end - end - - # 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. - module MinValue - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::MinValue::Variants - ] - ) - end - def self.variants - end - end - - module SelectOption - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::SelectOption::Variants - ] - ) - end - def self.variants - end - end - end - end - end -end diff --git a/rbi/imagekit/resources/custom_metadata_fields.rbi b/rbi/imagekit/resources/custom_metadata_fields.rbi index 68588ebd..ed2578c3 100644 --- a/rbi/imagekit/resources/custom_metadata_fields.rbi +++ b/rbi/imagekit/resources/custom_metadata_fields.rbi @@ -13,7 +13,7 @@ module Imagekit name: String, schema: Imagekit::CustomMetadataFieldCreateParams::Schema::OrHash, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::CustomMetadataFieldCreateResponse) + ).returns(Imagekit::CustomMetadataField) end def create( # Human readable name of the custom metadata field. This should be unique across @@ -36,7 +36,7 @@ module Imagekit label: String, schema: Imagekit::CustomMetadataFieldUpdateParams::Schema::OrHash, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::CustomMetadataFieldUpdateResponse) + ).returns(Imagekit::CustomMetadataField) end def update( # Should be a valid custom metadata field id. @@ -62,9 +62,7 @@ module Imagekit params( include_deleted: T::Boolean, request_options: Imagekit::RequestOptions::OrHash - ).returns( - T::Array[Imagekit::Models::CustomMetadataFieldListResponseItem] - ) + ).returns(T::Array[Imagekit::CustomMetadataField]) end def list( # Set it to `true` to include deleted field objects in the API response. diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index e7b3dc30..49237be6 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -7,6 +7,8 @@ module Imagekit module Cache = Imagekit::Models::Cache + class CustomMetadataField = Imagekit::Models::CustomMetadataField + class CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams class CustomMetadataFieldDeleteParams = Imagekit::Models::CustomMetadataFieldDeleteParams diff --git a/sig/imagekit/models/custom_metadata_field_create_response.rbs b/sig/imagekit/models/custom_metadata_field.rbs similarity index 53% rename from sig/imagekit/models/custom_metadata_field_create_response.rbs rename to sig/imagekit/models/custom_metadata_field.rbs index 935841e0..c141a507 100644 --- a/sig/imagekit/models/custom_metadata_field_create_response.rbs +++ b/sig/imagekit/models/custom_metadata_field.rbs @@ -1,56 +1,56 @@ module Imagekit module Models - type custom_metadata_field_create_response = + type custom_metadata_field = { id: String, label: String, name: String, - schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + schema: Imagekit::CustomMetadataField::Schema } - class CustomMetadataFieldCreateResponse < Imagekit::Internal::Type::BaseModel + class CustomMetadataField < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor label: String attr_accessor name: String - attr_accessor schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + attr_accessor schema: Imagekit::CustomMetadataField::Schema def initialize: ( id: String, label: String, name: String, - schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + schema: Imagekit::CustomMetadataField::Schema ) -> void def to_hash: -> { id: String, label: String, name: String, - schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + schema: Imagekit::CustomMetadataField::Schema } type schema = { - type: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_, - default_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value, + type: Imagekit::Models::CustomMetadataField::Schema::type_, + default_value: Imagekit::Models::CustomMetadataField::Schema::default_value, is_value_required: bool, max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value, + max_value: Imagekit::Models::CustomMetadataField::Schema::max_value, min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + min_value: Imagekit::Models::CustomMetadataField::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] } class Schema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_ + attr_accessor type: Imagekit::Models::CustomMetadataField::Schema::type_ - attr_reader default_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value? + attr_reader default_value: Imagekit::Models::CustomMetadataField::Schema::default_value? def default_value=: ( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value - ) -> Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value + Imagekit::Models::CustomMetadataField::Schema::default_value + ) -> Imagekit::Models::CustomMetadataField::Schema::default_value attr_reader is_value_required: bool? @@ -60,48 +60,48 @@ module Imagekit def max_length=: (Float) -> Float - attr_reader max_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value? + attr_reader max_value: Imagekit::Models::CustomMetadataField::Schema::max_value? def max_value=: ( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value - ) -> Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value + Imagekit::Models::CustomMetadataField::Schema::max_value + ) -> Imagekit::Models::CustomMetadataField::Schema::max_value attr_reader min_length: Float? def min_length=: (Float) -> Float - attr_reader min_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value? + attr_reader min_value: Imagekit::Models::CustomMetadataField::Schema::min_value? def min_value=: ( - Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value - ) -> Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value + Imagekit::Models::CustomMetadataField::Schema::min_value + ) -> Imagekit::Models::CustomMetadataField::Schema::min_value - attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option]? + attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option]? def select_options=: ( - ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] - ) -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] + ) -> ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] def initialize: ( - type: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_, - ?default_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value, + type: Imagekit::Models::CustomMetadataField::Schema::type_, + ?default_value: Imagekit::Models::CustomMetadataField::Schema::default_value, ?is_value_required: bool, ?max_length: Float, - ?max_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value, + ?max_value: Imagekit::Models::CustomMetadataField::Schema::max_value, ?min_length: Float, - ?min_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value, - ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + ?min_value: Imagekit::Models::CustomMetadataField::Schema::min_value, + ?select_options: ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] ) -> void def to_hash: -> { - type: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_, - default_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value, + type: Imagekit::Models::CustomMetadataField::Schema::type_, + default_value: Imagekit::Models::CustomMetadataField::Schema::default_value, is_value_required: bool, max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value, + max_value: Imagekit::Models::CustomMetadataField::Schema::max_value, min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + min_value: Imagekit::Models::CustomMetadataField::Schema::min_value, + select_options: ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] } type type_ = @@ -124,14 +124,14 @@ module Imagekit SINGLE_SELECT: :SingleSelect MULTI_SELECT: :MultiSelect - def self?.values: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::type_] + def self?.values: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::type_] end type default_value = String | Float | bool - | ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::mixed] + | ::Array[Imagekit::Models::CustomMetadataField::Schema::DefaultValue::mixed] module DefaultValue extend Imagekit::Internal::Type::Union @@ -141,10 +141,10 @@ module Imagekit module Mixed extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::DefaultValue::mixed] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::DefaultValue::mixed] end - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::default_value] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::default_value] MixedArray: Imagekit::Internal::Type::Converter end @@ -154,7 +154,7 @@ module Imagekit module MaxValue extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::max_value] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::max_value] end type min_value = String | Float @@ -162,7 +162,7 @@ module Imagekit module MinValue extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::min_value] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::min_value] end type select_option = String | Float | bool @@ -170,7 +170,7 @@ module Imagekit module SelectOption extend Imagekit::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateResponse::Schema::select_option] + def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] end end end diff --git a/sig/imagekit/models/custom_metadata_field_list_response.rbs b/sig/imagekit/models/custom_metadata_field_list_response.rbs index 3e856b70..7aa86e95 100644 --- a/sig/imagekit/models/custom_metadata_field_list_response.rbs +++ b/sig/imagekit/models/custom_metadata_field_list_response.rbs @@ -1,182 +1,7 @@ module Imagekit module Models - type custom_metadata_field_list_response_item = - { - id: String, - label: String, - name: String, - schema: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema - } - - class CustomMetadataFieldListResponseItem < Imagekit::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor label: String - - attr_accessor name: String - - attr_accessor schema: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema - - def initialize: ( - id: String, - label: String, - name: String, - schema: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema - ) -> void - - def to_hash: -> { - id: String, - label: String, - name: String, - schema: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema - } - - type schema = - { - type: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_, - default_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] - } - - class Schema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_ - - attr_reader default_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value? - - def default_value=: ( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value - ) -> Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value? - - def max_value=: ( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value - ) -> Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value? - - def min_value=: ( - Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value - ) -> Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value - - attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] - ) -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] - - def initialize: ( - type: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_, - ?default_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value, - ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] - ) -> void - - def to_hash: -> { - type: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_, - default_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem::Schema::select_option] - end - end - end - type custom_metadata_field_list_response = - ::Array[Imagekit::Models::CustomMetadataFieldListResponseItem] + ::Array[Imagekit::CustomMetadataField] CustomMetadataFieldListResponse: Imagekit::Internal::Type::Converter end diff --git a/sig/imagekit/models/custom_metadata_field_update_response.rbs b/sig/imagekit/models/custom_metadata_field_update_response.rbs deleted file mode 100644 index 118286b5..00000000 --- a/sig/imagekit/models/custom_metadata_field_update_response.rbs +++ /dev/null @@ -1,178 +0,0 @@ -module Imagekit - module Models - type custom_metadata_field_update_response = - { - id: String, - label: String, - name: String, - schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema - } - - class CustomMetadataFieldUpdateResponse < Imagekit::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor label: String - - attr_accessor name: String - - attr_accessor schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema - - def initialize: ( - id: String, - label: String, - name: String, - schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema - ) -> void - - def to_hash: -> { - id: String, - label: String, - name: String, - schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema - } - - type schema = - { - type: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_, - default_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] - } - - class Schema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_ - - attr_reader default_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value? - - def default_value=: ( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value - ) -> Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value? - - def max_value=: ( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value - ) -> Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value? - - def min_value=: ( - Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value - ) -> Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value - - attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] - ) -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] - - def initialize: ( - type: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_, - ?default_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value, - ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] - ) -> void - - def to_hash: -> { - type: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_, - default_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema::select_option] - end - end - end - end -end diff --git a/sig/imagekit/resources/custom_metadata_fields.rbs b/sig/imagekit/resources/custom_metadata_fields.rbs index 1a6850e9..f14f6f73 100644 --- a/sig/imagekit/resources/custom_metadata_fields.rbs +++ b/sig/imagekit/resources/custom_metadata_fields.rbs @@ -6,14 +6,14 @@ module Imagekit name: String, schema: Imagekit::CustomMetadataFieldCreateParams::Schema, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::CustomMetadataFieldCreateResponse + ) -> Imagekit::CustomMetadataField def update: ( String id, ?label: String, ?schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::CustomMetadataFieldUpdateResponse + ) -> Imagekit::CustomMetadataField def list: ( ?include_deleted: bool, diff --git a/test/imagekit/resources/custom_metadata_fields_test.rb b/test/imagekit/resources/custom_metadata_fields_test.rb index f5a22676..c87be2e5 100644 --- a/test/imagekit/resources/custom_metadata_fields_test.rb +++ b/test/imagekit/resources/custom_metadata_fields_test.rb @@ -10,7 +10,7 @@ def test_create_required_params @image_kit.custom_metadata_fields.create(label: "price", name: "price", schema: {type: :Number}) assert_pattern do - response => Imagekit::Models::CustomMetadataFieldCreateResponse + response => Imagekit::CustomMetadataField end assert_pattern do @@ -18,7 +18,7 @@ def test_create_required_params id: String, label: String, name: String, - schema: Imagekit::Models::CustomMetadataFieldCreateResponse::Schema + schema: Imagekit::CustomMetadataField::Schema } end end @@ -29,7 +29,7 @@ def test_update response = @image_kit.custom_metadata_fields.update("id") assert_pattern do - response => Imagekit::Models::CustomMetadataFieldUpdateResponse + response => Imagekit::CustomMetadataField end assert_pattern do @@ -37,7 +37,7 @@ def test_update id: String, label: String, name: String, - schema: Imagekit::Models::CustomMetadataFieldUpdateResponse::Schema + schema: Imagekit::CustomMetadataField::Schema } end end @@ -48,7 +48,7 @@ def test_list response = @image_kit.custom_metadata_fields.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::CustomMetadataFieldListResponseItem]) + response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::CustomMetadataField]) end end From f170ad3fbe8451cc5060a4dbf8f992333ce21b06 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 03:19:40 +0000 Subject: [PATCH 040/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 5 +- lib/imagekit/models.rb | 4 + lib/imagekit/models/asset_list_response.rb | 333 +--------- .../models/{file_get_response.rb => file.rb} | 30 +- lib/imagekit/models/file_update_response.rb | 254 +------- .../models/files/version_get_response.rb | 264 -------- .../models/files/version_list_response.rb | 259 +------- .../models/files/version_restore_response.rb | 264 -------- lib/imagekit/models/folder.rb | 76 +++ lib/imagekit/resources/assets.rb | 2 +- lib/imagekit/resources/files.rb | 4 +- lib/imagekit/resources/files/versions.rb | 12 +- rbi/imagekit/models.rbi | 4 + rbi/imagekit/models/asset_list_response.rbi | 591 +----------------- .../{file_get_response.rbi => file.rbi} | 73 +-- rbi/imagekit/models/file_update_response.rbi | 388 +----------- .../models/files/version_get_response.rbi | 433 ------------- .../models/files/version_list_response.rbi | 439 +------------ .../models/files/version_restore_response.rbi | 442 ------------- rbi/imagekit/models/folder.rbi | 117 ++++ rbi/imagekit/resources/files.rbi | 2 +- rbi/imagekit/resources/files/versions.rbi | 6 +- sig/imagekit/models.rbs | 4 + sig/imagekit/models/asset_list_response.rbs | 278 +------- .../{file_get_response.rbs => file.rbs} | 38 +- sig/imagekit/models/file_update_response.rbs | 208 +----- .../models/files/version_get_response.rbs | 213 ------- .../models/files/version_list_response.rbs | 211 +------ .../models/files/version_restore_response.rbs | 213 ------- sig/imagekit/models/folder.rbs | 69 ++ sig/imagekit/resources/files.rbs | 2 +- sig/imagekit/resources/files/versions.rbs | 4 +- .../imagekit/resources/files/versions_test.rb | 18 +- test/imagekit/resources/files_test.rb | 35 +- 35 files changed, 381 insertions(+), 4916 deletions(-) rename lib/imagekit/models/{file_get_response.rb => file.rb} (87%) delete mode 100644 lib/imagekit/models/files/version_get_response.rb delete mode 100644 lib/imagekit/models/files/version_restore_response.rb create mode 100644 lib/imagekit/models/folder.rb rename rbi/imagekit/models/{file_get_response.rbi => file.rbi} (83%) delete mode 100644 rbi/imagekit/models/files/version_get_response.rbi delete mode 100644 rbi/imagekit/models/files/version_restore_response.rbi create mode 100644 rbi/imagekit/models/folder.rbi rename sig/imagekit/models/{file_get_response.rbs => file.rbs} (77%) delete mode 100644 sig/imagekit/models/files/version_get_response.rbs delete mode 100644 sig/imagekit/models/files/version_restore_response.rbs create mode 100644 sig/imagekit/models/folder.rbs diff --git a/.stats.yml b/.stats.yml index ec9a7553..0fe111b5 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-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml openapi_spec_hash: 98642308bee81ac776b7b1843089b888 -config_hash: 733231d3642f7945a9459fbc90ddfb8e +config_hash: 91cbeb97fdb75393dffd187ec25a4080 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index e55549d2..345512fb 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -50,6 +50,7 @@ require_relative "imagekit/internal/transport/base_client" require_relative "imagekit/internal/transport/pooled_net_requester" require_relative "imagekit/client" +require_relative "imagekit/models/file" require_relative "imagekit/models/accounts/origin_create_params" require_relative "imagekit/models/accounts/origin_create_response" require_relative "imagekit/models/accounts/origin_delete_params" @@ -89,7 +90,6 @@ require_relative "imagekit/models/file_copy_response" require_relative "imagekit/models/file_delete_params" require_relative "imagekit/models/file_get_params" -require_relative "imagekit/models/file_get_response" require_relative "imagekit/models/file_move_params" require_relative "imagekit/models/file_move_response" require_relative "imagekit/models/file_rename_params" @@ -109,15 +109,14 @@ require_relative "imagekit/models/files/version_delete_params" require_relative "imagekit/models/files/version_delete_response" require_relative "imagekit/models/files/version_get_params" -require_relative "imagekit/models/files/version_get_response" require_relative "imagekit/models/files/version_list_params" require_relative "imagekit/models/files/version_list_response" require_relative "imagekit/models/files/version_restore_params" -require_relative "imagekit/models/files/version_restore_response" require_relative "imagekit/models/file_update_params" require_relative "imagekit/models/file_update_response" require_relative "imagekit/models/file_upload_params" require_relative "imagekit/models/file_upload_response" +require_relative "imagekit/models/folder" require_relative "imagekit/models/folder_copy_params" require_relative "imagekit/models/folder_copy_response" require_relative "imagekit/models/folder_create_params" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 107d5262..9e86f6f9 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -57,6 +57,8 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + File = Imagekit::Models::File + FileCopyParams = Imagekit::Models::FileCopyParams FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -73,6 +75,8 @@ module Imagekit FileUploadParams = Imagekit::Models::FileUploadParams + Folder = Imagekit::Models::Folder + FolderCopyParams = Imagekit::Models::FolderCopyParams FolderCreateParams = Imagekit::Models::FolderCreateParams diff --git a/lib/imagekit/models/asset_list_response.rb b/lib/imagekit/models/asset_list_response.rb index 414666bd..6477fc20 100644 --- a/lib/imagekit/models/asset_list_response.rb +++ b/lib/imagekit/models/asset_list_response.rb @@ -8,340 +8,13 @@ module AssetListResponseItem discriminator :type - variant :folder, -> { Imagekit::Models::AssetListResponseItem::Folder } + variant :folder, -> { Imagekit::Folder } # Object containing details of a file or file version. - variant -> { Imagekit::Models::AssetListResponseItem::FileDetails } - - class FileDetails < Imagekit::Internal::Type::BaseModel - # @!attribute ai_tags - # An array of tags assigned to the file by auto tagging. - # - # @return [Array, nil] - optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::AssetListResponseItem::FileDetails::AITag] }, - api_name: :AITags, - nil?: true - - # @!attribute created_at - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :created_at, Time, api_name: :createdAt - - # @!attribute custom_coordinates - # An string with custom coordinates of the file. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # An object with custom metadata for the file. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - - # @!attribute file_id - # Unique identifier of the asset. - # - # @return [String, nil] - optional :file_id, String, api_name: :fileId - - # @!attribute file_path - # 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`. - # - # @return [String, nil] - optional :file_path, String, api_name: :filePath - - # @!attribute file_type - # Type of the file. Possible values are `image`, `non-image`. - # - # @return [String, nil] - optional :file_type, String, api_name: :fileType - - # @!attribute has_alpha - # Specifies if the image has an alpha channel. - # - # @return [Boolean, nil] - optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha - - # @!attribute height - # Height of the file. - # - # @return [Float, nil] - optional :height, Float - - # @!attribute is_private_file - # Specifies if the file is private or not. - # - # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile - - # @!attribute is_published - # Specifies if the file is published or not. - # - # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute mime - # MIME type of the file. - # - # @return [String, nil] - optional :mime, String - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute size - # Size of the file in bytes. - # - # @return [Float, nil] - optional :size, Float - - # @!attribute tags - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute thumbnail - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - # - # @return [String, nil] - optional :thumbnail, String - - # @!attribute type - # Type of the asset. - # - # @return [Symbol, Imagekit::Models::AssetListResponseItem::FileDetails::Type, nil] - optional :type, enum: -> { Imagekit::Models::AssetListResponseItem::FileDetails::Type } - - # @!attribute updated_at - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :updated_at, Time, api_name: :updatedAt - - # @!attribute url - # URL of the file. - # - # @return [String, nil] - optional :url, String - - # @!attribute version_info - # An object with details of the file version. - # - # @return [Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, nil] - optional :version_info, - -> { Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo }, - api_name: :versionInfo - - # @!attribute width - # Width of the file. - # - # @return [Float, nil] - optional :width, Float - - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::AssetListResponseItem::FileDetails} for more details. - # - # Object containing details of a file or file version. - # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. - # - # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format - # - # @param custom_coordinates [String, nil] An string with custom coordinates of the file. - # - # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. - # - # @param file_id [String] Unique identifier of the asset. - # - # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. - # - # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. - # - # @param has_alpha [Boolean] Specifies if the image has an alpha channel. - # - # @param height [Float] Height of the file. - # - # @param is_private_file [Boolean] Specifies if the file is private or not. - # - # @param is_published [Boolean] Specifies if the file is published or not. - # - # @param mime [String] MIME type of the file. - # - # @param name [String] Name of the asset. - # - # @param size [Float] Size of the file in bytes. - # - # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi - # - # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th - # - # @param type [Symbol, Imagekit::Models::AssetListResponseItem::FileDetails::Type] Type of the asset. - # - # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo - # - # @param url [String] URL of the file. - # - # @param version_info [Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo] An object with details of the file version. - # - # @param width [Float] Width of the file. - - class AITag < Imagekit::Internal::Type::BaseModel - # @!attribute confidence - # Confidence score of the tag. - # - # @return [Float, nil] - optional :confidence, Float - - # @!attribute name - # Name of the tag. - # - # @return [String, nil] - optional :name, String - - # @!attribute source - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - # - # @return [String, nil] - optional :source, String - - # @!method initialize(confidence: nil, name: nil, source: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::AssetListResponseItem::FileDetails::AITag} for more details. - # - # @param confidence [Float] Confidence score of the tag. - # - # @param name [String] Name of the tag. - # - # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi - end - - # Type of the asset. - # - # @see Imagekit::Models::AssetListResponseItem::FileDetails#type - module Type - extend Imagekit::Internal::Type::Enum - - FILE = :file - FILE_VERSION = :"file-version" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::AssetListResponseItem::FileDetails#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier of the file version. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # Name of the file version. - # - # @return [String, nil] - optional :name, String - - # @!method initialize(id: nil, name: nil) - # An object with details of the file version. - # - # @param id [String] Unique identifier of the file version. - # - # @param name [String] Name of the file version. - end - end - - class Folder < Imagekit::Internal::Type::BaseModel - # @!attribute created_at - # Date and time when the folder was created. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :created_at, Time, api_name: :createdAt - - # @!attribute folder_id - # Unique identifier of the asset. - # - # @return [String, nil] - optional :folder_id, String, api_name: :folderId - - # @!attribute folder_path - # 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. - # - # @return [String, nil] - optional :folder_path, String, api_name: :folderPath - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute type - # Type of the asset. - # - # @return [Symbol, Imagekit::Models::AssetListResponseItem::Folder::Type, nil] - optional :type, enum: -> { Imagekit::Models::AssetListResponseItem::Folder::Type } - - # @!attribute updated_at - # Date and time when the folder was last updated. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :updated_at, Time, api_name: :updatedAt - - # @!method initialize(created_at: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::AssetListResponseItem::Folder} for more details. - # - # @param created_at [Time] Date and time when the folder was created. The date and time is in ISO8601 forma - # - # @param folder_id [String] Unique identifier of the asset. - # - # @param folder_path [String] Path of the folder. This is the path you would use in the URL to access the fold - # - # @param name [String] Name of the asset. - # - # @param type [Symbol, Imagekit::Models::AssetListResponseItem::Folder::Type] Type of the asset. - # - # @param updated_at [Time] Date and time when the folder was last updated. The date and time is in ISO8601 - - # Type of the asset. - # - # @see Imagekit::Models::AssetListResponseItem::Folder#type - module Type - extend Imagekit::Internal::Type::Enum - - FOLDER = :folder - - # @!method self.values - # @return [Array] - end - end + variant -> { Imagekit::File } # @!method self.variants - # @return [Array(Imagekit::Models::AssetListResponseItem::Folder, Imagekit::Models::AssetListResponseItem::FileDetails)] + # @return [Array(Imagekit::Models::Folder, Imagekit::Models::File)] end # @type [Imagekit::Internal::Type::Converter] diff --git a/lib/imagekit/models/file_get_response.rb b/lib/imagekit/models/file.rb similarity index 87% rename from lib/imagekit/models/file_get_response.rb rename to lib/imagekit/models/file.rb index af01ea2d..9da1c0d8 100644 --- a/lib/imagekit/models/file_get_response.rb +++ b/lib/imagekit/models/file.rb @@ -3,13 +3,13 @@ module Imagekit module Models # @see Imagekit::Resources::Files#get - class FileGetResponse < Imagekit::Internal::Type::BaseModel + class File < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileGetResponse::AITag] }, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::File::AITag] }, api_name: :AITags, nil?: true @@ -114,8 +114,8 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [Symbol, Imagekit::Models::FileGetResponse::Type, nil] - optional :type, enum: -> { Imagekit::Models::FileGetResponse::Type } + # @return [Symbol, Imagekit::Models::File::Type, nil] + optional :type, enum: -> { Imagekit::File::Type } # @!attribute updated_at # Date and time when the file was last updated. The date and time is in ISO8601 @@ -133,8 +133,8 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object with details of the file version. # - # @return [Imagekit::Models::FileGetResponse::VersionInfo, nil] - optional :version_info, -> { Imagekit::Models::FileGetResponse::VersionInfo }, api_name: :versionInfo + # @return [Imagekit::Models::File::VersionInfo, nil] + optional :version_info, -> { Imagekit::File::VersionInfo }, api_name: :versionInfo # @!attribute width # Width of the file. @@ -143,12 +143,12 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel optional :width, Float # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileGetResponse} for more details. + # Some parameter documentations has been truncated, see {Imagekit::Models::File} + # for more details. # # Object containing details of a file or file version. # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # @@ -180,13 +180,13 @@ class FileGetResponse < Imagekit::Internal::Type::BaseModel # # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th # - # @param type [Symbol, Imagekit::Models::FileGetResponse::Type] Type of the asset. + # @param type [Symbol, Imagekit::Models::File::Type] Type of the asset. # # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo # # @param url [String] URL of the file. # - # @param version_info [Imagekit::Models::FileGetResponse::VersionInfo] An object with details of the file version. + # @param version_info [Imagekit::Models::File::VersionInfo] An object with details of the file version. # # @param width [Float] Width of the file. @@ -212,7 +212,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileGetResponse::AITag} for more details. + # {Imagekit::Models::File::AITag} for more details. # # @param confidence [Float] Confidence score of the tag. # @@ -223,7 +223,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # Type of the asset. # - # @see Imagekit::Models::FileGetResponse#type + # @see Imagekit::Models::File#type module Type extend Imagekit::Internal::Type::Enum @@ -234,7 +234,7 @@ module Type # @return [Array] end - # @see Imagekit::Models::FileGetResponse#version_info + # @see Imagekit::Models::File#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. diff --git a/lib/imagekit/models/file_update_response.rb b/lib/imagekit/models/file_update_response.rb index da0d9eae..916adbcf 100644 --- a/lib/imagekit/models/file_update_response.rb +++ b/lib/imagekit/models/file_update_response.rb @@ -3,37 +3,7 @@ module Imagekit module Models # @see Imagekit::Resources::Files#update - class FileUpdateResponse < Imagekit::Internal::Type::BaseModel - # @!attribute ai_tags - # An array of tags assigned to the file by auto tagging. - # - # @return [Array, nil] - optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUpdateResponse::AITag] }, - api_name: :AITags, - nil?: true - - # @!attribute created_at - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :created_at, Time, api_name: :createdAt - - # @!attribute custom_coordinates - # An string with custom coordinates of the file. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # An object with custom metadata for the file. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - + class FileUpdateResponse < Imagekit::Models::File # @!attribute extension_status # # @return [Imagekit::Models::FileUpdateResponse::ExtensionStatus, nil] @@ -41,194 +11,11 @@ class FileUpdateResponse < Imagekit::Internal::Type::BaseModel -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus }, api_name: :extensionStatus - # @!attribute file_id - # Unique identifier of the asset. - # - # @return [String, nil] - optional :file_id, String, api_name: :fileId - - # @!attribute file_path - # 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`. - # - # @return [String, nil] - optional :file_path, String, api_name: :filePath - - # @!attribute file_type - # Type of the file. Possible values are `image`, `non-image`. - # - # @return [String, nil] - optional :file_type, String, api_name: :fileType - - # @!attribute has_alpha - # Specifies if the image has an alpha channel. - # - # @return [Boolean, nil] - optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha - - # @!attribute height - # Height of the file. - # - # @return [Float, nil] - optional :height, Float - - # @!attribute is_private_file - # Specifies if the file is private or not. - # - # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile - - # @!attribute is_published - # Specifies if the file is published or not. - # - # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute mime - # MIME type of the file. - # - # @return [String, nil] - optional :mime, String - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute size - # Size of the file in bytes. - # - # @return [Float, nil] - optional :size, Float - - # @!attribute tags - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute thumbnail - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - # - # @return [String, nil] - optional :thumbnail, String - - # @!attribute type - # Type of the asset. - # - # @return [Symbol, Imagekit::Models::FileUpdateResponse::Type, nil] - optional :type, enum: -> { Imagekit::Models::FileUpdateResponse::Type } - - # @!attribute updated_at - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :updated_at, Time, api_name: :updatedAt - - # @!attribute url - # URL of the file. - # - # @return [String, nil] - optional :url, String - - # @!attribute version_info - # An object with details of the file version. - # - # @return [Imagekit::Models::FileUpdateResponse::VersionInfo, nil] - optional :version_info, -> { Imagekit::Models::FileUpdateResponse::VersionInfo }, api_name: :versionInfo - - # @!attribute width - # Width of the file. - # - # @return [Float, nil] - optional :width, Float - - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateResponse} for more details. - # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. - # - # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format - # - # @param custom_coordinates [String, nil] An string with custom coordinates of the file. - # - # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. + # @!method initialize(extension_status: nil) + # Object containing details of a file or file version. # # @param extension_status [Imagekit::Models::FileUpdateResponse::ExtensionStatus] - # - # @param file_id [String] Unique identifier of the asset. - # - # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. - # - # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. - # - # @param has_alpha [Boolean] Specifies if the image has an alpha channel. - # - # @param height [Float] Height of the file. - # - # @param is_private_file [Boolean] Specifies if the file is private or not. - # - # @param is_published [Boolean] Specifies if the file is published or not. - # - # @param mime [String] MIME type of the file. - # - # @param name [String] Name of the asset. - # - # @param size [Float] Size of the file in bytes. - # - # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi - # - # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th - # - # @param type [Symbol, Imagekit::Models::FileUpdateResponse::Type] Type of the asset. - # - # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo - # - # @param url [String] URL of the file. - # - # @param version_info [Imagekit::Models::FileUpdateResponse::VersionInfo] An object with details of the file version. - # - # @param width [Float] Width of the file. - class AITag < Imagekit::Internal::Type::BaseModel - # @!attribute confidence - # Confidence score of the tag. - # - # @return [Float, nil] - optional :confidence, Float - - # @!attribute name - # Name of the tag. - # - # @return [String, nil] - optional :name, String - - # @!attribute source - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - # - # @return [String, nil] - optional :source, String - - # @!method initialize(confidence: nil, name: nil, source: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateResponse::AITag} for more details. - # - # @param confidence [Float] Confidence score of the tag. - # - # @param name [String] Name of the tag. - # - # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi - end - - # @see Imagekit::Models::FileUpdateResponse#extension_status class ExtensionStatus < Imagekit::Internal::Type::BaseModel # @!attribute ai_auto_description # @@ -312,41 +99,6 @@ module RemoveBg # @return [Array] end end - - # Type of the asset. - # - # @see Imagekit::Models::FileUpdateResponse#type - module Type - extend Imagekit::Internal::Type::Enum - - FILE = :file - FILE_VERSION = :"file-version" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUpdateResponse#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier of the file version. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # Name of the file version. - # - # @return [String, nil] - optional :name, String - - # @!method initialize(id: nil, name: nil) - # An object with details of the file version. - # - # @param id [String] Unique identifier of the file version. - # - # @param name [String] Name of the file version. - end end end end diff --git a/lib/imagekit/models/files/version_get_response.rb b/lib/imagekit/models/files/version_get_response.rb deleted file mode 100644 index e314ae5c..00000000 --- a/lib/imagekit/models/files/version_get_response.rb +++ /dev/null @@ -1,264 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Versions#get - class VersionGetResponse < Imagekit::Internal::Type::BaseModel - # @!attribute ai_tags - # An array of tags assigned to the file by auto tagging. - # - # @return [Array, nil] - optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionGetResponse::AITag] }, - api_name: :AITags, - nil?: true - - # @!attribute created_at - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :created_at, Time, api_name: :createdAt - - # @!attribute custom_coordinates - # An string with custom coordinates of the file. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # An object with custom metadata for the file. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - - # @!attribute file_id - # Unique identifier of the asset. - # - # @return [String, nil] - optional :file_id, String, api_name: :fileId - - # @!attribute file_path - # 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`. - # - # @return [String, nil] - optional :file_path, String, api_name: :filePath - - # @!attribute file_type - # Type of the file. Possible values are `image`, `non-image`. - # - # @return [String, nil] - optional :file_type, String, api_name: :fileType - - # @!attribute has_alpha - # Specifies if the image has an alpha channel. - # - # @return [Boolean, nil] - optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha - - # @!attribute height - # Height of the file. - # - # @return [Float, nil] - optional :height, Float - - # @!attribute is_private_file - # Specifies if the file is private or not. - # - # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile - - # @!attribute is_published - # Specifies if the file is published or not. - # - # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute mime - # MIME type of the file. - # - # @return [String, nil] - optional :mime, String - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute size - # Size of the file in bytes. - # - # @return [Float, nil] - optional :size, Float - - # @!attribute tags - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute thumbnail - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - # - # @return [String, nil] - optional :thumbnail, String - - # @!attribute type - # Type of the asset. - # - # @return [Symbol, Imagekit::Models::Files::VersionGetResponse::Type, nil] - optional :type, enum: -> { Imagekit::Models::Files::VersionGetResponse::Type } - - # @!attribute updated_at - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :updated_at, Time, api_name: :updatedAt - - # @!attribute url - # URL of the file. - # - # @return [String, nil] - optional :url, String - - # @!attribute version_info - # An object with details of the file version. - # - # @return [Imagekit::Models::Files::VersionGetResponse::VersionInfo, nil] - optional :version_info, - -> { Imagekit::Models::Files::VersionGetResponse::VersionInfo }, - api_name: :versionInfo - - # @!attribute width - # Width of the file. - # - # @return [Float, nil] - optional :width, Float - - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionGetResponse} for more details. - # - # Object containing details of a file or file version. - # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. - # - # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format - # - # @param custom_coordinates [String, nil] An string with custom coordinates of the file. - # - # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. - # - # @param file_id [String] Unique identifier of the asset. - # - # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. - # - # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. - # - # @param has_alpha [Boolean] Specifies if the image has an alpha channel. - # - # @param height [Float] Height of the file. - # - # @param is_private_file [Boolean] Specifies if the file is private or not. - # - # @param is_published [Boolean] Specifies if the file is published or not. - # - # @param mime [String] MIME type of the file. - # - # @param name [String] Name of the asset. - # - # @param size [Float] Size of the file in bytes. - # - # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi - # - # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th - # - # @param type [Symbol, Imagekit::Models::Files::VersionGetResponse::Type] Type of the asset. - # - # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo - # - # @param url [String] URL of the file. - # - # @param version_info [Imagekit::Models::Files::VersionGetResponse::VersionInfo] An object with details of the file version. - # - # @param width [Float] Width of the file. - - class AITag < Imagekit::Internal::Type::BaseModel - # @!attribute confidence - # Confidence score of the tag. - # - # @return [Float, nil] - optional :confidence, Float - - # @!attribute name - # Name of the tag. - # - # @return [String, nil] - optional :name, String - - # @!attribute source - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - # - # @return [String, nil] - optional :source, String - - # @!method initialize(confidence: nil, name: nil, source: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionGetResponse::AITag} for more details. - # - # @param confidence [Float] Confidence score of the tag. - # - # @param name [String] Name of the tag. - # - # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi - end - - # Type of the asset. - # - # @see Imagekit::Models::Files::VersionGetResponse#type - module Type - extend Imagekit::Internal::Type::Enum - - FILE = :file - FILE_VERSION = :"file-version" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::Files::VersionGetResponse#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier of the file version. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # Name of the file version. - # - # @return [String, nil] - optional :name, String - - # @!method initialize(id: nil, name: nil) - # An object with details of the file version. - # - # @param id [String] Unique identifier of the file version. - # - # @param name [String] Name of the file version. - end - end - end - end -end diff --git a/lib/imagekit/models/files/version_list_response.rb b/lib/imagekit/models/files/version_list_response.rb index 8f5ef79e..b74454e4 100644 --- a/lib/imagekit/models/files/version_list_response.rb +++ b/lib/imagekit/models/files/version_list_response.rb @@ -3,265 +3,8 @@ module Imagekit module Models module Files - class VersionListResponseItem < Imagekit::Internal::Type::BaseModel - # @!attribute ai_tags - # An array of tags assigned to the file by auto tagging. - # - # @return [Array, nil] - optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionListResponseItem::AITag] }, - api_name: :AITags, - nil?: true - - # @!attribute created_at - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :created_at, Time, api_name: :createdAt - - # @!attribute custom_coordinates - # An string with custom coordinates of the file. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # An object with custom metadata for the file. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - - # @!attribute file_id - # Unique identifier of the asset. - # - # @return [String, nil] - optional :file_id, String, api_name: :fileId - - # @!attribute file_path - # 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`. - # - # @return [String, nil] - optional :file_path, String, api_name: :filePath - - # @!attribute file_type - # Type of the file. Possible values are `image`, `non-image`. - # - # @return [String, nil] - optional :file_type, String, api_name: :fileType - - # @!attribute has_alpha - # Specifies if the image has an alpha channel. - # - # @return [Boolean, nil] - optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha - - # @!attribute height - # Height of the file. - # - # @return [Float, nil] - optional :height, Float - - # @!attribute is_private_file - # Specifies if the file is private or not. - # - # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile - - # @!attribute is_published - # Specifies if the file is published or not. - # - # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute mime - # MIME type of the file. - # - # @return [String, nil] - optional :mime, String - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute size - # Size of the file in bytes. - # - # @return [Float, nil] - optional :size, Float - - # @!attribute tags - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute thumbnail - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - # - # @return [String, nil] - optional :thumbnail, String - - # @!attribute type - # Type of the asset. - # - # @return [Symbol, Imagekit::Models::Files::VersionListResponseItem::Type, nil] - optional :type, enum: -> { Imagekit::Models::Files::VersionListResponseItem::Type } - - # @!attribute updated_at - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :updated_at, Time, api_name: :updatedAt - - # @!attribute url - # URL of the file. - # - # @return [String, nil] - optional :url, String - - # @!attribute version_info - # An object with details of the file version. - # - # @return [Imagekit::Models::Files::VersionListResponseItem::VersionInfo, nil] - optional :version_info, - -> { Imagekit::Models::Files::VersionListResponseItem::VersionInfo }, - api_name: :versionInfo - - # @!attribute width - # Width of the file. - # - # @return [Float, nil] - optional :width, Float - - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionListResponseItem} for more details. - # - # Object containing details of a file or file version. - # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. - # - # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format - # - # @param custom_coordinates [String, nil] An string with custom coordinates of the file. - # - # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. - # - # @param file_id [String] Unique identifier of the asset. - # - # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. - # - # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. - # - # @param has_alpha [Boolean] Specifies if the image has an alpha channel. - # - # @param height [Float] Height of the file. - # - # @param is_private_file [Boolean] Specifies if the file is private or not. - # - # @param is_published [Boolean] Specifies if the file is published or not. - # - # @param mime [String] MIME type of the file. - # - # @param name [String] Name of the asset. - # - # @param size [Float] Size of the file in bytes. - # - # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi - # - # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th - # - # @param type [Symbol, Imagekit::Models::Files::VersionListResponseItem::Type] Type of the asset. - # - # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo - # - # @param url [String] URL of the file. - # - # @param version_info [Imagekit::Models::Files::VersionListResponseItem::VersionInfo] An object with details of the file version. - # - # @param width [Float] Width of the file. - - class AITag < Imagekit::Internal::Type::BaseModel - # @!attribute confidence - # Confidence score of the tag. - # - # @return [Float, nil] - optional :confidence, Float - - # @!attribute name - # Name of the tag. - # - # @return [String, nil] - optional :name, String - - # @!attribute source - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - # - # @return [String, nil] - optional :source, String - - # @!method initialize(confidence: nil, name: nil, source: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionListResponseItem::AITag} for more details. - # - # @param confidence [Float] Confidence score of the tag. - # - # @param name [String] Name of the tag. - # - # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi - end - - # Type of the asset. - # - # @see Imagekit::Models::Files::VersionListResponseItem#type - module Type - extend Imagekit::Internal::Type::Enum - - FILE = :file - FILE_VERSION = :"file-version" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::Files::VersionListResponseItem#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier of the file version. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # Name of the file version. - # - # @return [String, nil] - optional :name, String - - # @!method initialize(id: nil, name: nil) - # An object with details of the file version. - # - # @param id [String] Unique identifier of the file version. - # - # @param name [String] Name of the file version. - end - end - # @type [Imagekit::Internal::Type::Converter] - VersionListResponse = - Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Models::Files::VersionListResponseItem }] + VersionListResponse = Imagekit::Internal::Type::ArrayOf[-> { Imagekit::File }] end end end diff --git a/lib/imagekit/models/files/version_restore_response.rb b/lib/imagekit/models/files/version_restore_response.rb deleted file mode 100644 index 6378ccb1..00000000 --- a/lib/imagekit/models/files/version_restore_response.rb +++ /dev/null @@ -1,264 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Versions#restore - class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel - # @!attribute ai_tags - # An array of tags assigned to the file by auto tagging. - # - # @return [Array, nil] - optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRestoreResponse::AITag] }, - api_name: :AITags, - nil?: true - - # @!attribute created_at - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :created_at, Time, api_name: :createdAt - - # @!attribute custom_coordinates - # An string with custom coordinates of the file. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # An object with custom metadata for the file. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - - # @!attribute file_id - # Unique identifier of the asset. - # - # @return [String, nil] - optional :file_id, String, api_name: :fileId - - # @!attribute file_path - # 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`. - # - # @return [String, nil] - optional :file_path, String, api_name: :filePath - - # @!attribute file_type - # Type of the file. Possible values are `image`, `non-image`. - # - # @return [String, nil] - optional :file_type, String, api_name: :fileType - - # @!attribute has_alpha - # Specifies if the image has an alpha channel. - # - # @return [Boolean, nil] - optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha - - # @!attribute height - # Height of the file. - # - # @return [Float, nil] - optional :height, Float - - # @!attribute is_private_file - # Specifies if the file is private or not. - # - # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile - - # @!attribute is_published - # Specifies if the file is published or not. - # - # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute mime - # MIME type of the file. - # - # @return [String, nil] - optional :mime, String - - # @!attribute name - # Name of the asset. - # - # @return [String, nil] - optional :name, String - - # @!attribute size - # Size of the file in bytes. - # - # @return [Float, nil] - optional :size, Float - - # @!attribute tags - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute thumbnail - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - # - # @return [String, nil] - optional :thumbnail, String - - # @!attribute type - # Type of the asset. - # - # @return [Symbol, Imagekit::Models::Files::VersionRestoreResponse::Type, nil] - optional :type, enum: -> { Imagekit::Models::Files::VersionRestoreResponse::Type } - - # @!attribute updated_at - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - # - # @return [Time, nil] - optional :updated_at, Time, api_name: :updatedAt - - # @!attribute url - # URL of the file. - # - # @return [String, nil] - optional :url, String - - # @!attribute version_info - # An object with details of the file version. - # - # @return [Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, nil] - optional :version_info, - -> { Imagekit::Models::Files::VersionRestoreResponse::VersionInfo }, - api_name: :versionInfo - - # @!attribute width - # Width of the file. - # - # @return [Float, nil] - optional :width, Float - - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionRestoreResponse} for more details. - # - # Object containing details of a file or file version. - # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. - # - # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format - # - # @param custom_coordinates [String, nil] An string with custom coordinates of the file. - # - # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. - # - # @param file_id [String] Unique identifier of the asset. - # - # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. - # - # @param file_type [String] Type of the file. Possible values are `image`, `non-image`. - # - # @param has_alpha [Boolean] Specifies if the image has an alpha channel. - # - # @param height [Float] Height of the file. - # - # @param is_private_file [Boolean] Specifies if the file is private or not. - # - # @param is_published [Boolean] Specifies if the file is published or not. - # - # @param mime [String] MIME type of the file. - # - # @param name [String] Name of the asset. - # - # @param size [Float] Size of the file in bytes. - # - # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi - # - # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th - # - # @param type [Symbol, Imagekit::Models::Files::VersionRestoreResponse::Type] Type of the asset. - # - # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo - # - # @param url [String] URL of the file. - # - # @param version_info [Imagekit::Models::Files::VersionRestoreResponse::VersionInfo] An object with details of the file version. - # - # @param width [Float] Width of the file. - - class AITag < Imagekit::Internal::Type::BaseModel - # @!attribute confidence - # Confidence score of the tag. - # - # @return [Float, nil] - optional :confidence, Float - - # @!attribute name - # Name of the tag. - # - # @return [String, nil] - optional :name, String - - # @!attribute source - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - # - # @return [String, nil] - optional :source, String - - # @!method initialize(confidence: nil, name: nil, source: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionRestoreResponse::AITag} for more details. - # - # @param confidence [Float] Confidence score of the tag. - # - # @param name [String] Name of the tag. - # - # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi - end - - # Type of the asset. - # - # @see Imagekit::Models::Files::VersionRestoreResponse#type - module Type - extend Imagekit::Internal::Type::Enum - - FILE = :file - FILE_VERSION = :"file-version" - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::Files::VersionRestoreResponse#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier of the file version. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # Name of the file version. - # - # @return [String, nil] - optional :name, String - - # @!method initialize(id: nil, name: nil) - # An object with details of the file version. - # - # @param id [String] Unique identifier of the file version. - # - # @param name [String] Name of the file version. - end - end - end - end -end diff --git a/lib/imagekit/models/folder.rb b/lib/imagekit/models/folder.rb new file mode 100644 index 00000000..832ae2a1 --- /dev/null +++ b/lib/imagekit/models/folder.rb @@ -0,0 +1,76 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Folder < Imagekit::Internal::Type::BaseModel + # @!attribute created_at + # Date and time when the folder was created. The date and time is in ISO8601 + # format. + # + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt + + # @!attribute folder_id + # Unique identifier of the asset. + # + # @return [String, nil] + optional :folder_id, String, api_name: :folderId + + # @!attribute folder_path + # 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. + # + # @return [String, nil] + optional :folder_path, String, api_name: :folderPath + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute type + # Type of the asset. + # + # @return [Symbol, Imagekit::Models::Folder::Type, nil] + optional :type, enum: -> { Imagekit::Folder::Type } + + # @!attribute updated_at + # Date and time when the folder was last updated. The date and time is in ISO8601 + # format. + # + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt + + # @!method initialize(created_at: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil) + # Some parameter documentations has been truncated, see {Imagekit::Models::Folder} + # for more details. + # + # @param created_at [Time] Date and time when the folder was created. The date and time is in ISO8601 forma + # + # @param folder_id [String] Unique identifier of the asset. + # + # @param folder_path [String] Path of the folder. This is the path you would use in the URL to access the fold + # + # @param name [String] Name of the asset. + # + # @param type [Symbol, Imagekit::Models::Folder::Type] Type of the asset. + # + # @param updated_at [Time] Date and time when the folder was last updated. The date and time is in ISO8601 + + # Type of the asset. + # + # @see Imagekit::Models::Folder#type + module Type + extend Imagekit::Internal::Type::Enum + + FOLDER = :folder + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/resources/assets.rb b/lib/imagekit/resources/assets.rb index 8b0987b3..de7abc9a 100644 --- a/lib/imagekit/resources/assets.rb +++ b/lib/imagekit/resources/assets.rb @@ -29,7 +29,7 @@ class Assets # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::AssetListParams def list(params = {}) diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 4298e6ea..6ee090f3 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -113,14 +113,14 @@ def copy(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FileGetResponse] + # @return [Imagekit::Models::File] # # @see Imagekit::Models::FileGetParams def get(file_id, params = {}) @client.request( method: :get, path: ["v1/files/%1$s/details", file_id], - model: Imagekit::Models::FileGetResponse, + model: Imagekit::File, options: params[:request_options] ) end diff --git a/lib/imagekit/resources/files/versions.rb b/lib/imagekit/resources/files/versions.rb index 9c5363d5..dd712b77 100644 --- a/lib/imagekit/resources/files/versions.rb +++ b/lib/imagekit/resources/files/versions.rb @@ -15,14 +15,14 @@ class Versions # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::Files::VersionListParams def list(file_id, params = {}) @client.request( method: :get, path: ["v1/files/%1$s/versions", file_id], - model: Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionListResponseItem], + model: Imagekit::Internal::Type::ArrayOf[Imagekit::File], options: params[:request_options] ) end @@ -73,7 +73,7 @@ def delete(version_id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::VersionGetResponse] + # @return [Imagekit::Models::File] # # @see Imagekit::Models::Files::VersionGetParams def get(version_id, params) @@ -85,7 +85,7 @@ def get(version_id, params) @client.request( method: :get, path: ["v1/files/%1$s/versions/%2$s", file_id, version_id], - model: Imagekit::Models::Files::VersionGetResponse, + model: Imagekit::File, options: options ) end @@ -103,7 +103,7 @@ def get(version_id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::VersionRestoreResponse] + # @return [Imagekit::Models::File] # # @see Imagekit::Models::Files::VersionRestoreParams def restore(version_id, params) @@ -115,7 +115,7 @@ def restore(version_id, params) @client.request( method: :put, path: ["v1/files/%1$s/versions/%2$s/restore", file_id, version_id], - model: Imagekit::Models::Files::VersionRestoreResponse, + model: Imagekit::File, options: options ) end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index b0b43162..952b8cfe 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -23,6 +23,8 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + File = Imagekit::Models::File + FileCopyParams = Imagekit::Models::FileCopyParams FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -39,6 +41,8 @@ module Imagekit FileUploadParams = Imagekit::Models::FileUploadParams + Folder = Imagekit::Models::Folder + FolderCopyParams = Imagekit::Models::FolderCopyParams FolderCreateParams = Imagekit::Models::FolderCreateParams diff --git a/rbi/imagekit/models/asset_list_response.rbi b/rbi/imagekit/models/asset_list_response.rbi index 05150a53..3f9f4f86 100644 --- a/rbi/imagekit/models/asset_list_response.rbi +++ b/rbi/imagekit/models/asset_list_response.rbi @@ -6,596 +6,7 @@ module Imagekit module AssetListResponseItem extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any( - Imagekit::Models::AssetListResponseItem::Folder, - Imagekit::Models::AssetListResponseItem::FileDetails - ) - end - - class FileDetails < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::AssetListResponseItem::FileDetails, - Imagekit::Internal::AnyHash - ) - end - - # An array of tags assigned to the file by auto tagging. - sig do - returns( - T.nilable( - T::Array[ - Imagekit::Models::AssetListResponseItem::FileDetails::AITag - ] - ) - ) - end - attr_accessor :ai_tags - - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :created_at - - sig { params(created_at: Time).void } - attr_writer :created_at - - # An string with custom coordinates of the file. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # An object with custom metadata for the file. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Unique identifier of the asset. - sig { returns(T.nilable(String)) } - attr_reader :file_id - - sig { params(file_id: String).void } - attr_writer :file_id - - # 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`. - sig { returns(T.nilable(String)) } - attr_reader :file_path - - sig { params(file_path: String).void } - attr_writer :file_path - - # Type of the file. Possible values are `image`, `non-image`. - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # Specifies if the image has an alpha channel. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_alpha - - sig { params(has_alpha: T::Boolean).void } - attr_writer :has_alpha - - # Height of the file. - sig { returns(T.nilable(Float)) } - attr_reader :height - - sig { params(height: Float).void } - attr_writer :height - - # Specifies if the file is private or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_private_file - - sig { params(is_private_file: T::Boolean).void } - attr_writer :is_private_file - - # Specifies if the file is published or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_published - - sig { params(is_published: T::Boolean).void } - attr_writer :is_published - - # MIME type of the file. - sig { returns(T.nilable(String)) } - attr_reader :mime - - sig { params(mime: String).void } - attr_writer :mime - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Size of the file in bytes. - sig { returns(T.nilable(Float)) } - attr_reader :size - - sig { params(size: Float).void } - attr_writer :size - - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :tags - - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - sig { returns(T.nilable(String)) } - attr_reader :thumbnail - - sig { params(thumbnail: String).void } - attr_writer :thumbnail - - # Type of the asset. - sig do - returns( - T.nilable( - Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol - ) - ) - end - attr_reader :type - - sig do - params( - type: - Imagekit::Models::AssetListResponseItem::FileDetails::Type::OrSymbol - ).void - end - attr_writer :type - - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :updated_at - - sig { params(updated_at: Time).void } - attr_writer :updated_at - - # URL of the file. - sig { returns(T.nilable(String)) } - attr_reader :url - - sig { params(url: String).void } - attr_writer :url - - # An object with details of the file version. - sig do - returns( - T.nilable( - Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo - ) - ) - end - attr_reader :version_info - - sig do - params( - version_info: - Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo::OrHash - ).void - end - attr_writer :version_info - - # Width of the file. - sig { returns(T.nilable(Float)) } - attr_reader :width - - sig { params(width: Float).void } - attr_writer :width - - # Object containing details of a file or file version. - sig do - params( - ai_tags: - T.nilable( - T::Array[ - Imagekit::Models::AssetListResponseItem::FileDetails::AITag::OrHash - ] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: - Imagekit::Models::AssetListResponseItem::FileDetails::Type::OrSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo::OrHash, - width: Float - ).returns(T.attached_class) - end - def self.new( - # An array of tags assigned to the file by auto tagging. - ai_tags: nil, - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - created_at: nil, - # An string with custom coordinates of the file. - custom_coordinates: nil, - # An object with custom metadata for the file. - custom_metadata: nil, - # Unique identifier of the asset. - file_id: nil, - # 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`. - file_path: nil, - # Type of the file. Possible values are `image`, `non-image`. - file_type: nil, - # Specifies if the image has an alpha channel. - has_alpha: nil, - # Height of the file. - height: nil, - # Specifies if the file is private or not. - is_private_file: nil, - # Specifies if the file is published or not. - is_published: nil, - # MIME type of the file. - mime: nil, - # Name of the asset. - name: nil, - # Size of the file in bytes. - size: nil, - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - tags: nil, - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - thumbnail: nil, - # Type of the asset. - type: nil, - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - updated_at: nil, - # URL of the file. - url: nil, - # An object with details of the file version. - version_info: nil, - # Width of the file. - width: nil - ) - end - - sig do - override.returns( - { - ai_tags: - T.nilable( - T::Array[ - Imagekit::Models::AssetListResponseItem::FileDetails::AITag - ] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: - Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, - width: Float - } - ) - end - def to_hash - end - - class AITag < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::AssetListResponseItem::FileDetails::AITag, - Imagekit::Internal::AnyHash - ) - end - - # Confidence score of the tag. - sig { returns(T.nilable(Float)) } - attr_reader :confidence - - sig { params(confidence: Float).void } - attr_writer :confidence - - # Name of the tag. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig do - params(confidence: Float, name: String, source: String).returns( - T.attached_class - ) - end - def self.new( - # Confidence score of the tag. - confidence: nil, - # Name of the tag. - name: nil, - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - source: nil - ) - end - - sig do - override.returns( - { confidence: Float, name: String, source: String } - ) - end - def to_hash - end - end - - # Type of the asset. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::AssetListResponseItem::FileDetails::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - FILE = - T.let( - :file, - Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol - ) - FILE_VERSION = - T.let( - :"file-version", - Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::AssetListResponseItem::FileDetails::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - - class VersionInfo < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the file version. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Name of the file version. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # An object with details of the file version. - sig { params(id: String, name: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the file version. - id: nil, - # Name of the file version. - name: nil - ) - end - - sig { override.returns({ id: String, name: String }) } - def to_hash - end - end - end - - class Folder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::AssetListResponseItem::Folder, - Imagekit::Internal::AnyHash - ) - end - - # Date and time when the folder was created. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :created_at - - sig { params(created_at: Time).void } - attr_writer :created_at - - # Unique identifier of the asset. - sig { returns(T.nilable(String)) } - attr_reader :folder_id - - sig { params(folder_id: String).void } - attr_writer :folder_id - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :folder_path - - sig { params(folder_path: String).void } - attr_writer :folder_path - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Type of the asset. - sig do - returns( - T.nilable( - Imagekit::Models::AssetListResponseItem::Folder::Type::TaggedSymbol - ) - ) - end - attr_reader :type - - sig do - params( - type: - Imagekit::Models::AssetListResponseItem::Folder::Type::OrSymbol - ).void - end - attr_writer :type - - # Date and time when the folder was last updated. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :updated_at - - sig { params(updated_at: Time).void } - attr_writer :updated_at - - sig do - params( - created_at: Time, - folder_id: String, - folder_path: String, - name: String, - type: - Imagekit::Models::AssetListResponseItem::Folder::Type::OrSymbol, - updated_at: Time - ).returns(T.attached_class) - end - def self.new( - # Date and time when the folder was created. The date and time is in ISO8601 - # format. - created_at: nil, - # Unique identifier of the asset. - folder_id: nil, - # 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. - folder_path: nil, - # Name of the asset. - name: nil, - # Type of the asset. - type: nil, - # Date and time when the folder was last updated. The date and time is in ISO8601 - # format. - updated_at: nil - ) - end - - sig do - override.returns( - { - created_at: Time, - folder_id: String, - folder_path: String, - name: String, - type: - Imagekit::Models::AssetListResponseItem::Folder::Type::TaggedSymbol, - updated_at: Time - } - ) - end - def to_hash - end - - # Type of the asset. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::AssetListResponseItem::Folder::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - FOLDER = - T.let( - :folder, - Imagekit::Models::AssetListResponseItem::Folder::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::AssetListResponseItem::Folder::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - end + Variants = T.type_alias { T.any(Imagekit::Folder, Imagekit::File) } sig do override.returns( diff --git a/rbi/imagekit/models/file_get_response.rbi b/rbi/imagekit/models/file.rbi similarity index 83% rename from rbi/imagekit/models/file_get_response.rbi rename to rbi/imagekit/models/file.rbi index b60d2ee3..1da2de0f 100644 --- a/rbi/imagekit/models/file_get_response.rbi +++ b/rbi/imagekit/models/file.rbi @@ -2,16 +2,12 @@ module Imagekit module Models - class FileGetResponse < Imagekit::Internal::Type::BaseModel + class File < Imagekit::Internal::Type::BaseModel OrHash = - T.type_alias do - T.any(Imagekit::Models::FileGetResponse, Imagekit::Internal::AnyHash) - end + T.type_alias { T.any(Imagekit::File, Imagekit::Internal::AnyHash) } # An array of tags assigned to the file by auto tagging. - sig do - returns(T.nilable(T::Array[Imagekit::Models::FileGetResponse::AITag])) - end + sig { returns(T.nilable(T::Array[Imagekit::File::AITag])) } attr_accessor :ai_tags # Date and time when the file was uploaded. The date and time is in ISO8601 @@ -120,16 +116,10 @@ module Imagekit attr_writer :thumbnail # Type of the asset. - sig do - returns( - T.nilable(Imagekit::Models::FileGetResponse::Type::TaggedSymbol) - ) - end + sig { returns(T.nilable(Imagekit::File::Type::TaggedSymbol)) } attr_reader :type - sig do - params(type: Imagekit::Models::FileGetResponse::Type::OrSymbol).void - end + sig { params(type: Imagekit::File::Type::OrSymbol).void } attr_writer :type # Date and time when the file was last updated. The date and time is in ISO8601 @@ -148,14 +138,10 @@ module Imagekit attr_writer :url # An object with details of the file version. - sig { returns(T.nilable(Imagekit::Models::FileGetResponse::VersionInfo)) } + sig { returns(T.nilable(Imagekit::File::VersionInfo)) } attr_reader :version_info - sig do - params( - version_info: Imagekit::Models::FileGetResponse::VersionInfo::OrHash - ).void - end + sig { params(version_info: Imagekit::File::VersionInfo::OrHash).void } attr_writer :version_info # Width of the file. @@ -168,10 +154,7 @@ module Imagekit # Object containing details of a file or file version. sig do params( - ai_tags: - T.nilable( - T::Array[Imagekit::Models::FileGetResponse::AITag::OrHash] - ), + ai_tags: T.nilable(T::Array[Imagekit::File::AITag::OrHash]), created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], @@ -187,10 +170,10 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: Imagekit::Models::FileGetResponse::Type::OrSymbol, + type: Imagekit::File::Type::OrSymbol, updated_at: Time, url: String, - version_info: Imagekit::Models::FileGetResponse::VersionInfo::OrHash, + version_info: Imagekit::File::VersionInfo::OrHash, width: Float ).returns(T.attached_class) end @@ -250,8 +233,7 @@ module Imagekit sig do override.returns( { - ai_tags: - T.nilable(T::Array[Imagekit::Models::FileGetResponse::AITag]), + ai_tags: T.nilable(T::Array[Imagekit::File::AITag]), created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], @@ -267,10 +249,10 @@ module Imagekit size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: Imagekit::Models::FileGetResponse::Type::TaggedSymbol, + type: Imagekit::File::Type::TaggedSymbol, updated_at: Time, url: String, - version_info: Imagekit::Models::FileGetResponse::VersionInfo, + version_info: Imagekit::File::VersionInfo, width: Float } ) @@ -281,10 +263,7 @@ module Imagekit class AITag < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do - T.any( - Imagekit::Models::FileGetResponse::AITag, - Imagekit::Internal::AnyHash - ) + T.any(Imagekit::File::AITag, Imagekit::Internal::AnyHash) end # Confidence score of the tag. @@ -336,25 +315,14 @@ module Imagekit module Type extend Imagekit::Internal::Type::Enum - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::Models::FileGetResponse::Type) - end + TaggedSymbol = T.type_alias { T.all(Symbol, Imagekit::File::Type) } OrSymbol = T.type_alias { T.any(Symbol, String) } - FILE = - T.let(:file, Imagekit::Models::FileGetResponse::Type::TaggedSymbol) + FILE = T.let(:file, Imagekit::File::Type::TaggedSymbol) FILE_VERSION = - T.let( - :"file-version", - Imagekit::Models::FileGetResponse::Type::TaggedSymbol - ) + T.let(:"file-version", Imagekit::File::Type::TaggedSymbol) - sig do - override.returns( - T::Array[Imagekit::Models::FileGetResponse::Type::TaggedSymbol] - ) - end + sig { override.returns(T::Array[Imagekit::File::Type::TaggedSymbol]) } def self.values end end @@ -362,10 +330,7 @@ module Imagekit class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do - T.any( - Imagekit::Models::FileGetResponse::VersionInfo, - Imagekit::Internal::AnyHash - ) + T.any(Imagekit::File::VersionInfo, Imagekit::Internal::AnyHash) end # Unique identifier of the file version. diff --git a/rbi/imagekit/models/file_update_response.rbi b/rbi/imagekit/models/file_update_response.rbi index d763bde8..92dba923 100644 --- a/rbi/imagekit/models/file_update_response.rbi +++ b/rbi/imagekit/models/file_update_response.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class FileUpdateResponse < Imagekit::Internal::Type::BaseModel + class FileUpdateResponse < Imagekit::Models::File OrHash = T.type_alias do T.any( @@ -11,33 +11,6 @@ module Imagekit ) end - # An array of tags assigned to the file by auto tagging. - sig do - returns( - T.nilable(T::Array[Imagekit::Models::FileUpdateResponse::AITag]) - ) - end - attr_accessor :ai_tags - - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :created_at - - sig { params(created_at: Time).void } - attr_writer :created_at - - # An string with custom coordinates of the file. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # An object with custom metadata for the file. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - sig do returns( T.nilable(Imagekit::Models::FileUpdateResponse::ExtensionStatus) @@ -53,313 +26,27 @@ module Imagekit end attr_writer :extension_status - # Unique identifier of the asset. - sig { returns(T.nilable(String)) } - attr_reader :file_id - - sig { params(file_id: String).void } - attr_writer :file_id - - # 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`. - sig { returns(T.nilable(String)) } - attr_reader :file_path - - sig { params(file_path: String).void } - attr_writer :file_path - - # Type of the file. Possible values are `image`, `non-image`. - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # Specifies if the image has an alpha channel. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_alpha - - sig { params(has_alpha: T::Boolean).void } - attr_writer :has_alpha - - # Height of the file. - sig { returns(T.nilable(Float)) } - attr_reader :height - - sig { params(height: Float).void } - attr_writer :height - - # Specifies if the file is private or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_private_file - - sig { params(is_private_file: T::Boolean).void } - attr_writer :is_private_file - - # Specifies if the file is published or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_published - - sig { params(is_published: T::Boolean).void } - attr_writer :is_published - - # MIME type of the file. - sig { returns(T.nilable(String)) } - attr_reader :mime - - sig { params(mime: String).void } - attr_writer :mime - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Size of the file in bytes. - sig { returns(T.nilable(Float)) } - attr_reader :size - - sig { params(size: Float).void } - attr_writer :size - - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :tags - - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - sig { returns(T.nilable(String)) } - attr_reader :thumbnail - - sig { params(thumbnail: String).void } - attr_writer :thumbnail - - # Type of the asset. - sig do - returns( - T.nilable(Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol) - ) - end - attr_reader :type - - sig do - params(type: Imagekit::Models::FileUpdateResponse::Type::OrSymbol).void - end - attr_writer :type - - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :updated_at - - sig { params(updated_at: Time).void } - attr_writer :updated_at - - # URL of the file. - sig { returns(T.nilable(String)) } - attr_reader :url - - sig { params(url: String).void } - attr_writer :url - - # An object with details of the file version. - sig do - returns(T.nilable(Imagekit::Models::FileUpdateResponse::VersionInfo)) - end - attr_reader :version_info - - sig do - params( - version_info: - Imagekit::Models::FileUpdateResponse::VersionInfo::OrHash - ).void - end - attr_writer :version_info - - # Width of the file. - sig { returns(T.nilable(Float)) } - attr_reader :width - - sig { params(width: Float).void } - attr_writer :width - + # Object containing details of a file or file version. sig do params( - ai_tags: - T.nilable( - T::Array[Imagekit::Models::FileUpdateResponse::AITag::OrHash] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::OrHash, - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: Imagekit::Models::FileUpdateResponse::Type::OrSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::FileUpdateResponse::VersionInfo::OrHash, - width: Float + Imagekit::Models::FileUpdateResponse::ExtensionStatus::OrHash ).returns(T.attached_class) end - def self.new( - # An array of tags assigned to the file by auto tagging. - ai_tags: nil, - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - created_at: nil, - # An string with custom coordinates of the file. - custom_coordinates: nil, - # An object with custom metadata for the file. - custom_metadata: nil, - extension_status: nil, - # Unique identifier of the asset. - file_id: nil, - # 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`. - file_path: nil, - # Type of the file. Possible values are `image`, `non-image`. - file_type: nil, - # Specifies if the image has an alpha channel. - has_alpha: nil, - # Height of the file. - height: nil, - # Specifies if the file is private or not. - is_private_file: nil, - # Specifies if the file is published or not. - is_published: nil, - # MIME type of the file. - mime: nil, - # Name of the asset. - name: nil, - # Size of the file in bytes. - size: nil, - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - tags: nil, - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - thumbnail: nil, - # Type of the asset. - type: nil, - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - updated_at: nil, - # URL of the file. - url: nil, - # An object with details of the file version. - version_info: nil, - # Width of the file. - width: nil - ) + def self.new(extension_status: nil) end sig do override.returns( { - ai_tags: - T.nilable(T::Array[Imagekit::Models::FileUpdateResponse::AITag]), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::Models::FileUpdateResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol, - updated_at: Time, - url: String, - version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, - width: Float + Imagekit::Models::FileUpdateResponse::ExtensionStatus } ) end def to_hash end - class AITag < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUpdateResponse::AITag, - Imagekit::Internal::AnyHash - ) - end - - # Confidence score of the tag. - sig { returns(T.nilable(Float)) } - attr_reader :confidence - - sig { params(confidence: Float).void } - attr_writer :confidence - - # Name of the tag. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig do - params(confidence: Float, name: String, source: String).returns( - T.attached_class - ) - end - def self.new( - # Confidence score of the tag. - confidence: nil, - # Name of the tag. - name: nil, - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - source: nil - ) - end - - sig do - override.returns({ confidence: Float, name: String, source: String }) - end - def to_hash - end - end - class ExtensionStatus < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do @@ -630,71 +317,6 @@ module Imagekit end end end - - # Type of the asset. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::Models::FileUpdateResponse::Type) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - FILE = - T.let(:file, Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol) - FILE_VERSION = - T.let( - :"file-version", - Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Imagekit::Models::FileUpdateResponse::Type::TaggedSymbol] - ) - end - def self.values - end - end - - class VersionInfo < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUpdateResponse::VersionInfo, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the file version. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Name of the file version. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # An object with details of the file version. - sig { params(id: String, name: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the file version. - id: nil, - # Name of the file version. - name: nil - ) - end - - sig { override.returns({ id: String, name: String }) } - def to_hash - end - end end end end diff --git a/rbi/imagekit/models/files/version_get_response.rbi b/rbi/imagekit/models/files/version_get_response.rbi deleted file mode 100644 index c12a13c4..00000000 --- a/rbi/imagekit/models/files/version_get_response.rbi +++ /dev/null @@ -1,433 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class VersionGetResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionGetResponse, - Imagekit::Internal::AnyHash - ) - end - - # An array of tags assigned to the file by auto tagging. - sig do - returns( - T.nilable( - T::Array[Imagekit::Models::Files::VersionGetResponse::AITag] - ) - ) - end - attr_accessor :ai_tags - - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :created_at - - sig { params(created_at: Time).void } - attr_writer :created_at - - # An string with custom coordinates of the file. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # An object with custom metadata for the file. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Unique identifier of the asset. - sig { returns(T.nilable(String)) } - attr_reader :file_id - - sig { params(file_id: String).void } - attr_writer :file_id - - # 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`. - sig { returns(T.nilable(String)) } - attr_reader :file_path - - sig { params(file_path: String).void } - attr_writer :file_path - - # Type of the file. Possible values are `image`, `non-image`. - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # Specifies if the image has an alpha channel. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_alpha - - sig { params(has_alpha: T::Boolean).void } - attr_writer :has_alpha - - # Height of the file. - sig { returns(T.nilable(Float)) } - attr_reader :height - - sig { params(height: Float).void } - attr_writer :height - - # Specifies if the file is private or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_private_file - - sig { params(is_private_file: T::Boolean).void } - attr_writer :is_private_file - - # Specifies if the file is published or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_published - - sig { params(is_published: T::Boolean).void } - attr_writer :is_published - - # MIME type of the file. - sig { returns(T.nilable(String)) } - attr_reader :mime - - sig { params(mime: String).void } - attr_writer :mime - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Size of the file in bytes. - sig { returns(T.nilable(Float)) } - attr_reader :size - - sig { params(size: Float).void } - attr_writer :size - - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :tags - - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - sig { returns(T.nilable(String)) } - attr_reader :thumbnail - - sig { params(thumbnail: String).void } - attr_writer :thumbnail - - # Type of the asset. - sig do - returns( - T.nilable( - Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol - ) - ) - end - attr_reader :type - - sig do - params( - type: Imagekit::Models::Files::VersionGetResponse::Type::OrSymbol - ).void - end - attr_writer :type - - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :updated_at - - sig { params(updated_at: Time).void } - attr_writer :updated_at - - # URL of the file. - sig { returns(T.nilable(String)) } - attr_reader :url - - sig { params(url: String).void } - attr_writer :url - - # An object with details of the file version. - sig do - returns( - T.nilable(Imagekit::Models::Files::VersionGetResponse::VersionInfo) - ) - end - attr_reader :version_info - - sig do - params( - version_info: - Imagekit::Models::Files::VersionGetResponse::VersionInfo::OrHash - ).void - end - attr_writer :version_info - - # Width of the file. - sig { returns(T.nilable(Float)) } - attr_reader :width - - sig { params(width: Float).void } - attr_writer :width - - # Object containing details of a file or file version. - sig do - params( - ai_tags: - T.nilable( - T::Array[ - Imagekit::Models::Files::VersionGetResponse::AITag::OrHash - ] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: Imagekit::Models::Files::VersionGetResponse::Type::OrSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::Files::VersionGetResponse::VersionInfo::OrHash, - width: Float - ).returns(T.attached_class) - end - def self.new( - # An array of tags assigned to the file by auto tagging. - ai_tags: nil, - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - created_at: nil, - # An string with custom coordinates of the file. - custom_coordinates: nil, - # An object with custom metadata for the file. - custom_metadata: nil, - # Unique identifier of the asset. - file_id: nil, - # 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`. - file_path: nil, - # Type of the file. Possible values are `image`, `non-image`. - file_type: nil, - # Specifies if the image has an alpha channel. - has_alpha: nil, - # Height of the file. - height: nil, - # Specifies if the file is private or not. - is_private_file: nil, - # Specifies if the file is published or not. - is_published: nil, - # MIME type of the file. - mime: nil, - # Name of the asset. - name: nil, - # Size of the file in bytes. - size: nil, - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - tags: nil, - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - thumbnail: nil, - # Type of the asset. - type: nil, - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - updated_at: nil, - # URL of the file. - url: nil, - # An object with details of the file version. - version_info: nil, - # Width of the file. - width: nil - ) - end - - sig do - override.returns( - { - ai_tags: - T.nilable( - T::Array[Imagekit::Models::Files::VersionGetResponse::AITag] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: - Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::Files::VersionGetResponse::VersionInfo, - width: Float - } - ) - end - def to_hash - end - - class AITag < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionGetResponse::AITag, - Imagekit::Internal::AnyHash - ) - end - - # Confidence score of the tag. - sig { returns(T.nilable(Float)) } - attr_reader :confidence - - sig { params(confidence: Float).void } - attr_writer :confidence - - # Name of the tag. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig do - params(confidence: Float, name: String, source: String).returns( - T.attached_class - ) - end - def self.new( - # Confidence score of the tag. - confidence: nil, - # Name of the tag. - name: nil, - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - source: nil - ) - end - - sig do - override.returns( - { confidence: Float, name: String, source: String } - ) - end - def to_hash - end - end - - # Type of the asset. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::Models::Files::VersionGetResponse::Type) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - FILE = - T.let( - :file, - Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol - ) - FILE_VERSION = - T.let( - :"file-version", - Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Files::VersionGetResponse::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - - class VersionInfo < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionGetResponse::VersionInfo, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the file version. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Name of the file version. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # An object with details of the file version. - sig { params(id: String, name: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the file version. - id: nil, - # Name of the file version. - name: nil - ) - end - - sig { override.returns({ id: String, name: String }) } - def to_hash - end - end - end - end - end -end diff --git a/rbi/imagekit/models/files/version_list_response.rbi b/rbi/imagekit/models/files/version_list_response.rbi index ca296d45..8ac552c7 100644 --- a/rbi/imagekit/models/files/version_list_response.rbi +++ b/rbi/imagekit/models/files/version_list_response.rbi @@ -3,446 +3,9 @@ module Imagekit module Models module Files - class VersionListResponseItem < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionListResponseItem, - Imagekit::Internal::AnyHash - ) - end - - # An array of tags assigned to the file by auto tagging. - sig do - returns( - T.nilable( - T::Array[Imagekit::Models::Files::VersionListResponseItem::AITag] - ) - ) - end - attr_accessor :ai_tags - - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :created_at - - sig { params(created_at: Time).void } - attr_writer :created_at - - # An string with custom coordinates of the file. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # An object with custom metadata for the file. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Unique identifier of the asset. - sig { returns(T.nilable(String)) } - attr_reader :file_id - - sig { params(file_id: String).void } - attr_writer :file_id - - # 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`. - sig { returns(T.nilable(String)) } - attr_reader :file_path - - sig { params(file_path: String).void } - attr_writer :file_path - - # Type of the file. Possible values are `image`, `non-image`. - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # Specifies if the image has an alpha channel. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_alpha - - sig { params(has_alpha: T::Boolean).void } - attr_writer :has_alpha - - # Height of the file. - sig { returns(T.nilable(Float)) } - attr_reader :height - - sig { params(height: Float).void } - attr_writer :height - - # Specifies if the file is private or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_private_file - - sig { params(is_private_file: T::Boolean).void } - attr_writer :is_private_file - - # Specifies if the file is published or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_published - - sig { params(is_published: T::Boolean).void } - attr_writer :is_published - - # MIME type of the file. - sig { returns(T.nilable(String)) } - attr_reader :mime - - sig { params(mime: String).void } - attr_writer :mime - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Size of the file in bytes. - sig { returns(T.nilable(Float)) } - attr_reader :size - - sig { params(size: Float).void } - attr_writer :size - - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :tags - - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - sig { returns(T.nilable(String)) } - attr_reader :thumbnail - - sig { params(thumbnail: String).void } - attr_writer :thumbnail - - # Type of the asset. - sig do - returns( - T.nilable( - Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol - ) - ) - end - attr_reader :type - - sig do - params( - type: - Imagekit::Models::Files::VersionListResponseItem::Type::OrSymbol - ).void - end - attr_writer :type - - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :updated_at - - sig { params(updated_at: Time).void } - attr_writer :updated_at - - # URL of the file. - sig { returns(T.nilable(String)) } - attr_reader :url - - sig { params(url: String).void } - attr_writer :url - - # An object with details of the file version. - sig do - returns( - T.nilable( - Imagekit::Models::Files::VersionListResponseItem::VersionInfo - ) - ) - end - attr_reader :version_info - - sig do - params( - version_info: - Imagekit::Models::Files::VersionListResponseItem::VersionInfo::OrHash - ).void - end - attr_writer :version_info - - # Width of the file. - sig { returns(T.nilable(Float)) } - attr_reader :width - - sig { params(width: Float).void } - attr_writer :width - - # Object containing details of a file or file version. - sig do - params( - ai_tags: - T.nilable( - T::Array[ - Imagekit::Models::Files::VersionListResponseItem::AITag::OrHash - ] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: - Imagekit::Models::Files::VersionListResponseItem::Type::OrSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::Files::VersionListResponseItem::VersionInfo::OrHash, - width: Float - ).returns(T.attached_class) - end - def self.new( - # An array of tags assigned to the file by auto tagging. - ai_tags: nil, - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - created_at: nil, - # An string with custom coordinates of the file. - custom_coordinates: nil, - # An object with custom metadata for the file. - custom_metadata: nil, - # Unique identifier of the asset. - file_id: nil, - # 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`. - file_path: nil, - # Type of the file. Possible values are `image`, `non-image`. - file_type: nil, - # Specifies if the image has an alpha channel. - has_alpha: nil, - # Height of the file. - height: nil, - # Specifies if the file is private or not. - is_private_file: nil, - # Specifies if the file is published or not. - is_published: nil, - # MIME type of the file. - mime: nil, - # Name of the asset. - name: nil, - # Size of the file in bytes. - size: nil, - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - tags: nil, - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - thumbnail: nil, - # Type of the asset. - type: nil, - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - updated_at: nil, - # URL of the file. - url: nil, - # An object with details of the file version. - version_info: nil, - # Width of the file. - width: nil - ) - end - - sig do - override.returns( - { - ai_tags: - T.nilable( - T::Array[ - Imagekit::Models::Files::VersionListResponseItem::AITag - ] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: - Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::Files::VersionListResponseItem::VersionInfo, - width: Float - } - ) - end - def to_hash - end - - class AITag < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionListResponseItem::AITag, - Imagekit::Internal::AnyHash - ) - end - - # Confidence score of the tag. - sig { returns(T.nilable(Float)) } - attr_reader :confidence - - sig { params(confidence: Float).void } - attr_writer :confidence - - # Name of the tag. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig do - params(confidence: Float, name: String, source: String).returns( - T.attached_class - ) - end - def self.new( - # Confidence score of the tag. - confidence: nil, - # Name of the tag. - name: nil, - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - source: nil - ) - end - - sig do - override.returns( - { confidence: Float, name: String, source: String } - ) - end - def to_hash - end - end - - # Type of the asset. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Files::VersionListResponseItem::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - FILE = - T.let( - :file, - Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol - ) - FILE_VERSION = - T.let( - :"file-version", - Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Files::VersionListResponseItem::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - - class VersionInfo < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionListResponseItem::VersionInfo, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the file version. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Name of the file version. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # An object with details of the file version. - sig { params(id: String, name: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the file version. - id: nil, - # Name of the file version. - name: nil - ) - end - - sig { override.returns({ id: String, name: String }) } - def to_hash - end - end - end - VersionListResponse = T.let( - Imagekit::Internal::Type::ArrayOf[ - Imagekit::Models::Files::VersionListResponseItem - ], + Imagekit::Internal::Type::ArrayOf[Imagekit::File], Imagekit::Internal::Type::Converter ) end diff --git a/rbi/imagekit/models/files/version_restore_response.rbi b/rbi/imagekit/models/files/version_restore_response.rbi deleted file mode 100644 index c6622167..00000000 --- a/rbi/imagekit/models/files/version_restore_response.rbi +++ /dev/null @@ -1,442 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionRestoreResponse, - Imagekit::Internal::AnyHash - ) - end - - # An array of tags assigned to the file by auto tagging. - sig do - returns( - T.nilable( - T::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag] - ) - ) - end - attr_accessor :ai_tags - - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :created_at - - sig { params(created_at: Time).void } - attr_writer :created_at - - # An string with custom coordinates of the file. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # An object with custom metadata for the file. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Unique identifier of the asset. - sig { returns(T.nilable(String)) } - attr_reader :file_id - - sig { params(file_id: String).void } - attr_writer :file_id - - # 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`. - sig { returns(T.nilable(String)) } - attr_reader :file_path - - sig { params(file_path: String).void } - attr_writer :file_path - - # Type of the file. Possible values are `image`, `non-image`. - sig { returns(T.nilable(String)) } - attr_reader :file_type - - sig { params(file_type: String).void } - attr_writer :file_type - - # Specifies if the image has an alpha channel. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_alpha - - sig { params(has_alpha: T::Boolean).void } - attr_writer :has_alpha - - # Height of the file. - sig { returns(T.nilable(Float)) } - attr_reader :height - - sig { params(height: Float).void } - attr_writer :height - - # Specifies if the file is private or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_private_file - - sig { params(is_private_file: T::Boolean).void } - attr_writer :is_private_file - - # Specifies if the file is published or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_published - - sig { params(is_published: T::Boolean).void } - attr_writer :is_published - - # MIME type of the file. - sig { returns(T.nilable(String)) } - attr_reader :mime - - sig { params(mime: String).void } - attr_writer :mime - - # Name of the asset. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Size of the file in bytes. - sig { returns(T.nilable(Float)) } - attr_reader :size - - sig { params(size: Float).void } - attr_writer :size - - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :tags - - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - sig { returns(T.nilable(String)) } - attr_reader :thumbnail - - sig { params(thumbnail: String).void } - attr_writer :thumbnail - - # Type of the asset. - sig do - returns( - T.nilable( - Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol - ) - ) - end - attr_reader :type - - sig do - params( - type: - Imagekit::Models::Files::VersionRestoreResponse::Type::OrSymbol - ).void - end - attr_writer :type - - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - sig { returns(T.nilable(Time)) } - attr_reader :updated_at - - sig { params(updated_at: Time).void } - attr_writer :updated_at - - # URL of the file. - sig { returns(T.nilable(String)) } - attr_reader :url - - sig { params(url: String).void } - attr_writer :url - - # An object with details of the file version. - sig do - returns( - T.nilable( - Imagekit::Models::Files::VersionRestoreResponse::VersionInfo - ) - ) - end - attr_reader :version_info - - sig do - params( - version_info: - Imagekit::Models::Files::VersionRestoreResponse::VersionInfo::OrHash - ).void - end - attr_writer :version_info - - # Width of the file. - sig { returns(T.nilable(Float)) } - attr_reader :width - - sig { params(width: Float).void } - attr_writer :width - - # Object containing details of a file or file version. - sig do - params( - ai_tags: - T.nilable( - T::Array[ - Imagekit::Models::Files::VersionRestoreResponse::AITag::OrHash - ] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: - Imagekit::Models::Files::VersionRestoreResponse::Type::OrSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::Files::VersionRestoreResponse::VersionInfo::OrHash, - width: Float - ).returns(T.attached_class) - end - def self.new( - # An array of tags assigned to the file by auto tagging. - ai_tags: nil, - # Date and time when the file was uploaded. The date and time is in ISO8601 - # format. - created_at: nil, - # An string with custom coordinates of the file. - custom_coordinates: nil, - # An object with custom metadata for the file. - custom_metadata: nil, - # Unique identifier of the asset. - file_id: nil, - # 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`. - file_path: nil, - # Type of the file. Possible values are `image`, `non-image`. - file_type: nil, - # Specifies if the image has an alpha channel. - has_alpha: nil, - # Height of the file. - height: nil, - # Specifies if the file is private or not. - is_private_file: nil, - # Specifies if the file is published or not. - is_published: nil, - # MIME type of the file. - mime: nil, - # Name of the asset. - name: nil, - # Size of the file in bytes. - size: nil, - # An array of tags assigned to the file. Tags are used to search files in the - # media library. - tags: nil, - # URL of the thumbnail image. This URL is used to access the thumbnail image of - # the file in the media library. - thumbnail: nil, - # Type of the asset. - type: nil, - # Date and time when the file was last updated. The date and time is in ISO8601 - # format. - updated_at: nil, - # URL of the file. - url: nil, - # An object with details of the file version. - version_info: nil, - # Width of the file. - width: nil - ) - end - - sig do - override.returns( - { - ai_tags: - T.nilable( - T::Array[ - Imagekit::Models::Files::VersionRestoreResponse::AITag - ] - ), - created_at: Time, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - file_id: String, - file_path: String, - file_type: String, - has_alpha: T::Boolean, - height: Float, - is_private_file: T::Boolean, - is_published: T::Boolean, - mime: String, - name: String, - size: Float, - tags: T.nilable(T::Array[String]), - thumbnail: String, - type: - Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol, - updated_at: Time, - url: String, - version_info: - Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, - width: Float - } - ) - end - def to_hash - end - - class AITag < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionRestoreResponse::AITag, - Imagekit::Internal::AnyHash - ) - end - - # Confidence score of the tag. - sig { returns(T.nilable(Float)) } - attr_reader :confidence - - sig { params(confidence: Float).void } - attr_writer :confidence - - # Name of the tag. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - sig { returns(T.nilable(String)) } - attr_reader :source - - sig { params(source: String).void } - attr_writer :source - - sig do - params(confidence: Float, name: String, source: String).returns( - T.attached_class - ) - end - def self.new( - # Confidence score of the tag. - confidence: nil, - # Name of the tag. - name: nil, - # Source of the tag. Possible values are `google-auto-tagging` and - # `aws-auto-tagging`. - source: nil - ) - end - - sig do - override.returns( - { confidence: Float, name: String, source: String } - ) - end - def to_hash - end - end - - # Type of the asset. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Models::Files::VersionRestoreResponse::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - FILE = - T.let( - :file, - Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol - ) - FILE_VERSION = - T.let( - :"file-version", - Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Models::Files::VersionRestoreResponse::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - - class VersionInfo < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the file version. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Name of the file version. - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - # An object with details of the file version. - sig { params(id: String, name: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the file version. - id: nil, - # Name of the file version. - name: nil - ) - end - - sig { override.returns({ id: String, name: String }) } - def to_hash - end - end - end - end - end -end diff --git a/rbi/imagekit/models/folder.rbi b/rbi/imagekit/models/folder.rbi new file mode 100644 index 00000000..ae0620c3 --- /dev/null +++ b/rbi/imagekit/models/folder.rbi @@ -0,0 +1,117 @@ +# typed: strong + +module Imagekit + module Models + class Folder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Imagekit::Folder, Imagekit::Internal::AnyHash) } + + # Date and time when the folder was created. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(Time)) } + attr_reader :created_at + + sig { params(created_at: Time).void } + attr_writer :created_at + + # Unique identifier of the asset. + sig { returns(T.nilable(String)) } + attr_reader :folder_id + + sig { params(folder_id: String).void } + attr_writer :folder_id + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :folder_path + + sig { params(folder_path: String).void } + attr_writer :folder_path + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Type of the asset. + sig { returns(T.nilable(Imagekit::Folder::Type::TaggedSymbol)) } + attr_reader :type + + sig { params(type: Imagekit::Folder::Type::OrSymbol).void } + attr_writer :type + + # Date and time when the folder was last updated. The date and time is in ISO8601 + # format. + sig { returns(T.nilable(Time)) } + attr_reader :updated_at + + sig { params(updated_at: Time).void } + attr_writer :updated_at + + sig do + params( + created_at: Time, + folder_id: String, + folder_path: String, + name: String, + type: Imagekit::Folder::Type::OrSymbol, + updated_at: Time + ).returns(T.attached_class) + end + def self.new( + # Date and time when the folder was created. The date and time is in ISO8601 + # format. + created_at: nil, + # Unique identifier of the asset. + folder_id: nil, + # 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. + folder_path: nil, + # Name of the asset. + name: nil, + # Type of the asset. + type: nil, + # Date and time when the folder was last updated. The date and time is in ISO8601 + # format. + updated_at: nil + ) + end + + sig do + override.returns( + { + created_at: Time, + folder_id: String, + folder_path: String, + name: String, + type: Imagekit::Folder::Type::TaggedSymbol, + updated_at: Time + } + ) + end + def to_hash + end + + # Type of the asset. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, Imagekit::Folder::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FOLDER = T.let(:folder, Imagekit::Folder::Type::TaggedSymbol) + + sig { override.returns(T::Array[Imagekit::Folder::Type::TaggedSymbol]) } + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 101a3ace..d9657c78 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -86,7 +86,7 @@ module Imagekit params( file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileGetResponse) + ).returns(Imagekit::File) end def get( # The unique `fileId` of the uploaded file. `fileId` is returned in the list and diff --git a/rbi/imagekit/resources/files/versions.rbi b/rbi/imagekit/resources/files/versions.rbi index e1dbf411..c27aff5d 100644 --- a/rbi/imagekit/resources/files/versions.rbi +++ b/rbi/imagekit/resources/files/versions.rbi @@ -9,7 +9,7 @@ module Imagekit params( file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(T::Array[Imagekit::Models::Files::VersionListResponseItem]) + ).returns(T::Array[Imagekit::File]) end def list( # The unique `fileId` of the uploaded file. `fileId` is returned in list and @@ -47,7 +47,7 @@ module Imagekit version_id: String, file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::VersionGetResponse) + ).returns(Imagekit::File) end def get( # The unique `versionId` of the uploaded file. `versionId` is returned in list and @@ -66,7 +66,7 @@ module Imagekit version_id: String, file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::VersionRestoreResponse) + ).returns(Imagekit::File) end def restore( # The unique `versionId` of the uploaded file. `versionId` is returned in list and diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 49237be6..a525aabc 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -17,6 +17,8 @@ module Imagekit class CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + class File = Imagekit::Models::File + class FileCopyParams = Imagekit::Models::FileCopyParams class FileDeleteParams = Imagekit::Models::FileDeleteParams @@ -33,6 +35,8 @@ module Imagekit class FileUploadParams = Imagekit::Models::FileUploadParams + class Folder = Imagekit::Models::Folder + class FolderCopyParams = Imagekit::Models::FolderCopyParams class FolderCreateParams = Imagekit::Models::FolderCreateParams diff --git a/sig/imagekit/models/asset_list_response.rbs b/sig/imagekit/models/asset_list_response.rbs index 2c81feb7..f60e52fd 100644 --- a/sig/imagekit/models/asset_list_response.rbs +++ b/sig/imagekit/models/asset_list_response.rbs @@ -1,286 +1,10 @@ module Imagekit module Models - type asset_list_response_item = - Imagekit::Models::AssetListResponseItem::Folder - | Imagekit::Models::AssetListResponseItem::FileDetails + type asset_list_response_item = Imagekit::Folder | Imagekit::File module AssetListResponseItem extend Imagekit::Internal::Type::Union - type file_details = - { - ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::AssetListResponseItem::FileDetails::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, - width: Float - } - - class FileDetails < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]? - - attr_reader created_at: Time? - - def created_at=: (Time) -> Time - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader has_alpha: bool? - - def has_alpha=: (bool) -> bool - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader mime: String? - - def mime=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail: String? - - def thumbnail=: (String) -> String - - attr_reader type: Imagekit::Models::AssetListResponseItem::FileDetails::type_? - - def type=: ( - Imagekit::Models::AssetListResponseItem::FileDetails::type_ - ) -> Imagekit::Models::AssetListResponseItem::FileDetails::type_ - - attr_reader updated_at: Time? - - def updated_at=: (Time) -> Time - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo? - - def version_info=: ( - Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo - ) -> Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, - ?created_at: Time, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?has_alpha: bool, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?mime: String, - ?name: String, - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail: String, - ?type: Imagekit::Models::AssetListResponseItem::FileDetails::type_, - ?updated_at: Time, - ?url: String, - ?version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::AssetListResponseItem::FileDetails::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::AssetListResponseItem::FileDetails::VersionInfo, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type type_ = :file | :"file-version" - - module Type - extend Imagekit::Internal::Type::Enum - - FILE: :file - FILE_VERSION: :"file-version" - - def self?.values: -> ::Array[Imagekit::Models::AssetListResponseItem::FileDetails::type_] - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - - type folder = - { - created_at: Time, - folder_id: String, - folder_path: String, - name: String, - type: Imagekit::Models::AssetListResponseItem::Folder::type_, - updated_at: Time - } - - class Folder < Imagekit::Internal::Type::BaseModel - attr_reader created_at: Time? - - def created_at=: (Time) -> Time - - attr_reader folder_id: String? - - def folder_id=: (String) -> String - - attr_reader folder_path: String? - - def folder_path=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader type: Imagekit::Models::AssetListResponseItem::Folder::type_? - - def type=: ( - Imagekit::Models::AssetListResponseItem::Folder::type_ - ) -> Imagekit::Models::AssetListResponseItem::Folder::type_ - - attr_reader updated_at: Time? - - def updated_at=: (Time) -> Time - - def initialize: ( - ?created_at: Time, - ?folder_id: String, - ?folder_path: String, - ?name: String, - ?type: Imagekit::Models::AssetListResponseItem::Folder::type_, - ?updated_at: Time - ) -> void - - def to_hash: -> { - created_at: Time, - folder_id: String, - folder_path: String, - name: String, - type: Imagekit::Models::AssetListResponseItem::Folder::type_, - updated_at: Time - } - - type type_ = :folder - - module Type - extend Imagekit::Internal::Type::Enum - - FOLDER: :folder - - def self?.values: -> ::Array[Imagekit::Models::AssetListResponseItem::Folder::type_] - end - end - def self?.variants: -> ::Array[Imagekit::Models::asset_list_response_item] end diff --git a/sig/imagekit/models/file_get_response.rbs b/sig/imagekit/models/file.rbs similarity index 77% rename from sig/imagekit/models/file_get_response.rbs rename to sig/imagekit/models/file.rbs index 472ec97e..87cb4946 100644 --- a/sig/imagekit/models/file_get_response.rbs +++ b/sig/imagekit/models/file.rbs @@ -1,8 +1,8 @@ module Imagekit module Models - type file_get_response = + type file = { - ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, + ai_tags: ::Array[Imagekit::File::AITag]?, created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], @@ -18,15 +18,15 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: Imagekit::Models::FileGetResponse::type_, + type: Imagekit::Models::File::type_, updated_at: Time, url: String, - version_info: Imagekit::Models::FileGetResponse::VersionInfo, + version_info: Imagekit::File::VersionInfo, width: Float } - class FileGetResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]? + class File < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::File::AITag]? attr_reader created_at: Time? @@ -84,11 +84,11 @@ module Imagekit def thumbnail=: (String) -> String - attr_reader type: Imagekit::Models::FileGetResponse::type_? + attr_reader type: Imagekit::Models::File::type_? def type=: ( - Imagekit::Models::FileGetResponse::type_ - ) -> Imagekit::Models::FileGetResponse::type_ + Imagekit::Models::File::type_ + ) -> Imagekit::Models::File::type_ attr_reader updated_at: Time? @@ -98,18 +98,18 @@ module Imagekit def url=: (String) -> String - attr_reader version_info: Imagekit::Models::FileGetResponse::VersionInfo? + attr_reader version_info: Imagekit::File::VersionInfo? def version_info=: ( - Imagekit::Models::FileGetResponse::VersionInfo - ) -> Imagekit::Models::FileGetResponse::VersionInfo + Imagekit::File::VersionInfo + ) -> Imagekit::File::VersionInfo attr_reader width: Float? def width=: (Float) -> Float def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, + ?ai_tags: ::Array[Imagekit::File::AITag]?, ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], @@ -125,15 +125,15 @@ module Imagekit ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, - ?type: Imagekit::Models::FileGetResponse::type_, + ?type: Imagekit::Models::File::type_, ?updated_at: Time, ?url: String, - ?version_info: Imagekit::Models::FileGetResponse::VersionInfo, + ?version_info: Imagekit::File::VersionInfo, ?width: Float ) -> void def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::FileGetResponse::AITag]?, + ai_tags: ::Array[Imagekit::File::AITag]?, created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], @@ -149,10 +149,10 @@ module Imagekit size: Float, tags: ::Array[String]?, thumbnail: String, - type: Imagekit::Models::FileGetResponse::type_, + type: Imagekit::Models::File::type_, updated_at: Time, url: String, - version_info: Imagekit::Models::FileGetResponse::VersionInfo, + version_info: Imagekit::File::VersionInfo, width: Float } @@ -188,7 +188,7 @@ module Imagekit FILE: :file FILE_VERSION: :"file-version" - def self?.values: -> ::Array[Imagekit::Models::FileGetResponse::type_] + def self?.values: -> ::Array[Imagekit::Models::File::type_] end type version_info = { id: String, name: String } diff --git a/sig/imagekit/models/file_update_response.rbs b/sig/imagekit/models/file_update_response.rbs index 26fb47f8..5a223c95 100644 --- a/sig/imagekit/models/file_update_response.rbs +++ b/sig/imagekit/models/file_update_response.rbs @@ -2,193 +2,24 @@ module Imagekit module Models type file_update_response = { - ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::FileUpdateResponse::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, - width: Float + extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus } - class FileUpdateResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]? - - attr_reader created_at: Time? - - def created_at=: (Time) -> Time - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus? + class FileUpdateResponse < Imagekit::Models::File + def extension_status: -> Imagekit::Models::FileUpdateResponse::ExtensionStatus? def extension_status=: ( - Imagekit::Models::FileUpdateResponse::ExtensionStatus + Imagekit::Models::FileUpdateResponse::ExtensionStatus _ ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader has_alpha: bool? - - def has_alpha=: (bool) -> bool - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader mime: String? - - def mime=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail: String? - - def thumbnail=: (String) -> String - - attr_reader type: Imagekit::Models::FileUpdateResponse::type_? - - def type=: ( - Imagekit::Models::FileUpdateResponse::type_ - ) -> Imagekit::Models::FileUpdateResponse::type_ - - attr_reader updated_at: Time? - - def updated_at=: (Time) -> Time - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::FileUpdateResponse::VersionInfo? - - def version_info=: ( - Imagekit::Models::FileUpdateResponse::VersionInfo - ) -> Imagekit::Models::FileUpdateResponse::VersionInfo - - attr_reader width: Float? - - def width=: (Float) -> Float - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, - ?created_at: Time, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?has_alpha: bool, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?mime: String, - ?name: String, - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail: String, - ?type: Imagekit::Models::FileUpdateResponse::type_, - ?updated_at: Time, - ?url: String, - ?version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, - ?width: Float + ?extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus ) -> void def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::FileUpdateResponse::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::FileUpdateResponse::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::FileUpdateResponse::VersionInfo, - width: Float + extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus } - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - type extension_status = { ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, @@ -284,33 +115,6 @@ module Imagekit def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg] end end - - type type_ = :file | :"file-version" - - module Type - extend Imagekit::Internal::Type::Enum - - FILE: :file - FILE_VERSION: :"file-version" - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::type_] - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end end end end diff --git a/sig/imagekit/models/files/version_get_response.rbs b/sig/imagekit/models/files/version_get_response.rbs deleted file mode 100644 index 87a89323..00000000 --- a/sig/imagekit/models/files/version_get_response.rbs +++ /dev/null @@ -1,213 +0,0 @@ -module Imagekit - module Models - module Files - type version_get_response = - { - ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::Files::VersionGetResponse::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, - width: Float - } - - class VersionGetResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]? - - attr_reader created_at: Time? - - def created_at=: (Time) -> Time - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader has_alpha: bool? - - def has_alpha=: (bool) -> bool - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader mime: String? - - def mime=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail: String? - - def thumbnail=: (String) -> String - - attr_reader type: Imagekit::Models::Files::VersionGetResponse::type_? - - def type=: ( - Imagekit::Models::Files::VersionGetResponse::type_ - ) -> Imagekit::Models::Files::VersionGetResponse::type_ - - attr_reader updated_at: Time? - - def updated_at=: (Time) -> Time - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo? - - def version_info=: ( - Imagekit::Models::Files::VersionGetResponse::VersionInfo - ) -> Imagekit::Models::Files::VersionGetResponse::VersionInfo - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, - ?created_at: Time, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?has_alpha: bool, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?mime: String, - ?name: String, - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail: String, - ?type: Imagekit::Models::Files::VersionGetResponse::type_, - ?updated_at: Time, - ?url: String, - ?version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::Files::VersionGetResponse::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::Files::VersionGetResponse::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type type_ = :file | :"file-version" - - module Type - extend Imagekit::Internal::Type::Enum - - FILE: :file - FILE_VERSION: :"file-version" - - def self?.values: -> ::Array[Imagekit::Models::Files::VersionGetResponse::type_] - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - end - end -end diff --git a/sig/imagekit/models/files/version_list_response.rbs b/sig/imagekit/models/files/version_list_response.rbs index e2485ef8..48c5bd45 100644 --- a/sig/imagekit/models/files/version_list_response.rbs +++ b/sig/imagekit/models/files/version_list_response.rbs @@ -1,216 +1,7 @@ module Imagekit module Models module Files - type version_list_response_item = - { - ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::Files::VersionListResponseItem::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, - width: Float - } - - class VersionListResponseItem < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]? - - attr_reader created_at: Time? - - def created_at=: (Time) -> Time - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader has_alpha: bool? - - def has_alpha=: (bool) -> bool - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader mime: String? - - def mime=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail: String? - - def thumbnail=: (String) -> String - - attr_reader type: Imagekit::Models::Files::VersionListResponseItem::type_? - - def type=: ( - Imagekit::Models::Files::VersionListResponseItem::type_ - ) -> Imagekit::Models::Files::VersionListResponseItem::type_ - - attr_reader updated_at: Time? - - def updated_at=: (Time) -> Time - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo? - - def version_info=: ( - Imagekit::Models::Files::VersionListResponseItem::VersionInfo - ) -> Imagekit::Models::Files::VersionListResponseItem::VersionInfo - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, - ?created_at: Time, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?has_alpha: bool, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?mime: String, - ?name: String, - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail: String, - ?type: Imagekit::Models::Files::VersionListResponseItem::type_, - ?updated_at: Time, - ?url: String, - ?version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::Files::VersionListResponseItem::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::Files::VersionListResponseItem::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::Files::VersionListResponseItem::VersionInfo, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type type_ = :file | :"file-version" - - module Type - extend Imagekit::Internal::Type::Enum - - FILE: :file - FILE_VERSION: :"file-version" - - def self?.values: -> ::Array[Imagekit::Models::Files::VersionListResponseItem::type_] - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - - type version_list_response = - ::Array[Imagekit::Models::Files::VersionListResponseItem] + type version_list_response = ::Array[Imagekit::File] VersionListResponse: Imagekit::Internal::Type::Converter end diff --git a/sig/imagekit/models/files/version_restore_response.rbs b/sig/imagekit/models/files/version_restore_response.rbs deleted file mode 100644 index 55dac25b..00000000 --- a/sig/imagekit/models/files/version_restore_response.rbs +++ /dev/null @@ -1,213 +0,0 @@ -module Imagekit - module Models - module Files - type version_restore_response = - { - ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::Files::VersionRestoreResponse::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, - width: Float - } - - class VersionRestoreResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]? - - attr_reader created_at: Time? - - def created_at=: (Time) -> Time - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader has_alpha: bool? - - def has_alpha=: (bool) -> bool - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader mime: String? - - def mime=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail: String? - - def thumbnail=: (String) -> String - - attr_reader type: Imagekit::Models::Files::VersionRestoreResponse::type_? - - def type=: ( - Imagekit::Models::Files::VersionRestoreResponse::type_ - ) -> Imagekit::Models::Files::VersionRestoreResponse::type_ - - attr_reader updated_at: Time? - - def updated_at=: (Time) -> Time - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo? - - def version_info=: ( - Imagekit::Models::Files::VersionRestoreResponse::VersionInfo - ) -> Imagekit::Models::Files::VersionRestoreResponse::VersionInfo - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, - ?created_at: Time, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?has_alpha: bool, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?mime: String, - ?name: String, - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail: String, - ?type: Imagekit::Models::Files::VersionRestoreResponse::type_, - ?updated_at: Time, - ?url: String, - ?version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::Files::VersionRestoreResponse::AITag]?, - created_at: Time, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - file_id: String, - file_path: String, - file_type: String, - has_alpha: bool, - height: Float, - is_private_file: bool, - is_published: bool, - mime: String, - name: String, - size: Float, - tags: ::Array[String]?, - thumbnail: String, - type: Imagekit::Models::Files::VersionRestoreResponse::type_, - updated_at: Time, - url: String, - version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type type_ = :file | :"file-version" - - module Type - extend Imagekit::Internal::Type::Enum - - FILE: :file - FILE_VERSION: :"file-version" - - def self?.values: -> ::Array[Imagekit::Models::Files::VersionRestoreResponse::type_] - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - end - end -end diff --git a/sig/imagekit/models/folder.rbs b/sig/imagekit/models/folder.rbs new file mode 100644 index 00000000..23c781ba --- /dev/null +++ b/sig/imagekit/models/folder.rbs @@ -0,0 +1,69 @@ +module Imagekit + module Models + type folder = + { + created_at: Time, + folder_id: String, + folder_path: String, + name: String, + type: Imagekit::Models::Folder::type_, + updated_at: Time + } + + class Folder < Imagekit::Internal::Type::BaseModel + attr_reader created_at: Time? + + def created_at=: (Time) -> Time + + attr_reader folder_id: String? + + def folder_id=: (String) -> String + + attr_reader folder_path: String? + + def folder_path=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader type: Imagekit::Models::Folder::type_? + + def type=: ( + Imagekit::Models::Folder::type_ + ) -> Imagekit::Models::Folder::type_ + + attr_reader updated_at: Time? + + def updated_at=: (Time) -> Time + + def initialize: ( + ?created_at: Time, + ?folder_id: String, + ?folder_path: String, + ?name: String, + ?type: Imagekit::Models::Folder::type_, + ?updated_at: Time + ) -> void + + def to_hash: -> { + created_at: Time, + folder_id: String, + folder_path: String, + name: String, + type: Imagekit::Models::Folder::type_, + updated_at: Time + } + + type type_ = :folder + + module Type + extend Imagekit::Internal::Type::Enum + + FOLDER: :folder + + def self?.values: -> ::Array[Imagekit::Models::Folder::type_] + end + end + end +end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index f4a55fa5..991b1f14 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -28,7 +28,7 @@ module Imagekit def get: ( String file_id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileGetResponse + ) -> Imagekit::File def move: ( destination_path: String, diff --git a/sig/imagekit/resources/files/versions.rbs b/sig/imagekit/resources/files/versions.rbs index 16bf7a95..881e2c57 100644 --- a/sig/imagekit/resources/files/versions.rbs +++ b/sig/imagekit/resources/files/versions.rbs @@ -17,13 +17,13 @@ module Imagekit String version_id, file_id: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::VersionGetResponse + ) -> Imagekit::File def restore: ( String version_id, file_id: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::VersionRestoreResponse + ) -> Imagekit::File def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/files/versions_test.rb b/test/imagekit/resources/files/versions_test.rb index ca9fa54b..75c233be 100644 --- a/test/imagekit/resources/files/versions_test.rb +++ b/test/imagekit/resources/files/versions_test.rb @@ -9,7 +9,7 @@ def test_list response = @image_kit.files.versions.list("fileId") assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionListResponseItem]) + response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::File]) end end @@ -35,12 +35,12 @@ def test_get_required_params response = @image_kit.files.versions.get("versionId", file_id: "fileId") assert_pattern do - response => Imagekit::Models::Files::VersionGetResponse + response => Imagekit::File end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionGetResponse::AITag]) | nil, + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::File::AITag]) | nil, created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, @@ -56,10 +56,10 @@ def test_get_required_params size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: Imagekit::Models::Files::VersionGetResponse::Type | nil, + type: Imagekit::File::Type | nil, updated_at: Time | nil, url: String | nil, - version_info: Imagekit::Models::Files::VersionGetResponse::VersionInfo | nil, + version_info: Imagekit::File::VersionInfo | nil, width: Float | nil } end @@ -71,12 +71,12 @@ def test_restore_required_params response = @image_kit.files.versions.restore("versionId", file_id: "fileId") assert_pattern do - response => Imagekit::Models::Files::VersionRestoreResponse + response => Imagekit::File end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Files::VersionRestoreResponse::AITag]) | nil, + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::File::AITag]) | nil, created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, @@ -92,10 +92,10 @@ def test_restore_required_params size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: Imagekit::Models::Files::VersionRestoreResponse::Type | nil, + type: Imagekit::File::Type | nil, updated_at: Time | nil, url: String | nil, - version_info: Imagekit::Models::Files::VersionRestoreResponse::VersionInfo | nil, + version_info: Imagekit::File::VersionInfo | nil, width: Float | nil } end diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index 3661e07d..516b6295 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -11,33 +11,6 @@ def test_update assert_pattern do response => Imagekit::Models::FileUpdateResponse end - - assert_pattern do - response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUpdateResponse::AITag]) | nil, - created_at: Time | nil, - custom_coordinates: String | nil, - custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, - extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus | nil, - file_id: String | nil, - file_path: String | nil, - file_type: String | nil, - has_alpha: Imagekit::Internal::Type::Boolean | nil, - height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, - mime: String | nil, - name: String | nil, - size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, - thumbnail: String | nil, - type: Imagekit::Models::FileUpdateResponse::Type | nil, - updated_at: Time | nil, - url: String | nil, - version_info: Imagekit::Models::FileUpdateResponse::VersionInfo | nil, - width: Float | nil - } - end end def test_delete @@ -73,12 +46,12 @@ def test_get response = @image_kit.files.get("fileId") assert_pattern do - response => Imagekit::Models::FileGetResponse + response => Imagekit::File end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileGetResponse::AITag]) | nil, + ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::File::AITag]) | nil, created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, @@ -94,10 +67,10 @@ def test_get size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: Imagekit::Models::FileGetResponse::Type | nil, + type: Imagekit::File::Type | nil, updated_at: Time | nil, url: String | nil, - version_info: Imagekit::Models::FileGetResponse::VersionInfo | nil, + version_info: Imagekit::File::VersionInfo | nil, width: Float | nil } end From b9f17cf1e0e2c45de56f96bbd4ee27377c0f6238 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 03:21:26 +0000 Subject: [PATCH 041/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 2 ++ lib/imagekit/models/file.rb | 1 - 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 0fe111b5..cf2fe471 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-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml openapi_spec_hash: 98642308bee81ac776b7b1843089b888 -config_hash: 91cbeb97fdb75393dffd187ec25a4080 +config_hash: 734b211088fdf0d30e3d6c8788ac83bc diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 345512fb..1aa474c5 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -86,6 +86,7 @@ require_relative "imagekit/models/custom_metadata_field_list_params" require_relative "imagekit/models/custom_metadata_field_list_response" require_relative "imagekit/models/custom_metadata_field_update_params" +require_relative "imagekit/models/file" require_relative "imagekit/models/file_copy_params" require_relative "imagekit/models/file_copy_response" require_relative "imagekit/models/file_delete_params" @@ -117,6 +118,7 @@ require_relative "imagekit/models/file_upload_params" require_relative "imagekit/models/file_upload_response" require_relative "imagekit/models/folder" +require_relative "imagekit/models/folder" require_relative "imagekit/models/folder_copy_params" require_relative "imagekit/models/folder_copy_response" require_relative "imagekit/models/folder_create_params" diff --git a/lib/imagekit/models/file.rb b/lib/imagekit/models/file.rb index 9da1c0d8..d2cf7bb0 100644 --- a/lib/imagekit/models/file.rb +++ b/lib/imagekit/models/file.rb @@ -2,7 +2,6 @@ module Imagekit module Models - # @see Imagekit::Resources::Files#get class File < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. From d0f2eab6c4707e3876006d1e34af9fbfc15b83f9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 03:22:11 +0000 Subject: [PATCH 042/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 2 -- lib/imagekit/models/file.rb | 1 + 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index cf2fe471..0fe111b5 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-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml openapi_spec_hash: 98642308bee81ac776b7b1843089b888 -config_hash: 734b211088fdf0d30e3d6c8788ac83bc +config_hash: 91cbeb97fdb75393dffd187ec25a4080 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 1aa474c5..345512fb 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -86,7 +86,6 @@ require_relative "imagekit/models/custom_metadata_field_list_params" require_relative "imagekit/models/custom_metadata_field_list_response" require_relative "imagekit/models/custom_metadata_field_update_params" -require_relative "imagekit/models/file" require_relative "imagekit/models/file_copy_params" require_relative "imagekit/models/file_copy_response" require_relative "imagekit/models/file_delete_params" @@ -118,7 +117,6 @@ require_relative "imagekit/models/file_upload_params" require_relative "imagekit/models/file_upload_response" require_relative "imagekit/models/folder" -require_relative "imagekit/models/folder" require_relative "imagekit/models/folder_copy_params" require_relative "imagekit/models/folder_copy_response" require_relative "imagekit/models/folder_create_params" diff --git a/lib/imagekit/models/file.rb b/lib/imagekit/models/file.rb index d2cf7bb0..9da1c0d8 100644 --- a/lib/imagekit/models/file.rb +++ b/lib/imagekit/models/file.rb @@ -2,6 +2,7 @@ module Imagekit module Models + # @see Imagekit::Resources::Files#get class File < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. From fd24ba177c00eca89e2940c24ffc4de0232d1de8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 03:28:45 +0000 Subject: [PATCH 043/178] feat(api): manual updates --- .stats.yml | 6 +- lib/imagekit.rb | 1 + lib/imagekit/internal/type/union.rb | 32 +- lib/imagekit/models/accounts/origin.rb | 547 ++++++++++++ .../models/accounts/origin_create_params.rb | 550 +----------- .../models/accounts/origin_create_response.rb | 458 +++++----- .../models/accounts/origin_get_response.rb | 457 +++++----- .../models/accounts/origin_list_response.rb | 460 +++++----- .../models/accounts/origin_update_params.rb | 550 +----------- .../models/accounts/origin_update_response.rb | 458 +++++----- lib/imagekit/resources/accounts/origins.rb | 12 +- rbi/imagekit/models/accounts/origin.rbi | 768 ++++++++++++++++ .../models/accounts/origin_create_params.rbi | 825 +----------------- .../accounts/origin_create_response.rbi | 510 +++++++---- .../models/accounts/origin_get_response.rbi | 510 +++++++---- .../models/accounts/origin_list_response.rbi | 510 +++++++---- .../models/accounts/origin_update_params.rbi | 825 +----------------- .../accounts/origin_update_response.rbi | 510 +++++++---- rbi/imagekit/resources/accounts/origins.rbi | 32 +- sig/imagekit/models/accounts/origin.rbs | 468 ++++++++++ .../models/accounts/origin_create_params.rbs | 478 +--------- .../accounts/origin_create_response.rbs | 352 +++++--- .../models/accounts/origin_get_response.rbs | 352 +++++--- .../models/accounts/origin_list_response.rbs | 352 +++++--- .../models/accounts/origin_update_params.rbs | 478 +--------- .../accounts/origin_update_response.rbs | 352 +++++--- sig/imagekit/resources/accounts/origins.rbs | 4 +- .../resources/accounts/origins_test.rb | 246 +----- 28 files changed, 5053 insertions(+), 6050 deletions(-) create mode 100644 lib/imagekit/models/accounts/origin.rb create mode 100644 rbi/imagekit/models/accounts/origin.rbi create mode 100644 sig/imagekit/models/accounts/origin.rbs diff --git a/.stats.yml b/.stats.yml index 0fe111b5..53bd25d3 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-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml -openapi_spec_hash: 98642308bee81ac776b7b1843089b888 -config_hash: 91cbeb97fdb75393dffd187ec25a4080 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d65a790786704dc315c1fded8ee24d61a55d96054fbbf1e6da429ec96b3e0c88.yml +openapi_spec_hash: 0fa9ee90455e183ec3b5d4e36f1351a9 +config_hash: 89ffae9ef2878c981a64f42cadb85186 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 345512fb..358728d1 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -50,6 +50,7 @@ require_relative "imagekit/internal/transport/base_client" require_relative "imagekit/internal/transport/pooled_net_requester" require_relative "imagekit/client" +require_relative "imagekit/models/accounts/origin" require_relative "imagekit/models/file" require_relative "imagekit/models/accounts/origin_create_params" require_relative "imagekit/models/accounts/origin_create_response" diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb index 9b6baee9..25bab102 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekit/internal/type/union.rb @@ -6,28 +6,28 @@ module Type # @api private # # @example - # # `origin_create_response` is a `Imagekit::Models::Accounts::OriginCreateResponse` - # case origin_create_response - # when Imagekit::Models::Accounts::OriginCreateResponse::S3 - # puts(origin_create_response.id) - # when Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible - # puts(origin_create_response.bucket) - # when Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup - # puts(origin_create_response.include_canonical_header) + # # `origin` is a `Imagekit::Accounts::Origin` + # case origin + # when Imagekit::Accounts::Origin::S3 + # puts(origin.access_key) + # when Imagekit::Accounts::Origin::S3Compatible + # puts(origin.bucket) + # when Imagekit::Accounts::Origin::CloudinaryBackup + # puts(origin.name) # else - # puts(origin_create_response) + # puts(origin) # end # # @example - # case origin_create_response - # in {type: :S3, id: id, bucket: bucket, include_canonical_header: include_canonical_header} - # puts(id) - # in {type: :S3_COMPATIBLE, id: id, bucket: bucket, endpoint: endpoint} + # case origin + # in {type: :S3, access_key: access_key, bucket: bucket, name: name} + # puts(access_key) + # in {type: :S3_COMPATIBLE, access_key: access_key, bucket: bucket, endpoint: endpoint} # puts(bucket) - # in {type: :CLOUDINARY_BACKUP, id: id, bucket: bucket, include_canonical_header: include_canonical_header} - # puts(include_canonical_header) + # in {type: :CLOUDINARY_BACKUP, access_key: access_key, bucket: bucket, name: name} + # puts(name) # else - # puts(origin_create_response) + # puts(origin) # end module Union include Imagekit::Internal::Type::Converter diff --git a/lib/imagekit/models/accounts/origin.rb b/lib/imagekit/models/accounts/origin.rb new file mode 100644 index 00000000..87b92f16 --- /dev/null +++ b/lib/imagekit/models/accounts/origin.rb @@ -0,0 +1,547 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # Schema for origin resources. + module Origin + extend Imagekit::Internal::Type::Union + + discriminator :type + + variant :S3, -> { Imagekit::Accounts::Origin::S3 } + + variant :S3_COMPATIBLE, -> { Imagekit::Accounts::Origin::S3Compatible } + + variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::Origin::CloudinaryBackup } + + variant :WEB_FOLDER, -> { Imagekit::Accounts::Origin::WebFolder } + + variant :WEB_PROXY, -> { Imagekit::Accounts::Origin::WebProxy } + + variant :GCS, -> { Imagekit::Accounts::Origin::Gcs } + + variant :AZURE_BLOB, -> { Imagekit::Accounts::Origin::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Accounts::Origin::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3] + required :type, const: :S3 + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :S3] + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, :S3_COMPATIBLE] + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :CLOUDINARY_BACKUP] + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. + # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_FOLDER] + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_PROXY] + end + + class Gcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute type + # + # @return [Symbol, :GCS] + required :type, const: :GCS + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @param bucket [String] + # + # @param client_email [String] + # + # @param name [String] Display name of the origin. + # + # @param private_key [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :GCS] + end + + class AzureBlob < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute type + # + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @param account_name [String] + # + # @param container [String] + # + # @param name [String] Display name of the origin. + # + # @param sas_token [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :AZURE_BLOB] + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute type + # + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + # @param base_url [String] Akeneo instance base URL. + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param name [String] Display name of the origin. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :AKENEO_PIM] + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim)] + end + end + end +end diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index d91d1635..d3f005e4 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -8,556 +8,8 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute origin - # Schema for origin resources. - # - # @return [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] - required :origin, union: -> { Imagekit::Accounts::OriginCreateParams::Origin } - - # @!method initialize(origin:, request_options: {}) - # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin resources. - # + # @!method initialize(request_options: {}) # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # Schema for origin resources. - module Origin - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :S3, -> { Imagekit::Accounts::OriginCreateParams::Origin::S3 } - - variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible } - - variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup } - - variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginCreateParams::Origin::WebFolder } - - variant :WEB_PROXY, -> { Imagekit::Accounts::OriginCreateParams::Origin::WebProxy } - - variant :GCS, -> { Imagekit::Accounts::OriginCreateParams::Origin::Gcs } - - variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim } - - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :S3] - required :type, const: :S3 - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param type [Symbol, :S3] - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :S3_COMPATIBLE] - required :type, const: :S3_COMPATIBLE - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param type [Symbol, :S3_COMPATIBLE] - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY_BACKUP] - required :type, const: :CLOUDINARY_BACKUP - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param type [Symbol, :CLOUDINARY_BACKUP] - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Root URL for the web folder origin. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_FOLDER] - required :type, const: :WEB_FOLDER - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :WEB_FOLDER] - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_PROXY] - required :type, const: :WEB_PROXY - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :WEB_PROXY] - end - - class Gcs < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey - - # @!attribute type - # - # @return [Symbol, :GCS] - required :type, const: :GCS - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) - # @param bucket [String] - # - # @param client_email [String] - # - # @param name [String] Display name of the origin. - # - # @param private_key [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param type [Symbol, :GCS] - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken - - # @!attribute type - # - # @return [Symbol, :AZURE_BLOB] - required :type, const: :AZURE_BLOB - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) - # @param account_name [String] - # - # @param container [String] - # - # @param name [String] Display name of the origin. - # - # @param sas_token [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param type [Symbol, :AZURE_BLOB] - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM - - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) - # @param base_url [String] Akeneo instance base URL. - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param name [String] Display name of the origin. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :AKENEO_PIM] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim)] - end end end end diff --git a/lib/imagekit/models/accounts/origin_create_response.rb b/lib/imagekit/models/accounts/origin_create_response.rb index 01e0c545..d1d545fb 100644 --- a/lib/imagekit/models/accounts/origin_create_response.rb +++ b/lib/imagekit/models/accounts/origin_create_response.rb @@ -3,56 +3,50 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). - # # @see Imagekit::Resources::Accounts::Origins#create module OriginCreateResponse extend Imagekit::Internal::Type::Union - discriminator :type + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::S3 } - variant :S3, -> { Imagekit::Models::Accounts::OriginCreateResponse::S3 } + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible } - variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible } + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup } - variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup } + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder } - variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder } + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy } - variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy } + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs } - variant :GCS, -> { Imagekit::Models::Accounts::OriginCreateResponse::Gcs } + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage } - variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim } + variant -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -65,35 +59,54 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::S3} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # @@ -106,31 +119,17 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -143,65 +142,81 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -214,32 +229,44 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -250,22 +277,6 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean] - required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # @@ -283,43 +294,46 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::WebFolder} for more details. + # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @param name [String] Display name of the origin. # - # @param base_url [String] Root URL for the web folder origin. + # @param id [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # @@ -337,31 +351,34 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::WebProxy} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # + # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) # @param name [String] Display name of the origin. # + # @param id [String] + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # # @param type [Symbol, :WEB_PROXY] end - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -372,24 +389,16 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix + # @!attribute private_key # # @return [String] - required :prefix, String + required :private_key, String, api_name: :privateKey # @!attribute type # @@ -402,37 +411,47 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::Gcs} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) # @param bucket [String] # # @param client_email [String] # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] + # @param private_key [String] + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # # @param type [Symbol, :GCS] end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -443,24 +462,16 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix + # @!attribute sas_token # # @return [String] - required :prefix, String + required :sas_token, String, api_name: :sasToken # @!attribute type # @@ -473,33 +484,43 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) # @param account_name [String] # # @param container [String] # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] + # @param sas_token [String] + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # # @param type [Symbol, :AZURE_BLOB] end @@ -510,13 +531,17 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute include_canonical_header - # Whether to send a Canonical header. + # @!attribute client_id + # Akeneo API client ID. # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret # @!attribute name # Display name of the origin. @@ -524,45 +549,68 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) # @param base_url [String] Akeneo instance base URL. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. # # @param name [String] Display name of the origin. # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param id [String] + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_get_response.rb b/lib/imagekit/models/accounts/origin_get_response.rb index f2faf7ad..2a88f014 100644 --- a/lib/imagekit/models/accounts/origin_get_response.rb +++ b/lib/imagekit/models/accounts/origin_get_response.rb @@ -3,56 +3,50 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). - # # @see Imagekit::Resources::Accounts::Origins#get module OriginGetResponse extend Imagekit::Internal::Type::Union - discriminator :type + variant -> { Imagekit::Models::Accounts::OriginGetResponse::S3 } - variant :S3, -> { Imagekit::Models::Accounts::OriginGetResponse::S3 } + variant -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible } - variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible } + variant -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup } - variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup } + variant -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder } - variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder } + variant -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy } - variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy } + variant -> { Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs } - variant :GCS, -> { Imagekit::Models::Accounts::OriginGetResponse::Gcs } + variant -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage } - variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim } + variant -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -65,35 +59,54 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::S3} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # @@ -106,31 +119,17 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -143,64 +142,81 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::S3Compatible} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -213,32 +229,44 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -249,22 +277,6 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean] - required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # @@ -282,43 +294,46 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::WebFolder} for more details. + # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @param name [String] Display name of the origin. # - # @param base_url [String] Root URL for the web folder origin. + # @param id [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # @@ -336,31 +351,34 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::WebProxy} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # + # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) # @param name [String] Display name of the origin. # + # @param id [String] + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # # @param type [Symbol, :WEB_PROXY] end - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -371,24 +389,16 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix + # @!attribute private_key # # @return [String] - required :prefix, String + required :private_key, String, api_name: :privateKey # @!attribute type # @@ -401,37 +411,47 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::Gcs} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) # @param bucket [String] # # @param client_email [String] # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] + # @param private_key [String] + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # # @param type [Symbol, :GCS] end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -442,24 +462,16 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix + # @!attribute sas_token # # @return [String] - required :prefix, String + required :sas_token, String, api_name: :sasToken # @!attribute type # @@ -472,33 +484,43 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::AzureBlob} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) # @param account_name [String] # # @param container [String] # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] + # @param sas_token [String] + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # # @param type [Symbol, :AZURE_BLOB] end @@ -509,13 +531,17 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute include_canonical_header - # Whether to send a Canonical header. + # @!attribute client_id + # Akeneo API client ID. # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret # @!attribute name # Display name of the origin. @@ -523,45 +549,68 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) # @param base_url [String] Akeneo instance base URL. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. # # @param name [String] Display name of the origin. # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param id [String] + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index 104d6194..3ca97e86 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -3,54 +3,49 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). module OriginListResponseItem extend Imagekit::Internal::Type::Union - discriminator :type + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::S3 } - variant :S3, -> { Imagekit::Models::Accounts::OriginListResponseItem::S3 } + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible } - variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible } + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup } - variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup } + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder } - variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder } + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy } - variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy } + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs } - variant :GCS, -> { Imagekit::Models::Accounts::OriginListResponseItem::Gcs } + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage } - variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim } + variant -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -63,35 +58,54 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::S3} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # @@ -104,31 +118,17 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -141,65 +141,81 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -212,32 +228,44 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -248,22 +276,6 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean] - required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # @@ -281,44 +293,46 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::WebFolder} for more - # details. + # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @param name [String] Display name of the origin. # - # @param base_url [String] Root URL for the web folder origin. + # @param id [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # @@ -336,31 +350,34 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::WebProxy} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # + # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) # @param name [String] Display name of the origin. # + # @param id [String] + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # # @param type [Symbol, :WEB_PROXY] end - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -371,24 +388,16 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix + # @!attribute private_key # # @return [String] - required :prefix, String + required :private_key, String, api_name: :privateKey # @!attribute type # @@ -401,37 +410,47 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::Gcs} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) # @param bucket [String] # # @param client_email [String] # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] + # @param private_key [String] + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # # @param type [Symbol, :GCS] end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -442,24 +461,16 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix + # @!attribute sas_token # # @return [String] - required :prefix, String + required :sas_token, String, api_name: :sasToken # @!attribute type # @@ -472,34 +483,43 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) # @param account_name [String] # # @param container [String] # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] + # @param sas_token [String] + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # # @param type [Symbol, :AZURE_BLOB] end @@ -510,13 +530,17 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute include_canonical_header - # Whether to send a Canonical header. + # @!attribute client_id + # Akeneo API client ID. # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret # @!attribute name # Display name of the origin. @@ -524,46 +548,68 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) # @param base_url [String] Akeneo instance base URL. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. # # @param name [String] Display name of the origin. # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param id [String] + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginListResponseItem::S3, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, Imagekit::Models::Accounts::OriginListResponseItem::Gcs, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginListResponseItem::S3, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim)] end # @type [Imagekit::Internal::Type::Converter] diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index e2cd97cf..d97a3cc0 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -8,556 +8,8 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute origin - # Schema for origin resources. - # - # @return [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] - required :origin, union: -> { Imagekit::Accounts::OriginUpdateParams::Origin } - - # @!method initialize(origin:, request_options: {}) - # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin resources. - # + # @!method initialize(request_options: {}) # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # Schema for origin resources. - module Origin - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :S3, -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3 } - - variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible } - - variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup } - - variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder } - - variant :WEB_PROXY, -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy } - - variant :GCS, -> { Imagekit::Accounts::OriginUpdateParams::Origin::Gcs } - - variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim } - - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :S3] - required :type, const: :S3 - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param type [Symbol, :S3] - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :S3_COMPATIBLE] - required :type, const: :S3_COMPATIBLE - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param type [Symbol, :S3_COMPATIBLE] - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY_BACKUP] - required :type, const: :CLOUDINARY_BACKUP - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param type [Symbol, :CLOUDINARY_BACKUP] - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Root URL for the web folder origin. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_FOLDER] - required :type, const: :WEB_FOLDER - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :WEB_FOLDER] - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_PROXY] - required :type, const: :WEB_PROXY - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :WEB_PROXY] - end - - class Gcs < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey - - # @!attribute type - # - # @return [Symbol, :GCS] - required :type, const: :GCS - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) - # @param bucket [String] - # - # @param client_email [String] - # - # @param name [String] Display name of the origin. - # - # @param private_key [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param type [Symbol, :GCS] - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken - - # @!attribute type - # - # @return [Symbol, :AZURE_BLOB] - required :type, const: :AZURE_BLOB - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) - # @param account_name [String] - # - # @param container [String] - # - # @param name [String] Display name of the origin. - # - # @param sas_token [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param type [Symbol, :AZURE_BLOB] - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM - - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) - # @param base_url [String] Akeneo instance base URL. - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param name [String] Display name of the origin. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :AKENEO_PIM] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim)] - end end end end diff --git a/lib/imagekit/models/accounts/origin_update_response.rb b/lib/imagekit/models/accounts/origin_update_response.rb index eae3c9c5..39319937 100644 --- a/lib/imagekit/models/accounts/origin_update_response.rb +++ b/lib/imagekit/models/accounts/origin_update_response.rb @@ -3,56 +3,50 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). - # # @see Imagekit::Resources::Accounts::Origins#update module OriginUpdateResponse extend Imagekit::Internal::Type::Union - discriminator :type + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3 } - variant :S3, -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3 } + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible } - variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible } + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup } - variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup } + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder } - variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder } + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy } - variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy } + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs } - variant :GCS, -> { Imagekit::Models::Accounts::OriginUpdateResponse::Gcs } + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage } - variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim } + variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -65,35 +59,54 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::S3} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # @@ -106,31 +119,17 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -143,65 +142,81 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix - # Path prefix inside the bucket. + # @!attribute secret_key + # Secret key for the bucket. # # @return [String] - required :prefix, String + required :secret_key, String, api_name: :secretKey # @!attribute type # @@ -214,32 +229,44 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] Path prefix inside the bucket. + # @param secret_key [String] Secret key for the bucket. + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -250,22 +277,6 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean] - required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # @@ -283,43 +294,46 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder} for more details. + # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @param name [String] Display name of the origin. # - # @param base_url [String] Root URL for the web folder origin. + # @param id [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # @@ -337,31 +351,34 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # + # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) # @param name [String] Display name of the origin. # + # @param id [String] + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # # @param type [Symbol, :WEB_PROXY] end - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -372,24 +389,16 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix + # @!attribute private_key # # @return [String] - required :prefix, String + required :private_key, String, api_name: :privateKey # @!attribute type # @@ -402,37 +411,47 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::Gcs} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) # @param bucket [String] # # @param client_email [String] # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] + # @param private_key [String] + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # # @param type [Symbol, :GCS] end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -443,24 +462,16 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute prefix + # @!attribute sas_token # # @return [String] - required :prefix, String + required :sas_token, String, api_name: :sasToken # @!attribute type # @@ -473,33 +484,43 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) # @param account_name [String] # # @param container [String] # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param name [String] Display name of the origin. # - # @param prefix [String] + # @param sas_token [String] + # + # @param id [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # # @param type [Symbol, :AZURE_BLOB] end @@ -510,13 +531,17 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute include_canonical_header - # Whether to send a Canonical header. + # @!attribute client_id + # Akeneo API client ID. # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret # @!attribute name # Display name of the origin. @@ -524,45 +549,68 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + response_only do # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String end - # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) # @param base_url [String] Akeneo instance base URL. # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. # # @param name [String] Display name of the origin. # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param id [String] + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index a7f4281e..aa7d70e3 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -9,11 +9,11 @@ class Origins # # @overload create(origin:, request_options: {}) # - # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin resources. + # @param origin [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] Schema for origin resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginCreateParams def create(params) @@ -37,11 +37,11 @@ def create(params) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin resources. + # @param origin [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] Schema for origin resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginUpdateParams def update(id, params) @@ -62,7 +62,7 @@ def update(id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::Accounts::OriginListParams def list(params = {}) @@ -111,7 +111,7 @@ def delete(id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginGetParams def get(id, params = {}) diff --git a/rbi/imagekit/models/accounts/origin.rbi b/rbi/imagekit/models/accounts/origin.rbi new file mode 100644 index 00000000..d5d5249a --- /dev/null +++ b/rbi/imagekit/models/accounts/origin.rbi @@ -0,0 +1,768 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + # Schema for origin resources. + module Origin + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Accounts::Origin::S3, + Imagekit::Accounts::Origin::S3Compatible, + Imagekit::Accounts::Origin::CloudinaryBackup, + Imagekit::Accounts::Origin::WebFolder, + Imagekit::Accounts::Origin::WebProxy, + Imagekit::Accounts::Origin::Gcs, + Imagekit::Accounts::Origin::AzureBlob, + Imagekit::Accounts::Origin::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Accounts::Origin::S3, Imagekit::Internal::AnyHash) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :S3 + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::Origin::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig do + params( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + type: :S3_COMPATIBLE + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean + } + ) + end + def to_hash + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::Origin::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :CLOUDINARY_BACKUP + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::Origin::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(String) } + attr_accessor :base_url + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + name: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Root URL for the web folder origin. + base_url:, + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_FOLDER + ) + end + + sig do + override.returns( + { + base_url: String, + name: String, + type: Symbol, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::Origin::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + name: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_PROXY + ) + end + + sig do + override.returns( + { + name: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class Gcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::Origin::Gcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + bucket: String, + client_email: String, + name: String, + private_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + bucket:, + client_email:, + # Display name of the origin. + name:, + private_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :GCS + ) + end + + sig do + override.returns( + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AzureBlob < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::Origin::AzureBlob, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :sas_token + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + account_name: String, + container: String, + name: String, + sas_token: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + account_name:, + container:, + # Display name of the origin. + name:, + sas_token:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :AZURE_BLOB + ) + end + + sig do + override.returns( + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::Origin::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + sig { returns(Symbol) } + attr_accessor :type + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Akeneo instance base URL. + base_url:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Display name of the origin. + name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :AKENEO_PIM + ) + end + + sig do + override.returns( + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: Symbol, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + sig { override.returns(T::Array[Imagekit::Accounts::Origin::Variants]) } + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index 0ab207a8..f53d55e5 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -15,834 +15,17 @@ module Imagekit ) end - # Schema for origin resources. sig do - returns( - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - ) + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class ) end - attr_accessor :origin - - sig do - params( - origin: - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Schema for origin resources. - origin:, - request_options: {} - ) + def self.new(request_options: {}) end - sig do - override.returns( - { - origin: - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - ), - request_options: Imagekit::RequestOptions - } - ) - end + sig { override.returns({ request_options: Imagekit::RequestOptions }) } def to_hash end - - # Schema for origin resources. - module Origin - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - ) - end - - class S3 < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - type: :S3 - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - sig do - params( - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Custom S3-compatible endpoint. - endpoint:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - type: :S3_COMPATIBLE - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean - } - ) - end - def to_hash - end - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - type: :CLOUDINARY_BACKUP - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, - Imagekit::Internal::AnyHash - ) - end - - # Root URL for the web folder origin. - sig { returns(String) } - attr_accessor :base_url - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - base_url: String, - name: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Root URL for the web folder origin. - base_url:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :WEB_FOLDER - ) - end - - sig do - override.returns( - { - base_url: String, - name: String, - type: Symbol, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Internal::AnyHash - ) - end - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - name: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :WEB_PROXY - ) - end - - sig do - override.returns( - { - name: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - class Gcs < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::Gcs, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :bucket - - sig { returns(String) } - attr_accessor :client_email - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :private_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - bucket: String, - client_email: String, - name: String, - private_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - bucket:, - client_email:, - # Display name of the origin. - name:, - private_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - type: :GCS - ) - end - - sig do - override.returns( - { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :sas_token - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - account_name: String, - container: String, - name: String, - sas_token: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - account_name:, - container:, - # Display name of the origin. - name:, - sas_token:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - type: :AZURE_BLOB - ) - end - - sig do - override.returns( - { - account_name: String, - container: String, - name: String, - sas_token: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim, - Imagekit::Internal::AnyHash - ) - end - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - - sig { returns(Symbol) } - attr_accessor :type - - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Akeneo instance base URL. - base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Display name of the origin. - name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :AKENEO_PIM - ) - end - - sig do - override.returns( - { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: Symbol, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - sig do - override.returns( - T::Array[Imagekit::Accounts::OriginCreateParams::Origin::Variants] - ) - end - def self.variants - end - end end end end diff --git a/rbi/imagekit/models/accounts/origin_create_response.rbi b/rbi/imagekit/models/accounts/origin_create_response.rbi index dc8ab505..9d66a376 100644 --- a/rbi/imagekit/models/accounts/origin_create_response.rbi +++ b/rbi/imagekit/models/accounts/origin_create_response.rbi @@ -3,7 +3,6 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). module OriginCreateResponse extend Imagekit::Internal::Type::Union @@ -15,8 +14,8 @@ module Imagekit Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, - Imagekit::Models::Accounts::OriginCreateResponse::Gcs, - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim ) end @@ -30,21 +29,21 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -56,36 +55,55 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, type: :S3 ) end @@ -93,13 +111,15 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -116,6 +136,10 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -124,21 +148,13 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix - - # Use path-style S3 URLs? - sig { returns(T::Boolean) } - attr_accessor :s3_force_path_style + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -150,42 +166,68 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: T::Boolean, name: String, + secret_key: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, prefix: String, s3_force_path_style: T::Boolean, - base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, - # Use path-style S3 URLs? - s3_force_path_style:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, type: :S3_COMPATIBLE ) end @@ -193,15 +235,17 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, - s3_force_path_style: T::Boolean, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean } ) end @@ -218,21 +262,21 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -244,36 +288,55 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -281,13 +344,15 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -308,14 +373,6 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Forward the Host header to origin? - sig { returns(T::Boolean) } - attr_accessor :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -330,36 +387,49 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, name: String, + id: String, base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, # Root URL for the web folder origin. base_url:, - # Forward the Host header to origin? - forward_host_header_to_origin:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -367,13 +437,13 @@ module Imagekit sig do override.returns( { - id: String, base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, name: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean } ) end @@ -390,10 +460,6 @@ module Imagekit ) end - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -408,30 +474,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, - include_canonical_header: T::Boolean, name: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :WEB_PROXY ) end @@ -439,11 +511,11 @@ module Imagekit sig do override.returns( { - id: String, - include_canonical_header: T::Boolean, name: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean } ) end @@ -451,11 +523,11 @@ module Imagekit end end - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginCreateResponse::Gcs, + Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Internal::AnyHash ) end @@ -466,16 +538,12 @@ module Imagekit sig { returns(String) } attr_accessor :client_email - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :prefix + attr_accessor :private_key sig { returns(Symbol) } attr_accessor :type @@ -487,36 +555,50 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, bucket: String, client_email: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + private_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, bucket:, client_email:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - prefix:, + private_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, type: :GCS ) end @@ -524,14 +606,15 @@ module Imagekit sig do override.returns( { - id: String, bucket: String, client_email: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + private_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -539,11 +622,11 @@ module Imagekit end end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Internal::AnyHash ) end @@ -554,16 +637,12 @@ module Imagekit sig { returns(String) } attr_accessor :container - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :prefix + attr_accessor :sas_token sig { returns(Symbol) } attr_accessor :type @@ -575,36 +654,50 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, account_name: String, container: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + sas_token: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, account_name:, container:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - prefix:, + sas_token:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, type: :AZURE_BLOB ) end @@ -612,14 +705,15 @@ module Imagekit sig do override.returns( { - id: String, account_name: String, container: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + sas_token: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -640,17 +734,29 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret # Display name of the origin. sig { returns(String) } attr_accessor :name + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + sig { returns(Symbol) } attr_accessor :type + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -658,33 +764,51 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, base_url: String, - include_canonical_header: T::Boolean, + client_id: String, + client_secret: String, name: String, + password: String, + username: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, # Akeneo instance base URL. base_url:, - # Whether to send a Canonical header. - include_canonical_header:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, # Display name of the origin. name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -692,12 +816,16 @@ module Imagekit sig do override.returns( { - id: String, base_url: String, - include_canonical_header: T::Boolean, + client_id: String, + client_secret: String, name: String, + password: String, type: Symbol, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean } ) end diff --git a/rbi/imagekit/models/accounts/origin_get_response.rbi b/rbi/imagekit/models/accounts/origin_get_response.rbi index acbc7270..26982ea5 100644 --- a/rbi/imagekit/models/accounts/origin_get_response.rbi +++ b/rbi/imagekit/models/accounts/origin_get_response.rbi @@ -3,7 +3,6 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). module OriginGetResponse extend Imagekit::Internal::Type::Union @@ -15,8 +14,8 @@ module Imagekit Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, - Imagekit::Models::Accounts::OriginGetResponse::Gcs, - Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim ) end @@ -30,21 +29,21 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -56,36 +55,55 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, type: :S3 ) end @@ -93,13 +111,15 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -116,6 +136,10 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -124,21 +148,13 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix - - # Use path-style S3 URLs? - sig { returns(T::Boolean) } - attr_accessor :s3_force_path_style + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -150,42 +166,68 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: T::Boolean, name: String, + secret_key: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, prefix: String, s3_force_path_style: T::Boolean, - base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, - # Use path-style S3 URLs? - s3_force_path_style:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, type: :S3_COMPATIBLE ) end @@ -193,15 +235,17 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, - s3_force_path_style: T::Boolean, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean } ) end @@ -218,21 +262,21 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -244,36 +288,55 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -281,13 +344,15 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -308,14 +373,6 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Forward the Host header to origin? - sig { returns(T::Boolean) } - attr_accessor :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -330,36 +387,49 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, name: String, + id: String, base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, # Root URL for the web folder origin. base_url:, - # Forward the Host header to origin? - forward_host_header_to_origin:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -367,13 +437,13 @@ module Imagekit sig do override.returns( { - id: String, base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, name: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean } ) end @@ -390,10 +460,6 @@ module Imagekit ) end - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -408,30 +474,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, - include_canonical_header: T::Boolean, name: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :WEB_PROXY ) end @@ -439,11 +511,11 @@ module Imagekit sig do override.returns( { - id: String, - include_canonical_header: T::Boolean, name: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean } ) end @@ -451,11 +523,11 @@ module Imagekit end end - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::Gcs, + Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Internal::AnyHash ) end @@ -466,16 +538,12 @@ module Imagekit sig { returns(String) } attr_accessor :client_email - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :prefix + attr_accessor :private_key sig { returns(Symbol) } attr_accessor :type @@ -487,36 +555,50 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, bucket: String, client_email: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + private_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, bucket:, client_email:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - prefix:, + private_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, type: :GCS ) end @@ -524,14 +606,15 @@ module Imagekit sig do override.returns( { - id: String, bucket: String, client_email: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + private_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -539,11 +622,11 @@ module Imagekit end end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Internal::AnyHash ) end @@ -554,16 +637,12 @@ module Imagekit sig { returns(String) } attr_accessor :container - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :prefix + attr_accessor :sas_token sig { returns(Symbol) } attr_accessor :type @@ -575,36 +654,50 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, account_name: String, container: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + sas_token: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, account_name:, container:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - prefix:, + sas_token:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, type: :AZURE_BLOB ) end @@ -612,14 +705,15 @@ module Imagekit sig do override.returns( { - id: String, account_name: String, container: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + sas_token: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -640,17 +734,29 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret # Display name of the origin. sig { returns(String) } attr_accessor :name + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + sig { returns(Symbol) } attr_accessor :type + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -658,33 +764,51 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, base_url: String, - include_canonical_header: T::Boolean, + client_id: String, + client_secret: String, name: String, + password: String, + username: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, # Akeneo instance base URL. base_url:, - # Whether to send a Canonical header. - include_canonical_header:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, # Display name of the origin. name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -692,12 +816,16 @@ module Imagekit sig do override.returns( { - id: String, base_url: String, - include_canonical_header: T::Boolean, + client_id: String, + client_secret: String, name: String, + password: String, type: Symbol, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean } ) end diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index 26f5914e..b0f10a3a 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -3,7 +3,6 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). module OriginListResponseItem extend Imagekit::Internal::Type::Union @@ -15,8 +14,8 @@ module Imagekit Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, - Imagekit::Models::Accounts::OriginListResponseItem::Gcs, - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim ) end @@ -30,21 +29,21 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -56,36 +55,55 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, type: :S3 ) end @@ -93,13 +111,15 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -116,6 +136,10 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -124,21 +148,13 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix - - # Use path-style S3 URLs? - sig { returns(T::Boolean) } - attr_accessor :s3_force_path_style + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -150,42 +166,68 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: T::Boolean, name: String, + secret_key: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, prefix: String, s3_force_path_style: T::Boolean, - base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, - # Use path-style S3 URLs? - s3_force_path_style:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, type: :S3_COMPATIBLE ) end @@ -193,15 +235,17 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, - s3_force_path_style: T::Boolean, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean } ) end @@ -218,21 +262,21 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -244,36 +288,55 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -281,13 +344,15 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -308,14 +373,6 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Forward the Host header to origin? - sig { returns(T::Boolean) } - attr_accessor :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -330,36 +387,49 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, name: String, + id: String, base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, # Root URL for the web folder origin. base_url:, - # Forward the Host header to origin? - forward_host_header_to_origin:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -367,13 +437,13 @@ module Imagekit sig do override.returns( { - id: String, base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, name: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean } ) end @@ -390,10 +460,6 @@ module Imagekit ) end - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -408,30 +474,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, - include_canonical_header: T::Boolean, name: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :WEB_PROXY ) end @@ -439,11 +511,11 @@ module Imagekit sig do override.returns( { - id: String, - include_canonical_header: T::Boolean, name: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean } ) end @@ -451,11 +523,11 @@ module Imagekit end end - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginListResponseItem::Gcs, + Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, Imagekit::Internal::AnyHash ) end @@ -466,16 +538,12 @@ module Imagekit sig { returns(String) } attr_accessor :client_email - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :prefix + attr_accessor :private_key sig { returns(Symbol) } attr_accessor :type @@ -487,36 +555,50 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, bucket: String, client_email: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + private_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, bucket:, client_email:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - prefix:, + private_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, type: :GCS ) end @@ -524,14 +606,15 @@ module Imagekit sig do override.returns( { - id: String, bucket: String, client_email: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + private_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -539,11 +622,11 @@ module Imagekit end end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, Imagekit::Internal::AnyHash ) end @@ -554,16 +637,12 @@ module Imagekit sig { returns(String) } attr_accessor :container - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :prefix + attr_accessor :sas_token sig { returns(Symbol) } attr_accessor :type @@ -575,36 +654,50 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, account_name: String, container: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + sas_token: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, account_name:, container:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - prefix:, + sas_token:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, type: :AZURE_BLOB ) end @@ -612,14 +705,15 @@ module Imagekit sig do override.returns( { - id: String, account_name: String, container: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + sas_token: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -640,17 +734,29 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret # Display name of the origin. sig { returns(String) } attr_accessor :name + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + sig { returns(Symbol) } attr_accessor :type + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -658,33 +764,51 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, base_url: String, - include_canonical_header: T::Boolean, + client_id: String, + client_secret: String, name: String, + password: String, + username: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, # Akeneo instance base URL. base_url:, - # Whether to send a Canonical header. - include_canonical_header:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, # Display name of the origin. name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -692,12 +816,16 @@ module Imagekit sig do override.returns( { - id: String, base_url: String, - include_canonical_header: T::Boolean, + client_id: String, + client_secret: String, name: String, + password: String, type: Symbol, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean } ) end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index 66a7c75e..51783397 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -15,834 +15,17 @@ module Imagekit ) end - # Schema for origin resources. sig do - returns( - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - ) + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class ) end - attr_accessor :origin - - sig do - params( - origin: - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Schema for origin resources. - origin:, - request_options: {} - ) + def self.new(request_options: {}) end - sig do - override.returns( - { - origin: - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - ), - request_options: Imagekit::RequestOptions - } - ) - end + sig { override.returns({ request_options: Imagekit::RequestOptions }) } def to_hash end - - # Schema for origin resources. - module Origin - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - ) - end - - class S3 < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - type: :S3 - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - sig do - params( - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Custom S3-compatible endpoint. - endpoint:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - type: :S3_COMPATIBLE - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean - } - ) - end - def to_hash - end - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - type: :CLOUDINARY_BACKUP - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, - Imagekit::Internal::AnyHash - ) - end - - # Root URL for the web folder origin. - sig { returns(String) } - attr_accessor :base_url - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - base_url: String, - name: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Root URL for the web folder origin. - base_url:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :WEB_FOLDER - ) - end - - sig do - override.returns( - { - base_url: String, - name: String, - type: Symbol, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Internal::AnyHash - ) - end - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - name: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :WEB_PROXY - ) - end - - sig do - override.returns( - { - name: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - class Gcs < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :bucket - - sig { returns(String) } - attr_accessor :client_email - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :private_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - bucket: String, - client_email: String, - name: String, - private_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - bucket:, - client_email:, - # Display name of the origin. - name:, - private_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - type: :GCS - ) - end - - sig do - override.returns( - { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :sas_token - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - account_name: String, - container: String, - name: String, - sas_token: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - account_name:, - container:, - # Display name of the origin. - name:, - sas_token:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - type: :AZURE_BLOB - ) - end - - sig do - override.returns( - { - account_name: String, - container: String, - name: String, - sas_token: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim, - Imagekit::Internal::AnyHash - ) - end - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - - sig { returns(Symbol) } - attr_accessor :type - - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Akeneo instance base URL. - base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Display name of the origin. - name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :AKENEO_PIM - ) - end - - sig do - override.returns( - { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: Symbol, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - sig do - override.returns( - T::Array[Imagekit::Accounts::OriginUpdateParams::Origin::Variants] - ) - end - def self.variants - end - end end end end diff --git a/rbi/imagekit/models/accounts/origin_update_response.rbi b/rbi/imagekit/models/accounts/origin_update_response.rbi index 6d07d92c..3cf16b43 100644 --- a/rbi/imagekit/models/accounts/origin_update_response.rbi +++ b/rbi/imagekit/models/accounts/origin_update_response.rbi @@ -3,7 +3,6 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). module OriginUpdateResponse extend Imagekit::Internal::Type::Union @@ -15,8 +14,8 @@ module Imagekit Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, - Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim ) end @@ -30,21 +29,21 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -56,36 +55,55 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, type: :S3 ) end @@ -93,13 +111,15 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -116,6 +136,10 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -124,21 +148,13 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix - - # Use path-style S3 URLs? - sig { returns(T::Boolean) } - attr_accessor :s3_force_path_style + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -150,42 +166,68 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: T::Boolean, name: String, + secret_key: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, prefix: String, s3_force_path_style: T::Boolean, - base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, - # Use path-style S3 URLs? - s3_force_path_style:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, type: :S3_COMPATIBLE ) end @@ -193,15 +235,17 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, - s3_force_path_style: T::Boolean, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean } ) end @@ -218,21 +262,21 @@ module Imagekit ) end + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + # S3 bucket name. sig { returns(String) } attr_accessor :bucket - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Path prefix inside the bucket. + # Secret key for the bucket. sig { returns(String) } - attr_accessor :prefix + attr_accessor :secret_key sig { returns(Symbol) } attr_accessor :type @@ -244,36 +288,55 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, + # Access key for the bucket. + access_key:, # S3 bucket name. bucket:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - # Path prefix inside the bucket. - prefix:, + # Secret key for the bucket. + secret_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -281,13 +344,15 @@ module Imagekit sig do override.returns( { - id: String, + access_key: String, bucket: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + secret_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -308,14 +373,6 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Forward the Host header to origin? - sig { returns(T::Boolean) } - attr_accessor :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -330,36 +387,49 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, name: String, + id: String, base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, # Root URL for the web folder origin. base_url:, - # Forward the Host header to origin? - forward_host_header_to_origin:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -367,13 +437,13 @@ module Imagekit sig do override.returns( { - id: String, base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, name: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean } ) end @@ -390,10 +460,6 @@ module Imagekit ) end - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -408,30 +474,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, - include_canonical_header: T::Boolean, name: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :WEB_PROXY ) end @@ -439,11 +511,11 @@ module Imagekit sig do override.returns( { - id: String, - include_canonical_header: T::Boolean, name: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean } ) end @@ -451,11 +523,11 @@ module Imagekit end end - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, + Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Internal::AnyHash ) end @@ -466,16 +538,12 @@ module Imagekit sig { returns(String) } attr_accessor :client_email - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :prefix + attr_accessor :private_key sig { returns(Symbol) } attr_accessor :type @@ -487,36 +555,50 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, bucket: String, client_email: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + private_key: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, bucket:, client_email:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - prefix:, + private_key:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, type: :GCS ) end @@ -524,14 +606,15 @@ module Imagekit sig do override.returns( { - id: String, bucket: String, client_email: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + private_key: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -539,11 +622,11 @@ module Imagekit end end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Internal::AnyHash ) end @@ -554,16 +637,12 @@ module Imagekit sig { returns(String) } attr_accessor :container - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :prefix + attr_accessor :sas_token sig { returns(Symbol) } attr_accessor :type @@ -575,36 +654,50 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, account_name: String, container: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + sas_token: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, account_name:, container:, - # Whether to send a Canonical header. - include_canonical_header:, # Display name of the origin. name:, - prefix:, + sas_token:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, type: :AZURE_BLOB ) end @@ -612,14 +705,15 @@ module Imagekit sig do override.returns( { - id: String, account_name: String, container: String, - include_canonical_header: T::Boolean, name: String, - prefix: String, + sas_token: String, type: Symbol, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String } ) end @@ -640,17 +734,29 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret # Display name of the origin. sig { returns(String) } attr_accessor :name + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + sig { returns(Symbol) } attr_accessor :type + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -658,33 +764,51 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id sig do params( - id: String, base_url: String, - include_canonical_header: T::Boolean, + client_id: String, + client_secret: String, name: String, + password: String, + username: String, + id: String, base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, # Akeneo instance base URL. base_url:, - # Whether to send a Canonical header. - include_canonical_header:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, # Display name of the origin. name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -692,12 +816,16 @@ module Imagekit sig do override.returns( { - id: String, base_url: String, - include_canonical_header: T::Boolean, + client_id: String, + client_secret: String, name: String, + password: String, type: Symbol, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean } ) end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index 7d81464f..b914baef 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -10,14 +10,14 @@ module Imagekit params( origin: T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash + Imagekit::Accounts::Origin::S3::OrHash, + Imagekit::Accounts::Origin::S3Compatible::OrHash, + Imagekit::Accounts::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::Origin::WebFolder::OrHash, + Imagekit::Accounts::Origin::WebProxy::OrHash, + Imagekit::Accounts::Origin::Gcs::OrHash, + Imagekit::Accounts::Origin::AzureBlob::OrHash, + Imagekit::Accounts::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginCreateResponse::Variants) @@ -36,14 +36,14 @@ module Imagekit id: String, origin: T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash + Imagekit::Accounts::Origin::S3::OrHash, + Imagekit::Accounts::Origin::S3Compatible::OrHash, + Imagekit::Accounts::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::Origin::WebFolder::OrHash, + Imagekit::Accounts::Origin::WebProxy::OrHash, + Imagekit::Accounts::Origin::Gcs::OrHash, + Imagekit::Accounts::Origin::AzureBlob::OrHash, + Imagekit::Accounts::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::OriginUpdateResponse::Variants) diff --git a/sig/imagekit/models/accounts/origin.rbs b/sig/imagekit/models/accounts/origin.rbs new file mode 100644 index 00000000..ef0e09c2 --- /dev/null +++ b/sig/imagekit/models/accounts/origin.rbs @@ -0,0 +1,468 @@ +module Imagekit + module Models + module Accounts + type origin = + Imagekit::Accounts::Origin::S3 + | Imagekit::Accounts::Origin::S3Compatible + | Imagekit::Accounts::Origin::CloudinaryBackup + | Imagekit::Accounts::Origin::WebFolder + | Imagekit::Accounts::Origin::WebProxy + | Imagekit::Accounts::Origin::Gcs + | Imagekit::Accounts::Origin::AzureBlob + | Imagekit::Accounts::Origin::AkeneoPim + + module Origin + extend Imagekit::Internal::Type::Union + + type s3 = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3 + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :S3 + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type s3_compatible = + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3_COMPATIBLE + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + def initialize: ( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?type: :S3_COMPATIBLE + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + end + + type cloudinary_backup = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :CLOUDINARY_BACKUP + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :CLOUDINARY_BACKUP + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type web_folder = + { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor name: String + + attr_accessor type: :WEB_FOLDER + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + name: String, + ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, + ?type: :WEB_FOLDER + ) -> void + + def to_hash: -> { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + end + + type web_proxy = + { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor type: :WEB_PROXY + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + name: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :WEB_PROXY + ) -> void + + def to_hash: -> { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + type gcs = + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class Gcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor name: String + + attr_accessor private_key: String + + attr_accessor type: :GCS + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + bucket: String, + client_email: String, + name: String, + private_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :GCS + ) -> void + + def to_hash: -> { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type azure_blob = + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class AzureBlob < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor name: String + + attr_accessor sas_token: String + + attr_accessor type: :AZURE_BLOB + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + account_name: String, + container: String, + name: String, + sas_token: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :AZURE_BLOB + ) -> void + + def to_hash: -> { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type akeneo_pim = + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor name: String + + attr_accessor password: String + + attr_accessor type: :AKENEO_PIM + + attr_accessor username: String + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :AKENEO_PIM + ) -> void + + def to_hash: -> { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin] + end + end + end +end diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index 83e146cf..60ad3272 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -2,487 +2,15 @@ module Imagekit module Models module Accounts type origin_create_params = - { origin: Imagekit::Models::Accounts::OriginCreateParams::origin } - & Imagekit::Internal::Type::request_parameters + { } & Imagekit::Internal::Type::request_parameters class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor origin: Imagekit::Models::Accounts::OriginCreateParams::origin + def initialize: (?request_options: Imagekit::request_opts) -> void - def initialize: ( - origin: Imagekit::Models::Accounts::OriginCreateParams::origin, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - origin: Imagekit::Models::Accounts::OriginCreateParams::origin, - request_options: Imagekit::RequestOptions - } - - type origin = - Imagekit::Accounts::OriginCreateParams::Origin::S3 - | Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible - | Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup - | Imagekit::Accounts::OriginCreateParams::Origin::WebFolder - | Imagekit::Accounts::OriginCreateParams::Origin::WebProxy - | Imagekit::Accounts::OriginCreateParams::Origin::Gcs - | Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob - | Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - - module Origin - extend Imagekit::Internal::Type::Union - - type s3 = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :S3, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :S3 - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :S3 - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :S3, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type s3_compatible = - { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - :s3_force_path_style => bool - } - - class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor endpoint: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :S3_COMPATIBLE - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - def initialize: ( - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?type: :S3_COMPATIBLE - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - :s3_force_path_style => bool - } - end - - type cloudinary_backup = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :CLOUDINARY_BACKUP - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :CLOUDINARY_BACKUP - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type web_folder = - { - base_url: String, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool - } - - class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor name: String - - attr_accessor type: :WEB_FOLDER - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - base_url: String, - name: String, - ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, - ?type: :WEB_FOLDER - ) -> void - - def to_hash: -> { - base_url: String, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool - } - end - - type web_proxy = - { - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - - class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor name: String - - attr_accessor type: :WEB_PROXY - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - name: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?type: :WEB_PROXY - ) -> void - - def to_hash: -> { - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - end - - type gcs = - { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: :GCS, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class Gcs < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor client_email: String - - attr_accessor name: String - - attr_accessor private_key: String - - attr_accessor type: :GCS - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - bucket: String, - client_email: String, - name: String, - private_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :GCS - ) -> void - - def to_hash: -> { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: :GCS, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type azure_blob = - { - account_name: String, - container: String, - name: String, - sas_token: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class AzureBlob < Imagekit::Internal::Type::BaseModel - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor name: String - - attr_accessor sas_token: String - - attr_accessor type: :AZURE_BLOB - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - account_name: String, - container: String, - name: String, - sas_token: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :AZURE_BLOB - ) -> void - - def to_hash: -> { - account_name: String, - container: String, - name: String, - sas_token: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type akeneo_pim = - { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: :AKENEO_PIM, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor client_id: String - - attr_accessor client_secret: String - - attr_accessor name: String - - attr_accessor password: String - - attr_accessor type: :AKENEO_PIM - - attr_accessor username: String - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?type: :AKENEO_PIM - ) -> void - - def to_hash: -> { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: :AKENEO_PIM, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::OriginCreateParams::origin] - end + def to_hash: -> { request_options: Imagekit::RequestOptions } end end end diff --git a/sig/imagekit/models/accounts/origin_create_response.rbs b/sig/imagekit/models/accounts/origin_create_response.rbs index 0d71ff69..8d98ddf3 100644 --- a/sig/imagekit/models/accounts/origin_create_response.rbs +++ b/sig/imagekit/models/accounts/origin_create_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginCreateResponse::WebFolder | Imagekit::Models::Accounts::OriginCreateResponse::WebProxy - | Imagekit::Models::Accounts::OriginCreateResponse::Gcs - | Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob + | Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs + | Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage | Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim module OriginCreateResponse @@ -16,23 +16,25 @@ module Imagekit type s3 = { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :S3, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String + attr_accessor access_key: String - attr_accessor include_canonical_header: bool + attr_accessor bucket: String attr_accessor name: String - attr_accessor prefix: String + attr_accessor secret_key: String attr_accessor type: :S3 @@ -40,54 +42,68 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :S3, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type s3_compatible = { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - :s3_force_path_style => bool, + secret_key: String, type: :S3_COMPATIBLE, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool } class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + attr_accessor bucket: String attr_accessor endpoint: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String - - attr_accessor s3_force_path_style: bool + attr_accessor secret_key: String attr_accessor type: :S3_COMPATIBLE @@ -95,52 +111,72 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - s3_force_path_style: bool, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - :s3_force_path_style => bool, + secret_key: String, type: :S3_COMPATIBLE, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool } end type cloudinary_backup = { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String + attr_accessor access_key: String - attr_accessor include_canonical_header: bool + attr_accessor bucket: String attr_accessor name: String - attr_accessor prefix: String + attr_accessor secret_key: String attr_accessor type: :CLOUDINARY_BACKUP @@ -148,47 +184,57 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type web_folder = { - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, type: :WEB_FOLDER, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor forward_host_header_to_origin: bool - - attr_accessor include_canonical_header: bool - attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -197,41 +243,49 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, + ?id: String, ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, type: :WEB_FOLDER, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool } end type web_proxy = { - id: String, - include_canonical_header: bool, name: String, type: :WEB_PROXY, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor include_canonical_header: bool - attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -240,47 +294,52 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, - include_canonical_header: bool, name: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { - id: String, - include_canonical_header: bool, name: String, type: :WEB_PROXY, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } end - type gcs = + type google_cloud_storage_gcs = { - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, type: :GCS, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String + attr_accessor private_key: String attr_accessor type: :GCS @@ -288,53 +347,64 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, type: :GCS, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end - type azure_blob = + type azure_blob_storage = { - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, type: :AZURE_BLOB, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String + attr_accessor sas_token: String attr_accessor type: :AZURE_BLOB @@ -342,72 +412,108 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, type: :AZURE_BLOB, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type akeneo_pim = { - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, type: :AKENEO_PIM, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor include_canonical_header: bool + attr_accessor client_id: String + + attr_accessor client_secret: String attr_accessor name: String + attr_accessor password: String + attr_accessor type: :AKENEO_PIM + attr_accessor username: String + attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, + username: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, type: :AKENEO_PIM, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } end diff --git a/sig/imagekit/models/accounts/origin_get_response.rbs b/sig/imagekit/models/accounts/origin_get_response.rbs index 68bc3616..a9dd331c 100644 --- a/sig/imagekit/models/accounts/origin_get_response.rbs +++ b/sig/imagekit/models/accounts/origin_get_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginGetResponse::WebFolder | Imagekit::Models::Accounts::OriginGetResponse::WebProxy - | Imagekit::Models::Accounts::OriginGetResponse::Gcs - | Imagekit::Models::Accounts::OriginGetResponse::AzureBlob + | Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs + | Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage | Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim module OriginGetResponse @@ -16,23 +16,25 @@ module Imagekit type s3 = { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :S3, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String + attr_accessor access_key: String - attr_accessor include_canonical_header: bool + attr_accessor bucket: String attr_accessor name: String - attr_accessor prefix: String + attr_accessor secret_key: String attr_accessor type: :S3 @@ -40,54 +42,68 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :S3, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type s3_compatible = { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - :s3_force_path_style => bool, + secret_key: String, type: :S3_COMPATIBLE, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool } class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + attr_accessor bucket: String attr_accessor endpoint: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String - - attr_accessor s3_force_path_style: bool + attr_accessor secret_key: String attr_accessor type: :S3_COMPATIBLE @@ -95,52 +111,72 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - s3_force_path_style: bool, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - :s3_force_path_style => bool, + secret_key: String, type: :S3_COMPATIBLE, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool } end type cloudinary_backup = { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String + attr_accessor access_key: String - attr_accessor include_canonical_header: bool + attr_accessor bucket: String attr_accessor name: String - attr_accessor prefix: String + attr_accessor secret_key: String attr_accessor type: :CLOUDINARY_BACKUP @@ -148,47 +184,57 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type web_folder = { - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, type: :WEB_FOLDER, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor forward_host_header_to_origin: bool - - attr_accessor include_canonical_header: bool - attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -197,41 +243,49 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, + ?id: String, ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, type: :WEB_FOLDER, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool } end type web_proxy = { - id: String, - include_canonical_header: bool, name: String, type: :WEB_PROXY, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor include_canonical_header: bool - attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -240,47 +294,52 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, - include_canonical_header: bool, name: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { - id: String, - include_canonical_header: bool, name: String, type: :WEB_PROXY, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } end - type gcs = + type google_cloud_storage_gcs = { - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, type: :GCS, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String + attr_accessor private_key: String attr_accessor type: :GCS @@ -288,53 +347,64 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, type: :GCS, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end - type azure_blob = + type azure_blob_storage = { - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, type: :AZURE_BLOB, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String + attr_accessor sas_token: String attr_accessor type: :AZURE_BLOB @@ -342,72 +412,108 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, type: :AZURE_BLOB, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type akeneo_pim = { - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, type: :AKENEO_PIM, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor include_canonical_header: bool + attr_accessor client_id: String + + attr_accessor client_secret: String attr_accessor name: String + attr_accessor password: String + attr_accessor type: :AKENEO_PIM + attr_accessor username: String + attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, + username: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, type: :AKENEO_PIM, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } end diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index 6950ef03..c97206db 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup | Imagekit::Models::Accounts::OriginListResponseItem::WebFolder | Imagekit::Models::Accounts::OriginListResponseItem::WebProxy - | Imagekit::Models::Accounts::OriginListResponseItem::Gcs - | Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob + | Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs + | Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage | Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim module OriginListResponseItem @@ -16,23 +16,25 @@ module Imagekit type s3 = { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :S3, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String + attr_accessor access_key: String - attr_accessor include_canonical_header: bool + attr_accessor bucket: String attr_accessor name: String - attr_accessor prefix: String + attr_accessor secret_key: String attr_accessor type: :S3 @@ -40,54 +42,68 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :S3, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type s3_compatible = { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - :s3_force_path_style => bool, + secret_key: String, type: :S3_COMPATIBLE, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool } class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + attr_accessor bucket: String attr_accessor endpoint: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String - - attr_accessor s3_force_path_style: bool + attr_accessor secret_key: String attr_accessor type: :S3_COMPATIBLE @@ -95,52 +111,72 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - s3_force_path_style: bool, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - :s3_force_path_style => bool, + secret_key: String, type: :S3_COMPATIBLE, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool } end type cloudinary_backup = { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String + attr_accessor access_key: String - attr_accessor include_canonical_header: bool + attr_accessor bucket: String attr_accessor name: String - attr_accessor prefix: String + attr_accessor secret_key: String attr_accessor type: :CLOUDINARY_BACKUP @@ -148,47 +184,57 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type web_folder = { - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, type: :WEB_FOLDER, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor forward_host_header_to_origin: bool - - attr_accessor include_canonical_header: bool - attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -197,41 +243,49 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, + ?id: String, ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, type: :WEB_FOLDER, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool } end type web_proxy = { - id: String, - include_canonical_header: bool, name: String, type: :WEB_PROXY, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor include_canonical_header: bool - attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -240,47 +294,52 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, - include_canonical_header: bool, name: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { - id: String, - include_canonical_header: bool, name: String, type: :WEB_PROXY, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } end - type gcs = + type google_cloud_storage_gcs = { - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, type: :GCS, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String + attr_accessor private_key: String attr_accessor type: :GCS @@ -288,53 +347,64 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, type: :GCS, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end - type azure_blob = + type azure_blob_storage = { - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, type: :AZURE_BLOB, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String + attr_accessor sas_token: String attr_accessor type: :AZURE_BLOB @@ -342,72 +412,108 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, type: :AZURE_BLOB, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type akeneo_pim = { - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, type: :AKENEO_PIM, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor include_canonical_header: bool + attr_accessor client_id: String + + attr_accessor client_secret: String attr_accessor name: String + attr_accessor password: String + attr_accessor type: :AKENEO_PIM + attr_accessor username: String + attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, + username: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, type: :AKENEO_PIM, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index d7ef8f51..cb2744ce 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -2,487 +2,15 @@ module Imagekit module Models module Accounts type origin_update_params = - { origin: Imagekit::Models::Accounts::OriginUpdateParams::origin } - & Imagekit::Internal::Type::request_parameters + { } & Imagekit::Internal::Type::request_parameters class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor origin: Imagekit::Models::Accounts::OriginUpdateParams::origin + def initialize: (?request_options: Imagekit::request_opts) -> void - def initialize: ( - origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, - request_options: Imagekit::RequestOptions - } - - type origin = - Imagekit::Accounts::OriginUpdateParams::Origin::S3 - | Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible - | Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup - | Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder - | Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy - | Imagekit::Accounts::OriginUpdateParams::Origin::Gcs - | Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob - | Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - - module Origin - extend Imagekit::Internal::Type::Union - - type s3 = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :S3, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :S3 - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :S3 - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :S3, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type s3_compatible = - { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - :s3_force_path_style => bool - } - - class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor endpoint: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :S3_COMPATIBLE - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - def initialize: ( - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?type: :S3_COMPATIBLE - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - :s3_force_path_style => bool - } - end - - type cloudinary_backup = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :CLOUDINARY_BACKUP - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :CLOUDINARY_BACKUP - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type web_folder = - { - base_url: String, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool - } - - class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor name: String - - attr_accessor type: :WEB_FOLDER - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - base_url: String, - name: String, - ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, - ?type: :WEB_FOLDER - ) -> void - - def to_hash: -> { - base_url: String, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool - } - end - - type web_proxy = - { - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - - class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor name: String - - attr_accessor type: :WEB_PROXY - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - name: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?type: :WEB_PROXY - ) -> void - - def to_hash: -> { - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - end - - type gcs = - { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: :GCS, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class Gcs < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor client_email: String - - attr_accessor name: String - - attr_accessor private_key: String - - attr_accessor type: :GCS - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - bucket: String, - client_email: String, - name: String, - private_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :GCS - ) -> void - - def to_hash: -> { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: :GCS, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type azure_blob = - { - account_name: String, - container: String, - name: String, - sas_token: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class AzureBlob < Imagekit::Internal::Type::BaseModel - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor name: String - - attr_accessor sas_token: String - - attr_accessor type: :AZURE_BLOB - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - account_name: String, - container: String, - name: String, - sas_token: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :AZURE_BLOB - ) -> void - - def to_hash: -> { - account_name: String, - container: String, - name: String, - sas_token: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type akeneo_pim = - { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: :AKENEO_PIM, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor client_id: String - - attr_accessor client_secret: String - - attr_accessor name: String - - attr_accessor password: String - - attr_accessor type: :AKENEO_PIM - - attr_accessor username: String - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?type: :AKENEO_PIM - ) -> void - - def to_hash: -> { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: :AKENEO_PIM, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::OriginUpdateParams::origin] - end + def to_hash: -> { request_options: Imagekit::RequestOptions } end end end diff --git a/sig/imagekit/models/accounts/origin_update_response.rbs b/sig/imagekit/models/accounts/origin_update_response.rbs index 11d8ae94..eea98e03 100644 --- a/sig/imagekit/models/accounts/origin_update_response.rbs +++ b/sig/imagekit/models/accounts/origin_update_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder | Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy - | Imagekit::Models::Accounts::OriginUpdateResponse::Gcs - | Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob + | Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs + | Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage | Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim module OriginUpdateResponse @@ -16,23 +16,25 @@ module Imagekit type s3 = { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :S3, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String + attr_accessor access_key: String - attr_accessor include_canonical_header: bool + attr_accessor bucket: String attr_accessor name: String - attr_accessor prefix: String + attr_accessor secret_key: String attr_accessor type: :S3 @@ -40,54 +42,68 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :S3, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type s3_compatible = { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - :s3_force_path_style => bool, + secret_key: String, type: :S3_COMPATIBLE, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool } class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + attr_accessor bucket: String attr_accessor endpoint: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String - - attr_accessor s3_force_path_style: bool + attr_accessor secret_key: String attr_accessor type: :S3_COMPATIBLE @@ -95,52 +111,72 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - s3_force_path_style: bool, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: bool, name: String, - prefix: String, - :s3_force_path_style => bool, + secret_key: String, type: :S3_COMPATIBLE, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool } end type cloudinary_backup = { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String + attr_accessor access_key: String - attr_accessor include_canonical_header: bool + attr_accessor bucket: String attr_accessor name: String - attr_accessor prefix: String + attr_accessor secret_key: String attr_accessor type: :CLOUDINARY_BACKUP @@ -148,47 +184,57 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - id: String, + access_key: String, bucket: String, - include_canonical_header: bool, name: String, - prefix: String, + secret_key: String, type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type web_folder = { - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, type: :WEB_FOLDER, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor forward_host_header_to_origin: bool - - attr_accessor include_canonical_header: bool - attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -197,41 +243,49 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, + ?id: String, ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { - id: String, base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, name: String, type: :WEB_FOLDER, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool } end type web_proxy = { - id: String, - include_canonical_header: bool, name: String, type: :WEB_PROXY, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor include_canonical_header: bool - attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -240,47 +294,52 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, - include_canonical_header: bool, name: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { - id: String, - include_canonical_header: bool, name: String, type: :WEB_PROXY, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } end - type gcs = + type google_cloud_storage_gcs = { - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, type: :GCS, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } - class Gcs < Imagekit::Internal::Type::BaseModel + class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String + attr_accessor private_key: String attr_accessor type: :GCS @@ -288,53 +347,64 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { - id: String, bucket: String, client_email: String, - include_canonical_header: bool, name: String, - prefix: String, + private_key: String, type: :GCS, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end - type azure_blob = + type azure_blob_storage = { - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, type: :AZURE_BLOB, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlobStorage < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String - attr_accessor include_canonical_header: bool - attr_accessor name: String - attr_accessor prefix: String + attr_accessor sas_token: String attr_accessor type: :AZURE_BLOB @@ -342,72 +412,108 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { - id: String, account_name: String, container: String, - include_canonical_header: bool, name: String, - prefix: String, + sas_token: String, type: :AZURE_BLOB, - base_url_for_canonical_header: String + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String } end type akeneo_pim = { - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, type: :AKENEO_PIM, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor include_canonical_header: bool + attr_accessor client_id: String + + attr_accessor client_secret: String attr_accessor name: String + attr_accessor password: String + attr_accessor type: :AKENEO_PIM + attr_accessor username: String + attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_accessor id: String + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader id: String? + + def id=: (String) -> String def initialize: ( - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, + username: String, + ?id: String, ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { - id: String, base_url: String, - include_canonical_header: bool, + client_id: String, + client_secret: String, name: String, + password: String, type: :AKENEO_PIM, - base_url_for_canonical_header: String + username: String, + id: String, + base_url_for_canonical_header: String, + include_canonical_header: bool } end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index 2503c671..63f7382e 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -3,13 +3,13 @@ module Imagekit class Accounts class Origins def create: ( - origin: Imagekit::Models::Accounts::OriginCreateParams::origin, + origin: Imagekit::Models::Accounts::origin, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_create_response def update: ( String id, - origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, + origin: Imagekit::Models::Accounts::origin, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_update_response diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index 18ed7728..82ef338d 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -28,89 +28,11 @@ def test_create_required_params in Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginCreateResponse::WebFolder in Imagekit::Models::Accounts::OriginCreateResponse::WebProxy - in Imagekit::Models::Accounts::OriginCreateResponse::Gcs - in Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob + in Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs + in Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage in Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim end end - - assert_pattern do - case response - in { - type: :S3, - id: String, - bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :S3_COMPATIBLE, - id: String, - bucket: String, - endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, - base_url_for_canonical_header: String | nil - } - in { - type: :CLOUDINARY_BACKUP, - id: String, - bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :WEB_FOLDER, - id: String, - base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - in { - type: :WEB_PROXY, - id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - in { - type: :GCS, - id: String, - bucket: String, - client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :AZURE_BLOB, - id: String, - account_name: String, - container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :AKENEO_PIM, - id: String, - base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - end - end end def test_update_required_params @@ -139,89 +61,11 @@ def test_update_required_params in Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder in Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy - in Imagekit::Models::Accounts::OriginUpdateResponse::Gcs - in Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob + in Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs + in Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage in Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim end end - - assert_pattern do - case response - in { - type: :S3, - id: String, - bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :S3_COMPATIBLE, - id: String, - bucket: String, - endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, - base_url_for_canonical_header: String | nil - } - in { - type: :CLOUDINARY_BACKUP, - id: String, - bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :WEB_FOLDER, - id: String, - base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - in { - type: :WEB_PROXY, - id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - in { - type: :GCS, - id: String, - bucket: String, - client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :AZURE_BLOB, - id: String, - account_name: String, - container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :AKENEO_PIM, - id: String, - base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - end - end end def test_list @@ -260,88 +104,10 @@ def test_get in Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginGetResponse::WebFolder in Imagekit::Models::Accounts::OriginGetResponse::WebProxy - in Imagekit::Models::Accounts::OriginGetResponse::Gcs - in Imagekit::Models::Accounts::OriginGetResponse::AzureBlob + in Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs + in Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage in Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim end end - - assert_pattern do - case response - in { - type: :S3, - id: String, - bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :S3_COMPATIBLE, - id: String, - bucket: String, - endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, - base_url_for_canonical_header: String | nil - } - in { - type: :CLOUDINARY_BACKUP, - id: String, - bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :WEB_FOLDER, - id: String, - base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - in { - type: :WEB_PROXY, - id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - in { - type: :GCS, - id: String, - bucket: String, - client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :AZURE_BLOB, - id: String, - account_name: String, - container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String | nil - } - in { - type: :AKENEO_PIM, - id: String, - base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, - name: String, - base_url_for_canonical_header: String | nil - } - end - end end end From dc0e5097e3bc7337169404af82ad0ba7f4ad5184 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 03:31:07 +0000 Subject: [PATCH 044/178] feat(api): manual updates --- .stats.yml | 6 +- .../models/accounts/origin_create_response.rb | 458 +++++++--------- .../models/accounts/origin_get_response.rb | 457 +++++++--------- .../models/accounts/origin_list_response.rb | 460 +++++++--------- .../models/accounts/origin_update_response.rb | 458 +++++++--------- lib/imagekit/resources/accounts/origins.rb | 8 +- .../accounts/origin_create_response.rbi | 510 +++++++----------- .../models/accounts/origin_get_response.rbi | 510 +++++++----------- .../models/accounts/origin_list_response.rbi | 510 +++++++----------- .../accounts/origin_update_response.rbi | 510 +++++++----------- .../accounts/origin_create_response.rbs | 352 +++++------- .../models/accounts/origin_get_response.rbs | 352 +++++------- .../models/accounts/origin_list_response.rbs | 352 +++++------- .../accounts/origin_update_response.rbs | 352 +++++------- .../resources/accounts/origins_test.rb | 246 ++++++++- 15 files changed, 2324 insertions(+), 3217 deletions(-) diff --git a/.stats.yml b/.stats.yml index 53bd25d3..5afb8fd9 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-d65a790786704dc315c1fded8ee24d61a55d96054fbbf1e6da429ec96b3e0c88.yml -openapi_spec_hash: 0fa9ee90455e183ec3b5d4e36f1351a9 -config_hash: 89ffae9ef2878c981a64f42cadb85186 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml +openapi_spec_hash: 98642308bee81ac776b7b1843089b888 +config_hash: ddd6954a6e35eb1a97e5d0cda8209e62 diff --git a/lib/imagekit/models/accounts/origin_create_response.rb b/lib/imagekit/models/accounts/origin_create_response.rb index d1d545fb..01e0c545 100644 --- a/lib/imagekit/models/accounts/origin_create_response.rb +++ b/lib/imagekit/models/accounts/origin_create_response.rb @@ -3,50 +3,56 @@ module Imagekit module Models module Accounts + # Origin object as returned by the API (sensitive fields removed). + # # @see Imagekit::Resources::Accounts::Origins#create module OriginCreateResponse extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::S3 } + discriminator :type - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible } + variant :S3, -> { Imagekit::Models::Accounts::OriginCreateResponse::S3 } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage } + variant :GCS, -> { Imagekit::Models::Accounts::OriginCreateResponse::Gcs } - variant -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob } - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey + variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim } + class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String # @!attribute type # @@ -59,54 +65,35 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::S3} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # @@ -119,17 +106,31 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle # @!attribute type # @@ -142,81 +143,65 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param id [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String # @!attribute type # @@ -229,44 +214,32 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -277,6 +250,22 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -294,46 +283,43 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::WebFolder} for more details. # - # @param id [String] + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -351,34 +337,31 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) - # @param name [String] Display name of the origin. + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::WebProxy} for more details. # - # @param id [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -389,16 +372,24 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute private_key + # @!attribute prefix # # @return [String] - required :private_key, String, api_name: :privateKey + required :prefix, String # @!attribute type # @@ -411,47 +402,37 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::Gcs} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param bucket [String] # # @param client_email [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param private_key [String] + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -462,16 +443,24 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute sas_token + # @!attribute prefix # # @return [String] - required :sas_token, String, api_name: :sasToken + required :prefix, String # @!attribute type # @@ -484,43 +473,33 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param account_name [String] # # @param container [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param sas_token [String] + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :AZURE_BLOB] end @@ -531,17 +510,13 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. + # @!attribute include_canonical_header + # Whether to send a Canonical header. # - # @return [String] - required :client_secret, String, api_name: :clientSecret + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader # @!attribute name # Display name of the origin. @@ -549,68 +524,45 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) - # @param base_url [String] Akeneo instance base URL. - # - # @param client_id [String] Akeneo API client ID. + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim} for more details. # - # @param client_secret [String] Akeneo API client secret. + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param name [String] Display name of the origin. - # - # @param password [String] Akeneo API password. + # @param base_url [String] Akeneo instance base URL. # - # @param username [String] Akeneo API username. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param id [String] + # @param name [String] Display name of the origin. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_get_response.rb b/lib/imagekit/models/accounts/origin_get_response.rb index 2a88f014..f2faf7ad 100644 --- a/lib/imagekit/models/accounts/origin_get_response.rb +++ b/lib/imagekit/models/accounts/origin_get_response.rb @@ -3,50 +3,56 @@ module Imagekit module Models module Accounts + # Origin object as returned by the API (sensitive fields removed). + # # @see Imagekit::Resources::Accounts::Origins#get module OriginGetResponse extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::OriginGetResponse::S3 } + discriminator :type - variant -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible } + variant :S3, -> { Imagekit::Models::Accounts::OriginGetResponse::S3 } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage } + variant :GCS, -> { Imagekit::Models::Accounts::OriginGetResponse::Gcs } - variant -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlob } - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey + variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim } + class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String # @!attribute type # @@ -59,54 +65,35 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::S3} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # @@ -119,17 +106,31 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle # @!attribute type # @@ -142,81 +143,64 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::S3Compatible} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param id [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String # @!attribute type # @@ -229,44 +213,32 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -277,6 +249,22 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -294,46 +282,43 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::WebFolder} for more details. # - # @param id [String] + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -351,34 +336,31 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) - # @param name [String] Display name of the origin. + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::WebProxy} for more details. # - # @param id [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -389,16 +371,24 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute private_key + # @!attribute prefix # # @return [String] - required :private_key, String, api_name: :privateKey + required :prefix, String # @!attribute type # @@ -411,47 +401,37 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::Gcs} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param bucket [String] # # @param client_email [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param private_key [String] + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -462,16 +442,24 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute sas_token + # @!attribute prefix # # @return [String] - required :sas_token, String, api_name: :sasToken + required :prefix, String # @!attribute type # @@ -484,43 +472,33 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::AzureBlob} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param account_name [String] # # @param container [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param sas_token [String] + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :AZURE_BLOB] end @@ -531,17 +509,13 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. + # @!attribute include_canonical_header + # Whether to send a Canonical header. # - # @return [String] - required :client_secret, String, api_name: :clientSecret + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader # @!attribute name # Display name of the origin. @@ -549,68 +523,45 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) - # @param base_url [String] Akeneo instance base URL. - # - # @param client_id [String] Akeneo API client ID. + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim} for more details. # - # @param client_secret [String] Akeneo API client secret. + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param name [String] Display name of the origin. - # - # @param password [String] Akeneo API password. + # @param base_url [String] Akeneo instance base URL. # - # @param username [String] Akeneo API username. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param id [String] + # @param name [String] Display name of the origin. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index 3ca97e86..104d6194 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -3,49 +3,54 @@ module Imagekit module Models module Accounts + # Origin object as returned by the API (sensitive fields removed). module OriginListResponseItem extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::S3 } + discriminator :type - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible } + variant :S3, -> { Imagekit::Models::Accounts::OriginListResponseItem::S3 } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage } + variant :GCS, -> { Imagekit::Models::Accounts::OriginListResponseItem::Gcs } - variant -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob } - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey + variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim } + class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String # @!attribute type # @@ -58,54 +63,35 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::S3} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # @@ -118,17 +104,31 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle # @!attribute type # @@ -141,81 +141,65 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param id [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String # @!attribute type # @@ -228,44 +212,32 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -276,6 +248,22 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -293,46 +281,44 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::WebFolder} for more + # details. # - # @param id [String] + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -350,34 +336,31 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) - # @param name [String] Display name of the origin. + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::WebProxy} for more details. # - # @param id [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -388,16 +371,24 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute private_key + # @!attribute prefix # # @return [String] - required :private_key, String, api_name: :privateKey + required :prefix, String # @!attribute type # @@ -410,47 +401,37 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::Gcs} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param bucket [String] # # @param client_email [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param private_key [String] + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -461,16 +442,24 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute sas_token + # @!attribute prefix # # @return [String] - required :sas_token, String, api_name: :sasToken + required :prefix, String # @!attribute type # @@ -483,43 +472,34 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param account_name [String] # # @param container [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param sas_token [String] + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :AZURE_BLOB] end @@ -530,17 +510,13 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. + # @!attribute include_canonical_header + # Whether to send a Canonical header. # - # @return [String] - required :client_secret, String, api_name: :clientSecret + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader # @!attribute name # Display name of the origin. @@ -548,68 +524,46 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) - # @param base_url [String] Akeneo instance base URL. - # - # @param client_id [String] Akeneo API client ID. + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim} for more + # details. # - # @param client_secret [String] Akeneo API client secret. + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param name [String] Display name of the origin. - # - # @param password [String] Akeneo API password. + # @param base_url [String] Akeneo instance base URL. # - # @param username [String] Akeneo API username. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param id [String] + # @param name [String] Display name of the origin. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginListResponseItem::S3, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginListResponseItem::S3, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, Imagekit::Models::Accounts::OriginListResponseItem::Gcs, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim)] end # @type [Imagekit::Internal::Type::Converter] diff --git a/lib/imagekit/models/accounts/origin_update_response.rb b/lib/imagekit/models/accounts/origin_update_response.rb index 39319937..eae3c9c5 100644 --- a/lib/imagekit/models/accounts/origin_update_response.rb +++ b/lib/imagekit/models/accounts/origin_update_response.rb @@ -3,50 +3,56 @@ module Imagekit module Models module Accounts + # Origin object as returned by the API (sensitive fields removed). + # # @see Imagekit::Resources::Accounts::Origins#update module OriginUpdateResponse extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3 } + discriminator :type - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible } + variant :S3, -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3 } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup } + variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy } + variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs } + variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage } + variant :GCS, -> { Imagekit::Models::Accounts::OriginUpdateResponse::Gcs } - variant -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim } + variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob } - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey + variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim } + class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String # @!attribute type # @@ -59,54 +65,35 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::S3} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :S3] end class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # @@ -119,17 +106,31 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle # @!attribute type # @@ -142,81 +143,65 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param id [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :S3_COMPATIBLE] end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. + # @!attribute prefix + # Path prefix inside the bucket. # # @return [String] - required :secret_key, String, api_name: :secretKey + required :prefix, String # @!attribute type # @@ -229,44 +214,32 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) - # @param access_key [String] Access key for the bucket. + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup} for more + # details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -277,6 +250,22 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -294,46 +283,43 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder} for more details. # - # @param id [String] + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -351,34 +337,31 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) - # @param name [String] Display name of the origin. + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy} for more details. # - # @param id [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_PROXY] end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -389,16 +372,24 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute private_key + # @!attribute prefix # # @return [String] - required :private_key, String, api_name: :privateKey + required :prefix, String # @!attribute type # @@ -411,47 +402,37 @@ class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::Gcs} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param bucket [String] # # @param client_email [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param private_key [String] + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :GCS] end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -462,16 +443,24 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute sas_token + # @!attribute prefix # # @return [String] - required :sas_token, String, api_name: :sasToken + required :prefix, String # @!attribute type # @@ -484,43 +473,33 @@ class AzureBlobStorage < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param account_name [String] # # @param container [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param sas_token [String] + # @param name [String] Display name of the origin. # - # @param id [String] + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :AZURE_BLOB] end @@ -531,17 +510,13 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. + # @!attribute include_canonical_header + # Whether to send a Canonical header. # - # @return [String] - required :client_secret, String, api_name: :clientSecret + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader # @!attribute name # Display name of the origin. @@ -549,68 +524,45 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) - # @param base_url [String] Akeneo instance base URL. - # - # @param client_id [String] Akeneo API client ID. + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim} for more details. # - # @param client_secret [String] Akeneo API client secret. + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param name [String] Display name of the origin. - # - # @param password [String] Akeneo API password. + # @param base_url [String] Akeneo instance base URL. # - # @param username [String] Akeneo API username. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param id [String] + # @param name [String] Display name of the origin. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index aa7d70e3..4fae97c0 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -13,7 +13,7 @@ class Origins # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginCreateParams def create(params) @@ -41,7 +41,7 @@ def create(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginUpdateParams def update(id, params) @@ -62,7 +62,7 @@ def update(id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::Accounts::OriginListParams def list(params = {}) @@ -111,7 +111,7 @@ def delete(id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginGetParams def get(id, params = {}) diff --git a/rbi/imagekit/models/accounts/origin_create_response.rbi b/rbi/imagekit/models/accounts/origin_create_response.rbi index 9d66a376..dc8ab505 100644 --- a/rbi/imagekit/models/accounts/origin_create_response.rbi +++ b/rbi/imagekit/models/accounts/origin_create_response.rbi @@ -3,6 +3,7 @@ module Imagekit module Models module Accounts + # Origin object as returned by the API (sensitive fields removed). module OriginCreateResponse extend Imagekit::Internal::Type::Union @@ -14,8 +15,8 @@ module Imagekit Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginCreateResponse::Gcs, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim ) end @@ -29,21 +30,21 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -55,55 +56,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :S3 ) end @@ -111,15 +93,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -136,10 +116,6 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -148,13 +124,21 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style sig { returns(Symbol) } attr_accessor :type @@ -166,68 +150,42 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, s3_force_path_style: T::Boolean, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, # Path prefix inside the bucket. - prefix: nil, + prefix:, # Use path-style S3 URLs? - s3_force_path_style: nil, + s3_force_path_style:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, type: :S3_COMPATIBLE ) end @@ -235,17 +193,15 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: Symbol, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, - s3_force_path_style: T::Boolean + s3_force_path_style: T::Boolean, + type: Symbol, + base_url_for_canonical_header: String } ) end @@ -262,21 +218,21 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -288,55 +244,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -344,15 +281,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -373,6 +308,14 @@ module Imagekit sig { returns(String) } attr_accessor :base_url + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -387,49 +330,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - base_url: String, - name: String, id: String, - base_url_for_canonical_header: String, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Root URL for the web folder origin. base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -437,13 +367,13 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -460,6 +390,10 @@ module Imagekit ) end + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -474,36 +408,30 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - name: String, id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_PROXY ) end @@ -511,11 +439,11 @@ module Imagekit sig do override.returns( { + id: String, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -523,11 +451,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Internal::AnyHash ) end @@ -538,12 +466,16 @@ module Imagekit sig { returns(String) } attr_accessor :client_email + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :private_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -555,50 +487,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, bucket: String, client_email: String, - name: String, - private_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, bucket:, client_email:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - private_key:, - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :GCS ) end @@ -606,15 +524,14 @@ module Imagekit sig do override.returns( { + id: String, bucket: String, client_email: String, + include_canonical_header: T::Boolean, name: String, - private_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -622,11 +539,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Internal::AnyHash ) end @@ -637,12 +554,16 @@ module Imagekit sig { returns(String) } attr_accessor :container + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :sas_token + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -654,50 +575,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, account_name: String, container: String, - name: String, - sas_token: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, account_name:, container:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - sas_token:, - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :AZURE_BLOB ) end @@ -705,15 +612,14 @@ module Imagekit sig do override.returns( { + id: String, account_name: String, container: String, + include_canonical_header: T::Boolean, name: String, - sas_token: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -734,29 +640,17 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header # Display name of the origin. sig { returns(String) } attr_accessor :name - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - sig { returns(Symbol) } attr_accessor :type - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -764,51 +658,33 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, - username: String, - id: String, base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Akeneo instance base URL. base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -816,16 +692,12 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, type: Symbol, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end diff --git a/rbi/imagekit/models/accounts/origin_get_response.rbi b/rbi/imagekit/models/accounts/origin_get_response.rbi index 26982ea5..acbc7270 100644 --- a/rbi/imagekit/models/accounts/origin_get_response.rbi +++ b/rbi/imagekit/models/accounts/origin_get_response.rbi @@ -3,6 +3,7 @@ module Imagekit module Models module Accounts + # Origin object as returned by the API (sensitive fields removed). module OriginGetResponse extend Imagekit::Internal::Type::Union @@ -14,8 +15,8 @@ module Imagekit Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginGetResponse::Gcs, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim ) end @@ -29,21 +30,21 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -55,55 +56,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :S3 ) end @@ -111,15 +93,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -136,10 +116,6 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -148,13 +124,21 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style sig { returns(Symbol) } attr_accessor :type @@ -166,68 +150,42 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, s3_force_path_style: T::Boolean, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, # Path prefix inside the bucket. - prefix: nil, + prefix:, # Use path-style S3 URLs? - s3_force_path_style: nil, + s3_force_path_style:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, type: :S3_COMPATIBLE ) end @@ -235,17 +193,15 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: Symbol, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, - s3_force_path_style: T::Boolean + s3_force_path_style: T::Boolean, + type: Symbol, + base_url_for_canonical_header: String } ) end @@ -262,21 +218,21 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -288,55 +244,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -344,15 +281,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -373,6 +308,14 @@ module Imagekit sig { returns(String) } attr_accessor :base_url + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -387,49 +330,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - base_url: String, - name: String, id: String, - base_url_for_canonical_header: String, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Root URL for the web folder origin. base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -437,13 +367,13 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -460,6 +390,10 @@ module Imagekit ) end + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -474,36 +408,30 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - name: String, id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_PROXY ) end @@ -511,11 +439,11 @@ module Imagekit sig do override.returns( { + id: String, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -523,11 +451,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Internal::AnyHash ) end @@ -538,12 +466,16 @@ module Imagekit sig { returns(String) } attr_accessor :client_email + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :private_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -555,50 +487,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, bucket: String, client_email: String, - name: String, - private_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, bucket:, client_email:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - private_key:, - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :GCS ) end @@ -606,15 +524,14 @@ module Imagekit sig do override.returns( { + id: String, bucket: String, client_email: String, + include_canonical_header: T::Boolean, name: String, - private_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -622,11 +539,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Internal::AnyHash ) end @@ -637,12 +554,16 @@ module Imagekit sig { returns(String) } attr_accessor :container + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :sas_token + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -654,50 +575,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, account_name: String, container: String, - name: String, - sas_token: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, account_name:, container:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - sas_token:, - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :AZURE_BLOB ) end @@ -705,15 +612,14 @@ module Imagekit sig do override.returns( { + id: String, account_name: String, container: String, + include_canonical_header: T::Boolean, name: String, - sas_token: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -734,29 +640,17 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header # Display name of the origin. sig { returns(String) } attr_accessor :name - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - sig { returns(Symbol) } attr_accessor :type - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -764,51 +658,33 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, - username: String, - id: String, base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Akeneo instance base URL. base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -816,16 +692,12 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, type: Symbol, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index b0f10a3a..26f5914e 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -3,6 +3,7 @@ module Imagekit module Models module Accounts + # Origin object as returned by the API (sensitive fields removed). module OriginListResponseItem extend Imagekit::Internal::Type::Union @@ -14,8 +15,8 @@ module Imagekit Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, + Imagekit::Models::Accounts::OriginListResponseItem::Gcs, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim ) end @@ -29,21 +30,21 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -55,55 +56,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :S3 ) end @@ -111,15 +93,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -136,10 +116,6 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -148,13 +124,21 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style sig { returns(Symbol) } attr_accessor :type @@ -166,68 +150,42 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, s3_force_path_style: T::Boolean, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, # Path prefix inside the bucket. - prefix: nil, + prefix:, # Use path-style S3 URLs? - s3_force_path_style: nil, + s3_force_path_style:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, type: :S3_COMPATIBLE ) end @@ -235,17 +193,15 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: Symbol, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, - s3_force_path_style: T::Boolean + s3_force_path_style: T::Boolean, + type: Symbol, + base_url_for_canonical_header: String } ) end @@ -262,21 +218,21 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -288,55 +244,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -344,15 +281,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -373,6 +308,14 @@ module Imagekit sig { returns(String) } attr_accessor :base_url + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -387,49 +330,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - base_url: String, - name: String, id: String, - base_url_for_canonical_header: String, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Root URL for the web folder origin. base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -437,13 +367,13 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -460,6 +390,10 @@ module Imagekit ) end + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -474,36 +408,30 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - name: String, id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_PROXY ) end @@ -511,11 +439,11 @@ module Imagekit sig do override.returns( { + id: String, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -523,11 +451,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginListResponseItem::Gcs, Imagekit::Internal::AnyHash ) end @@ -538,12 +466,16 @@ module Imagekit sig { returns(String) } attr_accessor :client_email + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :private_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -555,50 +487,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, bucket: String, client_email: String, - name: String, - private_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, bucket:, client_email:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - private_key:, - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :GCS ) end @@ -606,15 +524,14 @@ module Imagekit sig do override.returns( { + id: String, bucket: String, client_email: String, + include_canonical_header: T::Boolean, name: String, - private_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -622,11 +539,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage, + Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, Imagekit::Internal::AnyHash ) end @@ -637,12 +554,16 @@ module Imagekit sig { returns(String) } attr_accessor :container + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :sas_token + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -654,50 +575,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, account_name: String, container: String, - name: String, - sas_token: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, account_name:, container:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - sas_token:, - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :AZURE_BLOB ) end @@ -705,15 +612,14 @@ module Imagekit sig do override.returns( { + id: String, account_name: String, container: String, + include_canonical_header: T::Boolean, name: String, - sas_token: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -734,29 +640,17 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header # Display name of the origin. sig { returns(String) } attr_accessor :name - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - sig { returns(Symbol) } attr_accessor :type - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -764,51 +658,33 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, - username: String, - id: String, base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Akeneo instance base URL. base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -816,16 +692,12 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, type: Symbol, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end diff --git a/rbi/imagekit/models/accounts/origin_update_response.rbi b/rbi/imagekit/models/accounts/origin_update_response.rbi index 3cf16b43..6d07d92c 100644 --- a/rbi/imagekit/models/accounts/origin_update_response.rbi +++ b/rbi/imagekit/models/accounts/origin_update_response.rbi @@ -3,6 +3,7 @@ module Imagekit module Models module Accounts + # Origin object as returned by the API (sensitive fields removed). module OriginUpdateResponse extend Imagekit::Internal::Type::Union @@ -14,8 +15,8 @@ module Imagekit Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim ) end @@ -29,21 +30,21 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -55,55 +56,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :S3 ) end @@ -111,15 +93,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -136,10 +116,6 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -148,13 +124,21 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style sig { returns(Symbol) } attr_accessor :type @@ -166,68 +150,42 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, s3_force_path_style: T::Boolean, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, # Path prefix inside the bucket. - prefix: nil, + prefix:, # Use path-style S3 URLs? - s3_force_path_style: nil, + s3_force_path_style:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, type: :S3_COMPATIBLE ) end @@ -235,17 +193,15 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: Symbol, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, - s3_force_path_style: T::Boolean + s3_force_path_style: T::Boolean, + type: Symbol, + base_url_for_canonical_header: String } ) end @@ -262,21 +218,21 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name - # Secret key for the bucket. + # Path prefix inside the bucket. sig { returns(String) } - attr_accessor :secret_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -288,55 +244,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -344,15 +281,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -373,6 +308,14 @@ module Imagekit sig { returns(String) } attr_accessor :base_url + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -387,49 +330,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - base_url: String, - name: String, id: String, - base_url_for_canonical_header: String, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Root URL for the web folder origin. base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -437,13 +367,13 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -460,6 +390,10 @@ module Imagekit ) end + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -474,36 +408,30 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( - name: String, id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_PROXY ) end @@ -511,11 +439,11 @@ module Imagekit sig do override.returns( { + id: String, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -523,11 +451,11 @@ module Imagekit end end - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs, + Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Internal::AnyHash ) end @@ -538,12 +466,16 @@ module Imagekit sig { returns(String) } attr_accessor :client_email + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :private_key + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -555,50 +487,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, bucket: String, client_email: String, - name: String, - private_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, bucket:, client_email:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - private_key:, - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :GCS ) end @@ -606,15 +524,14 @@ module Imagekit sig do override.returns( { + id: String, bucket: String, client_email: String, + include_canonical_header: T::Boolean, name: String, - private_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -622,11 +539,11 @@ module Imagekit end end - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage, + Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Internal::AnyHash ) end @@ -637,12 +554,16 @@ module Imagekit sig { returns(String) } attr_accessor :container + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name sig { returns(String) } - attr_accessor :sas_token + attr_accessor :prefix sig { returns(Symbol) } attr_accessor :type @@ -654,50 +575,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, account_name: String, container: String, - name: String, - sas_token: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, account_name:, container:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - sas_token:, - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :AZURE_BLOB ) end @@ -705,15 +612,14 @@ module Imagekit sig do override.returns( { + id: String, account_name: String, container: String, + include_canonical_header: T::Boolean, name: String, - sas_token: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -734,29 +640,17 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header # Display name of the origin. sig { returns(String) } attr_accessor :name - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - sig { returns(Symbol) } attr_accessor :type - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -764,51 +658,33 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(String) } + attr_accessor :id sig do params( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, - username: String, - id: String, base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Akeneo instance base URL. base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -816,16 +692,12 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, type: Symbol, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end diff --git a/sig/imagekit/models/accounts/origin_create_response.rbs b/sig/imagekit/models/accounts/origin_create_response.rbs index 8d98ddf3..0d71ff69 100644 --- a/sig/imagekit/models/accounts/origin_create_response.rbs +++ b/sig/imagekit/models/accounts/origin_create_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginCreateResponse::WebFolder | Imagekit::Models::Accounts::OriginCreateResponse::WebProxy - | Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs - | Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginCreateResponse::Gcs + | Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob | Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim module OriginCreateResponse @@ -16,25 +16,23 @@ module Imagekit type s3 = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String attr_accessor type: :S3 @@ -42,68 +40,54 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type s3_compatible = { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String attr_accessor endpoint: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String + + attr_accessor s3_force_path_style: bool attr_accessor type: :S3_COMPATIBLE @@ -111,72 +95,52 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, endpoint: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, + s3_force_path_style: bool, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } end type cloudinary_backup = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String attr_accessor type: :CLOUDINARY_BACKUP @@ -184,57 +148,47 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type web_folder = { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -243,49 +197,41 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } end type web_proxy = { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -294,52 +240,47 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end - type google_cloud_storage_gcs = + type gcs = { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor private_key: String + attr_accessor prefix: String attr_accessor type: :GCS @@ -347,64 +288,53 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end - type azure_blob_storage = + type azure_blob = { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor sas_token: String + attr_accessor prefix: String attr_accessor type: :AZURE_BLOB @@ -412,108 +342,72 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type akeneo_pim = { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor client_id: String - - attr_accessor client_secret: String + attr_accessor include_canonical_header: bool attr_accessor name: String - attr_accessor password: String - attr_accessor type: :AKENEO_PIM - attr_accessor username: String - attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, - username: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end diff --git a/sig/imagekit/models/accounts/origin_get_response.rbs b/sig/imagekit/models/accounts/origin_get_response.rbs index a9dd331c..68bc3616 100644 --- a/sig/imagekit/models/accounts/origin_get_response.rbs +++ b/sig/imagekit/models/accounts/origin_get_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginGetResponse::WebFolder | Imagekit::Models::Accounts::OriginGetResponse::WebProxy - | Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs - | Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginGetResponse::Gcs + | Imagekit::Models::Accounts::OriginGetResponse::AzureBlob | Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim module OriginGetResponse @@ -16,25 +16,23 @@ module Imagekit type s3 = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String attr_accessor type: :S3 @@ -42,68 +40,54 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type s3_compatible = { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String attr_accessor endpoint: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String + + attr_accessor s3_force_path_style: bool attr_accessor type: :S3_COMPATIBLE @@ -111,72 +95,52 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, endpoint: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, + s3_force_path_style: bool, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } end type cloudinary_backup = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String attr_accessor type: :CLOUDINARY_BACKUP @@ -184,57 +148,47 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type web_folder = { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -243,49 +197,41 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } end type web_proxy = { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -294,52 +240,47 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end - type google_cloud_storage_gcs = + type gcs = { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor private_key: String + attr_accessor prefix: String attr_accessor type: :GCS @@ -347,64 +288,53 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end - type azure_blob_storage = + type azure_blob = { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor sas_token: String + attr_accessor prefix: String attr_accessor type: :AZURE_BLOB @@ -412,108 +342,72 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type akeneo_pim = { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor client_id: String - - attr_accessor client_secret: String + attr_accessor include_canonical_header: bool attr_accessor name: String - attr_accessor password: String - attr_accessor type: :AKENEO_PIM - attr_accessor username: String - attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, - username: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index c97206db..6950ef03 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup | Imagekit::Models::Accounts::OriginListResponseItem::WebFolder | Imagekit::Models::Accounts::OriginListResponseItem::WebProxy - | Imagekit::Models::Accounts::OriginListResponseItem::GoogleCloudStorageGcs - | Imagekit::Models::Accounts::OriginListResponseItem::AzureBlobStorage + | Imagekit::Models::Accounts::OriginListResponseItem::Gcs + | Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob | Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim module OriginListResponseItem @@ -16,25 +16,23 @@ module Imagekit type s3 = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String attr_accessor type: :S3 @@ -42,68 +40,54 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type s3_compatible = { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String attr_accessor endpoint: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String + + attr_accessor s3_force_path_style: bool attr_accessor type: :S3_COMPATIBLE @@ -111,72 +95,52 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, endpoint: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, + s3_force_path_style: bool, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } end type cloudinary_backup = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String attr_accessor type: :CLOUDINARY_BACKUP @@ -184,57 +148,47 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type web_folder = { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -243,49 +197,41 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } end type web_proxy = { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -294,52 +240,47 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end - type google_cloud_storage_gcs = + type gcs = { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor private_key: String + attr_accessor prefix: String attr_accessor type: :GCS @@ -347,64 +288,53 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end - type azure_blob_storage = + type azure_blob = { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor sas_token: String + attr_accessor prefix: String attr_accessor type: :AZURE_BLOB @@ -412,108 +342,72 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type akeneo_pim = { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor client_id: String - - attr_accessor client_secret: String + attr_accessor include_canonical_header: bool attr_accessor name: String - attr_accessor password: String - attr_accessor type: :AKENEO_PIM - attr_accessor username: String - attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, - username: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end diff --git a/sig/imagekit/models/accounts/origin_update_response.rbs b/sig/imagekit/models/accounts/origin_update_response.rbs index eea98e03..11d8ae94 100644 --- a/sig/imagekit/models/accounts/origin_update_response.rbs +++ b/sig/imagekit/models/accounts/origin_update_response.rbs @@ -7,8 +7,8 @@ module Imagekit | Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup | Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder | Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy - | Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs - | Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage + | Imagekit::Models::Accounts::OriginUpdateResponse::Gcs + | Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob | Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim module OriginUpdateResponse @@ -16,25 +16,23 @@ module Imagekit type s3 = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String attr_accessor type: :S3 @@ -42,68 +40,54 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type s3_compatible = { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String attr_accessor endpoint: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String + + attr_accessor s3_force_path_style: bool attr_accessor type: :S3_COMPATIBLE @@ -111,72 +95,52 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, endpoint: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, + s3_force_path_style: bool, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } end type cloudinary_backup = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor secret_key: String + attr_accessor prefix: String attr_accessor type: :CLOUDINARY_BACKUP @@ -184,57 +148,47 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type web_folder = { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -243,49 +197,41 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } end type web_proxy = { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -294,52 +240,47 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end - type google_cloud_storage_gcs = + type gcs = { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } - class GoogleCloudStorageGcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor private_key: String + attr_accessor prefix: String attr_accessor type: :GCS @@ -347,64 +288,53 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end - type azure_blob_storage = + type azure_blob = { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } - class AzureBlobStorage < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekit::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String + attr_accessor include_canonical_header: bool + attr_accessor name: String - attr_accessor sas_token: String + attr_accessor prefix: String attr_accessor type: :AZURE_BLOB @@ -412,108 +342,72 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type akeneo_pim = { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor client_id: String - - attr_accessor client_secret: String + attr_accessor include_canonical_header: bool attr_accessor name: String - attr_accessor password: String - attr_accessor type: :AKENEO_PIM - attr_accessor username: String - attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, - username: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index 82ef338d..18ed7728 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -28,11 +28,89 @@ def test_create_required_params in Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginCreateResponse::WebFolder in Imagekit::Models::Accounts::OriginCreateResponse::WebProxy - in Imagekit::Models::Accounts::OriginCreateResponse::GoogleCloudStorageGcs - in Imagekit::Models::Accounts::OriginCreateResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginCreateResponse::Gcs + in Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob in Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim end end + + assert_pattern do + case response + in { + type: :S3, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :S3_COMPATIBLE, + id: String, + bucket: String, + endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil + } + in { + type: :CLOUDINARY_BACKUP, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_FOLDER, + id: String, + base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :GCS, + id: String, + bucket: String, + client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AZURE_BLOB, + id: String, + account_name: String, + container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AKENEO_PIM, + id: String, + base_url: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + end + end end def test_update_required_params @@ -61,11 +139,89 @@ def test_update_required_params in Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder in Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy - in Imagekit::Models::Accounts::OriginUpdateResponse::GoogleCloudStorageGcs - in Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginUpdateResponse::Gcs + in Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob in Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim end end + + assert_pattern do + case response + in { + type: :S3, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :S3_COMPATIBLE, + id: String, + bucket: String, + endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil + } + in { + type: :CLOUDINARY_BACKUP, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_FOLDER, + id: String, + base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :GCS, + id: String, + bucket: String, + client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AZURE_BLOB, + id: String, + account_name: String, + container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AKENEO_PIM, + id: String, + base_url: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + end + end end def test_list @@ -104,10 +260,88 @@ def test_get in Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup in Imagekit::Models::Accounts::OriginGetResponse::WebFolder in Imagekit::Models::Accounts::OriginGetResponse::WebProxy - in Imagekit::Models::Accounts::OriginGetResponse::GoogleCloudStorageGcs - in Imagekit::Models::Accounts::OriginGetResponse::AzureBlobStorage + in Imagekit::Models::Accounts::OriginGetResponse::Gcs + in Imagekit::Models::Accounts::OriginGetResponse::AzureBlob in Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim end end + + assert_pattern do + case response + in { + type: :S3, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :S3_COMPATIBLE, + id: String, + bucket: String, + endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil + } + in { + type: :CLOUDINARY_BACKUP, + id: String, + bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_FOLDER, + id: String, + base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + in { + type: :GCS, + id: String, + bucket: String, + client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AZURE_BLOB, + id: String, + account_name: String, + container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + prefix: String, + base_url_for_canonical_header: String | nil + } + in { + type: :AKENEO_PIM, + id: String, + base_url: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, + name: String, + base_url_for_canonical_header: String | nil + } + end + end end end From 95d895a76e81a244cb9d9192a64c561185e75c98 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 05:49:34 +0000 Subject: [PATCH 045/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 1 + lib/imagekit/models/accounts/url_endpoint.rb | 112 +++++++++ .../accounts/url_endpoint_create_params.rb | 100 +------- .../accounts/url_endpoint_update_params.rb | 100 +------- .../resources/accounts/url_endpoints.rb | 4 +- rbi/imagekit/models/accounts/url_endpoint.rbi | 213 ++++++++++++++++++ .../accounts/url_endpoint_create_params.rbi | 201 +---------------- .../accounts/url_endpoint_update_params.rbi | 201 +---------------- .../resources/accounts/url_endpoints.rbi | 12 +- sig/imagekit/models/accounts/url_endpoint.rbs | 97 ++++++++ .../accounts/url_endpoint_create_params.rbs | 94 +------- .../accounts/url_endpoint_update_params.rbs | 94 +------- .../resources/accounts/url_endpoints.rbs | 4 +- 14 files changed, 456 insertions(+), 779 deletions(-) create mode 100644 lib/imagekit/models/accounts/url_endpoint.rb create mode 100644 rbi/imagekit/models/accounts/url_endpoint.rbi create mode 100644 sig/imagekit/models/accounts/url_endpoint.rbs diff --git a/.stats.yml b/.stats.yml index 5afb8fd9..49325e6c 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-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml openapi_spec_hash: 98642308bee81ac776b7b1843089b888 -config_hash: ddd6954a6e35eb1a97e5d0cda8209e62 +config_hash: 49e367d7f33aeaf63ed738c1c0392d0a diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 358728d1..74e07860 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -51,6 +51,7 @@ require_relative "imagekit/internal/transport/pooled_net_requester" require_relative "imagekit/client" require_relative "imagekit/models/accounts/origin" +require_relative "imagekit/models/accounts/url_endpoint" require_relative "imagekit/models/file" require_relative "imagekit/models/accounts/origin_create_params" require_relative "imagekit/models/accounts/origin_create_response" diff --git a/lib/imagekit/models/accounts/url_endpoint.rb b/lib/imagekit/models/accounts/url_endpoint.rb new file mode 100644 index 00000000..99d559ae --- /dev/null +++ b/lib/imagekit/models/accounts/url_endpoint.rb @@ -0,0 +1,112 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + class URLEndpoint < Imagekit::Internal::Type::BaseModel + # @!attribute description + # Description of the URL endpoint. + # + # @return [String] + required :description, String + + # @!attribute 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. + # + # @return [Array, nil] + optional :origins, Imagekit::Internal::Type::ArrayOf[String] + + # @!attribute url_prefix + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + # + # @return [String, nil] + optional :url_prefix, String, api_name: :urlPrefix + + # @!attribute url_rewriter + # Configuration for third-party URL rewriting. + # + # @return [Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai, nil] + optional :url_rewriter, + union: -> { + Imagekit::Accounts::URLEndpoint::URLRewriter + }, + api_name: :urlRewriter + + # @!method initialize(description:, origins: nil, url_prefix: nil, url_rewriter: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::URLEndpoint} for more details. + # + # Schema for URL endpoint resource. + # + # @param description [String] Description of the URL endpoint. + # + # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag + # + # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an + # + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai] Configuration for third-party URL rewriting. + + # Configuration for third-party URL rewriting. + # + # @see Imagekit::Models::Accounts::URLEndpoint#url_rewriter + module URLRewriter + extend Imagekit::Internal::Type::Union + + discriminator :type + + variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary } + + variant :IMGIX, -> { Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix } + + variant :AKAMAI, -> { Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai } + + class Cloudinary < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, :CLOUDINARY] + required :type, const: :CLOUDINARY + + # @!attribute preserve_asset_delivery_types + # Whether to preserve `/` in the rewritten URL. + # + # @return [Boolean, nil] + optional :preserve_asset_delivery_types, + Imagekit::Internal::Type::Boolean, + api_name: :preserveAssetDeliveryTypes + + # @!method initialize(preserve_asset_delivery_types: nil, type: :CLOUDINARY) + # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. + # + # @param type [Symbol, :CLOUDINARY] + end + + class Imgix < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, :IMGIX] + required :type, const: :IMGIX + + # @!method initialize(type: :IMGIX) + # @param type [Symbol, :IMGIX] + end + + class Akamai < Imagekit::Internal::Type::BaseModel + # @!attribute type + # + # @return [Symbol, :AKAMAI] + required :type, const: :AKAMAI + + # @!method initialize(type: :AKAMAI) + # @param type [Symbol, :AKAMAI] + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai)] + end + end + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_create_params.rb b/lib/imagekit/models/accounts/url_endpoint_create_params.rb index a4280d24..73a4cc8a 100644 --- a/lib/imagekit/models/accounts/url_endpoint_create_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_create_params.rb @@ -4,108 +4,12 @@ module Imagekit module Models module Accounts # @see Imagekit::Resources::Accounts::URLEndpoints#create - class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel + class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpoint extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute description - # Description of the URL endpoint. - # - # @return [String] - required :description, String - - # @!attribute 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. - # - # @return [Array, nil] - optional :origins, Imagekit::Internal::Type::ArrayOf[String] - - # @!attribute url_prefix - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - # - # @return [String, nil] - optional :url_prefix, String, api_name: :urlPrefix - - # @!attribute url_rewriter - # Configuration for third-party URL rewriting. - # - # @return [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Akamai, nil] - optional :url_rewriter, - union: -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter }, - api_name: :urlRewriter - - # @!method initialize(description:, origins: nil, url_prefix: nil, url_rewriter: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointCreateParams} for more details. - # - # @param description [String] Description of the URL endpoint. - # - # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag - # - # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an - # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Akamai] Configuration for third-party URL rewriting. - # + # @!method initialize(request_options: {}) # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # Configuration for third-party URL rewriting. - module URLRewriter - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary } - - variant :IMGIX, -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix } - - variant :AKAMAI, -> { Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :CLOUDINARY] - required :type, const: :CLOUDINARY - - # @!attribute preserve_asset_delivery_types - # Whether to preserve `/` in the rewritten URL. - # - # @return [Boolean, nil] - optional :preserve_asset_delivery_types, - Imagekit::Internal::Type::Boolean, - api_name: :preserveAssetDeliveryTypes - - # @!method initialize(preserve_asset_delivery_types: nil, type: :CLOUDINARY) - # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. - # - # @param type [Symbol, :CLOUDINARY] - end - - class Imgix < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :IMGIX] - required :type, const: :IMGIX - - # @!method initialize(type: :IMGIX) - # @param type [Symbol, :IMGIX] - end - - class Akamai < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :AKAMAI] - required :type, const: :AKAMAI - - # @!method initialize(type: :AKAMAI) - # @param type [Symbol, :AKAMAI] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Akamai)] - end end end end diff --git a/lib/imagekit/models/accounts/url_endpoint_update_params.rb b/lib/imagekit/models/accounts/url_endpoint_update_params.rb index bfe08c46..adb2c10d 100644 --- a/lib/imagekit/models/accounts/url_endpoint_update_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_update_params.rb @@ -4,108 +4,12 @@ module Imagekit module Models module Accounts # @see Imagekit::Resources::Accounts::URLEndpoints#update - class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel + class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpoint extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute description - # Description of the URL endpoint. - # - # @return [String] - required :description, String - - # @!attribute 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. - # - # @return [Array, nil] - optional :origins, Imagekit::Internal::Type::ArrayOf[String] - - # @!attribute url_prefix - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - # - # @return [String, nil] - optional :url_prefix, String, api_name: :urlPrefix - - # @!attribute url_rewriter - # Configuration for third-party URL rewriting. - # - # @return [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai, nil] - optional :url_rewriter, - union: -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter }, - api_name: :urlRewriter - - # @!method initialize(description:, origins: nil, url_prefix: nil, url_rewriter: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointUpdateParams} for more details. - # - # @param description [String] Description of the URL endpoint. - # - # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag - # - # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an - # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai] Configuration for third-party URL rewriting. - # + # @!method initialize(request_options: {}) # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # Configuration for third-party URL rewriting. - module URLRewriter - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary } - - variant :IMGIX, -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix } - - variant :AKAMAI, -> { Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :CLOUDINARY] - required :type, const: :CLOUDINARY - - # @!attribute preserve_asset_delivery_types - # Whether to preserve `/` in the rewritten URL. - # - # @return [Boolean, nil] - optional :preserve_asset_delivery_types, - Imagekit::Internal::Type::Boolean, - api_name: :preserveAssetDeliveryTypes - - # @!method initialize(preserve_asset_delivery_types: nil, type: :CLOUDINARY) - # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. - # - # @param type [Symbol, :CLOUDINARY] - end - - class Imgix < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :IMGIX] - required :type, const: :IMGIX - - # @!method initialize(type: :IMGIX) - # @param type [Symbol, :IMGIX] - end - - class Akamai < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :AKAMAI] - required :type, const: :AKAMAI - - # @!method initialize(type: :AKAMAI) - # @param type [Symbol, :AKAMAI] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai)] - end end end end diff --git a/lib/imagekit/resources/accounts/url_endpoints.rb b/lib/imagekit/resources/accounts/url_endpoints.rb index ff599297..657a4c74 100644 --- a/lib/imagekit/resources/accounts/url_endpoints.rb +++ b/lib/imagekit/resources/accounts/url_endpoints.rb @@ -18,7 +18,7 @@ class URLEndpoints # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateParams::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai] Configuration for third-party URL rewriting. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -52,7 +52,7 @@ def create(params) # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai] Configuration for third-party URL rewriting. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/rbi/imagekit/models/accounts/url_endpoint.rbi b/rbi/imagekit/models/accounts/url_endpoint.rbi new file mode 100644 index 00000000..01a1191e --- /dev/null +++ b/rbi/imagekit/models/accounts/url_endpoint.rbi @@ -0,0 +1,213 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + class URLEndpoint < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Accounts::URLEndpoint, Imagekit::Internal::AnyHash) + end + + # Description of the URL endpoint. + sig { returns(String) } + attr_accessor :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. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :origins + + sig { params(origins: T::Array[String]).void } + attr_writer :origins + + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + sig { returns(T.nilable(String)) } + attr_reader :url_prefix + + sig { params(url_prefix: String).void } + attr_writer :url_prefix + + # Configuration for third-party URL rewriting. + sig do + returns( + T.nilable( + T.any( + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai + ) + ) + ) + end + attr_reader :url_rewriter + + sig do + params( + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai::OrHash + ) + ).void + end + attr_writer :url_rewriter + + # Schema for URL endpoint resource. + sig do + params( + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai::OrHash + ) + ).returns(T.attached_class) + end + def self.new( + # Description of the URL endpoint. + 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. + origins: nil, + # Path segment appended to your base URL to form the endpoint (letters, digits, + # and hyphens only — or empty for the default endpoint). + url_prefix: nil, + # Configuration for third-party URL rewriting. + url_rewriter: nil + ) + end + + sig do + override.returns( + { + description: String, + origins: T::Array[String], + url_prefix: String, + url_rewriter: + T.any( + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai + ) + } + ) + end + def to_hash + end + + # Configuration for third-party URL rewriting. + module URLRewriter + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai + ) + end + + class Cloudinary < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(Symbol) } + attr_accessor :type + + # Whether to preserve `/` in the rewritten URL. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :preserve_asset_delivery_types + + sig { params(preserve_asset_delivery_types: T::Boolean).void } + attr_writer :preserve_asset_delivery_types + + sig do + params( + preserve_asset_delivery_types: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Whether to preserve `/` in the rewritten URL. + preserve_asset_delivery_types: nil, + type: :CLOUDINARY + ) + end + + sig do + override.returns( + { type: Symbol, preserve_asset_delivery_types: T::Boolean } + ) + end + def to_hash + end + end + + class Imgix < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(Symbol) } + attr_accessor :type + + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :IMGIX) + end + + sig { override.returns({ type: Symbol }) } + def to_hash + end + end + + class Akamai < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(Symbol) } + attr_accessor :type + + sig { params(type: Symbol).returns(T.attached_class) } + def self.new(type: :AKAMAI) + end + + sig { override.returns({ type: Symbol }) } + def to_hash + end + end + + sig do + override.returns( + T::Array[Imagekit::Accounts::URLEndpoint::URLRewriter::Variants] + ) + end + def self.variants + end + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi index d3d5e5b4..5bf7b76b 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi @@ -3,7 +3,7 @@ module Imagekit module Models module Accounts - class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel + class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpoint extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -15,208 +15,17 @@ module Imagekit ) end - # Description of the URL endpoint. - sig { returns(String) } - attr_accessor :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. - sig { returns(T.nilable(T::Array[String])) } - attr_reader :origins - - sig { params(origins: T::Array[String]).void } - attr_writer :origins - - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - sig { returns(T.nilable(String)) } - attr_reader :url_prefix - - sig { params(url_prefix: String).void } - attr_writer :url_prefix - - # Configuration for third-party URL rewriting. sig do - returns( - T.nilable( - T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai - ) - ) + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class ) end - attr_reader :url_rewriter - - sig do - params( - url_rewriter: - T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai::OrHash - ) - ).void - end - attr_writer :url_rewriter - - sig do - params( - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Description of the URL endpoint. - 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. - origins: nil, - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - url_prefix: nil, - # Configuration for third-party URL rewriting. - url_rewriter: nil, - request_options: {} - ) + def self.new(request_options: {}) end - sig do - override.returns( - { - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai - ), - request_options: Imagekit::RequestOptions - } - ) - end + sig { override.returns({ request_options: Imagekit::RequestOptions }) } def to_hash end - - # Configuration for third-party URL rewriting. - module URLRewriter - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai - ) - end - - class Cloudinary < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - # Whether to preserve `/` in the rewritten URL. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :preserve_asset_delivery_types - - sig { params(preserve_asset_delivery_types: T::Boolean).void } - attr_writer :preserve_asset_delivery_types - - sig do - params( - preserve_asset_delivery_types: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Whether to preserve `/` in the rewritten URL. - preserve_asset_delivery_types: nil, - type: :CLOUDINARY - ) - end - - sig do - override.returns( - { type: Symbol, preserve_asset_delivery_types: T::Boolean } - ) - end - def to_hash - end - end - - class Imgix < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :IMGIX) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - class Akamai < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :AKAMAI) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Variants - ] - ) - end - def self.variants - end - end end end end diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi index fb549c5f..bb2019a9 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi @@ -3,7 +3,7 @@ module Imagekit module Models module Accounts - class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel + class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpoint extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -15,208 +15,17 @@ module Imagekit ) end - # Description of the URL endpoint. - sig { returns(String) } - attr_accessor :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. - sig { returns(T.nilable(T::Array[String])) } - attr_reader :origins - - sig { params(origins: T::Array[String]).void } - attr_writer :origins - - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - sig { returns(T.nilable(String)) } - attr_reader :url_prefix - - sig { params(url_prefix: String).void } - attr_writer :url_prefix - - # Configuration for third-party URL rewriting. sig do - returns( - T.nilable( - T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai - ) - ) + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class ) end - attr_reader :url_rewriter - - sig do - params( - url_rewriter: - T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai::OrHash - ) - ).void - end - attr_writer :url_rewriter - - sig do - params( - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Description of the URL endpoint. - 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. - origins: nil, - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - url_prefix: nil, - # Configuration for third-party URL rewriting. - url_rewriter: nil, - request_options: {} - ) + def self.new(request_options: {}) end - sig do - override.returns( - { - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai - ), - request_options: Imagekit::RequestOptions - } - ) - end + sig { override.returns({ request_options: Imagekit::RequestOptions }) } def to_hash end - - # Configuration for third-party URL rewriting. - module URLRewriter - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai - ) - end - - class Cloudinary < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - # Whether to preserve `/` in the rewritten URL. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :preserve_asset_delivery_types - - sig { params(preserve_asset_delivery_types: T::Boolean).void } - attr_writer :preserve_asset_delivery_types - - sig do - params( - preserve_asset_delivery_types: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Whether to preserve `/` in the rewritten URL. - preserve_asset_delivery_types: nil, - type: :CLOUDINARY - ) - end - - sig do - override.returns( - { type: Symbol, preserve_asset_delivery_types: T::Boolean } - ) - end - def to_hash - end - end - - class Imgix < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :IMGIX) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - class Akamai < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :AKAMAI) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Variants - ] - ) - end - def self.variants - end - end end end end diff --git a/rbi/imagekit/resources/accounts/url_endpoints.rbi b/rbi/imagekit/resources/accounts/url_endpoints.rbi index 684d4632..02db5c95 100644 --- a/rbi/imagekit/resources/accounts/url_endpoints.rbi +++ b/rbi/imagekit/resources/accounts/url_endpoints.rbi @@ -13,9 +13,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai::OrHash + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::URLEndpointCreateResponse) @@ -46,9 +46,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai::OrHash + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::Accounts::URLEndpointUpdateResponse) diff --git a/sig/imagekit/models/accounts/url_endpoint.rbs b/sig/imagekit/models/accounts/url_endpoint.rbs new file mode 100644 index 00000000..8ab66ead --- /dev/null +++ b/sig/imagekit/models/accounts/url_endpoint.rbs @@ -0,0 +1,97 @@ +module Imagekit + module Models + module Accounts + type url_endpoint = + { + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter + } + + class URLEndpoint < Imagekit::Internal::Type::BaseModel + attr_accessor description: String + + attr_reader origins: ::Array[String]? + + def origins=: (::Array[String]) -> ::Array[String] + + attr_reader url_prefix: String? + + def url_prefix=: (String) -> String + + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter? + + def url_rewriter=: ( + Imagekit::Models::Accounts::URLEndpoint::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpoint::url_rewriter + + def initialize: ( + description: String, + ?origins: ::Array[String], + ?url_prefix: String, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter + ) -> void + + def to_hash: -> { + description: String, + origins: ::Array[String], + url_prefix: String, + url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter + } + + type url_rewriter = + Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary + | Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix + | Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai + + module URLRewriter + extend Imagekit::Internal::Type::Union + + type cloudinary = + { type: :CLOUDINARY, preserve_asset_delivery_types: bool } + + class Cloudinary < Imagekit::Internal::Type::BaseModel + attr_accessor type: :CLOUDINARY + + attr_reader preserve_asset_delivery_types: bool? + + def preserve_asset_delivery_types=: (bool) -> bool + + def initialize: ( + ?preserve_asset_delivery_types: bool, + ?type: :CLOUDINARY + ) -> void + + def to_hash: -> { + type: :CLOUDINARY, + preserve_asset_delivery_types: bool + } + end + + type imgix = { type: :IMGIX } + + class Imgix < Imagekit::Internal::Type::BaseModel + attr_accessor type: :IMGIX + + def initialize: (?type: :IMGIX) -> void + + def to_hash: -> { type: :IMGIX } + end + + type akamai = { type: :AKAMAI } + + class Akamai < Imagekit::Internal::Type::BaseModel + attr_accessor type: :AKAMAI + + def initialize: (?type: :AKAMAI) -> void + + def to_hash: -> { type: :AKAMAI } + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpoint::url_rewriter] + end + end + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs index a321175f..42b1f99b 100644 --- a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs @@ -2,101 +2,15 @@ module Imagekit module Models module Accounts type url_endpoint_create_params = - { - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter - } - & Imagekit::Internal::Type::request_parameters + { } & Imagekit::Internal::Type::request_parameters - class URLEndpointCreateParams < Imagekit::Internal::Type::BaseModel + class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpoint extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor description: String + def initialize: (?request_options: Imagekit::request_opts) -> void - attr_reader origins: ::Array[String]? - - def origins=: (::Array[String]) -> ::Array[String] - - attr_reader url_prefix: String? - - def url_prefix=: (String) -> String - - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter? - - def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter - - def initialize: ( - description: String, - ?origins: ::Array[String], - ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter, - request_options: Imagekit::RequestOptions - } - - type url_rewriter = - Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Cloudinary - | Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Imgix - | Imagekit::Accounts::URLEndpointCreateParams::URLRewriter::Akamai - - module URLRewriter - extend Imagekit::Internal::Type::Union - - type cloudinary = - { type: :CLOUDINARY, preserve_asset_delivery_types: bool } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - attr_accessor type: :CLOUDINARY - - attr_reader preserve_asset_delivery_types: bool? - - def preserve_asset_delivery_types=: (bool) -> bool - - def initialize: ( - ?preserve_asset_delivery_types: bool, - ?type: :CLOUDINARY - ) -> void - - def to_hash: -> { - type: :CLOUDINARY, - preserve_asset_delivery_types: bool - } - end - - type imgix = { type: :IMGIX } - - class Imgix < Imagekit::Internal::Type::BaseModel - attr_accessor type: :IMGIX - - def initialize: (?type: :IMGIX) -> void - - def to_hash: -> { type: :IMGIX } - end - - type akamai = { type: :AKAMAI } - - class Akamai < Imagekit::Internal::Type::BaseModel - attr_accessor type: :AKAMAI - - def initialize: (?type: :AKAMAI) -> void - - def to_hash: -> { type: :AKAMAI } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter] - end + def to_hash: -> { request_options: Imagekit::RequestOptions } end end end diff --git a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs index b027b9b5..54c5225d 100644 --- a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs @@ -2,101 +2,15 @@ module Imagekit module Models module Accounts type url_endpoint_update_params = - { - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter - } - & Imagekit::Internal::Type::request_parameters + { } & Imagekit::Internal::Type::request_parameters - class URLEndpointUpdateParams < Imagekit::Internal::Type::BaseModel + class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpoint extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor description: String + def initialize: (?request_options: Imagekit::request_opts) -> void - attr_reader origins: ::Array[String]? - - def origins=: (::Array[String]) -> ::Array[String] - - attr_reader url_prefix: String? - - def url_prefix=: (String) -> String - - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter? - - def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter - - def initialize: ( - description: String, - ?origins: ::Array[String], - ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter, - request_options: Imagekit::RequestOptions - } - - type url_rewriter = - Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Cloudinary - | Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Imgix - | Imagekit::Accounts::URLEndpointUpdateParams::URLRewriter::Akamai - - module URLRewriter - extend Imagekit::Internal::Type::Union - - type cloudinary = - { type: :CLOUDINARY, preserve_asset_delivery_types: bool } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - attr_accessor type: :CLOUDINARY - - attr_reader preserve_asset_delivery_types: bool? - - def preserve_asset_delivery_types=: (bool) -> bool - - def initialize: ( - ?preserve_asset_delivery_types: bool, - ?type: :CLOUDINARY - ) -> void - - def to_hash: -> { - type: :CLOUDINARY, - preserve_asset_delivery_types: bool - } - end - - type imgix = { type: :IMGIX } - - class Imgix < Imagekit::Internal::Type::BaseModel - attr_accessor type: :IMGIX - - def initialize: (?type: :IMGIX) -> void - - def to_hash: -> { type: :IMGIX } - end - - type akamai = { type: :AKAMAI } - - class Akamai < Imagekit::Internal::Type::BaseModel - attr_accessor type: :AKAMAI - - def initialize: (?type: :AKAMAI) -> void - - def to_hash: -> { type: :AKAMAI } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter] - end + def to_hash: -> { request_options: Imagekit::RequestOptions } end end end diff --git a/sig/imagekit/resources/accounts/url_endpoints.rbs b/sig/imagekit/resources/accounts/url_endpoints.rbs index a9679e07..c170c770 100644 --- a/sig/imagekit/resources/accounts/url_endpoints.rbs +++ b/sig/imagekit/resources/accounts/url_endpoints.rbs @@ -6,7 +6,7 @@ module Imagekit description: String, ?origins: ::Array[String], ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateParams::url_rewriter, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::URLEndpointCreateResponse @@ -15,7 +15,7 @@ module Imagekit description: String, ?origins: ::Array[String], ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateParams::url_rewriter, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::URLEndpointUpdateResponse From 8c372fce85e8a8b12d31bcdacb9680f1ee0d3ef4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 05:56:16 +0000 Subject: [PATCH 046/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 49325e6c..6690c82e 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-967cd0e731df83a642ded194cacae3628050f679c600b1efd4e66cf269973531.yml -openapi_spec_hash: 98642308bee81ac776b7b1843089b888 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-67e78a2f87dab7c661093c82f338197540584fa3d9a38773d1fdd435d788282f.yml +openapi_spec_hash: 28ec969480eb18203d798e0435e76df3 config_hash: 49e367d7f33aeaf63ed738c1c0392d0a From 2dac13c912385a6a10aeb80a290a072332ffa06c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 05:57:06 +0000 Subject: [PATCH 047/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 4 +- .../models/accounts/origin_create_response.rb | 569 -------------- .../models/accounts/origin_list_response.rb | 566 +------------- ...gin_get_response.rb => origin_response.rb} | 39 +- .../models/accounts/origin_update_response.rb | 569 -------------- lib/imagekit/resources/accounts/origins.rb | 16 +- .../accounts/origin_create_response.rbi | 718 ------------------ .../models/accounts/origin_list_response.rbi | 715 +---------------- ...n_get_response.rbi => origin_response.rbi} | 36 +- .../accounts/origin_update_response.rbi | 718 ------------------ rbi/imagekit/resources/accounts/origins.rbi | 10 +- .../accounts/origin_create_response.rbs | 418 ---------- .../models/accounts/origin_list_response.rbs | 415 +--------- ...n_get_response.rbs => origin_response.rbs} | 24 +- .../accounts/origin_update_response.rbs | 418 ---------- sig/imagekit/resources/accounts/origins.rbs | 6 +- .../resources/accounts/origins_test.rb | 56 +- 18 files changed, 97 insertions(+), 5202 deletions(-) delete mode 100644 lib/imagekit/models/accounts/origin_create_response.rb rename lib/imagekit/models/accounts/{origin_get_response.rb => origin_response.rb} (90%) delete mode 100644 lib/imagekit/models/accounts/origin_update_response.rb delete mode 100644 rbi/imagekit/models/accounts/origin_create_response.rbi rename rbi/imagekit/models/accounts/{origin_get_response.rbi => origin_response.rbi} (94%) delete mode 100644 rbi/imagekit/models/accounts/origin_update_response.rbi delete mode 100644 sig/imagekit/models/accounts/origin_create_response.rbs rename sig/imagekit/models/accounts/{origin_get_response.rbs => origin_response.rbs} (94%) delete mode 100644 sig/imagekit/models/accounts/origin_update_response.rbs diff --git a/.stats.yml b/.stats.yml index 6690c82e..21592678 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-67e78a2f87dab7c661093c82f338197540584fa3d9a38773d1fdd435d788282f.yml openapi_spec_hash: 28ec969480eb18203d798e0435e76df3 -config_hash: 49e367d7f33aeaf63ed738c1c0392d0a +config_hash: 167d38f07a70976231dcdfa53ffa234c diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 74e07860..7081047f 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -54,14 +54,12 @@ require_relative "imagekit/models/accounts/url_endpoint" require_relative "imagekit/models/file" require_relative "imagekit/models/accounts/origin_create_params" -require_relative "imagekit/models/accounts/origin_create_response" require_relative "imagekit/models/accounts/origin_delete_params" require_relative "imagekit/models/accounts/origin_get_params" -require_relative "imagekit/models/accounts/origin_get_response" require_relative "imagekit/models/accounts/origin_list_params" require_relative "imagekit/models/accounts/origin_list_response" +require_relative "imagekit/models/accounts/origin_response" require_relative "imagekit/models/accounts/origin_update_params" -require_relative "imagekit/models/accounts/origin_update_response" require_relative "imagekit/models/accounts/url_endpoint_create_params" require_relative "imagekit/models/accounts/url_endpoint_create_response" require_relative "imagekit/models/accounts/url_endpoint_delete_params" diff --git a/lib/imagekit/models/accounts/origin_create_response.rb b/lib/imagekit/models/accounts/origin_create_response.rb deleted file mode 100644 index 01e0c545..00000000 --- a/lib/imagekit/models/accounts/origin_create_response.rb +++ /dev/null @@ -1,569 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # Origin object as returned by the API (sensitive fields removed). - # - # @see Imagekit::Resources::Accounts::Origins#create - module OriginCreateResponse - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :S3, -> { Imagekit::Models::Accounts::OriginCreateResponse::S3 } - - variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible } - - variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup } - - variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginCreateResponse::WebFolder } - - variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginCreateResponse::WebProxy } - - variant :GCS, -> { Imagekit::Models::Accounts::OriginCreateResponse::Gcs } - - variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim } - - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :S3] - required :type, const: :S3 - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::S3} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :S3] - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!attribute type - # - # @return [Symbol, :S3_COMPATIBLE] - required :type, const: :S3_COMPATIBLE - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :S3_COMPATIBLE] - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY_BACKUP] - required :type, const: :CLOUDINARY_BACKUP - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :CLOUDINARY_BACKUP] - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Root URL for the web folder origin. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean] - required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_FOLDER] - required :type, const: :WEB_FOLDER - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::WebFolder} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url [String] Root URL for the web folder origin. - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :WEB_FOLDER] - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_PROXY] - required :type, const: :WEB_PROXY - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::WebProxy} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :WEB_PROXY] - end - - class Gcs < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :GCS] - required :type, const: :GCS - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::Gcs} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] - # - # @param client_email [String] - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :GCS] - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :AZURE_BLOB] - required :type, const: :AZURE_BLOB - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param account_name [String] - # - # @param container [String] - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :AZURE_BLOB] - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url [String] Akeneo instance base URL. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :AKENEO_PIM] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim)] - end - end - end -end diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index 104d6194..8f9e9da8 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -3,572 +3,8 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). - module OriginListResponseItem - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :S3, -> { Imagekit::Models::Accounts::OriginListResponseItem::S3 } - - variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible } - - variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup } - - variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginListResponseItem::WebFolder } - - variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginListResponseItem::WebProxy } - - variant :GCS, -> { Imagekit::Models::Accounts::OriginListResponseItem::Gcs } - - variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim } - - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :S3] - required :type, const: :S3 - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::S3} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :S3] - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!attribute type - # - # @return [Symbol, :S3_COMPATIBLE] - required :type, const: :S3_COMPATIBLE - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :S3_COMPATIBLE] - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY_BACKUP] - required :type, const: :CLOUDINARY_BACKUP - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :CLOUDINARY_BACKUP] - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Root URL for the web folder origin. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean] - required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_FOLDER] - required :type, const: :WEB_FOLDER - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::WebFolder} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url [String] Root URL for the web folder origin. - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :WEB_FOLDER] - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_PROXY] - required :type, const: :WEB_PROXY - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::WebProxy} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :WEB_PROXY] - end - - class Gcs < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :GCS] - required :type, const: :GCS - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::Gcs} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] - # - # @param client_email [String] - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :GCS] - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :AZURE_BLOB] - required :type, const: :AZURE_BLOB - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param account_name [String] - # - # @param container [String] - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :AZURE_BLOB] - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url [String] Akeneo instance base URL. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :AKENEO_PIM] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginListResponseItem::S3, Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, Imagekit::Models::Accounts::OriginListResponseItem::Gcs, Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim)] - end - # @type [Imagekit::Internal::Type::Converter] - OriginListResponse = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::Accounts::OriginListResponseItem }] + OriginListResponse = Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Accounts::OriginResponse }] end end end diff --git a/lib/imagekit/models/accounts/origin_get_response.rb b/lib/imagekit/models/accounts/origin_response.rb similarity index 90% rename from lib/imagekit/models/accounts/origin_get_response.rb rename to lib/imagekit/models/accounts/origin_response.rb index f2faf7ad..aa9aea71 100644 --- a/lib/imagekit/models/accounts/origin_get_response.rb +++ b/lib/imagekit/models/accounts/origin_response.rb @@ -5,27 +5,27 @@ module Models module Accounts # Origin object as returned by the API (sensitive fields removed). # - # @see Imagekit::Resources::Accounts::Origins#get - module OriginGetResponse + # @see Imagekit::Resources::Accounts::Origins#create + module OriginResponse extend Imagekit::Internal::Type::Union discriminator :type - variant :S3, -> { Imagekit::Models::Accounts::OriginGetResponse::S3 } + variant :S3, -> { Imagekit::Accounts::OriginResponse::S3 } - variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginGetResponse::S3Compatible } + variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginResponse::S3Compatible } - variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginResponse::CloudinaryBackup } - variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginGetResponse::WebFolder } + variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginResponse::WebFolder } - variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginGetResponse::WebProxy } + variant :WEB_PROXY, -> { Imagekit::Accounts::OriginResponse::WebProxy } - variant :GCS, -> { Imagekit::Models::Accounts::OriginGetResponse::Gcs } + variant :GCS, -> { Imagekit::Accounts::OriginResponse::Gcs } - variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginGetResponse::AzureBlob } + variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginResponse::AzureBlob } - variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim } + variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginResponse::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket @@ -76,7 +76,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::S3} for more details. + # {Imagekit::Models::Accounts::OriginResponse::S3} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -154,7 +154,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::S3Compatible} for more details. + # {Imagekit::Models::Accounts::OriginResponse::S3Compatible} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -224,8 +224,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup} for more - # details. + # {Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -293,7 +292,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::WebFolder} for more details. + # {Imagekit::Models::Accounts::OriginResponse::WebFolder} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -347,7 +346,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::WebProxy} for more details. + # {Imagekit::Models::Accounts::OriginResponse::WebProxy} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -412,7 +411,7 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::Gcs} for more details. + # {Imagekit::Models::Accounts::OriginResponse::Gcs} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -483,7 +482,7 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::AzureBlob} for more details. + # {Imagekit::Models::Accounts::OriginResponse::AzureBlob} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -545,7 +544,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim} for more details. + # {Imagekit::Models::Accounts::OriginResponse::AkeneoPim} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -561,7 +560,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_update_response.rb b/lib/imagekit/models/accounts/origin_update_response.rb deleted file mode 100644 index eae3c9c5..00000000 --- a/lib/imagekit/models/accounts/origin_update_response.rb +++ /dev/null @@ -1,569 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # Origin object as returned by the API (sensitive fields removed). - # - # @see Imagekit::Resources::Accounts::Origins#update - module OriginUpdateResponse - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :S3, -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3 } - - variant :S3_COMPATIBLE, -> { Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible } - - variant :CLOUDINARY_BACKUP, -> { Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup } - - variant :WEB_FOLDER, -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder } - - variant :WEB_PROXY, -> { Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy } - - variant :GCS, -> { Imagekit::Models::Accounts::OriginUpdateResponse::Gcs } - - variant :AZURE_BLOB, -> { Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim } - - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :S3] - required :type, const: :S3 - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::S3} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :S3] - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!attribute type - # - # @return [Symbol, :S3_COMPATIBLE] - required :type, const: :S3_COMPATIBLE - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :S3_COMPATIBLE] - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY_BACKUP] - required :type, const: :CLOUDINARY_BACKUP - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup} for more - # details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :CLOUDINARY_BACKUP] - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Root URL for the web folder origin. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean] - required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_FOLDER] - required :type, const: :WEB_FOLDER - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url [String] Root URL for the web folder origin. - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :WEB_FOLDER] - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_PROXY] - required :type, const: :WEB_PROXY - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :WEB_PROXY] - end - - class Gcs < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :GCS] - required :type, const: :GCS - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::Gcs} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] - # - # @param client_email [String] - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :GCS] - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :AZURE_BLOB] - required :type, const: :AZURE_BLOB - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param account_name [String] - # - # @param container [String] - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :AZURE_BLOB] - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url [String] Akeneo instance base URL. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :AKENEO_PIM] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim)] - end - end - end -end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index 4fae97c0..2f20a1b9 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -13,7 +13,7 @@ class Origins # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginCreateResponse::S3, Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, Imagekit::Models::Accounts::OriginCreateResponse::Gcs, Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginCreateParams def create(params) @@ -22,7 +22,7 @@ def create(params) method: :post, path: "v1/accounts/origins", body: parsed[:origin], - model: Imagekit::Models::Accounts::OriginCreateResponse, + model: Imagekit::Accounts::OriginResponse, options: options ) end @@ -41,7 +41,7 @@ def create(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginUpdateResponse::S3, Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginUpdateParams def update(id, params) @@ -50,7 +50,7 @@ def update(id, params) method: :put, path: ["v1/accounts/origins/%1$s", id], body: parsed[:origin], - model: Imagekit::Models::Accounts::OriginUpdateResponse, + model: Imagekit::Accounts::OriginResponse, options: options ) end @@ -62,14 +62,14 @@ def update(id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::Accounts::OriginListParams def list(params = {}) @client.request( method: :get, path: "v1/accounts/origins", - model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::Accounts::OriginListResponseItem], + model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::OriginResponse], options: params[:request_options] ) end @@ -111,14 +111,14 @@ def delete(id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginGetResponse::S3, Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginGetResponse::WebFolder, Imagekit::Models::Accounts::OriginGetResponse::WebProxy, Imagekit::Models::Accounts::OriginGetResponse::Gcs, Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginGetParams def get(id, params = {}) @client.request( method: :get, path: ["v1/accounts/origins/%1$s", id], - model: Imagekit::Models::Accounts::OriginGetResponse, + model: Imagekit::Accounts::OriginResponse, options: params[:request_options] ) end diff --git a/rbi/imagekit/models/accounts/origin_create_response.rbi b/rbi/imagekit/models/accounts/origin_create_response.rbi deleted file mode 100644 index dc8ab505..00000000 --- a/rbi/imagekit/models/accounts/origin_create_response.rbi +++ /dev/null @@ -1,718 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - # Origin object as returned by the API (sensitive fields removed). - module OriginCreateResponse - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::S3, - Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, - Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, - Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, - Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, - Imagekit::Models::Accounts::OriginCreateResponse::Gcs, - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, - Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim - ) - end - - class S3 < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::S3, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :S3 - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - # Use path-style S3 URLs? - sig { returns(T::Boolean) } - attr_accessor :s3_force_path_style - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - endpoint: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - s3_force_path_style: T::Boolean, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Custom S3-compatible endpoint. - endpoint:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # Use path-style S3 URLs? - s3_force_path_style:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :S3_COMPATIBLE - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - s3_force_path_style: T::Boolean, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :CLOUDINARY_BACKUP - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::WebFolder, - Imagekit::Internal::AnyHash - ) - end - - # Root URL for the web folder origin. - sig { returns(String) } - attr_accessor :base_url - - # Forward the Host header to origin? - sig { returns(T::Boolean) } - attr_accessor :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Root URL for the web folder origin. - base_url:, - # Forward the Host header to origin? - forward_host_header_to_origin:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :WEB_FOLDER - ) - end - - sig do - override.returns( - { - id: String, - base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::WebProxy, - Imagekit::Internal::AnyHash - ) - end - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :WEB_PROXY - ) - end - - sig do - override.returns( - { - id: String, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class Gcs < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::Gcs, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :bucket - - sig { returns(String) } - attr_accessor :client_email - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - client_email: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - bucket:, - client_email:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :GCS - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - client_email: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - account_name: String, - container: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - account_name:, - container:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :AZURE_BLOB - ) - end - - sig do - override.returns( - { - id: String, - account_name: String, - container: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim, - Imagekit::Internal::AnyHash - ) - end - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - base_url: String, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Akeneo instance base URL. - base_url:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :AKENEO_PIM - ) - end - - sig do - override.returns( - { - id: String, - base_url: String, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - sig do - override.returns( - T::Array[Imagekit::Models::Accounts::OriginCreateResponse::Variants] - ) - end - def self.variants - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index 26f5914e..95287046 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -3,723 +3,10 @@ module Imagekit module Models module Accounts - # Origin object as returned by the API (sensitive fields removed). - module OriginListResponseItem - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::S3, - Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, - Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, - Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, - Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, - Imagekit::Models::Accounts::OriginListResponseItem::Gcs, - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, - Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim - ) - end - - class S3 < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::S3, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :S3 - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - # Use path-style S3 URLs? - sig { returns(T::Boolean) } - attr_accessor :s3_force_path_style - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - endpoint: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - s3_force_path_style: T::Boolean, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Custom S3-compatible endpoint. - endpoint:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # Use path-style S3 URLs? - s3_force_path_style:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :S3_COMPATIBLE - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - s3_force_path_style: T::Boolean, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :CLOUDINARY_BACKUP - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::WebFolder, - Imagekit::Internal::AnyHash - ) - end - - # Root URL for the web folder origin. - sig { returns(String) } - attr_accessor :base_url - - # Forward the Host header to origin? - sig { returns(T::Boolean) } - attr_accessor :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Root URL for the web folder origin. - base_url:, - # Forward the Host header to origin? - forward_host_header_to_origin:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :WEB_FOLDER - ) - end - - sig do - override.returns( - { - id: String, - base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::WebProxy, - Imagekit::Internal::AnyHash - ) - end - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :WEB_PROXY - ) - end - - sig do - override.returns( - { - id: String, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class Gcs < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::Gcs, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :bucket - - sig { returns(String) } - attr_accessor :client_email - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - client_email: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - bucket:, - client_email:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :GCS - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - client_email: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - account_name: String, - container: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - account_name:, - container:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :AZURE_BLOB - ) - end - - sig do - override.returns( - { - id: String, - account_name: String, - container: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim, - Imagekit::Internal::AnyHash - ) - end - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - base_url: String, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Akeneo instance base URL. - base_url:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :AKENEO_PIM - ) - end - - sig do - override.returns( - { - id: String, - base_url: String, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::Variants - ] - ) - end - def self.variants - end - end - OriginListResponse = T.let( Imagekit::Internal::Type::ArrayOf[ - union: Imagekit::Models::Accounts::OriginListResponseItem + union: Imagekit::Accounts::OriginResponse ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/accounts/origin_get_response.rbi b/rbi/imagekit/models/accounts/origin_response.rbi similarity index 94% rename from rbi/imagekit/models/accounts/origin_get_response.rbi rename to rbi/imagekit/models/accounts/origin_response.rbi index acbc7270..be9fc05f 100644 --- a/rbi/imagekit/models/accounts/origin_get_response.rbi +++ b/rbi/imagekit/models/accounts/origin_response.rbi @@ -4,20 +4,20 @@ module Imagekit module Models module Accounts # Origin object as returned by the API (sensitive fields removed). - module OriginGetResponse + module OriginResponse extend Imagekit::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::S3, - Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, - Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, - Imagekit::Models::Accounts::OriginGetResponse::WebFolder, - Imagekit::Models::Accounts::OriginGetResponse::WebProxy, - Imagekit::Models::Accounts::OriginGetResponse::Gcs, - Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, - Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim + Imagekit::Accounts::OriginResponse::S3, + Imagekit::Accounts::OriginResponse::S3Compatible, + Imagekit::Accounts::OriginResponse::CloudinaryBackup, + Imagekit::Accounts::OriginResponse::WebFolder, + Imagekit::Accounts::OriginResponse::WebProxy, + Imagekit::Accounts::OriginResponse::Gcs, + Imagekit::Accounts::OriginResponse::AzureBlob, + Imagekit::Accounts::OriginResponse::AkeneoPim ) end @@ -25,7 +25,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::S3, + Imagekit::Accounts::OriginResponse::S3, Imagekit::Internal::AnyHash ) end @@ -111,7 +111,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::S3Compatible, + Imagekit::Accounts::OriginResponse::S3Compatible, Imagekit::Internal::AnyHash ) end @@ -213,7 +213,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup, + Imagekit::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Internal::AnyHash ) end @@ -299,7 +299,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::WebFolder, + Imagekit::Accounts::OriginResponse::WebFolder, Imagekit::Internal::AnyHash ) end @@ -385,7 +385,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::WebProxy, + Imagekit::Accounts::OriginResponse::WebProxy, Imagekit::Internal::AnyHash ) end @@ -455,7 +455,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::Gcs, + Imagekit::Accounts::OriginResponse::Gcs, Imagekit::Internal::AnyHash ) end @@ -543,7 +543,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::AzureBlob, + Imagekit::Accounts::OriginResponse::AzureBlob, Imagekit::Internal::AnyHash ) end @@ -631,7 +631,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim, + Imagekit::Accounts::OriginResponse::AkeneoPim, Imagekit::Internal::AnyHash ) end @@ -707,7 +707,7 @@ module Imagekit sig do override.returns( - T::Array[Imagekit::Models::Accounts::OriginGetResponse::Variants] + T::Array[Imagekit::Accounts::OriginResponse::Variants] ) end def self.variants diff --git a/rbi/imagekit/models/accounts/origin_update_response.rbi b/rbi/imagekit/models/accounts/origin_update_response.rbi deleted file mode 100644 index 6d07d92c..00000000 --- a/rbi/imagekit/models/accounts/origin_update_response.rbi +++ /dev/null @@ -1,718 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - # Origin object as returned by the API (sensitive fields removed). - module OriginUpdateResponse - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::S3, - Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, - Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, - Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, - Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, - Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, - Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim - ) - end - - class S3 < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::S3, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :S3 - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - # Use path-style S3 URLs? - sig { returns(T::Boolean) } - attr_accessor :s3_force_path_style - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - endpoint: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - s3_force_path_style: T::Boolean, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Custom S3-compatible endpoint. - endpoint:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # Use path-style S3 URLs? - s3_force_path_style:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :S3_COMPATIBLE - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - s3_force_path_style: T::Boolean, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :CLOUDINARY_BACKUP - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder, - Imagekit::Internal::AnyHash - ) - end - - # Root URL for the web folder origin. - sig { returns(String) } - attr_accessor :base_url - - # Forward the Host header to origin? - sig { returns(T::Boolean) } - attr_accessor :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Root URL for the web folder origin. - base_url:, - # Forward the Host header to origin? - forward_host_header_to_origin:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :WEB_FOLDER - ) - end - - sig do - override.returns( - { - id: String, - base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy, - Imagekit::Internal::AnyHash - ) - end - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :WEB_PROXY - ) - end - - sig do - override.returns( - { - id: String, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class Gcs < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::Gcs, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :bucket - - sig { returns(String) } - attr_accessor :client_email - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - client_email: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - bucket:, - client_email:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :GCS - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - client_email: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - account_name: String, - container: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - account_name:, - container:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :AZURE_BLOB - ) - end - - sig do - override.returns( - { - id: String, - account_name: String, - container: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim, - Imagekit::Internal::AnyHash - ) - end - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - base_url: String, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Akeneo instance base URL. - base_url:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :AKENEO_PIM - ) - end - - sig do - override.returns( - { - id: String, - base_url: String, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - sig do - override.returns( - T::Array[Imagekit::Models::Accounts::OriginUpdateResponse::Variants] - ) - end - def self.variants - end - end - end - end -end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index b914baef..cf247dcd 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -20,7 +20,7 @@ module Imagekit Imagekit::Accounts::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Accounts::OriginCreateResponse::Variants) + ).returns(Imagekit::Accounts::OriginResponse::Variants) end def create( # Schema for origin resources. @@ -46,7 +46,7 @@ module Imagekit Imagekit::Accounts::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Accounts::OriginUpdateResponse::Variants) + ).returns(Imagekit::Accounts::OriginResponse::Variants) end def update( # Unique identifier for the origin. This is generated by ImageKit when you create @@ -62,9 +62,7 @@ module Imagekit # Returns an array of all configured origins for the current account. sig do params(request_options: Imagekit::RequestOptions::OrHash).returns( - T::Array[ - Imagekit::Models::Accounts::OriginListResponseItem::Variants - ] + T::Array[Imagekit::Accounts::OriginResponse::Variants] ) end def list(request_options: {}) @@ -93,7 +91,7 @@ module Imagekit params( id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Accounts::OriginGetResponse::Variants) + ).returns(Imagekit::Accounts::OriginResponse::Variants) end def get( # Unique identifier for the origin. This is generated by ImageKit when you create diff --git a/sig/imagekit/models/accounts/origin_create_response.rbs b/sig/imagekit/models/accounts/origin_create_response.rbs deleted file mode 100644 index 0d71ff69..00000000 --- a/sig/imagekit/models/accounts/origin_create_response.rbs +++ /dev/null @@ -1,418 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_create_response = - Imagekit::Models::Accounts::OriginCreateResponse::S3 - | Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible - | Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup - | Imagekit::Models::Accounts::OriginCreateResponse::WebFolder - | Imagekit::Models::Accounts::OriginCreateResponse::WebProxy - | Imagekit::Models::Accounts::OriginCreateResponse::Gcs - | Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob - | Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim - - module OriginCreateResponse - extend Imagekit::Internal::Type::Union - - type s3 = - { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :S3, - base_url_for_canonical_header: String - } - - class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :S3 - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :S3 - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :S3, - base_url_for_canonical_header: String - } - end - - type s3_compatible = - { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - :s3_force_path_style => bool, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String - } - - class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor endpoint: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor s3_force_path_style: bool - - attr_accessor type: :S3_COMPATIBLE - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - s3_force_path_style: bool, - ?base_url_for_canonical_header: String, - ?type: :S3_COMPATIBLE - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - :s3_force_path_style => bool, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String - } - end - - type cloudinary_backup = - { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String - } - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :CLOUDINARY_BACKUP - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :CLOUDINARY_BACKUP - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String - } - end - - type web_folder = - { - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String - } - - class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor forward_host_header_to_origin: bool - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :WEB_FOLDER - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :WEB_FOLDER - ) -> void - - def to_hash: -> { - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String - } - end - - type web_proxy = - { - id: String, - include_canonical_header: bool, - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String - } - - class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :WEB_PROXY - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :WEB_PROXY - ) -> void - - def to_hash: -> { - id: String, - include_canonical_header: bool, - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String - } - end - - type gcs = - { - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :GCS, - base_url_for_canonical_header: String - } - - class Gcs < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor client_email: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :GCS - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :GCS - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :GCS, - base_url_for_canonical_header: String - } - end - - type azure_blob = - { - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String - } - - class AzureBlob < Imagekit::Internal::Type::BaseModel - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :AZURE_BLOB - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :AZURE_BLOB - ) -> void - - def to_hash: -> { - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String - } - end - - type akeneo_pim = - { - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String - } - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :AKENEO_PIM - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :AKENEO_PIM - ) -> void - - def to_hash: -> { - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String - } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_create_response] - end - end - end -end diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index 6950ef03..e689073a 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -1,421 +1,8 @@ module Imagekit module Models module Accounts - type origin_list_response_item = - Imagekit::Models::Accounts::OriginListResponseItem::S3 - | Imagekit::Models::Accounts::OriginListResponseItem::S3Compatible - | Imagekit::Models::Accounts::OriginListResponseItem::CloudinaryBackup - | Imagekit::Models::Accounts::OriginListResponseItem::WebFolder - | Imagekit::Models::Accounts::OriginListResponseItem::WebProxy - | Imagekit::Models::Accounts::OriginListResponseItem::Gcs - | Imagekit::Models::Accounts::OriginListResponseItem::AzureBlob - | Imagekit::Models::Accounts::OriginListResponseItem::AkeneoPim - - module OriginListResponseItem - extend Imagekit::Internal::Type::Union - - type s3 = - { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :S3, - base_url_for_canonical_header: String - } - - class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :S3 - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :S3 - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :S3, - base_url_for_canonical_header: String - } - end - - type s3_compatible = - { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - :s3_force_path_style => bool, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String - } - - class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor endpoint: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor s3_force_path_style: bool - - attr_accessor type: :S3_COMPATIBLE - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - s3_force_path_style: bool, - ?base_url_for_canonical_header: String, - ?type: :S3_COMPATIBLE - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - :s3_force_path_style => bool, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String - } - end - - type cloudinary_backup = - { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String - } - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :CLOUDINARY_BACKUP - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :CLOUDINARY_BACKUP - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String - } - end - - type web_folder = - { - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String - } - - class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor forward_host_header_to_origin: bool - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :WEB_FOLDER - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :WEB_FOLDER - ) -> void - - def to_hash: -> { - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String - } - end - - type web_proxy = - { - id: String, - include_canonical_header: bool, - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String - } - - class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :WEB_PROXY - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :WEB_PROXY - ) -> void - - def to_hash: -> { - id: String, - include_canonical_header: bool, - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String - } - end - - type gcs = - { - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :GCS, - base_url_for_canonical_header: String - } - - class Gcs < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor client_email: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :GCS - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :GCS - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :GCS, - base_url_for_canonical_header: String - } - end - - type azure_blob = - { - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String - } - - class AzureBlob < Imagekit::Internal::Type::BaseModel - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :AZURE_BLOB - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :AZURE_BLOB - ) -> void - - def to_hash: -> { - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String - } - end - - type akeneo_pim = - { - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String - } - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :AKENEO_PIM - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :AKENEO_PIM - ) -> void - - def to_hash: -> { - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String - } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_list_response_item] - end - type origin_list_response = - ::Array[Imagekit::Models::Accounts::origin_list_response_item] + ::Array[Imagekit::Models::Accounts::origin_response] OriginListResponse: Imagekit::Internal::Type::Converter end diff --git a/sig/imagekit/models/accounts/origin_get_response.rbs b/sig/imagekit/models/accounts/origin_response.rbs similarity index 94% rename from sig/imagekit/models/accounts/origin_get_response.rbs rename to sig/imagekit/models/accounts/origin_response.rbs index 68bc3616..bca52d65 100644 --- a/sig/imagekit/models/accounts/origin_get_response.rbs +++ b/sig/imagekit/models/accounts/origin_response.rbs @@ -1,17 +1,17 @@ module Imagekit module Models module Accounts - type origin_get_response = - Imagekit::Models::Accounts::OriginGetResponse::S3 - | Imagekit::Models::Accounts::OriginGetResponse::S3Compatible - | Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup - | Imagekit::Models::Accounts::OriginGetResponse::WebFolder - | Imagekit::Models::Accounts::OriginGetResponse::WebProxy - | Imagekit::Models::Accounts::OriginGetResponse::Gcs - | Imagekit::Models::Accounts::OriginGetResponse::AzureBlob - | Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim - - module OriginGetResponse + type origin_response = + Imagekit::Accounts::OriginResponse::S3 + | Imagekit::Accounts::OriginResponse::S3Compatible + | Imagekit::Accounts::OriginResponse::CloudinaryBackup + | Imagekit::Accounts::OriginResponse::WebFolder + | Imagekit::Accounts::OriginResponse::WebProxy + | Imagekit::Accounts::OriginResponse::Gcs + | Imagekit::Accounts::OriginResponse::AzureBlob + | Imagekit::Accounts::OriginResponse::AkeneoPim + + module OriginResponse extend Imagekit::Internal::Type::Union type s3 = @@ -411,7 +411,7 @@ module Imagekit } end - def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_get_response] + def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_response] end end end diff --git a/sig/imagekit/models/accounts/origin_update_response.rbs b/sig/imagekit/models/accounts/origin_update_response.rbs deleted file mode 100644 index 11d8ae94..00000000 --- a/sig/imagekit/models/accounts/origin_update_response.rbs +++ /dev/null @@ -1,418 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_update_response = - Imagekit::Models::Accounts::OriginUpdateResponse::S3 - | Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible - | Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup - | Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder - | Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy - | Imagekit::Models::Accounts::OriginUpdateResponse::Gcs - | Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob - | Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim - - module OriginUpdateResponse - extend Imagekit::Internal::Type::Union - - type s3 = - { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :S3, - base_url_for_canonical_header: String - } - - class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :S3 - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :S3 - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :S3, - base_url_for_canonical_header: String - } - end - - type s3_compatible = - { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - :s3_force_path_style => bool, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String - } - - class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor endpoint: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor s3_force_path_style: bool - - attr_accessor type: :S3_COMPATIBLE - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - s3_force_path_style: bool, - ?base_url_for_canonical_header: String, - ?type: :S3_COMPATIBLE - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - :s3_force_path_style => bool, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String - } - end - - type cloudinary_backup = - { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String - } - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :CLOUDINARY_BACKUP - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :CLOUDINARY_BACKUP - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String - } - end - - type web_folder = - { - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String - } - - class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor forward_host_header_to_origin: bool - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :WEB_FOLDER - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :WEB_FOLDER - ) -> void - - def to_hash: -> { - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String - } - end - - type web_proxy = - { - id: String, - include_canonical_header: bool, - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String - } - - class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :WEB_PROXY - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :WEB_PROXY - ) -> void - - def to_hash: -> { - id: String, - include_canonical_header: bool, - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String - } - end - - type gcs = - { - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :GCS, - base_url_for_canonical_header: String - } - - class Gcs < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor client_email: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :GCS - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :GCS - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :GCS, - base_url_for_canonical_header: String - } - end - - type azure_blob = - { - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String - } - - class AzureBlob < Imagekit::Internal::Type::BaseModel - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :AZURE_BLOB - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :AZURE_BLOB - ) -> void - - def to_hash: -> { - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String - } - end - - type akeneo_pim = - { - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String - } - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :AKENEO_PIM - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :AKENEO_PIM - ) -> void - - def to_hash: -> { - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String - } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_update_response] - end - end - end -end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index 63f7382e..4ffe3ae3 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -5,13 +5,13 @@ module Imagekit def create: ( origin: Imagekit::Models::Accounts::origin, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_create_response + ) -> Imagekit::Models::Accounts::origin_response def update: ( String id, origin: Imagekit::Models::Accounts::origin, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_update_response + ) -> Imagekit::Models::Accounts::origin_response def list: ( ?request_options: Imagekit::request_opts @@ -22,7 +22,7 @@ module Imagekit def get: ( String id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_get_response + ) -> Imagekit::Models::Accounts::origin_response def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index 18ed7728..55df4efe 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -18,19 +18,19 @@ def test_create_required_params ) assert_pattern do - response => Imagekit::Models::Accounts::OriginCreateResponse + response => Imagekit::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Models::Accounts::OriginCreateResponse::S3 - in Imagekit::Models::Accounts::OriginCreateResponse::S3Compatible - in Imagekit::Models::Accounts::OriginCreateResponse::CloudinaryBackup - in Imagekit::Models::Accounts::OriginCreateResponse::WebFolder - in Imagekit::Models::Accounts::OriginCreateResponse::WebProxy - in Imagekit::Models::Accounts::OriginCreateResponse::Gcs - in Imagekit::Models::Accounts::OriginCreateResponse::AzureBlob - in Imagekit::Models::Accounts::OriginCreateResponse::AkeneoPim + in Imagekit::Accounts::OriginResponse::S3 + in Imagekit::Accounts::OriginResponse::S3Compatible + in Imagekit::Accounts::OriginResponse::CloudinaryBackup + in Imagekit::Accounts::OriginResponse::WebFolder + in Imagekit::Accounts::OriginResponse::WebProxy + in Imagekit::Accounts::OriginResponse::Gcs + in Imagekit::Accounts::OriginResponse::AzureBlob + in Imagekit::Accounts::OriginResponse::AkeneoPim end end @@ -129,19 +129,19 @@ def test_update_required_params ) assert_pattern do - response => Imagekit::Models::Accounts::OriginUpdateResponse + response => Imagekit::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Models::Accounts::OriginUpdateResponse::S3 - in Imagekit::Models::Accounts::OriginUpdateResponse::S3Compatible - in Imagekit::Models::Accounts::OriginUpdateResponse::CloudinaryBackup - in Imagekit::Models::Accounts::OriginUpdateResponse::WebFolder - in Imagekit::Models::Accounts::OriginUpdateResponse::WebProxy - in Imagekit::Models::Accounts::OriginUpdateResponse::Gcs - in Imagekit::Models::Accounts::OriginUpdateResponse::AzureBlob - in Imagekit::Models::Accounts::OriginUpdateResponse::AkeneoPim + in Imagekit::Accounts::OriginResponse::S3 + in Imagekit::Accounts::OriginResponse::S3Compatible + in Imagekit::Accounts::OriginResponse::CloudinaryBackup + in Imagekit::Accounts::OriginResponse::WebFolder + in Imagekit::Accounts::OriginResponse::WebProxy + in Imagekit::Accounts::OriginResponse::Gcs + in Imagekit::Accounts::OriginResponse::AzureBlob + in Imagekit::Accounts::OriginResponse::AkeneoPim end end @@ -230,7 +230,7 @@ def test_list response = @image_kit.accounts.origins.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::Accounts::OriginListResponseItem]) + response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::OriginResponse]) end end @@ -250,19 +250,19 @@ def test_get response = @image_kit.accounts.origins.get("id") assert_pattern do - response => Imagekit::Models::Accounts::OriginGetResponse + response => Imagekit::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Models::Accounts::OriginGetResponse::S3 - in Imagekit::Models::Accounts::OriginGetResponse::S3Compatible - in Imagekit::Models::Accounts::OriginGetResponse::CloudinaryBackup - in Imagekit::Models::Accounts::OriginGetResponse::WebFolder - in Imagekit::Models::Accounts::OriginGetResponse::WebProxy - in Imagekit::Models::Accounts::OriginGetResponse::Gcs - in Imagekit::Models::Accounts::OriginGetResponse::AzureBlob - in Imagekit::Models::Accounts::OriginGetResponse::AkeneoPim + in Imagekit::Accounts::OriginResponse::S3 + in Imagekit::Accounts::OriginResponse::S3Compatible + in Imagekit::Accounts::OriginResponse::CloudinaryBackup + in Imagekit::Accounts::OriginResponse::WebFolder + in Imagekit::Accounts::OriginResponse::WebProxy + in Imagekit::Accounts::OriginResponse::Gcs + in Imagekit::Accounts::OriginResponse::AzureBlob + in Imagekit::Accounts::OriginResponse::AkeneoPim end end From 867bb9b7c70c6b568ea8bc0447f979e384ae7f1e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:08:08 +0000 Subject: [PATCH 048/178] feat(api): manual updates --- .stats.yml | 6 +- lib/imagekit.rb | 1 - lib/imagekit/models/accounts/origin.rb | 282 +++++-- .../models/accounts/origin_list_response.rb | 2 +- .../models/accounts/origin_response.rb | 567 -------------- lib/imagekit/resources/accounts/origins.rb | 16 +- rbi/imagekit/models/accounts/origin.rbi | 196 +++-- .../models/accounts/origin_list_response.rbi | 4 +- .../models/accounts/origin_response.rbi | 718 ------------------ rbi/imagekit/resources/accounts/origins.rbi | 8 +- sig/imagekit/models/accounts/origin.rbs | 104 ++- .../models/accounts/origin_list_response.rbs | 3 +- .../models/accounts/origin_response.rbs | 418 ---------- sig/imagekit/resources/accounts/origins.rbs | 6 +- .../resources/accounts/origins_test.rb | 278 ++++--- 15 files changed, 612 insertions(+), 1997 deletions(-) delete mode 100644 lib/imagekit/models/accounts/origin_response.rb delete mode 100644 rbi/imagekit/models/accounts/origin_response.rbi delete mode 100644 sig/imagekit/models/accounts/origin_response.rbs diff --git a/.stats.yml b/.stats.yml index 21592678..6ac1eba7 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-67e78a2f87dab7c661093c82f338197540584fa3d9a38773d1fdd435d788282f.yml -openapi_spec_hash: 28ec969480eb18203d798e0435e76df3 -config_hash: 167d38f07a70976231dcdfa53ffa234c +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-554f897c7f0061bb1fe51cd82f5f05e66050db5e868524c374dac827bd7b8c3d.yml +openapi_spec_hash: 95b7298e7f3977ea6c98d9557d2c8d27 +config_hash: 49e367d7f33aeaf63ed738c1c0392d0a diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 7081047f..97518432 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -58,7 +58,6 @@ require_relative "imagekit/models/accounts/origin_get_params" require_relative "imagekit/models/accounts/origin_list_params" require_relative "imagekit/models/accounts/origin_list_response" -require_relative "imagekit/models/accounts/origin_response" require_relative "imagekit/models/accounts/origin_update_params" require_relative "imagekit/models/accounts/url_endpoint_create_params" require_relative "imagekit/models/accounts/url_endpoint_create_response" diff --git a/lib/imagekit/models/accounts/origin.rb b/lib/imagekit/models/accounts/origin.rb index 87b92f16..f35d1f9f 100644 --- a/lib/imagekit/models/accounts/origin.rb +++ b/lib/imagekit/models/accounts/origin.rb @@ -4,6 +4,8 @@ module Imagekit module Models module Accounts # Schema for origin resources. + # + # @see Imagekit::Resources::Accounts::Origins#create module Origin extend Imagekit::Internal::Type::Union @@ -26,12 +28,6 @@ module Origin variant :AKENEO_PIM, -> { Imagekit::Accounts::Origin::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # @@ -44,12 +40,6 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - # @!attribute type # # @return [Symbol, :S3] @@ -75,7 +65,33 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :prefix, String - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + request_only do + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + end + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String, nil] + optional :id, String + end + + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::Origin::S3} for more details. + # # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. @@ -84,6 +100,8 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @param secret_key [String] Secret key for the bucket. # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param include_canonical_header [Boolean] Whether to send a Canonical header. @@ -94,12 +112,6 @@ class S3 < Imagekit::Internal::Type::BaseModel end class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # @@ -118,12 +130,6 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - # @!attribute type # # @return [Symbol, :S3_COMPATIBLE] @@ -155,7 +161,33 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [Boolean, nil] optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + request_only do + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + end + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String, nil] + optional :id, String + end + + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::Origin::S3Compatible} for more details. + # # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. @@ -166,6 +198,8 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @param secret_key [String] Secret key for the bucket. # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param include_canonical_header [Boolean] Whether to send a Canonical header. @@ -178,12 +212,6 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel end class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - # @!attribute bucket # S3 bucket name. # @@ -196,12 +224,6 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - # @!attribute type # # @return [Symbol, :CLOUDINARY_BACKUP] @@ -227,7 +249,33 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :prefix, String - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + request_only do + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + end + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String, nil] + optional :id, String + end + + # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::Origin::CloudinaryBackup} for more details. + # # @param access_key [String] Access key for the bucket. # # @param bucket [String] S3 bucket name. @@ -236,6 +284,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @param secret_key [String] Secret key for the bucket. # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param include_canonical_header [Boolean] Whether to send a Canonical header. @@ -285,11 +335,25 @@ class WebFolder < Imagekit::Internal::Type::BaseModel Imagekit::Internal::Type::Boolean, api_name: :includeCanonicalHeader - # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String, nil] + optional :id, String + end + + # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::Origin::WebFolder} for more details. + # # @param base_url [String] Root URL for the web folder origin. # # @param name [String] Display name of the origin. # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? @@ -325,9 +389,23 @@ class WebProxy < Imagekit::Internal::Type::BaseModel Imagekit::Internal::Type::Boolean, api_name: :includeCanonicalHeader - # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String, nil] + optional :id, String + end + + # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::Origin::WebProxy} for more details. + # # @param name [String] Display name of the origin. # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param include_canonical_header [Boolean] Whether to send a Canonical header. @@ -352,11 +430,6 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey - # @!attribute type # # @return [Symbol, :GCS] @@ -381,7 +454,26 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :prefix, String - # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + request_only do + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + end + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String, nil] + optional :id, String + end + + # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::Origin::Gcs} for more details. + # # @param bucket [String] # # @param client_email [String] @@ -390,6 +482,8 @@ class Gcs < Imagekit::Internal::Type::BaseModel # # @param private_key [String] # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param include_canonical_header [Boolean] Whether to send a Canonical header. @@ -416,11 +510,6 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken - # @!attribute type # # @return [Symbol, :AZURE_BLOB] @@ -445,7 +534,26 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :prefix, String - # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + request_only do + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + end + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String, nil] + optional :id, String + end + + # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::Origin::AzureBlob} for more details. + # # @param account_name [String] # # @param container [String] @@ -454,6 +562,8 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # # @param sas_token [String] # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param include_canonical_header [Boolean] Whether to send a Canonical header. @@ -470,41 +580,17 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret - # @!attribute name # Display name of the origin. # # @return [String] required :name, String - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - # @!attribute type # # @return [Symbol, :AKENEO_PIM] required :type, const: :AKENEO_PIM - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - # @!attribute base_url_for_canonical_header # URL used in the Canonical header (if enabled). # @@ -519,7 +605,45 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel Imagekit::Internal::Type::Boolean, api_name: :includeCanonicalHeader - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + request_only do + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + end + + response_only do + # @!attribute id + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + # + # @return [String, nil] + optional :id, String + end + + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Accounts::Origin::AkeneoPim} for more details. + # # @param base_url [String] Akeneo instance base URL. # # @param client_id [String] Akeneo API client ID. @@ -532,6 +656,8 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @param username [String] Akeneo API username. # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # # @param include_canonical_header [Boolean] Whether to send a Canonical header. diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index 8f9e9da8..193c027b 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -4,7 +4,7 @@ module Imagekit module Models module Accounts # @type [Imagekit::Internal::Type::Converter] - OriginListResponse = Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Accounts::OriginResponse }] + OriginListResponse = Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Accounts::Origin }] end end end diff --git a/lib/imagekit/models/accounts/origin_response.rb b/lib/imagekit/models/accounts/origin_response.rb deleted file mode 100644 index aa9aea71..00000000 --- a/lib/imagekit/models/accounts/origin_response.rb +++ /dev/null @@ -1,567 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # Origin object as returned by the API (sensitive fields removed). - # - # @see Imagekit::Resources::Accounts::Origins#create - module OriginResponse - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :S3, -> { Imagekit::Accounts::OriginResponse::S3 } - - variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginResponse::S3Compatible } - - variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginResponse::CloudinaryBackup } - - variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginResponse::WebFolder } - - variant :WEB_PROXY, -> { Imagekit::Accounts::OriginResponse::WebProxy } - - variant :GCS, -> { Imagekit::Accounts::OriginResponse::Gcs } - - variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginResponse::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginResponse::AkeneoPim } - - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :S3] - required :type, const: :S3 - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::S3} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :S3] - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!attribute type - # - # @return [Symbol, :S3_COMPATIBLE] - required :type, const: :S3_COMPATIBLE - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::S3Compatible} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :S3_COMPATIBLE] - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY_BACKUP] - required :type, const: :CLOUDINARY_BACKUP - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] S3 bucket name. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :CLOUDINARY_BACKUP] - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Root URL for the web folder origin. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean] - required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_FOLDER] - required :type, const: :WEB_FOLDER - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::WebFolder} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url [String] Root URL for the web folder origin. - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :WEB_FOLDER] - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_PROXY] - required :type, const: :WEB_PROXY - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::WebProxy} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :WEB_PROXY] - end - - class Gcs < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :GCS] - required :type, const: :GCS - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::Gcs} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param bucket [String] - # - # @param client_email [String] - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :GCS] - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute prefix - # - # @return [String] - required :prefix, String - - # @!attribute type - # - # @return [Symbol, :AZURE_BLOB] - required :type, const: :AZURE_BLOB - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::AzureBlob} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param account_name [String] - # - # @param container [String] - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param prefix [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :AZURE_BLOB] - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean] - required :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - response_only do - # @!attribute id - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::AkeneoPim} for more details. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url [String] Akeneo instance base URL. - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param type [Symbol, :AKENEO_PIM] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim)] - end - end - end -end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index 2f20a1b9..15db549c 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -13,7 +13,7 @@ class Origins # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginCreateParams def create(params) @@ -22,7 +22,7 @@ def create(params) method: :post, path: "v1/accounts/origins", body: parsed[:origin], - model: Imagekit::Accounts::OriginResponse, + model: Imagekit::Accounts::Origin, options: options ) end @@ -41,7 +41,7 @@ def create(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginUpdateParams def update(id, params) @@ -50,7 +50,7 @@ def update(id, params) method: :put, path: ["v1/accounts/origins/%1$s", id], body: parsed[:origin], - model: Imagekit::Accounts::OriginResponse, + model: Imagekit::Accounts::Origin, options: options ) end @@ -62,14 +62,14 @@ def update(id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::Accounts::OriginListParams def list(params = {}) @client.request( method: :get, path: "v1/accounts/origins", - model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::OriginResponse], + model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::Origin], options: params[:request_options] ) end @@ -111,14 +111,14 @@ def delete(id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] + # @return [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginGetParams def get(id, params = {}) @client.request( method: :get, path: ["v1/accounts/origins/%1$s", id], - model: Imagekit::Accounts::OriginResponse, + model: Imagekit::Accounts::Origin, options: params[:request_options] ) end diff --git a/rbi/imagekit/models/accounts/origin.rbi b/rbi/imagekit/models/accounts/origin.rbi index d5d5249a..5442050d 100644 --- a/rbi/imagekit/models/accounts/origin.rbi +++ b/rbi/imagekit/models/accounts/origin.rbi @@ -27,10 +27,6 @@ module Imagekit T.any(Imagekit::Accounts::Origin::S3, Imagekit::Internal::AnyHash) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -39,10 +35,6 @@ module Imagekit sig { returns(String) } attr_accessor :name - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - sig { returns(Symbol) } attr_accessor :type @@ -67,12 +59,29 @@ module Imagekit sig { params(prefix: String).void } attr_writer :prefix + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + sig do params( access_key: String, bucket: String, name: String, secret_key: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -88,6 +97,9 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, # Whether to send a Canonical header. @@ -106,6 +118,7 @@ module Imagekit name: String, secret_key: String, type: Symbol, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String @@ -125,10 +138,6 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -141,10 +150,6 @@ module Imagekit sig { returns(String) } attr_accessor :name - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - sig { returns(Symbol) } attr_accessor :type @@ -176,6 +181,22 @@ module Imagekit sig { params(s3_force_path_style: T::Boolean).void } attr_writer :s3_force_path_style + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + sig do params( access_key: String, @@ -183,6 +204,7 @@ module Imagekit endpoint: String, name: String, secret_key: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -201,6 +223,9 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, # Whether to send a Canonical header. @@ -222,6 +247,7 @@ module Imagekit name: String, secret_key: String, type: Symbol, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -242,10 +268,6 @@ module Imagekit ) end - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - # S3 bucket name. sig { returns(String) } attr_accessor :bucket @@ -254,10 +276,6 @@ module Imagekit sig { returns(String) } attr_accessor :name - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - sig { returns(Symbol) } attr_accessor :type @@ -282,12 +300,29 @@ module Imagekit sig { params(prefix: String).void } attr_writer :prefix + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + sig do params( access_key: String, bucket: String, name: String, secret_key: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -303,6 +338,9 @@ module Imagekit name:, # Secret key for the bucket. secret_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, # Whether to send a Canonical header. @@ -321,6 +359,7 @@ module Imagekit name: String, secret_key: String, type: Symbol, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String @@ -372,10 +411,19 @@ module Imagekit sig { params(include_canonical_header: T::Boolean).void } attr_writer :include_canonical_header + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + sig do params( base_url: String, name: String, + id: String, base_url_for_canonical_header: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, @@ -387,6 +435,9 @@ module Imagekit base_url:, # Display name of the origin. name:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, # Forward the Host header to origin? @@ -403,6 +454,7 @@ module Imagekit base_url: String, name: String, type: Symbol, + id: String, base_url_for_canonical_header: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean @@ -443,9 +495,18 @@ module Imagekit sig { params(include_canonical_header: T::Boolean).void } attr_writer :include_canonical_header + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + sig do params( name: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, type: Symbol @@ -454,6 +515,9 @@ module Imagekit def self.new( # Display name of the origin. name:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, # Whether to send a Canonical header. @@ -467,6 +531,7 @@ module Imagekit { name: String, type: Symbol, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean } @@ -495,9 +560,6 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(String) } - attr_accessor :private_key - sig { returns(Symbol) } attr_accessor :type @@ -521,12 +583,24 @@ module Imagekit sig { params(prefix: String).void } attr_writer :prefix + sig { returns(String) } + attr_accessor :private_key + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + sig do params( bucket: String, client_email: String, name: String, private_key: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -539,6 +613,9 @@ module Imagekit # Display name of the origin. name:, private_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, # Whether to send a Canonical header. @@ -556,6 +633,7 @@ module Imagekit name: String, private_key: String, type: Symbol, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String @@ -585,9 +663,6 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(String) } - attr_accessor :sas_token - sig { returns(Symbol) } attr_accessor :type @@ -611,12 +686,24 @@ module Imagekit sig { params(prefix: String).void } attr_writer :prefix + sig { returns(String) } + attr_accessor :sas_token + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + sig do params( account_name: String, container: String, name: String, sas_token: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String, @@ -629,6 +716,9 @@ module Imagekit # Display name of the origin. name:, sas_token:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, # Whether to send a Canonical header. @@ -646,6 +736,7 @@ module Imagekit name: String, sas_token: String, type: Symbol, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, prefix: String @@ -669,29 +760,13 @@ module Imagekit sig { returns(String) } attr_accessor :base_url - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret - # Display name of the origin. sig { returns(String) } attr_accessor :name - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - sig { returns(Symbol) } attr_accessor :type - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - # URL used in the Canonical header (if enabled). sig { returns(T.nilable(String)) } attr_reader :base_url_for_canonical_header @@ -706,6 +781,30 @@ module Imagekit sig { params(include_canonical_header: T::Boolean).void } attr_writer :include_canonical_header + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + sig do params( base_url: String, @@ -714,6 +813,7 @@ module Imagekit name: String, password: String, username: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean, type: Symbol @@ -732,6 +832,9 @@ module Imagekit password:, # Akeneo API username. username:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, # Whether to send a Canonical header. @@ -750,6 +853,7 @@ module Imagekit password: String, type: Symbol, username: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: T::Boolean } diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index 95287046..8342e471 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -5,9 +5,7 @@ module Imagekit module Accounts OriginListResponse = T.let( - Imagekit::Internal::Type::ArrayOf[ - union: Imagekit::Accounts::OriginResponse - ], + Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::Origin], Imagekit::Internal::Type::Converter ) end diff --git a/rbi/imagekit/models/accounts/origin_response.rbi b/rbi/imagekit/models/accounts/origin_response.rbi deleted file mode 100644 index be9fc05f..00000000 --- a/rbi/imagekit/models/accounts/origin_response.rbi +++ /dev/null @@ -1,718 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - # Origin object as returned by the API (sensitive fields removed). - module OriginResponse - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::S3, - Imagekit::Accounts::OriginResponse::S3Compatible, - Imagekit::Accounts::OriginResponse::CloudinaryBackup, - Imagekit::Accounts::OriginResponse::WebFolder, - Imagekit::Accounts::OriginResponse::WebProxy, - Imagekit::Accounts::OriginResponse::Gcs, - Imagekit::Accounts::OriginResponse::AzureBlob, - Imagekit::Accounts::OriginResponse::AkeneoPim - ) - end - - class S3 < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::S3, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :S3 - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::S3Compatible, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - # Use path-style S3 URLs? - sig { returns(T::Boolean) } - attr_accessor :s3_force_path_style - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - endpoint: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - s3_force_path_style: T::Boolean, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Custom S3-compatible endpoint. - endpoint:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # Use path-style S3 URLs? - s3_force_path_style:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :S3_COMPATIBLE - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - s3_force_path_style: T::Boolean, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::CloudinaryBackup, - Imagekit::Internal::AnyHash - ) - end - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Path prefix inside the bucket. - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # S3 bucket name. - bucket:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # Path prefix inside the bucket. - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :CLOUDINARY_BACKUP - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::WebFolder, - Imagekit::Internal::AnyHash - ) - end - - # Root URL for the web folder origin. - sig { returns(String) } - attr_accessor :base_url - - # Forward the Host header to origin? - sig { returns(T::Boolean) } - attr_accessor :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Root URL for the web folder origin. - base_url:, - # Forward the Host header to origin? - forward_host_header_to_origin:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :WEB_FOLDER - ) - end - - sig do - override.returns( - { - id: String, - base_url: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::WebProxy, - Imagekit::Internal::AnyHash - ) - end - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :WEB_PROXY - ) - end - - sig do - override.returns( - { - id: String, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class Gcs < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::Gcs, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :bucket - - sig { returns(String) } - attr_accessor :client_email - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - bucket: String, - client_email: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - bucket:, - client_email:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :GCS - ) - end - - sig do - override.returns( - { - id: String, - bucket: String, - client_email: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::AzureBlob, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :prefix - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - account_name: String, - container: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - account_name:, - container:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - prefix:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :AZURE_BLOB - ) - end - - sig do - override.returns( - { - id: String, - account_name: String, - container: String, - include_canonical_header: T::Boolean, - name: String, - prefix: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginResponse::AkeneoPim, - Imagekit::Internal::AnyHash - ) - end - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Whether to send a Canonical header. - sig { returns(T::Boolean) } - attr_accessor :include_canonical_header - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - sig { returns(String) } - attr_accessor :id - - sig do - params( - id: String, - base_url: String, - include_canonical_header: T::Boolean, - name: String, - base_url_for_canonical_header: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id:, - # Akeneo instance base URL. - base_url:, - # Whether to send a Canonical header. - include_canonical_header:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - type: :AKENEO_PIM - ) - end - - sig do - override.returns( - { - id: String, - base_url: String, - include_canonical_header: T::Boolean, - name: String, - type: Symbol, - base_url_for_canonical_header: String - } - ) - end - def to_hash - end - end - - sig do - override.returns( - T::Array[Imagekit::Accounts::OriginResponse::Variants] - ) - end - def self.variants - end - end - end - end -end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index cf247dcd..de9da743 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -20,7 +20,7 @@ module Imagekit Imagekit::Accounts::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::OriginResponse::Variants) + ).returns(Imagekit::Accounts::Origin::Variants) end def create( # Schema for origin resources. @@ -46,7 +46,7 @@ module Imagekit Imagekit::Accounts::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::OriginResponse::Variants) + ).returns(Imagekit::Accounts::Origin::Variants) end def update( # Unique identifier for the origin. This is generated by ImageKit when you create @@ -62,7 +62,7 @@ module Imagekit # Returns an array of all configured origins for the current account. sig do params(request_options: Imagekit::RequestOptions::OrHash).returns( - T::Array[Imagekit::Accounts::OriginResponse::Variants] + T::Array[Imagekit::Accounts::Origin::Variants] ) end def list(request_options: {}) @@ -91,7 +91,7 @@ module Imagekit params( id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::OriginResponse::Variants) + ).returns(Imagekit::Accounts::Origin::Variants) end def get( # Unique identifier for the origin. This is generated by ImageKit when you create diff --git a/sig/imagekit/models/accounts/origin.rbs b/sig/imagekit/models/accounts/origin.rbs index ef0e09c2..a3fc97af 100644 --- a/sig/imagekit/models/accounts/origin.rbs +++ b/sig/imagekit/models/accounts/origin.rbs @@ -21,20 +21,17 @@ module Imagekit name: String, secret_key: String, type: :S3, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String } class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String attr_accessor name: String - attr_accessor secret_key: String - attr_accessor type: :S3 attr_reader base_url_for_canonical_header: String? @@ -49,11 +46,20 @@ module Imagekit def prefix=: (String) -> String + attr_accessor access_key: String + + attr_accessor secret_key: String + + attr_reader id: String? + + def id=: (String) -> String + def initialize: ( access_key: String, bucket: String, name: String, secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, ?include_canonical_header: bool, ?prefix: String, @@ -66,6 +72,7 @@ module Imagekit name: String, secret_key: String, type: :S3, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String @@ -80,6 +87,7 @@ module Imagekit name: String, secret_key: String, type: :S3_COMPATIBLE, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -87,16 +95,12 @@ module Imagekit } class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String attr_accessor endpoint: String attr_accessor name: String - attr_accessor secret_key: String - attr_accessor type: :S3_COMPATIBLE attr_reader base_url_for_canonical_header: String? @@ -115,12 +119,21 @@ module Imagekit def s3_force_path_style=: (bool) -> bool + attr_accessor access_key: String + + attr_accessor secret_key: String + + attr_reader id: String? + + def id=: (String) -> String + def initialize: ( access_key: String, bucket: String, endpoint: String, name: String, secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, ?include_canonical_header: bool, ?prefix: String, @@ -135,6 +148,7 @@ module Imagekit name: String, secret_key: String, type: :S3_COMPATIBLE, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String, @@ -149,20 +163,17 @@ module Imagekit name: String, secret_key: String, type: :CLOUDINARY_BACKUP, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - attr_accessor bucket: String attr_accessor name: String - attr_accessor secret_key: String - attr_accessor type: :CLOUDINARY_BACKUP attr_reader base_url_for_canonical_header: String? @@ -177,11 +188,20 @@ module Imagekit def prefix=: (String) -> String + attr_accessor access_key: String + + attr_accessor secret_key: String + + attr_reader id: String? + + def id=: (String) -> String + def initialize: ( access_key: String, bucket: String, name: String, secret_key: String, + ?id: String, ?base_url_for_canonical_header: String, ?include_canonical_header: bool, ?prefix: String, @@ -194,6 +214,7 @@ module Imagekit name: String, secret_key: String, type: :CLOUDINARY_BACKUP, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String @@ -205,6 +226,7 @@ module Imagekit base_url: String, name: String, type: :WEB_FOLDER, + id: String, base_url_for_canonical_header: String, forward_host_header_to_origin: bool, include_canonical_header: bool @@ -229,9 +251,14 @@ module Imagekit def include_canonical_header=: (bool) -> bool + attr_reader id: String? + + def id=: (String) -> String + def initialize: ( base_url: String, name: String, + ?id: String, ?base_url_for_canonical_header: String, ?forward_host_header_to_origin: bool, ?include_canonical_header: bool, @@ -242,6 +269,7 @@ module Imagekit base_url: String, name: String, type: :WEB_FOLDER, + id: String, base_url_for_canonical_header: String, forward_host_header_to_origin: bool, include_canonical_header: bool @@ -252,6 +280,7 @@ module Imagekit { name: String, type: :WEB_PROXY, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool } @@ -269,8 +298,13 @@ module Imagekit def include_canonical_header=: (bool) -> bool + attr_reader id: String? + + def id=: (String) -> String + def initialize: ( name: String, + ?id: String, ?base_url_for_canonical_header: String, ?include_canonical_header: bool, ?type: :WEB_PROXY @@ -279,6 +313,7 @@ module Imagekit def to_hash: -> { name: String, type: :WEB_PROXY, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool } @@ -291,6 +326,7 @@ module Imagekit name: String, private_key: String, type: :GCS, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String @@ -303,8 +339,6 @@ module Imagekit attr_accessor name: String - attr_accessor private_key: String - attr_accessor type: :GCS attr_reader base_url_for_canonical_header: String? @@ -319,11 +353,18 @@ module Imagekit def prefix=: (String) -> String + attr_accessor private_key: String + + attr_reader id: String? + + def id=: (String) -> String + def initialize: ( bucket: String, client_email: String, name: String, private_key: String, + ?id: String, ?base_url_for_canonical_header: String, ?include_canonical_header: bool, ?prefix: String, @@ -336,6 +377,7 @@ module Imagekit name: String, private_key: String, type: :GCS, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String @@ -349,6 +391,7 @@ module Imagekit name: String, sas_token: String, type: :AZURE_BLOB, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String @@ -361,8 +404,6 @@ module Imagekit attr_accessor name: String - attr_accessor sas_token: String - attr_accessor type: :AZURE_BLOB attr_reader base_url_for_canonical_header: String? @@ -377,11 +418,18 @@ module Imagekit def prefix=: (String) -> String + attr_accessor sas_token: String + + attr_reader id: String? + + def id=: (String) -> String + def initialize: ( account_name: String, container: String, name: String, sas_token: String, + ?id: String, ?base_url_for_canonical_header: String, ?include_canonical_header: bool, ?prefix: String, @@ -394,6 +442,7 @@ module Imagekit name: String, sas_token: String, type: :AZURE_BLOB, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool, prefix: String @@ -409,6 +458,7 @@ module Imagekit password: String, type: :AKENEO_PIM, username: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool } @@ -416,18 +466,10 @@ module Imagekit class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String - attr_accessor client_id: String - - attr_accessor client_secret: String - attr_accessor name: String - attr_accessor password: String - attr_accessor type: :AKENEO_PIM - attr_accessor username: String - attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String @@ -436,6 +478,18 @@ module Imagekit def include_canonical_header=: (bool) -> bool + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor password: String + + attr_accessor username: String + + attr_reader id: String? + + def id=: (String) -> String + def initialize: ( base_url: String, client_id: String, @@ -443,6 +497,7 @@ module Imagekit name: String, password: String, username: String, + ?id: String, ?base_url_for_canonical_header: String, ?include_canonical_header: bool, ?type: :AKENEO_PIM @@ -456,6 +511,7 @@ module Imagekit password: String, type: :AKENEO_PIM, username: String, + id: String, base_url_for_canonical_header: String, include_canonical_header: bool } diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index e689073a..f98dbf39 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -1,8 +1,7 @@ module Imagekit module Models module Accounts - type origin_list_response = - ::Array[Imagekit::Models::Accounts::origin_response] + type origin_list_response = ::Array[Imagekit::Models::Accounts::origin] OriginListResponse: Imagekit::Internal::Type::Converter end diff --git a/sig/imagekit/models/accounts/origin_response.rbs b/sig/imagekit/models/accounts/origin_response.rbs deleted file mode 100644 index bca52d65..00000000 --- a/sig/imagekit/models/accounts/origin_response.rbs +++ /dev/null @@ -1,418 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_response = - Imagekit::Accounts::OriginResponse::S3 - | Imagekit::Accounts::OriginResponse::S3Compatible - | Imagekit::Accounts::OriginResponse::CloudinaryBackup - | Imagekit::Accounts::OriginResponse::WebFolder - | Imagekit::Accounts::OriginResponse::WebProxy - | Imagekit::Accounts::OriginResponse::Gcs - | Imagekit::Accounts::OriginResponse::AzureBlob - | Imagekit::Accounts::OriginResponse::AkeneoPim - - module OriginResponse - extend Imagekit::Internal::Type::Union - - type s3 = - { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :S3, - base_url_for_canonical_header: String - } - - class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :S3 - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :S3 - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :S3, - base_url_for_canonical_header: String - } - end - - type s3_compatible = - { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - :s3_force_path_style => bool, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String - } - - class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor endpoint: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor s3_force_path_style: bool - - attr_accessor type: :S3_COMPATIBLE - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - s3_force_path_style: bool, - ?base_url_for_canonical_header: String, - ?type: :S3_COMPATIBLE - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - endpoint: String, - include_canonical_header: bool, - name: String, - prefix: String, - :s3_force_path_style => bool, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String - } - end - - type cloudinary_backup = - { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String - } - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :CLOUDINARY_BACKUP - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :CLOUDINARY_BACKUP - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String - } - end - - type web_folder = - { - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String - } - - class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor forward_host_header_to_origin: bool - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :WEB_FOLDER - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :WEB_FOLDER - ) -> void - - def to_hash: -> { - id: String, - base_url: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String - } - end - - type web_proxy = - { - id: String, - include_canonical_header: bool, - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String - } - - class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :WEB_PROXY - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :WEB_PROXY - ) -> void - - def to_hash: -> { - id: String, - include_canonical_header: bool, - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String - } - end - - type gcs = - { - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :GCS, - base_url_for_canonical_header: String - } - - class Gcs < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor client_email: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :GCS - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :GCS - ) -> void - - def to_hash: -> { - id: String, - bucket: String, - client_email: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :GCS, - base_url_for_canonical_header: String - } - end - - type azure_blob = - { - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String - } - - class AzureBlob < Imagekit::Internal::Type::BaseModel - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor prefix: String - - attr_accessor type: :AZURE_BLOB - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - ?base_url_for_canonical_header: String, - ?type: :AZURE_BLOB - ) -> void - - def to_hash: -> { - id: String, - account_name: String, - container: String, - include_canonical_header: bool, - name: String, - prefix: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String - } - end - - type akeneo_pim = - { - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String - } - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor include_canonical_header: bool - - attr_accessor name: String - - attr_accessor type: :AKENEO_PIM - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_accessor id: String - - def initialize: ( - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - ?base_url_for_canonical_header: String, - ?type: :AKENEO_PIM - ) -> void - - def to_hash: -> { - id: String, - base_url: String, - include_canonical_header: bool, - name: String, - type: :AKENEO_PIM, - base_url_for_canonical_header: String - } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_response] - end - end - end -end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index 4ffe3ae3..cf6619a0 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -5,13 +5,13 @@ module Imagekit def create: ( origin: Imagekit::Models::Accounts::origin, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_response + ) -> Imagekit::Models::Accounts::origin def update: ( String id, origin: Imagekit::Models::Accounts::origin, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_response + ) -> Imagekit::Models::Accounts::origin def list: ( ?request_options: Imagekit::request_opts @@ -22,7 +22,7 @@ module Imagekit def get: ( String id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_response + ) -> Imagekit::Models::Accounts::origin def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index 55df4efe..79724fbe 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -18,19 +18,19 @@ def test_create_required_params ) assert_pattern do - response => Imagekit::Accounts::OriginResponse + response => Imagekit::Accounts::Origin end assert_pattern do case response - in Imagekit::Accounts::OriginResponse::S3 - in Imagekit::Accounts::OriginResponse::S3Compatible - in Imagekit::Accounts::OriginResponse::CloudinaryBackup - in Imagekit::Accounts::OriginResponse::WebFolder - in Imagekit::Accounts::OriginResponse::WebProxy - in Imagekit::Accounts::OriginResponse::Gcs - in Imagekit::Accounts::OriginResponse::AzureBlob - in Imagekit::Accounts::OriginResponse::AkeneoPim + in Imagekit::Accounts::Origin::S3 + in Imagekit::Accounts::Origin::S3Compatible + in Imagekit::Accounts::Origin::CloudinaryBackup + in Imagekit::Accounts::Origin::WebFolder + in Imagekit::Accounts::Origin::WebProxy + in Imagekit::Accounts::Origin::Gcs + in Imagekit::Accounts::Origin::AzureBlob + in Imagekit::Accounts::Origin::AkeneoPim end end @@ -38,76 +38,88 @@ def test_create_required_params case response in { type: :S3, - id: String, + access_key: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :S3_COMPATIBLE, - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil, + s3_force_path_style: Imagekit::Internal::Type::Boolean | nil } in { type: :CLOUDINARY_BACKUP, - id: String, + access_key: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :WEB_FOLDER, - id: String, base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - base_url_for_canonical_header: String | nil + id: String | nil, + base_url_for_canonical_header: String | nil, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } in { type: :WEB_PROXY, - id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - base_url_for_canonical_header: String | nil + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } in { type: :GCS, - id: String, bucket: String, client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + private_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :AZURE_BLOB, - id: String, account_name: String, container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + sas_token: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :AKENEO_PIM, - id: String, base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + client_id: String, + client_secret: String, name: String, - base_url_for_canonical_header: String | nil + password: String, + username: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } end end @@ -129,19 +141,19 @@ def test_update_required_params ) assert_pattern do - response => Imagekit::Accounts::OriginResponse + response => Imagekit::Accounts::Origin end assert_pattern do case response - in Imagekit::Accounts::OriginResponse::S3 - in Imagekit::Accounts::OriginResponse::S3Compatible - in Imagekit::Accounts::OriginResponse::CloudinaryBackup - in Imagekit::Accounts::OriginResponse::WebFolder - in Imagekit::Accounts::OriginResponse::WebProxy - in Imagekit::Accounts::OriginResponse::Gcs - in Imagekit::Accounts::OriginResponse::AzureBlob - in Imagekit::Accounts::OriginResponse::AkeneoPim + in Imagekit::Accounts::Origin::S3 + in Imagekit::Accounts::Origin::S3Compatible + in Imagekit::Accounts::Origin::CloudinaryBackup + in Imagekit::Accounts::Origin::WebFolder + in Imagekit::Accounts::Origin::WebProxy + in Imagekit::Accounts::Origin::Gcs + in Imagekit::Accounts::Origin::AzureBlob + in Imagekit::Accounts::Origin::AkeneoPim end end @@ -149,76 +161,88 @@ def test_update_required_params case response in { type: :S3, - id: String, + access_key: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :S3_COMPATIBLE, - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil, + s3_force_path_style: Imagekit::Internal::Type::Boolean | nil } in { type: :CLOUDINARY_BACKUP, - id: String, + access_key: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :WEB_FOLDER, - id: String, base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - base_url_for_canonical_header: String | nil + id: String | nil, + base_url_for_canonical_header: String | nil, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } in { type: :WEB_PROXY, - id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - base_url_for_canonical_header: String | nil + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } in { type: :GCS, - id: String, bucket: String, client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + private_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :AZURE_BLOB, - id: String, account_name: String, container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + sas_token: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :AKENEO_PIM, - id: String, base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + client_id: String, + client_secret: String, name: String, - base_url_for_canonical_header: String | nil + password: String, + username: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } end end @@ -230,7 +254,7 @@ def test_list response = @image_kit.accounts.origins.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::OriginResponse]) + response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::Origin]) end end @@ -250,19 +274,19 @@ def test_get response = @image_kit.accounts.origins.get("id") assert_pattern do - response => Imagekit::Accounts::OriginResponse + response => Imagekit::Accounts::Origin end assert_pattern do case response - in Imagekit::Accounts::OriginResponse::S3 - in Imagekit::Accounts::OriginResponse::S3Compatible - in Imagekit::Accounts::OriginResponse::CloudinaryBackup - in Imagekit::Accounts::OriginResponse::WebFolder - in Imagekit::Accounts::OriginResponse::WebProxy - in Imagekit::Accounts::OriginResponse::Gcs - in Imagekit::Accounts::OriginResponse::AzureBlob - in Imagekit::Accounts::OriginResponse::AkeneoPim + in Imagekit::Accounts::Origin::S3 + in Imagekit::Accounts::Origin::S3Compatible + in Imagekit::Accounts::Origin::CloudinaryBackup + in Imagekit::Accounts::Origin::WebFolder + in Imagekit::Accounts::Origin::WebProxy + in Imagekit::Accounts::Origin::Gcs + in Imagekit::Accounts::Origin::AzureBlob + in Imagekit::Accounts::Origin::AkeneoPim end end @@ -270,76 +294,88 @@ def test_get case response in { type: :S3, - id: String, + access_key: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :S3_COMPATIBLE, - id: String, + access_key: String, bucket: String, endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil, + s3_force_path_style: Imagekit::Internal::Type::Boolean | nil } in { type: :CLOUDINARY_BACKUP, - id: String, + access_key: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + secret_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :WEB_FOLDER, - id: String, base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - base_url_for_canonical_header: String | nil + id: String | nil, + base_url_for_canonical_header: String | nil, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } in { type: :WEB_PROXY, - id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - base_url_for_canonical_header: String | nil + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } in { type: :GCS, - id: String, bucket: String, client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + private_key: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :AZURE_BLOB, - id: String, account_name: String, container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - prefix: String, - base_url_for_canonical_header: String | nil + sas_token: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil, + prefix: String | nil } in { type: :AKENEO_PIM, - id: String, base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + client_id: String, + client_secret: String, name: String, - base_url_for_canonical_header: String | nil + password: String, + username: String, + id: String | nil, + base_url_for_canonical_header: String | nil, + include_canonical_header: Imagekit::Internal::Type::Boolean | nil } end end From bbd97b7b994ba297d4fdeec4e9d705d89715f07c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:12:12 +0000 Subject: [PATCH 049/178] feat(api): manual updates --- .stats.yml | 6 +- lib/imagekit.rb | 2 +- lib/imagekit/internal/type/union.rb | 32 +- .../models/accounts/origin_create_params.rb | 550 +++++++++++- .../models/accounts/origin_list_response.rb | 2 +- .../{origin.rb => origin_response.rb} | 474 ++++------ .../models/accounts/origin_update_params.rb | 550 +++++++++++- lib/imagekit/resources/accounts/origins.rb | 20 +- .../models/accounts/origin_create_params.rbi | 825 +++++++++++++++++- .../models/accounts/origin_list_response.rbi | 4 +- .../{origin.rbi => origin_response.rbi} | 564 +++++------- .../models/accounts/origin_update_params.rbi | 825 +++++++++++++++++- rbi/imagekit/resources/accounts/origins.rbi | 44 +- .../models/accounts/origin_create_params.rbs | 478 +++++++++- .../models/accounts/origin_list_response.rbs | 3 +- .../{origin.rbs => origin_response.rbs} | 376 +++----- .../models/accounts/origin_update_params.rbs | 478 +++++++++- sig/imagekit/resources/accounts/origins.rbs | 10 +- .../resources/accounts/origins_test.rb | 278 +++--- 19 files changed, 4398 insertions(+), 1123 deletions(-) rename lib/imagekit/models/accounts/{origin.rb => origin_response.rb} (68%) rename rbi/imagekit/models/accounts/{origin.rbi => origin_response.rbi} (66%) rename sig/imagekit/models/accounts/{origin.rbs => origin_response.rbs} (54%) diff --git a/.stats.yml b/.stats.yml index 6ac1eba7..8a42af3a 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-554f897c7f0061bb1fe51cd82f5f05e66050db5e868524c374dac827bd7b8c3d.yml -openapi_spec_hash: 95b7298e7f3977ea6c98d9557d2c8d27 -config_hash: 49e367d7f33aeaf63ed738c1c0392d0a +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-fa82106bb6313906d2eaac167e0ca5f60f12a166c743c00a18c22be0e455c1b6.yml +openapi_spec_hash: 8ff6fc6886e8d7a9eee6d45d51e9673c +config_hash: 76b94bb341141f0e9b14cdbb1203b0fa diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 97518432..3e287ceb 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -50,7 +50,6 @@ require_relative "imagekit/internal/transport/base_client" require_relative "imagekit/internal/transport/pooled_net_requester" require_relative "imagekit/client" -require_relative "imagekit/models/accounts/origin" require_relative "imagekit/models/accounts/url_endpoint" require_relative "imagekit/models/file" require_relative "imagekit/models/accounts/origin_create_params" @@ -58,6 +57,7 @@ require_relative "imagekit/models/accounts/origin_get_params" require_relative "imagekit/models/accounts/origin_list_params" require_relative "imagekit/models/accounts/origin_list_response" +require_relative "imagekit/models/accounts/origin_response" require_relative "imagekit/models/accounts/origin_update_params" require_relative "imagekit/models/accounts/url_endpoint_create_params" require_relative "imagekit/models/accounts/url_endpoint_create_response" diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb index 25bab102..9bb05f86 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekit/internal/type/union.rb @@ -6,28 +6,28 @@ module Type # @api private # # @example - # # `origin` is a `Imagekit::Accounts::Origin` - # case origin - # when Imagekit::Accounts::Origin::S3 - # puts(origin.access_key) - # when Imagekit::Accounts::Origin::S3Compatible - # puts(origin.bucket) - # when Imagekit::Accounts::Origin::CloudinaryBackup - # puts(origin.name) + # # `origin_response` is a `Imagekit::Accounts::OriginResponse` + # case origin_response + # when Imagekit::Accounts::OriginResponse::S3 + # puts(origin_response.id) + # when Imagekit::Accounts::OriginResponse::S3Compatible + # puts(origin_response.bucket) + # when Imagekit::Accounts::OriginResponse::CloudinaryBackup + # puts(origin_response.include_canonical_header) # else - # puts(origin) + # puts(origin_response) # end # # @example - # case origin - # in {type: :S3, access_key: access_key, bucket: bucket, name: name} - # puts(access_key) - # in {type: :S3_COMPATIBLE, access_key: access_key, bucket: bucket, endpoint: endpoint} + # case origin_response + # in {type: :S3, id: id, bucket: bucket, include_canonical_header: include_canonical_header} + # puts(id) + # in {type: :S3_COMPATIBLE, id: id, bucket: bucket, endpoint: endpoint} # puts(bucket) - # in {type: :CLOUDINARY_BACKUP, access_key: access_key, bucket: bucket, name: name} - # puts(name) + # in {type: :CLOUDINARY_BACKUP, id: id, bucket: bucket, include_canonical_header: include_canonical_header} + # puts(include_canonical_header) # else - # puts(origin) + # puts(origin_response) # end module Union include Imagekit::Internal::Type::Converter diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index d3f005e4..326040f3 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -8,8 +8,556 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute origin + # Schema for origin request resources. + # + # @return [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] + required :origin, union: -> { Imagekit::Accounts::OriginCreateParams::Origin } + + # @!method initialize(origin:, request_options: {}) + # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin request resources. + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # Schema for origin request resources. + module Origin + extend Imagekit::Internal::Type::Union + + discriminator :type + + variant :S3, -> { Imagekit::Accounts::OriginCreateParams::Origin::S3 } + + variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible } + + variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup } + + variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginCreateParams::Origin::WebFolder } + + variant :WEB_PROXY, -> { Imagekit::Accounts::OriginCreateParams::Origin::WebProxy } + + variant :GCS, -> { Imagekit::Accounts::OriginCreateParams::Origin::Gcs } + + variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3] + required :type, const: :S3 + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :S3] + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, :S3_COMPATIBLE] + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :CLOUDINARY_BACKUP] + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. + # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_FOLDER] + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_PROXY] + end + + class Gcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute type + # + # @return [Symbol, :GCS] + required :type, const: :GCS + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @param bucket [String] + # + # @param client_email [String] + # + # @param name [String] Display name of the origin. + # + # @param private_key [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :GCS] + end + + class AzureBlob < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute type + # + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @param account_name [String] + # + # @param container [String] + # + # @param name [String] Display name of the origin. + # + # @param sas_token [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :AZURE_BLOB] + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute type + # + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + # @param base_url [String] Akeneo instance base URL. + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param name [String] Display name of the origin. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :AKENEO_PIM] + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim)] + end end end end diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb index 193c027b..8f9e9da8 100644 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ b/lib/imagekit/models/accounts/origin_list_response.rb @@ -4,7 +4,7 @@ module Imagekit module Models module Accounts # @type [Imagekit::Internal::Type::Converter] - OriginListResponse = Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Accounts::Origin }] + OriginListResponse = Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Accounts::OriginResponse }] end end end diff --git a/lib/imagekit/models/accounts/origin.rb b/lib/imagekit/models/accounts/origin_response.rb similarity index 68% rename from lib/imagekit/models/accounts/origin.rb rename to lib/imagekit/models/accounts/origin_response.rb index f35d1f9f..aa9aea71 100644 --- a/lib/imagekit/models/accounts/origin.rb +++ b/lib/imagekit/models/accounts/origin_response.rb @@ -3,29 +3,29 @@ module Imagekit module Models module Accounts - # Schema for origin resources. + # Origin object as returned by the API (sensitive fields removed). # # @see Imagekit::Resources::Accounts::Origins#create - module Origin + module OriginResponse extend Imagekit::Internal::Type::Union discriminator :type - variant :S3, -> { Imagekit::Accounts::Origin::S3 } + variant :S3, -> { Imagekit::Accounts::OriginResponse::S3 } - variant :S3_COMPATIBLE, -> { Imagekit::Accounts::Origin::S3Compatible } + variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginResponse::S3Compatible } - variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::Origin::CloudinaryBackup } + variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginResponse::CloudinaryBackup } - variant :WEB_FOLDER, -> { Imagekit::Accounts::Origin::WebFolder } + variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginResponse::WebFolder } - variant :WEB_PROXY, -> { Imagekit::Accounts::Origin::WebProxy } + variant :WEB_PROXY, -> { Imagekit::Accounts::OriginResponse::WebProxy } - variant :GCS, -> { Imagekit::Accounts::Origin::Gcs } + variant :GCS, -> { Imagekit::Accounts::OriginResponse::Gcs } - variant :AZURE_BLOB, -> { Imagekit::Accounts::Origin::AzureBlob } + variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginResponse::AzureBlob } - variant :AKENEO_PIM, -> { Imagekit::Accounts::Origin::AkeneoPim } + variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginResponse::AkeneoPim } class S3 < Imagekit::Internal::Type::BaseModel # @!attribute bucket @@ -34,12 +34,26 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String] + required :prefix, String + # @!attribute type # # @return [Symbol, :S3] @@ -51,63 +65,31 @@ class S3 < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - request_only do - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - end - response_only do # @!attribute id # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::Origin::S3} for more details. + # {Imagekit::Models::Accounts::OriginResponse::S3} for more details. # - # @param access_key [String] Access key for the bucket. + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :S3] end @@ -124,12 +106,32 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String] required :endpoint, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String] + required :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean] + required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + # @!attribute type # # @return [Symbol, :S3_COMPATIBLE] @@ -141,73 +143,35 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - request_only do - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - end - response_only do # @!attribute id # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::Origin::S3Compatible} for more details. + # {Imagekit::Models::Accounts::OriginResponse::S3Compatible} for more details. # - # @param access_key [String] Access key for the bucket. + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # # @param endpoint [String] Custom S3-compatible endpoint. # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # # @param prefix [String] Path prefix inside the bucket. # # @param s3_force_path_style [Boolean] Use path-style S3 URLs? # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :S3_COMPATIBLE] end @@ -218,12 +182,26 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String] required :bucket, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String] + required :prefix, String + # @!attribute type # # @return [Symbol, :CLOUDINARY_BACKUP] @@ -235,63 +213,31 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - request_only do - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - end - response_only do # @!attribute id # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(access_key:, bucket:, name:, secret_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::Origin::CloudinaryBackup} for more details. + # {Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup} for more details. # - # @param access_key [String] Access key for the bucket. + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] S3 bucket name. # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param secret_key [String] Secret key for the bucket. + # @param name [String] Display name of the origin. # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @param prefix [String] Path prefix inside the bucket. # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # # @param type [Symbol, :CLOUDINARY_BACKUP] end @@ -302,6 +248,22 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean] + required :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -319,51 +281,43 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, name:, id: nil, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::Origin::WebFolder} for more details. - # - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. + # {Imagekit::Models::Accounts::OriginResponse::WebFolder} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # @param base_url [String] Root URL for the web folder origin. # # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_FOLDER] end class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -381,35 +335,27 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - response_only do # @!attribute id # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(name:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::Origin::WebProxy} for more details. - # - # @param name [String] Display name of the origin. + # {Imagekit::Models::Accounts::OriginResponse::WebProxy} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # # @param include_canonical_header [Boolean] Whether to send a Canonical header. # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # # @param type [Symbol, :WEB_PROXY] end @@ -424,12 +370,25 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String] required :client_email, String, api_name: :clientEmail + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String + # @!attribute prefix + # + # @return [String] + required :prefix, String + # @!attribute type # # @return [Symbol, :GCS] @@ -441,55 +400,33 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - request_only do - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey - end - response_only do # @!attribute id # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(bucket:, client_email:, name:, private_key:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::Origin::Gcs} for more details. + # {Imagekit::Models::Accounts::OriginResponse::Gcs} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param bucket [String] # # @param client_email [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param private_key [String] + # @param name [String] Display name of the origin. # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :GCS] end @@ -504,12 +441,25 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String] required :container, String + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # # @return [String] required :name, String + # @!attribute prefix + # + # @return [String] + required :prefix, String + # @!attribute type # # @return [Symbol, :AZURE_BLOB] @@ -521,55 +471,33 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - request_only do - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken - end - response_only do # @!attribute id # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(account_name:, container:, name:, sas_token:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::Origin::AzureBlob} for more details. + # {Imagekit::Models::Accounts::OriginResponse::AzureBlob} for more details. + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # # @param account_name [String] # # @param container [String] # - # @param name [String] Display name of the origin. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # - # @param sas_token [String] + # @param name [String] Display name of the origin. # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # @param prefix [String] # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # # @param type [Symbol, :AZURE_BLOB] end @@ -580,6 +508,14 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String] required :base_url, String, api_name: :baseUrl + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean] + required :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + # @!attribute name # Display name of the origin. # @@ -597,76 +533,34 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - request_only do - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret - - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - end - response_only do # @!attribute id # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String end - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, id: nil, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::Origin::AkeneoPim} for more details. + # {Imagekit::Models::Accounts::OriginResponse::AkeneoPim} for more details. # - # @param base_url [String] Akeneo instance base URL. + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param client_id [String] Akeneo API client ID. + # @param base_url [String] Akeneo instance base URL. # - # @param client_secret [String] Akeneo API client secret. + # @param include_canonical_header [Boolean] Whether to send a Canonical header. # # @param name [String] Display name of the origin. # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # # @param type [Symbol, :AKENEO_PIM] end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim)] + # @return [Array(Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index d97a3cc0..0d935d6b 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -8,8 +8,556 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute origin + # Schema for origin request resources. + # + # @return [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] + required :origin, union: -> { Imagekit::Accounts::OriginUpdateParams::Origin } + + # @!method initialize(origin:, request_options: {}) + # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin request resources. + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + + # Schema for origin request resources. + module Origin + extend Imagekit::Internal::Type::Union + + discriminator :type + + variant :S3, -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3 } + + variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible } + + variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup } + + variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder } + + variant :WEB_PROXY, -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy } + + variant :GCS, -> { Imagekit::Accounts::OriginUpdateParams::Origin::Gcs } + + variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3] + required :type, const: :S3 + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :S3] + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, :S3_COMPATIBLE] + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :CLOUDINARY_BACKUP] + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. + # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_FOLDER] + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_PROXY] + end + + class Gcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute type + # + # @return [Symbol, :GCS] + required :type, const: :GCS + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @param bucket [String] + # + # @param client_email [String] + # + # @param name [String] Display name of the origin. + # + # @param private_key [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :GCS] + end + + class AzureBlob < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute type + # + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @param account_name [String] + # + # @param container [String] + # + # @param name [String] Display name of the origin. + # + # @param sas_token [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :AZURE_BLOB] + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute type + # + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + # @param base_url [String] Akeneo instance base URL. + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param name [String] Display name of the origin. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :AKENEO_PIM] + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim)] + end end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index 15db549c..3318b038 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -9,11 +9,11 @@ class Origins # # @overload create(origin:, request_options: {}) # - # @param origin [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] Schema for origin resources. + # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin request resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginCreateParams def create(params) @@ -22,7 +22,7 @@ def create(params) method: :post, path: "v1/accounts/origins", body: parsed[:origin], - model: Imagekit::Accounts::Origin, + model: Imagekit::Accounts::OriginResponse, options: options ) end @@ -37,11 +37,11 @@ def create(params) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param origin [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] Schema for origin resources. + # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin request resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginUpdateParams def update(id, params) @@ -50,7 +50,7 @@ def update(id, params) method: :put, path: ["v1/accounts/origins/%1$s", id], body: parsed[:origin], - model: Imagekit::Accounts::Origin, + model: Imagekit::Accounts::OriginResponse, options: options ) end @@ -62,14 +62,14 @@ def update(id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::Accounts::OriginListParams def list(params = {}) @client.request( method: :get, path: "v1/accounts/origins", - model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::Origin], + model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::OriginResponse], options: params[:request_options] ) end @@ -111,14 +111,14 @@ def delete(id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::Origin::S3, Imagekit::Models::Accounts::Origin::S3Compatible, Imagekit::Models::Accounts::Origin::CloudinaryBackup, Imagekit::Models::Accounts::Origin::WebFolder, Imagekit::Models::Accounts::Origin::WebProxy, Imagekit::Models::Accounts::Origin::Gcs, Imagekit::Models::Accounts::Origin::AzureBlob, Imagekit::Models::Accounts::Origin::AkeneoPim] + # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] # # @see Imagekit::Models::Accounts::OriginGetParams def get(id, params = {}) @client.request( method: :get, path: ["v1/accounts/origins/%1$s", id], - model: Imagekit::Accounts::Origin, + model: Imagekit::Accounts::OriginResponse, options: params[:request_options] ) end diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index f53d55e5..287a128c 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -15,17 +15,834 @@ module Imagekit ) end + # Schema for origin request resources. sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class + returns( + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim + ) ) end - def self.new(request_options: {}) + attr_accessor :origin + + sig do + params( + origin: + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for origin request resources. + origin:, + request_options: {} + ) end - sig { override.returns({ request_options: Imagekit::RequestOptions }) } + sig do + override.returns( + { + origin: + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim + ), + request_options: Imagekit::RequestOptions + } + ) + end def to_hash end + + # Schema for origin request resources. + module Origin + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :S3 + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig do + params( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + type: :S3_COMPATIBLE + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean + } + ) + end + def to_hash + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :CLOUDINARY_BACKUP + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(String) } + attr_accessor :base_url + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + name: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Root URL for the web folder origin. + base_url:, + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_FOLDER + ) + end + + sig do + override.returns( + { + base_url: String, + name: String, + type: Symbol, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + name: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_PROXY + ) + end + + sig do + override.returns( + { + name: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class Gcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::Gcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + bucket: String, + client_email: String, + name: String, + private_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + bucket:, + client_email:, + # Display name of the origin. + name:, + private_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :GCS + ) + end + + sig do + override.returns( + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AzureBlob < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :sas_token + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + account_name: String, + container: String, + name: String, + sas_token: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + account_name:, + container:, + # Display name of the origin. + name:, + sas_token:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :AZURE_BLOB + ) + end + + sig do + override.returns( + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + sig { returns(Symbol) } + attr_accessor :type + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Akeneo instance base URL. + base_url:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Display name of the origin. + name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :AKENEO_PIM + ) + end + + sig do + override.returns( + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: Symbol, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + sig do + override.returns( + T::Array[Imagekit::Accounts::OriginCreateParams::Origin::Variants] + ) + end + def self.variants + end + end end end end diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi index 8342e471..95287046 100644 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ b/rbi/imagekit/models/accounts/origin_list_response.rbi @@ -5,7 +5,9 @@ module Imagekit module Accounts OriginListResponse = T.let( - Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::Origin], + Imagekit::Internal::Type::ArrayOf[ + union: Imagekit::Accounts::OriginResponse + ], Imagekit::Internal::Type::Converter ) end diff --git a/rbi/imagekit/models/accounts/origin.rbi b/rbi/imagekit/models/accounts/origin_response.rbi similarity index 66% rename from rbi/imagekit/models/accounts/origin.rbi rename to rbi/imagekit/models/accounts/origin_response.rbi index 5442050d..be9fc05f 100644 --- a/rbi/imagekit/models/accounts/origin.rbi +++ b/rbi/imagekit/models/accounts/origin_response.rbi @@ -3,38 +3,49 @@ module Imagekit module Models module Accounts - # Schema for origin resources. - module Origin + # Origin object as returned by the API (sensitive fields removed). + module OriginResponse extend Imagekit::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::Accounts::Origin::S3, - Imagekit::Accounts::Origin::S3Compatible, - Imagekit::Accounts::Origin::CloudinaryBackup, - Imagekit::Accounts::Origin::WebFolder, - Imagekit::Accounts::Origin::WebProxy, - Imagekit::Accounts::Origin::Gcs, - Imagekit::Accounts::Origin::AzureBlob, - Imagekit::Accounts::Origin::AkeneoPim + Imagekit::Accounts::OriginResponse::S3, + Imagekit::Accounts::OriginResponse::S3Compatible, + Imagekit::Accounts::OriginResponse::CloudinaryBackup, + Imagekit::Accounts::OriginResponse::WebFolder, + Imagekit::Accounts::OriginResponse::WebProxy, + Imagekit::Accounts::OriginResponse::Gcs, + Imagekit::Accounts::OriginResponse::AzureBlob, + Imagekit::Accounts::OriginResponse::AkeneoPim ) end class S3 < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::Accounts::Origin::S3, Imagekit::Internal::AnyHash) + T.any( + Imagekit::Accounts::OriginResponse::S3, + Imagekit::Internal::AnyHash + ) end # S3 bucket name. sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name + # Path prefix inside the bucket. + sig { returns(String) } + attr_accessor :prefix + sig { returns(Symbol) } attr_accessor :type @@ -45,67 +56,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :S3 ) end @@ -113,15 +93,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -133,7 +111,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::Origin::S3Compatible, + Imagekit::Accounts::OriginResponse::S3Compatible, Imagekit::Internal::AnyHash ) end @@ -146,10 +124,22 @@ module Imagekit sig { returns(String) } attr_accessor :endpoint + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name + # Path prefix inside the bucket. + sig { returns(String) } + attr_accessor :prefix + + # Use path-style S3 URLs? + sig { returns(T::Boolean) } + attr_accessor :s3_force_path_style + sig { returns(Symbol) } attr_accessor :type @@ -160,80 +150,42 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, s3_force_path_style: T::Boolean, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, # Custom S3-compatible endpoint. endpoint:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id: nil, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, # Path prefix inside the bucket. - prefix: nil, + prefix:, # Use path-style S3 URLs? - s3_force_path_style: nil, + s3_force_path_style:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, type: :S3_COMPATIBLE ) end @@ -241,17 +193,15 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: Symbol, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, - s3_force_path_style: T::Boolean + s3_force_path_style: T::Boolean, + type: Symbol, + base_url_for_canonical_header: String } ) end @@ -263,7 +213,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Internal::AnyHash ) end @@ -272,10 +222,18 @@ module Imagekit sig { returns(String) } attr_accessor :bucket + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name + # Path prefix inside the bucket. + sig { returns(String) } + attr_accessor :prefix + sig { returns(Symbol) } attr_accessor :type @@ -286,67 +244,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id sig do params( - access_key: String, - bucket: String, - name: String, - secret_key: String, id: String, - base_url_for_canonical_header: String, + bucket: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Access key for the bucket. - access_key:, + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # S3 bucket name. bucket:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Secret key for the bucket. - secret_key:, - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id: nil, + # Path prefix inside the bucket. + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, type: :CLOUDINARY_BACKUP ) end @@ -354,15 +281,13 @@ module Imagekit sig do override.returns( { - access_key: String, + id: String, bucket: String, + include_canonical_header: T::Boolean, name: String, - secret_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -374,7 +299,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::Origin::WebFolder, + Imagekit::Accounts::OriginResponse::WebFolder, Imagekit::Internal::AnyHash ) end @@ -383,6 +308,14 @@ module Imagekit sig { returns(String) } attr_accessor :base_url + # Forward the Host header to origin? + sig { returns(T::Boolean) } + attr_accessor :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -397,53 +330,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id sig do params( - base_url: String, - name: String, id: String, - base_url_for_canonical_header: String, + base_url: String, forward_host_header_to_origin: T::Boolean, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Root URL for the web folder origin. base_url:, + # Forward the Host header to origin? + forward_host_header_to_origin:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_FOLDER ) end @@ -451,13 +367,13 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -469,11 +385,15 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::Origin::WebProxy, + Imagekit::Accounts::OriginResponse::WebProxy, Imagekit::Internal::AnyHash ) end + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -488,40 +408,30 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id sig do params( - name: String, id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( - # Display name of the origin. - name:, # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - id: nil, + id:, + # Whether to send a Canonical header. + include_canonical_header:, + # Display name of the origin. + name:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :WEB_PROXY ) end @@ -529,11 +439,11 @@ module Imagekit sig do override.returns( { + id: String, + include_canonical_header: T::Boolean, name: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -545,7 +455,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::Origin::Gcs, + Imagekit::Accounts::OriginResponse::Gcs, Imagekit::Internal::AnyHash ) end @@ -556,10 +466,17 @@ module Imagekit sig { returns(String) } attr_accessor :client_email + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name + sig { returns(String) } + attr_accessor :prefix + sig { returns(Symbol) } attr_accessor :type @@ -570,57 +487,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(String) } - attr_accessor :private_key - # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id sig do params( + id: String, bucket: String, client_email: String, - name: String, - private_key: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, bucket:, client_email:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - private_key:, - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :GCS ) end @@ -628,15 +524,14 @@ module Imagekit sig do override.returns( { + id: String, bucket: String, client_email: String, + include_canonical_header: T::Boolean, name: String, - private_key: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -648,7 +543,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::Origin::AzureBlob, + Imagekit::Accounts::OriginResponse::AzureBlob, Imagekit::Internal::AnyHash ) end @@ -659,10 +554,17 @@ module Imagekit sig { returns(String) } attr_accessor :container + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name + sig { returns(String) } + attr_accessor :prefix + sig { returns(Symbol) } attr_accessor :type @@ -673,57 +575,36 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig { returns(String) } - attr_accessor :sas_token - # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id sig do params( + id: String, account_name: String, container: String, - name: String, - sas_token: String, - id: String, - base_url_for_canonical_header: String, include_canonical_header: T::Boolean, + name: String, prefix: String, + base_url_for_canonical_header: String, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, account_name:, container:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - sas_token:, - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id: nil, + prefix:, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, type: :AZURE_BLOB ) end @@ -731,15 +612,14 @@ module Imagekit sig do override.returns( { + id: String, account_name: String, container: String, + include_canonical_header: T::Boolean, name: String, - sas_token: String, + prefix: String, type: Symbol, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String + base_url_for_canonical_header: String } ) end @@ -751,7 +631,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::Origin::AkeneoPim, + Imagekit::Accounts::OriginResponse::AkeneoPim, Imagekit::Internal::AnyHash ) end @@ -760,6 +640,10 @@ module Imagekit sig { returns(String) } attr_accessor :base_url + # Whether to send a Canonical header. + sig { returns(T::Boolean) } + attr_accessor :include_canonical_header + # Display name of the origin. sig { returns(String) } attr_accessor :name @@ -774,71 +658,33 @@ module Imagekit sig { params(base_url_for_canonical_header: String).void } attr_writer :base_url_for_canonical_header - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret - - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id sig do params( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, - username: String, - id: String, base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, type: Symbol ).returns(T.attached_class) end def self.new( + # Unique identifier for the origin. This is generated by ImageKit when you create + # a new origin. + id:, # Akeneo instance base URL. base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, + # Whether to send a Canonical header. + include_canonical_header:, # Display name of the origin. name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # Unique identifier for the origin. This is generated by ImageKit when you create - # a new origin. - id: nil, # URL used in the Canonical header (if enabled). base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, type: :AKENEO_PIM ) end @@ -846,16 +692,12 @@ module Imagekit sig do override.returns( { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: T::Boolean, name: String, - password: String, type: Symbol, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean + base_url_for_canonical_header: String } ) end @@ -863,7 +705,11 @@ module Imagekit end end - sig { override.returns(T::Array[Imagekit::Accounts::Origin::Variants]) } + sig do + override.returns( + T::Array[Imagekit::Accounts::OriginResponse::Variants] + ) + end def self.variants end end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index 51783397..6ae17c3d 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -15,17 +15,834 @@ module Imagekit ) end + # Schema for origin request resources. sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class + returns( + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim + ) ) end - def self.new(request_options: {}) + attr_accessor :origin + + sig do + params( + origin: + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for origin request resources. + origin:, + request_options: {} + ) end - sig { override.returns({ request_options: Imagekit::RequestOptions }) } + sig do + override.returns( + { + origin: + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim + ), + request_options: Imagekit::RequestOptions + } + ) + end def to_hash end + + # Schema for origin request resources. + module Origin + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :S3 + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig do + params( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + type: :S3_COMPATIBLE + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean + } + ) + end + def to_hash + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :CLOUDINARY_BACKUP + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(String) } + attr_accessor :base_url + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + name: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Root URL for the web folder origin. + base_url:, + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_FOLDER + ) + end + + sig do + override.returns( + { + base_url: String, + name: String, + type: Symbol, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + name: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_PROXY + ) + end + + sig do + override.returns( + { + name: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class Gcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + bucket: String, + client_email: String, + name: String, + private_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + bucket:, + client_email:, + # Display name of the origin. + name:, + private_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :GCS + ) + end + + sig do + override.returns( + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AzureBlob < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :sas_token + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + account_name: String, + container: String, + name: String, + sas_token: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + account_name:, + container:, + # Display name of the origin. + name:, + sas_token:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :AZURE_BLOB + ) + end + + sig do + override.returns( + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + sig { returns(Symbol) } + attr_accessor :type + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Akeneo instance base URL. + base_url:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Display name of the origin. + name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :AKENEO_PIM + ) + end + + sig do + override.returns( + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: Symbol, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + sig do + override.returns( + T::Array[Imagekit::Accounts::OriginUpdateParams::Origin::Variants] + ) + end + def self.variants + end + end end end end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index de9da743..8dd8af5d 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -10,20 +10,20 @@ module Imagekit params( origin: T.any( - Imagekit::Accounts::Origin::S3::OrHash, - Imagekit::Accounts::Origin::S3Compatible::OrHash, - Imagekit::Accounts::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::Origin::WebFolder::OrHash, - Imagekit::Accounts::Origin::WebProxy::OrHash, - Imagekit::Accounts::Origin::Gcs::OrHash, - Imagekit::Accounts::Origin::AzureBlob::OrHash, - Imagekit::Accounts::Origin::AkeneoPim::OrHash + Imagekit::Accounts::OriginCreateParams::Origin::S3::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::Gcs::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob::OrHash, + Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::Origin::Variants) + ).returns(Imagekit::Accounts::OriginResponse::Variants) end def create( - # Schema for origin resources. + # Schema for origin request resources. origin:, request_options: {} ) @@ -36,23 +36,23 @@ module Imagekit id: String, origin: T.any( - Imagekit::Accounts::Origin::S3::OrHash, - Imagekit::Accounts::Origin::S3Compatible::OrHash, - Imagekit::Accounts::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::Origin::WebFolder::OrHash, - Imagekit::Accounts::Origin::WebProxy::OrHash, - Imagekit::Accounts::Origin::Gcs::OrHash, - Imagekit::Accounts::Origin::AzureBlob::OrHash, - Imagekit::Accounts::Origin::AkeneoPim::OrHash + Imagekit::Accounts::OriginUpdateParams::Origin::S3::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::Gcs::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob::OrHash, + Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::Origin::Variants) + ).returns(Imagekit::Accounts::OriginResponse::Variants) end def update( # Unique identifier for the origin. This is generated by ImageKit when you create # a new origin. id, - # Schema for origin resources. + # Schema for origin request resources. origin:, request_options: {} ) @@ -62,7 +62,7 @@ module Imagekit # Returns an array of all configured origins for the current account. sig do params(request_options: Imagekit::RequestOptions::OrHash).returns( - T::Array[Imagekit::Accounts::Origin::Variants] + T::Array[Imagekit::Accounts::OriginResponse::Variants] ) end def list(request_options: {}) @@ -91,7 +91,7 @@ module Imagekit params( id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::Origin::Variants) + ).returns(Imagekit::Accounts::OriginResponse::Variants) end def get( # Unique identifier for the origin. This is generated by ImageKit when you create diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index 60ad3272..83e146cf 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -2,15 +2,487 @@ module Imagekit module Models module Accounts type origin_create_params = - { } & Imagekit::Internal::Type::request_parameters + { origin: Imagekit::Models::Accounts::OriginCreateParams::origin } + & Imagekit::Internal::Type::request_parameters class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - def initialize: (?request_options: Imagekit::request_opts) -> void + attr_accessor origin: Imagekit::Models::Accounts::OriginCreateParams::origin - def to_hash: -> { request_options: Imagekit::RequestOptions } + def initialize: ( + origin: Imagekit::Models::Accounts::OriginCreateParams::origin, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + origin: Imagekit::Models::Accounts::OriginCreateParams::origin, + request_options: Imagekit::RequestOptions + } + + type origin = + Imagekit::Accounts::OriginCreateParams::Origin::S3 + | Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible + | Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup + | Imagekit::Accounts::OriginCreateParams::Origin::WebFolder + | Imagekit::Accounts::OriginCreateParams::Origin::WebProxy + | Imagekit::Accounts::OriginCreateParams::Origin::Gcs + | Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob + | Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim + + module Origin + extend Imagekit::Internal::Type::Union + + type s3 = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3 + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :S3 + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type s3_compatible = + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3_COMPATIBLE + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + def initialize: ( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?type: :S3_COMPATIBLE + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + end + + type cloudinary_backup = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :CLOUDINARY_BACKUP + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :CLOUDINARY_BACKUP + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type web_folder = + { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor name: String + + attr_accessor type: :WEB_FOLDER + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + name: String, + ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, + ?type: :WEB_FOLDER + ) -> void + + def to_hash: -> { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + end + + type web_proxy = + { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor type: :WEB_PROXY + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + name: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :WEB_PROXY + ) -> void + + def to_hash: -> { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + type gcs = + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class Gcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor name: String + + attr_accessor private_key: String + + attr_accessor type: :GCS + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + bucket: String, + client_email: String, + name: String, + private_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :GCS + ) -> void + + def to_hash: -> { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type azure_blob = + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class AzureBlob < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor name: String + + attr_accessor sas_token: String + + attr_accessor type: :AZURE_BLOB + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + account_name: String, + container: String, + name: String, + sas_token: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :AZURE_BLOB + ) -> void + + def to_hash: -> { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type akeneo_pim = + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor name: String + + attr_accessor password: String + + attr_accessor type: :AKENEO_PIM + + attr_accessor username: String + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :AKENEO_PIM + ) -> void + + def to_hash: -> { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::OriginCreateParams::origin] + end end end end diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs index f98dbf39..e689073a 100644 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ b/sig/imagekit/models/accounts/origin_list_response.rbs @@ -1,7 +1,8 @@ module Imagekit module Models module Accounts - type origin_list_response = ::Array[Imagekit::Models::Accounts::origin] + type origin_list_response = + ::Array[Imagekit::Models::Accounts::origin_response] OriginListResponse: Imagekit::Internal::Type::Converter end diff --git a/sig/imagekit/models/accounts/origin.rbs b/sig/imagekit/models/accounts/origin_response.rbs similarity index 54% rename from sig/imagekit/models/accounts/origin.rbs rename to sig/imagekit/models/accounts/origin_response.rbs index a3fc97af..bca52d65 100644 --- a/sig/imagekit/models/accounts/origin.rbs +++ b/sig/imagekit/models/accounts/origin_response.rbs @@ -1,97 +1,79 @@ module Imagekit module Models module Accounts - type origin = - Imagekit::Accounts::Origin::S3 - | Imagekit::Accounts::Origin::S3Compatible - | Imagekit::Accounts::Origin::CloudinaryBackup - | Imagekit::Accounts::Origin::WebFolder - | Imagekit::Accounts::Origin::WebProxy - | Imagekit::Accounts::Origin::Gcs - | Imagekit::Accounts::Origin::AzureBlob - | Imagekit::Accounts::Origin::AkeneoPim - - module Origin + type origin_response = + Imagekit::Accounts::OriginResponse::S3 + | Imagekit::Accounts::OriginResponse::S3Compatible + | Imagekit::Accounts::OriginResponse::CloudinaryBackup + | Imagekit::Accounts::OriginResponse::WebFolder + | Imagekit::Accounts::OriginResponse::WebProxy + | Imagekit::Accounts::OriginResponse::Gcs + | Imagekit::Accounts::OriginResponse::AzureBlob + | Imagekit::Accounts::OriginResponse::AkeneoPim + + module OriginResponse extend Imagekit::Internal::Type::Union type s3 = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class S3 < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String + attr_accessor prefix: String + attr_accessor type: :S3 attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_accessor access_key: String - - attr_accessor secret_key: String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :S3 ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :S3, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type s3_compatible = { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } class S3Compatible < Imagekit::Internal::Type::BaseModel @@ -99,142 +81,114 @@ module Imagekit attr_accessor endpoint: String + attr_accessor include_canonical_header: bool + attr_accessor name: String + attr_accessor prefix: String + + attr_accessor s3_force_path_style: bool + attr_accessor type: :S3_COMPATIBLE attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - attr_accessor access_key: String - - attr_accessor secret_key: String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, endpoint: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, + s3_force_path_style: bool, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, ?type: :S3_COMPATIBLE ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - id: String, - base_url_for_canonical_header: String, include_canonical_header: bool, + name: String, prefix: String, - :s3_force_path_style => bool + :s3_force_path_style => bool, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String } end type cloudinary_backup = { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class CloudinaryBackup < Imagekit::Internal::Type::BaseModel attr_accessor bucket: String + attr_accessor include_canonical_header: bool + attr_accessor name: String + attr_accessor prefix: String + attr_accessor type: :CLOUDINARY_BACKUP attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_accessor access_key: String - - attr_accessor secret_key: String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :CLOUDINARY_BACKUP ) -> void def to_hash: -> { - access_key: String, + id: String, bucket: String, + include_canonical_header: bool, name: String, - secret_key: String, + prefix: String, type: :CLOUDINARY_BACKUP, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type web_folder = { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebFolder < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String + attr_accessor forward_host_header_to_origin: bool + + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_FOLDER @@ -243,49 +197,41 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, ?type: :WEB_FOLDER ) -> void def to_hash: -> { + id: String, base_url: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool, name: String, type: :WEB_FOLDER, - id: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool + base_url_for_canonical_header: String } end type web_proxy = { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -294,42 +240,35 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, + include_canonical_header: bool, name: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :WEB_PROXY ) -> void def to_hash: -> { + id: String, + include_canonical_header: bool, name: String, type: :WEB_PROXY, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end type gcs = { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class Gcs < Imagekit::Internal::Type::BaseModel @@ -337,64 +276,53 @@ module Imagekit attr_accessor client_email: String + attr_accessor include_canonical_header: bool + attr_accessor name: String + attr_accessor prefix: String + attr_accessor type: :GCS attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_accessor private_key: String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :GCS ) -> void def to_hash: -> { + id: String, bucket: String, client_email: String, + include_canonical_header: bool, name: String, - private_key: String, + prefix: String, type: :GCS, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type azure_blob = { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } class AzureBlob < Imagekit::Internal::Type::BaseModel @@ -402,70 +330,58 @@ module Imagekit attr_accessor container: String + attr_accessor include_canonical_header: bool + attr_accessor name: String + attr_accessor prefix: String + attr_accessor type: :AZURE_BLOB attr_reader base_url_for_canonical_header: String? def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_accessor sas_token: String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, - ?id: String, + prefix: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, ?type: :AZURE_BLOB ) -> void def to_hash: -> { + id: String, account_name: String, container: String, + include_canonical_header: bool, name: String, - sas_token: String, + prefix: String, type: :AZURE_BLOB, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String + base_url_for_canonical_header: String } end type akeneo_pim = { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } class AkeneoPim < Imagekit::Internal::Type::BaseModel attr_accessor base_url: String + attr_accessor include_canonical_header: bool + attr_accessor name: String attr_accessor type: :AKENEO_PIM @@ -474,50 +390,28 @@ module Imagekit def base_url_for_canonical_header=: (String) -> String - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_accessor client_id: String - - attr_accessor client_secret: String - - attr_accessor password: String - - attr_accessor username: String - - attr_reader id: String? - - def id=: (String) -> String + attr_accessor id: String def initialize: ( + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, - username: String, - ?id: String, ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, ?type: :AKENEO_PIM ) -> void def to_hash: -> { + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: bool, name: String, - password: String, type: :AKENEO_PIM, - username: String, - id: String, - base_url_for_canonical_header: String, - include_canonical_header: bool + base_url_for_canonical_header: String } end - def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin] + def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_response] end end end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index cb2744ce..d7ef8f51 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -2,15 +2,487 @@ module Imagekit module Models module Accounts type origin_update_params = - { } & Imagekit::Internal::Type::request_parameters + { origin: Imagekit::Models::Accounts::OriginUpdateParams::origin } + & Imagekit::Internal::Type::request_parameters class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - def initialize: (?request_options: Imagekit::request_opts) -> void + attr_accessor origin: Imagekit::Models::Accounts::OriginUpdateParams::origin - def to_hash: -> { request_options: Imagekit::RequestOptions } + def initialize: ( + origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, + request_options: Imagekit::RequestOptions + } + + type origin = + Imagekit::Accounts::OriginUpdateParams::Origin::S3 + | Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible + | Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup + | Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder + | Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy + | Imagekit::Accounts::OriginUpdateParams::Origin::Gcs + | Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob + | Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim + + module Origin + extend Imagekit::Internal::Type::Union + + type s3 = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3 + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :S3 + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type s3_compatible = + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3_COMPATIBLE + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + def initialize: ( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?type: :S3_COMPATIBLE + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + end + + type cloudinary_backup = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :CLOUDINARY_BACKUP + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :CLOUDINARY_BACKUP + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type web_folder = + { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor name: String + + attr_accessor type: :WEB_FOLDER + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + name: String, + ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, + ?type: :WEB_FOLDER + ) -> void + + def to_hash: -> { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + end + + type web_proxy = + { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor type: :WEB_PROXY + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + name: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :WEB_PROXY + ) -> void + + def to_hash: -> { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + type gcs = + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class Gcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor name: String + + attr_accessor private_key: String + + attr_accessor type: :GCS + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + bucket: String, + client_email: String, + name: String, + private_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :GCS + ) -> void + + def to_hash: -> { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type azure_blob = + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class AzureBlob < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor name: String + + attr_accessor sas_token: String + + attr_accessor type: :AZURE_BLOB + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + account_name: String, + container: String, + name: String, + sas_token: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :AZURE_BLOB + ) -> void + + def to_hash: -> { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type akeneo_pim = + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor name: String + + attr_accessor password: String + + attr_accessor type: :AKENEO_PIM + + attr_accessor username: String + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :AKENEO_PIM + ) -> void + + def to_hash: -> { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::OriginUpdateParams::origin] + end end end end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index cf6619a0..67c657b8 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -3,15 +3,15 @@ module Imagekit class Accounts class Origins def create: ( - origin: Imagekit::Models::Accounts::origin, + origin: Imagekit::Models::Accounts::OriginCreateParams::origin, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin + ) -> Imagekit::Models::Accounts::origin_response def update: ( String id, - origin: Imagekit::Models::Accounts::origin, + origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin + ) -> Imagekit::Models::Accounts::origin_response def list: ( ?request_options: Imagekit::request_opts @@ -22,7 +22,7 @@ module Imagekit def get: ( String id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin + ) -> Imagekit::Models::Accounts::origin_response def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index 79724fbe..55df4efe 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -18,19 +18,19 @@ def test_create_required_params ) assert_pattern do - response => Imagekit::Accounts::Origin + response => Imagekit::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Accounts::Origin::S3 - in Imagekit::Accounts::Origin::S3Compatible - in Imagekit::Accounts::Origin::CloudinaryBackup - in Imagekit::Accounts::Origin::WebFolder - in Imagekit::Accounts::Origin::WebProxy - in Imagekit::Accounts::Origin::Gcs - in Imagekit::Accounts::Origin::AzureBlob - in Imagekit::Accounts::Origin::AkeneoPim + in Imagekit::Accounts::OriginResponse::S3 + in Imagekit::Accounts::OriginResponse::S3Compatible + in Imagekit::Accounts::OriginResponse::CloudinaryBackup + in Imagekit::Accounts::OriginResponse::WebFolder + in Imagekit::Accounts::OriginResponse::WebProxy + in Imagekit::Accounts::OriginResponse::Gcs + in Imagekit::Accounts::OriginResponse::AzureBlob + in Imagekit::Accounts::OriginResponse::AkeneoPim end end @@ -38,88 +38,76 @@ def test_create_required_params case response in { type: :S3, - access_key: String, + id: String, bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :S3_COMPATIBLE, - access_key: String, + id: String, bucket: String, endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil, - s3_force_path_style: Imagekit::Internal::Type::Boolean | nil + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil } in { type: :CLOUDINARY_BACKUP, - access_key: String, + id: String, bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :WEB_FOLDER, + id: String, base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } in { type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } in { type: :GCS, + id: String, bucket: String, client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - private_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :AZURE_BLOB, + id: String, account_name: String, container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - sas_token: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :AKENEO_PIM, + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - password: String, - username: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } end end @@ -141,19 +129,19 @@ def test_update_required_params ) assert_pattern do - response => Imagekit::Accounts::Origin + response => Imagekit::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Accounts::Origin::S3 - in Imagekit::Accounts::Origin::S3Compatible - in Imagekit::Accounts::Origin::CloudinaryBackup - in Imagekit::Accounts::Origin::WebFolder - in Imagekit::Accounts::Origin::WebProxy - in Imagekit::Accounts::Origin::Gcs - in Imagekit::Accounts::Origin::AzureBlob - in Imagekit::Accounts::Origin::AkeneoPim + in Imagekit::Accounts::OriginResponse::S3 + in Imagekit::Accounts::OriginResponse::S3Compatible + in Imagekit::Accounts::OriginResponse::CloudinaryBackup + in Imagekit::Accounts::OriginResponse::WebFolder + in Imagekit::Accounts::OriginResponse::WebProxy + in Imagekit::Accounts::OriginResponse::Gcs + in Imagekit::Accounts::OriginResponse::AzureBlob + in Imagekit::Accounts::OriginResponse::AkeneoPim end end @@ -161,88 +149,76 @@ def test_update_required_params case response in { type: :S3, - access_key: String, + id: String, bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :S3_COMPATIBLE, - access_key: String, + id: String, bucket: String, endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil, - s3_force_path_style: Imagekit::Internal::Type::Boolean | nil + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil } in { type: :CLOUDINARY_BACKUP, - access_key: String, + id: String, bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :WEB_FOLDER, + id: String, base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } in { type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } in { type: :GCS, + id: String, bucket: String, client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - private_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :AZURE_BLOB, + id: String, account_name: String, container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - sas_token: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :AKENEO_PIM, + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - password: String, - username: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } end end @@ -254,7 +230,7 @@ def test_list response = @image_kit.accounts.origins.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::Origin]) + response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::OriginResponse]) end end @@ -274,19 +250,19 @@ def test_get response = @image_kit.accounts.origins.get("id") assert_pattern do - response => Imagekit::Accounts::Origin + response => Imagekit::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Accounts::Origin::S3 - in Imagekit::Accounts::Origin::S3Compatible - in Imagekit::Accounts::Origin::CloudinaryBackup - in Imagekit::Accounts::Origin::WebFolder - in Imagekit::Accounts::Origin::WebProxy - in Imagekit::Accounts::Origin::Gcs - in Imagekit::Accounts::Origin::AzureBlob - in Imagekit::Accounts::Origin::AkeneoPim + in Imagekit::Accounts::OriginResponse::S3 + in Imagekit::Accounts::OriginResponse::S3Compatible + in Imagekit::Accounts::OriginResponse::CloudinaryBackup + in Imagekit::Accounts::OriginResponse::WebFolder + in Imagekit::Accounts::OriginResponse::WebProxy + in Imagekit::Accounts::OriginResponse::Gcs + in Imagekit::Accounts::OriginResponse::AzureBlob + in Imagekit::Accounts::OriginResponse::AkeneoPim end end @@ -294,88 +270,76 @@ def test_get case response in { type: :S3, - access_key: String, + id: String, bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :S3_COMPATIBLE, - access_key: String, + id: String, bucket: String, endpoint: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil, - s3_force_path_style: Imagekit::Internal::Type::Boolean | nil + prefix: String, + s3_force_path_style: Imagekit::Internal::Type::Boolean, + base_url_for_canonical_header: String | nil } in { type: :CLOUDINARY_BACKUP, - access_key: String, + id: String, bucket: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - secret_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :WEB_FOLDER, + id: String, base_url: String, + forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } in { type: :WEB_PROXY, + id: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } in { type: :GCS, + id: String, bucket: String, client_email: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - private_key: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :AZURE_BLOB, + id: String, account_name: String, container: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - sas_token: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil, - prefix: String | nil + prefix: String, + base_url_for_canonical_header: String | nil } in { type: :AKENEO_PIM, + id: String, base_url: String, - client_id: String, - client_secret: String, + include_canonical_header: Imagekit::Internal::Type::Boolean, name: String, - password: String, - username: String, - id: String | nil, - base_url_for_canonical_header: String | nil, - include_canonical_header: Imagekit::Internal::Type::Boolean | nil + base_url_for_canonical_header: String | nil } end end From 528976ec9f3b6b4648af87c27d46386ed67f5f50 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:12:49 +0000 Subject: [PATCH 050/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 1 + lib/imagekit/internal/type/union.rb | 32 +- .../models/accounts/origin_create_params.rb | 550 +----------- .../models/accounts/origin_request.rb | 547 ++++++++++++ .../models/accounts/origin_update_params.rb | 550 +----------- lib/imagekit/resources/accounts/origins.rb | 4 +- .../models/accounts/origin_create_params.rbi | 825 +----------------- .../models/accounts/origin_request.rbi | 775 ++++++++++++++++ .../models/accounts/origin_update_params.rbi | 825 +----------------- rbi/imagekit/resources/accounts/origins.rbi | 32 +- .../models/accounts/origin_create_params.rbs | 478 +--------- .../models/accounts/origin_request.rbs | 468 ++++++++++ .../models/accounts/origin_update_params.rbs | 478 +--------- sig/imagekit/resources/accounts/origins.rbs | 4 +- 15 files changed, 1844 insertions(+), 3727 deletions(-) create mode 100644 lib/imagekit/models/accounts/origin_request.rb create mode 100644 rbi/imagekit/models/accounts/origin_request.rbi create mode 100644 sig/imagekit/models/accounts/origin_request.rbs diff --git a/.stats.yml b/.stats.yml index 8a42af3a..d8061136 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-fa82106bb6313906d2eaac167e0ca5f60f12a166c743c00a18c22be0e455c1b6.yml openapi_spec_hash: 8ff6fc6886e8d7a9eee6d45d51e9673c -config_hash: 76b94bb341141f0e9b14cdbb1203b0fa +config_hash: e1442470f0f1b22d8558d6ca9526e0ea diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 3e287ceb..d41b38be 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -50,6 +50,7 @@ require_relative "imagekit/internal/transport/base_client" require_relative "imagekit/internal/transport/pooled_net_requester" require_relative "imagekit/client" +require_relative "imagekit/models/accounts/origin_request" require_relative "imagekit/models/accounts/url_endpoint" require_relative "imagekit/models/file" require_relative "imagekit/models/accounts/origin_create_params" diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb index 9bb05f86..5a103a05 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekit/internal/type/union.rb @@ -6,28 +6,28 @@ module Type # @api private # # @example - # # `origin_response` is a `Imagekit::Accounts::OriginResponse` - # case origin_response - # when Imagekit::Accounts::OriginResponse::S3 - # puts(origin_response.id) - # when Imagekit::Accounts::OriginResponse::S3Compatible - # puts(origin_response.bucket) - # when Imagekit::Accounts::OriginResponse::CloudinaryBackup - # puts(origin_response.include_canonical_header) + # # `origin_request` is a `Imagekit::Accounts::OriginRequest` + # case origin_request + # when Imagekit::Accounts::OriginRequest::S3 + # puts(origin_request.access_key) + # when Imagekit::Accounts::OriginRequest::S3Compatible + # puts(origin_request.bucket) + # when Imagekit::Accounts::OriginRequest::CloudinaryBackup + # puts(origin_request.name) # else - # puts(origin_response) + # puts(origin_request) # end # # @example - # case origin_response - # in {type: :S3, id: id, bucket: bucket, include_canonical_header: include_canonical_header} - # puts(id) - # in {type: :S3_COMPATIBLE, id: id, bucket: bucket, endpoint: endpoint} + # case origin_request + # in {type: :S3, access_key: access_key, bucket: bucket, name: name} + # puts(access_key) + # in {type: :S3_COMPATIBLE, access_key: access_key, bucket: bucket, endpoint: endpoint} # puts(bucket) - # in {type: :CLOUDINARY_BACKUP, id: id, bucket: bucket, include_canonical_header: include_canonical_header} - # puts(include_canonical_header) + # in {type: :CLOUDINARY_BACKUP, access_key: access_key, bucket: bucket, name: name} + # puts(name) # else - # puts(origin_response) + # puts(origin_request) # end module Union include Imagekit::Internal::Type::Converter diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index 326040f3..d3f005e4 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -8,556 +8,8 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute origin - # Schema for origin request resources. - # - # @return [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] - required :origin, union: -> { Imagekit::Accounts::OriginCreateParams::Origin } - - # @!method initialize(origin:, request_options: {}) - # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin request resources. - # + # @!method initialize(request_options: {}) # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # Schema for origin request resources. - module Origin - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :S3, -> { Imagekit::Accounts::OriginCreateParams::Origin::S3 } - - variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible } - - variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup } - - variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginCreateParams::Origin::WebFolder } - - variant :WEB_PROXY, -> { Imagekit::Accounts::OriginCreateParams::Origin::WebProxy } - - variant :GCS, -> { Imagekit::Accounts::OriginCreateParams::Origin::Gcs } - - variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim } - - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :S3] - required :type, const: :S3 - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param type [Symbol, :S3] - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :S3_COMPATIBLE] - required :type, const: :S3_COMPATIBLE - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param type [Symbol, :S3_COMPATIBLE] - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY_BACKUP] - required :type, const: :CLOUDINARY_BACKUP - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param type [Symbol, :CLOUDINARY_BACKUP] - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Root URL for the web folder origin. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_FOLDER] - required :type, const: :WEB_FOLDER - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :WEB_FOLDER] - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_PROXY] - required :type, const: :WEB_PROXY - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :WEB_PROXY] - end - - class Gcs < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey - - # @!attribute type - # - # @return [Symbol, :GCS] - required :type, const: :GCS - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) - # @param bucket [String] - # - # @param client_email [String] - # - # @param name [String] Display name of the origin. - # - # @param private_key [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param type [Symbol, :GCS] - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken - - # @!attribute type - # - # @return [Symbol, :AZURE_BLOB] - required :type, const: :AZURE_BLOB - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) - # @param account_name [String] - # - # @param container [String] - # - # @param name [String] Display name of the origin. - # - # @param sas_token [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param type [Symbol, :AZURE_BLOB] - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM - - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) - # @param base_url [String] Akeneo instance base URL. - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param name [String] Display name of the origin. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :AKENEO_PIM] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim)] - end end end end diff --git a/lib/imagekit/models/accounts/origin_request.rb b/lib/imagekit/models/accounts/origin_request.rb new file mode 100644 index 00000000..88b7782f --- /dev/null +++ b/lib/imagekit/models/accounts/origin_request.rb @@ -0,0 +1,547 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module Accounts + # Schema for origin request resources. + module OriginRequest + extend Imagekit::Internal::Type::Union + + discriminator :type + + variant :S3, -> { Imagekit::Accounts::OriginRequest::S3 } + + variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginRequest::S3Compatible } + + variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginRequest::CloudinaryBackup } + + variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginRequest::WebFolder } + + variant :WEB_PROXY, -> { Imagekit::Accounts::OriginRequest::WebProxy } + + variant :GCS, -> { Imagekit::Accounts::OriginRequest::Gcs } + + variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginRequest::AzureBlob } + + variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginRequest::AkeneoPim } + + class S3 < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3] + required :type, const: :S3 + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :S3] + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute endpoint + # Custom S3-compatible endpoint. + # + # @return [String] + required :endpoint, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :S3_COMPATIBLE] + required :type, const: :S3_COMPATIBLE + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!attribute s3_force_path_style + # Use path-style S3 URLs? + # + # @return [Boolean, nil] + optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + + # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param endpoint [String] Custom S3-compatible endpoint. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param s3_force_path_style [Boolean] Use path-style S3 URLs? + # + # @param type [Symbol, :S3_COMPATIBLE] + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + # @!attribute access_key + # Access key for the bucket. + # + # @return [String] + required :access_key, String, api_name: :accessKey + + # @!attribute bucket + # S3 bucket name. + # + # @return [String] + required :bucket, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute secret_key + # Secret key for the bucket. + # + # @return [String] + required :secret_key, String, api_name: :secretKey + + # @!attribute type + # + # @return [Symbol, :CLOUDINARY_BACKUP] + required :type, const: :CLOUDINARY_BACKUP + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # Path prefix inside the bucket. + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) + # @param access_key [String] Access key for the bucket. + # + # @param bucket [String] S3 bucket name. + # + # @param name [String] Display name of the origin. + # + # @param secret_key [String] Secret key for the bucket. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] Path prefix inside the bucket. + # + # @param type [Symbol, :CLOUDINARY_BACKUP] + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Root URL for the web folder origin. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_FOLDER] + required :type, const: :WEB_FOLDER + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute forward_host_header_to_origin + # Forward the Host header to origin? + # + # @return [Boolean, nil] + optional :forward_host_header_to_origin, + Imagekit::Internal::Type::Boolean, + api_name: :forwardHostHeaderToOrigin + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) + # @param base_url [String] Root URL for the web folder origin. + # + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_FOLDER] + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute type + # + # @return [Symbol, :WEB_PROXY] + required :type, const: :WEB_PROXY + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) + # @param name [String] Display name of the origin. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :WEB_PROXY] + end + + class Gcs < Imagekit::Internal::Type::BaseModel + # @!attribute bucket + # + # @return [String] + required :bucket, String + + # @!attribute client_email + # + # @return [String] + required :client_email, String, api_name: :clientEmail + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute private_key + # + # @return [String] + required :private_key, String, api_name: :privateKey + + # @!attribute type + # + # @return [Symbol, :GCS] + required :type, const: :GCS + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) + # @param bucket [String] + # + # @param client_email [String] + # + # @param name [String] Display name of the origin. + # + # @param private_key [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :GCS] + end + + class AzureBlob < Imagekit::Internal::Type::BaseModel + # @!attribute account_name + # + # @return [String] + required :account_name, String, api_name: :accountName + + # @!attribute container + # + # @return [String] + required :container, String + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute sas_token + # + # @return [String] + required :sas_token, String, api_name: :sasToken + + # @!attribute type + # + # @return [Symbol, :AZURE_BLOB] + required :type, const: :AZURE_BLOB + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!attribute prefix + # + # @return [String, nil] + optional :prefix, String + + # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) + # @param account_name [String] + # + # @param container [String] + # + # @param name [String] Display name of the origin. + # + # @param sas_token [String] + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param prefix [String] + # + # @param type [Symbol, :AZURE_BLOB] + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + # @!attribute base_url + # Akeneo instance base URL. + # + # @return [String] + required :base_url, String, api_name: :baseUrl + + # @!attribute client_id + # Akeneo API client ID. + # + # @return [String] + required :client_id, String, api_name: :clientId + + # @!attribute client_secret + # Akeneo API client secret. + # + # @return [String] + required :client_secret, String, api_name: :clientSecret + + # @!attribute name + # Display name of the origin. + # + # @return [String] + required :name, String + + # @!attribute password + # Akeneo API password. + # + # @return [String] + required :password, String + + # @!attribute type + # + # @return [Symbol, :AKENEO_PIM] + required :type, const: :AKENEO_PIM + + # @!attribute username + # Akeneo API username. + # + # @return [String] + required :username, String + + # @!attribute base_url_for_canonical_header + # URL used in the Canonical header (if enabled). + # + # @return [String, nil] + optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader + + # @!attribute include_canonical_header + # Whether to send a Canonical header. + # + # @return [Boolean, nil] + optional :include_canonical_header, + Imagekit::Internal::Type::Boolean, + api_name: :includeCanonicalHeader + + # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) + # @param base_url [String] Akeneo instance base URL. + # + # @param client_id [String] Akeneo API client ID. + # + # @param client_secret [String] Akeneo API client secret. + # + # @param name [String] Display name of the origin. + # + # @param password [String] Akeneo API password. + # + # @param username [String] Akeneo API username. + # + # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). + # + # @param include_canonical_header [Boolean] Whether to send a Canonical header. + # + # @param type [Symbol, :AKENEO_PIM] + end + + # @!method self.variants + # @return [Array(Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim)] + end + end + end +end diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index 0d935d6b..d97a3cc0 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -8,556 +8,8 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute origin - # Schema for origin request resources. - # - # @return [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] - required :origin, union: -> { Imagekit::Accounts::OriginUpdateParams::Origin } - - # @!method initialize(origin:, request_options: {}) - # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin request resources. - # + # @!method initialize(request_options: {}) # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # Schema for origin request resources. - module Origin - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :S3, -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3 } - - variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible } - - variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup } - - variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder } - - variant :WEB_PROXY, -> { Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy } - - variant :GCS, -> { Imagekit::Accounts::OriginUpdateParams::Origin::Gcs } - - variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob } - - variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim } - - class S3 < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :S3] - required :type, const: :S3 - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :S3) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param type [Symbol, :S3] - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute endpoint - # Custom S3-compatible endpoint. - # - # @return [String] - required :endpoint, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :S3_COMPATIBLE] - required :type, const: :S3_COMPATIBLE - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!attribute s3_force_path_style - # Use path-style S3 URLs? - # - # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle - - # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param endpoint [String] Custom S3-compatible endpoint. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param s3_force_path_style [Boolean] Use path-style S3 URLs? - # - # @param type [Symbol, :S3_COMPATIBLE] - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - # @!attribute access_key - # Access key for the bucket. - # - # @return [String] - required :access_key, String, api_name: :accessKey - - # @!attribute bucket - # S3 bucket name. - # - # @return [String] - required :bucket, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute secret_key - # Secret key for the bucket. - # - # @return [String] - required :secret_key, String, api_name: :secretKey - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY_BACKUP] - required :type, const: :CLOUDINARY_BACKUP - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # Path prefix inside the bucket. - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(access_key:, bucket:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :CLOUDINARY_BACKUP) - # @param access_key [String] Access key for the bucket. - # - # @param bucket [String] S3 bucket name. - # - # @param name [String] Display name of the origin. - # - # @param secret_key [String] Secret key for the bucket. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] Path prefix inside the bucket. - # - # @param type [Symbol, :CLOUDINARY_BACKUP] - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Root URL for the web folder origin. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_FOLDER] - required :type, const: :WEB_FOLDER - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute forward_host_header_to_origin - # Forward the Host header to origin? - # - # @return [Boolean, nil] - optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, - api_name: :forwardHostHeaderToOrigin - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) - # @param base_url [String] Root URL for the web folder origin. - # - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param forward_host_header_to_origin [Boolean] Forward the Host header to origin? - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :WEB_FOLDER] - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute type - # - # @return [Symbol, :WEB_PROXY] - required :type, const: :WEB_PROXY - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) - # @param name [String] Display name of the origin. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :WEB_PROXY] - end - - class Gcs < Imagekit::Internal::Type::BaseModel - # @!attribute bucket - # - # @return [String] - required :bucket, String - - # @!attribute client_email - # - # @return [String] - required :client_email, String, api_name: :clientEmail - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute private_key - # - # @return [String] - required :private_key, String, api_name: :privateKey - - # @!attribute type - # - # @return [Symbol, :GCS] - required :type, const: :GCS - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(bucket:, client_email:, name:, private_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :GCS) - # @param bucket [String] - # - # @param client_email [String] - # - # @param name [String] Display name of the origin. - # - # @param private_key [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param type [Symbol, :GCS] - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - # @!attribute account_name - # - # @return [String] - required :account_name, String, api_name: :accountName - - # @!attribute container - # - # @return [String] - required :container, String - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute sas_token - # - # @return [String] - required :sas_token, String, api_name: :sasToken - - # @!attribute type - # - # @return [Symbol, :AZURE_BLOB] - required :type, const: :AZURE_BLOB - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!attribute prefix - # - # @return [String, nil] - optional :prefix, String - - # @!method initialize(account_name:, container:, name:, sas_token:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, type: :AZURE_BLOB) - # @param account_name [String] - # - # @param container [String] - # - # @param name [String] Display name of the origin. - # - # @param sas_token [String] - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param prefix [String] - # - # @param type [Symbol, :AZURE_BLOB] - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - # @!attribute base_url - # Akeneo instance base URL. - # - # @return [String] - required :base_url, String, api_name: :baseUrl - - # @!attribute client_id - # Akeneo API client ID. - # - # @return [String] - required :client_id, String, api_name: :clientId - - # @!attribute client_secret - # Akeneo API client secret. - # - # @return [String] - required :client_secret, String, api_name: :clientSecret - - # @!attribute name - # Display name of the origin. - # - # @return [String] - required :name, String - - # @!attribute password - # Akeneo API password. - # - # @return [String] - required :password, String - - # @!attribute type - # - # @return [Symbol, :AKENEO_PIM] - required :type, const: :AKENEO_PIM - - # @!attribute username - # Akeneo API username. - # - # @return [String] - required :username, String - - # @!attribute base_url_for_canonical_header - # URL used in the Canonical header (if enabled). - # - # @return [String, nil] - optional :base_url_for_canonical_header, String, api_name: :baseUrlForCanonicalHeader - - # @!attribute include_canonical_header - # Whether to send a Canonical header. - # - # @return [Boolean, nil] - optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, - api_name: :includeCanonicalHeader - - # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) - # @param base_url [String] Akeneo instance base URL. - # - # @param client_id [String] Akeneo API client ID. - # - # @param client_secret [String] Akeneo API client secret. - # - # @param name [String] Display name of the origin. - # - # @param password [String] Akeneo API password. - # - # @param username [String] Akeneo API username. - # - # @param base_url_for_canonical_header [String] URL used in the Canonical header (if enabled). - # - # @param include_canonical_header [Boolean] Whether to send a Canonical header. - # - # @param type [Symbol, :AKENEO_PIM] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim)] - end end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index 3318b038..c4b0cba9 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -9,7 +9,7 @@ class Origins # # @overload create(origin:, request_options: {}) # - # @param origin [Imagekit::Models::Accounts::OriginCreateParams::Origin::S3, Imagekit::Models::Accounts::OriginCreateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginCreateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginCreateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginCreateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginCreateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginCreateParams::Origin::AkeneoPim] Schema for origin request resources. + # @param origin [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -37,7 +37,7 @@ def create(params) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param origin [Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3, Imagekit::Models::Accounts::OriginUpdateParams::Origin::S3Compatible, Imagekit::Models::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebFolder, Imagekit::Models::Accounts::OriginUpdateParams::Origin::WebProxy, Imagekit::Models::Accounts::OriginUpdateParams::Origin::Gcs, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AzureBlob, Imagekit::Models::Accounts::OriginUpdateParams::Origin::AkeneoPim] Schema for origin request resources. + # @param origin [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index 287a128c..f53d55e5 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -15,834 +15,17 @@ module Imagekit ) end - # Schema for origin request resources. sig do - returns( - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - ) + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class ) end - attr_accessor :origin - - sig do - params( - origin: - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Schema for origin request resources. - origin:, - request_options: {} - ) + def self.new(request_options: {}) end - sig do - override.returns( - { - origin: - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - ), - request_options: Imagekit::RequestOptions - } - ) - end + sig { override.returns({ request_options: Imagekit::RequestOptions }) } def to_hash end - - # Schema for origin request resources. - module Origin - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - ) - end - - class S3 < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - type: :S3 - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - sig do - params( - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Custom S3-compatible endpoint. - endpoint:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - type: :S3_COMPATIBLE - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean - } - ) - end - def to_hash - end - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - type: :CLOUDINARY_BACKUP - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder, - Imagekit::Internal::AnyHash - ) - end - - # Root URL for the web folder origin. - sig { returns(String) } - attr_accessor :base_url - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - base_url: String, - name: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Root URL for the web folder origin. - base_url:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :WEB_FOLDER - ) - end - - sig do - override.returns( - { - base_url: String, - name: String, - type: Symbol, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy, - Imagekit::Internal::AnyHash - ) - end - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - name: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :WEB_PROXY - ) - end - - sig do - override.returns( - { - name: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - class Gcs < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::Gcs, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :bucket - - sig { returns(String) } - attr_accessor :client_email - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :private_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - bucket: String, - client_email: String, - name: String, - private_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - bucket:, - client_email:, - # Display name of the origin. - name:, - private_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - type: :GCS - ) - end - - sig do - override.returns( - { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :sas_token - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - account_name: String, - container: String, - name: String, - sas_token: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - account_name:, - container:, - # Display name of the origin. - name:, - sas_token:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - type: :AZURE_BLOB - ) - end - - sig do - override.returns( - { - account_name: String, - container: String, - name: String, - sas_token: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim, - Imagekit::Internal::AnyHash - ) - end - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - - sig { returns(Symbol) } - attr_accessor :type - - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Akeneo instance base URL. - base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Display name of the origin. - name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :AKENEO_PIM - ) - end - - sig do - override.returns( - { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: Symbol, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - sig do - override.returns( - T::Array[Imagekit::Accounts::OriginCreateParams::Origin::Variants] - ) - end - def self.variants - end - end end end end diff --git a/rbi/imagekit/models/accounts/origin_request.rbi b/rbi/imagekit/models/accounts/origin_request.rbi new file mode 100644 index 00000000..3de49704 --- /dev/null +++ b/rbi/imagekit/models/accounts/origin_request.rbi @@ -0,0 +1,775 @@ +# typed: strong + +module Imagekit + module Models + module Accounts + # Schema for origin request resources. + module OriginRequest + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::S3, + Imagekit::Accounts::OriginRequest::S3Compatible, + Imagekit::Accounts::OriginRequest::CloudinaryBackup, + Imagekit::Accounts::OriginRequest::WebFolder, + Imagekit::Accounts::OriginRequest::WebProxy, + Imagekit::Accounts::OriginRequest::Gcs, + Imagekit::Accounts::OriginRequest::AzureBlob, + Imagekit::Accounts::OriginRequest::AkeneoPim + ) + end + + class S3 < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::S3, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :S3 + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class S3Compatible < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::S3Compatible, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Custom S3-compatible endpoint. + sig { returns(String) } + attr_accessor :endpoint + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + # Use path-style S3 URLs? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :s3_force_path_style + + sig { params(s3_force_path_style: T::Boolean).void } + attr_writer :s3_force_path_style + + sig do + params( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Custom S3-compatible endpoint. + endpoint:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + # Use path-style S3 URLs? + s3_force_path_style: nil, + type: :S3_COMPATIBLE + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + s3_force_path_style: T::Boolean + } + ) + end + def to_hash + end + end + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::CloudinaryBackup, + Imagekit::Internal::AnyHash + ) + end + + # Access key for the bucket. + sig { returns(String) } + attr_accessor :access_key + + # S3 bucket name. + sig { returns(String) } + attr_accessor :bucket + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Secret key for the bucket. + sig { returns(String) } + attr_accessor :secret_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + # Path prefix inside the bucket. + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + access_key: String, + bucket: String, + name: String, + secret_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Access key for the bucket. + access_key:, + # S3 bucket name. + bucket:, + # Display name of the origin. + name:, + # Secret key for the bucket. + secret_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + # Path prefix inside the bucket. + prefix: nil, + type: :CLOUDINARY_BACKUP + ) + end + + sig do + override.returns( + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class WebFolder < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::WebFolder, + Imagekit::Internal::AnyHash + ) + end + + # Root URL for the web folder origin. + sig { returns(String) } + attr_accessor :base_url + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Forward the Host header to origin? + sig { returns(T.nilable(T::Boolean)) } + attr_reader :forward_host_header_to_origin + + sig { params(forward_host_header_to_origin: T::Boolean).void } + attr_writer :forward_host_header_to_origin + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + name: String, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Root URL for the web folder origin. + base_url:, + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Forward the Host header to origin? + forward_host_header_to_origin: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_FOLDER + ) + end + + sig do + override.returns( + { + base_url: String, + name: String, + type: Symbol, + base_url_for_canonical_header: String, + forward_host_header_to_origin: T::Boolean, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class WebProxy < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::WebProxy, + Imagekit::Internal::AnyHash + ) + end + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + name: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Display name of the origin. + name:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :WEB_PROXY + ) + end + + sig do + override.returns( + { + name: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + class Gcs < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::Gcs, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :bucket + + sig { returns(String) } + attr_accessor :client_email + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :private_key + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + bucket: String, + client_email: String, + name: String, + private_key: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + bucket:, + client_email:, + # Display name of the origin. + name:, + private_key:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :GCS + ) + end + + sig do + override.returns( + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AzureBlob < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::AzureBlob, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :account_name + + sig { returns(String) } + attr_accessor :container + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :sas_token + + sig { returns(Symbol) } + attr_accessor :type + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig { returns(T.nilable(String)) } + attr_reader :prefix + + sig { params(prefix: String).void } + attr_writer :prefix + + sig do + params( + account_name: String, + container: String, + name: String, + sas_token: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + account_name:, + container:, + # Display name of the origin. + name:, + sas_token:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + prefix: nil, + type: :AZURE_BLOB + ) + end + + sig do + override.returns( + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: Symbol, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + prefix: String + } + ) + end + def to_hash + end + end + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Accounts::OriginRequest::AkeneoPim, + Imagekit::Internal::AnyHash + ) + end + + # Akeneo instance base URL. + sig { returns(String) } + attr_accessor :base_url + + # Akeneo API client ID. + sig { returns(String) } + attr_accessor :client_id + + # Akeneo API client secret. + sig { returns(String) } + attr_accessor :client_secret + + # Display name of the origin. + sig { returns(String) } + attr_accessor :name + + # Akeneo API password. + sig { returns(String) } + attr_accessor :password + + sig { returns(Symbol) } + attr_accessor :type + + # Akeneo API username. + sig { returns(String) } + attr_accessor :username + + # URL used in the Canonical header (if enabled). + sig { returns(T.nilable(String)) } + attr_reader :base_url_for_canonical_header + + sig { params(base_url_for_canonical_header: String).void } + attr_writer :base_url_for_canonical_header + + # Whether to send a Canonical header. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_canonical_header + + sig { params(include_canonical_header: T::Boolean).void } + attr_writer :include_canonical_header + + sig do + params( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Akeneo instance base URL. + base_url:, + # Akeneo API client ID. + client_id:, + # Akeneo API client secret. + client_secret:, + # Display name of the origin. + name:, + # Akeneo API password. + password:, + # Akeneo API username. + username:, + # URL used in the Canonical header (if enabled). + base_url_for_canonical_header: nil, + # Whether to send a Canonical header. + include_canonical_header: nil, + type: :AKENEO_PIM + ) + end + + sig do + override.returns( + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: Symbol, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: T::Boolean + } + ) + end + def to_hash + end + end + + sig do + override.returns( + T::Array[Imagekit::Accounts::OriginRequest::Variants] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index 6ae17c3d..51783397 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -15,834 +15,17 @@ module Imagekit ) end - # Schema for origin request resources. sig do - returns( - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - ) + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class ) end - attr_accessor :origin - - sig do - params( - origin: - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Schema for origin request resources. - origin:, - request_options: {} - ) + def self.new(request_options: {}) end - sig do - override.returns( - { - origin: - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - ), - request_options: Imagekit::RequestOptions - } - ) - end + sig { override.returns({ request_options: Imagekit::RequestOptions }) } def to_hash end - - # Schema for origin request resources. - module Origin - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - ) - end - - class S3 < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - type: :S3 - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class S3Compatible < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Custom S3-compatible endpoint. - sig { returns(String) } - attr_accessor :endpoint - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - # Use path-style S3 URLs? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :s3_force_path_style - - sig { params(s3_force_path_style: T::Boolean).void } - attr_writer :s3_force_path_style - - sig do - params( - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Custom S3-compatible endpoint. - endpoint:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - # Use path-style S3 URLs? - s3_force_path_style: nil, - type: :S3_COMPATIBLE - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - s3_force_path_style: T::Boolean - } - ) - end - def to_hash - end - end - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup, - Imagekit::Internal::AnyHash - ) - end - - # Access key for the bucket. - sig { returns(String) } - attr_accessor :access_key - - # S3 bucket name. - sig { returns(String) } - attr_accessor :bucket - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Secret key for the bucket. - sig { returns(String) } - attr_accessor :secret_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - # Path prefix inside the bucket. - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - access_key: String, - bucket: String, - name: String, - secret_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Access key for the bucket. - access_key:, - # S3 bucket name. - bucket:, - # Display name of the origin. - name:, - # Secret key for the bucket. - secret_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - # Path prefix inside the bucket. - prefix: nil, - type: :CLOUDINARY_BACKUP - ) - end - - sig do - override.returns( - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class WebFolder < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder, - Imagekit::Internal::AnyHash - ) - end - - # Root URL for the web folder origin. - sig { returns(String) } - attr_accessor :base_url - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Forward the Host header to origin? - sig { returns(T.nilable(T::Boolean)) } - attr_reader :forward_host_header_to_origin - - sig { params(forward_host_header_to_origin: T::Boolean).void } - attr_writer :forward_host_header_to_origin - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - base_url: String, - name: String, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Root URL for the web folder origin. - base_url:, - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Forward the Host header to origin? - forward_host_header_to_origin: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :WEB_FOLDER - ) - end - - sig do - override.returns( - { - base_url: String, - name: String, - type: Symbol, - base_url_for_canonical_header: String, - forward_host_header_to_origin: T::Boolean, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - class WebProxy < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy, - Imagekit::Internal::AnyHash - ) - end - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - name: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Display name of the origin. - name:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :WEB_PROXY - ) - end - - sig do - override.returns( - { - name: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - class Gcs < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :bucket - - sig { returns(String) } - attr_accessor :client_email - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :private_key - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - bucket: String, - client_email: String, - name: String, - private_key: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - bucket:, - client_email:, - # Display name of the origin. - name:, - private_key:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - type: :GCS - ) - end - - sig do - override.returns( - { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class AzureBlob < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :account_name - - sig { returns(String) } - attr_accessor :container - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :sas_token - - sig { returns(Symbol) } - attr_accessor :type - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig { returns(T.nilable(String)) } - attr_reader :prefix - - sig { params(prefix: String).void } - attr_writer :prefix - - sig do - params( - account_name: String, - container: String, - name: String, - sas_token: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - account_name:, - container:, - # Display name of the origin. - name:, - sas_token:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - prefix: nil, - type: :AZURE_BLOB - ) - end - - sig do - override.returns( - { - account_name: String, - container: String, - name: String, - sas_token: String, - type: Symbol, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - prefix: String - } - ) - end - def to_hash - end - end - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim, - Imagekit::Internal::AnyHash - ) - end - - # Akeneo instance base URL. - sig { returns(String) } - attr_accessor :base_url - - # Akeneo API client ID. - sig { returns(String) } - attr_accessor :client_id - - # Akeneo API client secret. - sig { returns(String) } - attr_accessor :client_secret - - # Display name of the origin. - sig { returns(String) } - attr_accessor :name - - # Akeneo API password. - sig { returns(String) } - attr_accessor :password - - sig { returns(Symbol) } - attr_accessor :type - - # Akeneo API username. - sig { returns(String) } - attr_accessor :username - - # URL used in the Canonical header (if enabled). - sig { returns(T.nilable(String)) } - attr_reader :base_url_for_canonical_header - - sig { params(base_url_for_canonical_header: String).void } - attr_writer :base_url_for_canonical_header - - # Whether to send a Canonical header. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_canonical_header - - sig { params(include_canonical_header: T::Boolean).void } - attr_writer :include_canonical_header - - sig do - params( - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Akeneo instance base URL. - base_url:, - # Akeneo API client ID. - client_id:, - # Akeneo API client secret. - client_secret:, - # Display name of the origin. - name:, - # Akeneo API password. - password:, - # Akeneo API username. - username:, - # URL used in the Canonical header (if enabled). - base_url_for_canonical_header: nil, - # Whether to send a Canonical header. - include_canonical_header: nil, - type: :AKENEO_PIM - ) - end - - sig do - override.returns( - { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: Symbol, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: T::Boolean - } - ) - end - def to_hash - end - end - - sig do - override.returns( - T::Array[Imagekit::Accounts::OriginUpdateParams::Origin::Variants] - ) - end - def self.variants - end - end end end end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index 8dd8af5d..5eb4899b 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -10,14 +10,14 @@ module Imagekit params( origin: T.any( - Imagekit::Accounts::OriginCreateParams::Origin::S3::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::WebFolder::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::Gcs::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob::OrHash, - Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim::OrHash + Imagekit::Accounts::OriginRequest::S3::OrHash, + Imagekit::Accounts::OriginRequest::S3Compatible::OrHash, + Imagekit::Accounts::OriginRequest::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginRequest::WebFolder::OrHash, + Imagekit::Accounts::OriginRequest::WebProxy::OrHash, + Imagekit::Accounts::OriginRequest::Gcs::OrHash, + Imagekit::Accounts::OriginRequest::AzureBlob::OrHash, + Imagekit::Accounts::OriginRequest::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Accounts::OriginResponse::Variants) @@ -36,14 +36,14 @@ module Imagekit id: String, origin: T.any( - Imagekit::Accounts::OriginUpdateParams::Origin::S3::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::Gcs::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob::OrHash, - Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim::OrHash + Imagekit::Accounts::OriginRequest::S3::OrHash, + Imagekit::Accounts::OriginRequest::S3Compatible::OrHash, + Imagekit::Accounts::OriginRequest::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginRequest::WebFolder::OrHash, + Imagekit::Accounts::OriginRequest::WebProxy::OrHash, + Imagekit::Accounts::OriginRequest::Gcs::OrHash, + Imagekit::Accounts::OriginRequest::AzureBlob::OrHash, + Imagekit::Accounts::OriginRequest::AkeneoPim::OrHash ), request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Accounts::OriginResponse::Variants) diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index 83e146cf..60ad3272 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -2,487 +2,15 @@ module Imagekit module Models module Accounts type origin_create_params = - { origin: Imagekit::Models::Accounts::OriginCreateParams::origin } - & Imagekit::Internal::Type::request_parameters + { } & Imagekit::Internal::Type::request_parameters class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor origin: Imagekit::Models::Accounts::OriginCreateParams::origin + def initialize: (?request_options: Imagekit::request_opts) -> void - def initialize: ( - origin: Imagekit::Models::Accounts::OriginCreateParams::origin, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - origin: Imagekit::Models::Accounts::OriginCreateParams::origin, - request_options: Imagekit::RequestOptions - } - - type origin = - Imagekit::Accounts::OriginCreateParams::Origin::S3 - | Imagekit::Accounts::OriginCreateParams::Origin::S3Compatible - | Imagekit::Accounts::OriginCreateParams::Origin::CloudinaryBackup - | Imagekit::Accounts::OriginCreateParams::Origin::WebFolder - | Imagekit::Accounts::OriginCreateParams::Origin::WebProxy - | Imagekit::Accounts::OriginCreateParams::Origin::Gcs - | Imagekit::Accounts::OriginCreateParams::Origin::AzureBlob - | Imagekit::Accounts::OriginCreateParams::Origin::AkeneoPim - - module Origin - extend Imagekit::Internal::Type::Union - - type s3 = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :S3, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :S3 - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :S3 - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :S3, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type s3_compatible = - { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - :s3_force_path_style => bool - } - - class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor endpoint: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :S3_COMPATIBLE - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - def initialize: ( - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?type: :S3_COMPATIBLE - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - :s3_force_path_style => bool - } - end - - type cloudinary_backup = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :CLOUDINARY_BACKUP - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :CLOUDINARY_BACKUP - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type web_folder = - { - base_url: String, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool - } - - class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor name: String - - attr_accessor type: :WEB_FOLDER - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - base_url: String, - name: String, - ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, - ?type: :WEB_FOLDER - ) -> void - - def to_hash: -> { - base_url: String, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool - } - end - - type web_proxy = - { - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - - class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor name: String - - attr_accessor type: :WEB_PROXY - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - name: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?type: :WEB_PROXY - ) -> void - - def to_hash: -> { - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - end - - type gcs = - { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: :GCS, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class Gcs < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor client_email: String - - attr_accessor name: String - - attr_accessor private_key: String - - attr_accessor type: :GCS - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - bucket: String, - client_email: String, - name: String, - private_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :GCS - ) -> void - - def to_hash: -> { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: :GCS, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type azure_blob = - { - account_name: String, - container: String, - name: String, - sas_token: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class AzureBlob < Imagekit::Internal::Type::BaseModel - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor name: String - - attr_accessor sas_token: String - - attr_accessor type: :AZURE_BLOB - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - account_name: String, - container: String, - name: String, - sas_token: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :AZURE_BLOB - ) -> void - - def to_hash: -> { - account_name: String, - container: String, - name: String, - sas_token: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type akeneo_pim = - { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: :AKENEO_PIM, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor client_id: String - - attr_accessor client_secret: String - - attr_accessor name: String - - attr_accessor password: String - - attr_accessor type: :AKENEO_PIM - - attr_accessor username: String - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?type: :AKENEO_PIM - ) -> void - - def to_hash: -> { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: :AKENEO_PIM, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::OriginCreateParams::origin] - end + def to_hash: -> { request_options: Imagekit::RequestOptions } end end end diff --git a/sig/imagekit/models/accounts/origin_request.rbs b/sig/imagekit/models/accounts/origin_request.rbs new file mode 100644 index 00000000..2e5e7916 --- /dev/null +++ b/sig/imagekit/models/accounts/origin_request.rbs @@ -0,0 +1,468 @@ +module Imagekit + module Models + module Accounts + type origin_request = + Imagekit::Accounts::OriginRequest::S3 + | Imagekit::Accounts::OriginRequest::S3Compatible + | Imagekit::Accounts::OriginRequest::CloudinaryBackup + | Imagekit::Accounts::OriginRequest::WebFolder + | Imagekit::Accounts::OriginRequest::WebProxy + | Imagekit::Accounts::OriginRequest::Gcs + | Imagekit::Accounts::OriginRequest::AzureBlob + | Imagekit::Accounts::OriginRequest::AkeneoPim + + module OriginRequest + extend Imagekit::Internal::Type::Union + + type s3 = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class S3 < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3 + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :S3 + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :S3, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type s3_compatible = + { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + + class S3Compatible < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor endpoint: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :S3_COMPATIBLE + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + attr_reader s3_force_path_style: bool? + + def s3_force_path_style=: (bool) -> bool + + def initialize: ( + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?s3_force_path_style: bool, + ?type: :S3_COMPATIBLE + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + endpoint: String, + name: String, + secret_key: String, + type: :S3_COMPATIBLE, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String, + :s3_force_path_style => bool + } + end + + type cloudinary_backup = + { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + attr_accessor access_key: String + + attr_accessor bucket: String + + attr_accessor name: String + + attr_accessor secret_key: String + + attr_accessor type: :CLOUDINARY_BACKUP + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + access_key: String, + bucket: String, + name: String, + secret_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :CLOUDINARY_BACKUP + ) -> void + + def to_hash: -> { + access_key: String, + bucket: String, + name: String, + secret_key: String, + type: :CLOUDINARY_BACKUP, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type web_folder = + { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + + class WebFolder < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor name: String + + attr_accessor type: :WEB_FOLDER + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader forward_host_header_to_origin: bool? + + def forward_host_header_to_origin=: (bool) -> bool + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + name: String, + ?base_url_for_canonical_header: String, + ?forward_host_header_to_origin: bool, + ?include_canonical_header: bool, + ?type: :WEB_FOLDER + ) -> void + + def to_hash: -> { + base_url: String, + name: String, + type: :WEB_FOLDER, + base_url_for_canonical_header: String, + forward_host_header_to_origin: bool, + include_canonical_header: bool + } + end + + type web_proxy = + { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class WebProxy < Imagekit::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor type: :WEB_PROXY + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + name: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :WEB_PROXY + ) -> void + + def to_hash: -> { + name: String, + type: :WEB_PROXY, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + type gcs = + { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class Gcs < Imagekit::Internal::Type::BaseModel + attr_accessor bucket: String + + attr_accessor client_email: String + + attr_accessor name: String + + attr_accessor private_key: String + + attr_accessor type: :GCS + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + bucket: String, + client_email: String, + name: String, + private_key: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :GCS + ) -> void + + def to_hash: -> { + bucket: String, + client_email: String, + name: String, + private_key: String, + type: :GCS, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type azure_blob = + { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + + class AzureBlob < Imagekit::Internal::Type::BaseModel + attr_accessor account_name: String + + attr_accessor container: String + + attr_accessor name: String + + attr_accessor sas_token: String + + attr_accessor type: :AZURE_BLOB + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + attr_reader prefix: String? + + def prefix=: (String) -> String + + def initialize: ( + account_name: String, + container: String, + name: String, + sas_token: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?prefix: String, + ?type: :AZURE_BLOB + ) -> void + + def to_hash: -> { + account_name: String, + container: String, + name: String, + sas_token: String, + type: :AZURE_BLOB, + base_url_for_canonical_header: String, + include_canonical_header: bool, + prefix: String + } + end + + type akeneo_pim = + { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + + class AkeneoPim < Imagekit::Internal::Type::BaseModel + attr_accessor base_url: String + + attr_accessor client_id: String + + attr_accessor client_secret: String + + attr_accessor name: String + + attr_accessor password: String + + attr_accessor type: :AKENEO_PIM + + attr_accessor username: String + + attr_reader base_url_for_canonical_header: String? + + def base_url_for_canonical_header=: (String) -> String + + attr_reader include_canonical_header: bool? + + def include_canonical_header=: (bool) -> bool + + def initialize: ( + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + username: String, + ?base_url_for_canonical_header: String, + ?include_canonical_header: bool, + ?type: :AKENEO_PIM + ) -> void + + def to_hash: -> { + base_url: String, + client_id: String, + client_secret: String, + name: String, + password: String, + type: :AKENEO_PIM, + username: String, + base_url_for_canonical_header: String, + include_canonical_header: bool + } + end + + def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_request] + end + end + end +end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index d7ef8f51..cb2744ce 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -2,487 +2,15 @@ module Imagekit module Models module Accounts type origin_update_params = - { origin: Imagekit::Models::Accounts::OriginUpdateParams::origin } - & Imagekit::Internal::Type::request_parameters + { } & Imagekit::Internal::Type::request_parameters class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor origin: Imagekit::Models::Accounts::OriginUpdateParams::origin + def initialize: (?request_options: Imagekit::request_opts) -> void - def initialize: ( - origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, - request_options: Imagekit::RequestOptions - } - - type origin = - Imagekit::Accounts::OriginUpdateParams::Origin::S3 - | Imagekit::Accounts::OriginUpdateParams::Origin::S3Compatible - | Imagekit::Accounts::OriginUpdateParams::Origin::CloudinaryBackup - | Imagekit::Accounts::OriginUpdateParams::Origin::WebFolder - | Imagekit::Accounts::OriginUpdateParams::Origin::WebProxy - | Imagekit::Accounts::OriginUpdateParams::Origin::Gcs - | Imagekit::Accounts::OriginUpdateParams::Origin::AzureBlob - | Imagekit::Accounts::OriginUpdateParams::Origin::AkeneoPim - - module Origin - extend Imagekit::Internal::Type::Union - - type s3 = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :S3, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class S3 < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :S3 - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :S3 - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :S3, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type s3_compatible = - { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - :s3_force_path_style => bool - } - - class S3Compatible < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor endpoint: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :S3_COMPATIBLE - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - attr_reader s3_force_path_style: bool? - - def s3_force_path_style=: (bool) -> bool - - def initialize: ( - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?s3_force_path_style: bool, - ?type: :S3_COMPATIBLE - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - endpoint: String, - name: String, - secret_key: String, - type: :S3_COMPATIBLE, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String, - :s3_force_path_style => bool - } - end - - type cloudinary_backup = - { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel - attr_accessor access_key: String - - attr_accessor bucket: String - - attr_accessor name: String - - attr_accessor secret_key: String - - attr_accessor type: :CLOUDINARY_BACKUP - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - access_key: String, - bucket: String, - name: String, - secret_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :CLOUDINARY_BACKUP - ) -> void - - def to_hash: -> { - access_key: String, - bucket: String, - name: String, - secret_key: String, - type: :CLOUDINARY_BACKUP, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type web_folder = - { - base_url: String, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool - } - - class WebFolder < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor name: String - - attr_accessor type: :WEB_FOLDER - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader forward_host_header_to_origin: bool? - - def forward_host_header_to_origin=: (bool) -> bool - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - base_url: String, - name: String, - ?base_url_for_canonical_header: String, - ?forward_host_header_to_origin: bool, - ?include_canonical_header: bool, - ?type: :WEB_FOLDER - ) -> void - - def to_hash: -> { - base_url: String, - name: String, - type: :WEB_FOLDER, - base_url_for_canonical_header: String, - forward_host_header_to_origin: bool, - include_canonical_header: bool - } - end - - type web_proxy = - { - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - - class WebProxy < Imagekit::Internal::Type::BaseModel - attr_accessor name: String - - attr_accessor type: :WEB_PROXY - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - name: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?type: :WEB_PROXY - ) -> void - - def to_hash: -> { - name: String, - type: :WEB_PROXY, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - end - - type gcs = - { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: :GCS, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class Gcs < Imagekit::Internal::Type::BaseModel - attr_accessor bucket: String - - attr_accessor client_email: String - - attr_accessor name: String - - attr_accessor private_key: String - - attr_accessor type: :GCS - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - bucket: String, - client_email: String, - name: String, - private_key: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :GCS - ) -> void - - def to_hash: -> { - bucket: String, - client_email: String, - name: String, - private_key: String, - type: :GCS, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type azure_blob = - { - account_name: String, - container: String, - name: String, - sas_token: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - - class AzureBlob < Imagekit::Internal::Type::BaseModel - attr_accessor account_name: String - - attr_accessor container: String - - attr_accessor name: String - - attr_accessor sas_token: String - - attr_accessor type: :AZURE_BLOB - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - attr_reader prefix: String? - - def prefix=: (String) -> String - - def initialize: ( - account_name: String, - container: String, - name: String, - sas_token: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?prefix: String, - ?type: :AZURE_BLOB - ) -> void - - def to_hash: -> { - account_name: String, - container: String, - name: String, - sas_token: String, - type: :AZURE_BLOB, - base_url_for_canonical_header: String, - include_canonical_header: bool, - prefix: String - } - end - - type akeneo_pim = - { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: :AKENEO_PIM, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - - class AkeneoPim < Imagekit::Internal::Type::BaseModel - attr_accessor base_url: String - - attr_accessor client_id: String - - attr_accessor client_secret: String - - attr_accessor name: String - - attr_accessor password: String - - attr_accessor type: :AKENEO_PIM - - attr_accessor username: String - - attr_reader base_url_for_canonical_header: String? - - def base_url_for_canonical_header=: (String) -> String - - attr_reader include_canonical_header: bool? - - def include_canonical_header=: (bool) -> bool - - def initialize: ( - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - username: String, - ?base_url_for_canonical_header: String, - ?include_canonical_header: bool, - ?type: :AKENEO_PIM - ) -> void - - def to_hash: -> { - base_url: String, - client_id: String, - client_secret: String, - name: String, - password: String, - type: :AKENEO_PIM, - username: String, - base_url_for_canonical_header: String, - include_canonical_header: bool - } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::OriginUpdateParams::origin] - end + def to_hash: -> { request_options: Imagekit::RequestOptions } end end end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index 67c657b8..3cc90be7 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -3,13 +3,13 @@ module Imagekit class Accounts class Origins def create: ( - origin: Imagekit::Models::Accounts::OriginCreateParams::origin, + origin: Imagekit::Models::Accounts::origin_request, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_response def update: ( String id, - origin: Imagekit::Models::Accounts::OriginUpdateParams::origin, + origin: Imagekit::Models::Accounts::origin_request, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_response From 88caf3be549eb0434e3ac96c58621b075a9e30ee Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:14:24 +0000 Subject: [PATCH 051/178] feat(api): manual updates --- .stats.yml | 6 +- lib/imagekit.rb | 6 +- .../accounts/url_endpoint_create_params.rb | 2 +- .../accounts/url_endpoint_get_response.rb | 123 ---------- .../accounts/url_endpoint_list_response.rb | 118 +--------- ...rl_endpoint.rb => url_endpoint_request.rb} | 22 +- ...e_response.rb => url_endpoint_response.rb} | 20 +- .../accounts/url_endpoint_update_params.rb | 2 +- .../accounts/url_endpoint_update_response.rb | 123 ---------- .../resources/accounts/url_endpoints.rb | 20 +- .../accounts/url_endpoint_create_params.rbi | 2 +- .../accounts/url_endpoint_create_response.rbi | 213 ------------------ .../accounts/url_endpoint_list_response.rbi | 208 +---------------- ..._endpoint.rbi => url_endpoint_request.rbi} | 47 ++-- ...response.rbi => url_endpoint_response.rbi} | 34 +-- .../accounts/url_endpoint_update_params.rbi | 2 +- .../accounts/url_endpoint_update_response.rbi | 213 ------------------ .../resources/accounts/url_endpoints.rbi | 20 +- .../accounts/url_endpoint_create_params.rbs | 2 +- .../accounts/url_endpoint_create_response.rbs | 96 -------- .../accounts/url_endpoint_list_response.rbs | 93 +------- ..._endpoint.rbs => url_endpoint_request.rbs} | 24 +- ...response.rbs => url_endpoint_response.rbs} | 24 +- .../accounts/url_endpoint_update_params.rbs | 2 +- .../accounts/url_endpoint_update_response.rbs | 96 -------- .../resources/accounts/url_endpoints.rbs | 10 +- .../resources/accounts/url_endpoints_test.rb | 14 +- 27 files changed, 133 insertions(+), 1409 deletions(-) delete mode 100644 lib/imagekit/models/accounts/url_endpoint_get_response.rb rename lib/imagekit/models/accounts/{url_endpoint.rb => url_endpoint_request.rb} (75%) rename lib/imagekit/models/accounts/{url_endpoint_create_response.rb => url_endpoint_response.rb} (74%) delete mode 100644 lib/imagekit/models/accounts/url_endpoint_update_response.rb delete mode 100644 rbi/imagekit/models/accounts/url_endpoint_create_response.rbi rename rbi/imagekit/models/accounts/{url_endpoint.rbi => url_endpoint_request.rbi} (74%) rename rbi/imagekit/models/accounts/{url_endpoint_get_response.rbi => url_endpoint_response.rbi} (78%) delete mode 100644 rbi/imagekit/models/accounts/url_endpoint_update_response.rbi delete mode 100644 sig/imagekit/models/accounts/url_endpoint_create_response.rbs rename sig/imagekit/models/accounts/{url_endpoint.rbs => url_endpoint_request.rbs} (74%) rename sig/imagekit/models/accounts/{url_endpoint_get_response.rbs => url_endpoint_response.rbs} (72%) delete mode 100644 sig/imagekit/models/accounts/url_endpoint_update_response.rbs diff --git a/.stats.yml b/.stats.yml index d8061136..e88489f2 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-fa82106bb6313906d2eaac167e0ca5f60f12a166c743c00a18c22be0e455c1b6.yml -openapi_spec_hash: 8ff6fc6886e8d7a9eee6d45d51e9673c -config_hash: e1442470f0f1b22d8558d6ca9526e0ea +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-547b616849eececf3f5b1ea38ebe1dba718e1877c787e3642b9c91e552548789.yml +openapi_spec_hash: fba0bf8c1ee034067ab6ae93f84abeae +config_hash: befd7c8f04cc5b4992ec11efe0d6934b diff --git a/lib/imagekit.rb b/lib/imagekit.rb index d41b38be..6ee022d6 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -51,7 +51,7 @@ require_relative "imagekit/internal/transport/pooled_net_requester" require_relative "imagekit/client" require_relative "imagekit/models/accounts/origin_request" -require_relative "imagekit/models/accounts/url_endpoint" +require_relative "imagekit/models/accounts/url_endpoint_request" require_relative "imagekit/models/file" require_relative "imagekit/models/accounts/origin_create_params" require_relative "imagekit/models/accounts/origin_delete_params" @@ -61,14 +61,12 @@ require_relative "imagekit/models/accounts/origin_response" require_relative "imagekit/models/accounts/origin_update_params" require_relative "imagekit/models/accounts/url_endpoint_create_params" -require_relative "imagekit/models/accounts/url_endpoint_create_response" require_relative "imagekit/models/accounts/url_endpoint_delete_params" require_relative "imagekit/models/accounts/url_endpoint_get_params" -require_relative "imagekit/models/accounts/url_endpoint_get_response" require_relative "imagekit/models/accounts/url_endpoint_list_params" require_relative "imagekit/models/accounts/url_endpoint_list_response" +require_relative "imagekit/models/accounts/url_endpoint_response" require_relative "imagekit/models/accounts/url_endpoint_update_params" -require_relative "imagekit/models/accounts/url_endpoint_update_response" require_relative "imagekit/models/accounts/usage_get_params" require_relative "imagekit/models/accounts/usage_get_response" require_relative "imagekit/models/asset_list_params" diff --git a/lib/imagekit/models/accounts/url_endpoint_create_params.rb b/lib/imagekit/models/accounts/url_endpoint_create_params.rb index 73a4cc8a..5a065839 100644 --- a/lib/imagekit/models/accounts/url_endpoint_create_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_create_params.rb @@ -4,7 +4,7 @@ module Imagekit module Models module Accounts # @see Imagekit::Resources::Accounts::URLEndpoints#create - class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpoint + class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpointRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/accounts/url_endpoint_get_response.rb b/lib/imagekit/models/accounts/url_endpoint_get_response.rb deleted file mode 100644 index 07bbaea0..00000000 --- a/lib/imagekit/models/accounts/url_endpoint_get_response.rb +++ /dev/null @@ -1,123 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::URLEndpoints#get - class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel - # @!attribute description - # Description of the URL endpoint. - # - # @return [String] - required :description, String - - # @!attribute 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. - # - # @return [Array] - required :origins, Imagekit::Internal::Type::ArrayOf[String] - - # @!attribute url_prefix - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - # - # @return [String] - required :url_prefix, String, api_name: :urlPrefix - - # @!attribute url_rewriter - # Configuration for third-party URL rewriting. - # - # @return [Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai, nil] - optional :url_rewriter, - union: -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter }, - api_name: :urlRewriter - - response_only do - # @!attribute id - # 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`. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointGetResponse} for more details. - # - # URL‑endpoint object as returned by the API. - # - # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c - # - # @param description [String] Description of the URL endpoint. - # - # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag - # - # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an - # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. - - # Configuration for third-party URL rewriting. - # - # @see Imagekit::Models::Accounts::URLEndpointGetResponse#url_rewriter - module URLRewriter - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :CLOUDINARY, -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary } - - variant :IMGIX, -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix } - - variant :AKAMAI, -> { Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - # @!attribute preserve_asset_delivery_types - # Whether to preserve `/` in the rewritten URL. - # - # @return [Boolean] - required :preserve_asset_delivery_types, - Imagekit::Internal::Type::Boolean, - api_name: :preserveAssetDeliveryTypes - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY] - required :type, const: :CLOUDINARY - - # @!method initialize(preserve_asset_delivery_types:, type: :CLOUDINARY) - # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. - # - # @param type [Symbol, :CLOUDINARY] - end - - class Imgix < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :IMGIX] - required :type, const: :IMGIX - - # @!method initialize(type: :IMGIX) - # @param type [Symbol, :IMGIX] - end - - class Akamai < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :AKAMAI] - required :type, const: :AKAMAI - - # @!method initialize(type: :AKAMAI) - # @param type [Symbol, :AKAMAI] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai)] - end - end - end - end -end diff --git a/lib/imagekit/models/accounts/url_endpoint_list_response.rb b/lib/imagekit/models/accounts/url_endpoint_list_response.rb index 1d8b7aae..054376a9 100644 --- a/lib/imagekit/models/accounts/url_endpoint_list_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_list_response.rb @@ -3,125 +3,9 @@ module Imagekit module Models module Accounts - class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel - # @!attribute description - # Description of the URL endpoint. - # - # @return [String] - required :description, String - - # @!attribute 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. - # - # @return [Array] - required :origins, Imagekit::Internal::Type::ArrayOf[String] - - # @!attribute url_prefix - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - # - # @return [String] - required :url_prefix, String, api_name: :urlPrefix - - # @!attribute url_rewriter - # Configuration for third-party URL rewriting. - # - # @return [Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai, nil] - optional :url_rewriter, - union: -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter }, - api_name: :urlRewriter - - response_only do - # @!attribute id - # 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`. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointListResponseItem} for more details. - # - # URL‑endpoint object as returned by the API. - # - # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c - # - # @param description [String] Description of the URL endpoint. - # - # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag - # - # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an - # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai] Configuration for third-party URL rewriting. - - # Configuration for third-party URL rewriting. - # - # @see Imagekit::Models::Accounts::URLEndpointListResponseItem#url_rewriter - module URLRewriter - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :CLOUDINARY, - -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary } - - variant :IMGIX, -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix } - - variant :AKAMAI, -> { Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - # @!attribute preserve_asset_delivery_types - # Whether to preserve `/` in the rewritten URL. - # - # @return [Boolean] - required :preserve_asset_delivery_types, - Imagekit::Internal::Type::Boolean, - api_name: :preserveAssetDeliveryTypes - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY] - required :type, const: :CLOUDINARY - - # @!method initialize(preserve_asset_delivery_types:, type: :CLOUDINARY) - # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. - # - # @param type [Symbol, :CLOUDINARY] - end - - class Imgix < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :IMGIX] - required :type, const: :IMGIX - - # @!method initialize(type: :IMGIX) - # @param type [Symbol, :IMGIX] - end - - class Akamai < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :AKAMAI] - required :type, const: :AKAMAI - - # @!method initialize(type: :AKAMAI) - # @param type [Symbol, :AKAMAI] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai)] - end - end - # @type [Imagekit::Internal::Type::Converter] URLEndpointListResponse = - Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Models::Accounts::URLEndpointListResponseItem }] + Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Accounts::URLEndpointResponse }] end end end diff --git a/lib/imagekit/models/accounts/url_endpoint.rb b/lib/imagekit/models/accounts/url_endpoint_request.rb similarity index 75% rename from lib/imagekit/models/accounts/url_endpoint.rb rename to lib/imagekit/models/accounts/url_endpoint_request.rb index 99d559ae..32c945fc 100644 --- a/lib/imagekit/models/accounts/url_endpoint.rb +++ b/lib/imagekit/models/accounts/url_endpoint_request.rb @@ -3,7 +3,7 @@ module Imagekit module Models module Accounts - class URLEndpoint < Imagekit::Internal::Type::BaseModel + class URLEndpointRequest < Imagekit::Internal::Type::BaseModel # @!attribute description # Description of the URL endpoint. # @@ -28,16 +28,14 @@ class URLEndpoint < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai, nil] + # @return [Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai, nil] optional :url_rewriter, - union: -> { - Imagekit::Accounts::URLEndpoint::URLRewriter - }, + union: -> { Imagekit::Accounts::URLEndpointRequest::URLRewriter }, api_name: :urlRewriter # @!method initialize(description:, origins: nil, url_prefix: nil, url_rewriter: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpoint} for more details. + # {Imagekit::Models::Accounts::URLEndpointRequest} for more details. # # Schema for URL endpoint resource. # @@ -47,21 +45,21 @@ class URLEndpoint < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. # Configuration for third-party URL rewriting. # - # @see Imagekit::Models::Accounts::URLEndpoint#url_rewriter + # @see Imagekit::Models::Accounts::URLEndpointRequest#url_rewriter module URLRewriter extend Imagekit::Internal::Type::Union discriminator :type - variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary } + variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary } - variant :IMGIX, -> { Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix } + variant :IMGIX, -> { Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix } - variant :AKAMAI, -> { Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai } + variant :AKAMAI, -> { Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai } class Cloudinary < Imagekit::Internal::Type::BaseModel # @!attribute type @@ -104,7 +102,7 @@ class Akamai < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai)] + # @return [Array(Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai)] end end end diff --git a/lib/imagekit/models/accounts/url_endpoint_create_response.rb b/lib/imagekit/models/accounts/url_endpoint_response.rb similarity index 74% rename from lib/imagekit/models/accounts/url_endpoint_create_response.rb rename to lib/imagekit/models/accounts/url_endpoint_response.rb index bec8e174..3ea557dc 100644 --- a/lib/imagekit/models/accounts/url_endpoint_create_response.rb +++ b/lib/imagekit/models/accounts/url_endpoint_response.rb @@ -4,7 +4,7 @@ module Imagekit module Models module Accounts # @see Imagekit::Resources::Accounts::URLEndpoints#create - class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel + class URLEndpointResponse < Imagekit::Internal::Type::BaseModel # @!attribute description # Description of the URL endpoint. # @@ -29,9 +29,9 @@ class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai, nil] + # @return [Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai, nil] optional :url_rewriter, - union: -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter }, + union: -> { Imagekit::Accounts::URLEndpointResponse::URLRewriter }, api_name: :urlRewriter response_only do @@ -46,7 +46,7 @@ class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointCreateResponse} for more details. + # {Imagekit::Models::Accounts::URLEndpointResponse} for more details. # # URL‑endpoint object as returned by the API. # @@ -58,21 +58,21 @@ class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. # Configuration for third-party URL rewriting. # - # @see Imagekit::Models::Accounts::URLEndpointCreateResponse#url_rewriter + # @see Imagekit::Models::Accounts::URLEndpointResponse#url_rewriter module URLRewriter extend Imagekit::Internal::Type::Union discriminator :type - variant :CLOUDINARY, -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary } + variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary } - variant :IMGIX, -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix } + variant :IMGIX, -> { Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix } - variant :AKAMAI, -> { Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai } + variant :AKAMAI, -> { Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai } class Cloudinary < Imagekit::Internal::Type::BaseModel # @!attribute preserve_asset_delivery_types @@ -115,7 +115,7 @@ class Akamai < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai)] + # @return [Array(Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai)] end end end diff --git a/lib/imagekit/models/accounts/url_endpoint_update_params.rb b/lib/imagekit/models/accounts/url_endpoint_update_params.rb index adb2c10d..cb1bca4f 100644 --- a/lib/imagekit/models/accounts/url_endpoint_update_params.rb +++ b/lib/imagekit/models/accounts/url_endpoint_update_params.rb @@ -4,7 +4,7 @@ module Imagekit module Models module Accounts # @see Imagekit::Resources::Accounts::URLEndpoints#update - class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpoint + class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpointRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/lib/imagekit/models/accounts/url_endpoint_update_response.rb b/lib/imagekit/models/accounts/url_endpoint_update_response.rb deleted file mode 100644 index ba87d374..00000000 --- a/lib/imagekit/models/accounts/url_endpoint_update_response.rb +++ /dev/null @@ -1,123 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::URLEndpoints#update - class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel - # @!attribute description - # Description of the URL endpoint. - # - # @return [String] - required :description, String - - # @!attribute 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. - # - # @return [Array] - required :origins, Imagekit::Internal::Type::ArrayOf[String] - - # @!attribute url_prefix - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - # - # @return [String] - required :url_prefix, String, api_name: :urlPrefix - - # @!attribute url_rewriter - # Configuration for third-party URL rewriting. - # - # @return [Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai, nil] - optional :url_rewriter, - union: -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter }, - api_name: :urlRewriter - - response_only do - # @!attribute id - # 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`. - # - # @return [String] - required :id, String - end - - # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointUpdateResponse} for more details. - # - # URL‑endpoint object as returned by the API. - # - # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c - # - # @param description [String] Description of the URL endpoint. - # - # @param origins [Array] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag - # - # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an - # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. - - # Configuration for third-party URL rewriting. - # - # @see Imagekit::Models::Accounts::URLEndpointUpdateResponse#url_rewriter - module URLRewriter - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :CLOUDINARY, -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary } - - variant :IMGIX, -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix } - - variant :AKAMAI, -> { Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - # @!attribute preserve_asset_delivery_types - # Whether to preserve `/` in the rewritten URL. - # - # @return [Boolean] - required :preserve_asset_delivery_types, - Imagekit::Internal::Type::Boolean, - api_name: :preserveAssetDeliveryTypes - - # @!attribute type - # - # @return [Symbol, :CLOUDINARY] - required :type, const: :CLOUDINARY - - # @!method initialize(preserve_asset_delivery_types:, type: :CLOUDINARY) - # @param preserve_asset_delivery_types [Boolean] Whether to preserve `/` in the rewritten URL. - # - # @param type [Symbol, :CLOUDINARY] - end - - class Imgix < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :IMGIX] - required :type, const: :IMGIX - - # @!method initialize(type: :IMGIX) - # @param type [Symbol, :IMGIX] - end - - class Akamai < Imagekit::Internal::Type::BaseModel - # @!attribute type - # - # @return [Symbol, :AKAMAI] - required :type, const: :AKAMAI - - # @!method initialize(type: :AKAMAI) - # @param type [Symbol, :AKAMAI] - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai)] - end - end - end - end -end diff --git a/lib/imagekit/resources/accounts/url_endpoints.rb b/lib/imagekit/resources/accounts/url_endpoints.rb index 657a4c74..c94d9fe9 100644 --- a/lib/imagekit/resources/accounts/url_endpoints.rb +++ b/lib/imagekit/resources/accounts/url_endpoints.rb @@ -18,11 +18,11 @@ class URLEndpoints # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::URLEndpointCreateResponse] + # @return [Imagekit::Models::Accounts::URLEndpointResponse] # # @see Imagekit::Models::Accounts::URLEndpointCreateParams def create(params) @@ -31,7 +31,7 @@ def create(params) method: :post, path: "v1/accounts/url-endpoints", body: parsed, - model: Imagekit::Models::Accounts::URLEndpointCreateResponse, + model: Imagekit::Accounts::URLEndpointResponse, options: options ) end @@ -52,11 +52,11 @@ def create(params) # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpoint::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::URLEndpointUpdateResponse] + # @return [Imagekit::Models::Accounts::URLEndpointResponse] # # @see Imagekit::Models::Accounts::URLEndpointUpdateParams def update(id, params) @@ -65,7 +65,7 @@ def update(id, params) method: :put, path: ["v1/accounts/url-endpoints/%1$s", id], body: parsed, - model: Imagekit::Models::Accounts::URLEndpointUpdateResponse, + model: Imagekit::Accounts::URLEndpointResponse, options: options ) end @@ -78,14 +78,14 @@ def update(id, params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Imagekit::Models::Accounts::URLEndpointListParams def list(params = {}) @client.request( method: :get, path: "v1/accounts/url-endpoints", - model: Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Accounts::URLEndpointListResponseItem], + model: Imagekit::Internal::Type::ArrayOf[Imagekit::Accounts::URLEndpointResponse], options: params[:request_options] ) end @@ -127,14 +127,14 @@ def delete(id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::URLEndpointGetResponse] + # @return [Imagekit::Models::Accounts::URLEndpointResponse] # # @see Imagekit::Models::Accounts::URLEndpointGetParams def get(id, params = {}) @client.request( method: :get, path: ["v1/accounts/url-endpoints/%1$s", id], - model: Imagekit::Models::Accounts::URLEndpointGetResponse, + model: Imagekit::Accounts::URLEndpointResponse, options: params[:request_options] ) end diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi index 5bf7b76b..002fe2e3 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi @@ -3,7 +3,7 @@ module Imagekit module Models module Accounts - class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpoint + class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpointRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi deleted file mode 100644 index 20f97a9c..00000000 --- a/rbi/imagekit/models/accounts/url_endpoint_create_response.rbi +++ /dev/null @@ -1,213 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse, - Imagekit::Internal::AnyHash - ) - end - - # Description of the URL endpoint. - sig { returns(String) } - attr_accessor :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. - sig { returns(T::Array[String]) } - attr_accessor :origins - - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - sig { returns(String) } - attr_accessor :url_prefix - - # Configuration for third-party URL rewriting. - sig do - returns( - T.nilable( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Variants - ) - ) - end - attr_reader :url_rewriter - - sig do - params( - url_rewriter: - T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary::OrHash, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix::OrHash, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai::OrHash - ) - ).void - end - attr_writer :url_rewriter - - # 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`. - sig { returns(String) } - attr_accessor :id - - # URL‑endpoint object as returned by the API. - sig do - params( - id: String, - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary::OrHash, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix::OrHash, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai::OrHash - ) - ).returns(T.attached_class) - end - def self.new( - # 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`. - id:, - # Description of the URL endpoint. - 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. - origins:, - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - url_prefix:, - # Configuration for third-party URL rewriting. - url_rewriter: nil - ) - end - - sig do - override.returns( - { - id: String, - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Variants - } - ) - end - def to_hash - end - - # Configuration for third-party URL rewriting. - module URLRewriter - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai - ) - end - - class Cloudinary < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary, - Imagekit::Internal::AnyHash - ) - end - - # Whether to preserve `/` in the rewritten URL. - sig { returns(T::Boolean) } - attr_accessor :preserve_asset_delivery_types - - sig { returns(Symbol) } - attr_accessor :type - - sig do - params( - preserve_asset_delivery_types: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Whether to preserve `/` in the rewritten URL. - preserve_asset_delivery_types:, - type: :CLOUDINARY - ) - end - - sig do - override.returns( - { preserve_asset_delivery_types: T::Boolean, type: Symbol } - ) - end - def to_hash - end - end - - class Imgix < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :IMGIX) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - class Akamai < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :AKAMAI) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Variants - ] - ) - end - def self.variants - end - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi index 23c9e464..d943f0ea 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi @@ -3,216 +3,10 @@ module Imagekit module Models module Accounts - class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem, - Imagekit::Internal::AnyHash - ) - end - - # Description of the URL endpoint. - sig { returns(String) } - attr_accessor :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. - sig { returns(T::Array[String]) } - attr_accessor :origins - - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - sig { returns(String) } - attr_accessor :url_prefix - - # Configuration for third-party URL rewriting. - sig do - returns( - T.nilable( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Variants - ) - ) - end - attr_reader :url_rewriter - - sig do - params( - url_rewriter: - T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary::OrHash, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix::OrHash, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai::OrHash - ) - ).void - end - attr_writer :url_rewriter - - # 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`. - sig { returns(String) } - attr_accessor :id - - # URL‑endpoint object as returned by the API. - sig do - params( - id: String, - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary::OrHash, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix::OrHash, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai::OrHash - ) - ).returns(T.attached_class) - end - def self.new( - # 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`. - id:, - # Description of the URL endpoint. - 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. - origins:, - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - url_prefix:, - # Configuration for third-party URL rewriting. - url_rewriter: nil - ) - end - - sig do - override.returns( - { - id: String, - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Variants - } - ) - end - def to_hash - end - - # Configuration for third-party URL rewriting. - module URLRewriter - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai - ) - end - - class Cloudinary < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary, - Imagekit::Internal::AnyHash - ) - end - - # Whether to preserve `/` in the rewritten URL. - sig { returns(T::Boolean) } - attr_accessor :preserve_asset_delivery_types - - sig { returns(Symbol) } - attr_accessor :type - - sig do - params( - preserve_asset_delivery_types: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Whether to preserve `/` in the rewritten URL. - preserve_asset_delivery_types:, - type: :CLOUDINARY - ) - end - - sig do - override.returns( - { preserve_asset_delivery_types: T::Boolean, type: Symbol } - ) - end - def to_hash - end - end - - class Imgix < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :IMGIX) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - class Akamai < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :AKAMAI) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Variants - ] - ) - end - def self.variants - end - end - end - URLEndpointListResponse = T.let( Imagekit::Internal::Type::ArrayOf[ - Imagekit::Models::Accounts::URLEndpointListResponseItem + Imagekit::Accounts::URLEndpointResponse ], Imagekit::Internal::Type::Converter ) diff --git a/rbi/imagekit/models/accounts/url_endpoint.rbi b/rbi/imagekit/models/accounts/url_endpoint_request.rbi similarity index 74% rename from rbi/imagekit/models/accounts/url_endpoint.rbi rename to rbi/imagekit/models/accounts/url_endpoint_request.rbi index 01a1191e..f36ad090 100644 --- a/rbi/imagekit/models/accounts/url_endpoint.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_request.rbi @@ -3,10 +3,13 @@ module Imagekit module Models module Accounts - class URLEndpoint < Imagekit::Internal::Type::BaseModel + class URLEndpointRequest < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::Accounts::URLEndpoint, Imagekit::Internal::AnyHash) + T.any( + Imagekit::Accounts::URLEndpointRequest, + Imagekit::Internal::AnyHash + ) end # Description of the URL endpoint. @@ -35,9 +38,9 @@ module Imagekit returns( T.nilable( T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai ) ) ) @@ -48,9 +51,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai::OrHash + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash ) ).void end @@ -64,9 +67,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai::OrHash + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash ) ).returns(T.attached_class) end @@ -93,9 +96,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai ) } ) @@ -110,9 +113,9 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai ) end @@ -120,7 +123,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Internal::AnyHash ) end @@ -161,7 +164,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Internal::AnyHash ) end @@ -182,7 +185,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai, Imagekit::Internal::AnyHash ) end @@ -201,7 +204,9 @@ module Imagekit sig do override.returns( - T::Array[Imagekit::Accounts::URLEndpoint::URLRewriter::Variants] + T::Array[ + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Variants + ] ) end def self.variants diff --git a/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_response.rbi similarity index 78% rename from rbi/imagekit/models/accounts/url_endpoint_get_response.rbi rename to rbi/imagekit/models/accounts/url_endpoint_response.rbi index c50dc4fe..6600ca95 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_get_response.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_response.rbi @@ -3,11 +3,11 @@ module Imagekit module Models module Accounts - class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel + class URLEndpointResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse, + Imagekit::Accounts::URLEndpointResponse, Imagekit::Internal::AnyHash ) end @@ -31,7 +31,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Variants + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Variants ) ) end @@ -41,9 +41,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary::OrHash, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix::OrHash, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai::OrHash + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai::OrHash ) ).void end @@ -64,9 +64,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary::OrHash, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix::OrHash, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai::OrHash + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai::OrHash ) ).returns(T.attached_class) end @@ -97,7 +97,7 @@ module Imagekit origins: T::Array[String], url_prefix: String, url_rewriter: - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Variants + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Variants } ) end @@ -111,9 +111,9 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai ) end @@ -121,7 +121,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekit::Internal::AnyHash ) end @@ -159,7 +159,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekit::Internal::AnyHash ) end @@ -180,7 +180,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai, + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai, Imagekit::Internal::AnyHash ) end @@ -200,7 +200,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Variants + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Variants ] ) end diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi index bb2019a9..91f649a0 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi +++ b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi @@ -3,7 +3,7 @@ module Imagekit module Models module Accounts - class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpoint + class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpointRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi deleted file mode 100644 index 337cd8ba..00000000 --- a/rbi/imagekit/models/accounts/url_endpoint_update_response.rbi +++ /dev/null @@ -1,213 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse, - Imagekit::Internal::AnyHash - ) - end - - # Description of the URL endpoint. - sig { returns(String) } - attr_accessor :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. - sig { returns(T::Array[String]) } - attr_accessor :origins - - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - sig { returns(String) } - attr_accessor :url_prefix - - # Configuration for third-party URL rewriting. - sig do - returns( - T.nilable( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Variants - ) - ) - end - attr_reader :url_rewriter - - sig do - params( - url_rewriter: - T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary::OrHash, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix::OrHash, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai::OrHash - ) - ).void - end - attr_writer :url_rewriter - - # 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`. - sig { returns(String) } - attr_accessor :id - - # URL‑endpoint object as returned by the API. - sig do - params( - id: String, - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary::OrHash, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix::OrHash, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai::OrHash - ) - ).returns(T.attached_class) - end - def self.new( - # 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`. - id:, - # Description of the URL endpoint. - 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. - origins:, - # Path segment appended to your base URL to form the endpoint (letters, digits, - # and hyphens only — or empty for the default endpoint). - url_prefix:, - # Configuration for third-party URL rewriting. - url_rewriter: nil - ) - end - - sig do - override.returns( - { - id: String, - description: String, - origins: T::Array[String], - url_prefix: String, - url_rewriter: - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Variants - } - ) - end - def to_hash - end - - # Configuration for third-party URL rewriting. - module URLRewriter - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai - ) - end - - class Cloudinary < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary, - Imagekit::Internal::AnyHash - ) - end - - # Whether to preserve `/` in the rewritten URL. - sig { returns(T::Boolean) } - attr_accessor :preserve_asset_delivery_types - - sig { returns(Symbol) } - attr_accessor :type - - sig do - params( - preserve_asset_delivery_types: T::Boolean, - type: Symbol - ).returns(T.attached_class) - end - def self.new( - # Whether to preserve `/` in the rewritten URL. - preserve_asset_delivery_types:, - type: :CLOUDINARY - ) - end - - sig do - override.returns( - { preserve_asset_delivery_types: T::Boolean, type: Symbol } - ) - end - def to_hash - end - end - - class Imgix < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :IMGIX) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - class Akamai < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(Symbol) } - attr_accessor :type - - sig { params(type: Symbol).returns(T.attached_class) } - def self.new(type: :AKAMAI) - end - - sig { override.returns({ type: Symbol }) } - def to_hash - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Variants - ] - ) - end - def self.variants - end - end - end - end - end -end diff --git a/rbi/imagekit/resources/accounts/url_endpoints.rbi b/rbi/imagekit/resources/accounts/url_endpoints.rbi index 02db5c95..46a2a571 100644 --- a/rbi/imagekit/resources/accounts/url_endpoints.rbi +++ b/rbi/imagekit/resources/accounts/url_endpoints.rbi @@ -13,12 +13,12 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai::OrHash + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash ), request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Accounts::URLEndpointCreateResponse) + ).returns(Imagekit::Accounts::URLEndpointResponse) end def create( # Description of the URL endpoint. @@ -46,12 +46,12 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai::OrHash + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash ), request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Accounts::URLEndpointUpdateResponse) + ).returns(Imagekit::Accounts::URLEndpointResponse) end def update( # Unique identifier for the URL-endpoint. This is generated by ImageKit when you @@ -78,7 +78,7 @@ module Imagekit # URL-endpoint generated by ImageKit during account creation. sig do params(request_options: Imagekit::RequestOptions::OrHash).returns( - T::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem] + T::Array[Imagekit::Accounts::URLEndpointResponse] ) end def list(request_options: {}) @@ -108,7 +108,7 @@ module Imagekit params( id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Accounts::URLEndpointGetResponse) + ).returns(Imagekit::Accounts::URLEndpointResponse) end def get( # Unique identifier for the URL-endpoint. This is generated by ImageKit when you diff --git a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs index 42b1f99b..d657e79d 100644 --- a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs @@ -4,7 +4,7 @@ module Imagekit type url_endpoint_create_params = { } & Imagekit::Internal::Type::request_parameters - class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpoint + class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpointRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/accounts/url_endpoint_create_response.rbs b/sig/imagekit/models/accounts/url_endpoint_create_response.rbs deleted file mode 100644 index 4cb7d592..00000000 --- a/sig/imagekit/models/accounts/url_endpoint_create_response.rbs +++ /dev/null @@ -1,96 +0,0 @@ -module Imagekit - module Models - module Accounts - type url_endpoint_create_response = - { - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter - } - - class URLEndpointCreateResponse < Imagekit::Internal::Type::BaseModel - attr_accessor description: String - - attr_accessor origins: ::Array[String] - - attr_accessor url_prefix: String - - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter? - - def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter - - attr_accessor id: String - - def initialize: ( - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter - ) -> void - - def to_hash: -> { - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter - } - - type url_rewriter = - Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Cloudinary - | Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Imgix - | Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter::Akamai - - module URLRewriter - extend Imagekit::Internal::Type::Union - - type cloudinary = - { preserve_asset_delivery_types: bool, type: :CLOUDINARY } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - attr_accessor preserve_asset_delivery_types: bool - - attr_accessor type: :CLOUDINARY - - def initialize: ( - preserve_asset_delivery_types: bool, - ?type: :CLOUDINARY - ) -> void - - def to_hash: -> { - preserve_asset_delivery_types: bool, - type: :CLOUDINARY - } - end - - type imgix = { type: :IMGIX } - - class Imgix < Imagekit::Internal::Type::BaseModel - attr_accessor type: :IMGIX - - def initialize: (?type: :IMGIX) -> void - - def to_hash: -> { type: :IMGIX } - end - - type akamai = { type: :AKAMAI } - - class Akamai < Imagekit::Internal::Type::BaseModel - attr_accessor type: :AKAMAI - - def initialize: (?type: :AKAMAI) -> void - - def to_hash: -> { type: :AKAMAI } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointCreateResponse::url_rewriter] - end - end - end - end -end diff --git a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs index c07ee939..01943b07 100644 --- a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs @@ -1,99 +1,8 @@ module Imagekit module Models module Accounts - type url_endpoint_list_response_item = - { - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter - } - - class URLEndpointListResponseItem < Imagekit::Internal::Type::BaseModel - attr_accessor description: String - - attr_accessor origins: ::Array[String] - - attr_accessor url_prefix: String - - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter? - - def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter - - attr_accessor id: String - - def initialize: ( - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter - ) -> void - - def to_hash: -> { - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter - } - - type url_rewriter = - Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Cloudinary - | Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Imgix - | Imagekit::Models::Accounts::URLEndpointListResponseItem::URLRewriter::Akamai - - module URLRewriter - extend Imagekit::Internal::Type::Union - - type cloudinary = - { preserve_asset_delivery_types: bool, type: :CLOUDINARY } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - attr_accessor preserve_asset_delivery_types: bool - - attr_accessor type: :CLOUDINARY - - def initialize: ( - preserve_asset_delivery_types: bool, - ?type: :CLOUDINARY - ) -> void - - def to_hash: -> { - preserve_asset_delivery_types: bool, - type: :CLOUDINARY - } - end - - type imgix = { type: :IMGIX } - - class Imgix < Imagekit::Internal::Type::BaseModel - attr_accessor type: :IMGIX - - def initialize: (?type: :IMGIX) -> void - - def to_hash: -> { type: :IMGIX } - end - - type akamai = { type: :AKAMAI } - - class Akamai < Imagekit::Internal::Type::BaseModel - attr_accessor type: :AKAMAI - - def initialize: (?type: :AKAMAI) -> void - - def to_hash: -> { type: :AKAMAI } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem::url_rewriter] - end - end - type url_endpoint_list_response = - ::Array[Imagekit::Models::Accounts::URLEndpointListResponseItem] + ::Array[Imagekit::Accounts::URLEndpointResponse] URLEndpointListResponse: Imagekit::Internal::Type::Converter end diff --git a/sig/imagekit/models/accounts/url_endpoint.rbs b/sig/imagekit/models/accounts/url_endpoint_request.rbs similarity index 74% rename from sig/imagekit/models/accounts/url_endpoint.rbs rename to sig/imagekit/models/accounts/url_endpoint_request.rbs index 8ab66ead..de0983f1 100644 --- a/sig/imagekit/models/accounts/url_endpoint.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_request.rbs @@ -1,15 +1,15 @@ module Imagekit module Models module Accounts - type url_endpoint = + type url_endpoint_request = { description: String, origins: ::Array[String], url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter + url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter } - class URLEndpoint < Imagekit::Internal::Type::BaseModel + class URLEndpointRequest < Imagekit::Internal::Type::BaseModel attr_accessor description: String attr_reader origins: ::Array[String]? @@ -20,30 +20,30 @@ module Imagekit def url_prefix=: (String) -> String - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter? + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter? def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpoint::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpoint::url_rewriter + Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter def initialize: ( description: String, ?origins: ::Array[String], ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter ) -> void def to_hash: -> { description: String, origins: ::Array[String], url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter + url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter } type url_rewriter = - Imagekit::Accounts::URLEndpoint::URLRewriter::Cloudinary - | Imagekit::Accounts::URLEndpoint::URLRewriter::Imgix - | Imagekit::Accounts::URLEndpoint::URLRewriter::Akamai + Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary + | Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix + | Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai module URLRewriter extend Imagekit::Internal::Type::Union @@ -89,7 +89,7 @@ module Imagekit def to_hash: -> { type: :AKAMAI } end - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpoint::url_rewriter] + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter] end end end diff --git a/sig/imagekit/models/accounts/url_endpoint_get_response.rbs b/sig/imagekit/models/accounts/url_endpoint_response.rbs similarity index 72% rename from sig/imagekit/models/accounts/url_endpoint_get_response.rbs rename to sig/imagekit/models/accounts/url_endpoint_response.rbs index c0658a6a..8c2da016 100644 --- a/sig/imagekit/models/accounts/url_endpoint_get_response.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_response.rbs @@ -1,27 +1,27 @@ module Imagekit module Models module Accounts - type url_endpoint_get_response = + type url_endpoint_response = { id: String, description: String, origins: ::Array[String], url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + url_rewriter: Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter } - class URLEndpointGetResponse < Imagekit::Internal::Type::BaseModel + class URLEndpointResponse < Imagekit::Internal::Type::BaseModel attr_accessor description: String attr_accessor origins: ::Array[String] attr_accessor url_prefix: String - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter? + attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter? def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter + ) -> Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter attr_accessor id: String @@ -30,7 +30,7 @@ module Imagekit description: String, origins: ::Array[String], url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter ) -> void def to_hash: -> { @@ -38,13 +38,13 @@ module Imagekit description: String, origins: ::Array[String], url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter + url_rewriter: Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter } type url_rewriter = - Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Cloudinary - | Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Imgix - | Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter::Akamai + Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary + | Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix + | Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai module URLRewriter extend Imagekit::Internal::Type::Union @@ -88,7 +88,7 @@ module Imagekit def to_hash: -> { type: :AKAMAI } end - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointGetResponse::url_rewriter] + def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter] end end end diff --git a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs index 54c5225d..0989d858 100644 --- a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs +++ b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs @@ -4,7 +4,7 @@ module Imagekit type url_endpoint_update_params = { } & Imagekit::Internal::Type::request_parameters - class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpoint + class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpointRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters diff --git a/sig/imagekit/models/accounts/url_endpoint_update_response.rbs b/sig/imagekit/models/accounts/url_endpoint_update_response.rbs deleted file mode 100644 index 1e29910d..00000000 --- a/sig/imagekit/models/accounts/url_endpoint_update_response.rbs +++ /dev/null @@ -1,96 +0,0 @@ -module Imagekit - module Models - module Accounts - type url_endpoint_update_response = - { - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter - } - - class URLEndpointUpdateResponse < Imagekit::Internal::Type::BaseModel - attr_accessor description: String - - attr_accessor origins: ::Array[String] - - attr_accessor url_prefix: String - - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter? - - def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter - - attr_accessor id: String - - def initialize: ( - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter - ) -> void - - def to_hash: -> { - id: String, - description: String, - origins: ::Array[String], - url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter - } - - type url_rewriter = - Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Cloudinary - | Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Imgix - | Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter::Akamai - - module URLRewriter - extend Imagekit::Internal::Type::Union - - type cloudinary = - { preserve_asset_delivery_types: bool, type: :CLOUDINARY } - - class Cloudinary < Imagekit::Internal::Type::BaseModel - attr_accessor preserve_asset_delivery_types: bool - - attr_accessor type: :CLOUDINARY - - def initialize: ( - preserve_asset_delivery_types: bool, - ?type: :CLOUDINARY - ) -> void - - def to_hash: -> { - preserve_asset_delivery_types: bool, - type: :CLOUDINARY - } - end - - type imgix = { type: :IMGIX } - - class Imgix < Imagekit::Internal::Type::BaseModel - attr_accessor type: :IMGIX - - def initialize: (?type: :IMGIX) -> void - - def to_hash: -> { type: :IMGIX } - end - - type akamai = { type: :AKAMAI } - - class Akamai < Imagekit::Internal::Type::BaseModel - attr_accessor type: :AKAMAI - - def initialize: (?type: :AKAMAI) -> void - - def to_hash: -> { type: :AKAMAI } - end - - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointUpdateResponse::url_rewriter] - end - end - end - end -end diff --git a/sig/imagekit/resources/accounts/url_endpoints.rbs b/sig/imagekit/resources/accounts/url_endpoints.rbs index c170c770..b87de7ed 100644 --- a/sig/imagekit/resources/accounts/url_endpoints.rbs +++ b/sig/imagekit/resources/accounts/url_endpoints.rbs @@ -6,18 +6,18 @@ module Imagekit description: String, ?origins: ::Array[String], ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::URLEndpointCreateResponse + ) -> Imagekit::Accounts::URLEndpointResponse def update: ( String id, description: String, ?origins: ::Array[String], ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpoint::url_rewriter, + ?url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::URLEndpointUpdateResponse + ) -> Imagekit::Accounts::URLEndpointResponse def list: ( ?request_options: Imagekit::request_opts @@ -28,7 +28,7 @@ module Imagekit def get: ( String id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::URLEndpointGetResponse + ) -> Imagekit::Accounts::URLEndpointResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/accounts/url_endpoints_test.rb b/test/imagekit/resources/accounts/url_endpoints_test.rb index baa5cf70..88895a66 100644 --- a/test/imagekit/resources/accounts/url_endpoints_test.rb +++ b/test/imagekit/resources/accounts/url_endpoints_test.rb @@ -9,7 +9,7 @@ def test_create_required_params response = @image_kit.accounts.url_endpoints.create(description: "My custom URL endpoint") assert_pattern do - response => Imagekit::Models::Accounts::URLEndpointCreateResponse + response => Imagekit::Accounts::URLEndpointResponse end assert_pattern do @@ -18,7 +18,7 @@ def test_create_required_params description: String, origins: ^(Imagekit::Internal::Type::ArrayOf[String]), url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointCreateResponse::URLRewriter | nil + url_rewriter: Imagekit::Accounts::URLEndpointResponse::URLRewriter | nil } end end @@ -29,7 +29,7 @@ def test_update_required_params response = @image_kit.accounts.url_endpoints.update("id", description: "My custom URL endpoint") assert_pattern do - response => Imagekit::Models::Accounts::URLEndpointUpdateResponse + response => Imagekit::Accounts::URLEndpointResponse end assert_pattern do @@ -38,7 +38,7 @@ def test_update_required_params description: String, origins: ^(Imagekit::Internal::Type::ArrayOf[String]), url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointUpdateResponse::URLRewriter | nil + url_rewriter: Imagekit::Accounts::URLEndpointResponse::URLRewriter | nil } end end @@ -49,7 +49,7 @@ def test_list response = @image_kit.accounts.url_endpoints.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Accounts::URLEndpointListResponseItem]) + response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Accounts::URLEndpointResponse]) end end @@ -69,7 +69,7 @@ def test_get response = @image_kit.accounts.url_endpoints.get("id") assert_pattern do - response => Imagekit::Models::Accounts::URLEndpointGetResponse + response => Imagekit::Accounts::URLEndpointResponse end assert_pattern do @@ -78,7 +78,7 @@ def test_get description: String, origins: ^(Imagekit::Internal::Type::ArrayOf[String]), url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointGetResponse::URLRewriter | nil + url_rewriter: Imagekit::Accounts::URLEndpointResponse::URLRewriter | nil } end end From 8b537dd53e352f89dde7ad804763ef297809414e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:22:19 +0000 Subject: [PATCH 052/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 3 +- lib/imagekit/models.rb | 2 + .../models/beta/v2/file_upload_response.rb | 487 +--------- lib/imagekit/models/file_upload_response.rb | 486 +--------- .../files/metadata_get_from_url_response.rb | 487 ---------- .../models/files/metadata_get_response.rb | 486 ---------- lib/imagekit/models/metadata.rb | 483 ++++++++++ lib/imagekit/resources/files/metadata.rb | 8 +- rbi/imagekit/models.rbi | 2 + .../models/beta/v2/file_upload_response.rbi | 911 +----------------- rbi/imagekit/models/file_upload_response.rbi | 895 +---------------- .../files/metadata_get_from_url_response.rbi | 892 ----------------- .../models/files/metadata_get_response.rbi | 884 ----------------- rbi/imagekit/models/metadata.rbi | 804 ++++++++++++++++ rbi/imagekit/resources/files/metadata.rbi | 4 +- sig/imagekit/models.rbs | 2 + .../models/beta/v2/file_upload_response.rbs | 560 +---------- sig/imagekit/models/file_upload_response.rbs | 557 +---------- .../files/metadata_get_from_url_response.rbs | 550 ----------- .../models/files/metadata_get_response.rbs | 550 ----------- sig/imagekit/models/metadata.rbs | 546 +++++++++++ sig/imagekit/resources/files/metadata.rbs | 4 +- test/imagekit/resources/beta/v2/files_test.rb | 2 +- .../imagekit/resources/files/metadata_test.rb | 8 +- test/imagekit/resources/files_test.rb | 2 +- 26 files changed, 1879 insertions(+), 7738 deletions(-) delete mode 100644 lib/imagekit/models/files/metadata_get_from_url_response.rb delete mode 100644 lib/imagekit/models/files/metadata_get_response.rb create mode 100644 lib/imagekit/models/metadata.rb delete mode 100644 rbi/imagekit/models/files/metadata_get_from_url_response.rbi delete mode 100644 rbi/imagekit/models/files/metadata_get_response.rbi create mode 100644 rbi/imagekit/models/metadata.rbi delete mode 100644 sig/imagekit/models/files/metadata_get_from_url_response.rbs delete mode 100644 sig/imagekit/models/files/metadata_get_response.rbs create mode 100644 sig/imagekit/models/metadata.rbs diff --git a/.stats.yml b/.stats.yml index e88489f2..eae87049 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-547b616849eececf3f5b1ea38ebe1dba718e1877c787e3642b9c91e552548789.yml openapi_spec_hash: fba0bf8c1ee034067ab6ae93f84abeae -config_hash: befd7c8f04cc5b4992ec11efe0d6934b +config_hash: 659d086a034de739b7423470b2c13ae0 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 6ee022d6..11290951 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -101,9 +101,7 @@ require_relative "imagekit/models/files/bulk_remove_tags_params" require_relative "imagekit/models/files/bulk_remove_tags_response" require_relative "imagekit/models/files/metadata_get_from_url_params" -require_relative "imagekit/models/files/metadata_get_from_url_response" require_relative "imagekit/models/files/metadata_get_params" -require_relative "imagekit/models/files/metadata_get_response" require_relative "imagekit/models/files/version_delete_params" require_relative "imagekit/models/files/version_delete_response" require_relative "imagekit/models/files/version_get_params" @@ -127,6 +125,7 @@ require_relative "imagekit/models/folder_rename_response" require_relative "imagekit/models/folders/job_get_params" require_relative "imagekit/models/folders/job_get_response" +require_relative "imagekit/models/metadata" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" require_relative "imagekit/models/video_transformation_accepted_webhook_event" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 9e86f6f9..9f4e5bd6 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -89,6 +89,8 @@ module Imagekit Folders = Imagekit::Models::Folders + Metadata = Imagekit::Models::Metadata + UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekit/models/beta/v2/file_upload_response.rb index 58e36783..88afd8bd 100644 --- a/lib/imagekit/models/beta/v2/file_upload_response.rb +++ b/lib/imagekit/models/beta/v2/file_upload_response.rb @@ -126,8 +126,8 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, nil] - optional :metadata, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata } + # @return [Imagekit::Models::Metadata, nil] + optional :metadata, -> { Imagekit::Metadata } # @!attribute name # Name of the asset. @@ -215,7 +215,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen # - # @param metadata [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # @param metadata [Imagekit::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad # # @param name [String] Name of the asset. # @@ -340,487 +340,6 @@ module RemoveBg end end - # @see Imagekit::Models::Beta::V2::FileUploadResponse#metadata - class Metadata < Imagekit::Internal::Type::BaseModel - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute density - # The density of the image in DPI. - # - # @return [Integer, nil] - optional :density, Integer - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute exif - # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, nil] - optional :exif, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif } - - # @!attribute format_ - # The format of the file (e.g., 'jpg', 'mp4'). - # - # @return [String, nil] - optional :format_, String, api_name: :format - - # @!attribute has_color_profile - # Indicates if the image has a color profile. - # - # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile - - # @!attribute has_transparency - # Indicates if the image contains transparent areas. - # - # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency - - # @!attribute height - # The height of the image or video in pixels. - # - # @return [Integer, nil] - optional :height, Integer - - # @!attribute p_hash - # Perceptual hash of the image. - # - # @return [String, nil] - optional :p_hash, String, api_name: :pHash - - # @!attribute quality - # The quality indicator of the image. - # - # @return [Integer, nil] - optional :quality, Integer - - # @!attribute size - # The file size in bytes. - # - # @return [Integer, nil] - optional :size, Integer - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # The width of the image or video in pixels. - # - # @return [Integer, nil] - optional :width, Integer - - # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param density [Integer] The density of the image in DPI. - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param exif [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif] - # - # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). - # - # @param has_color_profile [Boolean] Indicates if the image has a color profile. - # - # @param has_transparency [Boolean] Indicates if the image contains transparent areas. - # - # @param height [Integer] The height of the image or video in pixels. - # - # @param p_hash [String] Perceptual hash of the image. - # - # @param quality [Integer] The quality indicator of the image. - # - # @param size [Integer] The file size in bytes. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Integer] The width of the image or video in pixels. - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute exif - # Object containing Exif details. - # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, nil] - optional :exif, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif } - - # @!attribute gps - # Object containing GPS information. - # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, nil] - optional :gps, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps } - - # @!attribute image - # Object containing EXIF image information. - # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, nil] - optional :image, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image } - - # @!attribute interoperability - # JSON object. - # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, nil] - optional :interoperability, - -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability } - - # @!attribute makernote - # - # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] - - # @!attribute thumbnail - # Object containing Thumbnail information. - # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail } - - # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif] Object containing Exif details. - # - # @param gps [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps] Object containing GPS information. - # - # @param image [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image] Object containing EXIF image information. - # - # @param interoperability [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability] JSON object. - # - # @param makernote [Hash{Symbol=>Object}] - # - # @param thumbnail [Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail] Object containing Thumbnail information. - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#image - class Image < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - - # @see Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end - end - end - # @see Imagekit::Models::Beta::V2::FileUploadResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekit/models/file_upload_response.rb index d45a8b89..639d6257 100644 --- a/lib/imagekit/models/file_upload_response.rb +++ b/lib/imagekit/models/file_upload_response.rb @@ -124,8 +124,8 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. # - # @return [Imagekit::Models::FileUploadResponse::Metadata, nil] - optional :metadata, -> { Imagekit::Models::FileUploadResponse::Metadata } + # @return [Imagekit::Models::Metadata, nil] + optional :metadata, -> { Imagekit::Metadata } # @!attribute name # Name of the asset. @@ -211,7 +211,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen # - # @param metadata [Imagekit::Models::FileUploadResponse::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # @param metadata [Imagekit::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad # # @param name [String] Name of the asset. # @@ -336,486 +336,6 @@ module RemoveBg end end - # @see Imagekit::Models::FileUploadResponse#metadata - class Metadata < Imagekit::Internal::Type::BaseModel - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute density - # The density of the image in DPI. - # - # @return [Integer, nil] - optional :density, Integer - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute exif - # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif, nil] - optional :exif, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif } - - # @!attribute format_ - # The format of the file (e.g., 'jpg', 'mp4'). - # - # @return [String, nil] - optional :format_, String, api_name: :format - - # @!attribute has_color_profile - # Indicates if the image has a color profile. - # - # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile - - # @!attribute has_transparency - # Indicates if the image contains transparent areas. - # - # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency - - # @!attribute height - # The height of the image or video in pixels. - # - # @return [Integer, nil] - optional :height, Integer - - # @!attribute p_hash - # Perceptual hash of the image. - # - # @return [String, nil] - optional :p_hash, String, api_name: :pHash - - # @!attribute quality - # The quality indicator of the image. - # - # @return [Integer, nil] - optional :quality, Integer - - # @!attribute size - # The file size in bytes. - # - # @return [Integer, nil] - optional :size, Integer - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # The width of the image or video in pixels. - # - # @return [Integer, nil] - optional :width, Integer - - # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param density [Integer] The density of the image in DPI. - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param exif [Imagekit::Models::FileUploadResponse::Metadata::Exif] - # - # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). - # - # @param has_color_profile [Boolean] Indicates if the image has a color profile. - # - # @param has_transparency [Boolean] Indicates if the image contains transparent areas. - # - # @param height [Integer] The height of the image or video in pixels. - # - # @param p_hash [String] Perceptual hash of the image. - # - # @param quality [Integer] The quality indicator of the image. - # - # @param size [Integer] The file size in bytes. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Integer] The width of the image or video in pixels. - - # @see Imagekit::Models::FileUploadResponse::Metadata#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute exif - # Object containing Exif details. - # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, nil] - optional :exif, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif } - - # @!attribute gps - # Object containing GPS information. - # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, nil] - optional :gps, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps } - - # @!attribute image - # Object containing EXIF image information. - # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, nil] - optional :image, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Image } - - # @!attribute interoperability - # JSON object. - # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, nil] - optional :interoperability, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability } - - # @!attribute makernote - # - # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] - - # @!attribute thumbnail - # Object containing Thumbnail information. - # - # @return [Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail } - - # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif] Object containing Exif details. - # - # @param gps [Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps] Object containing GPS information. - # - # @param image [Imagekit::Models::FileUploadResponse::Metadata::Exif::Image] Object containing EXIF image information. - # - # @param interoperability [Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability] JSON object. - # - # @param makernote [Hash{Symbol=>Object}] - # - # @param thumbnail [Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail] Object containing Thumbnail information. - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#image - class Image < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - - # @see Imagekit::Models::FileUploadResponse::Metadata::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end - end - end - # @see Imagekit::Models::FileUploadResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/models/files/metadata_get_from_url_response.rb b/lib/imagekit/models/files/metadata_get_from_url_response.rb deleted file mode 100644 index 02c5b3b5..00000000 --- a/lib/imagekit/models/files/metadata_get_from_url_response.rb +++ /dev/null @@ -1,487 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Metadata#get_from_url - class MetadataGetFromURLResponse < Imagekit::Internal::Type::BaseModel - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute density - # The density of the image in DPI. - # - # @return [Integer, nil] - optional :density, Integer - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute exif - # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, nil] - optional :exif, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif } - - # @!attribute format_ - # The format of the file (e.g., 'jpg', 'mp4'). - # - # @return [String, nil] - optional :format_, String, api_name: :format - - # @!attribute has_color_profile - # Indicates if the image has a color profile. - # - # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile - - # @!attribute has_transparency - # Indicates if the image contains transparent areas. - # - # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency - - # @!attribute height - # The height of the image or video in pixels. - # - # @return [Integer, nil] - optional :height, Integer - - # @!attribute p_hash - # Perceptual hash of the image. - # - # @return [String, nil] - optional :p_hash, String, api_name: :pHash - - # @!attribute quality - # The quality indicator of the image. - # - # @return [Integer, nil] - optional :quality, Integer - - # @!attribute size - # The file size in bytes. - # - # @return [Integer, nil] - optional :size, Integer - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # The width of the image or video in pixels. - # - # @return [Integer, nil] - optional :width, Integer - - # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) - # JSON object containing metadata. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param density [Integer] The density of the image in DPI. - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param exif [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif] - # - # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). - # - # @param has_color_profile [Boolean] Indicates if the image has a color profile. - # - # @param has_transparency [Boolean] Indicates if the image contains transparent areas. - # - # @param height [Integer] The height of the image or video in pixels. - # - # @param p_hash [String] Perceptual hash of the image. - # - # @param quality [Integer] The quality indicator of the image. - # - # @param size [Integer] The file size in bytes. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Integer] The width of the image or video in pixels. - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute exif - # Object containing Exif details. - # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, nil] - optional :exif, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif } - - # @!attribute gps - # Object containing GPS information. - # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, nil] - optional :gps, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps } - - # @!attribute image - # Object containing EXIF image information. - # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, nil] - optional :image, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image } - - # @!attribute interoperability - # JSON object. - # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, nil] - optional :interoperability, - -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability } - - # @!attribute makernote - # - # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] - - # @!attribute thumbnail - # Object containing Thumbnail information. - # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail } - - # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif] Object containing Exif details. - # - # @param gps [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps] Object containing GPS information. - # - # @param image [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image] Object containing EXIF image information. - # - # @param interoperability [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability] JSON object. - # - # @param makernote [Hash{Symbol=>Object}] - # - # @param thumbnail [Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail] Object containing Thumbnail information. - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#image - class Image < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - - # @see Imagekit::Models::Files::MetadataGetFromURLResponse::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end - end - end - end - end -end diff --git a/lib/imagekit/models/files/metadata_get_response.rb b/lib/imagekit/models/files/metadata_get_response.rb deleted file mode 100644 index aa974f73..00000000 --- a/lib/imagekit/models/files/metadata_get_response.rb +++ /dev/null @@ -1,486 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Metadata#get - class MetadataGetResponse < Imagekit::Internal::Type::BaseModel - # @!attribute audio_codec - # The audio codec used in the video (only for video). - # - # @return [String, nil] - optional :audio_codec, String, api_name: :audioCodec - - # @!attribute bit_rate - # The bit rate of the video in kbps (only for video). - # - # @return [Integer, nil] - optional :bit_rate, Integer, api_name: :bitRate - - # @!attribute density - # The density of the image in DPI. - # - # @return [Integer, nil] - optional :density, Integer - - # @!attribute duration - # The duration of the video in seconds (only for video). - # - # @return [Integer, nil] - optional :duration, Integer - - # @!attribute exif - # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif, nil] - optional :exif, -> { Imagekit::Models::Files::MetadataGetResponse::Exif } - - # @!attribute format_ - # The format of the file (e.g., 'jpg', 'mp4'). - # - # @return [String, nil] - optional :format_, String, api_name: :format - - # @!attribute has_color_profile - # Indicates if the image has a color profile. - # - # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile - - # @!attribute has_transparency - # Indicates if the image contains transparent areas. - # - # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency - - # @!attribute height - # The height of the image or video in pixels. - # - # @return [Integer, nil] - optional :height, Integer - - # @!attribute p_hash - # Perceptual hash of the image. - # - # @return [String, nil] - optional :p_hash, String, api_name: :pHash - - # @!attribute quality - # The quality indicator of the image. - # - # @return [Integer, nil] - optional :quality, Integer - - # @!attribute size - # The file size in bytes. - # - # @return [Integer, nil] - optional :size, Integer - - # @!attribute video_codec - # The video codec used in the video (only for video). - # - # @return [String, nil] - optional :video_codec, String, api_name: :videoCodec - - # @!attribute width - # The width of the image or video in pixels. - # - # @return [Integer, nil] - optional :width, Integer - - # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) - # JSON object containing metadata. - # - # @param audio_codec [String] The audio codec used in the video (only for video). - # - # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). - # - # @param density [Integer] The density of the image in DPI. - # - # @param duration [Integer] The duration of the video in seconds (only for video). - # - # @param exif [Imagekit::Models::Files::MetadataGetResponse::Exif] - # - # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). - # - # @param has_color_profile [Boolean] Indicates if the image has a color profile. - # - # @param has_transparency [Boolean] Indicates if the image contains transparent areas. - # - # @param height [Integer] The height of the image or video in pixels. - # - # @param p_hash [String] Perceptual hash of the image. - # - # @param quality [Integer] The quality indicator of the image. - # - # @param size [Integer] The file size in bytes. - # - # @param video_codec [String] The video codec used in the video (only for video). - # - # @param width [Integer] The width of the image or video in pixels. - - # @see Imagekit::Models::Files::MetadataGetResponse#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute exif - # Object containing Exif details. - # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, nil] - optional :exif, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Exif } - - # @!attribute gps - # Object containing GPS information. - # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, nil] - optional :gps, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Gps } - - # @!attribute image - # Object containing EXIF image information. - # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Image, nil] - optional :image, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Image } - - # @!attribute interoperability - # JSON object. - # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, nil] - optional :interoperability, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability } - - # @!attribute makernote - # - # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] - - # @!attribute thumbnail - # Object containing Thumbnail information. - # - # @return [Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail } - - # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::Files::MetadataGetResponse::Exif::Exif] Object containing Exif details. - # - # @param gps [Imagekit::Models::Files::MetadataGetResponse::Exif::Gps] Object containing GPS information. - # - # @param image [Imagekit::Models::Files::MetadataGetResponse::Exif::Image] Object containing EXIF image information. - # - # @param interoperability [Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability] JSON object. - # - # @param makernote [Hash{Symbol=>Object}] - # - # @param thumbnail [Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail] Object containing Thumbnail information. - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel - # @!attribute aperture_value - # - # @return [Float, nil] - optional :aperture_value, Float, api_name: :ApertureValue - - # @!attribute color_space - # - # @return [Integer, nil] - optional :color_space, Integer, api_name: :ColorSpace - - # @!attribute create_date - # - # @return [String, nil] - optional :create_date, String, api_name: :CreateDate - - # @!attribute custom_rendered - # - # @return [Integer, nil] - optional :custom_rendered, Integer, api_name: :CustomRendered - - # @!attribute date_time_original - # - # @return [String, nil] - optional :date_time_original, String, api_name: :DateTimeOriginal - - # @!attribute exif_image_height - # - # @return [Integer, nil] - optional :exif_image_height, Integer, api_name: :ExifImageHeight - - # @!attribute exif_image_width - # - # @return [Integer, nil] - optional :exif_image_width, Integer, api_name: :ExifImageWidth - - # @!attribute exif_version - # - # @return [String, nil] - optional :exif_version, String, api_name: :ExifVersion - - # @!attribute exposure_compensation - # - # @return [Float, nil] - optional :exposure_compensation, Float, api_name: :ExposureCompensation - - # @!attribute exposure_mode - # - # @return [Integer, nil] - optional :exposure_mode, Integer, api_name: :ExposureMode - - # @!attribute exposure_program - # - # @return [Integer, nil] - optional :exposure_program, Integer, api_name: :ExposureProgram - - # @!attribute exposure_time - # - # @return [Float, nil] - optional :exposure_time, Float, api_name: :ExposureTime - - # @!attribute flash - # - # @return [Integer, nil] - optional :flash, Integer, api_name: :Flash - - # @!attribute flashpix_version - # - # @return [String, nil] - optional :flashpix_version, String, api_name: :FlashpixVersion - - # @!attribute f_number - # - # @return [Float, nil] - optional :f_number, Float, api_name: :FNumber - - # @!attribute focal_length - # - # @return [Integer, nil] - optional :focal_length, Integer, api_name: :FocalLength - - # @!attribute focal_plane_resolution_unit - # - # @return [Integer, nil] - optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit - - # @!attribute focal_plane_x_resolution - # - # @return [Float, nil] - optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution - - # @!attribute focal_plane_y_resolution - # - # @return [Float, nil] - optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution - - # @!attribute interop_offset - # - # @return [Integer, nil] - optional :interop_offset, Integer, api_name: :InteropOffset - - # @!attribute iso - # - # @return [Integer, nil] - optional :iso, Integer, api_name: :ISO - - # @!attribute metering_mode - # - # @return [Integer, nil] - optional :metering_mode, Integer, api_name: :MeteringMode - - # @!attribute scene_capture_type - # - # @return [Integer, nil] - optional :scene_capture_type, Integer, api_name: :SceneCaptureType - - # @!attribute shutter_speed_value - # - # @return [Float, nil] - optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue - - # @!attribute sub_sec_time - # - # @return [String, nil] - optional :sub_sec_time, String, api_name: :SubSecTime - - # @!attribute white_balance - # - # @return [Integer, nil] - optional :white_balance, Integer, api_name: :WhiteBalance - - # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) - # Object containing Exif details. - # - # @param aperture_value [Float] - # @param color_space [Integer] - # @param create_date [String] - # @param custom_rendered [Integer] - # @param date_time_original [String] - # @param exif_image_height [Integer] - # @param exif_image_width [Integer] - # @param exif_version [String] - # @param exposure_compensation [Float] - # @param exposure_mode [Integer] - # @param exposure_program [Integer] - # @param exposure_time [Float] - # @param flash [Integer] - # @param flashpix_version [String] - # @param f_number [Float] - # @param focal_length [Integer] - # @param focal_plane_resolution_unit [Integer] - # @param focal_plane_x_resolution [Float] - # @param focal_plane_y_resolution [Float] - # @param interop_offset [Integer] - # @param iso [Integer] - # @param metering_mode [Integer] - # @param scene_capture_type [Integer] - # @param shutter_speed_value [Float] - # @param sub_sec_time [String] - # @param white_balance [Integer] - end - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel - # @!attribute gps_version_id - # - # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID - - # @!method initialize(gps_version_id: nil) - # Object containing GPS information. - # - # @param gps_version_id [Array] - end - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#image - class Image < Imagekit::Internal::Type::BaseModel - # @!attribute exif_offset - # - # @return [Integer, nil] - optional :exif_offset, Integer, api_name: :ExifOffset - - # @!attribute gps_info - # - # @return [Integer, nil] - optional :gps_info, Integer, api_name: :GPSInfo - - # @!attribute make - # - # @return [String, nil] - optional :make, String, api_name: :Make - - # @!attribute model - # - # @return [String, nil] - optional :model, String, api_name: :Model - - # @!attribute modify_date - # - # @return [String, nil] - optional :modify_date, String, api_name: :ModifyDate - - # @!attribute orientation - # - # @return [Integer, nil] - optional :orientation, Integer, api_name: :Orientation - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute software - # - # @return [String, nil] - optional :software, String, api_name: :Software - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_cb_cr_positioning - # - # @return [Integer, nil] - optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) - # Object containing EXIF image information. - # - # @param exif_offset [Integer] - # @param gps_info [Integer] - # @param make [String] - # @param model [String] - # @param modify_date [String] - # @param orientation [Integer] - # @param resolution_unit [Integer] - # @param software [String] - # @param x_resolution [Integer] - # @param y_cb_cr_positioning [Integer] - # @param y_resolution [Integer] - end - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel - # @!attribute interop_index - # - # @return [String, nil] - optional :interop_index, String, api_name: :InteropIndex - - # @!attribute interop_version - # - # @return [String, nil] - optional :interop_version, String, api_name: :InteropVersion - - # @!method initialize(interop_index: nil, interop_version: nil) - # JSON object. - # - # @param interop_index [String] - # @param interop_version [String] - end - - # @see Imagekit::Models::Files::MetadataGetResponse::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel - # @!attribute compression - # - # @return [Integer, nil] - optional :compression, Integer, api_name: :Compression - - # @!attribute resolution_unit - # - # @return [Integer, nil] - optional :resolution_unit, Integer, api_name: :ResolutionUnit - - # @!attribute thumbnail_length - # - # @return [Integer, nil] - optional :thumbnail_length, Integer, api_name: :ThumbnailLength - - # @!attribute thumbnail_offset - # - # @return [Integer, nil] - optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset - - # @!attribute x_resolution - # - # @return [Integer, nil] - optional :x_resolution, Integer, api_name: :XResolution - - # @!attribute y_resolution - # - # @return [Integer, nil] - optional :y_resolution, Integer, api_name: :YResolution - - # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) - # Object containing Thumbnail information. - # - # @param compression [Integer] - # @param resolution_unit [Integer] - # @param thumbnail_length [Integer] - # @param thumbnail_offset [Integer] - # @param x_resolution [Integer] - # @param y_resolution [Integer] - end - end - end - end - end -end diff --git a/lib/imagekit/models/metadata.rb b/lib/imagekit/models/metadata.rb new file mode 100644 index 00000000..c02910dd --- /dev/null +++ b/lib/imagekit/models/metadata.rb @@ -0,0 +1,483 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Metadata < Imagekit::Internal::Type::BaseModel + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute density + # The density of the image in DPI. + # + # @return [Integer, nil] + optional :density, Integer + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute exif + # + # @return [Imagekit::Models::Metadata::Exif, nil] + optional :exif, -> { Imagekit::Metadata::Exif } + + # @!attribute format_ + # The format of the file (e.g., 'jpg', 'mp4'). + # + # @return [String, nil] + optional :format_, String, api_name: :format + + # @!attribute has_color_profile + # Indicates if the image has a color profile. + # + # @return [Boolean, nil] + optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + + # @!attribute has_transparency + # Indicates if the image contains transparent areas. + # + # @return [Boolean, nil] + optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + + # @!attribute height + # The height of the image or video in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute p_hash + # Perceptual hash of the image. + # + # @return [String, nil] + optional :p_hash, String, api_name: :pHash + + # @!attribute quality + # The quality indicator of the image. + # + # @return [Integer, nil] + optional :quality, Integer + + # @!attribute size + # The file size in bytes. + # + # @return [Integer, nil] + optional :size, Integer + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # The width of the image or video in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(audio_codec: nil, bit_rate: nil, density: nil, duration: nil, exif: nil, format_: nil, has_color_profile: nil, has_transparency: nil, height: nil, p_hash: nil, quality: nil, size: nil, video_codec: nil, width: nil) + # JSON object containing metadata. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param density [Integer] The density of the image in DPI. + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param exif [Imagekit::Models::Metadata::Exif] + # + # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). + # + # @param has_color_profile [Boolean] Indicates if the image has a color profile. + # + # @param has_transparency [Boolean] Indicates if the image contains transparent areas. + # + # @param height [Integer] The height of the image or video in pixels. + # + # @param p_hash [String] Perceptual hash of the image. + # + # @param quality [Integer] The quality indicator of the image. + # + # @param size [Integer] The file size in bytes. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Integer] The width of the image or video in pixels. + + # @see Imagekit::Models::Metadata#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute exif + # Object containing Exif details. + # + # @return [Imagekit::Models::Metadata::Exif::Exif, nil] + optional :exif, -> { Imagekit::Metadata::Exif::Exif } + + # @!attribute gps + # Object containing GPS information. + # + # @return [Imagekit::Models::Metadata::Exif::Gps, nil] + optional :gps, -> { Imagekit::Metadata::Exif::Gps } + + # @!attribute image + # Object containing EXIF image information. + # + # @return [Imagekit::Models::Metadata::Exif::Image, nil] + optional :image, -> { Imagekit::Metadata::Exif::Image } + + # @!attribute interoperability + # JSON object. + # + # @return [Imagekit::Models::Metadata::Exif::Interoperability, nil] + optional :interoperability, -> { Imagekit::Metadata::Exif::Interoperability } + + # @!attribute makernote + # + # @return [Hash{Symbol=>Object}, nil] + optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + + # @!attribute thumbnail + # Object containing Thumbnail information. + # + # @return [Imagekit::Models::Metadata::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekit::Metadata::Exif::Thumbnail } + + # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) + # @param exif [Imagekit::Models::Metadata::Exif::Exif] Object containing Exif details. + # + # @param gps [Imagekit::Models::Metadata::Exif::Gps] Object containing GPS information. + # + # @param image [Imagekit::Models::Metadata::Exif::Image] Object containing EXIF image information. + # + # @param interoperability [Imagekit::Models::Metadata::Exif::Interoperability] JSON object. + # + # @param makernote [Hash{Symbol=>Object}] + # + # @param thumbnail [Imagekit::Models::Metadata::Exif::Thumbnail] Object containing Thumbnail information. + + # @see Imagekit::Models::Metadata::Exif#exif + class Exif < Imagekit::Internal::Type::BaseModel + # @!attribute aperture_value + # + # @return [Float, nil] + optional :aperture_value, Float, api_name: :ApertureValue + + # @!attribute color_space + # + # @return [Integer, nil] + optional :color_space, Integer, api_name: :ColorSpace + + # @!attribute create_date + # + # @return [String, nil] + optional :create_date, String, api_name: :CreateDate + + # @!attribute custom_rendered + # + # @return [Integer, nil] + optional :custom_rendered, Integer, api_name: :CustomRendered + + # @!attribute date_time_original + # + # @return [String, nil] + optional :date_time_original, String, api_name: :DateTimeOriginal + + # @!attribute exif_image_height + # + # @return [Integer, nil] + optional :exif_image_height, Integer, api_name: :ExifImageHeight + + # @!attribute exif_image_width + # + # @return [Integer, nil] + optional :exif_image_width, Integer, api_name: :ExifImageWidth + + # @!attribute exif_version + # + # @return [String, nil] + optional :exif_version, String, api_name: :ExifVersion + + # @!attribute exposure_compensation + # + # @return [Float, nil] + optional :exposure_compensation, Float, api_name: :ExposureCompensation + + # @!attribute exposure_mode + # + # @return [Integer, nil] + optional :exposure_mode, Integer, api_name: :ExposureMode + + # @!attribute exposure_program + # + # @return [Integer, nil] + optional :exposure_program, Integer, api_name: :ExposureProgram + + # @!attribute exposure_time + # + # @return [Float, nil] + optional :exposure_time, Float, api_name: :ExposureTime + + # @!attribute flash + # + # @return [Integer, nil] + optional :flash, Integer, api_name: :Flash + + # @!attribute flashpix_version + # + # @return [String, nil] + optional :flashpix_version, String, api_name: :FlashpixVersion + + # @!attribute f_number + # + # @return [Float, nil] + optional :f_number, Float, api_name: :FNumber + + # @!attribute focal_length + # + # @return [Integer, nil] + optional :focal_length, Integer, api_name: :FocalLength + + # @!attribute focal_plane_resolution_unit + # + # @return [Integer, nil] + optional :focal_plane_resolution_unit, Integer, api_name: :FocalPlaneResolutionUnit + + # @!attribute focal_plane_x_resolution + # + # @return [Float, nil] + optional :focal_plane_x_resolution, Float, api_name: :FocalPlaneXResolution + + # @!attribute focal_plane_y_resolution + # + # @return [Float, nil] + optional :focal_plane_y_resolution, Float, api_name: :FocalPlaneYResolution + + # @!attribute interop_offset + # + # @return [Integer, nil] + optional :interop_offset, Integer, api_name: :InteropOffset + + # @!attribute iso + # + # @return [Integer, nil] + optional :iso, Integer, api_name: :ISO + + # @!attribute metering_mode + # + # @return [Integer, nil] + optional :metering_mode, Integer, api_name: :MeteringMode + + # @!attribute scene_capture_type + # + # @return [Integer, nil] + optional :scene_capture_type, Integer, api_name: :SceneCaptureType + + # @!attribute shutter_speed_value + # + # @return [Float, nil] + optional :shutter_speed_value, Float, api_name: :ShutterSpeedValue + + # @!attribute sub_sec_time + # + # @return [String, nil] + optional :sub_sec_time, String, api_name: :SubSecTime + + # @!attribute white_balance + # + # @return [Integer, nil] + optional :white_balance, Integer, api_name: :WhiteBalance + + # @!method initialize(aperture_value: nil, color_space: nil, create_date: nil, custom_rendered: nil, date_time_original: nil, exif_image_height: nil, exif_image_width: nil, exif_version: nil, exposure_compensation: nil, exposure_mode: nil, exposure_program: nil, exposure_time: nil, flash: nil, flashpix_version: nil, f_number: nil, focal_length: nil, focal_plane_resolution_unit: nil, focal_plane_x_resolution: nil, focal_plane_y_resolution: nil, interop_offset: nil, iso: nil, metering_mode: nil, scene_capture_type: nil, shutter_speed_value: nil, sub_sec_time: nil, white_balance: nil) + # Object containing Exif details. + # + # @param aperture_value [Float] + # @param color_space [Integer] + # @param create_date [String] + # @param custom_rendered [Integer] + # @param date_time_original [String] + # @param exif_image_height [Integer] + # @param exif_image_width [Integer] + # @param exif_version [String] + # @param exposure_compensation [Float] + # @param exposure_mode [Integer] + # @param exposure_program [Integer] + # @param exposure_time [Float] + # @param flash [Integer] + # @param flashpix_version [String] + # @param f_number [Float] + # @param focal_length [Integer] + # @param focal_plane_resolution_unit [Integer] + # @param focal_plane_x_resolution [Float] + # @param focal_plane_y_resolution [Float] + # @param interop_offset [Integer] + # @param iso [Integer] + # @param metering_mode [Integer] + # @param scene_capture_type [Integer] + # @param shutter_speed_value [Float] + # @param sub_sec_time [String] + # @param white_balance [Integer] + end + + # @see Imagekit::Models::Metadata::Exif#gps + class Gps < Imagekit::Internal::Type::BaseModel + # @!attribute gps_version_id + # + # @return [Array, nil] + optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + + # @!method initialize(gps_version_id: nil) + # Object containing GPS information. + # + # @param gps_version_id [Array] + end + + # @see Imagekit::Models::Metadata::Exif#image + class Image < Imagekit::Internal::Type::BaseModel + # @!attribute exif_offset + # + # @return [Integer, nil] + optional :exif_offset, Integer, api_name: :ExifOffset + + # @!attribute gps_info + # + # @return [Integer, nil] + optional :gps_info, Integer, api_name: :GPSInfo + + # @!attribute make + # + # @return [String, nil] + optional :make, String, api_name: :Make + + # @!attribute model + # + # @return [String, nil] + optional :model, String, api_name: :Model + + # @!attribute modify_date + # + # @return [String, nil] + optional :modify_date, String, api_name: :ModifyDate + + # @!attribute orientation + # + # @return [Integer, nil] + optional :orientation, Integer, api_name: :Orientation + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute software + # + # @return [String, nil] + optional :software, String, api_name: :Software + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_cb_cr_positioning + # + # @return [Integer, nil] + optional :y_cb_cr_positioning, Integer, api_name: :YCbCrPositioning + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(exif_offset: nil, gps_info: nil, make: nil, model: nil, modify_date: nil, orientation: nil, resolution_unit: nil, software: nil, x_resolution: nil, y_cb_cr_positioning: nil, y_resolution: nil) + # Object containing EXIF image information. + # + # @param exif_offset [Integer] + # @param gps_info [Integer] + # @param make [String] + # @param model [String] + # @param modify_date [String] + # @param orientation [Integer] + # @param resolution_unit [Integer] + # @param software [String] + # @param x_resolution [Integer] + # @param y_cb_cr_positioning [Integer] + # @param y_resolution [Integer] + end + + # @see Imagekit::Models::Metadata::Exif#interoperability + class Interoperability < Imagekit::Internal::Type::BaseModel + # @!attribute interop_index + # + # @return [String, nil] + optional :interop_index, String, api_name: :InteropIndex + + # @!attribute interop_version + # + # @return [String, nil] + optional :interop_version, String, api_name: :InteropVersion + + # @!method initialize(interop_index: nil, interop_version: nil) + # JSON object. + # + # @param interop_index [String] + # @param interop_version [String] + end + + # @see Imagekit::Models::Metadata::Exif#thumbnail + class Thumbnail < Imagekit::Internal::Type::BaseModel + # @!attribute compression + # + # @return [Integer, nil] + optional :compression, Integer, api_name: :Compression + + # @!attribute resolution_unit + # + # @return [Integer, nil] + optional :resolution_unit, Integer, api_name: :ResolutionUnit + + # @!attribute thumbnail_length + # + # @return [Integer, nil] + optional :thumbnail_length, Integer, api_name: :ThumbnailLength + + # @!attribute thumbnail_offset + # + # @return [Integer, nil] + optional :thumbnail_offset, Integer, api_name: :ThumbnailOffset + + # @!attribute x_resolution + # + # @return [Integer, nil] + optional :x_resolution, Integer, api_name: :XResolution + + # @!attribute y_resolution + # + # @return [Integer, nil] + optional :y_resolution, Integer, api_name: :YResolution + + # @!method initialize(compression: nil, resolution_unit: nil, thumbnail_length: nil, thumbnail_offset: nil, x_resolution: nil, y_resolution: nil) + # Object containing Thumbnail information. + # + # @param compression [Integer] + # @param resolution_unit [Integer] + # @param thumbnail_length [Integer] + # @param thumbnail_offset [Integer] + # @param x_resolution [Integer] + # @param y_resolution [Integer] + end + end + end + end +end diff --git a/lib/imagekit/resources/files/metadata.rb b/lib/imagekit/resources/files/metadata.rb index ea04498b..cc941499 100644 --- a/lib/imagekit/resources/files/metadata.rb +++ b/lib/imagekit/resources/files/metadata.rb @@ -19,14 +19,14 @@ class Metadata # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::MetadataGetResponse] + # @return [Imagekit::Models::Metadata] # # @see Imagekit::Models::Files::MetadataGetParams def get(file_id, params = {}) @client.request( method: :get, path: ["v1/files/%1$s/metadata", file_id], - model: Imagekit::Models::Files::MetadataGetResponse, + model: Imagekit::Metadata, options: params[:request_options] ) end @@ -43,7 +43,7 @@ def get(file_id, params = {}) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::MetadataGetFromURLResponse] + # @return [Imagekit::Models::Metadata] # # @see Imagekit::Models::Files::MetadataGetFromURLParams def get_from_url(params) @@ -52,7 +52,7 @@ def get_from_url(params) method: :get, path: "v1/files/metadata", query: parsed, - model: Imagekit::Models::Files::MetadataGetFromURLResponse, + model: Imagekit::Metadata, options: options ) end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 952b8cfe..90c72e54 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -55,6 +55,8 @@ module Imagekit Folders = Imagekit::Models::Folders + Metadata = Imagekit::Models::Metadata + UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekit/models/beta/v2/file_upload_response.rbi index 2399fd0b..612189b3 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_response.rbi @@ -147,21 +147,10 @@ module Imagekit # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata - ) - ) - end + sig { returns(T.nilable(Imagekit::Metadata)) } attr_reader :metadata - sig do - params( - metadata: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::OrHash - ).void - end + sig { params(metadata: Imagekit::Metadata::OrHash).void } attr_writer :metadata # Name of the asset. @@ -253,8 +242,7 @@ module Imagekit height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::OrHash, + metadata: Imagekit::Metadata::OrHash, name: String, size: Float, tags: T.nilable(T::Array[String]), @@ -365,8 +353,7 @@ module Imagekit height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + metadata: Imagekit::Metadata, name: String, size: Float, tags: T.nilable(T::Array[String]), @@ -659,896 +646,6 @@ module Imagekit end end - class Metadata < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, - Imagekit::Internal::AnyHash - ) - end - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # The density of the image in DPI. - sig { returns(T.nilable(Integer)) } - attr_reader :density - - sig { params(density: Integer).void } - attr_writer :density - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :duration - - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif - ) - ) - end - attr_reader :exif - - sig do - params( - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::OrHash - ).void - end - attr_writer :exif - - # The format of the file (e.g., 'jpg', 'mp4'). - sig { returns(T.nilable(String)) } - attr_reader :format_ - - sig { params(format_: String).void } - attr_writer :format_ - - # Indicates if the image has a color profile. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_color_profile - - sig { params(has_color_profile: T::Boolean).void } - attr_writer :has_color_profile - - # Indicates if the image contains transparent areas. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_transparency - - sig { params(has_transparency: T::Boolean).void } - attr_writer :has_transparency - - # The height of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :height - - sig { params(height: Integer).void } - attr_writer :height - - # Perceptual hash of the image. - sig { returns(T.nilable(String)) } - attr_reader :p_hash - - sig { params(p_hash: String).void } - attr_writer :p_hash - - # The quality indicator of the image. - sig { returns(T.nilable(Integer)) } - attr_reader :quality - - sig { params(quality: Integer).void } - attr_writer :quality - - # The file size in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :size - - sig { params(size: Integer).void } - attr_writer :size - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # The width of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :width - - sig { params(width: Integer).void } - attr_writer :width - - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - sig do - params( - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::OrHash, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - ).returns(T.attached_class) - end - def self.new( - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # The density of the image in DPI. - density: nil, - # The duration of the video in seconds (only for video). - duration: nil, - exif: nil, - # The format of the file (e.g., 'jpg', 'mp4'). - format_: nil, - # Indicates if the image has a color profile. - has_color_profile: nil, - # Indicates if the image contains transparent areas. - has_transparency: nil, - # The height of the image or video in pixels. - height: nil, - # Perceptual hash of the image. - p_hash: nil, - # The quality indicator of the image. - quality: nil, - # The file size in bytes. - size: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # The width of the image or video in pixels. - width: nil - ) - end - - sig do - override.returns( - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, - Imagekit::Internal::AnyHash - ) - end - - # Object containing Exif details. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif - ) - ) - end - attr_reader :exif - - sig do - params( - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif::OrHash - ).void - end - attr_writer :exif - - # Object containing GPS information. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps - ) - ) - end - attr_reader :gps - - sig do - params( - gps: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps::OrHash - ).void - end - attr_writer :gps - - # Object containing EXIF image information. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image - ) - ) - end - attr_reader :image - - sig do - params( - image: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image::OrHash - ).void - end - attr_writer :image - - # JSON object. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability - ) - ) - end - attr_reader :interoperability - - sig do - params( - interoperability: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability::OrHash - ).void - end - attr_writer :interoperability - - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :makernote - - sig { params(makernote: T::Hash[Symbol, T.anything]).void } - attr_writer :makernote - - # Object containing Thumbnail information. - sig do - returns( - T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - ) - ) - end - attr_reader :thumbnail - - sig do - params( - thumbnail: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash - ).void - end - attr_writer :thumbnail - - sig do - params( - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif::OrHash, - gps: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps::OrHash, - image: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image::OrHash, - interoperability: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability::OrHash, - makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash - ).returns(T.attached_class) - end - def self.new( - # Object containing Exif details. - exif: nil, - # Object containing GPS information. - gps: nil, - # Object containing EXIF image information. - image: nil, - # JSON object. - interoperability: nil, - makernote: nil, - # Object containing Thumbnail information. - thumbnail: nil - ) - end - - sig do - override.returns( - { - exif: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - gps: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - image: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - interoperability: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, - makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns( - T.attached_class - ) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - - class Image < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params( - interop_index: String, - interop_version: String - ).returns(T.attached_class) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns( - { interop_index: String, interop_version: String } - ) - end - def to_hash - end - end - - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - end - end - class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekit/models/file_upload_response.rbi index 3baec054..1b6e4d93 100644 --- a/rbi/imagekit/models/file_upload_response.rbi +++ b/rbi/imagekit/models/file_upload_response.rbi @@ -141,14 +141,10 @@ module Imagekit # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. - sig { returns(T.nilable(Imagekit::Models::FileUploadResponse::Metadata)) } + sig { returns(T.nilable(Imagekit::Metadata)) } attr_reader :metadata - sig do - params( - metadata: Imagekit::Models::FileUploadResponse::Metadata::OrHash - ).void - end + sig { params(metadata: Imagekit::Metadata::OrHash).void } attr_writer :metadata # Name of the asset. @@ -234,7 +230,7 @@ module Imagekit height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: Imagekit::Models::FileUploadResponse::Metadata::OrHash, + metadata: Imagekit::Metadata::OrHash, name: String, size: Float, tags: T.nilable(T::Array[String]), @@ -341,7 +337,7 @@ module Imagekit height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: Imagekit::Models::FileUploadResponse::Metadata, + metadata: Imagekit::Metadata, name: String, size: Float, tags: T.nilable(T::Array[String]), @@ -631,889 +627,6 @@ module Imagekit end end - class Metadata < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata, - Imagekit::Internal::AnyHash - ) - end - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # The density of the image in DPI. - sig { returns(T.nilable(Integer)) } - attr_reader :density - - sig { params(density: Integer).void } - attr_writer :density - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :duration - - sig do - returns( - T.nilable(Imagekit::Models::FileUploadResponse::Metadata::Exif) - ) - end - attr_reader :exif - - sig do - params( - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::OrHash - ).void - end - attr_writer :exif - - # The format of the file (e.g., 'jpg', 'mp4'). - sig { returns(T.nilable(String)) } - attr_reader :format_ - - sig { params(format_: String).void } - attr_writer :format_ - - # Indicates if the image has a color profile. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_color_profile - - sig { params(has_color_profile: T::Boolean).void } - attr_writer :has_color_profile - - # Indicates if the image contains transparent areas. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_transparency - - sig { params(has_transparency: T::Boolean).void } - attr_writer :has_transparency - - # The height of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :height - - sig { params(height: Integer).void } - attr_writer :height - - # Perceptual hash of the image. - sig { returns(T.nilable(String)) } - attr_reader :p_hash - - sig { params(p_hash: String).void } - attr_writer :p_hash - - # The quality indicator of the image. - sig { returns(T.nilable(Integer)) } - attr_reader :quality - - sig { params(quality: Integer).void } - attr_writer :quality - - # The file size in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :size - - sig { params(size: Integer).void } - attr_writer :size - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # The width of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :width - - sig { params(width: Integer).void } - attr_writer :width - - # Legacy metadata. Send `metadata` in `responseFields` in API request to get - # metadata in the upload API response. - sig do - params( - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::OrHash, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - ).returns(T.attached_class) - end - def self.new( - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # The density of the image in DPI. - density: nil, - # The duration of the video in seconds (only for video). - duration: nil, - exif: nil, - # The format of the file (e.g., 'jpg', 'mp4'). - format_: nil, - # Indicates if the image has a color profile. - has_color_profile: nil, - # Indicates if the image contains transparent areas. - has_transparency: nil, - # The height of the image or video in pixels. - height: nil, - # Perceptual hash of the image. - p_hash: nil, - # The quality indicator of the image. - quality: nil, - # The file size in bytes. - size: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # The width of the image or video in pixels. - width: nil - ) - end - - sig do - override.returns( - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif, - Imagekit::Internal::AnyHash - ) - end - - # Object containing Exif details. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif - ) - ) - end - attr_reader :exif - - sig do - params( - exif: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif::OrHash - ).void - end - attr_writer :exif - - # Object containing GPS information. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps - ) - ) - end - attr_reader :gps - - sig do - params( - gps: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps::OrHash - ).void - end - attr_writer :gps - - # Object containing EXIF image information. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image - ) - ) - end - attr_reader :image - - sig do - params( - image: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image::OrHash - ).void - end - attr_writer :image - - # JSON object. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability - ) - ) - end - attr_reader :interoperability - - sig do - params( - interoperability: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability::OrHash - ).void - end - attr_writer :interoperability - - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :makernote - - sig { params(makernote: T::Hash[Symbol, T.anything]).void } - attr_writer :makernote - - # Object containing Thumbnail information. - sig do - returns( - T.nilable( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - ) - ) - end - attr_reader :thumbnail - - sig do - params( - thumbnail: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash - ).void - end - attr_writer :thumbnail - - sig do - params( - exif: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif::OrHash, - gps: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps::OrHash, - image: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image::OrHash, - interoperability: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability::OrHash, - makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail::OrHash - ).returns(T.attached_class) - end - def self.new( - # Object containing Exif details. - exif: nil, - # Object containing GPS information. - gps: nil, - # Object containing EXIF image information. - image: nil, - # JSON object. - interoperability: nil, - makernote: nil, - # Object containing Thumbnail information. - thumbnail: nil - ) - end - - sig do - override.returns( - { - exif: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - image: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - interoperability: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, - makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns( - T.attached_class - ) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - - class Image < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params(interop_index: String, interop_version: String).returns( - T.attached_class - ) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns( - { interop_index: String, interop_version: String } - ) - end - def to_hash - end - end - - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - end - end - class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/files/metadata_get_from_url_response.rbi b/rbi/imagekit/models/files/metadata_get_from_url_response.rbi deleted file mode 100644 index 197185d4..00000000 --- a/rbi/imagekit/models/files/metadata_get_from_url_response.rbi +++ /dev/null @@ -1,892 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class MetadataGetFromURLResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse, - Imagekit::Internal::AnyHash - ) - end - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # The density of the image in DPI. - sig { returns(T.nilable(Integer)) } - attr_reader :density - - sig { params(density: Integer).void } - attr_writer :density - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :duration - - sig do - returns( - T.nilable(Imagekit::Models::Files::MetadataGetFromURLResponse::Exif) - ) - end - attr_reader :exif - - sig do - params( - exif: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::OrHash - ).void - end - attr_writer :exif - - # The format of the file (e.g., 'jpg', 'mp4'). - sig { returns(T.nilable(String)) } - attr_reader :format_ - - sig { params(format_: String).void } - attr_writer :format_ - - # Indicates if the image has a color profile. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_color_profile - - sig { params(has_color_profile: T::Boolean).void } - attr_writer :has_color_profile - - # Indicates if the image contains transparent areas. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_transparency - - sig { params(has_transparency: T::Boolean).void } - attr_writer :has_transparency - - # The height of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :height - - sig { params(height: Integer).void } - attr_writer :height - - # Perceptual hash of the image. - sig { returns(T.nilable(String)) } - attr_reader :p_hash - - sig { params(p_hash: String).void } - attr_writer :p_hash - - # The quality indicator of the image. - sig { returns(T.nilable(Integer)) } - attr_reader :quality - - sig { params(quality: Integer).void } - attr_writer :quality - - # The file size in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :size - - sig { params(size: Integer).void } - attr_writer :size - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # The width of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :width - - sig { params(width: Integer).void } - attr_writer :width - - # JSON object containing metadata. - sig do - params( - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::OrHash, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - ).returns(T.attached_class) - end - def self.new( - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # The density of the image in DPI. - density: nil, - # The duration of the video in seconds (only for video). - duration: nil, - exif: nil, - # The format of the file (e.g., 'jpg', 'mp4'). - format_: nil, - # Indicates if the image has a color profile. - has_color_profile: nil, - # Indicates if the image contains transparent areas. - has_transparency: nil, - # The height of the image or video in pixels. - height: nil, - # Perceptual hash of the image. - p_hash: nil, - # The quality indicator of the image. - quality: nil, - # The file size in bytes. - size: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # The width of the image or video in pixels. - width: nil - ) - end - - sig do - override.returns( - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, - Imagekit::Internal::AnyHash - ) - end - - # Object containing Exif details. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif - ) - ) - end - attr_reader :exif - - sig do - params( - exif: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif::OrHash - ).void - end - attr_writer :exif - - # Object containing GPS information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps - ) - ) - end - attr_reader :gps - - sig do - params( - gps: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps::OrHash - ).void - end - attr_writer :gps - - # Object containing EXIF image information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image - ) - ) - end - attr_reader :image - - sig do - params( - image: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image::OrHash - ).void - end - attr_writer :image - - # JSON object. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability - ) - ) - end - attr_reader :interoperability - - sig do - params( - interoperability: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability::OrHash - ).void - end - attr_writer :interoperability - - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :makernote - - sig { params(makernote: T::Hash[Symbol, T.anything]).void } - attr_writer :makernote - - # Object containing Thumbnail information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - ) - ) - end - attr_reader :thumbnail - - sig do - params( - thumbnail: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail::OrHash - ).void - end - attr_writer :thumbnail - - sig do - params( - exif: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif::OrHash, - gps: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps::OrHash, - image: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image::OrHash, - interoperability: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability::OrHash, - makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail::OrHash - ).returns(T.attached_class) - end - def self.new( - # Object containing Exif details. - exif: nil, - # Object containing GPS information. - gps: nil, - # Object containing EXIF image information. - image: nil, - # JSON object. - interoperability: nil, - makernote: nil, - # Object containing Thumbnail information. - thumbnail: nil - ) - end - - sig do - override.returns( - { - exif: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - gps: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - image: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - interoperability: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, - makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns( - T.attached_class - ) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - - class Image < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params(interop_index: String, interop_version: String).returns( - T.attached_class - ) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns( - { interop_index: String, interop_version: String } - ) - end - def to_hash - end - end - - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - end - end - end - end -end diff --git a/rbi/imagekit/models/files/metadata_get_response.rbi b/rbi/imagekit/models/files/metadata_get_response.rbi deleted file mode 100644 index a1d5cf55..00000000 --- a/rbi/imagekit/models/files/metadata_get_response.rbi +++ /dev/null @@ -1,884 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class MetadataGetResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse, - Imagekit::Internal::AnyHash - ) - end - - # The audio codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :audio_codec - - sig { params(audio_codec: String).void } - attr_writer :audio_codec - - # The bit rate of the video in kbps (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :bit_rate - - sig { params(bit_rate: Integer).void } - attr_writer :bit_rate - - # The density of the image in DPI. - sig { returns(T.nilable(Integer)) } - attr_reader :density - - sig { params(density: Integer).void } - attr_writer :density - - # The duration of the video in seconds (only for video). - sig { returns(T.nilable(Integer)) } - attr_reader :duration - - sig { params(duration: Integer).void } - attr_writer :duration - - sig do - returns(T.nilable(Imagekit::Models::Files::MetadataGetResponse::Exif)) - end - attr_reader :exif - - sig do - params( - exif: Imagekit::Models::Files::MetadataGetResponse::Exif::OrHash - ).void - end - attr_writer :exif - - # The format of the file (e.g., 'jpg', 'mp4'). - sig { returns(T.nilable(String)) } - attr_reader :format_ - - sig { params(format_: String).void } - attr_writer :format_ - - # Indicates if the image has a color profile. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_color_profile - - sig { params(has_color_profile: T::Boolean).void } - attr_writer :has_color_profile - - # Indicates if the image contains transparent areas. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :has_transparency - - sig { params(has_transparency: T::Boolean).void } - attr_writer :has_transparency - - # The height of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :height - - sig { params(height: Integer).void } - attr_writer :height - - # Perceptual hash of the image. - sig { returns(T.nilable(String)) } - attr_reader :p_hash - - sig { params(p_hash: String).void } - attr_writer :p_hash - - # The quality indicator of the image. - sig { returns(T.nilable(Integer)) } - attr_reader :quality - - sig { params(quality: Integer).void } - attr_writer :quality - - # The file size in bytes. - sig { returns(T.nilable(Integer)) } - attr_reader :size - - sig { params(size: Integer).void } - attr_writer :size - - # The video codec used in the video (only for video). - sig { returns(T.nilable(String)) } - attr_reader :video_codec - - sig { params(video_codec: String).void } - attr_writer :video_codec - - # The width of the image or video in pixels. - sig { returns(T.nilable(Integer)) } - attr_reader :width - - sig { params(width: Integer).void } - attr_writer :width - - # JSON object containing metadata. - sig do - params( - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataGetResponse::Exif::OrHash, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - ).returns(T.attached_class) - end - def self.new( - # The audio codec used in the video (only for video). - audio_codec: nil, - # The bit rate of the video in kbps (only for video). - bit_rate: nil, - # The density of the image in DPI. - density: nil, - # The duration of the video in seconds (only for video). - duration: nil, - exif: nil, - # The format of the file (e.g., 'jpg', 'mp4'). - format_: nil, - # Indicates if the image has a color profile. - has_color_profile: nil, - # Indicates if the image contains transparent areas. - has_transparency: nil, - # The height of the image or video in pixels. - height: nil, - # Perceptual hash of the image. - p_hash: nil, - # The quality indicator of the image. - quality: nil, - # The file size in bytes. - size: nil, - # The video codec used in the video (only for video). - video_codec: nil, - # The width of the image or video in pixels. - width: nil - ) - end - - sig do - override.returns( - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataGetResponse::Exif, - format_: String, - has_color_profile: T::Boolean, - has_transparency: T::Boolean, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif, - Imagekit::Internal::AnyHash - ) - end - - # Object containing Exif details. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif - ) - ) - end - attr_reader :exif - - sig do - params( - exif: - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif::OrHash - ).void - end - attr_writer :exif - - # Object containing GPS information. - sig do - returns( - T.nilable(Imagekit::Models::Files::MetadataGetResponse::Exif::Gps) - ) - end - attr_reader :gps - - sig do - params( - gps: - Imagekit::Models::Files::MetadataGetResponse::Exif::Gps::OrHash - ).void - end - attr_writer :gps - - # Object containing EXIF image information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetResponse::Exif::Image - ) - ) - end - attr_reader :image - - sig do - params( - image: - Imagekit::Models::Files::MetadataGetResponse::Exif::Image::OrHash - ).void - end - attr_writer :image - - # JSON object. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability - ) - ) - end - attr_reader :interoperability - - sig do - params( - interoperability: - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability::OrHash - ).void - end - attr_writer :interoperability - - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :makernote - - sig { params(makernote: T::Hash[Symbol, T.anything]).void } - attr_writer :makernote - - # Object containing Thumbnail information. - sig do - returns( - T.nilable( - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - ) - ) - end - attr_reader :thumbnail - - sig do - params( - thumbnail: - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail::OrHash - ).void - end - attr_writer :thumbnail - - sig do - params( - exif: - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif::OrHash, - gps: - Imagekit::Models::Files::MetadataGetResponse::Exif::Gps::OrHash, - image: - Imagekit::Models::Files::MetadataGetResponse::Exif::Image::OrHash, - interoperability: - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability::OrHash, - makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail::OrHash - ).returns(T.attached_class) - end - def self.new( - # Object containing Exif details. - exif: nil, - # Object containing GPS information. - gps: nil, - # Object containing EXIF image information. - image: nil, - # JSON object. - interoperability: nil, - makernote: nil, - # Object containing Thumbnail information. - thumbnail: nil - ) - end - - sig do - override.returns( - { - exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - image: - Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - interoperability: - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, - makernote: T::Hash[Symbol, T.anything], - thumbnail: - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - } - ) - end - def to_hash - end - - class Exif < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Float)) } - attr_reader :aperture_value - - sig { params(aperture_value: Float).void } - attr_writer :aperture_value - - sig { returns(T.nilable(Integer)) } - attr_reader :color_space - - sig { params(color_space: Integer).void } - attr_writer :color_space - - sig { returns(T.nilable(String)) } - attr_reader :create_date - - sig { params(create_date: String).void } - attr_writer :create_date - - sig { returns(T.nilable(Integer)) } - attr_reader :custom_rendered - - sig { params(custom_rendered: Integer).void } - attr_writer :custom_rendered - - sig { returns(T.nilable(String)) } - attr_reader :date_time_original - - sig { params(date_time_original: String).void } - attr_writer :date_time_original - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_height - - sig { params(exif_image_height: Integer).void } - attr_writer :exif_image_height - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_image_width - - sig { params(exif_image_width: Integer).void } - attr_writer :exif_image_width - - sig { returns(T.nilable(String)) } - attr_reader :exif_version - - sig { params(exif_version: String).void } - attr_writer :exif_version - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_compensation - - sig { params(exposure_compensation: Float).void } - attr_writer :exposure_compensation - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_mode - - sig { params(exposure_mode: Integer).void } - attr_writer :exposure_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :exposure_program - - sig { params(exposure_program: Integer).void } - attr_writer :exposure_program - - sig { returns(T.nilable(Float)) } - attr_reader :exposure_time - - sig { params(exposure_time: Float).void } - attr_writer :exposure_time - - sig { returns(T.nilable(Integer)) } - attr_reader :flash - - sig { params(flash: Integer).void } - attr_writer :flash - - sig { returns(T.nilable(String)) } - attr_reader :flashpix_version - - sig { params(flashpix_version: String).void } - attr_writer :flashpix_version - - sig { returns(T.nilable(Float)) } - attr_reader :f_number - - sig { params(f_number: Float).void } - attr_writer :f_number - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_length - - sig { params(focal_length: Integer).void } - attr_writer :focal_length - - sig { returns(T.nilable(Integer)) } - attr_reader :focal_plane_resolution_unit - - sig { params(focal_plane_resolution_unit: Integer).void } - attr_writer :focal_plane_resolution_unit - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_x_resolution - - sig { params(focal_plane_x_resolution: Float).void } - attr_writer :focal_plane_x_resolution - - sig { returns(T.nilable(Float)) } - attr_reader :focal_plane_y_resolution - - sig { params(focal_plane_y_resolution: Float).void } - attr_writer :focal_plane_y_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :interop_offset - - sig { params(interop_offset: Integer).void } - attr_writer :interop_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :iso - - sig { params(iso: Integer).void } - attr_writer :iso - - sig { returns(T.nilable(Integer)) } - attr_reader :metering_mode - - sig { params(metering_mode: Integer).void } - attr_writer :metering_mode - - sig { returns(T.nilable(Integer)) } - attr_reader :scene_capture_type - - sig { params(scene_capture_type: Integer).void } - attr_writer :scene_capture_type - - sig { returns(T.nilable(Float)) } - attr_reader :shutter_speed_value - - sig { params(shutter_speed_value: Float).void } - attr_writer :shutter_speed_value - - sig { returns(T.nilable(String)) } - attr_reader :sub_sec_time - - sig { params(sub_sec_time: String).void } - attr_writer :sub_sec_time - - sig { returns(T.nilable(Integer)) } - attr_reader :white_balance - - sig { params(white_balance: Integer).void } - attr_writer :white_balance - - # Object containing Exif details. - sig do - params( - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - ).returns(T.attached_class) - end - def self.new( - aperture_value: nil, - color_space: nil, - create_date: nil, - custom_rendered: nil, - date_time_original: nil, - exif_image_height: nil, - exif_image_width: nil, - exif_version: nil, - exposure_compensation: nil, - exposure_mode: nil, - exposure_program: nil, - exposure_time: nil, - flash: nil, - flashpix_version: nil, - f_number: nil, - focal_length: nil, - focal_plane_resolution_unit: nil, - focal_plane_x_resolution: nil, - focal_plane_y_resolution: nil, - interop_offset: nil, - iso: nil, - metering_mode: nil, - scene_capture_type: nil, - shutter_speed_value: nil, - sub_sec_time: nil, - white_balance: nil - ) - end - - sig do - override.returns( - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - ) - end - def to_hash - end - end - - class Gps < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(T::Array[Integer])) } - attr_reader :gps_version_id - - sig { params(gps_version_id: T::Array[Integer]).void } - attr_writer :gps_version_id - - # Object containing GPS information. - sig do - params(gps_version_id: T::Array[Integer]).returns( - T.attached_class - ) - end - def self.new(gps_version_id: nil) - end - - sig { override.returns({ gps_version_id: T::Array[Integer] }) } - def to_hash - end - end - - class Image < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :exif_offset - - sig { params(exif_offset: Integer).void } - attr_writer :exif_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :gps_info - - sig { params(gps_info: Integer).void } - attr_writer :gps_info - - sig { returns(T.nilable(String)) } - attr_reader :make - - sig { params(make: String).void } - attr_writer :make - - sig { returns(T.nilable(String)) } - attr_reader :model - - sig { params(model: String).void } - attr_writer :model - - sig { returns(T.nilable(String)) } - attr_reader :modify_date - - sig { params(modify_date: String).void } - attr_writer :modify_date - - sig { returns(T.nilable(Integer)) } - attr_reader :orientation - - sig { params(orientation: Integer).void } - attr_writer :orientation - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(String)) } - attr_reader :software - - sig { params(software: String).void } - attr_writer :software - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_cb_cr_positioning - - sig { params(y_cb_cr_positioning: Integer).void } - attr_writer :y_cb_cr_positioning - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing EXIF image information. - sig do - params( - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - exif_offset: nil, - gps_info: nil, - make: nil, - model: nil, - modify_date: nil, - orientation: nil, - resolution_unit: nil, - software: nil, - x_resolution: nil, - y_cb_cr_positioning: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - - class Interoperability < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_reader :interop_index - - sig { params(interop_index: String).void } - attr_writer :interop_index - - sig { returns(T.nilable(String)) } - attr_reader :interop_version - - sig { params(interop_version: String).void } - attr_writer :interop_version - - # JSON object. - sig do - params(interop_index: String, interop_version: String).returns( - T.attached_class - ) - end - def self.new(interop_index: nil, interop_version: nil) - end - - sig do - override.returns( - { interop_index: String, interop_version: String } - ) - end - def to_hash - end - end - - class Thumbnail < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail, - Imagekit::Internal::AnyHash - ) - end - - sig { returns(T.nilable(Integer)) } - attr_reader :compression - - sig { params(compression: Integer).void } - attr_writer :compression - - sig { returns(T.nilable(Integer)) } - attr_reader :resolution_unit - - sig { params(resolution_unit: Integer).void } - attr_writer :resolution_unit - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_length - - sig { params(thumbnail_length: Integer).void } - attr_writer :thumbnail_length - - sig { returns(T.nilable(Integer)) } - attr_reader :thumbnail_offset - - sig { params(thumbnail_offset: Integer).void } - attr_writer :thumbnail_offset - - sig { returns(T.nilable(Integer)) } - attr_reader :x_resolution - - sig { params(x_resolution: Integer).void } - attr_writer :x_resolution - - sig { returns(T.nilable(Integer)) } - attr_reader :y_resolution - - sig { params(y_resolution: Integer).void } - attr_writer :y_resolution - - # Object containing Thumbnail information. - sig do - params( - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - ).returns(T.attached_class) - end - def self.new( - compression: nil, - resolution_unit: nil, - thumbnail_length: nil, - thumbnail_offset: nil, - x_resolution: nil, - y_resolution: nil - ) - end - - sig do - override.returns( - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - ) - end - def to_hash - end - end - end - end - end - end -end diff --git a/rbi/imagekit/models/metadata.rbi b/rbi/imagekit/models/metadata.rbi new file mode 100644 index 00000000..53bea104 --- /dev/null +++ b/rbi/imagekit/models/metadata.rbi @@ -0,0 +1,804 @@ +# typed: strong + +module Imagekit + module Models + class Metadata < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Imagekit::Metadata, Imagekit::Internal::AnyHash) } + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # The density of the image in DPI. + sig { returns(T.nilable(Integer)) } + attr_reader :density + + sig { params(density: Integer).void } + attr_writer :density + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + sig { returns(T.nilable(Imagekit::Metadata::Exif)) } + attr_reader :exif + + sig { params(exif: Imagekit::Metadata::Exif::OrHash).void } + attr_writer :exif + + # The format of the file (e.g., 'jpg', 'mp4'). + sig { returns(T.nilable(String)) } + attr_reader :format_ + + sig { params(format_: String).void } + attr_writer :format_ + + # Indicates if the image has a color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_color_profile + + sig { params(has_color_profile: T::Boolean).void } + attr_writer :has_color_profile + + # Indicates if the image contains transparent areas. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :has_transparency + + sig { params(has_transparency: T::Boolean).void } + attr_writer :has_transparency + + # The height of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Perceptual hash of the image. + sig { returns(T.nilable(String)) } + attr_reader :p_hash + + sig { params(p_hash: String).void } + attr_writer :p_hash + + # The quality indicator of the image. + sig { returns(T.nilable(Integer)) } + attr_reader :quality + + sig { params(quality: Integer).void } + attr_writer :quality + + # The file size in bytes. + sig { returns(T.nilable(Integer)) } + attr_reader :size + + sig { params(size: Integer).void } + attr_writer :size + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # The width of the image or video in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # JSON object containing metadata. + sig do + params( + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Metadata::Exif::OrHash, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # The density of the image in DPI. + density: nil, + # The duration of the video in seconds (only for video). + duration: nil, + exif: nil, + # The format of the file (e.g., 'jpg', 'mp4'). + format_: nil, + # Indicates if the image has a color profile. + has_color_profile: nil, + # Indicates if the image contains transparent areas. + has_transparency: nil, + # The height of the image or video in pixels. + height: nil, + # Perceptual hash of the image. + p_hash: nil, + # The quality indicator of the image. + quality: nil, + # The file size in bytes. + size: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # The width of the image or video in pixels. + width: nil + ) + end + + sig do + override.returns( + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Metadata::Exif, + format_: String, + has_color_profile: T::Boolean, + has_transparency: T::Boolean, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Metadata::Exif, Imagekit::Internal::AnyHash) + end + + # Object containing Exif details. + sig { returns(T.nilable(Imagekit::Metadata::Exif::Exif)) } + attr_reader :exif + + sig { params(exif: Imagekit::Metadata::Exif::Exif::OrHash).void } + attr_writer :exif + + # Object containing GPS information. + sig { returns(T.nilable(Imagekit::Metadata::Exif::Gps)) } + attr_reader :gps + + sig { params(gps: Imagekit::Metadata::Exif::Gps::OrHash).void } + attr_writer :gps + + # Object containing EXIF image information. + sig { returns(T.nilable(Imagekit::Metadata::Exif::Image)) } + attr_reader :image + + sig { params(image: Imagekit::Metadata::Exif::Image::OrHash).void } + attr_writer :image + + # JSON object. + sig { returns(T.nilable(Imagekit::Metadata::Exif::Interoperability)) } + attr_reader :interoperability + + sig do + params( + interoperability: Imagekit::Metadata::Exif::Interoperability::OrHash + ).void + end + attr_writer :interoperability + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :makernote + + sig { params(makernote: T::Hash[Symbol, T.anything]).void } + attr_writer :makernote + + # Object containing Thumbnail information. + sig { returns(T.nilable(Imagekit::Metadata::Exif::Thumbnail)) } + attr_reader :thumbnail + + sig do + params(thumbnail: Imagekit::Metadata::Exif::Thumbnail::OrHash).void + end + attr_writer :thumbnail + + sig do + params( + exif: Imagekit::Metadata::Exif::Exif::OrHash, + gps: Imagekit::Metadata::Exif::Gps::OrHash, + image: Imagekit::Metadata::Exif::Image::OrHash, + interoperability: + Imagekit::Metadata::Exif::Interoperability::OrHash, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Metadata::Exif::Thumbnail::OrHash + ).returns(T.attached_class) + end + def self.new( + # Object containing Exif details. + exif: nil, + # Object containing GPS information. + gps: nil, + # Object containing EXIF image information. + image: nil, + # JSON object. + interoperability: nil, + makernote: nil, + # Object containing Thumbnail information. + thumbnail: nil + ) + end + + sig do + override.returns( + { + exif: Imagekit::Metadata::Exif::Exif, + gps: Imagekit::Metadata::Exif::Gps, + image: Imagekit::Metadata::Exif::Image, + interoperability: Imagekit::Metadata::Exif::Interoperability, + makernote: T::Hash[Symbol, T.anything], + thumbnail: Imagekit::Metadata::Exif::Thumbnail + } + ) + end + def to_hash + end + + class Exif < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Metadata::Exif::Exif, Imagekit::Internal::AnyHash) + end + + sig { returns(T.nilable(Float)) } + attr_reader :aperture_value + + sig { params(aperture_value: Float).void } + attr_writer :aperture_value + + sig { returns(T.nilable(Integer)) } + attr_reader :color_space + + sig { params(color_space: Integer).void } + attr_writer :color_space + + sig { returns(T.nilable(String)) } + attr_reader :create_date + + sig { params(create_date: String).void } + attr_writer :create_date + + sig { returns(T.nilable(Integer)) } + attr_reader :custom_rendered + + sig { params(custom_rendered: Integer).void } + attr_writer :custom_rendered + + sig { returns(T.nilable(String)) } + attr_reader :date_time_original + + sig { params(date_time_original: String).void } + attr_writer :date_time_original + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_height + + sig { params(exif_image_height: Integer).void } + attr_writer :exif_image_height + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_image_width + + sig { params(exif_image_width: Integer).void } + attr_writer :exif_image_width + + sig { returns(T.nilable(String)) } + attr_reader :exif_version + + sig { params(exif_version: String).void } + attr_writer :exif_version + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_compensation + + sig { params(exposure_compensation: Float).void } + attr_writer :exposure_compensation + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_mode + + sig { params(exposure_mode: Integer).void } + attr_writer :exposure_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :exposure_program + + sig { params(exposure_program: Integer).void } + attr_writer :exposure_program + + sig { returns(T.nilable(Float)) } + attr_reader :exposure_time + + sig { params(exposure_time: Float).void } + attr_writer :exposure_time + + sig { returns(T.nilable(Integer)) } + attr_reader :flash + + sig { params(flash: Integer).void } + attr_writer :flash + + sig { returns(T.nilable(String)) } + attr_reader :flashpix_version + + sig { params(flashpix_version: String).void } + attr_writer :flashpix_version + + sig { returns(T.nilable(Float)) } + attr_reader :f_number + + sig { params(f_number: Float).void } + attr_writer :f_number + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_length + + sig { params(focal_length: Integer).void } + attr_writer :focal_length + + sig { returns(T.nilable(Integer)) } + attr_reader :focal_plane_resolution_unit + + sig { params(focal_plane_resolution_unit: Integer).void } + attr_writer :focal_plane_resolution_unit + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_x_resolution + + sig { params(focal_plane_x_resolution: Float).void } + attr_writer :focal_plane_x_resolution + + sig { returns(T.nilable(Float)) } + attr_reader :focal_plane_y_resolution + + sig { params(focal_plane_y_resolution: Float).void } + attr_writer :focal_plane_y_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :interop_offset + + sig { params(interop_offset: Integer).void } + attr_writer :interop_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :iso + + sig { params(iso: Integer).void } + attr_writer :iso + + sig { returns(T.nilable(Integer)) } + attr_reader :metering_mode + + sig { params(metering_mode: Integer).void } + attr_writer :metering_mode + + sig { returns(T.nilable(Integer)) } + attr_reader :scene_capture_type + + sig { params(scene_capture_type: Integer).void } + attr_writer :scene_capture_type + + sig { returns(T.nilable(Float)) } + attr_reader :shutter_speed_value + + sig { params(shutter_speed_value: Float).void } + attr_writer :shutter_speed_value + + sig { returns(T.nilable(String)) } + attr_reader :sub_sec_time + + sig { params(sub_sec_time: String).void } + attr_writer :sub_sec_time + + sig { returns(T.nilable(Integer)) } + attr_reader :white_balance + + sig { params(white_balance: Integer).void } + attr_writer :white_balance + + # Object containing Exif details. + sig do + params( + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + ).returns(T.attached_class) + end + def self.new( + aperture_value: nil, + color_space: nil, + create_date: nil, + custom_rendered: nil, + date_time_original: nil, + exif_image_height: nil, + exif_image_width: nil, + exif_version: nil, + exposure_compensation: nil, + exposure_mode: nil, + exposure_program: nil, + exposure_time: nil, + flash: nil, + flashpix_version: nil, + f_number: nil, + focal_length: nil, + focal_plane_resolution_unit: nil, + focal_plane_x_resolution: nil, + focal_plane_y_resolution: nil, + interop_offset: nil, + iso: nil, + metering_mode: nil, + scene_capture_type: nil, + shutter_speed_value: nil, + sub_sec_time: nil, + white_balance: nil + ) + end + + sig do + override.returns( + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + ) + end + def to_hash + end + end + + class Gps < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Metadata::Exif::Gps, Imagekit::Internal::AnyHash) + end + + sig { returns(T.nilable(T::Array[Integer])) } + attr_reader :gps_version_id + + sig { params(gps_version_id: T::Array[Integer]).void } + attr_writer :gps_version_id + + # Object containing GPS information. + sig do + params(gps_version_id: T::Array[Integer]).returns(T.attached_class) + end + def self.new(gps_version_id: nil) + end + + sig { override.returns({ gps_version_id: T::Array[Integer] }) } + def to_hash + end + end + + class Image < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Metadata::Exif::Image, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :exif_offset + + sig { params(exif_offset: Integer).void } + attr_writer :exif_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :gps_info + + sig { params(gps_info: Integer).void } + attr_writer :gps_info + + sig { returns(T.nilable(String)) } + attr_reader :make + + sig { params(make: String).void } + attr_writer :make + + sig { returns(T.nilable(String)) } + attr_reader :model + + sig { params(model: String).void } + attr_writer :model + + sig { returns(T.nilable(String)) } + attr_reader :modify_date + + sig { params(modify_date: String).void } + attr_writer :modify_date + + sig { returns(T.nilable(Integer)) } + attr_reader :orientation + + sig { params(orientation: Integer).void } + attr_writer :orientation + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(String)) } + attr_reader :software + + sig { params(software: String).void } + attr_writer :software + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_cb_cr_positioning + + sig { params(y_cb_cr_positioning: Integer).void } + attr_writer :y_cb_cr_positioning + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing EXIF image information. + sig do + params( + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + exif_offset: nil, + gps_info: nil, + make: nil, + model: nil, + modify_date: nil, + orientation: nil, + resolution_unit: nil, + software: nil, + x_resolution: nil, + y_cb_cr_positioning: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + + class Interoperability < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Metadata::Exif::Interoperability, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_reader :interop_index + + sig { params(interop_index: String).void } + attr_writer :interop_index + + sig { returns(T.nilable(String)) } + attr_reader :interop_version + + sig { params(interop_version: String).void } + attr_writer :interop_version + + # JSON object. + sig do + params(interop_index: String, interop_version: String).returns( + T.attached_class + ) + end + def self.new(interop_index: nil, interop_version: nil) + end + + sig do + override.returns({ interop_index: String, interop_version: String }) + end + def to_hash + end + end + + class Thumbnail < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Metadata::Exif::Thumbnail, + Imagekit::Internal::AnyHash + ) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :compression + + sig { params(compression: Integer).void } + attr_writer :compression + + sig { returns(T.nilable(Integer)) } + attr_reader :resolution_unit + + sig { params(resolution_unit: Integer).void } + attr_writer :resolution_unit + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_length + + sig { params(thumbnail_length: Integer).void } + attr_writer :thumbnail_length + + sig { returns(T.nilable(Integer)) } + attr_reader :thumbnail_offset + + sig { params(thumbnail_offset: Integer).void } + attr_writer :thumbnail_offset + + sig { returns(T.nilable(Integer)) } + attr_reader :x_resolution + + sig { params(x_resolution: Integer).void } + attr_writer :x_resolution + + sig { returns(T.nilable(Integer)) } + attr_reader :y_resolution + + sig { params(y_resolution: Integer).void } + attr_writer :y_resolution + + # Object containing Thumbnail information. + sig do + params( + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + ).returns(T.attached_class) + end + def self.new( + compression: nil, + resolution_unit: nil, + thumbnail_length: nil, + thumbnail_offset: nil, + x_resolution: nil, + y_resolution: nil + ) + end + + sig do + override.returns( + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/imagekit/resources/files/metadata.rbi b/rbi/imagekit/resources/files/metadata.rbi index 9b795ba6..34ecc601 100644 --- a/rbi/imagekit/resources/files/metadata.rbi +++ b/rbi/imagekit/resources/files/metadata.rbi @@ -13,7 +13,7 @@ module Imagekit params( file_id: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::MetadataGetResponse) + ).returns(Imagekit::Metadata) end def get( # The unique `fileId` of the uploaded file. `fileId` is returned in the list and @@ -29,7 +29,7 @@ module Imagekit params( url: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::MetadataGetFromURLResponse) + ).returns(Imagekit::Metadata) end def get_from_url( # Should be a valid file URL. It should be accessible using your ImageKit.io diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index a525aabc..3dfdb265 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -49,6 +49,8 @@ module Imagekit module Folders = Imagekit::Models::Folders + class Metadata = Imagekit::Models::Metadata + module UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs index 1d8a524d..b55e39df 100644 --- a/sig/imagekit/models/beta/v2/file_upload_response.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_response.rbs @@ -18,7 +18,7 @@ module Imagekit height: Float, is_private_file: bool, is_published: bool, - metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + metadata: Imagekit::Metadata, name: String, size: Float, tags: ::Array[String]?, @@ -84,11 +84,9 @@ module Imagekit def is_published=: (bool) -> bool - attr_reader metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata? + attr_reader metadata: Imagekit::Metadata? - def metadata=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata + def metadata=: (Imagekit::Metadata) -> Imagekit::Metadata attr_reader name: String? @@ -137,7 +135,7 @@ module Imagekit ?height: Float, ?is_private_file: bool, ?is_published: bool, - ?metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + ?metadata: Imagekit::Metadata, ?name: String, ?size: Float, ?tags: ::Array[String]?, @@ -163,7 +161,7 @@ module Imagekit height: Float, is_private_file: bool, is_published: bool, - metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata, + metadata: Imagekit::Metadata, name: String, size: Float, tags: ::Array[String]?, @@ -273,554 +271,6 @@ module Imagekit end end - type metadata = - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - class Metadata < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_reader density: Integer? - - def density=: (Integer) -> Integer - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif? - - def exif=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif - - attr_reader format_: String? - - def format_=: (String) -> String - - attr_reader has_color_profile: bool? - - def has_color_profile=: (bool) -> bool - - attr_reader has_transparency: bool? - - def has_transparency=: (bool) -> bool - - attr_reader height: Integer? - - def height=: (Integer) -> Integer - - attr_reader p_hash: String? - - def p_hash=: (String) -> String - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader size: Integer? - - def size=: (Integer) -> Integer - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Integer? - - def width=: (Integer) -> Integer - - def initialize: ( - ?audio_codec: String, - ?bit_rate: Integer, - ?density: Integer, - ?duration: Integer, - ?exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, - ?format_: String, - ?has_color_profile: bool, - ?has_transparency: bool, - ?height: Integer, - ?p_hash: String, - ?quality: Integer, - ?size: Integer, - ?video_codec: String, - ?width: Integer - ) -> void - - def to_hash: -> { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - type exif = - { - exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif? - - def exif=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif - - attr_reader gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps? - - def gps=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps - - attr_reader image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image? - - def image=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image - - attr_reader interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability? - - def interoperability=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability - - attr_reader makernote: ::Hash[Symbol, top]? - - def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail? - - def thumbnail=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - - def initialize: ( - ?exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - ?gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - ?image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - ?interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, - ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - ) -> void - - def to_hash: -> { - exif: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Gps, - image: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Image, - interoperability: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata::Exif::Thumbnail - } - - type exif = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - - type image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class Image < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - - type interoperability = - { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: ( - ?interop_index: String, - ?interop_version: String - ) -> void - - def to_hash: -> { - interop_index: String, - interop_version: String - } - end - - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end - end - end - type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs index bcf2de3c..b3629b61 100644 --- a/sig/imagekit/models/file_upload_response.rbs +++ b/sig/imagekit/models/file_upload_response.rbs @@ -16,7 +16,7 @@ module Imagekit height: Float, is_private_file: bool, is_published: bool, - metadata: Imagekit::Models::FileUploadResponse::Metadata, + metadata: Imagekit::Metadata, name: String, size: Float, tags: ::Array[String]?, @@ -82,11 +82,9 @@ module Imagekit def is_published=: (bool) -> bool - attr_reader metadata: Imagekit::Models::FileUploadResponse::Metadata? + attr_reader metadata: Imagekit::Metadata? - def metadata=: ( - Imagekit::Models::FileUploadResponse::Metadata - ) -> Imagekit::Models::FileUploadResponse::Metadata + def metadata=: (Imagekit::Metadata) -> Imagekit::Metadata attr_reader name: String? @@ -135,7 +133,7 @@ module Imagekit ?height: Float, ?is_private_file: bool, ?is_published: bool, - ?metadata: Imagekit::Models::FileUploadResponse::Metadata, + ?metadata: Imagekit::Metadata, ?name: String, ?size: Float, ?tags: ::Array[String]?, @@ -161,7 +159,7 @@ module Imagekit height: Float, is_private_file: bool, is_published: bool, - metadata: Imagekit::Models::FileUploadResponse::Metadata, + metadata: Imagekit::Metadata, name: String, size: Float, tags: ::Array[String]?, @@ -271,551 +269,6 @@ module Imagekit end end - type metadata = - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - class Metadata < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_reader density: Integer? - - def density=: (Integer) -> Integer - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader exif: Imagekit::Models::FileUploadResponse::Metadata::Exif? - - def exif=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif - - attr_reader format_: String? - - def format_=: (String) -> String - - attr_reader has_color_profile: bool? - - def has_color_profile=: (bool) -> bool - - attr_reader has_transparency: bool? - - def has_transparency=: (bool) -> bool - - attr_reader height: Integer? - - def height=: (Integer) -> Integer - - attr_reader p_hash: String? - - def p_hash=: (String) -> String - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader size: Integer? - - def size=: (Integer) -> Integer - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Integer? - - def width=: (Integer) -> Integer - - def initialize: ( - ?audio_codec: String, - ?bit_rate: Integer, - ?density: Integer, - ?duration: Integer, - ?exif: Imagekit::Models::FileUploadResponse::Metadata::Exif, - ?format_: String, - ?has_color_profile: bool, - ?has_transparency: bool, - ?height: Integer, - ?p_hash: String, - ?quality: Integer, - ?size: Integer, - ?video_codec: String, - ?width: Integer - ) -> void - - def to_hash: -> { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - type exif = - { - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif? - - def exif=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif - - attr_reader gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps? - - def gps=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps - - attr_reader image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image? - - def image=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Image - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Image - - attr_reader interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability? - - def interoperability=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability - - attr_reader makernote: ::Hash[Symbol, top]? - - def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail? - - def thumbnail=: ( - Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - ) -> Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - - def initialize: ( - ?exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - ?gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - ?image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - ?interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, - ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - ) -> void - - def to_hash: -> { - exif: Imagekit::Models::FileUploadResponse::Metadata::Exif::Exif, - gps: Imagekit::Models::FileUploadResponse::Metadata::Exif::Gps, - image: Imagekit::Models::FileUploadResponse::Metadata::Exif::Image, - interoperability: Imagekit::Models::FileUploadResponse::Metadata::Exif::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::FileUploadResponse::Metadata::Exif::Thumbnail - } - - type exif = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - - type image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class Image < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - - type interoperability = - { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: ( - ?interop_index: String, - ?interop_version: String - ) -> void - - def to_hash: -> { interop_index: String, interop_version: String } - end - - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end - end - end - type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/models/files/metadata_get_from_url_response.rbs b/sig/imagekit/models/files/metadata_get_from_url_response.rbs deleted file mode 100644 index 0befaf28..00000000 --- a/sig/imagekit/models/files/metadata_get_from_url_response.rbs +++ /dev/null @@ -1,550 +0,0 @@ -module Imagekit - module Models - module Files - type metadata_get_from_url_response = - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - class MetadataGetFromURLResponse < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_reader density: Integer? - - def density=: (Integer) -> Integer - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif? - - def exif=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif - - attr_reader format_: String? - - def format_=: (String) -> String - - attr_reader has_color_profile: bool? - - def has_color_profile=: (bool) -> bool - - attr_reader has_transparency: bool? - - def has_transparency=: (bool) -> bool - - attr_reader height: Integer? - - def height=: (Integer) -> Integer - - attr_reader p_hash: String? - - def p_hash=: (String) -> String - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader size: Integer? - - def size=: (Integer) -> Integer - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Integer? - - def width=: (Integer) -> Integer - - def initialize: ( - ?audio_codec: String, - ?bit_rate: Integer, - ?density: Integer, - ?duration: Integer, - ?exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, - ?format_: String, - ?has_color_profile: bool, - ?has_transparency: bool, - ?height: Integer, - ?p_hash: String, - ?quality: Integer, - ?size: Integer, - ?video_codec: String, - ?width: Integer - ) -> void - - def to_hash: -> { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - type exif = - { - exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif? - - def exif=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif - - attr_reader gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps? - - def gps=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps - - attr_reader image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image? - - def image=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image - - attr_reader interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability? - - def interoperability=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability - - attr_reader makernote: ::Hash[Symbol, top]? - - def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail? - - def thumbnail=: ( - Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - - def initialize: ( - ?exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - ?gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - ?image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - ?interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, - ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - ) -> void - - def to_hash: -> { - exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Gps, - image: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Image, - interoperability: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif::Thumbnail - } - - type exif = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - - type image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class Image < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - - type interoperability = - { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: ( - ?interop_index: String, - ?interop_version: String - ) -> void - - def to_hash: -> { interop_index: String, interop_version: String } - end - - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end - end - end - end - end -end diff --git a/sig/imagekit/models/files/metadata_get_response.rbs b/sig/imagekit/models/files/metadata_get_response.rbs deleted file mode 100644 index 749a3cad..00000000 --- a/sig/imagekit/models/files/metadata_get_response.rbs +++ /dev/null @@ -1,550 +0,0 @@ -module Imagekit - module Models - module Files - type metadata_get_response = - { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataGetResponse::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - class MetadataGetResponse < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_reader density: Integer? - - def density=: (Integer) -> Integer - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader exif: Imagekit::Models::Files::MetadataGetResponse::Exif? - - def exif=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif - - attr_reader format_: String? - - def format_=: (String) -> String - - attr_reader has_color_profile: bool? - - def has_color_profile=: (bool) -> bool - - attr_reader has_transparency: bool? - - def has_transparency=: (bool) -> bool - - attr_reader height: Integer? - - def height=: (Integer) -> Integer - - attr_reader p_hash: String? - - def p_hash=: (String) -> String - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader size: Integer? - - def size=: (Integer) -> Integer - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Integer? - - def width=: (Integer) -> Integer - - def initialize: ( - ?audio_codec: String, - ?bit_rate: Integer, - ?density: Integer, - ?duration: Integer, - ?exif: Imagekit::Models::Files::MetadataGetResponse::Exif, - ?format_: String, - ?has_color_profile: bool, - ?has_transparency: bool, - ?height: Integer, - ?p_hash: String, - ?quality: Integer, - ?size: Integer, - ?video_codec: String, - ?width: Integer - ) -> void - - def to_hash: -> { - audio_codec: String, - bit_rate: Integer, - density: Integer, - duration: Integer, - exif: Imagekit::Models::Files::MetadataGetResponse::Exif, - format_: String, - has_color_profile: bool, - has_transparency: bool, - height: Integer, - p_hash: String, - quality: Integer, - size: Integer, - video_codec: String, - width: Integer - } - - type exif = - { - exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif? - - def exif=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Exif - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Exif - - attr_reader gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps? - - def gps=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Gps - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Gps - - attr_reader image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image? - - def image=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Image - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Image - - attr_reader interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability? - - def interoperability=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability - - attr_reader makernote: ::Hash[Symbol, top]? - - def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail? - - def thumbnail=: ( - Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - ) -> Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - - def initialize: ( - ?exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - ?gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - ?image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - ?interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, - ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - ) -> void - - def to_hash: -> { - exif: Imagekit::Models::Files::MetadataGetResponse::Exif::Exif, - gps: Imagekit::Models::Files::MetadataGetResponse::Exif::Gps, - image: Imagekit::Models::Files::MetadataGetResponse::Exif::Image, - interoperability: Imagekit::Models::Files::MetadataGetResponse::Exif::Interoperability, - makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Models::Files::MetadataGetResponse::Exif::Thumbnail - } - - type exif = - { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader aperture_value: Float? - - def aperture_value=: (Float) -> Float - - attr_reader color_space: Integer? - - def color_space=: (Integer) -> Integer - - attr_reader create_date: String? - - def create_date=: (String) -> String - - attr_reader custom_rendered: Integer? - - def custom_rendered=: (Integer) -> Integer - - attr_reader date_time_original: String? - - def date_time_original=: (String) -> String - - attr_reader exif_image_height: Integer? - - def exif_image_height=: (Integer) -> Integer - - attr_reader exif_image_width: Integer? - - def exif_image_width=: (Integer) -> Integer - - attr_reader exif_version: String? - - def exif_version=: (String) -> String - - attr_reader exposure_compensation: Float? - - def exposure_compensation=: (Float) -> Float - - attr_reader exposure_mode: Integer? - - def exposure_mode=: (Integer) -> Integer - - attr_reader exposure_program: Integer? - - def exposure_program=: (Integer) -> Integer - - attr_reader exposure_time: Float? - - def exposure_time=: (Float) -> Float - - attr_reader flash: Integer? - - def flash=: (Integer) -> Integer - - attr_reader flashpix_version: String? - - def flashpix_version=: (String) -> String - - attr_reader f_number: Float? - - def f_number=: (Float) -> Float - - attr_reader focal_length: Integer? - - def focal_length=: (Integer) -> Integer - - attr_reader focal_plane_resolution_unit: Integer? - - def focal_plane_resolution_unit=: (Integer) -> Integer - - attr_reader focal_plane_x_resolution: Float? - - def focal_plane_x_resolution=: (Float) -> Float - - attr_reader focal_plane_y_resolution: Float? - - def focal_plane_y_resolution=: (Float) -> Float - - attr_reader interop_offset: Integer? - - def interop_offset=: (Integer) -> Integer - - attr_reader iso: Integer? - - def iso=: (Integer) -> Integer - - attr_reader metering_mode: Integer? - - def metering_mode=: (Integer) -> Integer - - attr_reader scene_capture_type: Integer? - - def scene_capture_type=: (Integer) -> Integer - - attr_reader shutter_speed_value: Float? - - def shutter_speed_value=: (Float) -> Float - - attr_reader sub_sec_time: String? - - def sub_sec_time=: (String) -> String - - attr_reader white_balance: Integer? - - def white_balance=: (Integer) -> Integer - - def initialize: ( - ?aperture_value: Float, - ?color_space: Integer, - ?create_date: String, - ?custom_rendered: Integer, - ?date_time_original: String, - ?exif_image_height: Integer, - ?exif_image_width: Integer, - ?exif_version: String, - ?exposure_compensation: Float, - ?exposure_mode: Integer, - ?exposure_program: Integer, - ?exposure_time: Float, - ?flash: Integer, - ?flashpix_version: String, - ?f_number: Float, - ?focal_length: Integer, - ?focal_plane_resolution_unit: Integer, - ?focal_plane_x_resolution: Float, - ?focal_plane_y_resolution: Float, - ?interop_offset: Integer, - ?iso: Integer, - ?metering_mode: Integer, - ?scene_capture_type: Integer, - ?shutter_speed_value: Float, - ?sub_sec_time: String, - ?white_balance: Integer - ) -> void - - def to_hash: -> { - aperture_value: Float, - color_space: Integer, - create_date: String, - custom_rendered: Integer, - date_time_original: String, - exif_image_height: Integer, - exif_image_width: Integer, - exif_version: String, - exposure_compensation: Float, - exposure_mode: Integer, - exposure_program: Integer, - exposure_time: Float, - flash: Integer, - flashpix_version: String, - f_number: Float, - focal_length: Integer, - focal_plane_resolution_unit: Integer, - focal_plane_x_resolution: Float, - focal_plane_y_resolution: Float, - interop_offset: Integer, - iso: Integer, - metering_mode: Integer, - scene_capture_type: Integer, - shutter_speed_value: Float, - sub_sec_time: String, - white_balance: Integer - } - end - - type gps = { gps_version_id: ::Array[Integer] } - - class Gps < Imagekit::Internal::Type::BaseModel - attr_reader gps_version_id: ::Array[Integer]? - - def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] - - def initialize: (?gps_version_id: ::Array[Integer]) -> void - - def to_hash: -> { gps_version_id: ::Array[Integer] } - end - - type image = - { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - - class Image < Imagekit::Internal::Type::BaseModel - attr_reader exif_offset: Integer? - - def exif_offset=: (Integer) -> Integer - - attr_reader gps_info: Integer? - - def gps_info=: (Integer) -> Integer - - attr_reader make: String? - - def make=: (String) -> String - - attr_reader model: String? - - def model=: (String) -> String - - attr_reader modify_date: String? - - def modify_date=: (String) -> String - - attr_reader orientation: Integer? - - def orientation=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader software: String? - - def software=: (String) -> String - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_cb_cr_positioning: Integer? - - def y_cb_cr_positioning=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?exif_offset: Integer, - ?gps_info: Integer, - ?make: String, - ?model: String, - ?modify_date: String, - ?orientation: Integer, - ?resolution_unit: Integer, - ?software: String, - ?x_resolution: Integer, - ?y_cb_cr_positioning: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - exif_offset: Integer, - gps_info: Integer, - make: String, - model: String, - modify_date: String, - orientation: Integer, - resolution_unit: Integer, - software: String, - x_resolution: Integer, - y_cb_cr_positioning: Integer, - y_resolution: Integer - } - end - - type interoperability = - { interop_index: String, interop_version: String } - - class Interoperability < Imagekit::Internal::Type::BaseModel - attr_reader interop_index: String? - - def interop_index=: (String) -> String - - attr_reader interop_version: String? - - def interop_version=: (String) -> String - - def initialize: ( - ?interop_index: String, - ?interop_version: String - ) -> void - - def to_hash: -> { interop_index: String, interop_version: String } - end - - type thumbnail = - { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - - class Thumbnail < Imagekit::Internal::Type::BaseModel - attr_reader compression: Integer? - - def compression=: (Integer) -> Integer - - attr_reader resolution_unit: Integer? - - def resolution_unit=: (Integer) -> Integer - - attr_reader thumbnail_length: Integer? - - def thumbnail_length=: (Integer) -> Integer - - attr_reader thumbnail_offset: Integer? - - def thumbnail_offset=: (Integer) -> Integer - - attr_reader x_resolution: Integer? - - def x_resolution=: (Integer) -> Integer - - attr_reader y_resolution: Integer? - - def y_resolution=: (Integer) -> Integer - - def initialize: ( - ?compression: Integer, - ?resolution_unit: Integer, - ?thumbnail_length: Integer, - ?thumbnail_offset: Integer, - ?x_resolution: Integer, - ?y_resolution: Integer - ) -> void - - def to_hash: -> { - compression: Integer, - resolution_unit: Integer, - thumbnail_length: Integer, - thumbnail_offset: Integer, - x_resolution: Integer, - y_resolution: Integer - } - end - end - end - end - end -end diff --git a/sig/imagekit/models/metadata.rbs b/sig/imagekit/models/metadata.rbs new file mode 100644 index 00000000..789a9376 --- /dev/null +++ b/sig/imagekit/models/metadata.rbs @@ -0,0 +1,546 @@ +module Imagekit + module Models + type metadata = + { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + class Metadata < Imagekit::Internal::Type::BaseModel + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_reader density: Integer? + + def density=: (Integer) -> Integer + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader exif: Imagekit::Metadata::Exif? + + def exif=: (Imagekit::Metadata::Exif) -> Imagekit::Metadata::Exif + + attr_reader format_: String? + + def format_=: (String) -> String + + attr_reader has_color_profile: bool? + + def has_color_profile=: (bool) -> bool + + attr_reader has_transparency: bool? + + def has_transparency=: (bool) -> bool + + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader p_hash: String? + + def p_hash=: (String) -> String + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader size: Integer? + + def size=: (Integer) -> Integer + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?audio_codec: String, + ?bit_rate: Integer, + ?density: Integer, + ?duration: Integer, + ?exif: Imagekit::Metadata::Exif, + ?format_: String, + ?has_color_profile: bool, + ?has_transparency: bool, + ?height: Integer, + ?p_hash: String, + ?quality: Integer, + ?size: Integer, + ?video_codec: String, + ?width: Integer + ) -> void + + def to_hash: -> { + audio_codec: String, + bit_rate: Integer, + density: Integer, + duration: Integer, + exif: Imagekit::Metadata::Exif, + format_: String, + has_color_profile: bool, + has_transparency: bool, + height: Integer, + p_hash: String, + quality: Integer, + size: Integer, + video_codec: String, + width: Integer + } + + type exif = + { + exif: Imagekit::Metadata::Exif::Exif, + gps: Imagekit::Metadata::Exif::Gps, + image: Imagekit::Metadata::Exif::Image, + interoperability: Imagekit::Metadata::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Metadata::Exif::Thumbnail + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader exif: Imagekit::Metadata::Exif::Exif? + + def exif=: ( + Imagekit::Metadata::Exif::Exif + ) -> Imagekit::Metadata::Exif::Exif + + attr_reader gps: Imagekit::Metadata::Exif::Gps? + + def gps=: ( + Imagekit::Metadata::Exif::Gps + ) -> Imagekit::Metadata::Exif::Gps + + attr_reader image: Imagekit::Metadata::Exif::Image? + + def image=: ( + Imagekit::Metadata::Exif::Image + ) -> Imagekit::Metadata::Exif::Image + + attr_reader interoperability: Imagekit::Metadata::Exif::Interoperability? + + def interoperability=: ( + Imagekit::Metadata::Exif::Interoperability + ) -> Imagekit::Metadata::Exif::Interoperability + + attr_reader makernote: ::Hash[Symbol, top]? + + def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader thumbnail: Imagekit::Metadata::Exif::Thumbnail? + + def thumbnail=: ( + Imagekit::Metadata::Exif::Thumbnail + ) -> Imagekit::Metadata::Exif::Thumbnail + + def initialize: ( + ?exif: Imagekit::Metadata::Exif::Exif, + ?gps: Imagekit::Metadata::Exif::Gps, + ?image: Imagekit::Metadata::Exif::Image, + ?interoperability: Imagekit::Metadata::Exif::Interoperability, + ?makernote: ::Hash[Symbol, top], + ?thumbnail: Imagekit::Metadata::Exif::Thumbnail + ) -> void + + def to_hash: -> { + exif: Imagekit::Metadata::Exif::Exif, + gps: Imagekit::Metadata::Exif::Gps, + image: Imagekit::Metadata::Exif::Image, + interoperability: Imagekit::Metadata::Exif::Interoperability, + makernote: ::Hash[Symbol, top], + thumbnail: Imagekit::Metadata::Exif::Thumbnail + } + + type exif = + { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + + class Exif < Imagekit::Internal::Type::BaseModel + attr_reader aperture_value: Float? + + def aperture_value=: (Float) -> Float + + attr_reader color_space: Integer? + + def color_space=: (Integer) -> Integer + + attr_reader create_date: String? + + def create_date=: (String) -> String + + attr_reader custom_rendered: Integer? + + def custom_rendered=: (Integer) -> Integer + + attr_reader date_time_original: String? + + def date_time_original=: (String) -> String + + attr_reader exif_image_height: Integer? + + def exif_image_height=: (Integer) -> Integer + + attr_reader exif_image_width: Integer? + + def exif_image_width=: (Integer) -> Integer + + attr_reader exif_version: String? + + def exif_version=: (String) -> String + + attr_reader exposure_compensation: Float? + + def exposure_compensation=: (Float) -> Float + + attr_reader exposure_mode: Integer? + + def exposure_mode=: (Integer) -> Integer + + attr_reader exposure_program: Integer? + + def exposure_program=: (Integer) -> Integer + + attr_reader exposure_time: Float? + + def exposure_time=: (Float) -> Float + + attr_reader flash: Integer? + + def flash=: (Integer) -> Integer + + attr_reader flashpix_version: String? + + def flashpix_version=: (String) -> String + + attr_reader f_number: Float? + + def f_number=: (Float) -> Float + + attr_reader focal_length: Integer? + + def focal_length=: (Integer) -> Integer + + attr_reader focal_plane_resolution_unit: Integer? + + def focal_plane_resolution_unit=: (Integer) -> Integer + + attr_reader focal_plane_x_resolution: Float? + + def focal_plane_x_resolution=: (Float) -> Float + + attr_reader focal_plane_y_resolution: Float? + + def focal_plane_y_resolution=: (Float) -> Float + + attr_reader interop_offset: Integer? + + def interop_offset=: (Integer) -> Integer + + attr_reader iso: Integer? + + def iso=: (Integer) -> Integer + + attr_reader metering_mode: Integer? + + def metering_mode=: (Integer) -> Integer + + attr_reader scene_capture_type: Integer? + + def scene_capture_type=: (Integer) -> Integer + + attr_reader shutter_speed_value: Float? + + def shutter_speed_value=: (Float) -> Float + + attr_reader sub_sec_time: String? + + def sub_sec_time=: (String) -> String + + attr_reader white_balance: Integer? + + def white_balance=: (Integer) -> Integer + + def initialize: ( + ?aperture_value: Float, + ?color_space: Integer, + ?create_date: String, + ?custom_rendered: Integer, + ?date_time_original: String, + ?exif_image_height: Integer, + ?exif_image_width: Integer, + ?exif_version: String, + ?exposure_compensation: Float, + ?exposure_mode: Integer, + ?exposure_program: Integer, + ?exposure_time: Float, + ?flash: Integer, + ?flashpix_version: String, + ?f_number: Float, + ?focal_length: Integer, + ?focal_plane_resolution_unit: Integer, + ?focal_plane_x_resolution: Float, + ?focal_plane_y_resolution: Float, + ?interop_offset: Integer, + ?iso: Integer, + ?metering_mode: Integer, + ?scene_capture_type: Integer, + ?shutter_speed_value: Float, + ?sub_sec_time: String, + ?white_balance: Integer + ) -> void + + def to_hash: -> { + aperture_value: Float, + color_space: Integer, + create_date: String, + custom_rendered: Integer, + date_time_original: String, + exif_image_height: Integer, + exif_image_width: Integer, + exif_version: String, + exposure_compensation: Float, + exposure_mode: Integer, + exposure_program: Integer, + exposure_time: Float, + flash: Integer, + flashpix_version: String, + f_number: Float, + focal_length: Integer, + focal_plane_resolution_unit: Integer, + focal_plane_x_resolution: Float, + focal_plane_y_resolution: Float, + interop_offset: Integer, + iso: Integer, + metering_mode: Integer, + scene_capture_type: Integer, + shutter_speed_value: Float, + sub_sec_time: String, + white_balance: Integer + } + end + + type gps = { gps_version_id: ::Array[Integer] } + + class Gps < Imagekit::Internal::Type::BaseModel + attr_reader gps_version_id: ::Array[Integer]? + + def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] + + def initialize: (?gps_version_id: ::Array[Integer]) -> void + + def to_hash: -> { gps_version_id: ::Array[Integer] } + end + + type image = + { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + + class Image < Imagekit::Internal::Type::BaseModel + attr_reader exif_offset: Integer? + + def exif_offset=: (Integer) -> Integer + + attr_reader gps_info: Integer? + + def gps_info=: (Integer) -> Integer + + attr_reader make: String? + + def make=: (String) -> String + + attr_reader model: String? + + def model=: (String) -> String + + attr_reader modify_date: String? + + def modify_date=: (String) -> String + + attr_reader orientation: Integer? + + def orientation=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader software: String? + + def software=: (String) -> String + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_cb_cr_positioning: Integer? + + def y_cb_cr_positioning=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?exif_offset: Integer, + ?gps_info: Integer, + ?make: String, + ?model: String, + ?modify_date: String, + ?orientation: Integer, + ?resolution_unit: Integer, + ?software: String, + ?x_resolution: Integer, + ?y_cb_cr_positioning: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + exif_offset: Integer, + gps_info: Integer, + make: String, + model: String, + modify_date: String, + orientation: Integer, + resolution_unit: Integer, + software: String, + x_resolution: Integer, + y_cb_cr_positioning: Integer, + y_resolution: Integer + } + end + + type interoperability = + { interop_index: String, interop_version: String } + + class Interoperability < Imagekit::Internal::Type::BaseModel + attr_reader interop_index: String? + + def interop_index=: (String) -> String + + attr_reader interop_version: String? + + def interop_version=: (String) -> String + + def initialize: ( + ?interop_index: String, + ?interop_version: String + ) -> void + + def to_hash: -> { interop_index: String, interop_version: String } + end + + type thumbnail = + { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + + class Thumbnail < Imagekit::Internal::Type::BaseModel + attr_reader compression: Integer? + + def compression=: (Integer) -> Integer + + attr_reader resolution_unit: Integer? + + def resolution_unit=: (Integer) -> Integer + + attr_reader thumbnail_length: Integer? + + def thumbnail_length=: (Integer) -> Integer + + attr_reader thumbnail_offset: Integer? + + def thumbnail_offset=: (Integer) -> Integer + + attr_reader x_resolution: Integer? + + def x_resolution=: (Integer) -> Integer + + attr_reader y_resolution: Integer? + + def y_resolution=: (Integer) -> Integer + + def initialize: ( + ?compression: Integer, + ?resolution_unit: Integer, + ?thumbnail_length: Integer, + ?thumbnail_offset: Integer, + ?x_resolution: Integer, + ?y_resolution: Integer + ) -> void + + def to_hash: -> { + compression: Integer, + resolution_unit: Integer, + thumbnail_length: Integer, + thumbnail_offset: Integer, + x_resolution: Integer, + y_resolution: Integer + } + end + end + end + end +end diff --git a/sig/imagekit/resources/files/metadata.rbs b/sig/imagekit/resources/files/metadata.rbs index 7b40d2ac..4ddd61e6 100644 --- a/sig/imagekit/resources/files/metadata.rbs +++ b/sig/imagekit/resources/files/metadata.rbs @@ -5,12 +5,12 @@ module Imagekit def get: ( String file_id, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::MetadataGetResponse + ) -> Imagekit::Metadata def get_from_url: ( url: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::MetadataGetFromURLResponse + ) -> Imagekit::Metadata def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/beta/v2/files_test.rb b/test/imagekit/resources/beta/v2/files_test.rb index afc21743..f913375d 100644 --- a/test/imagekit/resources/beta/v2/files_test.rb +++ b/test/imagekit/resources/beta/v2/files_test.rb @@ -28,7 +28,7 @@ def test_upload_required_params height: Float | nil, is_private_file: Imagekit::Internal::Type::Boolean | nil, is_published: Imagekit::Internal::Type::Boolean | nil, - metadata: Imagekit::Models::Beta::V2::FileUploadResponse::Metadata | nil, + metadata: Imagekit::Metadata | nil, name: String | nil, size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, diff --git a/test/imagekit/resources/files/metadata_test.rb b/test/imagekit/resources/files/metadata_test.rb index 4bca4ea5..9a60e643 100644 --- a/test/imagekit/resources/files/metadata_test.rb +++ b/test/imagekit/resources/files/metadata_test.rb @@ -9,7 +9,7 @@ def test_get response = @image_kit.files.metadata.get("fileId") assert_pattern do - response => Imagekit::Models::Files::MetadataGetResponse + response => Imagekit::Metadata end assert_pattern do @@ -18,7 +18,7 @@ def test_get bit_rate: Integer | nil, density: Integer | nil, duration: Integer | nil, - exif: Imagekit::Models::Files::MetadataGetResponse::Exif | nil, + exif: Imagekit::Metadata::Exif | nil, format_: String | nil, has_color_profile: Imagekit::Internal::Type::Boolean | nil, has_transparency: Imagekit::Internal::Type::Boolean | nil, @@ -38,7 +38,7 @@ def test_get_from_url_required_params response = @image_kit.files.metadata.get_from_url(url: "https://example.com") assert_pattern do - response => Imagekit::Models::Files::MetadataGetFromURLResponse + response => Imagekit::Metadata end assert_pattern do @@ -47,7 +47,7 @@ def test_get_from_url_required_params bit_rate: Integer | nil, density: Integer | nil, duration: Integer | nil, - exif: Imagekit::Models::Files::MetadataGetFromURLResponse::Exif | nil, + exif: Imagekit::Metadata::Exif | nil, format_: String | nil, has_color_profile: Imagekit::Internal::Type::Boolean | nil, has_transparency: Imagekit::Internal::Type::Boolean | nil, diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index 516b6295..0036d23e 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -134,7 +134,7 @@ def test_upload_required_params height: Float | nil, is_private_file: Imagekit::Internal::Type::Boolean | nil, is_published: Imagekit::Internal::Type::Boolean | nil, - metadata: Imagekit::Models::FileUploadResponse::Metadata | nil, + metadata: Imagekit::Metadata | nil, name: String | nil, size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, From 0c8e22150c65c2039dfbb5e0e82237d5bef2394e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:23:06 +0000 Subject: [PATCH 053/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index eae87049..b0b132c4 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-547b616849eececf3f5b1ea38ebe1dba718e1877c787e3642b9c91e552548789.yml openapi_spec_hash: fba0bf8c1ee034067ab6ae93f84abeae -config_hash: 659d086a034de739b7423470b2c13ae0 +config_hash: 90f5a16140d721a24bffafbc30abaf35 From 7fa96e92b63c17dd78d7945fbccbdc44cbb7d84f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:44:47 +0000 Subject: [PATCH 054/178] feat(api): manual updates --- .stats.yml | 6 +++--- lib/imagekit.rb | 1 + lib/imagekit/models.rb | 3 +++ lib/imagekit/models/async_bulk_job_response.rb | 8 ++++++++ rbi/imagekit/models.rbi | 6 ++++++ rbi/imagekit/models/async_bulk_job_response.rbi | 8 ++++++++ sig/imagekit/models.rbs | 2 ++ sig/imagekit/models/async_bulk_job_response.rbs | 5 +++++ 8 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 lib/imagekit/models/async_bulk_job_response.rb create mode 100644 rbi/imagekit/models/async_bulk_job_response.rbi create mode 100644 sig/imagekit/models/async_bulk_job_response.rbs diff --git a/.stats.yml b/.stats.yml index b0b132c4..67dc4384 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-547b616849eececf3f5b1ea38ebe1dba718e1877c787e3642b9c91e552548789.yml -openapi_spec_hash: fba0bf8c1ee034067ab6ae93f84abeae -config_hash: 90f5a16140d721a24bffafbc30abaf35 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-ef47bed4a4585d2bdb4308a8710d748625a33548279a7b5ba04bbea0a0bbe1b8.yml +openapi_spec_hash: e64e91aa1603678f705d1ef4817f3304 +config_hash: 3e8cbbe505aa1a6dd7a72728dbf8fd4a diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 11290951..94bc4357 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -71,6 +71,7 @@ require_relative "imagekit/models/accounts/usage_get_response" require_relative "imagekit/models/asset_list_params" require_relative "imagekit/models/asset_list_response" +require_relative "imagekit/models/async_bulk_job_response" require_relative "imagekit/models/beta/v2/file_upload_params" require_relative "imagekit/models/beta/v2/file_upload_response" require_relative "imagekit/models/cache/invalidation_create_params" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 9f4e5bd6..e34498fb 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -43,6 +43,9 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams + # @type [Imagekit::Internal::Type::Converter] + AsyncBulkJobResponse = Imagekit::Models::AsyncBulkJobResponse + Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache diff --git a/lib/imagekit/models/async_bulk_job_response.rb b/lib/imagekit/models/async_bulk_job_response.rb new file mode 100644 index 00000000..bd4a4926 --- /dev/null +++ b/lib/imagekit/models/async_bulk_job_response.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @type [Imagekit::Internal::Type::Converter] + AsyncBulkJobResponse = Imagekit::Internal::Type::Unknown + end +end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 90c72e54..cff11e79 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -5,6 +5,12 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams + AsyncBulkJobResponse = + T.let( + Imagekit::Models::AsyncBulkJobResponse, + Imagekit::Internal::Type::Converter + ) + Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache diff --git a/rbi/imagekit/models/async_bulk_job_response.rbi b/rbi/imagekit/models/async_bulk_job_response.rbi new file mode 100644 index 00000000..317ae007 --- /dev/null +++ b/rbi/imagekit/models/async_bulk_job_response.rbi @@ -0,0 +1,8 @@ +# typed: strong + +module Imagekit + module Models + AsyncBulkJobResponse = + T.let(T.anything, Imagekit::Internal::Type::Converter) + end +end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 3dfdb265..3228c363 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -3,6 +3,8 @@ module Imagekit class AssetListParams = Imagekit::Models::AssetListParams + AsyncBulkJobResponse: Imagekit::Internal::Type::Converter + module Beta = Imagekit::Models::Beta module Cache = Imagekit::Models::Cache diff --git a/sig/imagekit/models/async_bulk_job_response.rbs b/sig/imagekit/models/async_bulk_job_response.rbs new file mode 100644 index 00000000..4031e905 --- /dev/null +++ b/sig/imagekit/models/async_bulk_job_response.rbs @@ -0,0 +1,5 @@ +module Imagekit + module Models + AsyncBulkJobResponse: Imagekit::Internal::Type::Converter + end +end From 907bca5f79d24f5af2e26536ad50173c57acfcd0 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:48:49 +0000 Subject: [PATCH 055/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 67dc4384..8c084b5d 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-ef47bed4a4585d2bdb4308a8710d748625a33548279a7b5ba04bbea0a0bbe1b8.yml openapi_spec_hash: e64e91aa1603678f705d1ef4817f3304 -config_hash: 3e8cbbe505aa1a6dd7a72728dbf8fd4a +config_hash: 9f3ce6ee05ee57f8d3f0330a5d18be26 From f878d34f29fe62d73c463082dfbee6eee7d5faa9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:56:42 +0000 Subject: [PATCH 056/178] feat(api): manual updates --- .stats.yml | 4 +-- lib/imagekit.rb | 3 -- lib/imagekit/models.rb | 1 - .../models/async_bulk_job_response.rb | 19 ++++++++-- lib/imagekit/models/folder_copy_response.rb | 21 ----------- lib/imagekit/models/folder_move_response.rb | 21 ----------- lib/imagekit/models/folder_rename_response.rb | 21 ----------- lib/imagekit/resources/folders.rb | 12 +++---- rbi/imagekit/models.rbi | 6 +--- .../models/async_bulk_job_response.rbi | 26 ++++++++++++-- rbi/imagekit/models/folder_copy_response.rbi | 35 ------------------- rbi/imagekit/models/folder_move_response.rbi | 35 ------------------- .../models/folder_rename_response.rbi | 35 ------------------- rbi/imagekit/resources/folders.rbi | 6 ++-- sig/imagekit/models.rbs | 2 +- .../models/async_bulk_job_response.rbs | 10 +++++- sig/imagekit/models/folder_copy_response.rbs | 15 -------- sig/imagekit/models/folder_move_response.rbs | 15 -------- .../models/folder_rename_response.rbs | 15 -------- sig/imagekit/resources/folders.rbs | 6 ++-- test/imagekit/resources/folders_test.rb | 12 +++---- 21 files changed, 72 insertions(+), 248 deletions(-) delete mode 100644 lib/imagekit/models/folder_copy_response.rb delete mode 100644 lib/imagekit/models/folder_move_response.rb delete mode 100644 lib/imagekit/models/folder_rename_response.rb delete mode 100644 rbi/imagekit/models/folder_copy_response.rbi delete mode 100644 rbi/imagekit/models/folder_move_response.rbi delete mode 100644 rbi/imagekit/models/folder_rename_response.rbi delete mode 100644 sig/imagekit/models/folder_copy_response.rbs delete mode 100644 sig/imagekit/models/folder_move_response.rbs delete mode 100644 sig/imagekit/models/folder_rename_response.rbs diff --git a/.stats.yml b/.stats.yml index 8c084b5d..a43e2d25 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-ef47bed4a4585d2bdb4308a8710d748625a33548279a7b5ba04bbea0a0bbe1b8.yml -openapi_spec_hash: e64e91aa1603678f705d1ef4817f3304 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-76121f82e0f399831eff2cf350f6f7737d8e22b996b22f5a5ca88fdf73c8a7fc.yml +openapi_spec_hash: 0913383eddc12609ad59e29d68dc6154 config_hash: 9f3ce6ee05ee57f8d3f0330a5d18be26 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 94bc4357..67b58e2a 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -115,15 +115,12 @@ require_relative "imagekit/models/file_upload_response" require_relative "imagekit/models/folder" require_relative "imagekit/models/folder_copy_params" -require_relative "imagekit/models/folder_copy_response" require_relative "imagekit/models/folder_create_params" require_relative "imagekit/models/folder_create_response" require_relative "imagekit/models/folder_delete_params" require_relative "imagekit/models/folder_delete_response" require_relative "imagekit/models/folder_move_params" -require_relative "imagekit/models/folder_move_response" require_relative "imagekit/models/folder_rename_params" -require_relative "imagekit/models/folder_rename_response" require_relative "imagekit/models/folders/job_get_params" require_relative "imagekit/models/folders/job_get_response" require_relative "imagekit/models/metadata" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index e34498fb..f70ace63 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -43,7 +43,6 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams - # @type [Imagekit::Internal::Type::Converter] AsyncBulkJobResponse = Imagekit::Models::AsyncBulkJobResponse Beta = Imagekit::Models::Beta diff --git a/lib/imagekit/models/async_bulk_job_response.rb b/lib/imagekit/models/async_bulk_job_response.rb index bd4a4926..43252209 100644 --- a/lib/imagekit/models/async_bulk_job_response.rb +++ b/lib/imagekit/models/async_bulk_job_response.rb @@ -2,7 +2,22 @@ module Imagekit module Models - # @type [Imagekit::Internal::Type::Converter] - AsyncBulkJobResponse = Imagekit::Internal::Type::Unknown + # @see Imagekit::Resources::Folders#copy + class AsyncBulkJobResponse < Imagekit::Internal::Type::BaseModel + # @!attribute job_id + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + # + # @return [String] + required :job_id, String, api_name: :jobId + + # @!method initialize(job_id:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::AsyncBulkJobResponse} for more details. + # + # Job submitted successfully. A `jobId` will be returned. + # + # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b + end end end diff --git a/lib/imagekit/models/folder_copy_response.rb b/lib/imagekit/models/folder_copy_response.rb deleted file mode 100644 index 62978384..00000000 --- a/lib/imagekit/models/folder_copy_response.rb +++ /dev/null @@ -1,21 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Folders#copy - class FolderCopyResponse < Imagekit::Internal::Type::BaseModel - # @!attribute job_id - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - # - # @return [String, nil] - optional :job_id, String, api_name: :jobId - - # @!method initialize(job_id: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderCopyResponse} for more details. - # - # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b - end - end -end diff --git a/lib/imagekit/models/folder_move_response.rb b/lib/imagekit/models/folder_move_response.rb deleted file mode 100644 index 46451324..00000000 --- a/lib/imagekit/models/folder_move_response.rb +++ /dev/null @@ -1,21 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Folders#move - class FolderMoveResponse < Imagekit::Internal::Type::BaseModel - # @!attribute job_id - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - # - # @return [String, nil] - optional :job_id, String, api_name: :jobId - - # @!method initialize(job_id: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderMoveResponse} for more details. - # - # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b - end - end -end diff --git a/lib/imagekit/models/folder_rename_response.rb b/lib/imagekit/models/folder_rename_response.rb deleted file mode 100644 index aeee24a8..00000000 --- a/lib/imagekit/models/folder_rename_response.rb +++ /dev/null @@ -1,21 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Folders#rename - class FolderRenameResponse < Imagekit::Internal::Type::BaseModel - # @!attribute job_id - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - # - # @return [String, nil] - optional :job_id, String, api_name: :jobId - - # @!method initialize(job_id: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderRenameResponse} for more details. - # - # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b - end - end -end diff --git a/lib/imagekit/resources/folders.rb b/lib/imagekit/resources/folders.rb index ad5e4b10..150ac563 100644 --- a/lib/imagekit/resources/folders.rb +++ b/lib/imagekit/resources/folders.rb @@ -79,7 +79,7 @@ def delete(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FolderCopyResponse] + # @return [Imagekit::Models::AsyncBulkJobResponse] # # @see Imagekit::Models::FolderCopyParams def copy(params) @@ -88,7 +88,7 @@ def copy(params) method: :post, path: "v1/bulkJobs/copyFolder", body: parsed, - model: Imagekit::Models::FolderCopyResponse, + model: Imagekit::AsyncBulkJobResponse, options: options ) end @@ -109,7 +109,7 @@ def copy(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FolderMoveResponse] + # @return [Imagekit::Models::AsyncBulkJobResponse] # # @see Imagekit::Models::FolderMoveParams def move(params) @@ -118,7 +118,7 @@ def move(params) method: :post, path: "v1/bulkJobs/moveFolder", body: parsed, - model: Imagekit::Models::FolderMoveResponse, + model: Imagekit::AsyncBulkJobResponse, options: options ) end @@ -140,7 +140,7 @@ def move(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FolderRenameResponse] + # @return [Imagekit::Models::AsyncBulkJobResponse] # # @see Imagekit::Models::FolderRenameParams def rename(params) @@ -149,7 +149,7 @@ def rename(params) method: :post, path: "v1/bulkJobs/renameFolder", body: parsed, - model: Imagekit::Models::FolderRenameResponse, + model: Imagekit::AsyncBulkJobResponse, options: options ) end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index cff11e79..17528530 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -5,11 +5,7 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams - AsyncBulkJobResponse = - T.let( - Imagekit::Models::AsyncBulkJobResponse, - Imagekit::Internal::Type::Converter - ) + AsyncBulkJobResponse = Imagekit::Models::AsyncBulkJobResponse Beta = Imagekit::Models::Beta diff --git a/rbi/imagekit/models/async_bulk_job_response.rbi b/rbi/imagekit/models/async_bulk_job_response.rbi index 317ae007..f7d1c472 100644 --- a/rbi/imagekit/models/async_bulk_job_response.rbi +++ b/rbi/imagekit/models/async_bulk_job_response.rbi @@ -2,7 +2,29 @@ module Imagekit module Models - AsyncBulkJobResponse = - T.let(T.anything, Imagekit::Internal::Type::Converter) + class AsyncBulkJobResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::AsyncBulkJobResponse, Imagekit::Internal::AnyHash) + end + + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + sig { returns(String) } + attr_accessor :job_id + + # Job submitted successfully. A `jobId` will be returned. + sig { params(job_id: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + job_id: + ) + end + + sig { override.returns({ job_id: String }) } + def to_hash + end + end end end diff --git a/rbi/imagekit/models/folder_copy_response.rbi b/rbi/imagekit/models/folder_copy_response.rbi deleted file mode 100644 index 71c01b2d..00000000 --- a/rbi/imagekit/models/folder_copy_response.rbi +++ /dev/null @@ -1,35 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FolderCopyResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FolderCopyResponse, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - sig { returns(T.nilable(String)) } - attr_reader :job_id - - sig { params(job_id: String).void } - attr_writer :job_id - - sig { params(job_id: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - job_id: nil - ) - end - - sig { override.returns({ job_id: String }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/folder_move_response.rbi b/rbi/imagekit/models/folder_move_response.rbi deleted file mode 100644 index a28a2310..00000000 --- a/rbi/imagekit/models/folder_move_response.rbi +++ /dev/null @@ -1,35 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FolderMoveResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FolderMoveResponse, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - sig { returns(T.nilable(String)) } - attr_reader :job_id - - sig { params(job_id: String).void } - attr_writer :job_id - - sig { params(job_id: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - job_id: nil - ) - end - - sig { override.returns({ job_id: String }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/folder_rename_response.rbi b/rbi/imagekit/models/folder_rename_response.rbi deleted file mode 100644 index fd47a6a3..00000000 --- a/rbi/imagekit/models/folder_rename_response.rbi +++ /dev/null @@ -1,35 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FolderRenameResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Models::FolderRenameResponse, - Imagekit::Internal::AnyHash - ) - end - - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - sig { returns(T.nilable(String)) } - attr_reader :job_id - - sig { params(job_id: String).void } - attr_writer :job_id - - sig { params(job_id: String).returns(T.attached_class) } - def self.new( - # Unique identifier of the bulk job. This can be used to check the status of the - # bulk job. - job_id: nil - ) - end - - sig { override.returns({ job_id: String }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/resources/folders.rbi b/rbi/imagekit/resources/folders.rbi index 3fd9afd7..8a213276 100644 --- a/rbi/imagekit/resources/folders.rbi +++ b/rbi/imagekit/resources/folders.rbi @@ -60,7 +60,7 @@ module Imagekit source_folder_path: String, include_versions: T::Boolean, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FolderCopyResponse) + ).returns(Imagekit::AsyncBulkJobResponse) end def copy( # Full path to the destination folder where you want to copy the source folder @@ -85,7 +85,7 @@ module Imagekit destination_path: String, source_folder_path: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FolderMoveResponse) + ).returns(Imagekit::AsyncBulkJobResponse) end def move( # Full path to the destination folder where you want to move the source folder @@ -106,7 +106,7 @@ module Imagekit new_folder_name: String, purge_cache: T::Boolean, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FolderRenameResponse) + ).returns(Imagekit::AsyncBulkJobResponse) end def rename( # The full path to the folder you want to rename. diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 3228c363..d5f40857 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -3,7 +3,7 @@ module Imagekit class AssetListParams = Imagekit::Models::AssetListParams - AsyncBulkJobResponse: Imagekit::Internal::Type::Converter + class AsyncBulkJobResponse = Imagekit::Models::AsyncBulkJobResponse module Beta = Imagekit::Models::Beta diff --git a/sig/imagekit/models/async_bulk_job_response.rbs b/sig/imagekit/models/async_bulk_job_response.rbs index 4031e905..aa4c9148 100644 --- a/sig/imagekit/models/async_bulk_job_response.rbs +++ b/sig/imagekit/models/async_bulk_job_response.rbs @@ -1,5 +1,13 @@ module Imagekit module Models - AsyncBulkJobResponse: Imagekit::Internal::Type::Converter + type async_bulk_job_response = { job_id: String } + + class AsyncBulkJobResponse < Imagekit::Internal::Type::BaseModel + attr_accessor job_id: String + + def initialize: (job_id: String) -> void + + def to_hash: -> { job_id: String } + end end end diff --git a/sig/imagekit/models/folder_copy_response.rbs b/sig/imagekit/models/folder_copy_response.rbs deleted file mode 100644 index 764eaaec..00000000 --- a/sig/imagekit/models/folder_copy_response.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type folder_copy_response = { job_id: String } - - class FolderCopyResponse < Imagekit::Internal::Type::BaseModel - attr_reader job_id: String? - - def job_id=: (String) -> String - - def initialize: (?job_id: String) -> void - - def to_hash: -> { job_id: String } - end - end -end diff --git a/sig/imagekit/models/folder_move_response.rbs b/sig/imagekit/models/folder_move_response.rbs deleted file mode 100644 index 5ed07b1c..00000000 --- a/sig/imagekit/models/folder_move_response.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type folder_move_response = { job_id: String } - - class FolderMoveResponse < Imagekit::Internal::Type::BaseModel - attr_reader job_id: String? - - def job_id=: (String) -> String - - def initialize: (?job_id: String) -> void - - def to_hash: -> { job_id: String } - end - end -end diff --git a/sig/imagekit/models/folder_rename_response.rbs b/sig/imagekit/models/folder_rename_response.rbs deleted file mode 100644 index 11edeed4..00000000 --- a/sig/imagekit/models/folder_rename_response.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type folder_rename_response = { job_id: String } - - class FolderRenameResponse < Imagekit::Internal::Type::BaseModel - attr_reader job_id: String? - - def job_id=: (String) -> String - - def initialize: (?job_id: String) -> void - - def to_hash: -> { job_id: String } - end - end -end diff --git a/sig/imagekit/resources/folders.rbs b/sig/imagekit/resources/folders.rbs index f5990d9b..aafcdc75 100644 --- a/sig/imagekit/resources/folders.rbs +++ b/sig/imagekit/resources/folders.rbs @@ -19,20 +19,20 @@ module Imagekit source_folder_path: String, ?include_versions: bool, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FolderCopyResponse + ) -> Imagekit::AsyncBulkJobResponse def move: ( destination_path: String, source_folder_path: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FolderMoveResponse + ) -> Imagekit::AsyncBulkJobResponse def rename: ( folder_path: String, new_folder_name: String, ?purge_cache: bool, ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FolderRenameResponse + ) -> Imagekit::AsyncBulkJobResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/folders_test.rb b/test/imagekit/resources/folders_test.rb index 1130e813..09609132 100644 --- a/test/imagekit/resources/folders_test.rb +++ b/test/imagekit/resources/folders_test.rb @@ -45,12 +45,12 @@ def test_copy_required_params ) assert_pattern do - response => Imagekit::Models::FolderCopyResponse + response => Imagekit::AsyncBulkJobResponse end assert_pattern do response => { - job_id: String | nil + job_id: String } end end @@ -65,12 +65,12 @@ def test_move_required_params ) assert_pattern do - response => Imagekit::Models::FolderMoveResponse + response => Imagekit::AsyncBulkJobResponse end assert_pattern do response => { - job_id: String | nil + job_id: String } end end @@ -81,12 +81,12 @@ def test_rename_required_params response = @image_kit.folders.rename(folder_path: "/path/of/folder", new_folder_name: "new-folder-name") assert_pattern do - response => Imagekit::Models::FolderRenameResponse + response => Imagekit::AsyncBulkJobResponse end assert_pattern do response => { - job_id: String | nil + job_id: String } end end From 2093e32f08f4e0cabe3b31c86850172672d7fc7b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 06:58:26 +0000 Subject: [PATCH 057/178] feat(api): manual updates --- .stats.yml | 6 +++--- lib/imagekit.rb | 2 +- lib/imagekit/models.rb | 4 ++-- .../{async_bulk_job_response.rb => job_response.rb} | 4 ++-- lib/imagekit/resources/folders.rb | 12 ++++++------ rbi/imagekit/models.rbi | 4 ++-- ...{async_bulk_job_response.rbi => job_response.rbi} | 4 ++-- rbi/imagekit/resources/folders.rbi | 6 +++--- sig/imagekit/models.rbs | 4 ++-- ...{async_bulk_job_response.rbs => job_response.rbs} | 4 ++-- sig/imagekit/resources/folders.rbs | 6 +++--- test/imagekit/resources/folders_test.rb | 6 +++--- 12 files changed, 31 insertions(+), 31 deletions(-) rename lib/imagekit/models/{async_bulk_job_response.rb => job_response.rb} (82%) rename rbi/imagekit/models/{async_bulk_job_response.rbi => job_response.rbi} (81%) rename sig/imagekit/models/{async_bulk_job_response.rbs => job_response.rbs} (58%) diff --git a/.stats.yml b/.stats.yml index a43e2d25..8cb350c9 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-76121f82e0f399831eff2cf350f6f7737d8e22b996b22f5a5ca88fdf73c8a7fc.yml -openapi_spec_hash: 0913383eddc12609ad59e29d68dc6154 -config_hash: 9f3ce6ee05ee57f8d3f0330a5d18be26 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-6fee8f335061dc7a308b9a2712dce5a1c16c81125f71e00dba3e4759a39d7bf0.yml +openapi_spec_hash: 205e083e0ab6b49d5bc8a2e5b323610b +config_hash: f7c2f1f50b841dabc54904c2e05f21c5 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 67b58e2a..23ebb709 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -71,7 +71,6 @@ require_relative "imagekit/models/accounts/usage_get_response" require_relative "imagekit/models/asset_list_params" require_relative "imagekit/models/asset_list_response" -require_relative "imagekit/models/async_bulk_job_response" require_relative "imagekit/models/beta/v2/file_upload_params" require_relative "imagekit/models/beta/v2/file_upload_response" require_relative "imagekit/models/cache/invalidation_create_params" @@ -123,6 +122,7 @@ require_relative "imagekit/models/folder_rename_params" require_relative "imagekit/models/folders/job_get_params" require_relative "imagekit/models/folders/job_get_response" +require_relative "imagekit/models/job_response" require_relative "imagekit/models/metadata" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index f70ace63..1f7f1c9a 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -43,8 +43,6 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams - AsyncBulkJobResponse = Imagekit::Models::AsyncBulkJobResponse - Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache @@ -91,6 +89,8 @@ module Imagekit Folders = Imagekit::Models::Folders + JobResponse = Imagekit::Models::JobResponse + Metadata = Imagekit::Models::Metadata UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent diff --git a/lib/imagekit/models/async_bulk_job_response.rb b/lib/imagekit/models/job_response.rb similarity index 82% rename from lib/imagekit/models/async_bulk_job_response.rb rename to lib/imagekit/models/job_response.rb index 43252209..aafde16e 100644 --- a/lib/imagekit/models/async_bulk_job_response.rb +++ b/lib/imagekit/models/job_response.rb @@ -3,7 +3,7 @@ module Imagekit module Models # @see Imagekit::Resources::Folders#copy - class AsyncBulkJobResponse < Imagekit::Internal::Type::BaseModel + class JobResponse < Imagekit::Internal::Type::BaseModel # @!attribute job_id # Unique identifier of the bulk job. This can be used to check the status of the # bulk job. @@ -13,7 +13,7 @@ class AsyncBulkJobResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(job_id:) # Some parameter documentations has been truncated, see - # {Imagekit::Models::AsyncBulkJobResponse} for more details. + # {Imagekit::Models::JobResponse} for more details. # # Job submitted successfully. A `jobId` will be returned. # diff --git a/lib/imagekit/resources/folders.rb b/lib/imagekit/resources/folders.rb index 150ac563..2ebb717c 100644 --- a/lib/imagekit/resources/folders.rb +++ b/lib/imagekit/resources/folders.rb @@ -79,7 +79,7 @@ def delete(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::AsyncBulkJobResponse] + # @return [Imagekit::Models::JobResponse] # # @see Imagekit::Models::FolderCopyParams def copy(params) @@ -88,7 +88,7 @@ def copy(params) method: :post, path: "v1/bulkJobs/copyFolder", body: parsed, - model: Imagekit::AsyncBulkJobResponse, + model: Imagekit::JobResponse, options: options ) end @@ -109,7 +109,7 @@ def copy(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::AsyncBulkJobResponse] + # @return [Imagekit::Models::JobResponse] # # @see Imagekit::Models::FolderMoveParams def move(params) @@ -118,7 +118,7 @@ def move(params) method: :post, path: "v1/bulkJobs/moveFolder", body: parsed, - model: Imagekit::AsyncBulkJobResponse, + model: Imagekit::JobResponse, options: options ) end @@ -140,7 +140,7 @@ def move(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::AsyncBulkJobResponse] + # @return [Imagekit::Models::JobResponse] # # @see Imagekit::Models::FolderRenameParams def rename(params) @@ -149,7 +149,7 @@ def rename(params) method: :post, path: "v1/bulkJobs/renameFolder", body: parsed, - model: Imagekit::AsyncBulkJobResponse, + model: Imagekit::JobResponse, options: options ) end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 17528530..9cf9dab8 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -5,8 +5,6 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams - AsyncBulkJobResponse = Imagekit::Models::AsyncBulkJobResponse - Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache @@ -57,6 +55,8 @@ module Imagekit Folders = Imagekit::Models::Folders + JobResponse = Imagekit::Models::JobResponse + Metadata = Imagekit::Models::Metadata UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent diff --git a/rbi/imagekit/models/async_bulk_job_response.rbi b/rbi/imagekit/models/job_response.rbi similarity index 81% rename from rbi/imagekit/models/async_bulk_job_response.rbi rename to rbi/imagekit/models/job_response.rbi index f7d1c472..a84872f8 100644 --- a/rbi/imagekit/models/async_bulk_job_response.rbi +++ b/rbi/imagekit/models/job_response.rbi @@ -2,10 +2,10 @@ module Imagekit module Models - class AsyncBulkJobResponse < Imagekit::Internal::Type::BaseModel + class JobResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::AsyncBulkJobResponse, Imagekit::Internal::AnyHash) + T.any(Imagekit::JobResponse, Imagekit::Internal::AnyHash) end # Unique identifier of the bulk job. This can be used to check the status of the diff --git a/rbi/imagekit/resources/folders.rbi b/rbi/imagekit/resources/folders.rbi index 8a213276..5b1398f7 100644 --- a/rbi/imagekit/resources/folders.rbi +++ b/rbi/imagekit/resources/folders.rbi @@ -60,7 +60,7 @@ module Imagekit source_folder_path: String, include_versions: T::Boolean, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::AsyncBulkJobResponse) + ).returns(Imagekit::JobResponse) end def copy( # Full path to the destination folder where you want to copy the source folder @@ -85,7 +85,7 @@ module Imagekit destination_path: String, source_folder_path: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::AsyncBulkJobResponse) + ).returns(Imagekit::JobResponse) end def move( # Full path to the destination folder where you want to move the source folder @@ -106,7 +106,7 @@ module Imagekit new_folder_name: String, purge_cache: T::Boolean, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::AsyncBulkJobResponse) + ).returns(Imagekit::JobResponse) end def rename( # The full path to the folder you want to rename. diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index d5f40857..5f3d54fc 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -3,8 +3,6 @@ module Imagekit class AssetListParams = Imagekit::Models::AssetListParams - class AsyncBulkJobResponse = Imagekit::Models::AsyncBulkJobResponse - module Beta = Imagekit::Models::Beta module Cache = Imagekit::Models::Cache @@ -51,6 +49,8 @@ module Imagekit module Folders = Imagekit::Models::Folders + class JobResponse = Imagekit::Models::JobResponse + class Metadata = Imagekit::Models::Metadata module UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent diff --git a/sig/imagekit/models/async_bulk_job_response.rbs b/sig/imagekit/models/job_response.rbs similarity index 58% rename from sig/imagekit/models/async_bulk_job_response.rbs rename to sig/imagekit/models/job_response.rbs index aa4c9148..49eda6db 100644 --- a/sig/imagekit/models/async_bulk_job_response.rbs +++ b/sig/imagekit/models/job_response.rbs @@ -1,8 +1,8 @@ module Imagekit module Models - type async_bulk_job_response = { job_id: String } + type job_response = { job_id: String } - class AsyncBulkJobResponse < Imagekit::Internal::Type::BaseModel + class JobResponse < Imagekit::Internal::Type::BaseModel attr_accessor job_id: String def initialize: (job_id: String) -> void diff --git a/sig/imagekit/resources/folders.rbs b/sig/imagekit/resources/folders.rbs index aafcdc75..0624f560 100644 --- a/sig/imagekit/resources/folders.rbs +++ b/sig/imagekit/resources/folders.rbs @@ -19,20 +19,20 @@ module Imagekit source_folder_path: String, ?include_versions: bool, ?request_options: Imagekit::request_opts - ) -> Imagekit::AsyncBulkJobResponse + ) -> Imagekit::JobResponse def move: ( destination_path: String, source_folder_path: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::AsyncBulkJobResponse + ) -> Imagekit::JobResponse def rename: ( folder_path: String, new_folder_name: String, ?purge_cache: bool, ?request_options: Imagekit::request_opts - ) -> Imagekit::AsyncBulkJobResponse + ) -> Imagekit::JobResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/folders_test.rb b/test/imagekit/resources/folders_test.rb index 09609132..6a38c461 100644 --- a/test/imagekit/resources/folders_test.rb +++ b/test/imagekit/resources/folders_test.rb @@ -45,7 +45,7 @@ def test_copy_required_params ) assert_pattern do - response => Imagekit::AsyncBulkJobResponse + response => Imagekit::JobResponse end assert_pattern do @@ -65,7 +65,7 @@ def test_move_required_params ) assert_pattern do - response => Imagekit::AsyncBulkJobResponse + response => Imagekit::JobResponse end assert_pattern do @@ -81,7 +81,7 @@ def test_rename_required_params response = @image_kit.folders.rename(folder_path: "/path/of/folder", new_folder_name: "new-folder-name") assert_pattern do - response => Imagekit::AsyncBulkJobResponse + response => Imagekit::JobResponse end assert_pattern do From 9c42a068727f42ce2a1baa0c7cc50a47573072c4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 07:03:22 +0000 Subject: [PATCH 058/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 4 ++- lib/imagekit/models.rb | 2 -- ...ob_response.rb => folder_copy_response.rb} | 4 +-- lib/imagekit/models/folder_move_response.rb | 23 +++++++++++++ lib/imagekit/models/folder_rename_response.rb | 23 +++++++++++++ lib/imagekit/resources/folders.rb | 12 +++---- rbi/imagekit/models.rbi | 2 -- ..._response.rbi => folder_copy_response.rbi} | 7 ++-- rbi/imagekit/models/folder_move_response.rbi | 33 +++++++++++++++++++ .../models/folder_rename_response.rbi | 33 +++++++++++++++++++ rbi/imagekit/resources/folders.rbi | 6 ++-- sig/imagekit/models.rbs | 2 -- ..._response.rbs => folder_copy_response.rbs} | 4 +-- sig/imagekit/models/folder_move_response.rbs | 13 ++++++++ .../models/folder_rename_response.rbs | 13 ++++++++ sig/imagekit/resources/folders.rbs | 6 ++-- test/imagekit/resources/folders_test.rb | 6 ++-- 18 files changed, 166 insertions(+), 29 deletions(-) rename lib/imagekit/models/{job_response.rb => folder_copy_response.rb} (82%) create mode 100644 lib/imagekit/models/folder_move_response.rb create mode 100644 lib/imagekit/models/folder_rename_response.rb rename rbi/imagekit/models/{job_response.rbi => folder_copy_response.rbi} (77%) create mode 100644 rbi/imagekit/models/folder_move_response.rbi create mode 100644 rbi/imagekit/models/folder_rename_response.rbi rename sig/imagekit/models/{job_response.rbs => folder_copy_response.rbs} (59%) create mode 100644 sig/imagekit/models/folder_move_response.rbs create mode 100644 sig/imagekit/models/folder_rename_response.rbs diff --git a/.stats.yml b/.stats.yml index 8cb350c9..f16eca03 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-6fee8f335061dc7a308b9a2712dce5a1c16c81125f71e00dba3e4759a39d7bf0.yml openapi_spec_hash: 205e083e0ab6b49d5bc8a2e5b323610b -config_hash: f7c2f1f50b841dabc54904c2e05f21c5 +config_hash: 90f5a16140d721a24bffafbc30abaf35 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 23ebb709..11290951 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -114,15 +114,17 @@ require_relative "imagekit/models/file_upload_response" require_relative "imagekit/models/folder" require_relative "imagekit/models/folder_copy_params" +require_relative "imagekit/models/folder_copy_response" require_relative "imagekit/models/folder_create_params" require_relative "imagekit/models/folder_create_response" require_relative "imagekit/models/folder_delete_params" require_relative "imagekit/models/folder_delete_response" require_relative "imagekit/models/folder_move_params" +require_relative "imagekit/models/folder_move_response" require_relative "imagekit/models/folder_rename_params" +require_relative "imagekit/models/folder_rename_response" require_relative "imagekit/models/folders/job_get_params" require_relative "imagekit/models/folders/job_get_response" -require_relative "imagekit/models/job_response" require_relative "imagekit/models/metadata" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 1f7f1c9a..9f4e5bd6 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -89,8 +89,6 @@ module Imagekit Folders = Imagekit::Models::Folders - JobResponse = Imagekit::Models::JobResponse - Metadata = Imagekit::Models::Metadata UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent diff --git a/lib/imagekit/models/job_response.rb b/lib/imagekit/models/folder_copy_response.rb similarity index 82% rename from lib/imagekit/models/job_response.rb rename to lib/imagekit/models/folder_copy_response.rb index aafde16e..a9deadc1 100644 --- a/lib/imagekit/models/job_response.rb +++ b/lib/imagekit/models/folder_copy_response.rb @@ -3,7 +3,7 @@ module Imagekit module Models # @see Imagekit::Resources::Folders#copy - class JobResponse < Imagekit::Internal::Type::BaseModel + class FolderCopyResponse < Imagekit::Internal::Type::BaseModel # @!attribute job_id # Unique identifier of the bulk job. This can be used to check the status of the # bulk job. @@ -13,7 +13,7 @@ class JobResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(job_id:) # Some parameter documentations has been truncated, see - # {Imagekit::Models::JobResponse} for more details. + # {Imagekit::Models::FolderCopyResponse} for more details. # # Job submitted successfully. A `jobId` will be returned. # diff --git a/lib/imagekit/models/folder_move_response.rb b/lib/imagekit/models/folder_move_response.rb new file mode 100644 index 00000000..8fa4b3ef --- /dev/null +++ b/lib/imagekit/models/folder_move_response.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Folders#move + class FolderMoveResponse < Imagekit::Internal::Type::BaseModel + # @!attribute job_id + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + # + # @return [String] + required :job_id, String, api_name: :jobId + + # @!method initialize(job_id:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderMoveResponse} for more details. + # + # Job submitted successfully. A `jobId` will be returned. + # + # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b + end + end +end diff --git a/lib/imagekit/models/folder_rename_response.rb b/lib/imagekit/models/folder_rename_response.rb new file mode 100644 index 00000000..0ac8984b --- /dev/null +++ b/lib/imagekit/models/folder_rename_response.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # @see Imagekit::Resources::Folders#rename + class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + # @!attribute job_id + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + # + # @return [String] + required :job_id, String, api_name: :jobId + + # @!method initialize(job_id:) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FolderRenameResponse} for more details. + # + # Job submitted successfully. A `jobId` will be returned. + # + # @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b + end + end +end diff --git a/lib/imagekit/resources/folders.rb b/lib/imagekit/resources/folders.rb index 2ebb717c..ad5e4b10 100644 --- a/lib/imagekit/resources/folders.rb +++ b/lib/imagekit/resources/folders.rb @@ -79,7 +79,7 @@ def delete(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::JobResponse] + # @return [Imagekit::Models::FolderCopyResponse] # # @see Imagekit::Models::FolderCopyParams def copy(params) @@ -88,7 +88,7 @@ def copy(params) method: :post, path: "v1/bulkJobs/copyFolder", body: parsed, - model: Imagekit::JobResponse, + model: Imagekit::Models::FolderCopyResponse, options: options ) end @@ -109,7 +109,7 @@ def copy(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::JobResponse] + # @return [Imagekit::Models::FolderMoveResponse] # # @see Imagekit::Models::FolderMoveParams def move(params) @@ -118,7 +118,7 @@ def move(params) method: :post, path: "v1/bulkJobs/moveFolder", body: parsed, - model: Imagekit::JobResponse, + model: Imagekit::Models::FolderMoveResponse, options: options ) end @@ -140,7 +140,7 @@ def move(params) # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::JobResponse] + # @return [Imagekit::Models::FolderRenameResponse] # # @see Imagekit::Models::FolderRenameParams def rename(params) @@ -149,7 +149,7 @@ def rename(params) method: :post, path: "v1/bulkJobs/renameFolder", body: parsed, - model: Imagekit::JobResponse, + model: Imagekit::Models::FolderRenameResponse, options: options ) end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 9cf9dab8..90c72e54 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -55,8 +55,6 @@ module Imagekit Folders = Imagekit::Models::Folders - JobResponse = Imagekit::Models::JobResponse - Metadata = Imagekit::Models::Metadata UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent diff --git a/rbi/imagekit/models/job_response.rbi b/rbi/imagekit/models/folder_copy_response.rbi similarity index 77% rename from rbi/imagekit/models/job_response.rbi rename to rbi/imagekit/models/folder_copy_response.rbi index a84872f8..f294ad91 100644 --- a/rbi/imagekit/models/job_response.rbi +++ b/rbi/imagekit/models/folder_copy_response.rbi @@ -2,10 +2,13 @@ module Imagekit module Models - class JobResponse < Imagekit::Internal::Type::BaseModel + class FolderCopyResponse < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::JobResponse, Imagekit::Internal::AnyHash) + T.any( + Imagekit::Models::FolderCopyResponse, + Imagekit::Internal::AnyHash + ) end # Unique identifier of the bulk job. This can be used to check the status of the diff --git a/rbi/imagekit/models/folder_move_response.rbi b/rbi/imagekit/models/folder_move_response.rbi new file mode 100644 index 00000000..e19ca456 --- /dev/null +++ b/rbi/imagekit/models/folder_move_response.rbi @@ -0,0 +1,33 @@ +# typed: strong + +module Imagekit + module Models + class FolderMoveResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FolderMoveResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + sig { returns(String) } + attr_accessor :job_id + + # Job submitted successfully. A `jobId` will be returned. + sig { params(job_id: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + job_id: + ) + end + + sig { override.returns({ job_id: String }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/folder_rename_response.rbi b/rbi/imagekit/models/folder_rename_response.rbi new file mode 100644 index 00000000..5fad09f4 --- /dev/null +++ b/rbi/imagekit/models/folder_rename_response.rbi @@ -0,0 +1,33 @@ +# typed: strong + +module Imagekit + module Models + class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FolderRenameResponse, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + sig { returns(String) } + attr_accessor :job_id + + # Job submitted successfully. A `jobId` will be returned. + sig { params(job_id: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the bulk job. This can be used to check the status of the + # bulk job. + job_id: + ) + end + + sig { override.returns({ job_id: String }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/resources/folders.rbi b/rbi/imagekit/resources/folders.rbi index 5b1398f7..3fd9afd7 100644 --- a/rbi/imagekit/resources/folders.rbi +++ b/rbi/imagekit/resources/folders.rbi @@ -60,7 +60,7 @@ module Imagekit source_folder_path: String, include_versions: T::Boolean, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::JobResponse) + ).returns(Imagekit::Models::FolderCopyResponse) end def copy( # Full path to the destination folder where you want to copy the source folder @@ -85,7 +85,7 @@ module Imagekit destination_path: String, source_folder_path: String, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::JobResponse) + ).returns(Imagekit::Models::FolderMoveResponse) end def move( # Full path to the destination folder where you want to move the source folder @@ -106,7 +106,7 @@ module Imagekit new_folder_name: String, purge_cache: T::Boolean, request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::JobResponse) + ).returns(Imagekit::Models::FolderRenameResponse) end def rename( # The full path to the folder you want to rename. diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 5f3d54fc..3dfdb265 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -49,8 +49,6 @@ module Imagekit module Folders = Imagekit::Models::Folders - class JobResponse = Imagekit::Models::JobResponse - class Metadata = Imagekit::Models::Metadata module UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent diff --git a/sig/imagekit/models/job_response.rbs b/sig/imagekit/models/folder_copy_response.rbs similarity index 59% rename from sig/imagekit/models/job_response.rbs rename to sig/imagekit/models/folder_copy_response.rbs index 49eda6db..3baef44d 100644 --- a/sig/imagekit/models/job_response.rbs +++ b/sig/imagekit/models/folder_copy_response.rbs @@ -1,8 +1,8 @@ module Imagekit module Models - type job_response = { job_id: String } + type folder_copy_response = { job_id: String } - class JobResponse < Imagekit::Internal::Type::BaseModel + class FolderCopyResponse < Imagekit::Internal::Type::BaseModel attr_accessor job_id: String def initialize: (job_id: String) -> void diff --git a/sig/imagekit/models/folder_move_response.rbs b/sig/imagekit/models/folder_move_response.rbs new file mode 100644 index 00000000..dd788a3e --- /dev/null +++ b/sig/imagekit/models/folder_move_response.rbs @@ -0,0 +1,13 @@ +module Imagekit + module Models + type folder_move_response = { job_id: String } + + class FolderMoveResponse < Imagekit::Internal::Type::BaseModel + attr_accessor job_id: String + + def initialize: (job_id: String) -> void + + def to_hash: -> { job_id: String } + end + end +end diff --git a/sig/imagekit/models/folder_rename_response.rbs b/sig/imagekit/models/folder_rename_response.rbs new file mode 100644 index 00000000..8b24b6dd --- /dev/null +++ b/sig/imagekit/models/folder_rename_response.rbs @@ -0,0 +1,13 @@ +module Imagekit + module Models + type folder_rename_response = { job_id: String } + + class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + attr_accessor job_id: String + + def initialize: (job_id: String) -> void + + def to_hash: -> { job_id: String } + end + end +end diff --git a/sig/imagekit/resources/folders.rbs b/sig/imagekit/resources/folders.rbs index 0624f560..f5990d9b 100644 --- a/sig/imagekit/resources/folders.rbs +++ b/sig/imagekit/resources/folders.rbs @@ -19,20 +19,20 @@ module Imagekit source_folder_path: String, ?include_versions: bool, ?request_options: Imagekit::request_opts - ) -> Imagekit::JobResponse + ) -> Imagekit::Models::FolderCopyResponse def move: ( destination_path: String, source_folder_path: String, ?request_options: Imagekit::request_opts - ) -> Imagekit::JobResponse + ) -> Imagekit::Models::FolderMoveResponse def rename: ( folder_path: String, new_folder_name: String, ?purge_cache: bool, ?request_options: Imagekit::request_opts - ) -> Imagekit::JobResponse + ) -> Imagekit::Models::FolderRenameResponse def initialize: (client: Imagekit::Client) -> void end diff --git a/test/imagekit/resources/folders_test.rb b/test/imagekit/resources/folders_test.rb index 6a38c461..4e5e4e43 100644 --- a/test/imagekit/resources/folders_test.rb +++ b/test/imagekit/resources/folders_test.rb @@ -45,7 +45,7 @@ def test_copy_required_params ) assert_pattern do - response => Imagekit::JobResponse + response => Imagekit::Models::FolderCopyResponse end assert_pattern do @@ -65,7 +65,7 @@ def test_move_required_params ) assert_pattern do - response => Imagekit::JobResponse + response => Imagekit::Models::FolderMoveResponse end assert_pattern do @@ -81,7 +81,7 @@ def test_rename_required_params response = @image_kit.folders.rename(folder_path: "/path/of/folder", new_folder_name: "new-folder-name") assert_pattern do - response => Imagekit::JobResponse + response => Imagekit::Models::FolderRenameResponse end assert_pattern do From 9b98ee39f5a1b5133a20f5404bca6d580ac20725 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 07:10:08 +0000 Subject: [PATCH 059/178] feat(api): manual updates --- .stats.yml | 4 +- .../models/folders/job_get_response.rb | 44 +++++-- .../models/folders/job_get_response.rbi | 117 +++++++++++++++--- .../models/folders/job_get_response.rbs | 47 +++++-- test/imagekit/resources/folders/job_test.rb | 4 +- 5 files changed, 179 insertions(+), 37 deletions(-) diff --git a/.stats.yml b/.stats.yml index f16eca03..5d95bc69 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-6fee8f335061dc7a308b9a2712dce5a1c16c81125f71e00dba3e4759a39d7bf0.yml -openapi_spec_hash: 205e083e0ab6b49d5bc8a2e5b323610b +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-e9ae4f96eddf09567444c458e190ab6f96d0f1e1aa594793466c78791330ffde.yml +openapi_spec_hash: 88836566c32f51ff2bf66404e8b8f40e config_hash: 90f5a16140d721a24bffafbc30abaf35 diff --git a/lib/imagekit/models/folders/job_get_response.rb b/lib/imagekit/models/folders/job_get_response.rb index 833fa36c..efd0d528 100644 --- a/lib/imagekit/models/folders/job_get_response.rb +++ b/lib/imagekit/models/folders/job_get_response.rb @@ -19,17 +19,16 @@ class JobGetResponse < Imagekit::Internal::Type::BaseModel optional :purge_request_id, String, api_name: :purgeRequestId # @!attribute status - # Status of the bulk job. Possible values - `Pending`, `Completed`. + # Status of the bulk job. # - # @return [String, nil] - optional :status, String + # @return [Symbol, Imagekit::Models::Folders::JobGetResponse::Status, nil] + optional :status, enum: -> { Imagekit::Models::Folders::JobGetResponse::Status } # @!attribute type - # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`, - # `RENAME_FOLDER`. + # Type of the bulk job. # - # @return [String, nil] - optional :type, String + # @return [Symbol, Imagekit::Models::Folders::JobGetResponse::Type, nil] + optional :type, enum: -> { Imagekit::Models::Folders::JobGetResponse::Type } # @!method initialize(job_id: nil, purge_request_id: nil, status: nil, type: nil) # Some parameter documentations has been truncated, see @@ -39,9 +38,36 @@ class JobGetResponse < Imagekit::Internal::Type::BaseModel # # @param purge_request_id [String] Unique identifier of the purge request. This will be present only if `purgeCache # - # @param status [String] Status of the bulk job. Possible values - `Pending`, `Completed`. + # @param status [Symbol, Imagekit::Models::Folders::JobGetResponse::Status] Status of the bulk job. + # + # @param type [Symbol, Imagekit::Models::Folders::JobGetResponse::Type] Type of the bulk job. + + # Status of the bulk job. + # + # @see Imagekit::Models::Folders::JobGetResponse#status + module Status + extend Imagekit::Internal::Type::Enum + + PENDING = :Pending + COMPLETED = :Completed + + # @!method self.values + # @return [Array] + end + + # Type of the bulk job. # - # @param type [String] Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`, `RENAME_FO + # @see Imagekit::Models::Folders::JobGetResponse#type + module Type + extend Imagekit::Internal::Type::Enum + + COPY_FOLDER = :COPY_FOLDER + MOVE_FOLDER = :MOVE_FOLDER + RENAME_FOLDER = :RENAME_FOLDER + + # @!method self.values + # @return [Array] + end end end end diff --git a/rbi/imagekit/models/folders/job_get_response.rbi b/rbi/imagekit/models/folders/job_get_response.rbi index 506b7482..518392e0 100644 --- a/rbi/imagekit/models/folders/job_get_response.rbi +++ b/rbi/imagekit/models/folders/job_get_response.rbi @@ -27,27 +27,46 @@ module Imagekit sig { params(purge_request_id: String).void } attr_writer :purge_request_id - # Status of the bulk job. Possible values - `Pending`, `Completed`. - sig { returns(T.nilable(String)) } + # Status of the bulk job. + sig do + returns( + T.nilable( + Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol + ) + ) + end attr_reader :status - sig { params(status: String).void } + sig do + params( + status: Imagekit::Models::Folders::JobGetResponse::Status::OrSymbol + ).void + end attr_writer :status - # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`, - # `RENAME_FOLDER`. - sig { returns(T.nilable(String)) } + # Type of the bulk job. + sig do + returns( + T.nilable( + Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: Imagekit::Models::Folders::JobGetResponse::Type::OrSymbol + ).void + end attr_writer :type sig do params( job_id: String, purge_request_id: String, - status: String, - type: String + status: Imagekit::Models::Folders::JobGetResponse::Status::OrSymbol, + type: Imagekit::Models::Folders::JobGetResponse::Type::OrSymbol ).returns(T.attached_class) end def self.new( @@ -56,10 +75,9 @@ module Imagekit # Unique identifier of the purge request. This will be present only if # `purgeCache` is set to `true` in the rename folder API request. purge_request_id: nil, - # Status of the bulk job. Possible values - `Pending`, `Completed`. + # Status of the bulk job. status: nil, - # Type of the bulk job. Possible values - `COPY_FOLDER`, `MOVE_FOLDER`, - # `RENAME_FOLDER`. + # Type of the bulk job. type: nil ) end @@ -69,13 +87,84 @@ module Imagekit { job_id: String, purge_request_id: String, - status: String, - type: String + status: + Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol, + type: + Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol } ) end def to_hash end + + # Status of the bulk job. + module Status + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Models::Folders::JobGetResponse::Status) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PENDING = + T.let( + :Pending, + Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol + ) + COMPLETED = + T.let( + :Completed, + Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Type of the bulk job. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::Models::Folders::JobGetResponse::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + COPY_FOLDER = + T.let( + :COPY_FOLDER, + Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + ) + MOVE_FOLDER = + T.let( + :MOVE_FOLDER, + Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + ) + RENAME_FOLDER = + T.let( + :RENAME_FOLDER, + Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end end end diff --git a/sig/imagekit/models/folders/job_get_response.rbs b/sig/imagekit/models/folders/job_get_response.rbs index 247c4fb2..dcda6269 100644 --- a/sig/imagekit/models/folders/job_get_response.rbs +++ b/sig/imagekit/models/folders/job_get_response.rbs @@ -5,8 +5,8 @@ module Imagekit { job_id: String, purge_request_id: String, - status: String, - type: String + status: Imagekit::Models::Folders::JobGetResponse::status, + type: Imagekit::Models::Folders::JobGetResponse::type_ } class JobGetResponse < Imagekit::Internal::Type::BaseModel @@ -18,27 +18,54 @@ module Imagekit def purge_request_id=: (String) -> String - attr_reader status: String? + attr_reader status: Imagekit::Models::Folders::JobGetResponse::status? - def status=: (String) -> String + def status=: ( + Imagekit::Models::Folders::JobGetResponse::status + ) -> Imagekit::Models::Folders::JobGetResponse::status - attr_reader type: String? + attr_reader type: Imagekit::Models::Folders::JobGetResponse::type_? - def type=: (String) -> String + def type=: ( + Imagekit::Models::Folders::JobGetResponse::type_ + ) -> Imagekit::Models::Folders::JobGetResponse::type_ def initialize: ( ?job_id: String, ?purge_request_id: String, - ?status: String, - ?type: String + ?status: Imagekit::Models::Folders::JobGetResponse::status, + ?type: Imagekit::Models::Folders::JobGetResponse::type_ ) -> void def to_hash: -> { job_id: String, purge_request_id: String, - status: String, - type: String + status: Imagekit::Models::Folders::JobGetResponse::status, + type: Imagekit::Models::Folders::JobGetResponse::type_ } + + type status = :Pending | :Completed + + module Status + extend Imagekit::Internal::Type::Enum + + PENDING: :Pending + COMPLETED: :Completed + + def self?.values: -> ::Array[Imagekit::Models::Folders::JobGetResponse::status] + end + + type type_ = :COPY_FOLDER | :MOVE_FOLDER | :RENAME_FOLDER + + module Type + extend Imagekit::Internal::Type::Enum + + COPY_FOLDER: :COPY_FOLDER + MOVE_FOLDER: :MOVE_FOLDER + RENAME_FOLDER: :RENAME_FOLDER + + def self?.values: -> ::Array[Imagekit::Models::Folders::JobGetResponse::type_] + end end end end diff --git a/test/imagekit/resources/folders/job_test.rb b/test/imagekit/resources/folders/job_test.rb index 07b576d0..6521e30e 100644 --- a/test/imagekit/resources/folders/job_test.rb +++ b/test/imagekit/resources/folders/job_test.rb @@ -16,8 +16,8 @@ def test_get response => { job_id: String | nil, purge_request_id: String | nil, - status: String | nil, - type: String | nil + status: Imagekit::Models::Folders::JobGetResponse::Status | nil, + type: Imagekit::Models::Folders::JobGetResponse::Type | nil } end end From 47a8f328c14678ad8453b3b7b0c89fe60fe245f3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 07:15:33 +0000 Subject: [PATCH 060/178] feat(api): manual updates --- .stats.yml | 4 ++-- lib/imagekit/models/beta/v2/file_upload_response.rb | 11 ++++++++++- lib/imagekit/models/file.rb | 11 ++++++++++- lib/imagekit/models/file_upload_response.rb | 11 ++++++++++- .../models/beta/v2/file_upload_response.rbi | 13 +++++++++++++ rbi/imagekit/models/file.rbi | 13 +++++++++++++ rbi/imagekit/models/file_upload_response.rbi | 13 +++++++++++++ .../models/beta/v2/file_upload_response.rbs | 7 +++++++ sig/imagekit/models/file.rbs | 7 +++++++ sig/imagekit/models/file_upload_response.rbs | 7 +++++++ test/imagekit/resources/beta/v2/files_test.rb | 1 + test/imagekit/resources/files/versions_test.rb | 2 ++ test/imagekit/resources/files_test.rb | 2 ++ 13 files changed, 97 insertions(+), 5 deletions(-) diff --git a/.stats.yml b/.stats.yml index 5d95bc69..7fff3c20 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-e9ae4f96eddf09567444c458e190ab6f96d0f1e1aa594793466c78791330ffde.yml -openapi_spec_hash: 88836566c32f51ff2bf66404e8b8f40e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-64e7f6a89ec59f5801a735655ff564f48bab5be2c4d8c1146a27cdab70538945.yml +openapi_spec_hash: 581fefcb95712f716fa46f84469e6655 config_hash: 90f5a16140d721a24bffafbc30abaf35 diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekit/models/beta/v2/file_upload_response.rb index 88afd8bd..5d90c5b0 100644 --- a/lib/imagekit/models/beta/v2/file_upload_response.rb +++ b/lib/imagekit/models/beta/v2/file_upload_response.rb @@ -48,6 +48,13 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], api_name: :customMetadata + # @!attribute description + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + # + # @return [String, nil] + optional :description, String + # @!attribute duration # The duration of the video in seconds (only for video). # @@ -181,7 +188,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @return [Float, nil] optional :width, Float - # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see # {Imagekit::Models::Beta::V2::FileUploadResponse} for more details. # @@ -197,6 +204,8 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param custom_metadata [Hash{Symbol=>Object}] A key-value data associated with the asset. Use `responseField` in API request t # + # @param description [String] Optional text to describe the contents of the file. Can be set by the user or th + # # @param duration [Integer] The duration of the video in seconds (only for video). # # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, diff --git a/lib/imagekit/models/file.rb b/lib/imagekit/models/file.rb index 9da1c0d8..d1c2aacb 100644 --- a/lib/imagekit/models/file.rb +++ b/lib/imagekit/models/file.rb @@ -34,6 +34,13 @@ class File < Imagekit::Internal::Type::BaseModel Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], api_name: :customMetadata + # @!attribute description + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + # + # @return [String, nil] + optional :description, String + # @!attribute file_id # Unique identifier of the asset. # @@ -142,7 +149,7 @@ class File < Imagekit::Internal::Type::BaseModel # @return [Float, nil] optional :width, Float - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) # Some parameter documentations has been truncated, see {Imagekit::Models::File} # for more details. # @@ -156,6 +163,8 @@ class File < Imagekit::Internal::Type::BaseModel # # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the file. # + # @param description [String] Optional text to describe the contents of the file. Can be set by the user or th + # # @param file_id [String] Unique identifier of the asset. # # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekit/models/file_upload_response.rb index 639d6257..2d9c67ec 100644 --- a/lib/imagekit/models/file_upload_response.rb +++ b/lib/imagekit/models/file_upload_response.rb @@ -46,6 +46,13 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], api_name: :customMetadata + # @!attribute description + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + # + # @return [String, nil] + optional :description, String + # @!attribute duration # The duration of the video in seconds (only for video). # @@ -177,7 +184,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @return [Float, nil] optional :width, Float - # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadResponse} for more details. # @@ -193,6 +200,8 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param custom_metadata [Hash{Symbol=>Object}] A key-value data associated with the asset. Use `responseField` in API request t # + # @param description [String] Optional text to describe the contents of the file. Can be set by the user or th + # # @param duration [Integer] The duration of the video in seconds (only for video). # # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekit/models/beta/v2/file_upload_response.rbi index 612189b3..d2c558c3 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_response.rbi @@ -55,6 +55,14 @@ module Imagekit sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + # The duration of the video in seconds (only for video). sig { returns(T.nilable(Integer)) } attr_reader :duration @@ -232,6 +240,7 @@ module Imagekit bit_rate: Integer, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], + description: String, duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: @@ -272,6 +281,9 @@ module Imagekit # API. Send `customMetadata` in `responseFields` in API request to get the value # of this field. custom_metadata: nil, + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + description: nil, # The duration of the video in seconds (only for video). duration: nil, # Consolidated embedded metadata associated with the file. It includes exif, iptc, @@ -343,6 +355,7 @@ module Imagekit bit_rate: Integer, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], + description: String, duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: diff --git a/rbi/imagekit/models/file.rbi b/rbi/imagekit/models/file.rbi index 1da2de0f..4d68e344 100644 --- a/rbi/imagekit/models/file.rbi +++ b/rbi/imagekit/models/file.rbi @@ -29,6 +29,14 @@ module Imagekit sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + # Unique identifier of the asset. sig { returns(T.nilable(String)) } attr_reader :file_id @@ -158,6 +166,7 @@ module Imagekit created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], + description: String, file_id: String, file_path: String, file_type: String, @@ -187,6 +196,9 @@ module Imagekit custom_coordinates: nil, # An object with custom metadata for the file. custom_metadata: nil, + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + description: nil, # Unique identifier of the asset. file_id: nil, # Path of the file. This is the path you would use in the URL to access the file. @@ -237,6 +249,7 @@ module Imagekit created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], + description: String, file_id: String, file_path: String, file_type: String, diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekit/models/file_upload_response.rbi index 1b6e4d93..e71a13fc 100644 --- a/rbi/imagekit/models/file_upload_response.rbi +++ b/rbi/imagekit/models/file_upload_response.rbi @@ -51,6 +51,14 @@ module Imagekit sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } attr_writer :custom_metadata + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + # The duration of the video in seconds (only for video). sig { returns(T.nilable(Integer)) } attr_reader :duration @@ -220,6 +228,7 @@ module Imagekit bit_rate: Integer, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], + description: String, duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: @@ -260,6 +269,9 @@ module Imagekit # API. Send `customMetadata` in `responseFields` in API request to get the value # of this field. custom_metadata: nil, + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + description: nil, # The duration of the video in seconds (only for video). duration: nil, # Consolidated embedded metadata associated with the file. It includes exif, iptc, @@ -327,6 +339,7 @@ module Imagekit bit_rate: Integer, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], + description: String, duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs index b55e39df..1e41ee42 100644 --- a/sig/imagekit/models/beta/v2/file_upload_response.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_response.rbs @@ -9,6 +9,7 @@ module Imagekit bit_rate: Integer, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], + description: String, duration: Integer, embedded_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, @@ -46,6 +47,10 @@ module Imagekit def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader description: String? + + def description=: (String) -> String + attr_reader duration: Integer? def duration=: (Integer) -> Integer @@ -126,6 +131,7 @@ module Imagekit ?bit_rate: Integer, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], + ?description: String, ?duration: Integer, ?embedded_metadata: ::Hash[Symbol, top], ?extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, @@ -152,6 +158,7 @@ module Imagekit bit_rate: Integer, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], + description: String, duration: Integer, embedded_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, diff --git a/sig/imagekit/models/file.rbs b/sig/imagekit/models/file.rbs index 87cb4946..9331ad13 100644 --- a/sig/imagekit/models/file.rbs +++ b/sig/imagekit/models/file.rbs @@ -6,6 +6,7 @@ module Imagekit created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], + description: String, file_id: String, file_path: String, file_type: String, @@ -38,6 +39,10 @@ module Imagekit def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader description: String? + + def description=: (String) -> String + attr_reader file_id: String? def file_id=: (String) -> String @@ -113,6 +118,7 @@ module Imagekit ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], + ?description: String, ?file_id: String, ?file_path: String, ?file_type: String, @@ -137,6 +143,7 @@ module Imagekit created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], + description: String, file_id: String, file_path: String, file_type: String, diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs index b3629b61..5d6d5bc2 100644 --- a/sig/imagekit/models/file_upload_response.rbs +++ b/sig/imagekit/models/file_upload_response.rbs @@ -7,6 +7,7 @@ module Imagekit bit_rate: Integer, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], + description: String, duration: Integer, embedded_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, @@ -44,6 +45,10 @@ module Imagekit def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader description: String? + + def description=: (String) -> String + attr_reader duration: Integer? def duration=: (Integer) -> Integer @@ -124,6 +129,7 @@ module Imagekit ?bit_rate: Integer, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], + ?description: String, ?duration: Integer, ?embedded_metadata: ::Hash[Symbol, top], ?extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, @@ -150,6 +156,7 @@ module Imagekit bit_rate: Integer, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], + description: String, duration: Integer, embedded_metadata: ::Hash[Symbol, top], extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, diff --git a/test/imagekit/resources/beta/v2/files_test.rb b/test/imagekit/resources/beta/v2/files_test.rb index f913375d..c664cb10 100644 --- a/test/imagekit/resources/beta/v2/files_test.rb +++ b/test/imagekit/resources/beta/v2/files_test.rb @@ -19,6 +19,7 @@ def test_upload_required_params bit_rate: Integer | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + description: String | nil, duration: Integer | nil, embedded_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus | nil, diff --git a/test/imagekit/resources/files/versions_test.rb b/test/imagekit/resources/files/versions_test.rb index 75c233be..cb25fb21 100644 --- a/test/imagekit/resources/files/versions_test.rb +++ b/test/imagekit/resources/files/versions_test.rb @@ -44,6 +44,7 @@ def test_get_required_params created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + description: String | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, @@ -80,6 +81,7 @@ def test_restore_required_params created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + description: String | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index 0036d23e..c09eb4bb 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -55,6 +55,7 @@ def test_get created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + description: String | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, @@ -125,6 +126,7 @@ def test_upload_required_params bit_rate: Integer | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + description: String | nil, duration: Integer | nil, embedded_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus | nil, From 39129a9f78ce3effc45df7b7fb2aefe8fa3c9b5a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 07:21:14 +0000 Subject: [PATCH 061/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 7fff3c20..b8f03deb 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-64e7f6a89ec59f5801a735655ff564f48bab5be2c4d8c1146a27cdab70538945.yml -openapi_spec_hash: 581fefcb95712f716fa46f84469e6655 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-53f7c35748f9b41bb07f888796c7417ea84e5e63ab0e9e2aa4a8d64e48713b24.yml +openapi_spec_hash: 098ce74bcff31c61870e3d0ce357814b config_hash: 90f5a16140d721a24bffafbc30abaf35 From f5abbc48c0af450d88da780c7eca02993cf5b7d9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 07:26:34 +0000 Subject: [PATCH 062/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit/internal/type/base_model.rb | 10 +++++----- lib/imagekit/models/file.rb | 1 - test/imagekit/resources/shared_test.rb | 6 ++++++ 4 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 test/imagekit/resources/shared_test.rb diff --git a/.stats.yml b/.stats.yml index b8f03deb..cb0d8e12 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-53f7c35748f9b41bb07f888796c7417ea84e5e63ab0e9e2aa4a8d64e48713b24.yml openapi_spec_hash: 098ce74bcff31c61870e3d0ce357814b -config_hash: 90f5a16140d721a24bffafbc30abaf35 +config_hash: b8c48b915f11a452e84fafc0e851a772 diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb index 33ab960f..13828650 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekit/internal/type/base_model.rb @@ -438,11 +438,11 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `custom_metadata_field` is a `Imagekit::CustomMetadataField` - # custom_metadata_field => { - # id: id, - # label: label, - # name: name + # # `file` is a `Imagekit::File` + # file => { + # ai_tags: ai_tags, + # created_at: created_at, + # custom_coordinates: custom_coordinates # } def deconstruct_keys(keys) (keys || self.class.known_fields.keys) diff --git a/lib/imagekit/models/file.rb b/lib/imagekit/models/file.rb index d1c2aacb..72cfa4f4 100644 --- a/lib/imagekit/models/file.rb +++ b/lib/imagekit/models/file.rb @@ -2,7 +2,6 @@ module Imagekit module Models - # @see Imagekit::Resources::Files#get class File < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. diff --git a/test/imagekit/resources/shared_test.rb b/test/imagekit/resources/shared_test.rb new file mode 100644 index 00000000..be22f0e4 --- /dev/null +++ b/test/imagekit/resources/shared_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::SharedTest < Imagekit::Test::ResourceTest +end From 98b78eed4c3b75343904909d20b9e4cdc3ba1040 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 07:33:02 +0000 Subject: [PATCH 063/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit/internal/type/base_model.rb | 10 +++++----- lib/imagekit/models/file.rb | 1 + test/imagekit/resources/shared_test.rb | 6 ------ 4 files changed, 7 insertions(+), 12 deletions(-) delete mode 100644 test/imagekit/resources/shared_test.rb diff --git a/.stats.yml b/.stats.yml index cb0d8e12..b8f03deb 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-53f7c35748f9b41bb07f888796c7417ea84e5e63ab0e9e2aa4a8d64e48713b24.yml openapi_spec_hash: 098ce74bcff31c61870e3d0ce357814b -config_hash: b8c48b915f11a452e84fafc0e851a772 +config_hash: 90f5a16140d721a24bffafbc30abaf35 diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb index 13828650..33ab960f 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekit/internal/type/base_model.rb @@ -438,11 +438,11 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `file` is a `Imagekit::File` - # file => { - # ai_tags: ai_tags, - # created_at: created_at, - # custom_coordinates: custom_coordinates + # # `custom_metadata_field` is a `Imagekit::CustomMetadataField` + # custom_metadata_field => { + # id: id, + # label: label, + # name: name # } def deconstruct_keys(keys) (keys || self.class.known_fields.keys) diff --git a/lib/imagekit/models/file.rb b/lib/imagekit/models/file.rb index 72cfa4f4..d1c2aacb 100644 --- a/lib/imagekit/models/file.rb +++ b/lib/imagekit/models/file.rb @@ -2,6 +2,7 @@ module Imagekit module Models + # @see Imagekit::Resources::Files#get class File < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. diff --git a/test/imagekit/resources/shared_test.rb b/test/imagekit/resources/shared_test.rb deleted file mode 100644 index be22f0e4..00000000 --- a/test/imagekit/resources/shared_test.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::Resources::SharedTest < Imagekit::Test::ResourceTest -end From 016ff51e711f864d4c4fcd59ebf07f8bc596f16f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 07:49:02 +0000 Subject: [PATCH 064/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index b8f03deb..82cd02a9 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-53f7c35748f9b41bb07f888796c7417ea84e5e63ab0e9e2aa4a8d64e48713b24.yml -openapi_spec_hash: 098ce74bcff31c61870e3d0ce357814b +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-e798e75f763868cfd2babe250a0d880a651b19f9e1b9a3b567d629eea9893147.yml +openapi_spec_hash: 45341845beb1363b7dcb4050934b9cf0 config_hash: 90f5a16140d721a24bffafbc30abaf35 From 2997526a53273eb1552c6ba51648dc593ce09805 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 26 Aug 2025 12:24:13 +0000 Subject: [PATCH 065/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 82cd02a9..2feea331 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-e798e75f763868cfd2babe250a0d880a651b19f9e1b9a3b567d629eea9893147.yml openapi_spec_hash: 45341845beb1363b7dcb4050934b9cf0 -config_hash: 90f5a16140d721a24bffafbc30abaf35 +config_hash: d1c62fed14fedf6774ac70983dc71d68 From 968631653e753b9a2a34fdccbf453c71e98a47f2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 27 Aug 2025 14:56:49 +0000 Subject: [PATCH 066/178] feat(api): add models back to Webhooks --- .stats.yml | 2 +- lib/imagekit.rb | 9 +- lib/imagekit/models.rb | 6 +- .../models/unsafe_unwrap_webhook_event.rb | 8 +- lib/imagekit/models/unwrap_webhook_event.rb | 8 +- ...=> video_transformation_accepted_event.rb} | 82 ++++---- ...rb => video_transformation_error_event.rb} | 98 +++++----- ...rb => video_transformation_ready_event.rb} | 106 +++++----- lib/imagekit/resources/webhooks.rb | 4 +- rbi/imagekit/models.rbi | 12 +- .../models/unsafe_unwrap_webhook_event.rbi | 6 +- rbi/imagekit/models/unwrap_webhook_event.rbi | 6 +- ...> video_transformation_accepted_event.rbi} | 149 +++++++------- ...i => video_transformation_error_event.rbi} | 177 ++++++++--------- ...i => video_transformation_ready_event.rbi} | 185 ++++++++---------- rbi/imagekit/resources/webhooks.rbi | 12 +- sig/imagekit/models.rbs | 6 +- .../models/unsafe_unwrap_webhook_event.rbs | 6 +- sig/imagekit/models/unwrap_webhook_event.rbs | 6 +- ...> video_transformation_accepted_event.rbs} | 114 +++++------ ...s => video_transformation_error_event.rbs} | 136 ++++++------- ...s => video_transformation_ready_event.rbs} | 150 +++++++------- sig/imagekit/resources/webhooks.rbs | 12 +- 23 files changed, 631 insertions(+), 669 deletions(-) rename lib/imagekit/models/{video_transformation_accepted_webhook_event.rb => video_transformation_accepted_event.rb} (74%) rename lib/imagekit/models/{video_transformation_error_webhook_event.rb => video_transformation_error_event.rb} (68%) rename lib/imagekit/models/{video_transformation_ready_webhook_event.rb => video_transformation_ready_event.rb} (70%) rename rbi/imagekit/models/{video_transformation_accepted_webhook_event.rbi => video_transformation_accepted_event.rbi} (60%) rename rbi/imagekit/models/{video_transformation_error_webhook_event.rbi => video_transformation_error_event.rbi} (60%) rename rbi/imagekit/models/{video_transformation_ready_webhook_event.rbi => video_transformation_ready_event.rbi} (63%) rename sig/imagekit/models/{video_transformation_accepted_webhook_event.rbs => video_transformation_accepted_event.rbs} (55%) rename sig/imagekit/models/{video_transformation_error_webhook_event.rbs => video_transformation_error_event.rbs} (54%) rename sig/imagekit/models/{video_transformation_ready_webhook_event.rbs => video_transformation_ready_event.rbs} (56%) diff --git a/.stats.yml b/.stats.yml index 2feea331..aa083b75 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-e798e75f763868cfd2babe250a0d880a651b19f9e1b9a3b567d629eea9893147.yml openapi_spec_hash: 45341845beb1363b7dcb4050934b9cf0 -config_hash: d1c62fed14fedf6774ac70983dc71d68 +config_hash: 128de0925828937e2ae36770e7f6029a diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 11290951..fca54b76 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -128,12 +128,9 @@ require_relative "imagekit/models/metadata" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" -require_relative "imagekit/models/video_transformation_accepted_webhook_event" -require_relative "imagekit/models/video_transformation_accepted_webhook_event" -require_relative "imagekit/models/video_transformation_error_webhook_event" -require_relative "imagekit/models/video_transformation_error_webhook_event" -require_relative "imagekit/models/video_transformation_ready_webhook_event" -require_relative "imagekit/models/video_transformation_ready_webhook_event" +require_relative "imagekit/models/video_transformation_accepted_event" +require_relative "imagekit/models/video_transformation_error_event" +require_relative "imagekit/models/video_transformation_ready_event" require_relative "imagekit/models/webhook_unsafe_unwrap_params" require_relative "imagekit/models/webhook_unwrap_params" require_relative "imagekit/models" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 9f4e5bd6..e5d19dc3 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -95,11 +95,11 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent + VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent - VideoTransformationErrorWebhookEvent = Imagekit::Models::VideoTransformationErrorWebhookEvent + VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent - VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + VideoTransformationReadyEvent = Imagekit::Models::VideoTransformationReadyEvent WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb index 5b7cab93..c86439e5 100644 --- a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb @@ -5,14 +5,14 @@ module Models module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union - variant -> { Imagekit::VideoTransformationAcceptedWebhookEvent } + variant -> { Imagekit::VideoTransformationAcceptedEvent } - variant -> { Imagekit::VideoTransformationReadyWebhookEvent } + variant -> { Imagekit::VideoTransformationReadyEvent } - variant -> { Imagekit::VideoTransformationErrorWebhookEvent } + variant -> { Imagekit::VideoTransformationErrorEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent)] end end end diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb index be01dd2a..1a570019 100644 --- a/lib/imagekit/models/unwrap_webhook_event.rb +++ b/lib/imagekit/models/unwrap_webhook_event.rb @@ -5,14 +5,14 @@ module Models module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union - variant -> { Imagekit::VideoTransformationAcceptedWebhookEvent } + variant -> { Imagekit::VideoTransformationAcceptedEvent } - variant -> { Imagekit::VideoTransformationReadyWebhookEvent } + variant -> { Imagekit::VideoTransformationReadyEvent } - variant -> { Imagekit::VideoTransformationErrorWebhookEvent } + variant -> { Imagekit::VideoTransformationErrorEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent)] end end end diff --git a/lib/imagekit/models/video_transformation_accepted_webhook_event.rb b/lib/imagekit/models/video_transformation_accepted_event.rb similarity index 74% rename from lib/imagekit/models/video_transformation_accepted_webhook_event.rb rename to lib/imagekit/models/video_transformation_accepted_event.rb index 4b238162..fc8eaec5 100644 --- a/lib/imagekit/models/video_transformation_accepted_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_accepted_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseMo # @!attribute data # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data] - required :data, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data] + required :data, -> { Imagekit::VideoTransformationAcceptedEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] - required :request, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Request } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Request] + required :request, -> { Imagekit::VideoTransformationAcceptedEvent::Request } # @!attribute type # @@ -34,29 +34,29 @@ class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseMo # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data] + # @param data [Imagekit::Models::VideoTransformationAcceptedEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] + # @param request [Imagekit::Models::VideoTransformationAcceptedEvent::Request] # # @param type [Symbol, :"video.transformation.accepted"] - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#data + # @see Imagekit::Models::VideoTransformationAcceptedEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data#asset + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -68,23 +68,23 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } # @!method initialize(type:, options: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type] - # @param options [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options] + # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] + # @param options [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options] - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -96,13 +96,13 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -111,10 +111,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format }, api_name: :format @@ -125,9 +125,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -136,20 +136,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -160,7 +160,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -174,7 +174,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -185,7 +185,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -199,7 +199,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#request + # @see Imagekit::Models::VideoTransformationAcceptedEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. diff --git a/lib/imagekit/models/video_transformation_error_webhook_event.rb b/lib/imagekit/models/video_transformation_error_event.rb similarity index 68% rename from lib/imagekit/models/video_transformation_error_webhook_event.rb rename to lib/imagekit/models/video_transformation_error_event.rb index c639c0a7..5b199f18 100644 --- a/lib/imagekit/models/video_transformation_error_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_error_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data] - required :data, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data] + required :data, -> { Imagekit::VideoTransformationErrorEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] - required :request, -> { Imagekit::VideoTransformationErrorWebhookEvent::Request } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Request] + required :request, -> { Imagekit::VideoTransformationErrorEvent::Request } # @!attribute type # @@ -34,29 +34,29 @@ class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data] + # @param data [Imagekit::Models::VideoTransformationErrorEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] + # @param request [Imagekit::Models::VideoTransformationErrorEvent::Request] # # @param type [Symbol, :"video.transformation.error"] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#data + # @see Imagekit::Models::VideoTransformationErrorEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationErrorEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data#asset + # @see Imagekit::Models::VideoTransformationErrorEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -68,29 +68,29 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationErrorEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type } # @!attribute error # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, nil] - optional :error, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error, nil] + optional :error, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } # @!method initialize(type:, error: nil, options: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Type] - # @param error [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error] - # @param options [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options] + # @param type [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] + # @param error [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error] + # @param options [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -102,18 +102,18 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#error + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#error class Error < Imagekit::Internal::Type::BaseModel # @!attribute reason # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] required :reason, - enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason } + enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason } # @!method initialize(reason:) - # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason] + # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error#reason + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error#reason module Reason extend Imagekit::Internal::Type::Enum @@ -126,13 +126,13 @@ module Reason end end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -141,10 +141,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format }, api_name: :format @@ -155,9 +155,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -166,20 +166,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -190,7 +190,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -204,7 +204,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -215,7 +215,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -229,7 +229,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#request + # @see Imagekit::Models::VideoTransformationErrorEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. diff --git a/lib/imagekit/models/video_transformation_ready_webhook_event.rb b/lib/imagekit/models/video_transformation_ready_event.rb similarity index 70% rename from lib/imagekit/models/video_transformation_ready_webhook_event.rb rename to lib/imagekit/models/video_transformation_ready_event.rb index 812ea710..5e6d463b 100644 --- a/lib/imagekit/models/video_transformation_ready_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_ready_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data] - required :data, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data] + required :data, -> { Imagekit::VideoTransformationReadyEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] - required :request, -> { Imagekit::VideoTransformationReadyWebhookEvent::Request } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Request] + required :request, -> { Imagekit::VideoTransformationReadyEvent::Request } # @!attribute type # @@ -31,39 +31,39 @@ class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute timings # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings, nil] - optional :timings, -> { Imagekit::VideoTransformationReadyWebhookEvent::Timings } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Timings, nil] + optional :timings, -> { Imagekit::VideoTransformationReadyEvent::Timings } # @!method initialize(id:, created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") # @param id [String] Unique identifier for the event. # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data] + # @param data [Imagekit::Models::VideoTransformationReadyEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] + # @param request [Imagekit::Models::VideoTransformationReadyEvent::Request] # - # @param timings [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings] + # @param timings [Imagekit::Models::VideoTransformationReadyEvent::Timings] # # @param type [Symbol, :"video.transformation.ready"] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#data + # @see Imagekit::Models::VideoTransformationReadyEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationReadyEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data#asset + # @see Imagekit::Models::VideoTransformationReadyEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -75,29 +75,29 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationReadyEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options } # @!attribute output # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output, nil] - optional :output, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output, nil] + optional :output, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } # @!method initialize(type:, options: nil, output: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Type] - # @param options [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options] - # @param output [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output] + # @param type [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] + # @param options [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options] + # @param output [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -109,13 +109,13 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -124,10 +124,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format }, api_name: :format @@ -138,9 +138,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -149,20 +149,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -173,7 +173,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -187,7 +187,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -198,7 +198,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -210,7 +210,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#output + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#output class Output < Imagekit::Internal::Type::BaseModel # @!attribute url # @@ -219,15 +219,15 @@ class Output < Imagekit::Internal::Type::BaseModel # @!attribute video_metadata # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata, nil] + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, nil] optional :video_metadata, - -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata } + -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } # @!method initialize(url:, video_metadata: nil) # @param url [String] - # @param video_metadata [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata] + # @param video_metadata [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output#video_metadata + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output#video_metadata class VideoMetadata < Imagekit::Internal::Type::BaseModel # @!attribute bitrate # @@ -259,7 +259,7 @@ class VideoMetadata < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#request + # @see Imagekit::Models::VideoTransformationReadyEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. @@ -287,7 +287,7 @@ class Request < Imagekit::Internal::Type::BaseModel # @param user_agent [String] User-Agent header of the originating request. end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#timings + # @see Imagekit::Models::VideoTransformationReadyEvent#timings class Timings < Imagekit::Internal::Type::BaseModel # @!attribute download_duration # Milliseconds spent downloading the source. diff --git a/lib/imagekit/resources/webhooks.rb b/lib/imagekit/resources/webhooks.rb index 4c50cd1b..abc4b41e 100644 --- a/lib/imagekit/resources/webhooks.rb +++ b/lib/imagekit/resources/webhooks.rb @@ -5,7 +5,7 @@ module Resources class Webhooks # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent] def unsafe_unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnsafeUnwrapWebhookEvent, parsed) @@ -13,7 +13,7 @@ def unsafe_unwrap(payload) # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent] def unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnwrapWebhookEvent, parsed) diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 90c72e54..ba4b9b2b 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -61,14 +61,14 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - VideoTransformationAcceptedWebhookEvent = - Imagekit::Models::VideoTransformationAcceptedWebhookEvent + VideoTransformationAcceptedEvent = + Imagekit::Models::VideoTransformationAcceptedEvent - VideoTransformationErrorWebhookEvent = - Imagekit::Models::VideoTransformationErrorWebhookEvent + VideoTransformationErrorEvent = + Imagekit::Models::VideoTransformationErrorEvent - VideoTransformationReadyWebhookEvent = - Imagekit::Models::VideoTransformationReadyWebhookEvent + VideoTransformationReadyEvent = + Imagekit::Models::VideoTransformationReadyEvent WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi index d9881aea..e4fe5870 100644 --- a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi @@ -8,9 +8,9 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, - Imagekit::VideoTransformationReadyWebhookEvent, - Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationErrorEvent ) end diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi index 457c223b..d2d814d5 100644 --- a/rbi/imagekit/models/unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unwrap_webhook_event.rbi @@ -8,9 +8,9 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, - Imagekit::VideoTransformationReadyWebhookEvent, - Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationErrorEvent ) end diff --git a/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi b/rbi/imagekit/models/video_transformation_accepted_event.rbi similarity index 60% rename from rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi rename to rbi/imagekit/models/video_transformation_accepted_event.rbi index 5433ace6..3e0a9e1b 100644 --- a/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_accepted_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationAcceptedEvent, Imagekit::Internal::AnyHash ) end @@ -18,25 +18,22 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationAcceptedWebhookEvent::Data) } + sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data) } attr_reader :data sig do params( - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash + data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash ).void end attr_writer :data - sig do - returns(Imagekit::VideoTransformationAcceptedWebhookEvent::Request) - end + sig { returns(Imagekit::VideoTransformationAcceptedEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash + request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash ).void end attr_writer :request @@ -48,9 +45,8 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash, - request: - Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash, + data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash, + request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -69,8 +65,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, - request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + data: Imagekit::VideoTransformationAcceptedEvent::Data, + request: Imagekit::VideoTransformationAcceptedEvent::Request, type: Symbol } ) @@ -82,29 +78,25 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + Imagekit::VideoTransformationAcceptedEvent::Data, Imagekit::Internal::AnyHash ) end - sig do - returns( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset - ) - end + sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data::Asset) } attr_reader :asset sig do params( asset: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do returns( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation ) end attr_reader :transformation @@ -112,7 +104,7 @@ module Imagekit sig do params( transformation: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash ).void end attr_writer :transformation @@ -120,9 +112,9 @@ module Imagekit sig do params( asset: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset::OrHash, + Imagekit::VideoTransformationAcceptedEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -131,10 +123,9 @@ module Imagekit sig do override.returns( { - asset: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, transformation: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } ) end @@ -145,7 +136,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + Imagekit::VideoTransformationAcceptedEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -170,14 +161,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -185,7 +176,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options ) ) end @@ -194,7 +185,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -202,9 +193,9 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::OrSymbol, options: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end def self.new(type:, options: nil) @@ -214,9 +205,9 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol, options: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } ) end @@ -230,7 +221,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -238,23 +229,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -266,7 +257,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -274,7 +265,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -283,7 +274,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -297,7 +288,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -306,7 +297,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -320,7 +311,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -329,7 +320,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -343,7 +334,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -352,7 +343,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -360,16 +351,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -387,16 +378,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -410,7 +401,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -418,18 +409,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -444,7 +435,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -452,33 +443,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -493,7 +484,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -501,18 +492,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -527,7 +518,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -535,18 +526,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -561,7 +552,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + Imagekit::VideoTransformationAcceptedEvent::Request, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_transformation_error_webhook_event.rbi b/rbi/imagekit/models/video_transformation_error_event.rbi similarity index 60% rename from rbi/imagekit/models/video_transformation_error_webhook_event.rbi rename to rbi/imagekit/models/video_transformation_error_event.rbi index dc3438bf..1f6f27bb 100644 --- a/rbi/imagekit/models/video_transformation_error_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_error_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent, + Imagekit::VideoTransformationErrorEvent, Imagekit::Internal::AnyHash ) end @@ -18,23 +18,20 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationErrorWebhookEvent::Data) } + sig { returns(Imagekit::VideoTransformationErrorEvent::Data) } attr_reader :data sig do - params( - data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash - ).void + params(data: Imagekit::VideoTransformationErrorEvent::Data::OrHash).void end attr_writer :data - sig { returns(Imagekit::VideoTransformationErrorWebhookEvent::Request) } + sig { returns(Imagekit::VideoTransformationErrorEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash + request: Imagekit::VideoTransformationErrorEvent::Request::OrHash ).void end attr_writer :request @@ -46,9 +43,8 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash, - request: - Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash, + data: Imagekit::VideoTransformationErrorEvent::Data::OrHash, + request: Imagekit::VideoTransformationErrorEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -67,8 +63,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data, - request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + data: Imagekit::VideoTransformationErrorEvent::Data, + request: Imagekit::VideoTransformationErrorEvent::Request, type: Symbol } ) @@ -80,45 +76,39 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data, + Imagekit::VideoTransformationErrorEvent::Data, Imagekit::Internal::AnyHash ) end - sig do - returns(Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset) - end + sig { returns(Imagekit::VideoTransformationErrorEvent::Data::Asset) } attr_reader :asset sig do params( - asset: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset::OrHash + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do - returns( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation - ) + returns(Imagekit::VideoTransformationErrorEvent::Data::Transformation) end attr_reader :transformation sig do params( transformation: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash ).void end attr_writer :transformation sig do params( - asset: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset::OrHash, + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -127,10 +117,9 @@ module Imagekit sig do override.returns( { - asset: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, transformation: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + Imagekit::VideoTransformationErrorEvent::Data::Transformation } ) end @@ -141,7 +130,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + Imagekit::VideoTransformationErrorEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -166,14 +155,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation, + Imagekit::VideoTransformationErrorEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -181,7 +170,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error ) ) end @@ -190,7 +179,7 @@ module Imagekit sig do params( error: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash ).void end attr_writer :error @@ -198,7 +187,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options ) ) end @@ -207,7 +196,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -215,11 +204,11 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::OrSymbol, error: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::OrHash, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash, options: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end def self.new(type:, error: nil, options: nil) @@ -229,11 +218,11 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol, error: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, options: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } ) end @@ -247,7 +236,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -255,23 +244,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -283,14 +272,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) end attr_accessor :reason @@ -298,7 +287,7 @@ module Imagekit sig do params( reason: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::OrSymbol ).returns(T.attached_class) end def self.new(reason:) @@ -308,7 +297,7 @@ module Imagekit override.returns( { reason: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol } ) end @@ -322,7 +311,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -330,23 +319,23 @@ module Imagekit ENCODING_FAILED = T.let( :encoding_failed, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) DOWNLOAD_FAILED = T.let( :download_failed, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) INTERNAL_SERVER_ERROR = T.let( :internal_server_error, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ] ) end @@ -359,7 +348,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -367,7 +356,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -376,7 +365,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -390,7 +379,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -399,7 +388,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -413,7 +402,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -422,7 +411,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -436,7 +425,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -445,7 +434,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -453,16 +442,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -480,16 +469,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -503,7 +492,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -511,18 +500,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -537,7 +526,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -545,33 +534,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -586,7 +575,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -594,18 +583,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -620,7 +609,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -628,18 +617,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -654,7 +643,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Request, + Imagekit::VideoTransformationErrorEvent::Request, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi b/rbi/imagekit/models/video_transformation_ready_event.rbi similarity index 63% rename from rbi/imagekit/models/video_transformation_ready_webhook_event.rbi rename to rbi/imagekit/models/video_transformation_ready_event.rbi index 406bcf19..15b4c135 100644 --- a/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_ready_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationReadyEvent, Imagekit::Internal::AnyHash ) end @@ -18,23 +18,20 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationReadyWebhookEvent::Data) } + sig { returns(Imagekit::VideoTransformationReadyEvent::Data) } attr_reader :data sig do - params( - data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash - ).void + params(data: Imagekit::VideoTransformationReadyEvent::Data::OrHash).void end attr_writer :data - sig { returns(Imagekit::VideoTransformationReadyWebhookEvent::Request) } + sig { returns(Imagekit::VideoTransformationReadyEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash + request: Imagekit::VideoTransformationReadyEvent::Request::OrHash ).void end attr_writer :request @@ -43,16 +40,13 @@ module Imagekit attr_accessor :type sig do - returns( - T.nilable(Imagekit::VideoTransformationReadyWebhookEvent::Timings) - ) + returns(T.nilable(Imagekit::VideoTransformationReadyEvent::Timings)) end attr_reader :timings sig do params( - timings: - Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash + timings: Imagekit::VideoTransformationReadyEvent::Timings::OrHash ).void end attr_writer :timings @@ -61,11 +55,9 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash, - request: - Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash, - timings: - Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash, + data: Imagekit::VideoTransformationReadyEvent::Data::OrHash, + request: Imagekit::VideoTransformationReadyEvent::Request::OrHash, + timings: Imagekit::VideoTransformationReadyEvent::Timings::OrHash, type: Symbol ).returns(T.attached_class) end @@ -85,10 +77,10 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data, - request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + data: Imagekit::VideoTransformationReadyEvent::Data, + request: Imagekit::VideoTransformationReadyEvent::Request, type: Symbol, - timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + timings: Imagekit::VideoTransformationReadyEvent::Timings } ) end @@ -99,45 +91,39 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data, + Imagekit::VideoTransformationReadyEvent::Data, Imagekit::Internal::AnyHash ) end - sig do - returns(Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset) - end + sig { returns(Imagekit::VideoTransformationReadyEvent::Data::Asset) } attr_reader :asset sig do params( - asset: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset::OrHash + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do - returns( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation - ) + returns(Imagekit::VideoTransformationReadyEvent::Data::Transformation) end attr_reader :transformation sig do params( transformation: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash ).void end attr_writer :transformation sig do params( - asset: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset::OrHash, + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -146,10 +132,9 @@ module Imagekit sig do override.returns( { - asset: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, transformation: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + Imagekit::VideoTransformationReadyEvent::Data::Transformation } ) end @@ -160,7 +145,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + Imagekit::VideoTransformationReadyEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -185,14 +170,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation, + Imagekit::VideoTransformationReadyEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -200,7 +185,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options ) ) end @@ -209,7 +194,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -217,7 +202,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output ) ) end @@ -226,7 +211,7 @@ module Imagekit sig do params( output: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash ).void end attr_writer :output @@ -234,11 +219,11 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::OrSymbol, options: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::OrHash, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash, output: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash ).returns(T.attached_class) end def self.new(type:, options: nil, output: nil) @@ -248,11 +233,11 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol, options: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, output: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } ) end @@ -266,7 +251,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -274,23 +259,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -302,7 +287,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -310,7 +295,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -319,7 +304,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -333,7 +318,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -342,7 +327,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -356,7 +341,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -365,7 +350,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -379,7 +364,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -388,7 +373,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -396,16 +381,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -423,16 +408,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -446,7 +431,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -454,18 +439,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -480,7 +465,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -488,33 +473,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -529,7 +514,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -537,18 +522,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -563,7 +548,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -571,18 +556,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -595,7 +580,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output, Imagekit::Internal::AnyHash ) end @@ -606,7 +591,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata ) ) end @@ -615,7 +600,7 @@ module Imagekit sig do params( video_metadata: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash ).void end attr_writer :video_metadata @@ -624,7 +609,7 @@ module Imagekit params( url: String, video_metadata: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash ).returns(T.attached_class) end def self.new(url:, video_metadata: nil) @@ -635,7 +620,7 @@ module Imagekit { url: String, video_metadata: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } ) end @@ -646,7 +631,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, Imagekit::Internal::AnyHash ) end @@ -695,7 +680,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Request, + Imagekit::VideoTransformationReadyEvent::Request, Imagekit::Internal::AnyHash ) end @@ -743,7 +728,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Timings, + Imagekit::VideoTransformationReadyEvent::Timings, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/resources/webhooks.rbi b/rbi/imagekit/resources/webhooks.rbi index dbb2ddc0..05c1e68b 100644 --- a/rbi/imagekit/resources/webhooks.rbi +++ b/rbi/imagekit/resources/webhooks.rbi @@ -6,9 +6,9 @@ module Imagekit sig do params(payload: String).returns( T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, - Imagekit::VideoTransformationReadyWebhookEvent, - Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationErrorEvent ) ) end @@ -21,9 +21,9 @@ module Imagekit sig do params(payload: String).returns( T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, - Imagekit::VideoTransformationReadyWebhookEvent, - Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationErrorEvent ) ) end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 3dfdb265..1ceb33fc 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -55,11 +55,11 @@ module Imagekit module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - class VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent + class VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent - class VideoTransformationErrorWebhookEvent = Imagekit::Models::VideoTransformationErrorWebhookEvent + class VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent - class VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + class VideoTransformationReadyEvent = Imagekit::Models::VideoTransformationReadyEvent class WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs index 04a9fefb..0a683e9d 100644 --- a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs @@ -1,9 +1,9 @@ module Imagekit module Models type unsafe_unwrap_webhook_event = - Imagekit::VideoTransformationAcceptedWebhookEvent - | Imagekit::VideoTransformationReadyWebhookEvent - | Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent + | Imagekit::VideoTransformationReadyEvent + | Imagekit::VideoTransformationErrorEvent module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/unwrap_webhook_event.rbs b/sig/imagekit/models/unwrap_webhook_event.rbs index b9101a5f..c3224e6d 100644 --- a/sig/imagekit/models/unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unwrap_webhook_event.rbs @@ -1,9 +1,9 @@ module Imagekit module Models type unwrap_webhook_event = - Imagekit::VideoTransformationAcceptedWebhookEvent - | Imagekit::VideoTransformationReadyWebhookEvent - | Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent + | Imagekit::VideoTransformationReadyEvent + | Imagekit::VideoTransformationErrorEvent module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs b/sig/imagekit/models/video_transformation_accepted_event.rbs similarity index 55% rename from sig/imagekit/models/video_transformation_accepted_webhook_event.rbs rename to sig/imagekit/models/video_transformation_accepted_event.rbs index 2e9ad468..c1e84f58 100644 --- a/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_accepted_event.rbs @@ -1,60 +1,60 @@ module Imagekit module Models - type video_transformation_accepted_webhook_event = + type video_transformation_accepted_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, - request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + data: Imagekit::VideoTransformationAcceptedEvent::Data, + request: Imagekit::VideoTransformationAcceptedEvent::Request, type: :"video.transformation.accepted" } - class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data + attr_accessor data: Imagekit::VideoTransformationAcceptedEvent::Data - attr_accessor request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request + attr_accessor request: Imagekit::VideoTransformationAcceptedEvent::Request attr_accessor type: :"video.transformation.accepted" def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, - request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + data: Imagekit::VideoTransformationAcceptedEvent::Data, + request: Imagekit::VideoTransformationAcceptedEvent::Request, ?type: :"video.transformation.accepted" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, - request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + data: Imagekit::VideoTransformationAcceptedEvent::Data, + request: Imagekit::VideoTransformationAcceptedEvent::Request, type: :"video.transformation.accepted" } type data = { - asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } type asset = { url: String } @@ -69,27 +69,27 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_ - attr_reader options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options def initialize: ( - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, - ?options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + ?options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } type type_ = @@ -102,75 +102,75 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_] end type options = { - audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -181,7 +181,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -195,7 +195,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -206,7 +206,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -217,7 +217,7 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec] end end end diff --git a/sig/imagekit/models/video_transformation_error_webhook_event.rbs b/sig/imagekit/models/video_transformation_error_event.rbs similarity index 54% rename from sig/imagekit/models/video_transformation_error_webhook_event.rbs rename to sig/imagekit/models/video_transformation_error_event.rbs index 4eada151..f0a40b5a 100644 --- a/sig/imagekit/models/video_transformation_error_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_error_event.rbs @@ -1,60 +1,60 @@ module Imagekit module Models - type video_transformation_error_webhook_event = + type video_transformation_error_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data, - request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + data: Imagekit::VideoTransformationErrorEvent::Data, + request: Imagekit::VideoTransformationErrorEvent::Request, type: :"video.transformation.error" } - class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationErrorWebhookEvent::Data + attr_accessor data: Imagekit::VideoTransformationErrorEvent::Data - attr_accessor request: Imagekit::VideoTransformationErrorWebhookEvent::Request + attr_accessor request: Imagekit::VideoTransformationErrorEvent::Request attr_accessor type: :"video.transformation.error" def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data, - request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + data: Imagekit::VideoTransformationErrorEvent::Data, + request: Imagekit::VideoTransformationErrorEvent::Request, ?type: :"video.transformation.error" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data, - request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + data: Imagekit::VideoTransformationErrorEvent::Data, + request: Imagekit::VideoTransformationErrorEvent::Request, type: :"video.transformation.error" } type data = { - asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationErrorEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation } type asset = { url: String } @@ -69,36 +69,36 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, - error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, - options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_ - attr_reader error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error? + attr_reader error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error? def error=: ( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error - ) -> Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error + ) -> Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error - attr_reader options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options def initialize: ( - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, - ?error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, - ?options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + ?error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + ?options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, - error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, - options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } type type_ = @@ -111,23 +111,23 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_] end type error = { - reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason } class Error < Imagekit::Internal::Type::BaseModel - attr_accessor reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + attr_accessor reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason def initialize: ( - reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason ) -> void def to_hash: -> { - reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason } type reason = @@ -140,76 +140,76 @@ module Imagekit DOWNLOAD_FAILED: :download_failed INTERNAL_SERVER_ERROR: :internal_server_error - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason] end end type options = { - audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -220,7 +220,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -234,7 +234,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -245,7 +245,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -256,7 +256,7 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec] end end end diff --git a/sig/imagekit/models/video_transformation_ready_webhook_event.rbs b/sig/imagekit/models/video_transformation_ready_event.rbs similarity index 56% rename from sig/imagekit/models/video_transformation_ready_webhook_event.rbs rename to sig/imagekit/models/video_transformation_ready_event.rbs index 1a6a7a2c..7af03de5 100644 --- a/sig/imagekit/models/video_transformation_ready_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_ready_event.rbs @@ -1,69 +1,69 @@ module Imagekit module Models - type video_transformation_ready_webhook_event = + type video_transformation_ready_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data, - request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + data: Imagekit::VideoTransformationReadyEvent::Data, + request: Imagekit::VideoTransformationReadyEvent::Request, type: :"video.transformation.ready", - timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + timings: Imagekit::VideoTransformationReadyEvent::Timings } - class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationReadyWebhookEvent::Data + attr_accessor data: Imagekit::VideoTransformationReadyEvent::Data - attr_accessor request: Imagekit::VideoTransformationReadyWebhookEvent::Request + attr_accessor request: Imagekit::VideoTransformationReadyEvent::Request attr_accessor type: :"video.transformation.ready" - attr_reader timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings? + attr_reader timings: Imagekit::VideoTransformationReadyEvent::Timings? def timings=: ( - Imagekit::VideoTransformationReadyWebhookEvent::Timings - ) -> Imagekit::VideoTransformationReadyWebhookEvent::Timings + Imagekit::VideoTransformationReadyEvent::Timings + ) -> Imagekit::VideoTransformationReadyEvent::Timings def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data, - request: Imagekit::VideoTransformationReadyWebhookEvent::Request, - ?timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings, + data: Imagekit::VideoTransformationReadyEvent::Data, + request: Imagekit::VideoTransformationReadyEvent::Request, + ?timings: Imagekit::VideoTransformationReadyEvent::Timings, ?type: :"video.transformation.ready" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data, - request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + data: Imagekit::VideoTransformationReadyEvent::Data, + request: Imagekit::VideoTransformationReadyEvent::Request, type: :"video.transformation.ready", - timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + timings: Imagekit::VideoTransformationReadyEvent::Timings } type data = { - asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationReadyEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation } type asset = { url: String } @@ -78,36 +78,36 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, - output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_ - attr_reader options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options - attr_reader output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output? + attr_reader output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output? def output=: ( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output - ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output def initialize: ( - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, - ?options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, - ?output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + ?options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + ?output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, - output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } type type_ = @@ -120,75 +120,75 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_] end type options = { - audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -199,7 +199,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -213,7 +213,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -224,7 +224,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -235,33 +235,33 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec] end end type output = { url: String, - video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } class Output < Imagekit::Internal::Type::BaseModel attr_accessor url: String - attr_reader video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata? + attr_reader video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata? def video_metadata=: ( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata - ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata def initialize: ( url: String, - ?video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + ?video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata ) -> void def to_hash: -> { url: String, - video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } type video_metadata = diff --git a/sig/imagekit/resources/webhooks.rbs b/sig/imagekit/resources/webhooks.rbs index 703798fe..d0ffe5de 100644 --- a/sig/imagekit/resources/webhooks.rbs +++ b/sig/imagekit/resources/webhooks.rbs @@ -3,15 +3,15 @@ module Imagekit class Webhooks def unsafe_unwrap: ( String payload - ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent - | Imagekit::VideoTransformationReadyWebhookEvent - | Imagekit::VideoTransformationErrorWebhookEvent) + ) -> (Imagekit::VideoTransformationAcceptedEvent + | Imagekit::VideoTransformationReadyEvent + | Imagekit::VideoTransformationErrorEvent) def unwrap: ( String payload - ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent - | Imagekit::VideoTransformationReadyWebhookEvent - | Imagekit::VideoTransformationErrorWebhookEvent) + ) -> (Imagekit::VideoTransformationAcceptedEvent + | Imagekit::VideoTransformationReadyEvent + | Imagekit::VideoTransformationErrorEvent) def initialize: (client: Imagekit::Client) -> void end From 51a1c4b519334c5a28add142d6756826ff9b9da9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 04:54:38 +0000 Subject: [PATCH 067/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index aa083b75..211c2820 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-e798e75f763868cfd2babe250a0d880a651b19f9e1b9a3b567d629eea9893147.yml openapi_spec_hash: 45341845beb1363b7dcb4050934b9cf0 -config_hash: 128de0925828937e2ae36770e7f6029a +config_hash: 62e43a8e96bb82f754e37a0e0c264f1e From d43b6ff55b75dd74e732b4e6a52a8d1b000f058f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 05:09:10 +0000 Subject: [PATCH 068/178] feat(api): manual updates --- .stats.yml | 6 +- lib/imagekit.rb | 9 +- lib/imagekit/models.rb | 6 +- .../models/unsafe_unwrap_webhook_event.rb | 8 +- lib/imagekit/models/unwrap_webhook_event.rb | 8 +- ..._transformation_accepted_webhook_event.rb} | 82 ++++---- ...deo_transformation_error_webhook_event.rb} | 98 +++++----- ...deo_transformation_ready_webhook_event.rb} | 106 +++++----- lib/imagekit/resources/files.rb | 4 +- lib/imagekit/resources/webhooks.rb | 4 +- rbi/imagekit/models.rbi | 12 +- .../models/unsafe_unwrap_webhook_event.rbi | 6 +- rbi/imagekit/models/unwrap_webhook_event.rbi | 6 +- ...transformation_accepted_webhook_event.rbi} | 149 +++++++------- ...eo_transformation_error_webhook_event.rbi} | 177 +++++++++-------- ...eo_transformation_ready_webhook_event.rbi} | 185 ++++++++++-------- rbi/imagekit/resources/files.rbi | 4 +- rbi/imagekit/resources/webhooks.rbi | 12 +- sig/imagekit/models.rbs | 6 +- .../models/unsafe_unwrap_webhook_event.rbs | 6 +- sig/imagekit/models/unwrap_webhook_event.rbs | 6 +- ...transformation_accepted_webhook_event.rbs} | 114 +++++------ ...eo_transformation_error_webhook_event.rbs} | 136 ++++++------- ...eo_transformation_ready_webhook_event.rbs} | 150 +++++++------- sig/imagekit/resources/webhooks.rbs | 12 +- 25 files changed, 675 insertions(+), 637 deletions(-) rename lib/imagekit/models/{video_transformation_accepted_event.rb => video_transformation_accepted_webhook_event.rb} (74%) rename lib/imagekit/models/{video_transformation_error_event.rb => video_transformation_error_webhook_event.rb} (68%) rename lib/imagekit/models/{video_transformation_ready_event.rb => video_transformation_ready_webhook_event.rb} (70%) rename rbi/imagekit/models/{video_transformation_accepted_event.rbi => video_transformation_accepted_webhook_event.rbi} (60%) rename rbi/imagekit/models/{video_transformation_error_event.rbi => video_transformation_error_webhook_event.rbi} (60%) rename rbi/imagekit/models/{video_transformation_ready_event.rbi => video_transformation_ready_webhook_event.rbi} (63%) rename sig/imagekit/models/{video_transformation_accepted_event.rbs => video_transformation_accepted_webhook_event.rbs} (55%) rename sig/imagekit/models/{video_transformation_error_event.rbs => video_transformation_error_webhook_event.rbs} (54%) rename sig/imagekit/models/{video_transformation_ready_event.rbs => video_transformation_ready_webhook_event.rbs} (56%) diff --git a/.stats.yml b/.stats.yml index 211c2820..2ec886b7 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-e798e75f763868cfd2babe250a0d880a651b19f9e1b9a3b567d629eea9893147.yml -openapi_spec_hash: 45341845beb1363b7dcb4050934b9cf0 -config_hash: 62e43a8e96bb82f754e37a0e0c264f1e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-863564701f791fdf016f7321fce445de5e368c474b06b135aaac16214f4f6416.yml +openapi_spec_hash: e3bb05601081de07084edf79cf3a2d63 +config_hash: 4947aef92e0f986b21a473329de4a647 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index fca54b76..11290951 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -128,9 +128,12 @@ require_relative "imagekit/models/metadata" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" -require_relative "imagekit/models/video_transformation_accepted_event" -require_relative "imagekit/models/video_transformation_error_event" -require_relative "imagekit/models/video_transformation_ready_event" +require_relative "imagekit/models/video_transformation_accepted_webhook_event" +require_relative "imagekit/models/video_transformation_accepted_webhook_event" +require_relative "imagekit/models/video_transformation_error_webhook_event" +require_relative "imagekit/models/video_transformation_error_webhook_event" +require_relative "imagekit/models/video_transformation_ready_webhook_event" +require_relative "imagekit/models/video_transformation_ready_webhook_event" require_relative "imagekit/models/webhook_unsafe_unwrap_params" require_relative "imagekit/models/webhook_unwrap_params" require_relative "imagekit/models" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index e5d19dc3..9f4e5bd6 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -95,11 +95,11 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent + VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent - VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent + VideoTransformationErrorWebhookEvent = Imagekit::Models::VideoTransformationErrorWebhookEvent - VideoTransformationReadyEvent = Imagekit::Models::VideoTransformationReadyEvent + VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb index c86439e5..5b7cab93 100644 --- a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb @@ -5,14 +5,14 @@ module Models module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union - variant -> { Imagekit::VideoTransformationAcceptedEvent } + variant -> { Imagekit::VideoTransformationAcceptedWebhookEvent } - variant -> { Imagekit::VideoTransformationReadyEvent } + variant -> { Imagekit::VideoTransformationReadyWebhookEvent } - variant -> { Imagekit::VideoTransformationErrorEvent } + variant -> { Imagekit::VideoTransformationErrorWebhookEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent)] end end end diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb index 1a570019..be01dd2a 100644 --- a/lib/imagekit/models/unwrap_webhook_event.rb +++ b/lib/imagekit/models/unwrap_webhook_event.rb @@ -5,14 +5,14 @@ module Models module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union - variant -> { Imagekit::VideoTransformationAcceptedEvent } + variant -> { Imagekit::VideoTransformationAcceptedWebhookEvent } - variant -> { Imagekit::VideoTransformationReadyEvent } + variant -> { Imagekit::VideoTransformationReadyWebhookEvent } - variant -> { Imagekit::VideoTransformationErrorEvent } + variant -> { Imagekit::VideoTransformationErrorWebhookEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent)] end end end diff --git a/lib/imagekit/models/video_transformation_accepted_event.rb b/lib/imagekit/models/video_transformation_accepted_webhook_event.rb similarity index 74% rename from lib/imagekit/models/video_transformation_accepted_event.rb rename to lib/imagekit/models/video_transformation_accepted_webhook_event.rb index fc8eaec5..4b238162 100644 --- a/lib/imagekit/models/video_transformation_accepted_event.rb +++ b/lib/imagekit/models/video_transformation_accepted_webhook_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data] - required :data, -> { Imagekit::VideoTransformationAcceptedEvent::Data } + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data] + required :data, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Request] - required :request, -> { Imagekit::VideoTransformationAcceptedEvent::Request } + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] + required :request, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Request } # @!attribute type # @@ -34,29 +34,29 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationAcceptedEvent::Data] + # @param data [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationAcceptedEvent::Request] + # @param request [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] # # @param type [Symbol, :"video.transformation.accepted"] - # @see Imagekit::Models::VideoTransformationAcceptedEvent#data + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#asset + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -68,23 +68,23 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options } # @!method initialize(type:, options: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] - # @param options [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options] + # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type] + # @param options [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options] - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -96,13 +96,13 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -111,10 +111,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format }, api_name: :format @@ -125,9 +125,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -136,20 +136,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -160,7 +160,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -174,7 +174,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -185,7 +185,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -199,7 +199,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationAcceptedEvent#request + # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. diff --git a/lib/imagekit/models/video_transformation_error_event.rb b/lib/imagekit/models/video_transformation_error_webhook_event.rb similarity index 68% rename from lib/imagekit/models/video_transformation_error_event.rb rename to lib/imagekit/models/video_transformation_error_webhook_event.rb index 5b199f18..c639c0a7 100644 --- a/lib/imagekit/models/video_transformation_error_event.rb +++ b/lib/imagekit/models/video_transformation_error_webhook_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data] - required :data, -> { Imagekit::VideoTransformationErrorEvent::Data } + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data] + required :data, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Request] - required :request, -> { Imagekit::VideoTransformationErrorEvent::Request } + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] + required :request, -> { Imagekit::VideoTransformationErrorWebhookEvent::Request } # @!attribute type # @@ -34,29 +34,29 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationErrorEvent::Data] + # @param data [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationErrorEvent::Request] + # @param request [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] # # @param type [Symbol, :"video.transformation.error"] - # @see Imagekit::Models::VideoTransformationErrorEvent#data + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationErrorEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationErrorEvent::Data#asset + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -68,29 +68,29 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type } # @!attribute error # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error, nil] - optional :error, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error } + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, nil] + optional :error, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options } # @!method initialize(type:, error: nil, options: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] - # @param error [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error] - # @param options [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options] + # @param type [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Type] + # @param error [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error] + # @param options [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options] - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -102,18 +102,18 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#error + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#error class Error < Imagekit::Internal::Type::BaseModel # @!attribute reason # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason] required :reason, - enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason } + enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason } # @!method initialize(reason:) - # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] + # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason] - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error#reason + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error#reason module Reason extend Imagekit::Internal::Type::Enum @@ -126,13 +126,13 @@ module Reason end end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -141,10 +141,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format }, api_name: :format @@ -155,9 +155,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -166,20 +166,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -190,7 +190,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -204,7 +204,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -215,7 +215,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -229,7 +229,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationErrorEvent#request + # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. diff --git a/lib/imagekit/models/video_transformation_ready_event.rb b/lib/imagekit/models/video_transformation_ready_webhook_event.rb similarity index 70% rename from lib/imagekit/models/video_transformation_ready_event.rb rename to lib/imagekit/models/video_transformation_ready_webhook_event.rb index 5e6d463b..812ea710 100644 --- a/lib/imagekit/models/video_transformation_ready_event.rb +++ b/lib/imagekit/models/video_transformation_ready_webhook_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data] - required :data, -> { Imagekit::VideoTransformationReadyEvent::Data } + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data] + required :data, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Request] - required :request, -> { Imagekit::VideoTransformationReadyEvent::Request } + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] + required :request, -> { Imagekit::VideoTransformationReadyWebhookEvent::Request } # @!attribute type # @@ -31,39 +31,39 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel # @!attribute timings # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Timings, nil] - optional :timings, -> { Imagekit::VideoTransformationReadyEvent::Timings } + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings, nil] + optional :timings, -> { Imagekit::VideoTransformationReadyWebhookEvent::Timings } # @!method initialize(id:, created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") # @param id [String] Unique identifier for the event. # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationReadyEvent::Data] + # @param data [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationReadyEvent::Request] + # @param request [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] # - # @param timings [Imagekit::Models::VideoTransformationReadyEvent::Timings] + # @param timings [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings] # # @param type [Symbol, :"video.transformation.ready"] - # @see Imagekit::Models::VideoTransformationReadyEvent#data + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationReadyEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationReadyEvent::Data#asset + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -75,29 +75,29 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options } # @!attribute output # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output, nil] - optional :output, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output, nil] + optional :output, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output } # @!method initialize(type:, options: nil, output: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] - # @param options [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options] - # @param output [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output] + # @param type [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Type] + # @param options [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options] + # @param output [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output] - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -109,13 +109,13 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -124,10 +124,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format }, api_name: :format @@ -138,9 +138,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -149,20 +149,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -173,7 +173,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -187,7 +187,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -198,7 +198,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -210,7 +210,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#output + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#output class Output < Imagekit::Internal::Type::BaseModel # @!attribute url # @@ -219,15 +219,15 @@ class Output < Imagekit::Internal::Type::BaseModel # @!attribute video_metadata # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, nil] + # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata, nil] optional :video_metadata, - -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } + -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata } # @!method initialize(url:, video_metadata: nil) # @param url [String] - # @param video_metadata [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata] + # @param video_metadata [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata] - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output#video_metadata + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output#video_metadata class VideoMetadata < Imagekit::Internal::Type::BaseModel # @!attribute bitrate # @@ -259,7 +259,7 @@ class VideoMetadata < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::VideoTransformationReadyEvent#request + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. @@ -287,7 +287,7 @@ class Request < Imagekit::Internal::Type::BaseModel # @param user_agent [String] User-Agent header of the originating request. end - # @see Imagekit::Models::VideoTransformationReadyEvent#timings + # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#timings class Timings < Imagekit::Internal::Type::BaseModel # @!attribute download_duration # Milliseconds spent downloading the source. diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 6ee090f3..d138d933 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -193,8 +193,8 @@ def rename(params) # # 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 `expiration` - # from your secure backend using private API. + # 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. # diff --git a/lib/imagekit/resources/webhooks.rb b/lib/imagekit/resources/webhooks.rb index abc4b41e..4c50cd1b 100644 --- a/lib/imagekit/resources/webhooks.rb +++ b/lib/imagekit/resources/webhooks.rb @@ -5,7 +5,7 @@ module Resources class Webhooks # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] def unsafe_unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnsafeUnwrapWebhookEvent, parsed) @@ -13,7 +13,7 @@ def unsafe_unwrap(payload) # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] def unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnwrapWebhookEvent, parsed) diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index ba4b9b2b..90c72e54 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -61,14 +61,14 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - VideoTransformationAcceptedEvent = - Imagekit::Models::VideoTransformationAcceptedEvent + VideoTransformationAcceptedWebhookEvent = + Imagekit::Models::VideoTransformationAcceptedWebhookEvent - VideoTransformationErrorEvent = - Imagekit::Models::VideoTransformationErrorEvent + VideoTransformationErrorWebhookEvent = + Imagekit::Models::VideoTransformationErrorWebhookEvent - VideoTransformationReadyEvent = - Imagekit::Models::VideoTransformationReadyEvent + VideoTransformationReadyWebhookEvent = + Imagekit::Models::VideoTransformationReadyWebhookEvent WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi index e4fe5870..d9881aea 100644 --- a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi @@ -8,9 +8,9 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationErrorWebhookEvent ) end diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi index d2d814d5..457c223b 100644 --- a/rbi/imagekit/models/unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unwrap_webhook_event.rbi @@ -8,9 +8,9 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationErrorWebhookEvent ) end diff --git a/rbi/imagekit/models/video_transformation_accepted_event.rbi b/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi similarity index 60% rename from rbi/imagekit/models/video_transformation_accepted_event.rbi rename to rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi index 3e0a9e1b..5433ace6 100644 --- a/rbi/imagekit/models/video_transformation_accepted_event.rbi +++ b/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationAcceptedWebhookEvent, Imagekit::Internal::AnyHash ) end @@ -18,22 +18,25 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data) } + sig { returns(Imagekit::VideoTransformationAcceptedWebhookEvent::Data) } attr_reader :data sig do params( - data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash ).void end attr_writer :data - sig { returns(Imagekit::VideoTransformationAcceptedEvent::Request) } + sig do + returns(Imagekit::VideoTransformationAcceptedWebhookEvent::Request) + end attr_reader :request sig do params( - request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash + request: + Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash ).void end attr_writer :request @@ -45,8 +48,9 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash, - request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash, + request: + Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -65,8 +69,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data, - request: Imagekit::VideoTransformationAcceptedEvent::Request, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, type: Symbol } ) @@ -78,25 +82,29 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Data, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data, Imagekit::Internal::AnyHash ) end - sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data::Asset) } + sig do + returns( + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset + ) + end attr_reader :asset sig do params( asset: - Imagekit::VideoTransformationAcceptedEvent::Data::Asset::OrHash + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do returns( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation ) end attr_reader :transformation @@ -104,7 +112,7 @@ module Imagekit sig do params( transformation: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::OrHash ).void end attr_writer :transformation @@ -112,9 +120,9 @@ module Imagekit sig do params( asset: - Imagekit::VideoTransformationAcceptedEvent::Data::Asset::OrHash, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -123,9 +131,10 @@ module Imagekit sig do override.returns( { - asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + asset: + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, transformation: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation } ) end @@ -136,7 +145,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -161,14 +170,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -176,7 +185,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options ) ) end @@ -185,7 +194,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -193,9 +202,9 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::OrSymbol, options: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end def self.new(type:, options: nil) @@ -205,9 +214,9 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol, options: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options } ) end @@ -221,7 +230,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -229,23 +238,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -257,7 +266,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -265,7 +274,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -274,7 +283,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -288,7 +297,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -297,7 +306,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -311,7 +320,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -320,7 +329,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -334,7 +343,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -343,7 +352,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -351,16 +360,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -378,16 +387,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -401,7 +410,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -409,18 +418,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -435,7 +444,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -443,33 +452,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -484,7 +493,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -492,18 +501,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -518,7 +527,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -526,18 +535,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -552,7 +561,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Request, + Imagekit::VideoTransformationAcceptedWebhookEvent::Request, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_transformation_error_event.rbi b/rbi/imagekit/models/video_transformation_error_webhook_event.rbi similarity index 60% rename from rbi/imagekit/models/video_transformation_error_event.rbi rename to rbi/imagekit/models/video_transformation_error_webhook_event.rbi index 1f6f27bb..dc3438bf 100644 --- a/rbi/imagekit/models/video_transformation_error_event.rbi +++ b/rbi/imagekit/models/video_transformation_error_webhook_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent, + Imagekit::VideoTransformationErrorWebhookEvent, Imagekit::Internal::AnyHash ) end @@ -18,20 +18,23 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationErrorEvent::Data) } + sig { returns(Imagekit::VideoTransformationErrorWebhookEvent::Data) } attr_reader :data sig do - params(data: Imagekit::VideoTransformationErrorEvent::Data::OrHash).void + params( + data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash + ).void end attr_writer :data - sig { returns(Imagekit::VideoTransformationErrorEvent::Request) } + sig { returns(Imagekit::VideoTransformationErrorWebhookEvent::Request) } attr_reader :request sig do params( - request: Imagekit::VideoTransformationErrorEvent::Request::OrHash + request: + Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash ).void end attr_writer :request @@ -43,8 +46,9 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data::OrHash, - request: Imagekit::VideoTransformationErrorEvent::Request::OrHash, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash, + request: + Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -63,8 +67,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data, - request: Imagekit::VideoTransformationErrorEvent::Request, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data, + request: Imagekit::VideoTransformationErrorWebhookEvent::Request, type: Symbol } ) @@ -76,39 +80,45 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data, + Imagekit::VideoTransformationErrorWebhookEvent::Data, Imagekit::Internal::AnyHash ) end - sig { returns(Imagekit::VideoTransformationErrorEvent::Data::Asset) } + sig do + returns(Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset) + end attr_reader :asset sig do params( - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset::OrHash + asset: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do - returns(Imagekit::VideoTransformationErrorEvent::Data::Transformation) + returns( + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + ) end attr_reader :transformation sig do params( transformation: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::OrHash ).void end attr_writer :transformation sig do params( - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset::OrHash, + asset: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -117,9 +127,10 @@ module Imagekit sig do override.returns( { - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, + asset: + Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, transformation: - Imagekit::VideoTransformationErrorEvent::Data::Transformation + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation } ) end @@ -130,7 +141,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data::Asset, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -155,14 +166,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data::Transformation, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -170,7 +181,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error ) ) end @@ -179,7 +190,7 @@ module Imagekit sig do params( error: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::OrHash ).void end attr_writer :error @@ -187,7 +198,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options ) ) end @@ -196,7 +207,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -204,11 +215,11 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::OrSymbol, error: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::OrHash, options: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end def self.new(type:, error: nil, options: nil) @@ -218,11 +229,11 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol, error: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, options: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options } ) end @@ -236,7 +247,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -244,23 +255,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -272,14 +283,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol ) end attr_accessor :reason @@ -287,7 +298,7 @@ module Imagekit sig do params( reason: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::OrSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::OrSymbol ).returns(T.attached_class) end def self.new(reason:) @@ -297,7 +308,7 @@ module Imagekit override.returns( { reason: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol } ) end @@ -311,7 +322,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -319,23 +330,23 @@ module Imagekit ENCODING_FAILED = T.let( :encoding_failed, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol ) DOWNLOAD_FAILED = T.let( :download_failed, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol ) INTERNAL_SERVER_ERROR = T.let( :internal_server_error, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol ] ) end @@ -348,7 +359,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -356,7 +367,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -365,7 +376,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -379,7 +390,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -388,7 +399,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -402,7 +413,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -411,7 +422,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -425,7 +436,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -434,7 +445,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -442,16 +453,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -469,16 +480,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -492,7 +503,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -500,18 +511,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -526,7 +537,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -534,33 +545,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -575,7 +586,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -583,18 +594,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -609,7 +620,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -617,18 +628,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -643,7 +654,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Request, + Imagekit::VideoTransformationErrorWebhookEvent::Request, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_transformation_ready_event.rbi b/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi similarity index 63% rename from rbi/imagekit/models/video_transformation_ready_event.rbi rename to rbi/imagekit/models/video_transformation_ready_webhook_event.rbi index 15b4c135..406bcf19 100644 --- a/rbi/imagekit/models/video_transformation_ready_event.rbi +++ b/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationReadyWebhookEvent, Imagekit::Internal::AnyHash ) end @@ -18,20 +18,23 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationReadyEvent::Data) } + sig { returns(Imagekit::VideoTransformationReadyWebhookEvent::Data) } attr_reader :data sig do - params(data: Imagekit::VideoTransformationReadyEvent::Data::OrHash).void + params( + data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash + ).void end attr_writer :data - sig { returns(Imagekit::VideoTransformationReadyEvent::Request) } + sig { returns(Imagekit::VideoTransformationReadyWebhookEvent::Request) } attr_reader :request sig do params( - request: Imagekit::VideoTransformationReadyEvent::Request::OrHash + request: + Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash ).void end attr_writer :request @@ -40,13 +43,16 @@ module Imagekit attr_accessor :type sig do - returns(T.nilable(Imagekit::VideoTransformationReadyEvent::Timings)) + returns( + T.nilable(Imagekit::VideoTransformationReadyWebhookEvent::Timings) + ) end attr_reader :timings sig do params( - timings: Imagekit::VideoTransformationReadyEvent::Timings::OrHash + timings: + Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash ).void end attr_writer :timings @@ -55,9 +61,11 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data::OrHash, - request: Imagekit::VideoTransformationReadyEvent::Request::OrHash, - timings: Imagekit::VideoTransformationReadyEvent::Timings::OrHash, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash, + request: + Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash, + timings: + Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash, type: Symbol ).returns(T.attached_class) end @@ -77,10 +85,10 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data, - request: Imagekit::VideoTransformationReadyEvent::Request, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data, + request: Imagekit::VideoTransformationReadyWebhookEvent::Request, type: Symbol, - timings: Imagekit::VideoTransformationReadyEvent::Timings + timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings } ) end @@ -91,39 +99,45 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data, + Imagekit::VideoTransformationReadyWebhookEvent::Data, Imagekit::Internal::AnyHash ) end - sig { returns(Imagekit::VideoTransformationReadyEvent::Data::Asset) } + sig do + returns(Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset) + end attr_reader :asset sig do params( - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset::OrHash + asset: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do - returns(Imagekit::VideoTransformationReadyEvent::Data::Transformation) + returns( + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + ) end attr_reader :transformation sig do params( transformation: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::OrHash ).void end attr_writer :transformation sig do params( - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset::OrHash, + asset: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -132,9 +146,10 @@ module Imagekit sig do override.returns( { - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, + asset: + Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, transformation: - Imagekit::VideoTransformationReadyEvent::Data::Transformation + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation } ) end @@ -145,7 +160,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Asset, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -170,14 +185,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Transformation, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -185,7 +200,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options ) ) end @@ -194,7 +209,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -202,7 +217,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output ) ) end @@ -211,7 +226,7 @@ module Imagekit sig do params( output: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::OrHash ).void end attr_writer :output @@ -219,11 +234,11 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::OrSymbol, options: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::OrHash, output: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::OrHash ).returns(T.attached_class) end def self.new(type:, options: nil, output: nil) @@ -233,11 +248,11 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol, options: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, output: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output } ) end @@ -251,7 +266,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -259,23 +274,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -287,7 +302,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -295,7 +310,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -304,7 +319,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -318,7 +333,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -327,7 +342,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -341,7 +356,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -350,7 +365,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -364,7 +379,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -373,7 +388,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -381,16 +396,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -408,16 +423,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -431,7 +446,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -439,18 +454,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -465,7 +480,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -473,33 +488,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -514,7 +529,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -522,18 +537,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -548,7 +563,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -556,18 +571,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -580,7 +595,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output, Imagekit::Internal::AnyHash ) end @@ -591,7 +606,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata ) ) end @@ -600,7 +615,7 @@ module Imagekit sig do params( video_metadata: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata::OrHash ).void end attr_writer :video_metadata @@ -609,7 +624,7 @@ module Imagekit params( url: String, video_metadata: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata::OrHash ).returns(T.attached_class) end def self.new(url:, video_metadata: nil) @@ -620,7 +635,7 @@ module Imagekit { url: String, video_metadata: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata } ) end @@ -631,7 +646,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata, Imagekit::Internal::AnyHash ) end @@ -680,7 +695,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Request, + Imagekit::VideoTransformationReadyWebhookEvent::Request, Imagekit::Internal::AnyHash ) end @@ -728,7 +743,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Timings, + Imagekit::VideoTransformationReadyWebhookEvent::Timings, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index d9657c78..9d1db383 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -162,8 +162,8 @@ module Imagekit # 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 `expiration` - # from your secure backend using private API. + # 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. # diff --git a/rbi/imagekit/resources/webhooks.rbi b/rbi/imagekit/resources/webhooks.rbi index 05c1e68b..dbb2ddc0 100644 --- a/rbi/imagekit/resources/webhooks.rbi +++ b/rbi/imagekit/resources/webhooks.rbi @@ -6,9 +6,9 @@ module Imagekit sig do params(payload: String).returns( T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationErrorWebhookEvent ) ) end @@ -21,9 +21,9 @@ module Imagekit sig do params(payload: String).returns( T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationErrorWebhookEvent ) ) end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 1ceb33fc..3dfdb265 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -55,11 +55,11 @@ module Imagekit module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - class VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent + class VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent - class VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent + class VideoTransformationErrorWebhookEvent = Imagekit::Models::VideoTransformationErrorWebhookEvent - class VideoTransformationReadyEvent = Imagekit::Models::VideoTransformationReadyEvent + class VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent class WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs index 0a683e9d..04a9fefb 100644 --- a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs @@ -1,9 +1,9 @@ module Imagekit module Models type unsafe_unwrap_webhook_event = - Imagekit::VideoTransformationAcceptedEvent - | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationAcceptedWebhookEvent + | Imagekit::VideoTransformationReadyWebhookEvent + | Imagekit::VideoTransformationErrorWebhookEvent module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/unwrap_webhook_event.rbs b/sig/imagekit/models/unwrap_webhook_event.rbs index c3224e6d..b9101a5f 100644 --- a/sig/imagekit/models/unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unwrap_webhook_event.rbs @@ -1,9 +1,9 @@ module Imagekit module Models type unwrap_webhook_event = - Imagekit::VideoTransformationAcceptedEvent - | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationAcceptedWebhookEvent + | Imagekit::VideoTransformationReadyWebhookEvent + | Imagekit::VideoTransformationErrorWebhookEvent module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/video_transformation_accepted_event.rbs b/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs similarity index 55% rename from sig/imagekit/models/video_transformation_accepted_event.rbs rename to sig/imagekit/models/video_transformation_accepted_webhook_event.rbs index c1e84f58..2e9ad468 100644 --- a/sig/imagekit/models/video_transformation_accepted_event.rbs +++ b/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs @@ -1,60 +1,60 @@ module Imagekit module Models - type video_transformation_accepted_event = + type video_transformation_accepted_webhook_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data, - request: Imagekit::VideoTransformationAcceptedEvent::Request, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, type: :"video.transformation.accepted" } - class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationAcceptedEvent::Data + attr_accessor data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data - attr_accessor request: Imagekit::VideoTransformationAcceptedEvent::Request + attr_accessor request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request attr_accessor type: :"video.transformation.accepted" def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data, - request: Imagekit::VideoTransformationAcceptedEvent::Request, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, ?type: :"video.transformation.accepted" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data, - request: Imagekit::VideoTransformationAcceptedEvent::Request, + data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, type: :"video.transformation.accepted" } type data = { - asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation } type asset = { url: String } @@ -69,27 +69,27 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_ - attr_reader options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options def initialize: ( - type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, - ?options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, + ?options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options } type type_ = @@ -102,75 +102,75 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_] end type options = { - audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -181,7 +181,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -195,7 +195,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -206,7 +206,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -217,7 +217,7 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec] end end end diff --git a/sig/imagekit/models/video_transformation_error_event.rbs b/sig/imagekit/models/video_transformation_error_webhook_event.rbs similarity index 54% rename from sig/imagekit/models/video_transformation_error_event.rbs rename to sig/imagekit/models/video_transformation_error_webhook_event.rbs index f0a40b5a..4eada151 100644 --- a/sig/imagekit/models/video_transformation_error_event.rbs +++ b/sig/imagekit/models/video_transformation_error_webhook_event.rbs @@ -1,60 +1,60 @@ module Imagekit module Models - type video_transformation_error_event = + type video_transformation_error_webhook_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data, - request: Imagekit::VideoTransformationErrorEvent::Request, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data, + request: Imagekit::VideoTransformationErrorWebhookEvent::Request, type: :"video.transformation.error" } - class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationErrorEvent::Data + attr_accessor data: Imagekit::VideoTransformationErrorWebhookEvent::Data - attr_accessor request: Imagekit::VideoTransformationErrorEvent::Request + attr_accessor request: Imagekit::VideoTransformationErrorWebhookEvent::Request attr_accessor type: :"video.transformation.error" def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data, - request: Imagekit::VideoTransformationErrorEvent::Request, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data, + request: Imagekit::VideoTransformationErrorWebhookEvent::Request, ?type: :"video.transformation.error" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data, - request: Imagekit::VideoTransformationErrorEvent::Request, + data: Imagekit::VideoTransformationErrorWebhookEvent::Data, + request: Imagekit::VideoTransformationErrorWebhookEvent::Request, type: :"video.transformation.error" } type data = { - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationErrorEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation } type asset = { url: String } @@ -69,36 +69,36 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, - error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, - options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, + error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_ - attr_reader error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error? + attr_reader error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error? def error=: ( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error - ) -> Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error + ) -> Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error - attr_reader options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options def initialize: ( - type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, - ?error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, - ?options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, + ?error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + ?options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, - error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, - options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, + error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options } type type_ = @@ -111,23 +111,23 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_] end type error = { - reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason } class Error < Imagekit::Internal::Type::BaseModel - attr_accessor reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason + attr_accessor reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason def initialize: ( - reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason ) -> void def to_hash: -> { - reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason } type reason = @@ -140,76 +140,76 @@ module Imagekit DOWNLOAD_FAILED: :download_failed INTERNAL_SERVER_ERROR: :internal_server_error - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason] end end type options = { - audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -220,7 +220,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -234,7 +234,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -245,7 +245,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -256,7 +256,7 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec] end end end diff --git a/sig/imagekit/models/video_transformation_ready_event.rbs b/sig/imagekit/models/video_transformation_ready_webhook_event.rbs similarity index 56% rename from sig/imagekit/models/video_transformation_ready_event.rbs rename to sig/imagekit/models/video_transformation_ready_webhook_event.rbs index 7af03de5..1a6a7a2c 100644 --- a/sig/imagekit/models/video_transformation_ready_event.rbs +++ b/sig/imagekit/models/video_transformation_ready_webhook_event.rbs @@ -1,69 +1,69 @@ module Imagekit module Models - type video_transformation_ready_event = + type video_transformation_ready_webhook_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data, - request: Imagekit::VideoTransformationReadyEvent::Request, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data, + request: Imagekit::VideoTransformationReadyWebhookEvent::Request, type: :"video.transformation.ready", - timings: Imagekit::VideoTransformationReadyEvent::Timings + timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings } - class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationReadyEvent::Data + attr_accessor data: Imagekit::VideoTransformationReadyWebhookEvent::Data - attr_accessor request: Imagekit::VideoTransformationReadyEvent::Request + attr_accessor request: Imagekit::VideoTransformationReadyWebhookEvent::Request attr_accessor type: :"video.transformation.ready" - attr_reader timings: Imagekit::VideoTransformationReadyEvent::Timings? + attr_reader timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings? def timings=: ( - Imagekit::VideoTransformationReadyEvent::Timings - ) -> Imagekit::VideoTransformationReadyEvent::Timings + Imagekit::VideoTransformationReadyWebhookEvent::Timings + ) -> Imagekit::VideoTransformationReadyWebhookEvent::Timings def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data, - request: Imagekit::VideoTransformationReadyEvent::Request, - ?timings: Imagekit::VideoTransformationReadyEvent::Timings, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data, + request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + ?timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings, ?type: :"video.transformation.ready" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data, - request: Imagekit::VideoTransformationReadyEvent::Request, + data: Imagekit::VideoTransformationReadyWebhookEvent::Data, + request: Imagekit::VideoTransformationReadyWebhookEvent::Request, type: :"video.transformation.ready", - timings: Imagekit::VideoTransformationReadyEvent::Timings + timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings } type data = { - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationReadyEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation } type asset = { url: String } @@ -78,36 +78,36 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, - output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_ - attr_reader options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options - attr_reader output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output? + attr_reader output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output? def output=: ( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output - ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output def initialize: ( - type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, - ?options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, - ?output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, + ?options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + ?output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, - output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output } type type_ = @@ -120,75 +120,75 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_] end type options = { - audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -199,7 +199,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -213,7 +213,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -224,7 +224,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -235,33 +235,33 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec] end end type output = { url: String, - video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata } class Output < Imagekit::Internal::Type::BaseModel attr_accessor url: String - attr_reader video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata? + attr_reader video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata? def video_metadata=: ( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata - ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata def initialize: ( url: String, - ?video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + ?video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata ) -> void def to_hash: -> { url: String, - video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata } type video_metadata = diff --git a/sig/imagekit/resources/webhooks.rbs b/sig/imagekit/resources/webhooks.rbs index d0ffe5de..703798fe 100644 --- a/sig/imagekit/resources/webhooks.rbs +++ b/sig/imagekit/resources/webhooks.rbs @@ -3,15 +3,15 @@ module Imagekit class Webhooks def unsafe_unwrap: ( String payload - ) -> (Imagekit::VideoTransformationAcceptedEvent - | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent) + ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent + | Imagekit::VideoTransformationReadyWebhookEvent + | Imagekit::VideoTransformationErrorWebhookEvent) def unwrap: ( String payload - ) -> (Imagekit::VideoTransformationAcceptedEvent - | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent) + ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent + | Imagekit::VideoTransformationReadyWebhookEvent + | Imagekit::VideoTransformationErrorWebhookEvent) def initialize: (client: Imagekit::Client) -> void end From b6f0d1705cbca5ef33a58dd90fa384e7f501e02d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 05:11:33 +0000 Subject: [PATCH 069/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 9 +- lib/imagekit/models.rb | 6 +- .../models/unsafe_unwrap_webhook_event.rb | 8 +- lib/imagekit/models/unwrap_webhook_event.rb | 8 +- ...=> video_transformation_accepted_event.rb} | 82 ++++---- ...rb => video_transformation_error_event.rb} | 98 +++++----- ...rb => video_transformation_ready_event.rb} | 106 +++++----- lib/imagekit/resources/webhooks.rb | 4 +- rbi/imagekit/models.rbi | 12 +- .../models/unsafe_unwrap_webhook_event.rbi | 6 +- rbi/imagekit/models/unwrap_webhook_event.rbi | 6 +- ...> video_transformation_accepted_event.rbi} | 149 +++++++------- ...i => video_transformation_error_event.rbi} | 177 ++++++++--------- ...i => video_transformation_ready_event.rbi} | 185 ++++++++---------- rbi/imagekit/resources/webhooks.rbi | 12 +- sig/imagekit/models.rbs | 6 +- .../models/unsafe_unwrap_webhook_event.rbs | 6 +- sig/imagekit/models/unwrap_webhook_event.rbs | 6 +- ...> video_transformation_accepted_event.rbs} | 114 +++++------ ...s => video_transformation_error_event.rbs} | 136 ++++++------- ...s => video_transformation_ready_event.rbs} | 150 +++++++------- sig/imagekit/resources/webhooks.rbs | 12 +- 23 files changed, 631 insertions(+), 669 deletions(-) rename lib/imagekit/models/{video_transformation_accepted_webhook_event.rb => video_transformation_accepted_event.rb} (74%) rename lib/imagekit/models/{video_transformation_error_webhook_event.rb => video_transformation_error_event.rb} (68%) rename lib/imagekit/models/{video_transformation_ready_webhook_event.rb => video_transformation_ready_event.rb} (70%) rename rbi/imagekit/models/{video_transformation_accepted_webhook_event.rbi => video_transformation_accepted_event.rbi} (60%) rename rbi/imagekit/models/{video_transformation_error_webhook_event.rbi => video_transformation_error_event.rbi} (60%) rename rbi/imagekit/models/{video_transformation_ready_webhook_event.rbi => video_transformation_ready_event.rbi} (63%) rename sig/imagekit/models/{video_transformation_accepted_webhook_event.rbs => video_transformation_accepted_event.rbs} (55%) rename sig/imagekit/models/{video_transformation_error_webhook_event.rbs => video_transformation_error_event.rbs} (54%) rename sig/imagekit/models/{video_transformation_ready_webhook_event.rbs => video_transformation_ready_event.rbs} (56%) diff --git a/.stats.yml b/.stats.yml index 2ec886b7..f8ab83a1 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-863564701f791fdf016f7321fce445de5e368c474b06b135aaac16214f4f6416.yml openapi_spec_hash: e3bb05601081de07084edf79cf3a2d63 -config_hash: 4947aef92e0f986b21a473329de4a647 +config_hash: d6fc50026fa9ef4b444d43c07c2c70a6 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 11290951..fca54b76 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -128,12 +128,9 @@ require_relative "imagekit/models/metadata" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" -require_relative "imagekit/models/video_transformation_accepted_webhook_event" -require_relative "imagekit/models/video_transformation_accepted_webhook_event" -require_relative "imagekit/models/video_transformation_error_webhook_event" -require_relative "imagekit/models/video_transformation_error_webhook_event" -require_relative "imagekit/models/video_transformation_ready_webhook_event" -require_relative "imagekit/models/video_transformation_ready_webhook_event" +require_relative "imagekit/models/video_transformation_accepted_event" +require_relative "imagekit/models/video_transformation_error_event" +require_relative "imagekit/models/video_transformation_ready_event" require_relative "imagekit/models/webhook_unsafe_unwrap_params" require_relative "imagekit/models/webhook_unwrap_params" require_relative "imagekit/models" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 9f4e5bd6..e5d19dc3 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -95,11 +95,11 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent + VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent - VideoTransformationErrorWebhookEvent = Imagekit::Models::VideoTransformationErrorWebhookEvent + VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent - VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + VideoTransformationReadyEvent = Imagekit::Models::VideoTransformationReadyEvent WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb index 5b7cab93..c86439e5 100644 --- a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb @@ -5,14 +5,14 @@ module Models module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union - variant -> { Imagekit::VideoTransformationAcceptedWebhookEvent } + variant -> { Imagekit::VideoTransformationAcceptedEvent } - variant -> { Imagekit::VideoTransformationReadyWebhookEvent } + variant -> { Imagekit::VideoTransformationReadyEvent } - variant -> { Imagekit::VideoTransformationErrorWebhookEvent } + variant -> { Imagekit::VideoTransformationErrorEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent)] end end end diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb index be01dd2a..1a570019 100644 --- a/lib/imagekit/models/unwrap_webhook_event.rb +++ b/lib/imagekit/models/unwrap_webhook_event.rb @@ -5,14 +5,14 @@ module Models module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union - variant -> { Imagekit::VideoTransformationAcceptedWebhookEvent } + variant -> { Imagekit::VideoTransformationAcceptedEvent } - variant -> { Imagekit::VideoTransformationReadyWebhookEvent } + variant -> { Imagekit::VideoTransformationReadyEvent } - variant -> { Imagekit::VideoTransformationErrorWebhookEvent } + variant -> { Imagekit::VideoTransformationErrorEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent)] end end end diff --git a/lib/imagekit/models/video_transformation_accepted_webhook_event.rb b/lib/imagekit/models/video_transformation_accepted_event.rb similarity index 74% rename from lib/imagekit/models/video_transformation_accepted_webhook_event.rb rename to lib/imagekit/models/video_transformation_accepted_event.rb index 4b238162..fc8eaec5 100644 --- a/lib/imagekit/models/video_transformation_accepted_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_accepted_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseMo # @!attribute data # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data] - required :data, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data] + required :data, -> { Imagekit::VideoTransformationAcceptedEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] - required :request, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Request } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Request] + required :request, -> { Imagekit::VideoTransformationAcceptedEvent::Request } # @!attribute type # @@ -34,29 +34,29 @@ class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseMo # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data] + # @param data [Imagekit::Models::VideoTransformationAcceptedEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Request] + # @param request [Imagekit::Models::VideoTransformationAcceptedEvent::Request] # # @param type [Symbol, :"video.transformation.accepted"] - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#data + # @see Imagekit::Models::VideoTransformationAcceptedEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data#asset + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -68,23 +68,23 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } # @!method initialize(type:, options: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type] - # @param options [Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options] + # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] + # @param options [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options] - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -96,13 +96,13 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -111,10 +111,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format }, api_name: :format @@ -125,9 +125,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -136,20 +136,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -160,7 +160,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -174,7 +174,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -185,7 +185,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -199,7 +199,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationAcceptedWebhookEvent#request + # @see Imagekit::Models::VideoTransformationAcceptedEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. diff --git a/lib/imagekit/models/video_transformation_error_webhook_event.rb b/lib/imagekit/models/video_transformation_error_event.rb similarity index 68% rename from lib/imagekit/models/video_transformation_error_webhook_event.rb rename to lib/imagekit/models/video_transformation_error_event.rb index c639c0a7..5b199f18 100644 --- a/lib/imagekit/models/video_transformation_error_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_error_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data] - required :data, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data] + required :data, -> { Imagekit::VideoTransformationErrorEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] - required :request, -> { Imagekit::VideoTransformationErrorWebhookEvent::Request } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Request] + required :request, -> { Imagekit::VideoTransformationErrorEvent::Request } # @!attribute type # @@ -34,29 +34,29 @@ class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data] + # @param data [Imagekit::Models::VideoTransformationErrorEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationErrorWebhookEvent::Request] + # @param request [Imagekit::Models::VideoTransformationErrorEvent::Request] # # @param type [Symbol, :"video.transformation.error"] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#data + # @see Imagekit::Models::VideoTransformationErrorEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationErrorEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data#asset + # @see Imagekit::Models::VideoTransformationErrorEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -68,29 +68,29 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationErrorEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type } # @!attribute error # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, nil] - optional :error, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error, nil] + optional :error, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } # @!method initialize(type:, error: nil, options: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Type] - # @param error [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error] - # @param options [Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options] + # @param type [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] + # @param error [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error] + # @param options [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -102,18 +102,18 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#error + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#error class Error < Imagekit::Internal::Type::BaseModel # @!attribute reason # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] required :reason, - enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason } + enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason } # @!method initialize(reason:) - # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason] + # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error#reason + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error#reason module Reason extend Imagekit::Internal::Type::Enum @@ -126,13 +126,13 @@ module Reason end end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -141,10 +141,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format }, api_name: :format @@ -155,9 +155,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -166,20 +166,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -190,7 +190,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -204,7 +204,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -215,7 +215,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -229,7 +229,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationErrorWebhookEvent#request + # @see Imagekit::Models::VideoTransformationErrorEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. diff --git a/lib/imagekit/models/video_transformation_ready_webhook_event.rb b/lib/imagekit/models/video_transformation_ready_event.rb similarity index 70% rename from lib/imagekit/models/video_transformation_ready_webhook_event.rb rename to lib/imagekit/models/video_transformation_ready_event.rb index 812ea710..5e6d463b 100644 --- a/lib/imagekit/models/video_transformation_ready_webhook_event.rb +++ b/lib/imagekit/models/video_transformation_ready_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -16,13 +16,13 @@ class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data] - required :data, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data] + required :data, -> { Imagekit::VideoTransformationReadyEvent::Data } # @!attribute request # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] - required :request, -> { Imagekit::VideoTransformationReadyWebhookEvent::Request } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Request] + required :request, -> { Imagekit::VideoTransformationReadyEvent::Request } # @!attribute type # @@ -31,39 +31,39 @@ class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute timings # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings, nil] - optional :timings, -> { Imagekit::VideoTransformationReadyWebhookEvent::Timings } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Timings, nil] + optional :timings, -> { Imagekit::VideoTransformationReadyEvent::Timings } # @!method initialize(id:, created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") # @param id [String] Unique identifier for the event. # # @param created_at [Time] # - # @param data [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data] + # @param data [Imagekit::Models::VideoTransformationReadyEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationReadyWebhookEvent::Request] + # @param request [Imagekit::Models::VideoTransformationReadyEvent::Request] # - # @param timings [Imagekit::Models::VideoTransformationReadyWebhookEvent::Timings] + # @param timings [Imagekit::Models::VideoTransformationReadyEvent::Timings] # # @param type [Symbol, :"video.transformation.ready"] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#data + # @see Imagekit::Models::VideoTransformationReadyEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] + required :asset, -> { Imagekit::VideoTransformationReadyEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] + required :transformation, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] + # @param transformation [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data#asset + # @see Imagekit::Models::VideoTransformationReadyEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url # Source asset URL. @@ -75,29 +75,29 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] Source asset URL. end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data#transformation + # @see Imagekit::Models::VideoTransformationReadyEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type } + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type } # @!attribute options # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options } # @!attribute output # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output, nil] - optional :output, -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output } + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output, nil] + optional :output, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } # @!method initialize(type:, options: nil, output: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Type] - # @param options [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options] - # @param output [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output] + # @param type [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] + # @param options [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options] + # @param output [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#type + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -109,13 +109,13 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#options + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # @@ -124,10 +124,10 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute format_ # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format }, api_name: :format @@ -138,9 +138,9 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # @@ -149,20 +149,20 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute video_codec # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec] + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec] # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format] + # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format] # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol] + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol] # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec] + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#audio_codec + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -173,7 +173,7 @@ module AudioCodec # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#format_ + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -187,7 +187,7 @@ module Format # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#stream_protocol + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -198,7 +198,7 @@ module StreamProtocol # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options#video_codec + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -210,7 +210,7 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation#output + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#output class Output < Imagekit::Internal::Type::BaseModel # @!attribute url # @@ -219,15 +219,15 @@ class Output < Imagekit::Internal::Type::BaseModel # @!attribute video_metadata # - # @return [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata, nil] + # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, nil] optional :video_metadata, - -> { Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata } + -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } # @!method initialize(url:, video_metadata: nil) # @param url [String] - # @param video_metadata [Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata] + # @param video_metadata [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata] - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Output#video_metadata + # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output#video_metadata class VideoMetadata < Imagekit::Internal::Type::BaseModel # @!attribute bitrate # @@ -259,7 +259,7 @@ class VideoMetadata < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#request + # @see Imagekit::Models::VideoTransformationReadyEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # URL of the submitted request. @@ -287,7 +287,7 @@ class Request < Imagekit::Internal::Type::BaseModel # @param user_agent [String] User-Agent header of the originating request. end - # @see Imagekit::Models::VideoTransformationReadyWebhookEvent#timings + # @see Imagekit::Models::VideoTransformationReadyEvent#timings class Timings < Imagekit::Internal::Type::BaseModel # @!attribute download_duration # Milliseconds spent downloading the source. diff --git a/lib/imagekit/resources/webhooks.rb b/lib/imagekit/resources/webhooks.rb index 4c50cd1b..abc4b41e 100644 --- a/lib/imagekit/resources/webhooks.rb +++ b/lib/imagekit/resources/webhooks.rb @@ -5,7 +5,7 @@ module Resources class Webhooks # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent] def unsafe_unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnsafeUnwrapWebhookEvent, parsed) @@ -13,7 +13,7 @@ def unsafe_unwrap(payload) # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedWebhookEvent, Imagekit::Models::VideoTransformationReadyWebhookEvent, Imagekit::Models::VideoTransformationErrorWebhookEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent] def unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnwrapWebhookEvent, parsed) diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 90c72e54..ba4b9b2b 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -61,14 +61,14 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - VideoTransformationAcceptedWebhookEvent = - Imagekit::Models::VideoTransformationAcceptedWebhookEvent + VideoTransformationAcceptedEvent = + Imagekit::Models::VideoTransformationAcceptedEvent - VideoTransformationErrorWebhookEvent = - Imagekit::Models::VideoTransformationErrorWebhookEvent + VideoTransformationErrorEvent = + Imagekit::Models::VideoTransformationErrorEvent - VideoTransformationReadyWebhookEvent = - Imagekit::Models::VideoTransformationReadyWebhookEvent + VideoTransformationReadyEvent = + Imagekit::Models::VideoTransformationReadyEvent WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi index d9881aea..e4fe5870 100644 --- a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi @@ -8,9 +8,9 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, - Imagekit::VideoTransformationReadyWebhookEvent, - Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationErrorEvent ) end diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi index 457c223b..d2d814d5 100644 --- a/rbi/imagekit/models/unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unwrap_webhook_event.rbi @@ -8,9 +8,9 @@ module Imagekit Variants = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, - Imagekit::VideoTransformationReadyWebhookEvent, - Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationErrorEvent ) end diff --git a/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi b/rbi/imagekit/models/video_transformation_accepted_event.rbi similarity index 60% rename from rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi rename to rbi/imagekit/models/video_transformation_accepted_event.rbi index 5433ace6..3e0a9e1b 100644 --- a/rbi/imagekit/models/video_transformation_accepted_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_accepted_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, + Imagekit::VideoTransformationAcceptedEvent, Imagekit::Internal::AnyHash ) end @@ -18,25 +18,22 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationAcceptedWebhookEvent::Data) } + sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data) } attr_reader :data sig do params( - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash + data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash ).void end attr_writer :data - sig do - returns(Imagekit::VideoTransformationAcceptedWebhookEvent::Request) - end + sig { returns(Imagekit::VideoTransformationAcceptedEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash + request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash ).void end attr_writer :request @@ -48,9 +45,8 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::OrHash, - request: - Imagekit::VideoTransformationAcceptedWebhookEvent::Request::OrHash, + data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash, + request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -69,8 +65,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, - request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + data: Imagekit::VideoTransformationAcceptedEvent::Data, + request: Imagekit::VideoTransformationAcceptedEvent::Request, type: Symbol } ) @@ -82,29 +78,25 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data, + Imagekit::VideoTransformationAcceptedEvent::Data, Imagekit::Internal::AnyHash ) end - sig do - returns( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset - ) - end + sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data::Asset) } attr_reader :asset sig do params( asset: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do returns( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation ) end attr_reader :transformation @@ -112,7 +104,7 @@ module Imagekit sig do params( transformation: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash ).void end attr_writer :transformation @@ -120,9 +112,9 @@ module Imagekit sig do params( asset: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset::OrHash, + Imagekit::VideoTransformationAcceptedEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -131,10 +123,9 @@ module Imagekit sig do override.returns( { - asset: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, transformation: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } ) end @@ -145,7 +136,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, + Imagekit::VideoTransformationAcceptedEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -170,14 +161,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -185,7 +176,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options ) ) end @@ -194,7 +185,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -202,9 +193,9 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::OrSymbol, options: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end def self.new(type:, options: nil) @@ -214,9 +205,9 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol, options: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } ) end @@ -230,7 +221,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -238,23 +229,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -266,7 +257,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -274,7 +265,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -283,7 +274,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -297,7 +288,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -306,7 +297,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -320,7 +311,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -329,7 +320,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -343,7 +334,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -352,7 +343,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -360,16 +351,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -387,16 +378,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -410,7 +401,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -418,18 +409,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -444,7 +435,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -452,33 +443,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -493,7 +484,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -501,18 +492,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -527,7 +518,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -535,18 +526,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -561,7 +552,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + Imagekit::VideoTransformationAcceptedEvent::Request, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_transformation_error_webhook_event.rbi b/rbi/imagekit/models/video_transformation_error_event.rbi similarity index 60% rename from rbi/imagekit/models/video_transformation_error_webhook_event.rbi rename to rbi/imagekit/models/video_transformation_error_event.rbi index dc3438bf..1f6f27bb 100644 --- a/rbi/imagekit/models/video_transformation_error_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_error_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent, + Imagekit::VideoTransformationErrorEvent, Imagekit::Internal::AnyHash ) end @@ -18,23 +18,20 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationErrorWebhookEvent::Data) } + sig { returns(Imagekit::VideoTransformationErrorEvent::Data) } attr_reader :data sig do - params( - data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash - ).void + params(data: Imagekit::VideoTransformationErrorEvent::Data::OrHash).void end attr_writer :data - sig { returns(Imagekit::VideoTransformationErrorWebhookEvent::Request) } + sig { returns(Imagekit::VideoTransformationErrorEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash + request: Imagekit::VideoTransformationErrorEvent::Request::OrHash ).void end attr_writer :request @@ -46,9 +43,8 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data::OrHash, - request: - Imagekit::VideoTransformationErrorWebhookEvent::Request::OrHash, + data: Imagekit::VideoTransformationErrorEvent::Data::OrHash, + request: Imagekit::VideoTransformationErrorEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -67,8 +63,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data, - request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + data: Imagekit::VideoTransformationErrorEvent::Data, + request: Imagekit::VideoTransformationErrorEvent::Request, type: Symbol } ) @@ -80,45 +76,39 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data, + Imagekit::VideoTransformationErrorEvent::Data, Imagekit::Internal::AnyHash ) end - sig do - returns(Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset) - end + sig { returns(Imagekit::VideoTransformationErrorEvent::Data::Asset) } attr_reader :asset sig do params( - asset: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset::OrHash + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do - returns( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation - ) + returns(Imagekit::VideoTransformationErrorEvent::Data::Transformation) end attr_reader :transformation sig do params( transformation: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash ).void end attr_writer :transformation sig do params( - asset: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset::OrHash, + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -127,10 +117,9 @@ module Imagekit sig do override.returns( { - asset: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, transformation: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + Imagekit::VideoTransformationErrorEvent::Data::Transformation } ) end @@ -141,7 +130,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, + Imagekit::VideoTransformationErrorEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -166,14 +155,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation, + Imagekit::VideoTransformationErrorEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -181,7 +170,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error ) ) end @@ -190,7 +179,7 @@ module Imagekit sig do params( error: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash ).void end attr_writer :error @@ -198,7 +187,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options ) ) end @@ -207,7 +196,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -215,11 +204,11 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::OrSymbol, error: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::OrHash, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash, options: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end def self.new(type:, error: nil, options: nil) @@ -229,11 +218,11 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol, error: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, options: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } ) end @@ -247,7 +236,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -255,23 +244,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -283,14 +272,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) end attr_accessor :reason @@ -298,7 +287,7 @@ module Imagekit sig do params( reason: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::OrSymbol ).returns(T.attached_class) end def self.new(reason:) @@ -308,7 +297,7 @@ module Imagekit override.returns( { reason: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol } ) end @@ -322,7 +311,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -330,23 +319,23 @@ module Imagekit ENCODING_FAILED = T.let( :encoding_failed, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) DOWNLOAD_FAILED = T.let( :download_failed, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) INTERNAL_SERVER_ERROR = T.let( :internal_server_error, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ] ) end @@ -359,7 +348,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -367,7 +356,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -376,7 +365,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -390,7 +379,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -399,7 +388,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -413,7 +402,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -422,7 +411,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -436,7 +425,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -445,7 +434,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -453,16 +442,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -480,16 +469,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -503,7 +492,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -511,18 +500,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -537,7 +526,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -545,33 +534,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -586,7 +575,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -594,18 +583,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -620,7 +609,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -628,18 +617,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -654,7 +643,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorWebhookEvent::Request, + Imagekit::VideoTransformationErrorEvent::Request, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi b/rbi/imagekit/models/video_transformation_ready_event.rbi similarity index 63% rename from rbi/imagekit/models/video_transformation_ready_webhook_event.rbi rename to rbi/imagekit/models/video_transformation_ready_event.rbi index 406bcf19..15b4c135 100644 --- a/rbi/imagekit/models/video_transformation_ready_webhook_event.rbi +++ b/rbi/imagekit/models/video_transformation_ready_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent, + Imagekit::VideoTransformationReadyEvent, Imagekit::Internal::AnyHash ) end @@ -18,23 +18,20 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationReadyWebhookEvent::Data) } + sig { returns(Imagekit::VideoTransformationReadyEvent::Data) } attr_reader :data sig do - params( - data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash - ).void + params(data: Imagekit::VideoTransformationReadyEvent::Data::OrHash).void end attr_writer :data - sig { returns(Imagekit::VideoTransformationReadyWebhookEvent::Request) } + sig { returns(Imagekit::VideoTransformationReadyEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash + request: Imagekit::VideoTransformationReadyEvent::Request::OrHash ).void end attr_writer :request @@ -43,16 +40,13 @@ module Imagekit attr_accessor :type sig do - returns( - T.nilable(Imagekit::VideoTransformationReadyWebhookEvent::Timings) - ) + returns(T.nilable(Imagekit::VideoTransformationReadyEvent::Timings)) end attr_reader :timings sig do params( - timings: - Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash + timings: Imagekit::VideoTransformationReadyEvent::Timings::OrHash ).void end attr_writer :timings @@ -61,11 +55,9 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data::OrHash, - request: - Imagekit::VideoTransformationReadyWebhookEvent::Request::OrHash, - timings: - Imagekit::VideoTransformationReadyWebhookEvent::Timings::OrHash, + data: Imagekit::VideoTransformationReadyEvent::Data::OrHash, + request: Imagekit::VideoTransformationReadyEvent::Request::OrHash, + timings: Imagekit::VideoTransformationReadyEvent::Timings::OrHash, type: Symbol ).returns(T.attached_class) end @@ -85,10 +77,10 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data, - request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + data: Imagekit::VideoTransformationReadyEvent::Data, + request: Imagekit::VideoTransformationReadyEvent::Request, type: Symbol, - timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + timings: Imagekit::VideoTransformationReadyEvent::Timings } ) end @@ -99,45 +91,39 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data, + Imagekit::VideoTransformationReadyEvent::Data, Imagekit::Internal::AnyHash ) end - sig do - returns(Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset) - end + sig { returns(Imagekit::VideoTransformationReadyEvent::Data::Asset) } attr_reader :asset sig do params( - asset: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset::OrHash + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do - returns( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation - ) + returns(Imagekit::VideoTransformationReadyEvent::Data::Transformation) end attr_reader :transformation sig do params( transformation: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash ).void end attr_writer :transformation sig do params( - asset: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset::OrHash, + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new(asset:, transformation:) @@ -146,10 +132,9 @@ module Imagekit sig do override.returns( { - asset: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, transformation: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + Imagekit::VideoTransformationReadyEvent::Data::Transformation } ) end @@ -160,7 +145,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, + Imagekit::VideoTransformationReadyEvent::Data::Asset, Imagekit::Internal::AnyHash ) end @@ -185,14 +170,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation, + Imagekit::VideoTransformationReadyEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -200,7 +185,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options ) ) end @@ -209,7 +194,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -217,7 +202,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output ) ) end @@ -226,7 +211,7 @@ module Imagekit sig do params( output: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash ).void end attr_writer :output @@ -234,11 +219,11 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::OrSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::OrSymbol, options: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::OrHash, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash, output: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash ).returns(T.attached_class) end def self.new(type:, options: nil, output: nil) @@ -248,11 +233,11 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol, options: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, output: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } ) end @@ -266,7 +251,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -274,23 +259,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Type::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -302,7 +287,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, Imagekit::Internal::AnyHash ) end @@ -310,7 +295,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -319,7 +304,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -333,7 +318,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -342,7 +327,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -356,7 +341,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -365,7 +350,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -379,7 +364,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -388,7 +373,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -396,16 +381,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -423,16 +408,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -446,7 +431,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -454,18 +439,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -480,7 +465,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -488,33 +473,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -529,7 +514,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -537,18 +522,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -563,7 +548,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -571,18 +556,18 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -595,7 +580,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output, Imagekit::Internal::AnyHash ) end @@ -606,7 +591,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata ) ) end @@ -615,7 +600,7 @@ module Imagekit sig do params( video_metadata: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash ).void end attr_writer :video_metadata @@ -624,7 +609,7 @@ module Imagekit params( url: String, video_metadata: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata::OrHash + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash ).returns(T.attached_class) end def self.new(url:, video_metadata: nil) @@ -635,7 +620,7 @@ module Imagekit { url: String, video_metadata: - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } ) end @@ -646,7 +631,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, Imagekit::Internal::AnyHash ) end @@ -695,7 +680,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Request, + Imagekit::VideoTransformationReadyEvent::Request, Imagekit::Internal::AnyHash ) end @@ -743,7 +728,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyWebhookEvent::Timings, + Imagekit::VideoTransformationReadyEvent::Timings, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/resources/webhooks.rbi b/rbi/imagekit/resources/webhooks.rbi index dbb2ddc0..05c1e68b 100644 --- a/rbi/imagekit/resources/webhooks.rbi +++ b/rbi/imagekit/resources/webhooks.rbi @@ -6,9 +6,9 @@ module Imagekit sig do params(payload: String).returns( T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, - Imagekit::VideoTransformationReadyWebhookEvent, - Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationErrorEvent ) ) end @@ -21,9 +21,9 @@ module Imagekit sig do params(payload: String).returns( T.any( - Imagekit::VideoTransformationAcceptedWebhookEvent, - Imagekit::VideoTransformationReadyWebhookEvent, - Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent, + Imagekit::VideoTransformationReadyEvent, + Imagekit::VideoTransformationErrorEvent ) ) end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 3dfdb265..1ceb33fc 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -55,11 +55,11 @@ module Imagekit module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - class VideoTransformationAcceptedWebhookEvent = Imagekit::Models::VideoTransformationAcceptedWebhookEvent + class VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent - class VideoTransformationErrorWebhookEvent = Imagekit::Models::VideoTransformationErrorWebhookEvent + class VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent - class VideoTransformationReadyWebhookEvent = Imagekit::Models::VideoTransformationReadyWebhookEvent + class VideoTransformationReadyEvent = Imagekit::Models::VideoTransformationReadyEvent class WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams diff --git a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs index 04a9fefb..0a683e9d 100644 --- a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs @@ -1,9 +1,9 @@ module Imagekit module Models type unsafe_unwrap_webhook_event = - Imagekit::VideoTransformationAcceptedWebhookEvent - | Imagekit::VideoTransformationReadyWebhookEvent - | Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent + | Imagekit::VideoTransformationReadyEvent + | Imagekit::VideoTransformationErrorEvent module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/unwrap_webhook_event.rbs b/sig/imagekit/models/unwrap_webhook_event.rbs index b9101a5f..c3224e6d 100644 --- a/sig/imagekit/models/unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unwrap_webhook_event.rbs @@ -1,9 +1,9 @@ module Imagekit module Models type unwrap_webhook_event = - Imagekit::VideoTransformationAcceptedWebhookEvent - | Imagekit::VideoTransformationReadyWebhookEvent - | Imagekit::VideoTransformationErrorWebhookEvent + Imagekit::VideoTransformationAcceptedEvent + | Imagekit::VideoTransformationReadyEvent + | Imagekit::VideoTransformationErrorEvent module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs b/sig/imagekit/models/video_transformation_accepted_event.rbs similarity index 55% rename from sig/imagekit/models/video_transformation_accepted_webhook_event.rbs rename to sig/imagekit/models/video_transformation_accepted_event.rbs index 2e9ad468..c1e84f58 100644 --- a/sig/imagekit/models/video_transformation_accepted_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_accepted_event.rbs @@ -1,60 +1,60 @@ module Imagekit module Models - type video_transformation_accepted_webhook_event = + type video_transformation_accepted_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, - request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + data: Imagekit::VideoTransformationAcceptedEvent::Data, + request: Imagekit::VideoTransformationAcceptedEvent::Request, type: :"video.transformation.accepted" } - class VideoTransformationAcceptedWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data + attr_accessor data: Imagekit::VideoTransformationAcceptedEvent::Data - attr_accessor request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request + attr_accessor request: Imagekit::VideoTransformationAcceptedEvent::Request attr_accessor type: :"video.transformation.accepted" def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, - request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + data: Imagekit::VideoTransformationAcceptedEvent::Data, + request: Imagekit::VideoTransformationAcceptedEvent::Request, ?type: :"video.transformation.accepted" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationAcceptedWebhookEvent::Data, - request: Imagekit::VideoTransformationAcceptedWebhookEvent::Request, + data: Imagekit::VideoTransformationAcceptedEvent::Data, + request: Imagekit::VideoTransformationAcceptedEvent::Request, type: :"video.transformation.accepted" } type data = { - asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } type asset = { url: String } @@ -69,27 +69,27 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_ - attr_reader options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options def initialize: ( - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, - ?options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + ?options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } type type_ = @@ -102,75 +102,75 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_] end type options = { - audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -181,7 +181,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -195,7 +195,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -206,7 +206,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -217,7 +217,7 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedWebhookEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec] end end end diff --git a/sig/imagekit/models/video_transformation_error_webhook_event.rbs b/sig/imagekit/models/video_transformation_error_event.rbs similarity index 54% rename from sig/imagekit/models/video_transformation_error_webhook_event.rbs rename to sig/imagekit/models/video_transformation_error_event.rbs index 4eada151..f0a40b5a 100644 --- a/sig/imagekit/models/video_transformation_error_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_error_event.rbs @@ -1,60 +1,60 @@ module Imagekit module Models - type video_transformation_error_webhook_event = + type video_transformation_error_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data, - request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + data: Imagekit::VideoTransformationErrorEvent::Data, + request: Imagekit::VideoTransformationErrorEvent::Request, type: :"video.transformation.error" } - class VideoTransformationErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationErrorWebhookEvent::Data + attr_accessor data: Imagekit::VideoTransformationErrorEvent::Data - attr_accessor request: Imagekit::VideoTransformationErrorWebhookEvent::Request + attr_accessor request: Imagekit::VideoTransformationErrorEvent::Request attr_accessor type: :"video.transformation.error" def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data, - request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + data: Imagekit::VideoTransformationErrorEvent::Data, + request: Imagekit::VideoTransformationErrorEvent::Request, ?type: :"video.transformation.error" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationErrorWebhookEvent::Data, - request: Imagekit::VideoTransformationErrorWebhookEvent::Request, + data: Imagekit::VideoTransformationErrorEvent::Data, + request: Imagekit::VideoTransformationErrorEvent::Request, type: :"video.transformation.error" } type data = { - asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationErrorEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationErrorWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation } type asset = { url: String } @@ -69,36 +69,36 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, - error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, - options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_ - attr_reader error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error? + attr_reader error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error? def error=: ( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error - ) -> Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error + ) -> Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error - attr_reader options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options def initialize: ( - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, - ?error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, - ?options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + ?error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + ?options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_, - error: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Error, - options: Imagekit::VideoTransformationErrorWebhookEvent::Data::Transformation::Options + type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } type type_ = @@ -111,23 +111,23 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_] end type error = { - reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason } class Error < Imagekit::Internal::Type::BaseModel - attr_accessor reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + attr_accessor reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason def initialize: ( - reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason ) -> void def to_hash: -> { - reason: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason + reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason } type reason = @@ -140,76 +140,76 @@ module Imagekit DOWNLOAD_FAILED: :download_failed INTERNAL_SERVER_ERROR: :internal_server_error - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Error::reason] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason] end end type options = { - audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -220,7 +220,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -234,7 +234,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -245,7 +245,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -256,7 +256,7 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorWebhookEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec] end end end diff --git a/sig/imagekit/models/video_transformation_ready_webhook_event.rbs b/sig/imagekit/models/video_transformation_ready_event.rbs similarity index 56% rename from sig/imagekit/models/video_transformation_ready_webhook_event.rbs rename to sig/imagekit/models/video_transformation_ready_event.rbs index 1a6a7a2c..7af03de5 100644 --- a/sig/imagekit/models/video_transformation_ready_webhook_event.rbs +++ b/sig/imagekit/models/video_transformation_ready_event.rbs @@ -1,69 +1,69 @@ module Imagekit module Models - type video_transformation_ready_webhook_event = + type video_transformation_ready_event = { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data, - request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + data: Imagekit::VideoTransformationReadyEvent::Data, + request: Imagekit::VideoTransformationReadyEvent::Request, type: :"video.transformation.ready", - timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + timings: Imagekit::VideoTransformationReadyEvent::Timings } - class VideoTransformationReadyWebhookEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::VideoTransformationReadyWebhookEvent::Data + attr_accessor data: Imagekit::VideoTransformationReadyEvent::Data - attr_accessor request: Imagekit::VideoTransformationReadyWebhookEvent::Request + attr_accessor request: Imagekit::VideoTransformationReadyEvent::Request attr_accessor type: :"video.transformation.ready" - attr_reader timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings? + attr_reader timings: Imagekit::VideoTransformationReadyEvent::Timings? def timings=: ( - Imagekit::VideoTransformationReadyWebhookEvent::Timings - ) -> Imagekit::VideoTransformationReadyWebhookEvent::Timings + Imagekit::VideoTransformationReadyEvent::Timings + ) -> Imagekit::VideoTransformationReadyEvent::Timings def initialize: ( id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data, - request: Imagekit::VideoTransformationReadyWebhookEvent::Request, - ?timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings, + data: Imagekit::VideoTransformationReadyEvent::Data, + request: Imagekit::VideoTransformationReadyEvent::Request, + ?timings: Imagekit::VideoTransformationReadyEvent::Timings, ?type: :"video.transformation.ready" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::VideoTransformationReadyWebhookEvent::Data, - request: Imagekit::VideoTransformationReadyWebhookEvent::Request, + data: Imagekit::VideoTransformationReadyEvent::Data, + request: Imagekit::VideoTransformationReadyEvent::Request, type: :"video.transformation.ready", - timings: Imagekit::VideoTransformationReadyWebhookEvent::Timings + timings: Imagekit::VideoTransformationReadyEvent::Timings } type data = { - asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset + attr_accessor asset: Imagekit::VideoTransformationReadyEvent::Data::Asset - attr_accessor transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + attr_accessor transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation def initialize: ( - asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation ) -> void def to_hash: -> { - asset: Imagekit::VideoTransformationReadyWebhookEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation + asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation } type asset = { url: String } @@ -78,36 +78,36 @@ module Imagekit type transformation = { - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, - output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_ + attr_accessor type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_ - attr_reader options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options? + attr_reader options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options? def options=: ( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options + ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options - attr_reader output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output? + attr_reader output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output? def output=: ( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output - ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output def initialize: ( - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, - ?options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, - ?output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + ?options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + ?output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output ) -> void def to_hash: -> { - type: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Options, - output: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output + type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } type type_ = @@ -120,75 +120,75 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" VIDEO_THUMBNAIL: :"video-thumbnail" - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_] end type options = { - audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec } class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec? + attr_reader audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec? def audio_codec=: ( - Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec + Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec + ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec attr_reader auto_rotate: bool? def auto_rotate=: (bool) -> bool - attr_reader format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_? + attr_reader format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_? def format_=: ( - Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_ + Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ + ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ attr_reader quality: Integer? def quality=: (Integer) -> Integer - attr_reader stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol? + attr_reader stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol? def stream_protocol=: ( - Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol + Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol attr_reader variants: ::Array[String]? def variants=: (::Array[String]) -> ::Array[String] - attr_reader video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec? + attr_reader video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec? def video_codec=: ( - Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + ?audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + ?format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + ?stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + ?video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec ) -> void def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec, + audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_, + format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol, + stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec + video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec } type audio_codec = :aac | :opus @@ -199,7 +199,7 @@ module Imagekit AAC: :aac OPUS: :opus - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::audio_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec] end type format_ = :mp4 | :webm | :jpg | :png | :webp @@ -213,7 +213,7 @@ module Imagekit PNG: :png WEBP: :webp - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::format_] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_] end type stream_protocol = :HLS | :DASH @@ -224,7 +224,7 @@ module Imagekit HLS: :HLS DASH: :DASH - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::stream_protocol] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol] end type video_codec = :h264 | :vp9 @@ -235,33 +235,33 @@ module Imagekit H264: :h264 VP9: :vp9 - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyWebhookEvent::Data::Transformation::Options::video_codec] + def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec] end end type output = { url: String, - video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } class Output < Imagekit::Internal::Type::BaseModel attr_accessor url: String - attr_reader video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata? + attr_reader video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata? def video_metadata=: ( - Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata - ) -> Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata def initialize: ( url: String, - ?video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + ?video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata ) -> void def to_hash: -> { url: String, - video_metadata: Imagekit::VideoTransformationReadyWebhookEvent::Data::Transformation::Output::VideoMetadata + video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } type video_metadata = diff --git a/sig/imagekit/resources/webhooks.rbs b/sig/imagekit/resources/webhooks.rbs index 703798fe..d0ffe5de 100644 --- a/sig/imagekit/resources/webhooks.rbs +++ b/sig/imagekit/resources/webhooks.rbs @@ -3,15 +3,15 @@ module Imagekit class Webhooks def unsafe_unwrap: ( String payload - ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent - | Imagekit::VideoTransformationReadyWebhookEvent - | Imagekit::VideoTransformationErrorWebhookEvent) + ) -> (Imagekit::VideoTransformationAcceptedEvent + | Imagekit::VideoTransformationReadyEvent + | Imagekit::VideoTransformationErrorEvent) def unwrap: ( String payload - ) -> (Imagekit::VideoTransformationAcceptedWebhookEvent - | Imagekit::VideoTransformationReadyWebhookEvent - | Imagekit::VideoTransformationErrorWebhookEvent) + ) -> (Imagekit::VideoTransformationAcceptedEvent + | Imagekit::VideoTransformationReadyEvent + | Imagekit::VideoTransformationErrorEvent) def initialize: (client: Imagekit::Client) -> void end From 9b7d97d21df8c7cf8e21d3afa4d2616b5679fea7 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 10:33:52 +0000 Subject: [PATCH 070/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index f8ab83a1..5d987049 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-863564701f791fdf016f7321fce445de5e368c474b06b135aaac16214f4f6416.yml -openapi_spec_hash: e3bb05601081de07084edf79cf3a2d63 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-5b571c1f83e65c8209d9e4d82e89f62e958a852d1f3ccdb9e8137292079bb18f.yml +openapi_spec_hash: e67360f0b45cace9f1cbfa280982b56c config_hash: d6fc50026fa9ef4b444d43c07c2c70a6 From 48dfc9708430d307cdf5f799a1de5e6981d32ac6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 10:42:11 +0000 Subject: [PATCH 071/178] feat(api): manual updates --- .stats.yml | 6 +- lib/imagekit.rb | 16 + lib/imagekit/internal/type/base_model.rb | 9 +- lib/imagekit/internal/type/enum.rb | 25 + lib/imagekit/internal/type/union.rb | 30 +- lib/imagekit/models.rb | 32 + lib/imagekit/models/base_overlay.rb | 21 + lib/imagekit/models/image_overlay.rb | 72 + lib/imagekit/models/overlay.rb | 26 + lib/imagekit/models/overlay_position.rb | 93 + lib/imagekit/models/overlay_timing.rb | 97 + lib/imagekit/models/solid_color_overlay.rb | 48 + .../solid_color_overlay_transformation.rb | 132 ++ lib/imagekit/models/src_options.rb | 77 + lib/imagekit/models/streaming_resolution.rb | 21 + lib/imagekit/models/subtitle_overlay.rb | 72 + .../models/subtitle_overlay_transformation.rb | 96 + lib/imagekit/models/text_overlay.rb | 72 + .../models/text_overlay_transformation.rb | 278 +++ lib/imagekit/models/transformation.rb | 1057 +++++++++++ .../models/transformation_position.rb | 18 + lib/imagekit/models/video_overlay.rb | 72 + rbi/imagekit/models.rbi | 34 + rbi/imagekit/models/base_overlay.rbi | 44 + rbi/imagekit/models/image_overlay.rbi | 116 ++ rbi/imagekit/models/overlay.rbi | 26 + rbi/imagekit/models/overlay_position.rbi | 134 ++ rbi/imagekit/models/overlay_timing.rbi | 133 ++ rbi/imagekit/models/solid_color_overlay.rbi | 89 + .../solid_color_overlay_transformation.rbi | 269 +++ rbi/imagekit/models/src_options.rbi | 130 ++ rbi/imagekit/models/streaming_resolution.rbi | 35 + rbi/imagekit/models/subtitle_overlay.rbi | 128 ++ .../subtitle_overlay_transformation.rbi | 186 ++ rbi/imagekit/models/text_overlay.rbi | 120 ++ .../models/text_overlay_transformation.rbi | 495 ++++++ rbi/imagekit/models/transformation.rbi | 1561 +++++++++++++++++ .../models/transformation_position.rbi | 27 + rbi/imagekit/models/video_overlay.rbi | 116 ++ sig/imagekit/models.rbs | 32 + sig/imagekit/models/base_overlay.rbs | 26 + sig/imagekit/models/image_overlay.rbs | 71 + sig/imagekit/models/overlay.rbs | 16 + sig/imagekit/models/overlay_position.rbs | 85 + sig/imagekit/models/overlay_timing.rbs | 66 + sig/imagekit/models/solid_color_overlay.rbs | 50 + .../solid_color_overlay_transformation.rbs | 101 ++ sig/imagekit/models/src_options.rbs | 60 + sig/imagekit/models/streaming_resolution.rbs | 20 + sig/imagekit/models/subtitle_overlay.rbs | 71 + .../subtitle_overlay_transformation.rbs | 88 + sig/imagekit/models/text_overlay.rbs | 71 + .../models/text_overlay_transformation.rbs | 211 +++ sig/imagekit/models/transformation.rbs | 770 ++++++++ .../models/transformation_position.rbs | 14 + sig/imagekit/models/video_overlay.rbs | 71 + test/imagekit/resources/shared_test.rb | 6 + 57 files changed, 7813 insertions(+), 29 deletions(-) create mode 100644 lib/imagekit/models/base_overlay.rb create mode 100644 lib/imagekit/models/image_overlay.rb create mode 100644 lib/imagekit/models/overlay.rb create mode 100644 lib/imagekit/models/overlay_position.rb create mode 100644 lib/imagekit/models/overlay_timing.rb create mode 100644 lib/imagekit/models/solid_color_overlay.rb create mode 100644 lib/imagekit/models/solid_color_overlay_transformation.rb create mode 100644 lib/imagekit/models/src_options.rb create mode 100644 lib/imagekit/models/streaming_resolution.rb create mode 100644 lib/imagekit/models/subtitle_overlay.rb create mode 100644 lib/imagekit/models/subtitle_overlay_transformation.rb create mode 100644 lib/imagekit/models/text_overlay.rb create mode 100644 lib/imagekit/models/text_overlay_transformation.rb create mode 100644 lib/imagekit/models/transformation.rb create mode 100644 lib/imagekit/models/transformation_position.rb create mode 100644 lib/imagekit/models/video_overlay.rb create mode 100644 rbi/imagekit/models/base_overlay.rbi create mode 100644 rbi/imagekit/models/image_overlay.rbi create mode 100644 rbi/imagekit/models/overlay.rbi create mode 100644 rbi/imagekit/models/overlay_position.rbi create mode 100644 rbi/imagekit/models/overlay_timing.rbi create mode 100644 rbi/imagekit/models/solid_color_overlay.rbi create mode 100644 rbi/imagekit/models/solid_color_overlay_transformation.rbi create mode 100644 rbi/imagekit/models/src_options.rbi create mode 100644 rbi/imagekit/models/streaming_resolution.rbi create mode 100644 rbi/imagekit/models/subtitle_overlay.rbi create mode 100644 rbi/imagekit/models/subtitle_overlay_transformation.rbi create mode 100644 rbi/imagekit/models/text_overlay.rbi create mode 100644 rbi/imagekit/models/text_overlay_transformation.rbi create mode 100644 rbi/imagekit/models/transformation.rbi create mode 100644 rbi/imagekit/models/transformation_position.rbi create mode 100644 rbi/imagekit/models/video_overlay.rbi create mode 100644 sig/imagekit/models/base_overlay.rbs create mode 100644 sig/imagekit/models/image_overlay.rbs create mode 100644 sig/imagekit/models/overlay.rbs create mode 100644 sig/imagekit/models/overlay_position.rbs create mode 100644 sig/imagekit/models/overlay_timing.rbs create mode 100644 sig/imagekit/models/solid_color_overlay.rbs create mode 100644 sig/imagekit/models/solid_color_overlay_transformation.rbs create mode 100644 sig/imagekit/models/src_options.rbs create mode 100644 sig/imagekit/models/streaming_resolution.rbs create mode 100644 sig/imagekit/models/subtitle_overlay.rbs create mode 100644 sig/imagekit/models/subtitle_overlay_transformation.rbs create mode 100644 sig/imagekit/models/text_overlay.rbs create mode 100644 sig/imagekit/models/text_overlay_transformation.rbs create mode 100644 sig/imagekit/models/transformation.rbs create mode 100644 sig/imagekit/models/transformation_position.rbs create mode 100644 sig/imagekit/models/video_overlay.rbs create mode 100644 test/imagekit/resources/shared_test.rb diff --git a/.stats.yml b/.stats.yml index 5d987049..64418ba8 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-5b571c1f83e65c8209d9e4d82e89f62e958a852d1f3ccdb9e8137292079bb18f.yml -openapi_spec_hash: e67360f0b45cace9f1cbfa280982b56c -config_hash: d6fc50026fa9ef4b444d43c07c2c70a6 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-f3bff3868f6fb17535ab409692a079b9187de5922d7f04578082ea44680d28db.yml +openapi_spec_hash: 00e12ee294dedaf7afab030d42178bf2 +config_hash: 1dd1a96eff228aa2567b9973c36f5593 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index fca54b76..5032755e 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -53,6 +53,7 @@ require_relative "imagekit/models/accounts/origin_request" require_relative "imagekit/models/accounts/url_endpoint_request" require_relative "imagekit/models/file" +require_relative "imagekit/models/base_overlay" require_relative "imagekit/models/accounts/origin_create_params" require_relative "imagekit/models/accounts/origin_delete_params" require_relative "imagekit/models/accounts/origin_get_params" @@ -125,9 +126,24 @@ require_relative "imagekit/models/folder_rename_response" require_relative "imagekit/models/folders/job_get_params" require_relative "imagekit/models/folders/job_get_response" +require_relative "imagekit/models/image_overlay" require_relative "imagekit/models/metadata" +require_relative "imagekit/models/overlay" +require_relative "imagekit/models/overlay_position" +require_relative "imagekit/models/overlay_timing" +require_relative "imagekit/models/solid_color_overlay" +require_relative "imagekit/models/solid_color_overlay_transformation" +require_relative "imagekit/models/src_options" +require_relative "imagekit/models/streaming_resolution" +require_relative "imagekit/models/subtitle_overlay" +require_relative "imagekit/models/subtitle_overlay_transformation" +require_relative "imagekit/models/text_overlay" +require_relative "imagekit/models/text_overlay_transformation" +require_relative "imagekit/models/transformation" +require_relative "imagekit/models/transformation_position" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" +require_relative "imagekit/models/video_overlay" require_relative "imagekit/models/video_transformation_accepted_event" require_relative "imagekit/models/video_transformation_error_event" require_relative "imagekit/models/video_transformation_ready_event" diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekit/internal/type/base_model.rb index 33ab960f..10b423c5 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekit/internal/type/base_model.rb @@ -438,11 +438,10 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `custom_metadata_field` is a `Imagekit::CustomMetadataField` - # custom_metadata_field => { - # id: id, - # label: label, - # name: name + # # `base_overlay` is a `Imagekit::BaseOverlay` + # base_overlay => { + # position: position, + # timing: timing # } def deconstruct_keys(keys) (keys || self.class.known_fields.keys) diff --git a/lib/imagekit/internal/type/enum.rb b/lib/imagekit/internal/type/enum.rb index 95f74db9..f8cfca79 100644 --- a/lib/imagekit/internal/type/enum.rb +++ b/lib/imagekit/internal/type/enum.rb @@ -15,6 +15,31 @@ module Type # # We can therefore convert string values to Symbols, but can't convert other # values safely. + # + # @example + # # `streaming_resolution` is a `Imagekit::StreamingResolution` + # case streaming_resolution + # when Imagekit::StreamingResolution::STREAMING_RESOLUTION_240 + # # ... + # when Imagekit::StreamingResolution::STREAMING_RESOLUTION_360 + # # ... + # when Imagekit::StreamingResolution::STREAMING_RESOLUTION_480 + # # ... + # else + # puts(streaming_resolution) + # end + # + # @example + # case streaming_resolution + # in :"240" + # # ... + # in :"360" + # # ... + # in :"480" + # # ... + # else + # puts(streaming_resolution) + # end module Enum include Imagekit::Internal::Type::Converter include Imagekit::Internal::Util::SorbetRuntimeSupport diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekit/internal/type/union.rb index 5a103a05..56cb34b1 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekit/internal/type/union.rb @@ -6,28 +6,16 @@ module Type # @api private # # @example - # # `origin_request` is a `Imagekit::Accounts::OriginRequest` - # case origin_request - # when Imagekit::Accounts::OriginRequest::S3 - # puts(origin_request.access_key) - # when Imagekit::Accounts::OriginRequest::S3Compatible - # puts(origin_request.bucket) - # when Imagekit::Accounts::OriginRequest::CloudinaryBackup - # puts(origin_request.name) + # # `overlay` is a `Imagekit::Overlay` + # case overlay + # when Imagekit::TextOverlay + # # ... + # when Imagekit::ImageOverlay + # # ... + # when Imagekit::VideoOverlay + # # ... # else - # puts(origin_request) - # end - # - # @example - # case origin_request - # in {type: :S3, access_key: access_key, bucket: bucket, name: name} - # puts(access_key) - # in {type: :S3_COMPATIBLE, access_key: access_key, bucket: bucket, endpoint: endpoint} - # puts(bucket) - # in {type: :CLOUDINARY_BACKUP, access_key: access_key, bucket: bucket, name: name} - # puts(name) - # else - # puts(origin_request) + # puts(overlay) # end module Union include Imagekit::Internal::Type::Converter diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index e5d19dc3..8d5fbec2 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -43,6 +43,8 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams + BaseOverlay = Imagekit::Models::BaseOverlay + Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache @@ -89,12 +91,42 @@ module Imagekit Folders = Imagekit::Models::Folders + ImageOverlay = Imagekit::Models::ImageOverlay + Metadata = Imagekit::Models::Metadata + Overlay = Imagekit::Models::Overlay + + OverlayPosition = Imagekit::Models::OverlayPosition + + OverlayTiming = Imagekit::Models::OverlayTiming + + SolidColorOverlay = Imagekit::Models::SolidColorOverlay + + SolidColorOverlayTransformation = Imagekit::Models::SolidColorOverlayTransformation + + SrcOptions = Imagekit::Models::SrcOptions + + StreamingResolution = Imagekit::Models::StreamingResolution + + SubtitleOverlay = Imagekit::Models::SubtitleOverlay + + SubtitleOverlayTransformation = Imagekit::Models::SubtitleOverlayTransformation + + TextOverlay = Imagekit::Models::TextOverlay + + TextOverlayTransformation = Imagekit::Models::TextOverlayTransformation + + Transformation = Imagekit::Models::Transformation + + TransformationPosition = Imagekit::Models::TransformationPosition + UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + VideoOverlay = Imagekit::Models::VideoOverlay + VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent diff --git a/lib/imagekit/models/base_overlay.rb b/lib/imagekit/models/base_overlay.rb new file mode 100644 index 00000000..44a3c8a8 --- /dev/null +++ b/lib/imagekit/models/base_overlay.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class BaseOverlay < Imagekit::Internal::Type::BaseModel + # @!attribute position + # + # @return [Imagekit::Models::OverlayPosition, nil] + optional :position, -> { Imagekit::OverlayPosition } + + # @!attribute timing + # + # @return [Imagekit::Models::OverlayTiming, nil] + optional :timing, -> { Imagekit::OverlayTiming } + + # @!method initialize(position: nil, timing: nil) + # @param position [Imagekit::Models::OverlayPosition] + # @param timing [Imagekit::Models::OverlayTiming] + end + end +end diff --git a/lib/imagekit/models/image_overlay.rb b/lib/imagekit/models/image_overlay.rb new file mode 100644 index 00000000..b5cda19e --- /dev/null +++ b/lib/imagekit/models/image_overlay.rb @@ -0,0 +1,72 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class ImageOverlay < Imagekit::Models::BaseOverlay + # @!attribute input + # Specifies the relative path to the image used as an overlay. + # + # @return [String] + required :input, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::ImageOverlay::Type] + required :type, enum: -> { Imagekit::ImageOverlay::Type } + + # @!attribute encoding + # 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`. + # + # @return [Symbol, Imagekit::Models::ImageOverlay::Encoding, nil] + optional :encoding, enum: -> { Imagekit::ImageOverlay::Encoding } + + # @!attribute transformation + # Array of transformations to be applied to the overlay image. Supported + # transformations depends on the base/parent asset. + # + # @return [Array, nil] + optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } + + # @!method initialize(input:, type:, encoding: nil, transformation: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::ImageOverlay} for more details. + # + # @param input [String] Specifies the relative path to the image used as an overlay. + # + # @param type [Symbol, Imagekit::Models::ImageOverlay::Type] + # + # @param encoding [Symbol, Imagekit::Models::ImageOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 + # + # @param transformation [Array] Array of transformations to be applied to the overlay image. Supported transform + + module Type + extend Imagekit::Internal::Type::Enum + + IMAGE = :image + + # @!method self.values + # @return [Array] + end + + # 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`. + module Encoding + extend Imagekit::Internal::Type::Enum + + AUTO = :auto + PLAIN = :plain + BASE64 = :base64 + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/overlay.rb b/lib/imagekit/models/overlay.rb new file mode 100644 index 00000000..5bef33d3 --- /dev/null +++ b/lib/imagekit/models/overlay.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # Specifies an overlay to be applied on the parent image or video. ImageKit + # supports overlays including images, text, videos, subtitles, and solid colors. + module Overlay + extend Imagekit::Internal::Type::Union + + discriminator :type + + variant :text, -> { Imagekit::TextOverlay } + + variant :image, -> { Imagekit::ImageOverlay } + + variant :video, -> { Imagekit::VideoOverlay } + + variant :subtitle, -> { Imagekit::SubtitleOverlay } + + variant :solidColor, -> { Imagekit::SolidColorOverlay } + + # @!method self.variants + # @return [Array(Imagekit::Models::TextOverlay, Imagekit::Models::ImageOverlay, Imagekit::Models::VideoOverlay, Imagekit::Models::SubtitleOverlay, Imagekit::Models::SolidColorOverlay)] + end + end +end diff --git a/lib/imagekit/models/overlay_position.rb b/lib/imagekit/models/overlay_position.rb new file mode 100644 index 00000000..77fac8ab --- /dev/null +++ b/lib/imagekit/models/overlay_position.rb @@ -0,0 +1,93 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class OverlayPosition < Imagekit::Internal::Type::BaseModel + # @!attribute focus + # Specifies the position of the overlay relative to the parent image or video. + # Maps to `lfo` in the URL. + # + # @return [Symbol, Imagekit::Models::OverlayPosition::Focus, nil] + optional :focus, enum: -> { Imagekit::OverlayPosition::Focus } + + # @!attribute x + # 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. + # + # @return [Float, String, nil] + optional :x, union: -> { Imagekit::OverlayPosition::X } + + # @!attribute y_ + # 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. + # + # @return [Float, String, nil] + optional :y_, union: -> { Imagekit::OverlayPosition::Y }, api_name: :y + + # @!method initialize(focus: nil, x: nil, y_: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::OverlayPosition} for more details. + # + # @param focus [Symbol, Imagekit::Models::OverlayPosition::Focus] Specifies the position of the overlay relative to the parent image or video. + # + # @param x [Float, String] Specifies the x-coordinate of the top-left corner of the base asset where the ov + # + # @param y_ [Float, String] Specifies the y-coordinate of the top-left corner of the base asset where the ov + + # Specifies the position of the overlay relative to the parent image or video. + # Maps to `lfo` in the URL. + # + # @see Imagekit::Models::OverlayPosition#focus + module Focus + extend Imagekit::Internal::Type::Enum + + CENTER = :center + TOP = :top + LEFT = :left + BOTTOM = :bottom + RIGHT = :right + TOP_LEFT = :top_left + TOP_RIGHT = :top_right + BOTTOM_LEFT = :bottom_left + BOTTOM_RIGHT = :bottom_right + + # @!method self.values + # @return [Array] + end + + # 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. + # + # @see Imagekit::Models::OverlayPosition#x + module X + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # 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. + # + # @see Imagekit::Models::OverlayPosition#y_ + module Y + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + end + end +end diff --git a/lib/imagekit/models/overlay_timing.rb b/lib/imagekit/models/overlay_timing.rb new file mode 100644 index 00000000..7e399421 --- /dev/null +++ b/lib/imagekit/models/overlay_timing.rb @@ -0,0 +1,97 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class OverlayTiming < Imagekit::Internal::Type::BaseModel + # @!attribute duration + # 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. + # + # @return [Float, String, nil] + optional :duration, union: -> { Imagekit::OverlayTiming::Duration } + + # @!attribute end_ + # 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. + # + # @return [Float, String, nil] + optional :end_, union: -> { Imagekit::OverlayTiming::End }, api_name: :end + + # @!attribute start + # 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. + # + # @return [Float, String, nil] + optional :start, union: -> { Imagekit::OverlayTiming::Start } + + # @!method initialize(duration: nil, end_: nil, start: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::OverlayTiming} for more details. + # + # @param duration [Float, String] Specifies the duration (in seconds) during which the overlay should appear on th + # + # @param end_ [Float, String] Specifies the end time (in seconds) for when the overlay should disappear from t + # + # @param start [Float, String] Specifies the start time (in seconds) for when the overlay should appear on the + + # 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. + # + # @see Imagekit::Models::OverlayTiming#duration + module Duration + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # 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. + # + # @see Imagekit::Models::OverlayTiming#end_ + module End + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + 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. + # + # @see Imagekit::Models::OverlayTiming#start + module Start + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + end + end +end diff --git a/lib/imagekit/models/solid_color_overlay.rb b/lib/imagekit/models/solid_color_overlay.rb new file mode 100644 index 00000000..38bf49e8 --- /dev/null +++ b/lib/imagekit/models/solid_color_overlay.rb @@ -0,0 +1,48 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class SolidColorOverlay < Imagekit::Models::BaseOverlay + # @!attribute color + # 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). + # + # @return [String] + required :color, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::SolidColorOverlay::Type] + required :type, enum: -> { Imagekit::SolidColorOverlay::Type } + + # @!attribute transformation + # Control width and height of the solid color overlay. Supported transformations + # depend on the base/parent asset. + # + # @return [Array, nil] + optional :transformation, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::SolidColorOverlayTransformation] } + + # @!method initialize(color:, type:, transformation: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::SolidColorOverlay} for more details. + # + # @param color [String] Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA + # + # @param type [Symbol, Imagekit::Models::SolidColorOverlay::Type] + # + # @param transformation [Array] Control width and height of the solid color overlay. Supported transformations d + + module Type + extend Imagekit::Internal::Type::Enum + + SOLID_COLOR = :solidColor + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/solid_color_overlay_transformation.rb b/lib/imagekit/models/solid_color_overlay_transformation.rb new file mode 100644 index 00000000..05e0959c --- /dev/null +++ b/lib/imagekit/models/solid_color_overlay_transformation.rb @@ -0,0 +1,132 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel + # @!attribute alpha + # Alpha transparency level + # + # @return [Float, nil] + optional :alpha, Float + + # @!attribute background + # Background color + # + # @return [String, nil] + optional :background, String + + # @!attribute gradient + # Gradient effect for the overlay + # + # @return [Boolean, String, Imagekit::Models::SolidColorOverlayTransformation::Gradient, nil] + optional :gradient, union: -> { Imagekit::SolidColorOverlayTransformation::Gradient } + + # @!attribute height + # Height of the solid color overlay + # + # @return [Float, String, nil] + optional :height, union: -> { Imagekit::SolidColorOverlayTransformation::Height } + + # @!attribute radius + # Corner radius of the solid color overlay + # + # @return [Float, Symbol, Imagekit::Models::SolidColorOverlayTransformation::Radius, nil] + optional :radius, union: -> { Imagekit::SolidColorOverlayTransformation::Radius } + + # @!attribute width + # Width of the solid color overlay + # + # @return [Float, String, nil] + optional :width, union: -> { Imagekit::SolidColorOverlayTransformation::Width } + + # @!method initialize(alpha: nil, background: nil, gradient: nil, height: nil, radius: nil, width: nil) + # @param alpha [Float] Alpha transparency level + # + # @param background [String] Background color + # + # @param gradient [Boolean, String, Imagekit::Models::SolidColorOverlayTransformation::Gradient] Gradient effect for the overlay + # + # @param height [Float, String] Height of the solid color overlay + # + # @param radius [Float, Symbol, Imagekit::Models::SolidColorOverlayTransformation::Radius] Corner radius of the solid color overlay + # + # @param width [Float, String] Width of the solid color overlay + + # Gradient effect for the overlay + # + # @see Imagekit::Models::SolidColorOverlayTransformation#gradient + module Gradient + extend Imagekit::Internal::Type::Union + + variant const: -> { Imagekit::Models::SolidColorOverlayTransformation::Gradient::TRUE } + + variant String + + # @!method self.variants + # @return [Array(Boolean, String)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Imagekit::SolidColorOverlayTransformation::Gradient::TaggedBoolean, String) } + end + + # @!group + + TRUE = true + + # @!endgroup + end + + # Height of the solid color overlay + # + # @see Imagekit::Models::SolidColorOverlayTransformation#height + module Height + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Corner radius of the solid color overlay + # + # @see Imagekit::Models::SolidColorOverlayTransformation#radius + module Radius + extend Imagekit::Internal::Type::Union + + variant Float + + variant const: -> { Imagekit::Models::SolidColorOverlayTransformation::Radius::MAX } + + # @!method self.variants + # @return [Array(Float, Symbol)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Float, Imagekit::SolidColorOverlayTransformation::Radius::TaggedSymbol) } + end + + # @!group + + MAX = :max + + # @!endgroup + end + + # Width of the solid color overlay + # + # @see Imagekit::Models::SolidColorOverlayTransformation#width + module Width + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + end + end +end diff --git a/lib/imagekit/models/src_options.rb b/lib/imagekit/models/src_options.rb new file mode 100644 index 00000000..c029bd0a --- /dev/null +++ b/lib/imagekit/models/src_options.rb @@ -0,0 +1,77 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class SrcOptions < Imagekit::Internal::Type::BaseModel + # @!attribute src + # 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. + # + # @return [String] + required :src, String + + # @!attribute url_endpoint + # Get your urlEndpoint from the + # [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints). + # + # @return [String] + required :url_endpoint, String, api_name: :urlEndpoint + + # @!attribute query_parameters + # 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. + # + # @return [Hash{Symbol=>String, Float}, nil] + optional :query_parameters, + -> { Imagekit::Internal::Type::HashOf[union: Imagekit::SrcOptions::QueryParameter] }, + api_name: :queryParameters + + # @!attribute transformation + # 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. + # + # @return [Array, nil] + optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } + + # @!attribute transformation_position + # 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`. + # + # @return [Symbol, Imagekit::Models::TransformationPosition, nil] + optional :transformation_position, + enum: -> { Imagekit::TransformationPosition }, + api_name: :transformationPosition + + # @!method initialize(src:, url_endpoint:, query_parameters: nil, transformation: nil, transformation_position: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::SrcOptions} for more details. + # + # Options for generating ImageKit URLs with transformations + # + # @param src [String] Accepts a relative or absolute path of the resource. If a relative path is provi + # + # @param url_endpoint [String] Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard + # + # @param query_parameters [Hash{Symbol=>String, Float}] These are additional query parameters that you want to add to the final URL. + # + # @param transformation [Array] An array of objects specifying the transformations to be applied in the URL. If + # + # @param transformation_position [Symbol, Imagekit::Models::TransformationPosition] By default, the transformation string is added as a query parameter in the URL, + + module QueryParameter + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + end + end +end diff --git a/lib/imagekit/models/streaming_resolution.rb b/lib/imagekit/models/streaming_resolution.rb new file mode 100644 index 00000000..8ed00e6b --- /dev/null +++ b/lib/imagekit/models/streaming_resolution.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # Available streaming resolutions for adaptive bitrate streaming + module StreamingResolution + extend Imagekit::Internal::Type::Enum + + STREAMING_RESOLUTION_240 = :"240" + STREAMING_RESOLUTION_360 = :"360" + STREAMING_RESOLUTION_480 = :"480" + STREAMING_RESOLUTION_720 = :"720" + STREAMING_RESOLUTION_1080 = :"1080" + STREAMING_RESOLUTION_1440 = :"1440" + STREAMING_RESOLUTION_2160 = :"2160" + + # @!method self.values + # @return [Array] + end + end +end diff --git a/lib/imagekit/models/subtitle_overlay.rb b/lib/imagekit/models/subtitle_overlay.rb new file mode 100644 index 00000000..db5dbc3f --- /dev/null +++ b/lib/imagekit/models/subtitle_overlay.rb @@ -0,0 +1,72 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class SubtitleOverlay < Imagekit::Models::BaseOverlay + # @!attribute input + # Specifies the relative path to the subtitle file used as an overlay. + # + # @return [String] + required :input, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::SubtitleOverlay::Type] + required :type, enum: -> { Imagekit::SubtitleOverlay::Type } + + # @!attribute encoding + # 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`. + # + # @return [Symbol, Imagekit::Models::SubtitleOverlay::Encoding, nil] + optional :encoding, enum: -> { Imagekit::SubtitleOverlay::Encoding } + + # @!attribute transformation + # Control styling of the subtitle. + # + # @return [Array, nil] + optional :transformation, + -> { Imagekit::Internal::Type::ArrayOf[Imagekit::SubtitleOverlayTransformation] } + + # @!method initialize(input:, type:, encoding: nil, transformation: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::SubtitleOverlay} for more details. + # + # @param input [String] Specifies the relative path to the subtitle file used as an overlay. + # + # @param type [Symbol, Imagekit::Models::SubtitleOverlay::Type] + # + # @param encoding [Symbol, Imagekit::Models::SubtitleOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 + # + # @param transformation [Array] Control styling of the subtitle. + + module Type + extend Imagekit::Internal::Type::Enum + + SUBTITLE = :subtitle + + # @!method self.values + # @return [Array] + end + + # 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`. + module Encoding + extend Imagekit::Internal::Type::Enum + + AUTO = :auto + PLAIN = :plain + BASE64 = :base64 + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/subtitle_overlay_transformation.rb b/lib/imagekit/models/subtitle_overlay_transformation.rb new file mode 100644 index 00000000..72715df0 --- /dev/null +++ b/lib/imagekit/models/subtitle_overlay_transformation.rb @@ -0,0 +1,96 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel + # @!attribute background + # Background color for subtitles + # + # @return [String, nil] + optional :background, String + + # @!attribute color + # Text color for subtitles + # + # @return [String, nil] + optional :color, String + + # @!attribute font_family + # Font family for subtitles + # + # @return [String, nil] + optional :font_family, String, api_name: :fontFamily + + # @!attribute font_outline + # Font outline for subtitles + # + # @return [String, nil] + optional :font_outline, String, api_name: :fontOutline + + # @!attribute font_shadow + # Font shadow for subtitles + # + # @return [String, nil] + optional :font_shadow, String, api_name: :fontShadow + + # @!attribute font_size + # Font size for subtitles + # + # @return [Float, String, nil] + optional :font_size, + union: -> { + Imagekit::SubtitleOverlayTransformation::FontSize + }, + api_name: :fontSize + + # @!attribute typography + # Typography style for subtitles + # + # @return [Symbol, Imagekit::Models::SubtitleOverlayTransformation::Typography, nil] + optional :typography, enum: -> { Imagekit::SubtitleOverlayTransformation::Typography } + + # @!method initialize(background: nil, color: nil, font_family: nil, font_outline: nil, font_shadow: nil, font_size: nil, typography: nil) + # @param background [String] Background color for subtitles + # + # @param color [String] Text color for subtitles + # + # @param font_family [String] Font family for subtitles + # + # @param font_outline [String] Font outline for subtitles + # + # @param font_shadow [String] Font shadow for subtitles + # + # @param font_size [Float, String] Font size for subtitles + # + # @param typography [Symbol, Imagekit::Models::SubtitleOverlayTransformation::Typography] Typography style for subtitles + + # Font size for subtitles + # + # @see Imagekit::Models::SubtitleOverlayTransformation#font_size + module FontSize + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Typography style for subtitles + # + # @see Imagekit::Models::SubtitleOverlayTransformation#typography + module Typography + extend Imagekit::Internal::Type::Enum + + B = :b + I = :i + B_I = :b_i + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/text_overlay.rb b/lib/imagekit/models/text_overlay.rb new file mode 100644 index 00000000..6a4d81d3 --- /dev/null +++ b/lib/imagekit/models/text_overlay.rb @@ -0,0 +1,72 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class TextOverlay < Imagekit::Models::BaseOverlay + # @!attribute text + # Specifies the text to be displayed in the overlay. The SDK automatically handles + # special characters and encoding. + # + # @return [String] + required :text, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::TextOverlay::Type] + required :type, enum: -> { Imagekit::TextOverlay::Type } + + # @!attribute encoding + # 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`. + # + # @return [Symbol, Imagekit::Models::TextOverlay::Encoding, nil] + optional :encoding, enum: -> { Imagekit::TextOverlay::Encoding } + + # @!attribute transformation + # Control styling of the text overlay. + # + # @return [Array, nil] + optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::TextOverlayTransformation] } + + # @!method initialize(text:, type:, encoding: nil, transformation: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::TextOverlay} for more details. + # + # @param text [String] Specifies the text to be displayed in the overlay. The SDK automatically handles + # + # @param type [Symbol, Imagekit::Models::TextOverlay::Type] + # + # @param encoding [Symbol, Imagekit::Models::TextOverlay::Encoding] Text can be included in the layer as either `i-{input}` (plain text) or `ie-{bas + # + # @param transformation [Array] Control styling of the text overlay. + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :text + + # @!method self.values + # @return [Array] + end + + # 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`. + module Encoding + extend Imagekit::Internal::Type::Enum + + AUTO = :auto + PLAIN = :plain + BASE64 = :base64 + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/imagekit/models/text_overlay_transformation.rb b/lib/imagekit/models/text_overlay_transformation.rb new file mode 100644 index 00000000..1d95eb17 --- /dev/null +++ b/lib/imagekit/models/text_overlay_transformation.rb @@ -0,0 +1,278 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel + # @!attribute alpha + # Specifies the transparency level of the text overlay. Accepts integers from `1` + # to `9`. + # + # @return [Float, nil] + optional :alpha, Float + + # @!attribute background + # Specifies the background color of the text overlay. Accepts an RGB hex code, an + # RGBA code, or a color name. + # + # @return [String, nil] + optional :background, String + + # @!attribute flip + # Flip the text overlay horizontally, vertically, or both. + # + # @return [Symbol, Imagekit::Models::TextOverlayTransformation::Flip, nil] + optional :flip, enum: -> { Imagekit::TextOverlayTransformation::Flip } + + # @!attribute font_color + # 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. + # + # @return [String, nil] + optional :font_color, String, api_name: :fontColor + + # @!attribute font_family + # Specifies the font family of the overlaid text. Choose from the supported fonts + # list or use a custom font. + # + # @return [String, nil] + optional :font_family, String, api_name: :fontFamily + + # @!attribute font_size + # Specifies the font size of the overlaid text. Accepts a numeric value or an + # arithmetic expression. + # + # @return [Float, String, nil] + optional :font_size, union: -> { Imagekit::TextOverlayTransformation::FontSize }, api_name: :fontSize + + # @!attribute inner_alignment + # Specifies the inner alignment of the text when width is more than the text + # length. + # + # @return [Symbol, Imagekit::Models::TextOverlayTransformation::InnerAlignment, nil] + optional :inner_alignment, + enum: -> { Imagekit::TextOverlayTransformation::InnerAlignment }, + api_name: :innerAlignment + + # @!attribute line_height + # Specifies the line height of the text overlay. + # + # @return [Float, String, nil] + optional :line_height, + union: -> { Imagekit::TextOverlayTransformation::LineHeight }, + api_name: :lineHeight + + # @!attribute padding + # 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. + # + # @return [Float, String, nil] + optional :padding, union: -> { Imagekit::TextOverlayTransformation::Padding } + + # @!attribute radius + # Specifies the corner radius of the text overlay. Set to `max` to achieve a + # circular or oval shape. + # + # @return [Float, Symbol, Imagekit::Models::TextOverlayTransformation::Radius, nil] + optional :radius, union: -> { Imagekit::TextOverlayTransformation::Radius } + + # @!attribute rotation + # 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. + # + # @return [Float, String, nil] + optional :rotation, union: -> { Imagekit::TextOverlayTransformation::Rotation } + + # @!attribute typography + # Specifies the typography style of the text. Supported values: `b` for bold, `i` + # for italics, and `b_i` for bold with italics. + # + # @return [Symbol, Imagekit::Models::TextOverlayTransformation::Typography, nil] + optional :typography, enum: -> { Imagekit::TextOverlayTransformation::Typography } + + # @!attribute width + # 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`. + # + # @return [Float, String, nil] + optional :width, union: -> { Imagekit::TextOverlayTransformation::Width } + + # @!method initialize(alpha: nil, background: nil, flip: nil, font_color: nil, font_family: nil, font_size: nil, inner_alignment: nil, line_height: nil, padding: nil, radius: nil, rotation: nil, typography: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::TextOverlayTransformation} for more details. + # + # @param alpha [Float] Specifies the transparency level of the text overlay. Accepts integers from `1` + # + # @param background [String] Specifies the background color of the text overlay. + # + # @param flip [Symbol, Imagekit::Models::TextOverlayTransformation::Flip] Flip the text overlay horizontally, vertically, or both. + # + # @param font_color [String] Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `F + # + # @param font_family [String] Specifies the font family of the overlaid text. Choose from the supported fonts + # + # @param font_size [Float, String] Specifies the font size of the overlaid text. Accepts a numeric value or an arit + # + # @param inner_alignment [Symbol, Imagekit::Models::TextOverlayTransformation::InnerAlignment] Specifies the inner alignment of the text when width is more than the text lengt + # + # @param line_height [Float, String] Specifies the line height of the text overlay. + # + # @param padding [Float, String] Specifies the padding around the overlaid text. + # + # @param radius [Float, Symbol, Imagekit::Models::TextOverlayTransformation::Radius] Specifies the corner radius of the text overlay. + # + # @param rotation [Float, String] Specifies the rotation angle of the text overlay. + # + # @param typography [Symbol, Imagekit::Models::TextOverlayTransformation::Typography] Specifies the typography style of the text. + # + # @param width [Float, String] Specifies the maximum width (in pixels) of the overlaid text. The text wraps aut + + # Flip the text overlay horizontally, vertically, or both. + # + # @see Imagekit::Models::TextOverlayTransformation#flip + module Flip + extend Imagekit::Internal::Type::Enum + + H = :h + V = :v + H_V = :h_v + V_H = :v_h + + # @!method self.values + # @return [Array] + end + + # Specifies the font size of the overlaid text. Accepts a numeric value or an + # arithmetic expression. + # + # @see Imagekit::Models::TextOverlayTransformation#font_size + module FontSize + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Specifies the inner alignment of the text when width is more than the text + # length. + # + # @see Imagekit::Models::TextOverlayTransformation#inner_alignment + module InnerAlignment + extend Imagekit::Internal::Type::Enum + + LEFT = :left + RIGHT = :right + CENTER = :center + + # @!method self.values + # @return [Array] + end + + # Specifies the line height of the text overlay. + # + # @see Imagekit::Models::TextOverlayTransformation#line_height + module LineHeight + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # 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. + # + # @see Imagekit::Models::TextOverlayTransformation#padding + module Padding + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Specifies the corner radius of the text overlay. Set to `max` to achieve a + # circular or oval shape. + # + # @see Imagekit::Models::TextOverlayTransformation#radius + module Radius + extend Imagekit::Internal::Type::Union + + variant Float + + variant const: -> { Imagekit::Models::TextOverlayTransformation::Radius::MAX } + + # @!method self.variants + # @return [Array(Float, Symbol)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Float, Imagekit::TextOverlayTransformation::Radius::TaggedSymbol) } + end + + # @!group + + MAX = :max + + # @!endgroup + end + + # 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. + # + # @see Imagekit::Models::TextOverlayTransformation#rotation + module Rotation + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Specifies the typography style of the text. Supported values: `b` for bold, `i` + # for italics, and `b_i` for bold with italics. + # + # @see Imagekit::Models::TextOverlayTransformation#typography + module Typography + extend Imagekit::Internal::Type::Enum + + B = :b + I = :i + B_I = :b_i + + # @!method self.values + # @return [Array] + end + + # 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`. + # + # @see Imagekit::Models::TextOverlayTransformation#width + module Width + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + end + end +end diff --git a/lib/imagekit/models/transformation.rb b/lib/imagekit/models/transformation.rb new file mode 100644 index 00000000..c21109fd --- /dev/null +++ b/lib/imagekit/models/transformation.rb @@ -0,0 +1,1057 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute ai_change_background + # 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. + # + # @return [String, nil] + optional :ai_change_background, String, api_name: :aiChangeBackground + + # @!attribute ai_drop_shadow + # 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. + # + # @return [Boolean, String, Imagekit::Models::Transformation::AIDropShadow, nil] + optional :ai_drop_shadow, union: -> { Imagekit::Transformation::AIDropShadow }, api_name: :aiDropShadow + + # @!attribute ai_remove_background + # Applies ImageKit's in-house background removal. Supported inside overlay. + # + # @return [Boolean, Imagekit::Models::Transformation::AIRemoveBackground, nil] + optional :ai_remove_background, + enum: -> { Imagekit::Transformation::AIRemoveBackground }, + api_name: :aiRemoveBackground + + # @!attribute ai_remove_background_external + # 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. + # + # @return [Boolean, Imagekit::Models::Transformation::AIRemoveBackgroundExternal, nil] + optional :ai_remove_background_external, + enum: -> { Imagekit::Transformation::AIRemoveBackgroundExternal }, + api_name: :aiRemoveBackgroundExternal + + # @!attribute ai_retouch + # Performs AI-based retouching to improve faces or product shots. Not supported + # inside overlay. + # + # @return [Boolean, Imagekit::Models::Transformation::AIRetouch, nil] + optional :ai_retouch, enum: -> { Imagekit::Transformation::AIRetouch }, api_name: :aiRetouch + + # @!attribute ai_upscale + # Upscales images beyond their original dimensions using AI. Not supported inside + # overlay. + # + # @return [Boolean, Imagekit::Models::Transformation::AIUpscale, nil] + optional :ai_upscale, enum: -> { Imagekit::Transformation::AIUpscale }, api_name: :aiUpscale + + # @!attribute ai_variation + # 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. + # + # @return [Boolean, Imagekit::Models::Transformation::AIVariation, nil] + optional :ai_variation, enum: -> { Imagekit::Transformation::AIVariation }, api_name: :aiVariation + + # @!attribute aspect_ratio + # 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`. + # + # @return [Float, String, nil] + optional :aspect_ratio, union: -> { Imagekit::Transformation::AspectRatio }, api_name: :aspectRatio + + # @!attribute audio_codec + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # + # @return [Symbol, Imagekit::Models::Transformation::AudioCodec, nil] + optional :audio_codec, enum: -> { Imagekit::Transformation::AudioCodec }, api_name: :audioCodec + + # @!attribute background + # Specifies the background to be used in conjunction with certain cropping + # strategies when resizing an image. + # + # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. + # - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. + # - 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}]`. + # + # @return [String, nil] + optional :background, String + + # @!attribute blur + # Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, + # or an expression like `bl-10`. + # + # @return [Float, nil] + optional :blur, Float + + # @!attribute border + # 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`. + # + # @return [String, nil] + optional :border, String + + # @!attribute color_profile + # Indicates whether the output image should retain the original color profile. + # + # @return [Boolean, nil] + optional :color_profile, Imagekit::Internal::Type::Boolean, api_name: :colorProfile + + # @!attribute contrast_stretch + # Automatically enhances the contrast of an image (contrast stretch). + # + # @return [Boolean, Imagekit::Models::Transformation::ContrastStretch, nil] + optional :contrast_stretch, + enum: -> { Imagekit::Transformation::ContrastStretch }, + api_name: :contrastStretch + + # @!attribute crop + # Crop modes for image resizing + # + # @return [Symbol, Imagekit::Models::Transformation::Crop, nil] + optional :crop, enum: -> { Imagekit::Transformation::Crop } + + # @!attribute crop_mode + # Additional crop modes for image resizing + # + # @return [Symbol, Imagekit::Models::Transformation::CropMode, nil] + optional :crop_mode, enum: -> { Imagekit::Transformation::CropMode }, api_name: :cropMode + + # @!attribute default_image + # Specifies a fallback image if the resource is not found, e.g., a URL or file + # path. + # + # @return [String, nil] + optional :default_image, String, api_name: :defaultImage + + # @!attribute dpr + # Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio + # (DPR) calculation. + # + # @return [Float, nil] + optional :dpr, Float + + # @!attribute duration + # 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. + # + # @return [Float, String, nil] + optional :duration, union: -> { Imagekit::Transformation::Duration } + + # @!attribute end_offset + # 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. + # + # @return [Float, String, nil] + optional :end_offset, union: -> { Imagekit::Transformation::EndOffset }, api_name: :endOffset + + # @!attribute flip + # Flips or mirrors an image either horizontally, vertically, or both. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. + # + # @return [Symbol, Imagekit::Models::Transformation::Flip, nil] + optional :flip, enum: -> { Imagekit::Transformation::Flip } + + # @!attribute focus + # This parameter can be used with pad resize, maintain ratio, or extract crop to + # modify the padding or cropping behavior. + # + # @return [String, nil] + optional :focus, String + + # @!attribute format_ + # 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. + # + # @return [Symbol, Imagekit::Models::Transformation::Format, nil] + optional :format_, enum: -> { Imagekit::Transformation::Format }, api_name: :format + + # @!attribute gradient + # Creates a linear gradient with two colors. Pass `true` for a default gradient, + # or provide a string for a custom gradient. + # + # @return [Boolean, String, Imagekit::Models::Transformation::Gradient, nil] + optional :gradient, union: -> { Imagekit::Transformation::Gradient } + + # @!attribute grayscale + # Enables a grayscale effect for images. + # + # @return [Boolean, Imagekit::Models::Transformation::Grayscale, nil] + optional :grayscale, enum: -> { Imagekit::Transformation::Grayscale } + + # @!attribute height + # 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`). + # + # @return [Float, String, nil] + optional :height, union: -> { Imagekit::Transformation::Height } + + # @!attribute lossless + # Specifies whether the output image (in JPEG or PNG) should be compressed + # losslessly. + # + # @return [Boolean, nil] + optional :lossless, Imagekit::Internal::Type::Boolean + + # @!attribute metadata + # By default, ImageKit removes all metadata during automatic image compression. + # Set this to true to preserve metadata. + # + # @return [Boolean, nil] + optional :metadata, Imagekit::Internal::Type::Boolean + + # @!attribute named + # Named transformation reference + # + # @return [String, nil] + optional :named, String + + # @!attribute opacity + # Specifies the opacity level of the output image. + # + # @return [Float, nil] + optional :opacity, Float + + # @!attribute original + # If set to true, serves the original file without applying any transformations. + # + # @return [Boolean, nil] + optional :original, Imagekit::Internal::Type::Boolean + + # @!attribute overlay + # Specifies an overlay to be applied on the parent image or video. ImageKit + # supports overlays including images, text, videos, subtitles, and solid colors. + # + # @return [Imagekit::Models::Overlay, nil] + optional :overlay, union: -> { Imagekit::Overlay } + + # @!attribute page + # 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). + # + # @return [Float, String, nil] + optional :page, union: -> { Imagekit::Transformation::Page } + + # @!attribute progressive + # 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. + # + # @return [Boolean, nil] + optional :progressive, Imagekit::Internal::Type::Boolean + + # @!attribute quality + # 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. + # + # @return [Float, nil] + optional :quality, Float + + # @!attribute radius + # Specifies the corner radius for rounded corners (e.g., 20) or `max` for + # circular/oval shapes. + # + # @return [Float, Symbol, Imagekit::Models::Transformation::Radius, nil] + optional :radius, union: -> { Imagekit::Transformation::Radius } + + # @!attribute raw + # Pass any transformation not directly supported by the SDK. This transformation + # string is appended to the URL as provided. + # + # @return [String, nil] + optional :raw, String + + # @!attribute rotation + # 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. + # + # @return [Float, String, nil] + optional :rotation, union: -> { Imagekit::Transformation::Rotation } + + # @!attribute shadow + # 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. + # + # @return [Boolean, String, Imagekit::Models::Transformation::Shadow, nil] + optional :shadow, union: -> { Imagekit::Transformation::Shadow } + + # @!attribute sharpen + # Sharpens the input image, highlighting edges and finer details. Pass `true` for + # default sharpening, or provide a numeric value for custom sharpening. + # + # @return [Boolean, Float, Imagekit::Models::Transformation::Sharpen, nil] + optional :sharpen, union: -> { Imagekit::Transformation::Sharpen } + + # @!attribute start_offset + # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or + # `10.5`. Arithmetic expressions are also supported. + # + # @return [Float, String, nil] + optional :start_offset, union: -> { Imagekit::Transformation::StartOffset }, api_name: :startOffset + + # @!attribute streaming_resolutions + # An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, + # `480`, `720`, `1080`]. + # + # @return [Array, nil] + optional :streaming_resolutions, + -> { Imagekit::Internal::Type::ArrayOf[enum: Imagekit::StreamingResolution] }, + api_name: :streamingResolutions + + # @!attribute trim + # 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. + # + # @return [Boolean, Float, Imagekit::Models::Transformation::Trim, nil] + optional :trim, union: -> { Imagekit::Transformation::Trim } + + # @!attribute unsharp_mask + # Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a + # default unsharp mask, or provide a string for a custom unsharp mask. + # + # @return [Boolean, String, Imagekit::Models::Transformation::UnsharpMask, nil] + optional :unsharp_mask, union: -> { Imagekit::Transformation::UnsharpMask }, api_name: :unsharpMask + + # @!attribute video_codec + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # + # @return [Symbol, Imagekit::Models::Transformation::VideoCodec, nil] + optional :video_codec, enum: -> { Imagekit::Transformation::VideoCodec }, api_name: :videoCodec + + # @!attribute width + # 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`). + # + # @return [Float, String, nil] + optional :width, union: -> { Imagekit::Transformation::Width } + + # @!attribute x + # Focus using cropped image coordinates - X coordinate + # + # @return [Float, String, nil] + optional :x, union: -> { Imagekit::Transformation::X } + + # @!attribute x_center + # Focus using cropped image coordinates - X center coordinate + # + # @return [Float, String, nil] + optional :x_center, union: -> { Imagekit::Transformation::XCenter }, api_name: :xCenter + + # @!attribute y_ + # Focus using cropped image coordinates - Y coordinate + # + # @return [Float, String, nil] + optional :y_, union: -> { Imagekit::Transformation::Y }, api_name: :y + + # @!attribute y_center + # Focus using cropped image coordinates - Y center coordinate + # + # @return [Float, String, nil] + optional :y_center, union: -> { Imagekit::Transformation::YCenter }, api_name: :yCenter + + # @!attribute zoom + # 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-. + # + # @return [Float, nil] + optional :zoom, Float + + # @!method initialize(ai_change_background: nil, ai_drop_shadow: nil, ai_remove_background: nil, ai_remove_background_external: nil, ai_retouch: nil, ai_upscale: nil, ai_variation: nil, aspect_ratio: nil, audio_codec: nil, background: nil, blur: nil, border: nil, color_profile: nil, contrast_stretch: nil, crop: nil, crop_mode: nil, default_image: nil, dpr: nil, duration: nil, end_offset: nil, flip: nil, focus: nil, format_: nil, gradient: nil, grayscale: nil, height: nil, lossless: nil, metadata: nil, named: nil, opacity: nil, original: nil, overlay: nil, page: nil, progressive: nil, quality: nil, radius: nil, raw: nil, rotation: nil, shadow: nil, sharpen: nil, start_offset: nil, streaming_resolutions: nil, trim: nil, unsharp_mask: nil, video_codec: nil, width: nil, x: nil, x_center: nil, y_: nil, y_center: nil, zoom: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Transformation} for more details. + # + # The SDK provides easy-to-use names for transformations. These names are + # converted to the corresponding transformation string before being added to the + # URL. SDKs are updated regularly to support new transformations. If you want to + # use a transformation that is not supported by the SDK, You can use the `raw` + # parameter to pass the transformation string directly. + # + # @param ai_change_background [String] Uses AI to change the background. Provide a text prompt or a base64-encoded prom + # + # @param ai_drop_shadow [Boolean, String, Imagekit::Models::Transformation::AIDropShadow] Adds an AI-based drop shadow around a foreground object on a transparent or remo + # + # @param ai_remove_background [Boolean, Imagekit::Models::Transformation::AIRemoveBackground] Applies ImageKit's in-house background removal. + # + # @param ai_remove_background_external [Boolean, Imagekit::Models::Transformation::AIRemoveBackgroundExternal] Uses third-party background removal. + # + # @param ai_retouch [Boolean, Imagekit::Models::Transformation::AIRetouch] Performs AI-based retouching to improve faces or product shots. Not supported in + # + # @param ai_upscale [Boolean, Imagekit::Models::Transformation::AIUpscale] Upscales images beyond their original dimensions using AI. Not supported inside + # + # @param ai_variation [Boolean, Imagekit::Models::Transformation::AIVariation] Generates a variation of an image using AI. This produces a new image with sligh + # + # @param aspect_ratio [Float, String] Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with e + # + # @param audio_codec [Symbol, Imagekit::Models::Transformation::AudioCodec] Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # + # @param background [String] Specifies the background to be used in conjunction with certain cropping strateg + # + # @param blur [Float] Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, o + # + # @param border [String] Adds a border to the output media. Accepts a string in the format `] An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `48 + # + # @param trim [Boolean, Float, Imagekit::Models::Transformation::Trim] Useful for images with a solid or nearly solid background and a central object. + # + # @param unsharp_mask [Boolean, String, Imagekit::Models::Transformation::UnsharpMask] Applies Unsharp Masking (USM), an image sharpening technique. + # + # @param video_codec [Symbol, Imagekit::Models::Transformation::VideoCodec] Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # + # @param width [Float, String] Specifies the width of the output. If a value between 0 and 1 is provided, it is + # + # @param x [Float, String] Focus using cropped image coordinates - X coordinate + # + # @param x_center [Float, String] Focus using cropped image coordinates - X center coordinate + # + # @param y_ [Float, String] Focus using cropped image coordinates - Y coordinate + # + # @param y_center [Float, String] Focus using cropped image coordinates - Y center coordinate + # + # @param zoom [Float] Accepts a numeric value that determines how much to zoom in or out of the croppe + + # 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 Imagekit::Models::Transformation#ai_drop_shadow + module AIDropShadow + extend Imagekit::Internal::Type::Union + + variant const: -> { Imagekit::Models::Transformation::AIDropShadow::TRUE } + + variant String + + # @!method self.variants + # @return [Array(Boolean, String)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Imagekit::Transformation::AIDropShadow::TaggedBoolean, String) } + end + + # @!group + + TRUE = true + + # @!endgroup + end + + # Applies ImageKit's in-house background removal. Supported inside overlay. + # + # @see Imagekit::Models::Transformation#ai_remove_background + module AIRemoveBackground + extend Imagekit::Internal::Type::Enum + + TRUE = true + + # @!method self.values + # @return [Array] + end + + # 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 Imagekit::Models::Transformation#ai_remove_background_external + module AIRemoveBackgroundExternal + extend Imagekit::Internal::Type::Enum + + TRUE = true + + # @!method self.values + # @return [Array] + end + + # Performs AI-based retouching to improve faces or product shots. Not supported + # inside overlay. + # + # @see Imagekit::Models::Transformation#ai_retouch + module AIRetouch + extend Imagekit::Internal::Type::Enum + + TRUE = true + + # @!method self.values + # @return [Array] + end + + # Upscales images beyond their original dimensions using AI. Not supported inside + # overlay. + # + # @see Imagekit::Models::Transformation#ai_upscale + module AIUpscale + extend Imagekit::Internal::Type::Enum + + TRUE = true + + # @!method self.values + # @return [Array] + end + + # 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 Imagekit::Models::Transformation#ai_variation + module AIVariation + extend Imagekit::Internal::Type::Enum + + TRUE = true + + # @!method self.values + # @return [Array] + end + + # 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 Imagekit::Models::Transformation#aspect_ratio + module AspectRatio + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # + # @see Imagekit::Models::Transformation#audio_codec + module AudioCodec + extend Imagekit::Internal::Type::Enum + + AAC = :aac + OPUS = :opus + NONE = :none + + # @!method self.values + # @return [Array] + end + + # Automatically enhances the contrast of an image (contrast stretch). + # + # @see Imagekit::Models::Transformation#contrast_stretch + module ContrastStretch + extend Imagekit::Internal::Type::Enum + + TRUE = true + + # @!method self.values + # @return [Array] + end + + # Crop modes for image resizing + # + # @see Imagekit::Models::Transformation#crop + module Crop + extend Imagekit::Internal::Type::Enum + + FORCE = :force + AT_MAX = :at_max + AT_MAX_ENLARGE = :at_max_enlarge + AT_LEAST = :at_least + MAINTAIN_RATIO = :maintain_ratio + + # @!method self.values + # @return [Array] + end + + # Additional crop modes for image resizing + # + # @see Imagekit::Models::Transformation#crop_mode + module CropMode + extend Imagekit::Internal::Type::Enum + + PAD_RESIZE = :pad_resize + EXTRACT = :extract + PAD_EXTRACT = :pad_extract + + # @!method self.values + # @return [Array] + end + + # 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 Imagekit::Models::Transformation#duration + module Duration + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # 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 Imagekit::Models::Transformation#end_offset + module EndOffset + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # 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 Imagekit::Models::Transformation#flip + module Flip + extend Imagekit::Internal::Type::Enum + + H = :h + V = :v + H_V = :h_v + V_H = :v_h + + # @!method self.values + # @return [Array] + end + + # 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 Imagekit::Models::Transformation#format_ + module Format + extend Imagekit::Internal::Type::Enum + + AUTO = :auto + WEBP = :webp + JPG = :jpg + JPEG = :jpeg + PNG = :png + GIF = :gif + SVG = :svg + MP4 = :mp4 + WEBM = :webm + AVIF = :avif + ORIG = :orig + + # @!method self.values + # @return [Array] + end + + # Creates a linear gradient with two colors. Pass `true` for a default gradient, + # or provide a string for a custom gradient. + # + # @see Imagekit::Models::Transformation#gradient + module Gradient + extend Imagekit::Internal::Type::Union + + variant const: -> { Imagekit::Models::Transformation::Gradient::TRUE } + + variant String + + # @!method self.variants + # @return [Array(Boolean, String)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Imagekit::Transformation::Gradient::TaggedBoolean, String) } + end + + # @!group + + TRUE = true + + # @!endgroup + end + + # Enables a grayscale effect for images. + # + # @see Imagekit::Models::Transformation#grayscale + module Grayscale + extend Imagekit::Internal::Type::Enum + + TRUE = true + + # @!method self.values + # @return [Array] + end + + # 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`). + # + # @see Imagekit::Models::Transformation#height + module Height + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # 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 Imagekit::Models::Transformation#page + module Page + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Specifies the corner radius for rounded corners (e.g., 20) or `max` for + # circular/oval shapes. + # + # @see Imagekit::Models::Transformation#radius + module Radius + extend Imagekit::Internal::Type::Union + + variant Float + + variant const: -> { Imagekit::Models::Transformation::Radius::MAX } + + # @!method self.variants + # @return [Array(Float, Symbol)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Float, Imagekit::Transformation::Radius::TaggedSymbol) } + end + + # @!group + + MAX = :max + + # @!endgroup + end + + # 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 Imagekit::Models::Transformation#rotation + module Rotation + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # 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 Imagekit::Models::Transformation#shadow + module Shadow + extend Imagekit::Internal::Type::Union + + variant const: -> { Imagekit::Models::Transformation::Shadow::TRUE } + + variant String + + # @!method self.variants + # @return [Array(Boolean, String)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Imagekit::Transformation::Shadow::TaggedBoolean, String) } + end + + # @!group + + TRUE = true + + # @!endgroup + end + + # Sharpens the input image, highlighting edges and finer details. Pass `true` for + # default sharpening, or provide a numeric value for custom sharpening. + # + # @see Imagekit::Models::Transformation#sharpen + module Sharpen + extend Imagekit::Internal::Type::Union + + variant const: -> { Imagekit::Models::Transformation::Sharpen::TRUE } + + variant Float + + # @!method self.variants + # @return [Array(Boolean, Float)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Imagekit::Transformation::Sharpen::TaggedBoolean, Float) } + end + + # @!group + + TRUE = true + + # @!endgroup + end + + # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or + # `10.5`. Arithmetic expressions are also supported. + # + # @see Imagekit::Models::Transformation#start_offset + module StartOffset + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # 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 Imagekit::Models::Transformation#trim + module Trim + extend Imagekit::Internal::Type::Union + + variant const: -> { Imagekit::Models::Transformation::Trim::TRUE } + + variant Float + + # @!method self.variants + # @return [Array(Boolean, Float)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Imagekit::Transformation::Trim::TaggedBoolean, Float) } + end + + # @!group + + TRUE = true + + # @!endgroup + end + + # 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 Imagekit::Models::Transformation#unsharp_mask + module UnsharpMask + extend Imagekit::Internal::Type::Union + + variant const: -> { Imagekit::Models::Transformation::UnsharpMask::TRUE } + + variant String + + # @!method self.variants + # @return [Array(Boolean, String)] + + define_sorbet_constant!(:Variants) do + T.type_alias { T.any(Imagekit::Transformation::UnsharpMask::TaggedBoolean, String) } + end + + # @!group + + TRUE = true + + # @!endgroup + end + + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # + # @see Imagekit::Models::Transformation#video_codec + module VideoCodec + extend Imagekit::Internal::Type::Enum + + H264 = :h264 + VP9 = :vp9 + AV1 = :av1 + NONE = :none + + # @!method self.values + # @return [Array] + end + + # 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`). + # + # @see Imagekit::Models::Transformation#width + module Width + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Focus using cropped image coordinates - X coordinate + # + # @see Imagekit::Models::Transformation#x + module X + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Focus using cropped image coordinates - X center coordinate + # + # @see Imagekit::Models::Transformation#x_center + module XCenter + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Focus using cropped image coordinates - Y coordinate + # + # @see Imagekit::Models::Transformation#y_ + module Y + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + + # Focus using cropped image coordinates - Y center coordinate + # + # @see Imagekit::Models::Transformation#y_center + module YCenter + extend Imagekit::Internal::Type::Union + + variant Float + + variant String + + # @!method self.variants + # @return [Array(Float, String)] + end + end + end +end diff --git a/lib/imagekit/models/transformation_position.rb b/lib/imagekit/models/transformation_position.rb new file mode 100644 index 00000000..31246e1e --- /dev/null +++ b/lib/imagekit/models/transformation_position.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +module Imagekit + module Models + # 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`. + module TransformationPosition + extend Imagekit::Internal::Type::Enum + + PATH = :path + QUERY = :query + + # @!method self.values + # @return [Array] + end + end +end diff --git a/lib/imagekit/models/video_overlay.rb b/lib/imagekit/models/video_overlay.rb new file mode 100644 index 00000000..8d3ebad4 --- /dev/null +++ b/lib/imagekit/models/video_overlay.rb @@ -0,0 +1,72 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class VideoOverlay < Imagekit::Models::BaseOverlay + # @!attribute input + # Specifies the relative path to the video used as an overlay. + # + # @return [String] + required :input, String + + # @!attribute type + # + # @return [Symbol, Imagekit::Models::VideoOverlay::Type] + required :type, enum: -> { Imagekit::VideoOverlay::Type } + + # @!attribute encoding + # 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`. + # + # @return [Symbol, Imagekit::Models::VideoOverlay::Encoding, nil] + optional :encoding, enum: -> { Imagekit::VideoOverlay::Encoding } + + # @!attribute transformation + # Array of transformation to be applied to the overlay video. Except + # `streamingResolutions`, all other video transformations are supported. + # + # @return [Array, nil] + optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } + + # @!method initialize(input:, type:, encoding: nil, transformation: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::VideoOverlay} for more details. + # + # @param input [String] Specifies the relative path to the video used as an overlay. + # + # @param type [Symbol, Imagekit::Models::VideoOverlay::Type] + # + # @param encoding [Symbol, Imagekit::Models::VideoOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 + # + # @param transformation [Array] Array of transformation to be applied to the overlay video. Except `streamingRes + + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO = :video + + # @!method self.values + # @return [Array] + end + + # 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`. + module Encoding + extend Imagekit::Internal::Type::Enum + + AUTO = :auto + PLAIN = :plain + BASE64 = :base64 + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index ba4b9b2b..95e6fa74 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -5,6 +5,8 @@ module Imagekit AssetListParams = Imagekit::Models::AssetListParams + BaseOverlay = Imagekit::Models::BaseOverlay + Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache @@ -55,12 +57,44 @@ module Imagekit Folders = Imagekit::Models::Folders + ImageOverlay = Imagekit::Models::ImageOverlay + Metadata = Imagekit::Models::Metadata + Overlay = Imagekit::Models::Overlay + + OverlayPosition = Imagekit::Models::OverlayPosition + + OverlayTiming = Imagekit::Models::OverlayTiming + + SolidColorOverlay = Imagekit::Models::SolidColorOverlay + + SolidColorOverlayTransformation = + Imagekit::Models::SolidColorOverlayTransformation + + SrcOptions = Imagekit::Models::SrcOptions + + StreamingResolution = Imagekit::Models::StreamingResolution + + SubtitleOverlay = Imagekit::Models::SubtitleOverlay + + SubtitleOverlayTransformation = + Imagekit::Models::SubtitleOverlayTransformation + + TextOverlay = Imagekit::Models::TextOverlay + + TextOverlayTransformation = Imagekit::Models::TextOverlayTransformation + + Transformation = Imagekit::Models::Transformation + + TransformationPosition = Imagekit::Models::TransformationPosition + UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + VideoOverlay = Imagekit::Models::VideoOverlay + VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent diff --git a/rbi/imagekit/models/base_overlay.rbi b/rbi/imagekit/models/base_overlay.rbi new file mode 100644 index 00000000..fc1a6eea --- /dev/null +++ b/rbi/imagekit/models/base_overlay.rbi @@ -0,0 +1,44 @@ +# typed: strong + +module Imagekit + module Models + class BaseOverlay < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::BaseOverlay, Imagekit::Internal::AnyHash) + end + + sig { returns(T.nilable(Imagekit::OverlayPosition)) } + attr_reader :position + + sig { params(position: Imagekit::OverlayPosition::OrHash).void } + attr_writer :position + + sig { returns(T.nilable(Imagekit::OverlayTiming)) } + attr_reader :timing + + sig { params(timing: Imagekit::OverlayTiming::OrHash).void } + attr_writer :timing + + sig do + params( + position: Imagekit::OverlayPosition::OrHash, + timing: Imagekit::OverlayTiming::OrHash + ).returns(T.attached_class) + end + def self.new(position: nil, timing: nil) + end + + sig do + override.returns( + { + position: Imagekit::OverlayPosition, + timing: Imagekit::OverlayTiming + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/image_overlay.rbi b/rbi/imagekit/models/image_overlay.rbi new file mode 100644 index 00000000..b34471e5 --- /dev/null +++ b/rbi/imagekit/models/image_overlay.rbi @@ -0,0 +1,116 @@ +# typed: strong + +module Imagekit + module Models + class ImageOverlay < Imagekit::Models::BaseOverlay + OrHash = + T.type_alias do + T.any(Imagekit::ImageOverlay, Imagekit::Internal::AnyHash) + end + + # Specifies the relative path to the image used as an overlay. + sig { returns(String) } + attr_accessor :input + + sig { returns(Imagekit::ImageOverlay::Type::OrSymbol) } + attr_accessor :type + + # 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`. + sig { returns(T.nilable(Imagekit::ImageOverlay::Encoding::OrSymbol)) } + attr_reader :encoding + + sig { params(encoding: Imagekit::ImageOverlay::Encoding::OrSymbol).void } + attr_writer :encoding + + # Array of transformations to be applied to the overlay image. Supported + # transformations depends on the base/parent asset. + sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } + attr_reader :transformation + + sig { params(transformation: T::Array[Imagekit::Transformation]).void } + attr_writer :transformation + + sig do + params( + input: String, + type: Imagekit::ImageOverlay::Type::OrSymbol, + encoding: Imagekit::ImageOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekit::Transformation] + ).returns(T.attached_class) + end + def self.new( + # Specifies the relative path to the image used as an overlay. + input:, + type:, + # 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`. + encoding: nil, + # Array of transformations to be applied to the overlay image. Supported + # transformations depends on the base/parent asset. + transformation: nil + ) + end + + sig do + override.returns( + { + input: String, + type: Imagekit::ImageOverlay::Type::OrSymbol, + encoding: Imagekit::ImageOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekit::Transformation] + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::ImageOverlay::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + IMAGE = T.let(:image, Imagekit::ImageOverlay::Type::TaggedSymbol) + + sig do + override.returns(T::Array[Imagekit::ImageOverlay::Type::TaggedSymbol]) + end + def self.values + end + end + + # 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`. + module Encoding + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::ImageOverlay::Encoding) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AUTO = T.let(:auto, Imagekit::ImageOverlay::Encoding::TaggedSymbol) + PLAIN = T.let(:plain, Imagekit::ImageOverlay::Encoding::TaggedSymbol) + BASE64 = T.let(:base64, Imagekit::ImageOverlay::Encoding::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::ImageOverlay::Encoding::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/overlay.rbi b/rbi/imagekit/models/overlay.rbi new file mode 100644 index 00000000..8de9c66d --- /dev/null +++ b/rbi/imagekit/models/overlay.rbi @@ -0,0 +1,26 @@ +# typed: strong + +module Imagekit + module Models + # Specifies an overlay to be applied on the parent image or video. ImageKit + # supports overlays including images, text, videos, subtitles, and solid colors. + module Overlay + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::TextOverlay, + Imagekit::ImageOverlay, + Imagekit::VideoOverlay, + Imagekit::SubtitleOverlay, + Imagekit::SolidColorOverlay + ) + end + + sig { override.returns(T::Array[Imagekit::Overlay::Variants]) } + def self.variants + end + end + end +end diff --git a/rbi/imagekit/models/overlay_position.rbi b/rbi/imagekit/models/overlay_position.rbi new file mode 100644 index 00000000..f5ca4087 --- /dev/null +++ b/rbi/imagekit/models/overlay_position.rbi @@ -0,0 +1,134 @@ +# typed: strong + +module Imagekit + module Models + class OverlayPosition < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::OverlayPosition, Imagekit::Internal::AnyHash) + end + + # Specifies the position of the overlay relative to the parent image or video. + # Maps to `lfo` in the URL. + sig { returns(T.nilable(Imagekit::OverlayPosition::Focus::OrSymbol)) } + attr_reader :focus + + sig { params(focus: Imagekit::OverlayPosition::Focus::OrSymbol).void } + attr_writer :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. + sig { returns(T.nilable(Imagekit::OverlayPosition::X::Variants)) } + attr_reader :x + + sig { params(x: Imagekit::OverlayPosition::X::Variants).void } + attr_writer :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. + sig { returns(T.nilable(Imagekit::OverlayPosition::Y::Variants)) } + attr_reader :y_ + + sig { params(y_: Imagekit::OverlayPosition::Y::Variants).void } + attr_writer :y_ + + sig do + params( + focus: Imagekit::OverlayPosition::Focus::OrSymbol, + x: Imagekit::OverlayPosition::X::Variants, + y_: Imagekit::OverlayPosition::Y::Variants + ).returns(T.attached_class) + end + def self.new( + # Specifies the position of the overlay relative to the parent image or video. + # Maps to `lfo` in the URL. + focus: nil, + # 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. + x: nil, + # 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. + y_: nil + ) + end + + sig do + override.returns( + { + focus: Imagekit::OverlayPosition::Focus::OrSymbol, + x: Imagekit::OverlayPosition::X::Variants, + y_: Imagekit::OverlayPosition::Y::Variants + } + ) + end + def to_hash + end + + # Specifies the position of the overlay relative to the parent image or video. + # Maps to `lfo` in the URL. + module Focus + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::OverlayPosition::Focus) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CENTER = T.let(:center, Imagekit::OverlayPosition::Focus::TaggedSymbol) + TOP = T.let(:top, Imagekit::OverlayPosition::Focus::TaggedSymbol) + LEFT = T.let(:left, Imagekit::OverlayPosition::Focus::TaggedSymbol) + BOTTOM = T.let(:bottom, Imagekit::OverlayPosition::Focus::TaggedSymbol) + RIGHT = T.let(:right, Imagekit::OverlayPosition::Focus::TaggedSymbol) + TOP_LEFT = + T.let(:top_left, Imagekit::OverlayPosition::Focus::TaggedSymbol) + TOP_RIGHT = + T.let(:top_right, Imagekit::OverlayPosition::Focus::TaggedSymbol) + BOTTOM_LEFT = + T.let(:bottom_left, Imagekit::OverlayPosition::Focus::TaggedSymbol) + BOTTOM_RIGHT = + T.let(:bottom_right, Imagekit::OverlayPosition::Focus::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::OverlayPosition::Focus::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module X + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::OverlayPosition::X::Variants]) + end + def self.variants + end + end + + # 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. + module Y + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::OverlayPosition::Y::Variants]) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/overlay_timing.rbi b/rbi/imagekit/models/overlay_timing.rbi new file mode 100644 index 00000000..50d25cae --- /dev/null +++ b/rbi/imagekit/models/overlay_timing.rbi @@ -0,0 +1,133 @@ +# typed: strong + +module Imagekit + module Models + class OverlayTiming < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::OverlayTiming, Imagekit::Internal::AnyHash) + end + + # 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. + sig { returns(T.nilable(Imagekit::OverlayTiming::Duration::Variants)) } + attr_reader :duration + + sig { params(duration: Imagekit::OverlayTiming::Duration::Variants).void } + attr_writer :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. + sig { returns(T.nilable(Imagekit::OverlayTiming::End::Variants)) } + attr_reader :end_ + + sig { params(end_: Imagekit::OverlayTiming::End::Variants).void } + attr_writer :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. + sig { returns(T.nilable(Imagekit::OverlayTiming::Start::Variants)) } + attr_reader :start + + sig { params(start: Imagekit::OverlayTiming::Start::Variants).void } + attr_writer :start + + sig do + params( + duration: Imagekit::OverlayTiming::Duration::Variants, + end_: Imagekit::OverlayTiming::End::Variants, + start: Imagekit::OverlayTiming::Start::Variants + ).returns(T.attached_class) + end + def self.new( + # 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. + duration: nil, + # 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. + end_: nil, + # 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. + start: nil + ) + end + + sig do + override.returns( + { + duration: Imagekit::OverlayTiming::Duration::Variants, + end_: Imagekit::OverlayTiming::End::Variants, + start: Imagekit::OverlayTiming::Start::Variants + } + ) + end + def to_hash + end + + # 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. + module Duration + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::OverlayTiming::Duration::Variants] + ) + end + def self.variants + end + end + + # 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. + module End + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::OverlayTiming::End::Variants]) + end + def self.variants + end + 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. + module Start + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::OverlayTiming::Start::Variants]) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/solid_color_overlay.rbi b/rbi/imagekit/models/solid_color_overlay.rbi new file mode 100644 index 00000000..71b3cedc --- /dev/null +++ b/rbi/imagekit/models/solid_color_overlay.rbi @@ -0,0 +1,89 @@ +# typed: strong + +module Imagekit + module Models + class SolidColorOverlay < Imagekit::Models::BaseOverlay + OrHash = + T.type_alias do + T.any(Imagekit::SolidColorOverlay, Imagekit::Internal::AnyHash) + end + + # 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). + sig { returns(String) } + attr_accessor :color + + sig { returns(Imagekit::SolidColorOverlay::Type::OrSymbol) } + attr_accessor :type + + # Control width and height of the solid color overlay. Supported transformations + # depend on the base/parent asset. + sig do + returns(T.nilable(T::Array[Imagekit::SolidColorOverlayTransformation])) + end + attr_reader :transformation + + sig do + params( + transformation: + T::Array[Imagekit::SolidColorOverlayTransformation::OrHash] + ).void + end + attr_writer :transformation + + sig do + params( + color: String, + type: Imagekit::SolidColorOverlay::Type::OrSymbol, + transformation: + T::Array[Imagekit::SolidColorOverlayTransformation::OrHash] + ).returns(T.attached_class) + end + def self.new( + # 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). + color:, + type:, + # Control width and height of the solid color overlay. Supported transformations + # depend on the base/parent asset. + transformation: nil + ) + end + + sig do + override.returns( + { + color: String, + type: Imagekit::SolidColorOverlay::Type::OrSymbol, + transformation: T::Array[Imagekit::SolidColorOverlayTransformation] + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::SolidColorOverlay::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SOLID_COLOR = + T.let(:solidColor, Imagekit::SolidColorOverlay::Type::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::SolidColorOverlay::Type::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/solid_color_overlay_transformation.rbi b/rbi/imagekit/models/solid_color_overlay_transformation.rbi new file mode 100644 index 00000000..1836cb91 --- /dev/null +++ b/rbi/imagekit/models/solid_color_overlay_transformation.rbi @@ -0,0 +1,269 @@ +# typed: strong + +module Imagekit + module Models + class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::SolidColorOverlayTransformation, + Imagekit::Internal::AnyHash + ) + end + + # Alpha transparency level + sig { returns(T.nilable(Float)) } + attr_reader :alpha + + sig { params(alpha: Float).void } + attr_writer :alpha + + # Background color + sig { returns(T.nilable(String)) } + attr_reader :background + + sig { params(background: String).void } + attr_writer :background + + # Gradient effect for the overlay + sig do + returns( + T.nilable( + T.any( + Imagekit::SolidColorOverlayTransformation::Gradient::OrBoolean, + String + ) + ) + ) + end + attr_reader :gradient + + sig do + params( + gradient: + T.any( + Imagekit::SolidColorOverlayTransformation::Gradient::OrBoolean, + String + ) + ).void + end + attr_writer :gradient + + # Height of the solid color overlay + sig do + returns( + T.nilable(Imagekit::SolidColorOverlayTransformation::Height::Variants) + ) + end + attr_reader :height + + sig do + params( + height: Imagekit::SolidColorOverlayTransformation::Height::Variants + ).void + end + attr_writer :height + + # Corner radius of the solid color overlay + sig do + returns( + T.nilable( + T.any( + Float, + Imagekit::SolidColorOverlayTransformation::Radius::OrSymbol + ) + ) + ) + end + attr_reader :radius + + sig do + params( + radius: + T.any( + Float, + Imagekit::SolidColorOverlayTransformation::Radius::OrSymbol + ) + ).void + end + attr_writer :radius + + # Width of the solid color overlay + sig do + returns( + T.nilable(Imagekit::SolidColorOverlayTransformation::Width::Variants) + ) + end + attr_reader :width + + sig do + params( + width: Imagekit::SolidColorOverlayTransformation::Width::Variants + ).void + end + attr_writer :width + + sig do + params( + alpha: Float, + background: String, + gradient: + T.any( + Imagekit::SolidColorOverlayTransformation::Gradient::OrBoolean, + String + ), + height: Imagekit::SolidColorOverlayTransformation::Height::Variants, + radius: + T.any( + Float, + Imagekit::SolidColorOverlayTransformation::Radius::OrSymbol + ), + width: Imagekit::SolidColorOverlayTransformation::Width::Variants + ).returns(T.attached_class) + end + def self.new( + # Alpha transparency level + alpha: nil, + # Background color + background: nil, + # Gradient effect for the overlay + gradient: nil, + # Height of the solid color overlay + height: nil, + # Corner radius of the solid color overlay + radius: nil, + # Width of the solid color overlay + width: nil + ) + end + + sig do + override.returns( + { + alpha: Float, + background: String, + gradient: + T.any( + Imagekit::SolidColorOverlayTransformation::Gradient::OrBoolean, + String + ), + height: Imagekit::SolidColorOverlayTransformation::Height::Variants, + radius: + T.any( + Float, + Imagekit::SolidColorOverlayTransformation::Radius::OrSymbol + ), + width: Imagekit::SolidColorOverlayTransformation::Width::Variants + } + ) + end + def to_hash + end + + # Gradient effect for the overlay + module Gradient + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::SolidColorOverlayTransformation::Gradient::TaggedBoolean, + String + ) + end + + sig do + override.returns( + T::Array[ + Imagekit::SolidColorOverlayTransformation::Gradient::Variants + ] + ) + end + def self.variants + end + + TaggedBoolean = + T.type_alias do + T.all( + T::Boolean, + Imagekit::SolidColorOverlayTransformation::Gradient + ) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = + T.let( + true, + Imagekit::SolidColorOverlayTransformation::Gradient::TaggedBoolean + ) + end + + # Height of the solid color overlay + module Height + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[ + Imagekit::SolidColorOverlayTransformation::Height::Variants + ] + ) + end + def self.variants + end + end + + # Corner radius of the solid color overlay + module Radius + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Float, + Imagekit::SolidColorOverlayTransformation::Radius::TaggedSymbol + ) + end + + sig do + override.returns( + T::Array[ + Imagekit::SolidColorOverlayTransformation::Radius::Variants + ] + ) + end + def self.variants + end + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::SolidColorOverlayTransformation::Radius) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + MAX = + T.let( + :max, + Imagekit::SolidColorOverlayTransformation::Radius::TaggedSymbol + ) + end + + # Width of the solid color overlay + module Width + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::SolidColorOverlayTransformation::Width::Variants] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/src_options.rbi b/rbi/imagekit/models/src_options.rbi new file mode 100644 index 00000000..9283129a --- /dev/null +++ b/rbi/imagekit/models/src_options.rbi @@ -0,0 +1,130 @@ +# typed: strong + +module Imagekit + module Models + class SrcOptions < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::SrcOptions, Imagekit::Internal::AnyHash) + end + + # 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. + sig { returns(String) } + attr_accessor :src + + # Get your urlEndpoint from the + # [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints). + sig { returns(String) } + attr_accessor :url_endpoint + + # 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. + sig do + returns( + T.nilable( + T::Hash[Symbol, Imagekit::SrcOptions::QueryParameter::Variants] + ) + ) + end + attr_reader :query_parameters + + sig do + params( + query_parameters: + T::Hash[Symbol, Imagekit::SrcOptions::QueryParameter::Variants] + ).void + end + attr_writer :query_parameters + + # 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. + sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } + attr_reader :transformation + + sig do + params(transformation: T::Array[Imagekit::Transformation::OrHash]).void + end + attr_writer :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`. + sig { returns(T.nilable(Imagekit::TransformationPosition::OrSymbol)) } + attr_reader :transformation_position + + sig do + params( + transformation_position: Imagekit::TransformationPosition::OrSymbol + ).void + end + attr_writer :transformation_position + + # Options for generating ImageKit URLs with transformations + sig do + params( + src: String, + url_endpoint: String, + query_parameters: + T::Hash[Symbol, Imagekit::SrcOptions::QueryParameter::Variants], + transformation: T::Array[Imagekit::Transformation::OrHash], + transformation_position: Imagekit::TransformationPosition::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # 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. + src:, + # Get your urlEndpoint from the + # [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints). + url_endpoint:, + # 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. + query_parameters: nil, + # 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. + transformation: nil, + # 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`. + transformation_position: nil + ) + end + + sig do + override.returns( + { + src: String, + url_endpoint: String, + query_parameters: + T::Hash[Symbol, Imagekit::SrcOptions::QueryParameter::Variants], + transformation: T::Array[Imagekit::Transformation], + transformation_position: Imagekit::TransformationPosition::OrSymbol + } + ) + end + def to_hash + end + + module QueryParameter + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[Imagekit::SrcOptions::QueryParameter::Variants] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/streaming_resolution.rbi b/rbi/imagekit/models/streaming_resolution.rbi new file mode 100644 index 00000000..41bd7f5d --- /dev/null +++ b/rbi/imagekit/models/streaming_resolution.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Imagekit + module Models + # Available streaming resolutions for adaptive bitrate streaming + module StreamingResolution + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::StreamingResolution) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + STREAMING_RESOLUTION_240 = + T.let(:"240", Imagekit::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_360 = + T.let(:"360", Imagekit::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_480 = + T.let(:"480", Imagekit::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_720 = + T.let(:"720", Imagekit::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_1080 = + T.let(:"1080", Imagekit::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_1440 = + T.let(:"1440", Imagekit::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_2160 = + T.let(:"2160", Imagekit::StreamingResolution::TaggedSymbol) + + sig do + override.returns(T::Array[Imagekit::StreamingResolution::TaggedSymbol]) + end + def self.values + end + end + end +end diff --git a/rbi/imagekit/models/subtitle_overlay.rbi b/rbi/imagekit/models/subtitle_overlay.rbi new file mode 100644 index 00000000..909ddf47 --- /dev/null +++ b/rbi/imagekit/models/subtitle_overlay.rbi @@ -0,0 +1,128 @@ +# typed: strong + +module Imagekit + module Models + class SubtitleOverlay < Imagekit::Models::BaseOverlay + OrHash = + T.type_alias do + T.any(Imagekit::SubtitleOverlay, Imagekit::Internal::AnyHash) + end + + # Specifies the relative path to the subtitle file used as an overlay. + sig { returns(String) } + attr_accessor :input + + sig { returns(Imagekit::SubtitleOverlay::Type::OrSymbol) } + attr_accessor :type + + # 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`. + sig { returns(T.nilable(Imagekit::SubtitleOverlay::Encoding::OrSymbol)) } + attr_reader :encoding + + sig do + params(encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol).void + end + attr_writer :encoding + + # Control styling of the subtitle. + sig do + returns(T.nilable(T::Array[Imagekit::SubtitleOverlayTransformation])) + end + attr_reader :transformation + + sig do + params( + transformation: + T::Array[Imagekit::SubtitleOverlayTransformation::OrHash] + ).void + end + attr_writer :transformation + + sig do + params( + input: String, + type: Imagekit::SubtitleOverlay::Type::OrSymbol, + encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol, + transformation: + T::Array[Imagekit::SubtitleOverlayTransformation::OrHash] + ).returns(T.attached_class) + end + def self.new( + # Specifies the relative path to the subtitle file used as an overlay. + input:, + type:, + # 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`. + encoding: nil, + # Control styling of the subtitle. + transformation: nil + ) + end + + sig do + override.returns( + { + input: String, + type: Imagekit::SubtitleOverlay::Type::OrSymbol, + encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekit::SubtitleOverlayTransformation] + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::SubtitleOverlay::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUBTITLE = + T.let(:subtitle, Imagekit::SubtitleOverlay::Type::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::SubtitleOverlay::Type::TaggedSymbol] + ) + end + def self.values + end + end + + # 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`. + module Encoding + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::SubtitleOverlay::Encoding) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AUTO = T.let(:auto, Imagekit::SubtitleOverlay::Encoding::TaggedSymbol) + PLAIN = T.let(:plain, Imagekit::SubtitleOverlay::Encoding::TaggedSymbol) + BASE64 = + T.let(:base64, Imagekit::SubtitleOverlay::Encoding::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::SubtitleOverlay::Encoding::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/subtitle_overlay_transformation.rbi b/rbi/imagekit/models/subtitle_overlay_transformation.rbi new file mode 100644 index 00000000..01341381 --- /dev/null +++ b/rbi/imagekit/models/subtitle_overlay_transformation.rbi @@ -0,0 +1,186 @@ +# typed: strong + +module Imagekit + module Models + class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::SubtitleOverlayTransformation, + Imagekit::Internal::AnyHash + ) + end + + # Background color for subtitles + sig { returns(T.nilable(String)) } + attr_reader :background + + sig { params(background: String).void } + attr_writer :background + + # Text color for subtitles + sig { returns(T.nilable(String)) } + attr_reader :color + + sig { params(color: String).void } + attr_writer :color + + # Font family for subtitles + sig { returns(T.nilable(String)) } + attr_reader :font_family + + sig { params(font_family: String).void } + attr_writer :font_family + + # Font outline for subtitles + sig { returns(T.nilable(String)) } + attr_reader :font_outline + + sig { params(font_outline: String).void } + attr_writer :font_outline + + # Font shadow for subtitles + sig { returns(T.nilable(String)) } + attr_reader :font_shadow + + sig { params(font_shadow: String).void } + attr_writer :font_shadow + + # Font size for subtitles + sig do + returns( + T.nilable(Imagekit::SubtitleOverlayTransformation::FontSize::Variants) + ) + end + attr_reader :font_size + + sig do + params( + font_size: Imagekit::SubtitleOverlayTransformation::FontSize::Variants + ).void + end + attr_writer :font_size + + # Typography style for subtitles + sig do + returns( + T.nilable( + Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + ) + ) + end + attr_reader :typography + + sig do + params( + typography: + Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + ).void + end + attr_writer :typography + + sig do + params( + background: String, + color: String, + font_family: String, + font_outline: String, + font_shadow: String, + font_size: + Imagekit::SubtitleOverlayTransformation::FontSize::Variants, + typography: + Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Background color for subtitles + background: nil, + # Text color for subtitles + color: nil, + # Font family for subtitles + font_family: nil, + # Font outline for subtitles + font_outline: nil, + # Font shadow for subtitles + font_shadow: nil, + # Font size for subtitles + font_size: nil, + # Typography style for subtitles + typography: nil + ) + end + + sig do + override.returns( + { + background: String, + color: String, + font_family: String, + font_outline: String, + font_shadow: String, + font_size: + Imagekit::SubtitleOverlayTransformation::FontSize::Variants, + typography: + Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + } + ) + end + def to_hash + end + + # Font size for subtitles + module FontSize + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[ + Imagekit::SubtitleOverlayTransformation::FontSize::Variants + ] + ) + end + def self.variants + end + end + + # Typography style for subtitles + module Typography + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::SubtitleOverlayTransformation::Typography) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + B = + T.let( + :b, + Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + ) + I = + T.let( + :i, + Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + ) + B_I = + T.let( + :b_i, + Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/text_overlay.rbi b/rbi/imagekit/models/text_overlay.rbi new file mode 100644 index 00000000..35bf6c07 --- /dev/null +++ b/rbi/imagekit/models/text_overlay.rbi @@ -0,0 +1,120 @@ +# typed: strong + +module Imagekit + module Models + class TextOverlay < Imagekit::Models::BaseOverlay + OrHash = + T.type_alias do + T.any(Imagekit::TextOverlay, Imagekit::Internal::AnyHash) + end + + # Specifies the text to be displayed in the overlay. The SDK automatically handles + # special characters and encoding. + sig { returns(String) } + attr_accessor :text + + sig { returns(Imagekit::TextOverlay::Type::OrSymbol) } + attr_accessor :type + + # 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`. + sig { returns(T.nilable(Imagekit::TextOverlay::Encoding::OrSymbol)) } + attr_reader :encoding + + sig { params(encoding: Imagekit::TextOverlay::Encoding::OrSymbol).void } + attr_writer :encoding + + # Control styling of the text overlay. + sig { returns(T.nilable(T::Array[Imagekit::TextOverlayTransformation])) } + attr_reader :transformation + + sig do + params( + transformation: T::Array[Imagekit::TextOverlayTransformation::OrHash] + ).void + end + attr_writer :transformation + + sig do + params( + text: String, + type: Imagekit::TextOverlay::Type::OrSymbol, + encoding: Imagekit::TextOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekit::TextOverlayTransformation::OrHash] + ).returns(T.attached_class) + end + def self.new( + # Specifies the text to be displayed in the overlay. The SDK automatically handles + # special characters and encoding. + text:, + type:, + # 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`. + encoding: nil, + # Control styling of the text overlay. + transformation: nil + ) + end + + sig do + override.returns( + { + text: String, + type: Imagekit::TextOverlay::Type::OrSymbol, + encoding: Imagekit::TextOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekit::TextOverlayTransformation] + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::TextOverlay::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = T.let(:text, Imagekit::TextOverlay::Type::TaggedSymbol) + + sig do + override.returns(T::Array[Imagekit::TextOverlay::Type::TaggedSymbol]) + end + def self.values + end + end + + # 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`. + module Encoding + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::TextOverlay::Encoding) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AUTO = T.let(:auto, Imagekit::TextOverlay::Encoding::TaggedSymbol) + PLAIN = T.let(:plain, Imagekit::TextOverlay::Encoding::TaggedSymbol) + BASE64 = T.let(:base64, Imagekit::TextOverlay::Encoding::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::TextOverlay::Encoding::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/imagekit/models/text_overlay_transformation.rbi b/rbi/imagekit/models/text_overlay_transformation.rbi new file mode 100644 index 00000000..f33ac2f1 --- /dev/null +++ b/rbi/imagekit/models/text_overlay_transformation.rbi @@ -0,0 +1,495 @@ +# typed: strong + +module Imagekit + module Models + class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::TextOverlayTransformation, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the transparency level of the text overlay. Accepts integers from `1` + # to `9`. + sig { returns(T.nilable(Float)) } + attr_reader :alpha + + sig { params(alpha: Float).void } + attr_writer :alpha + + # Specifies the background color of the text overlay. Accepts an RGB hex code, an + # RGBA code, or a color name. + sig { returns(T.nilable(String)) } + attr_reader :background + + sig { params(background: String).void } + attr_writer :background + + # Flip the text overlay horizontally, vertically, or both. + sig do + returns(T.nilable(Imagekit::TextOverlayTransformation::Flip::OrSymbol)) + end + attr_reader :flip + + sig do + params(flip: Imagekit::TextOverlayTransformation::Flip::OrSymbol).void + end + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :font_color + + sig { params(font_color: String).void } + attr_writer :font_color + + # Specifies the font family of the overlaid text. Choose from the supported fonts + # list or use a custom font. + sig { returns(T.nilable(String)) } + attr_reader :font_family + + sig { params(font_family: String).void } + attr_writer :font_family + + # Specifies the font size of the overlaid text. Accepts a numeric value or an + # arithmetic expression. + sig do + returns( + T.nilable(Imagekit::TextOverlayTransformation::FontSize::Variants) + ) + end + attr_reader :font_size + + sig do + params( + font_size: Imagekit::TextOverlayTransformation::FontSize::Variants + ).void + end + attr_writer :font_size + + # Specifies the inner alignment of the text when width is more than the text + # length. + sig do + returns( + T.nilable( + Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol + ) + ) + end + attr_reader :inner_alignment + + sig do + params( + inner_alignment: + Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol + ).void + end + attr_writer :inner_alignment + + # Specifies the line height of the text overlay. + sig do + returns( + T.nilable(Imagekit::TextOverlayTransformation::LineHeight::Variants) + ) + end + attr_reader :line_height + + sig do + params( + line_height: Imagekit::TextOverlayTransformation::LineHeight::Variants + ).void + end + attr_writer :line_height + + # 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. + sig do + returns( + T.nilable(Imagekit::TextOverlayTransformation::Padding::Variants) + ) + end + attr_reader :padding + + sig do + params( + padding: Imagekit::TextOverlayTransformation::Padding::Variants + ).void + end + attr_writer :padding + + # Specifies the corner radius of the text overlay. Set to `max` to achieve a + # circular or oval shape. + sig do + returns( + T.nilable( + T.any(Float, Imagekit::TextOverlayTransformation::Radius::OrSymbol) + ) + ) + end + attr_reader :radius + + sig do + params( + radius: + T.any(Float, Imagekit::TextOverlayTransformation::Radius::OrSymbol) + ).void + end + attr_writer :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. + sig do + returns( + T.nilable(Imagekit::TextOverlayTransformation::Rotation::Variants) + ) + end + attr_reader :rotation + + sig do + params( + rotation: Imagekit::TextOverlayTransformation::Rotation::Variants + ).void + end + attr_writer :rotation + + # Specifies the typography style of the text. Supported values: `b` for bold, `i` + # for italics, and `b_i` for bold with italics. + sig do + returns( + T.nilable(Imagekit::TextOverlayTransformation::Typography::OrSymbol) + ) + end + attr_reader :typography + + sig do + params( + typography: Imagekit::TextOverlayTransformation::Typography::OrSymbol + ).void + end + attr_writer :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`. + sig do + returns(T.nilable(Imagekit::TextOverlayTransformation::Width::Variants)) + end + attr_reader :width + + sig do + params(width: Imagekit::TextOverlayTransformation::Width::Variants).void + end + attr_writer :width + + sig do + params( + alpha: Float, + background: String, + flip: Imagekit::TextOverlayTransformation::Flip::OrSymbol, + font_color: String, + font_family: String, + font_size: Imagekit::TextOverlayTransformation::FontSize::Variants, + inner_alignment: + Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol, + line_height: + Imagekit::TextOverlayTransformation::LineHeight::Variants, + padding: Imagekit::TextOverlayTransformation::Padding::Variants, + radius: + T.any(Float, Imagekit::TextOverlayTransformation::Radius::OrSymbol), + rotation: Imagekit::TextOverlayTransformation::Rotation::Variants, + typography: Imagekit::TextOverlayTransformation::Typography::OrSymbol, + width: Imagekit::TextOverlayTransformation::Width::Variants + ).returns(T.attached_class) + end + def self.new( + # Specifies the transparency level of the text overlay. Accepts integers from `1` + # to `9`. + alpha: nil, + # Specifies the background color of the text overlay. Accepts an RGB hex code, an + # RGBA code, or a color name. + background: nil, + # Flip the text overlay horizontally, vertically, or both. + flip: nil, + # 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. + font_color: nil, + # Specifies the font family of the overlaid text. Choose from the supported fonts + # list or use a custom font. + font_family: nil, + # Specifies the font size of the overlaid text. Accepts a numeric value or an + # arithmetic expression. + font_size: nil, + # Specifies the inner alignment of the text when width is more than the text + # length. + inner_alignment: nil, + # Specifies the line height of the text overlay. + line_height: nil, + # 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. + padding: nil, + # Specifies the corner radius of the text overlay. Set to `max` to achieve a + # circular or oval shape. + radius: nil, + # 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. + rotation: nil, + # Specifies the typography style of the text. Supported values: `b` for bold, `i` + # for italics, and `b_i` for bold with italics. + typography: nil, + # 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`. + width: nil + ) + end + + sig do + override.returns( + { + alpha: Float, + background: String, + flip: Imagekit::TextOverlayTransformation::Flip::OrSymbol, + font_color: String, + font_family: String, + font_size: Imagekit::TextOverlayTransformation::FontSize::Variants, + inner_alignment: + Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol, + line_height: + Imagekit::TextOverlayTransformation::LineHeight::Variants, + padding: Imagekit::TextOverlayTransformation::Padding::Variants, + radius: + T.any( + Float, + Imagekit::TextOverlayTransformation::Radius::OrSymbol + ), + rotation: Imagekit::TextOverlayTransformation::Rotation::Variants, + typography: + Imagekit::TextOverlayTransformation::Typography::OrSymbol, + width: Imagekit::TextOverlayTransformation::Width::Variants + } + ) + end + def to_hash + end + + # Flip the text overlay horizontally, vertically, or both. + module Flip + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::TextOverlayTransformation::Flip) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + H = T.let(:h, Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) + V = T.let(:v, Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) + H_V = + T.let(:h_v, Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) + V_H = + T.let(:v_h, Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::TextOverlayTransformation::Flip::TaggedSymbol] + ) + end + def self.values + end + end + + # Specifies the font size of the overlaid text. Accepts a numeric value or an + # arithmetic expression. + module FontSize + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::TextOverlayTransformation::FontSize::Variants] + ) + end + def self.variants + end + end + + # Specifies the inner alignment of the text when width is more than the text + # length. + module InnerAlignment + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::TextOverlayTransformation::InnerAlignment) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + LEFT = + T.let( + :left, + Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + ) + RIGHT = + T.let( + :right, + Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + ) + CENTER = + T.let( + :center, + Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Specifies the line height of the text overlay. + module LineHeight + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::TextOverlayTransformation::LineHeight::Variants] + ) + end + def self.variants + end + end + + # 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. + module Padding + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::TextOverlayTransformation::Padding::Variants] + ) + end + def self.variants + end + end + + # Specifies the corner radius of the text overlay. Set to `max` to achieve a + # circular or oval shape. + module Radius + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Float, + Imagekit::TextOverlayTransformation::Radius::TaggedSymbol + ) + end + + sig do + override.returns( + T::Array[Imagekit::TextOverlayTransformation::Radius::Variants] + ) + end + def self.variants + end + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::TextOverlayTransformation::Radius) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + MAX = + T.let(:max, Imagekit::TextOverlayTransformation::Radius::TaggedSymbol) + end + + # 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. + module Rotation + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::TextOverlayTransformation::Rotation::Variants] + ) + end + def self.variants + end + end + + # Specifies the typography style of the text. Supported values: `b` for bold, `i` + # for italics, and `b_i` for bold with italics. + module Typography + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::TextOverlayTransformation::Typography) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + B = + T.let( + :b, + Imagekit::TextOverlayTransformation::Typography::TaggedSymbol + ) + I = + T.let( + :i, + Imagekit::TextOverlayTransformation::Typography::TaggedSymbol + ) + B_I = + T.let( + :b_i, + Imagekit::TextOverlayTransformation::Typography::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::TextOverlayTransformation::Typography::TaggedSymbol + ] + ) + end + def self.values + end + end + + # 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`. + module Width + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::TextOverlayTransformation::Width::Variants] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/transformation.rbi b/rbi/imagekit/models/transformation.rbi new file mode 100644 index 00000000..f36c78ff --- /dev/null +++ b/rbi/imagekit/models/transformation.rbi @@ -0,0 +1,1561 @@ +# typed: strong + +module Imagekit + module Models + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::Transformation, Imagekit::Internal::AnyHash) + end + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :ai_change_background + + sig { params(ai_change_background: String).void } + attr_writer :ai_change_background + + # 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. + sig do + returns( + T.nilable( + T.any(Imagekit::Transformation::AIDropShadow::OrBoolean, String) + ) + ) + end + attr_reader :ai_drop_shadow + + sig do + params( + ai_drop_shadow: + T.any(Imagekit::Transformation::AIDropShadow::OrBoolean, String) + ).void + end + attr_writer :ai_drop_shadow + + # Applies ImageKit's in-house background removal. Supported inside overlay. + sig do + returns( + T.nilable(Imagekit::Transformation::AIRemoveBackground::OrBoolean) + ) + end + attr_reader :ai_remove_background + + sig do + params( + ai_remove_background: + Imagekit::Transformation::AIRemoveBackground::OrBoolean + ).void + end + attr_writer :ai_remove_background + + # 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. + sig do + returns( + T.nilable( + Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean + ) + ) + end + attr_reader :ai_remove_background_external + + sig do + params( + ai_remove_background_external: + Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean + ).void + end + attr_writer :ai_remove_background_external + + # Performs AI-based retouching to improve faces or product shots. Not supported + # inside overlay. + sig { returns(T.nilable(Imagekit::Transformation::AIRetouch::OrBoolean)) } + attr_reader :ai_retouch + + sig do + params(ai_retouch: Imagekit::Transformation::AIRetouch::OrBoolean).void + end + attr_writer :ai_retouch + + # Upscales images beyond their original dimensions using AI. Not supported inside + # overlay. + sig { returns(T.nilable(Imagekit::Transformation::AIUpscale::OrBoolean)) } + attr_reader :ai_upscale + + sig do + params(ai_upscale: Imagekit::Transformation::AIUpscale::OrBoolean).void + end + attr_writer :ai_upscale + + # 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. + sig do + returns(T.nilable(Imagekit::Transformation::AIVariation::OrBoolean)) + end + attr_reader :ai_variation + + sig do + params( + ai_variation: Imagekit::Transformation::AIVariation::OrBoolean + ).void + end + attr_writer :ai_variation + + # 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`. + sig do + returns(T.nilable(Imagekit::Transformation::AspectRatio::Variants)) + end + attr_reader :aspect_ratio + + sig do + params( + aspect_ratio: Imagekit::Transformation::AspectRatio::Variants + ).void + end + attr_writer :aspect_ratio + + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + sig { returns(T.nilable(Imagekit::Transformation::AudioCodec::OrSymbol)) } + attr_reader :audio_codec + + sig do + params(audio_codec: Imagekit::Transformation::AudioCodec::OrSymbol).void + end + attr_writer :audio_codec + + # Specifies the background to be used in conjunction with certain cropping + # strategies when resizing an image. + # + # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. + # - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. + # - 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}]`. + sig { returns(T.nilable(String)) } + attr_reader :background + + sig { params(background: String).void } + attr_writer :background + + # Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, + # or an expression like `bl-10`. + sig { returns(T.nilable(Float)) } + attr_reader :blur + + sig { params(blur: Float).void } + attr_writer :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`. + sig { returns(T.nilable(String)) } + attr_reader :border + + sig { params(border: String).void } + attr_writer :border + + # Indicates whether the output image should retain the original color profile. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :color_profile + + sig { params(color_profile: T::Boolean).void } + attr_writer :color_profile + + # Automatically enhances the contrast of an image (contrast stretch). + sig do + returns(T.nilable(Imagekit::Transformation::ContrastStretch::OrBoolean)) + end + attr_reader :contrast_stretch + + sig do + params( + contrast_stretch: Imagekit::Transformation::ContrastStretch::OrBoolean + ).void + end + attr_writer :contrast_stretch + + # Crop modes for image resizing + sig { returns(T.nilable(Imagekit::Transformation::Crop::OrSymbol)) } + attr_reader :crop + + sig { params(crop: Imagekit::Transformation::Crop::OrSymbol).void } + attr_writer :crop + + # Additional crop modes for image resizing + sig { returns(T.nilable(Imagekit::Transformation::CropMode::OrSymbol)) } + attr_reader :crop_mode + + sig do + params(crop_mode: Imagekit::Transformation::CropMode::OrSymbol).void + end + attr_writer :crop_mode + + # Specifies a fallback image if the resource is not found, e.g., a URL or file + # path. + sig { returns(T.nilable(String)) } + attr_reader :default_image + + sig { params(default_image: String).void } + attr_writer :default_image + + # Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio + # (DPR) calculation. + sig { returns(T.nilable(Float)) } + attr_reader :dpr + + sig { params(dpr: Float).void } + attr_writer :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. + sig { returns(T.nilable(Imagekit::Transformation::Duration::Variants)) } + attr_reader :duration + + sig do + params(duration: Imagekit::Transformation::Duration::Variants).void + end + attr_writer :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. + sig { returns(T.nilable(Imagekit::Transformation::EndOffset::Variants)) } + attr_reader :end_offset + + sig do + params(end_offset: Imagekit::Transformation::EndOffset::Variants).void + end + attr_writer :end_offset + + # Flips or mirrors an image either horizontally, vertically, or both. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. + sig { returns(T.nilable(Imagekit::Transformation::Flip::OrSymbol)) } + attr_reader :flip + + sig { params(flip: Imagekit::Transformation::Flip::OrSymbol).void } + attr_writer :flip + + # This parameter can be used with pad resize, maintain ratio, or extract crop to + # modify the padding or cropping behavior. + sig { returns(T.nilable(String)) } + attr_reader :focus + + sig { params(focus: String).void } + attr_writer :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. + sig { returns(T.nilable(Imagekit::Transformation::Format::OrSymbol)) } + attr_reader :format_ + + sig { params(format_: Imagekit::Transformation::Format::OrSymbol).void } + attr_writer :format_ + + # Creates a linear gradient with two colors. Pass `true` for a default gradient, + # or provide a string for a custom gradient. + sig do + returns( + T.nilable( + T.any(Imagekit::Transformation::Gradient::OrBoolean, String) + ) + ) + end + attr_reader :gradient + + sig do + params( + gradient: T.any(Imagekit::Transformation::Gradient::OrBoolean, String) + ).void + end + attr_writer :gradient + + # Enables a grayscale effect for images. + sig { returns(T.nilable(Imagekit::Transformation::Grayscale::OrBoolean)) } + attr_reader :grayscale + + sig do + params(grayscale: Imagekit::Transformation::Grayscale::OrBoolean).void + end + attr_writer :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`). + sig { returns(T.nilable(Imagekit::Transformation::Height::Variants)) } + attr_reader :height + + sig { params(height: Imagekit::Transformation::Height::Variants).void } + attr_writer :height + + # Specifies whether the output image (in JPEG or PNG) should be compressed + # losslessly. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :lossless + + sig { params(lossless: T::Boolean).void } + attr_writer :lossless + + # By default, ImageKit removes all metadata during automatic image compression. + # Set this to true to preserve metadata. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :metadata + + sig { params(metadata: T::Boolean).void } + attr_writer :metadata + + # Named transformation reference + sig { returns(T.nilable(String)) } + attr_reader :named + + sig { params(named: String).void } + attr_writer :named + + # Specifies the opacity level of the output image. + sig { returns(T.nilable(Float)) } + attr_reader :opacity + + sig { params(opacity: Float).void } + attr_writer :opacity + + # If set to true, serves the original file without applying any transformations. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :original + + sig { params(original: T::Boolean).void } + attr_writer :original + + # Specifies an overlay to be applied on the parent image or video. ImageKit + # supports overlays including images, text, videos, subtitles, and solid colors. + sig { returns(T.nilable(Imagekit::Overlay)) } + attr_reader :overlay + + sig { params(overlay: Imagekit::Overlay).void } + attr_writer :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). + sig { returns(T.nilable(Imagekit::Transformation::Page::Variants)) } + attr_reader :page + + sig { params(page: Imagekit::Transformation::Page::Variants).void } + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :progressive + + sig { params(progressive: T::Boolean).void } + attr_writer :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. + sig { returns(T.nilable(Float)) } + attr_reader :quality + + sig { params(quality: Float).void } + attr_writer :quality + + # Specifies the corner radius for rounded corners (e.g., 20) or `max` for + # circular/oval shapes. + sig do + returns( + T.nilable(T.any(Float, Imagekit::Transformation::Radius::OrSymbol)) + ) + end + attr_reader :radius + + sig do + params( + radius: T.any(Float, Imagekit::Transformation::Radius::OrSymbol) + ).void + end + attr_writer :radius + + # Pass any transformation not directly supported by the SDK. This transformation + # string is appended to the URL as provided. + sig { returns(T.nilable(String)) } + attr_reader :raw + + sig { params(raw: String).void } + attr_writer :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. + sig { returns(T.nilable(Imagekit::Transformation::Rotation::Variants)) } + attr_reader :rotation + + sig do + params(rotation: Imagekit::Transformation::Rotation::Variants).void + end + attr_writer :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. + sig do + returns( + T.nilable(T.any(Imagekit::Transformation::Shadow::OrBoolean, String)) + ) + end + attr_reader :shadow + + sig do + params( + shadow: T.any(Imagekit::Transformation::Shadow::OrBoolean, String) + ).void + end + attr_writer :shadow + + # Sharpens the input image, highlighting edges and finer details. Pass `true` for + # default sharpening, or provide a numeric value for custom sharpening. + sig do + returns( + T.nilable(T.any(Imagekit::Transformation::Sharpen::OrBoolean, Float)) + ) + end + attr_reader :sharpen + + sig do + params( + sharpen: T.any(Imagekit::Transformation::Sharpen::OrBoolean, Float) + ).void + end + attr_writer :sharpen + + # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or + # `10.5`. Arithmetic expressions are also supported. + sig do + returns(T.nilable(Imagekit::Transformation::StartOffset::Variants)) + end + attr_reader :start_offset + + sig do + params( + start_offset: Imagekit::Transformation::StartOffset::Variants + ).void + end + attr_writer :start_offset + + # An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, + # `480`, `720`, `1080`]. + sig do + returns(T.nilable(T::Array[Imagekit::StreamingResolution::OrSymbol])) + end + attr_reader :streaming_resolutions + + sig do + params( + streaming_resolutions: + T::Array[Imagekit::StreamingResolution::OrSymbol] + ).void + end + attr_writer :streaming_resolutions + + # 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. + sig do + returns( + T.nilable(T.any(Imagekit::Transformation::Trim::OrBoolean, Float)) + ) + end + attr_reader :trim + + sig do + params( + trim: T.any(Imagekit::Transformation::Trim::OrBoolean, Float) + ).void + end + attr_writer :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. + sig do + returns( + T.nilable( + T.any(Imagekit::Transformation::UnsharpMask::OrBoolean, String) + ) + ) + end + attr_reader :unsharp_mask + + sig do + params( + unsharp_mask: + T.any(Imagekit::Transformation::UnsharpMask::OrBoolean, String) + ).void + end + attr_writer :unsharp_mask + + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + sig { returns(T.nilable(Imagekit::Transformation::VideoCodec::OrSymbol)) } + attr_reader :video_codec + + sig do + params(video_codec: Imagekit::Transformation::VideoCodec::OrSymbol).void + end + attr_writer :video_codec + + # 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`). + sig { returns(T.nilable(Imagekit::Transformation::Width::Variants)) } + attr_reader :width + + sig { params(width: Imagekit::Transformation::Width::Variants).void } + attr_writer :width + + # Focus using cropped image coordinates - X coordinate + sig { returns(T.nilable(Imagekit::Transformation::X::Variants)) } + attr_reader :x + + sig { params(x: Imagekit::Transformation::X::Variants).void } + attr_writer :x + + # Focus using cropped image coordinates - X center coordinate + sig { returns(T.nilable(Imagekit::Transformation::XCenter::Variants)) } + attr_reader :x_center + + sig { params(x_center: Imagekit::Transformation::XCenter::Variants).void } + attr_writer :x_center + + # Focus using cropped image coordinates - Y coordinate + sig { returns(T.nilable(Imagekit::Transformation::Y::Variants)) } + attr_reader :y_ + + sig { params(y_: Imagekit::Transformation::Y::Variants).void } + attr_writer :y_ + + # Focus using cropped image coordinates - Y center coordinate + sig { returns(T.nilable(Imagekit::Transformation::YCenter::Variants)) } + attr_reader :y_center + + sig { params(y_center: Imagekit::Transformation::YCenter::Variants).void } + attr_writer :y_center + + # 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-. + sig { returns(T.nilable(Float)) } + attr_reader :zoom + + sig { params(zoom: Float).void } + attr_writer :zoom + + # The SDK provides easy-to-use names for transformations. These names are + # converted to the corresponding transformation string before being added to the + # URL. SDKs are updated regularly to support new transformations. If you want to + # use a transformation that is not supported by the SDK, You can use the `raw` + # parameter to pass the transformation string directly. + sig do + params( + ai_change_background: String, + ai_drop_shadow: + T.any(Imagekit::Transformation::AIDropShadow::OrBoolean, String), + ai_remove_background: + Imagekit::Transformation::AIRemoveBackground::OrBoolean, + ai_remove_background_external: + Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean, + ai_retouch: Imagekit::Transformation::AIRetouch::OrBoolean, + ai_upscale: Imagekit::Transformation::AIUpscale::OrBoolean, + ai_variation: Imagekit::Transformation::AIVariation::OrBoolean, + aspect_ratio: Imagekit::Transformation::AspectRatio::Variants, + audio_codec: Imagekit::Transformation::AudioCodec::OrSymbol, + background: String, + blur: Float, + border: String, + color_profile: T::Boolean, + contrast_stretch: + Imagekit::Transformation::ContrastStretch::OrBoolean, + crop: Imagekit::Transformation::Crop::OrSymbol, + crop_mode: Imagekit::Transformation::CropMode::OrSymbol, + default_image: String, + dpr: Float, + duration: Imagekit::Transformation::Duration::Variants, + end_offset: Imagekit::Transformation::EndOffset::Variants, + flip: Imagekit::Transformation::Flip::OrSymbol, + focus: String, + format_: Imagekit::Transformation::Format::OrSymbol, + gradient: + T.any(Imagekit::Transformation::Gradient::OrBoolean, String), + grayscale: Imagekit::Transformation::Grayscale::OrBoolean, + height: Imagekit::Transformation::Height::Variants, + lossless: T::Boolean, + metadata: T::Boolean, + named: String, + opacity: Float, + original: T::Boolean, + overlay: Imagekit::Overlay, + page: Imagekit::Transformation::Page::Variants, + progressive: T::Boolean, + quality: Float, + radius: T.any(Float, Imagekit::Transformation::Radius::OrSymbol), + raw: String, + rotation: Imagekit::Transformation::Rotation::Variants, + shadow: T.any(Imagekit::Transformation::Shadow::OrBoolean, String), + sharpen: T.any(Imagekit::Transformation::Sharpen::OrBoolean, Float), + start_offset: Imagekit::Transformation::StartOffset::Variants, + streaming_resolutions: + T::Array[Imagekit::StreamingResolution::OrSymbol], + trim: T.any(Imagekit::Transformation::Trim::OrBoolean, Float), + unsharp_mask: + T.any(Imagekit::Transformation::UnsharpMask::OrBoolean, String), + video_codec: Imagekit::Transformation::VideoCodec::OrSymbol, + width: Imagekit::Transformation::Width::Variants, + x: Imagekit::Transformation::X::Variants, + x_center: Imagekit::Transformation::XCenter::Variants, + y_: Imagekit::Transformation::Y::Variants, + y_center: Imagekit::Transformation::YCenter::Variants, + zoom: Float + ).returns(T.attached_class) + end + def self.new( + # 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. + ai_change_background: nil, + # 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. + ai_drop_shadow: nil, + # Applies ImageKit's in-house background removal. Supported inside overlay. + ai_remove_background: nil, + # 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. + ai_remove_background_external: nil, + # Performs AI-based retouching to improve faces or product shots. Not supported + # inside overlay. + ai_retouch: nil, + # Upscales images beyond their original dimensions using AI. Not supported inside + # overlay. + ai_upscale: nil, + # 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. + ai_variation: nil, + # 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`. + aspect_ratio: nil, + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + audio_codec: nil, + # Specifies the background to be used in conjunction with certain cropping + # strategies when resizing an image. + # + # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. + # - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. + # - 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}]`. + background: nil, + # Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, + # or an expression like `bl-10`. + blur: nil, + # 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`. + border: nil, + # Indicates whether the output image should retain the original color profile. + color_profile: nil, + # Automatically enhances the contrast of an image (contrast stretch). + contrast_stretch: nil, + # Crop modes for image resizing + crop: nil, + # Additional crop modes for image resizing + crop_mode: nil, + # Specifies a fallback image if the resource is not found, e.g., a URL or file + # path. + default_image: nil, + # Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio + # (DPR) calculation. + dpr: nil, + # 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. + duration: nil, + # 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. + end_offset: nil, + # Flips or mirrors an image either horizontally, vertically, or both. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. + flip: nil, + # This parameter can be used with pad resize, maintain ratio, or extract crop to + # modify the padding or cropping behavior. + focus: nil, + # 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. + format_: nil, + # Creates a linear gradient with two colors. Pass `true` for a default gradient, + # or provide a string for a custom gradient. + gradient: nil, + # Enables a grayscale effect for images. + grayscale: nil, + # 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: nil, + # Specifies whether the output image (in JPEG or PNG) should be compressed + # losslessly. + lossless: nil, + # By default, ImageKit removes all metadata during automatic image compression. + # Set this to true to preserve metadata. + metadata: nil, + # Named transformation reference + named: nil, + # Specifies the opacity level of the output image. + opacity: nil, + # If set to true, serves the original file without applying any transformations. + original: nil, + # Specifies an overlay to be applied on the parent image or video. ImageKit + # supports overlays including images, text, videos, subtitles, and solid colors. + overlay: nil, + # 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). + page: nil, + # 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. + progressive: nil, + # 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. + quality: nil, + # Specifies the corner radius for rounded corners (e.g., 20) or `max` for + # circular/oval shapes. + radius: nil, + # Pass any transformation not directly supported by the SDK. This transformation + # string is appended to the URL as provided. + raw: nil, + # 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. + rotation: nil, + # 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. + shadow: nil, + # Sharpens the input image, highlighting edges and finer details. Pass `true` for + # default sharpening, or provide a numeric value for custom sharpening. + sharpen: nil, + # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or + # `10.5`. Arithmetic expressions are also supported. + start_offset: nil, + # An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, + # `480`, `720`, `1080`]. + streaming_resolutions: nil, + # 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. + trim: nil, + # Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a + # default unsharp mask, or provide a string for a custom unsharp mask. + unsharp_mask: nil, + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + video_codec: nil, + # 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: nil, + # Focus using cropped image coordinates - X coordinate + x: nil, + # Focus using cropped image coordinates - X center coordinate + x_center: nil, + # Focus using cropped image coordinates - Y coordinate + y_: nil, + # Focus using cropped image coordinates - Y center coordinate + y_center: nil, + # 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-. + zoom: nil + ) + end + + sig do + override.returns( + { + ai_change_background: String, + ai_drop_shadow: + T.any(Imagekit::Transformation::AIDropShadow::OrBoolean, String), + ai_remove_background: + Imagekit::Transformation::AIRemoveBackground::OrBoolean, + ai_remove_background_external: + Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean, + ai_retouch: Imagekit::Transformation::AIRetouch::OrBoolean, + ai_upscale: Imagekit::Transformation::AIUpscale::OrBoolean, + ai_variation: Imagekit::Transformation::AIVariation::OrBoolean, + aspect_ratio: Imagekit::Transformation::AspectRatio::Variants, + audio_codec: Imagekit::Transformation::AudioCodec::OrSymbol, + background: String, + blur: Float, + border: String, + color_profile: T::Boolean, + contrast_stretch: + Imagekit::Transformation::ContrastStretch::OrBoolean, + crop: Imagekit::Transformation::Crop::OrSymbol, + crop_mode: Imagekit::Transformation::CropMode::OrSymbol, + default_image: String, + dpr: Float, + duration: Imagekit::Transformation::Duration::Variants, + end_offset: Imagekit::Transformation::EndOffset::Variants, + flip: Imagekit::Transformation::Flip::OrSymbol, + focus: String, + format_: Imagekit::Transformation::Format::OrSymbol, + gradient: + T.any(Imagekit::Transformation::Gradient::OrBoolean, String), + grayscale: Imagekit::Transformation::Grayscale::OrBoolean, + height: Imagekit::Transformation::Height::Variants, + lossless: T::Boolean, + metadata: T::Boolean, + named: String, + opacity: Float, + original: T::Boolean, + overlay: Imagekit::Overlay, + page: Imagekit::Transformation::Page::Variants, + progressive: T::Boolean, + quality: Float, + radius: T.any(Float, Imagekit::Transformation::Radius::OrSymbol), + raw: String, + rotation: Imagekit::Transformation::Rotation::Variants, + shadow: T.any(Imagekit::Transformation::Shadow::OrBoolean, String), + sharpen: T.any(Imagekit::Transformation::Sharpen::OrBoolean, Float), + start_offset: Imagekit::Transformation::StartOffset::Variants, + streaming_resolutions: + T::Array[Imagekit::StreamingResolution::OrSymbol], + trim: T.any(Imagekit::Transformation::Trim::OrBoolean, Float), + unsharp_mask: + T.any(Imagekit::Transformation::UnsharpMask::OrBoolean, String), + video_codec: Imagekit::Transformation::VideoCodec::OrSymbol, + width: Imagekit::Transformation::Width::Variants, + x: Imagekit::Transformation::X::Variants, + x_center: Imagekit::Transformation::XCenter::Variants, + y_: Imagekit::Transformation::Y::Variants, + y_center: Imagekit::Transformation::YCenter::Variants, + zoom: Float + } + ) + end + def to_hash + end + + # 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. + module AIDropShadow + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any(Imagekit::Transformation::AIDropShadow::TaggedBoolean, String) + end + + sig do + override.returns( + T::Array[Imagekit::Transformation::AIDropShadow::Variants] + ) + end + def self.variants + end + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, Imagekit::Transformation::AIDropShadow) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = + T.let(true, Imagekit::Transformation::AIDropShadow::TaggedBoolean) + end + + # Applies ImageKit's in-house background removal. Supported inside overlay. + module AIRemoveBackground + extend Imagekit::Internal::Type::Enum + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, Imagekit::Transformation::AIRemoveBackground) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = + T.let( + true, + Imagekit::Transformation::AIRemoveBackground::TaggedBoolean + ) + + sig do + override.returns( + T::Array[ + Imagekit::Transformation::AIRemoveBackground::TaggedBoolean + ] + ) + end + def self.values + end + end + + # 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. + module AIRemoveBackgroundExternal + extend Imagekit::Internal::Type::Enum + + TaggedBoolean = + T.type_alias do + T.all( + T::Boolean, + Imagekit::Transformation::AIRemoveBackgroundExternal + ) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = + T.let( + true, + Imagekit::Transformation::AIRemoveBackgroundExternal::TaggedBoolean + ) + + sig do + override.returns( + T::Array[ + Imagekit::Transformation::AIRemoveBackgroundExternal::TaggedBoolean + ] + ) + end + def self.values + end + end + + # Performs AI-based retouching to improve faces or product shots. Not supported + # inside overlay. + module AIRetouch + extend Imagekit::Internal::Type::Enum + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, Imagekit::Transformation::AIRetouch) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::AIRetouch::TaggedBoolean) + + sig do + override.returns( + T::Array[Imagekit::Transformation::AIRetouch::TaggedBoolean] + ) + end + def self.values + end + end + + # Upscales images beyond their original dimensions using AI. Not supported inside + # overlay. + module AIUpscale + extend Imagekit::Internal::Type::Enum + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, Imagekit::Transformation::AIUpscale) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::AIUpscale::TaggedBoolean) + + sig do + override.returns( + T::Array[Imagekit::Transformation::AIUpscale::TaggedBoolean] + ) + end + def self.values + end + end + + # 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. + module AIVariation + extend Imagekit::Internal::Type::Enum + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, Imagekit::Transformation::AIVariation) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::AIVariation::TaggedBoolean) + + sig do + override.returns( + T::Array[Imagekit::Transformation::AIVariation::TaggedBoolean] + ) + end + def self.values + end + end + + # 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`. + module AspectRatio + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::Transformation::AspectRatio::Variants] + ) + end + def self.variants + end + end + + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + module AudioCodec + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::Transformation::AudioCodec) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AAC = T.let(:aac, Imagekit::Transformation::AudioCodec::TaggedSymbol) + OPUS = T.let(:opus, Imagekit::Transformation::AudioCodec::TaggedSymbol) + NONE = T.let(:none, Imagekit::Transformation::AudioCodec::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::Transformation::AudioCodec::TaggedSymbol] + ) + end + def self.values + end + end + + # Automatically enhances the contrast of an image (contrast stretch). + module ContrastStretch + extend Imagekit::Internal::Type::Enum + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, Imagekit::Transformation::ContrastStretch) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = + T.let(true, Imagekit::Transformation::ContrastStretch::TaggedBoolean) + + sig do + override.returns( + T::Array[Imagekit::Transformation::ContrastStretch::TaggedBoolean] + ) + end + def self.values + end + end + + # Crop modes for image resizing + module Crop + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::Transformation::Crop) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FORCE = T.let(:force, Imagekit::Transformation::Crop::TaggedSymbol) + AT_MAX = T.let(:at_max, Imagekit::Transformation::Crop::TaggedSymbol) + AT_MAX_ENLARGE = + T.let(:at_max_enlarge, Imagekit::Transformation::Crop::TaggedSymbol) + AT_LEAST = + T.let(:at_least, Imagekit::Transformation::Crop::TaggedSymbol) + MAINTAIN_RATIO = + T.let(:maintain_ratio, Imagekit::Transformation::Crop::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::Transformation::Crop::TaggedSymbol] + ) + end + def self.values + end + end + + # Additional crop modes for image resizing + module CropMode + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::Transformation::CropMode) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PAD_RESIZE = + T.let(:pad_resize, Imagekit::Transformation::CropMode::TaggedSymbol) + EXTRACT = + T.let(:extract, Imagekit::Transformation::CropMode::TaggedSymbol) + PAD_EXTRACT = + T.let(:pad_extract, Imagekit::Transformation::CropMode::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::Transformation::CropMode::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module Duration + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::Transformation::Duration::Variants] + ) + end + def self.variants + end + end + + # 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. + module EndOffset + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::Transformation::EndOffset::Variants] + ) + end + def self.variants + end + end + + # Flips or mirrors an image either horizontally, vertically, or both. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. + module Flip + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::Transformation::Flip) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + H = T.let(:h, Imagekit::Transformation::Flip::TaggedSymbol) + V = T.let(:v, Imagekit::Transformation::Flip::TaggedSymbol) + H_V = T.let(:h_v, Imagekit::Transformation::Flip::TaggedSymbol) + V_H = T.let(:v_h, Imagekit::Transformation::Flip::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::Transformation::Flip::TaggedSymbol] + ) + end + def self.values + end + end + + # 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. + module Format + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::Transformation::Format) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AUTO = T.let(:auto, Imagekit::Transformation::Format::TaggedSymbol) + WEBP = T.let(:webp, Imagekit::Transformation::Format::TaggedSymbol) + JPG = T.let(:jpg, Imagekit::Transformation::Format::TaggedSymbol) + JPEG = T.let(:jpeg, Imagekit::Transformation::Format::TaggedSymbol) + PNG = T.let(:png, Imagekit::Transformation::Format::TaggedSymbol) + GIF = T.let(:gif, Imagekit::Transformation::Format::TaggedSymbol) + SVG = T.let(:svg, Imagekit::Transformation::Format::TaggedSymbol) + MP4 = T.let(:mp4, Imagekit::Transformation::Format::TaggedSymbol) + WEBM = T.let(:webm, Imagekit::Transformation::Format::TaggedSymbol) + AVIF = T.let(:avif, Imagekit::Transformation::Format::TaggedSymbol) + ORIG = T.let(:orig, Imagekit::Transformation::Format::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::Transformation::Format::TaggedSymbol] + ) + end + def self.values + end + end + + # Creates a linear gradient with two colors. Pass `true` for a default gradient, + # or provide a string for a custom gradient. + module Gradient + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any(Imagekit::Transformation::Gradient::TaggedBoolean, String) + end + + sig do + override.returns( + T::Array[Imagekit::Transformation::Gradient::Variants] + ) + end + def self.variants + end + + TaggedBoolean = + T.type_alias { T.all(T::Boolean, Imagekit::Transformation::Gradient) } + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::Gradient::TaggedBoolean) + end + + # Enables a grayscale effect for images. + module Grayscale + extend Imagekit::Internal::Type::Enum + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, Imagekit::Transformation::Grayscale) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::Grayscale::TaggedBoolean) + + sig do + override.returns( + T::Array[Imagekit::Transformation::Grayscale::TaggedBoolean] + ) + end + def self.values + end + end + + # 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`). + module Height + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::Transformation::Height::Variants]) + end + def self.variants + end + end + + # 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). + module Page + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::Transformation::Page::Variants]) + end + def self.variants + end + end + + # Specifies the corner radius for rounded corners (e.g., 20) or `max` for + # circular/oval shapes. + module Radius + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any(Float, Imagekit::Transformation::Radius::TaggedSymbol) + end + + sig do + override.returns(T::Array[Imagekit::Transformation::Radius::Variants]) + end + def self.variants + end + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::Transformation::Radius) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + MAX = T.let(:max, Imagekit::Transformation::Radius::TaggedSymbol) + end + + # 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. + module Rotation + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::Transformation::Rotation::Variants] + ) + end + def self.variants + end + end + + # 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. + module Shadow + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any(Imagekit::Transformation::Shadow::TaggedBoolean, String) + end + + sig do + override.returns(T::Array[Imagekit::Transformation::Shadow::Variants]) + end + def self.variants + end + + TaggedBoolean = + T.type_alias { T.all(T::Boolean, Imagekit::Transformation::Shadow) } + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::Shadow::TaggedBoolean) + end + + # Sharpens the input image, highlighting edges and finer details. Pass `true` for + # default sharpening, or provide a numeric value for custom sharpening. + module Sharpen + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any(Imagekit::Transformation::Sharpen::TaggedBoolean, Float) + end + + sig do + override.returns( + T::Array[Imagekit::Transformation::Sharpen::Variants] + ) + end + def self.variants + end + + TaggedBoolean = + T.type_alias { T.all(T::Boolean, Imagekit::Transformation::Sharpen) } + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::Sharpen::TaggedBoolean) + end + + # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or + # `10.5`. Arithmetic expressions are also supported. + module StartOffset + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::Transformation::StartOffset::Variants] + ) + end + def self.variants + end + end + + # 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. + module Trim + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any(Imagekit::Transformation::Trim::TaggedBoolean, Float) + end + + sig do + override.returns(T::Array[Imagekit::Transformation::Trim::Variants]) + end + def self.variants + end + + TaggedBoolean = + T.type_alias { T.all(T::Boolean, Imagekit::Transformation::Trim) } + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::Trim::TaggedBoolean) + end + + # Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a + # default unsharp mask, or provide a string for a custom unsharp mask. + module UnsharpMask + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any(Imagekit::Transformation::UnsharpMask::TaggedBoolean, String) + end + + sig do + override.returns( + T::Array[Imagekit::Transformation::UnsharpMask::Variants] + ) + end + def self.variants + end + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, Imagekit::Transformation::UnsharpMask) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = T.let(true, Imagekit::Transformation::UnsharpMask::TaggedBoolean) + end + + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + module VideoCodec + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::Transformation::VideoCodec) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + H264 = T.let(:h264, Imagekit::Transformation::VideoCodec::TaggedSymbol) + VP9 = T.let(:vp9, Imagekit::Transformation::VideoCodec::TaggedSymbol) + AV1 = T.let(:av1, Imagekit::Transformation::VideoCodec::TaggedSymbol) + NONE = T.let(:none, Imagekit::Transformation::VideoCodec::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::Transformation::VideoCodec::TaggedSymbol] + ) + end + def self.values + end + end + + # 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`). + module Width + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::Transformation::Width::Variants]) + end + def self.variants + end + end + + # Focus using cropped image coordinates - X coordinate + module X + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::Transformation::X::Variants]) + end + def self.variants + end + end + + # Focus using cropped image coordinates - X center coordinate + module XCenter + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::Transformation::XCenter::Variants] + ) + end + def self.variants + end + end + + # Focus using cropped image coordinates - Y coordinate + module Y + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns(T::Array[Imagekit::Transformation::Y::Variants]) + end + def self.variants + end + end + + # Focus using cropped image coordinates - Y center coordinate + module YCenter + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(Float, String) } + + sig do + override.returns( + T::Array[Imagekit::Transformation::YCenter::Variants] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/imagekit/models/transformation_position.rbi b/rbi/imagekit/models/transformation_position.rbi new file mode 100644 index 00000000..9ae4af39 --- /dev/null +++ b/rbi/imagekit/models/transformation_position.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekit + module Models + # 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`. + module TransformationPosition + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::TransformationPosition) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PATH = T.let(:path, Imagekit::TransformationPosition::TaggedSymbol) + QUERY = T.let(:query, Imagekit::TransformationPosition::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::TransformationPosition::TaggedSymbol] + ) + end + def self.values + end + end + end +end diff --git a/rbi/imagekit/models/video_overlay.rbi b/rbi/imagekit/models/video_overlay.rbi new file mode 100644 index 00000000..71690f70 --- /dev/null +++ b/rbi/imagekit/models/video_overlay.rbi @@ -0,0 +1,116 @@ +# typed: strong + +module Imagekit + module Models + class VideoOverlay < Imagekit::Models::BaseOverlay + OrHash = + T.type_alias do + T.any(Imagekit::VideoOverlay, Imagekit::Internal::AnyHash) + end + + # Specifies the relative path to the video used as an overlay. + sig { returns(String) } + attr_accessor :input + + sig { returns(Imagekit::VideoOverlay::Type::OrSymbol) } + attr_accessor :type + + # 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`. + sig { returns(T.nilable(Imagekit::VideoOverlay::Encoding::OrSymbol)) } + attr_reader :encoding + + sig { params(encoding: Imagekit::VideoOverlay::Encoding::OrSymbol).void } + attr_writer :encoding + + # Array of transformation to be applied to the overlay video. Except + # `streamingResolutions`, all other video transformations are supported. + sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } + attr_reader :transformation + + sig { params(transformation: T::Array[Imagekit::Transformation]).void } + attr_writer :transformation + + sig do + params( + input: String, + type: Imagekit::VideoOverlay::Type::OrSymbol, + encoding: Imagekit::VideoOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekit::Transformation] + ).returns(T.attached_class) + end + def self.new( + # Specifies the relative path to the video used as an overlay. + input:, + type:, + # 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`. + encoding: nil, + # Array of transformation to be applied to the overlay video. Except + # `streamingResolutions`, all other video transformations are supported. + transformation: nil + ) + end + + sig do + override.returns( + { + input: String, + type: Imagekit::VideoOverlay::Type::OrSymbol, + encoding: Imagekit::VideoOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekit::Transformation] + } + ) + end + def to_hash + end + + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::VideoOverlay::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VIDEO = T.let(:video, Imagekit::VideoOverlay::Type::TaggedSymbol) + + sig do + override.returns(T::Array[Imagekit::VideoOverlay::Type::TaggedSymbol]) + end + def self.values + end + end + + # 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`. + module Encoding + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekit::VideoOverlay::Encoding) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AUTO = T.let(:auto, Imagekit::VideoOverlay::Encoding::TaggedSymbol) + PLAIN = T.let(:plain, Imagekit::VideoOverlay::Encoding::TaggedSymbol) + BASE64 = T.let(:base64, Imagekit::VideoOverlay::Encoding::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekit::VideoOverlay::Encoding::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 1ceb33fc..13ded142 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -3,6 +3,8 @@ module Imagekit class AssetListParams = Imagekit::Models::AssetListParams + class BaseOverlay = Imagekit::Models::BaseOverlay + module Beta = Imagekit::Models::Beta module Cache = Imagekit::Models::Cache @@ -49,12 +51,42 @@ module Imagekit module Folders = Imagekit::Models::Folders + class ImageOverlay = Imagekit::Models::ImageOverlay + class Metadata = Imagekit::Models::Metadata + module Overlay = Imagekit::Models::Overlay + + class OverlayPosition = Imagekit::Models::OverlayPosition + + class OverlayTiming = Imagekit::Models::OverlayTiming + + class SolidColorOverlay = Imagekit::Models::SolidColorOverlay + + class SolidColorOverlayTransformation = Imagekit::Models::SolidColorOverlayTransformation + + class SrcOptions = Imagekit::Models::SrcOptions + + module StreamingResolution = Imagekit::Models::StreamingResolution + + class SubtitleOverlay = Imagekit::Models::SubtitleOverlay + + class SubtitleOverlayTransformation = Imagekit::Models::SubtitleOverlayTransformation + + class TextOverlay = Imagekit::Models::TextOverlay + + class TextOverlayTransformation = Imagekit::Models::TextOverlayTransformation + + class Transformation = Imagekit::Models::Transformation + + module TransformationPosition = Imagekit::Models::TransformationPosition + module UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + class VideoOverlay = Imagekit::Models::VideoOverlay + class VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent class VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent diff --git a/sig/imagekit/models/base_overlay.rbs b/sig/imagekit/models/base_overlay.rbs new file mode 100644 index 00000000..5b012352 --- /dev/null +++ b/sig/imagekit/models/base_overlay.rbs @@ -0,0 +1,26 @@ +module Imagekit + module Models + type base_overlay = + { position: Imagekit::OverlayPosition, timing: Imagekit::OverlayTiming } + + class BaseOverlay < Imagekit::Internal::Type::BaseModel + attr_reader position: Imagekit::OverlayPosition? + + def position=: (Imagekit::OverlayPosition) -> Imagekit::OverlayPosition + + attr_reader timing: Imagekit::OverlayTiming? + + def timing=: (Imagekit::OverlayTiming) -> Imagekit::OverlayTiming + + def initialize: ( + ?position: Imagekit::OverlayPosition, + ?timing: Imagekit::OverlayTiming + ) -> void + + def to_hash: -> { + position: Imagekit::OverlayPosition, + timing: Imagekit::OverlayTiming + } + end + end +end diff --git a/sig/imagekit/models/image_overlay.rbs b/sig/imagekit/models/image_overlay.rbs new file mode 100644 index 00000000..7628473e --- /dev/null +++ b/sig/imagekit/models/image_overlay.rbs @@ -0,0 +1,71 @@ +module Imagekit + module Models + type image_overlay = + { + input: String, + type: Imagekit::Models::ImageOverlay::type_, + encoding: Imagekit::Models::ImageOverlay::encoding, + transformation: ::Array[Imagekit::Transformation] + } + + class ImageOverlay < Imagekit::Models::BaseOverlay + def input: -> String + + def input=: (String _) -> String + + def `type`: -> Imagekit::Models::ImageOverlay::type_ + + def type=: ( + Imagekit::Models::ImageOverlay::type_ _ + ) -> Imagekit::Models::ImageOverlay::type_ + + def encoding: -> Imagekit::Models::ImageOverlay::encoding? + + def encoding=: ( + Imagekit::Models::ImageOverlay::encoding _ + ) -> Imagekit::Models::ImageOverlay::encoding + + def transformation: -> ::Array[Imagekit::Transformation]? + + def transformation=: ( + ::Array[Imagekit::Transformation] _ + ) -> ::Array[Imagekit::Transformation] + + def initialize: ( + input: String, + type: Imagekit::Models::ImageOverlay::type_, + ?encoding: Imagekit::Models::ImageOverlay::encoding, + ?transformation: ::Array[Imagekit::Transformation] + ) -> void + + def to_hash: -> { + input: String, + type: Imagekit::Models::ImageOverlay::type_, + encoding: Imagekit::Models::ImageOverlay::encoding, + transformation: ::Array[Imagekit::Transformation] + } + + type type_ = :image + + module Type + extend Imagekit::Internal::Type::Enum + + IMAGE: :image + + def self?.values: -> ::Array[Imagekit::Models::ImageOverlay::type_] + end + + type encoding = :auto | :plain | :base64 + + module Encoding + extend Imagekit::Internal::Type::Enum + + AUTO: :auto + PLAIN: :plain + BASE64: :base64 + + def self?.values: -> ::Array[Imagekit::Models::ImageOverlay::encoding] + end + end + end +end diff --git a/sig/imagekit/models/overlay.rbs b/sig/imagekit/models/overlay.rbs new file mode 100644 index 00000000..2172be0b --- /dev/null +++ b/sig/imagekit/models/overlay.rbs @@ -0,0 +1,16 @@ +module Imagekit + module Models + type overlay = + Imagekit::TextOverlay + | Imagekit::ImageOverlay + | Imagekit::VideoOverlay + | Imagekit::SubtitleOverlay + | Imagekit::SolidColorOverlay + + module Overlay + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::overlay] + end + end +end diff --git a/sig/imagekit/models/overlay_position.rbs b/sig/imagekit/models/overlay_position.rbs new file mode 100644 index 00000000..8576502e --- /dev/null +++ b/sig/imagekit/models/overlay_position.rbs @@ -0,0 +1,85 @@ +module Imagekit + module Models + type overlay_position = + { + focus: Imagekit::Models::OverlayPosition::focus, + x: Imagekit::Models::OverlayPosition::x, + y_: Imagekit::Models::OverlayPosition::y_ + } + + class OverlayPosition < Imagekit::Internal::Type::BaseModel + attr_reader focus: Imagekit::Models::OverlayPosition::focus? + + def focus=: ( + Imagekit::Models::OverlayPosition::focus + ) -> Imagekit::Models::OverlayPosition::focus + + attr_reader x: Imagekit::Models::OverlayPosition::x? + + def x=: ( + Imagekit::Models::OverlayPosition::x + ) -> Imagekit::Models::OverlayPosition::x + + attr_reader y_: Imagekit::Models::OverlayPosition::y_? + + def y_=: ( + Imagekit::Models::OverlayPosition::y_ + ) -> Imagekit::Models::OverlayPosition::y_ + + def initialize: ( + ?focus: Imagekit::Models::OverlayPosition::focus, + ?x: Imagekit::Models::OverlayPosition::x, + ?y_: Imagekit::Models::OverlayPosition::y_ + ) -> void + + def to_hash: -> { + focus: Imagekit::Models::OverlayPosition::focus, + x: Imagekit::Models::OverlayPosition::x, + y_: Imagekit::Models::OverlayPosition::y_ + } + + type focus = + :center + | :top + | :left + | :bottom + | :right + | :top_left + | :top_right + | :bottom_left + | :bottom_right + + module Focus + extend Imagekit::Internal::Type::Enum + + CENTER: :center + TOP: :top + LEFT: :left + BOTTOM: :bottom + RIGHT: :right + TOP_LEFT: :top_left + TOP_RIGHT: :top_right + BOTTOM_LEFT: :bottom_left + BOTTOM_RIGHT: :bottom_right + + def self?.values: -> ::Array[Imagekit::Models::OverlayPosition::focus] + end + + type x = Float | String + + module X + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::OverlayPosition::x] + end + + type y_ = Float | String + + module Y + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::OverlayPosition::y_] + end + end + end +end diff --git a/sig/imagekit/models/overlay_timing.rbs b/sig/imagekit/models/overlay_timing.rbs new file mode 100644 index 00000000..4cafca16 --- /dev/null +++ b/sig/imagekit/models/overlay_timing.rbs @@ -0,0 +1,66 @@ +module Imagekit + module Models + type overlay_timing = + { + duration: Imagekit::Models::OverlayTiming::duration, + end_: Imagekit::Models::OverlayTiming::end_, + start: Imagekit::Models::OverlayTiming::start + } + + class OverlayTiming < Imagekit::Internal::Type::BaseModel + attr_reader duration: Imagekit::Models::OverlayTiming::duration? + + def duration=: ( + Imagekit::Models::OverlayTiming::duration + ) -> Imagekit::Models::OverlayTiming::duration + + attr_reader end_: Imagekit::Models::OverlayTiming::end_? + + def end_=: ( + Imagekit::Models::OverlayTiming::end_ + ) -> Imagekit::Models::OverlayTiming::end_ + + attr_reader start: Imagekit::Models::OverlayTiming::start? + + def start=: ( + Imagekit::Models::OverlayTiming::start + ) -> Imagekit::Models::OverlayTiming::start + + def initialize: ( + ?duration: Imagekit::Models::OverlayTiming::duration, + ?end_: Imagekit::Models::OverlayTiming::end_, + ?start: Imagekit::Models::OverlayTiming::start + ) -> void + + def to_hash: -> { + duration: Imagekit::Models::OverlayTiming::duration, + end_: Imagekit::Models::OverlayTiming::end_, + start: Imagekit::Models::OverlayTiming::start + } + + type duration = Float | String + + module Duration + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::OverlayTiming::duration] + end + + type end_ = Float | String + + module End + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::OverlayTiming::end_] + end + + type start = Float | String + + module Start + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::OverlayTiming::start] + end + end + end +end diff --git a/sig/imagekit/models/solid_color_overlay.rbs b/sig/imagekit/models/solid_color_overlay.rbs new file mode 100644 index 00000000..f006d7a6 --- /dev/null +++ b/sig/imagekit/models/solid_color_overlay.rbs @@ -0,0 +1,50 @@ +module Imagekit + module Models + type solid_color_overlay = + { + color: String, + type: Imagekit::Models::SolidColorOverlay::type_, + transformation: ::Array[Imagekit::SolidColorOverlayTransformation] + } + + class SolidColorOverlay < Imagekit::Models::BaseOverlay + def color: -> String + + def color=: (String _) -> String + + def `type`: -> Imagekit::Models::SolidColorOverlay::type_ + + def type=: ( + Imagekit::Models::SolidColorOverlay::type_ _ + ) -> Imagekit::Models::SolidColorOverlay::type_ + + def transformation: -> ::Array[Imagekit::SolidColorOverlayTransformation]? + + def transformation=: ( + ::Array[Imagekit::SolidColorOverlayTransformation] _ + ) -> ::Array[Imagekit::SolidColorOverlayTransformation] + + def initialize: ( + color: String, + type: Imagekit::Models::SolidColorOverlay::type_, + ?transformation: ::Array[Imagekit::SolidColorOverlayTransformation] + ) -> void + + def to_hash: -> { + color: String, + type: Imagekit::Models::SolidColorOverlay::type_, + transformation: ::Array[Imagekit::SolidColorOverlayTransformation] + } + + type type_ = :solidColor + + module Type + extend Imagekit::Internal::Type::Enum + + SOLID_COLOR: :solidColor + + def self?.values: -> ::Array[Imagekit::Models::SolidColorOverlay::type_] + end + end + end +end diff --git a/sig/imagekit/models/solid_color_overlay_transformation.rbs b/sig/imagekit/models/solid_color_overlay_transformation.rbs new file mode 100644 index 00000000..d750909f --- /dev/null +++ b/sig/imagekit/models/solid_color_overlay_transformation.rbs @@ -0,0 +1,101 @@ +module Imagekit + module Models + type solid_color_overlay_transformation = + { + alpha: Float, + background: String, + gradient: Imagekit::Models::SolidColorOverlayTransformation::gradient, + height: Imagekit::Models::SolidColorOverlayTransformation::height, + radius: Imagekit::Models::SolidColorOverlayTransformation::radius, + width: Imagekit::Models::SolidColorOverlayTransformation::width + } + + class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel + attr_reader alpha: Float? + + def alpha=: (Float) -> Float + + attr_reader background: String? + + def background=: (String) -> String + + attr_reader gradient: Imagekit::Models::SolidColorOverlayTransformation::gradient? + + def gradient=: ( + Imagekit::Models::SolidColorOverlayTransformation::gradient + ) -> Imagekit::Models::SolidColorOverlayTransformation::gradient + + attr_reader height: Imagekit::Models::SolidColorOverlayTransformation::height? + + def height=: ( + Imagekit::Models::SolidColorOverlayTransformation::height + ) -> Imagekit::Models::SolidColorOverlayTransformation::height + + attr_reader radius: Imagekit::Models::SolidColorOverlayTransformation::radius? + + def radius=: ( + Imagekit::Models::SolidColorOverlayTransformation::radius + ) -> Imagekit::Models::SolidColorOverlayTransformation::radius + + attr_reader width: Imagekit::Models::SolidColorOverlayTransformation::width? + + def width=: ( + Imagekit::Models::SolidColorOverlayTransformation::width + ) -> Imagekit::Models::SolidColorOverlayTransformation::width + + def initialize: ( + ?alpha: Float, + ?background: String, + ?gradient: Imagekit::Models::SolidColorOverlayTransformation::gradient, + ?height: Imagekit::Models::SolidColorOverlayTransformation::height, + ?radius: Imagekit::Models::SolidColorOverlayTransformation::radius, + ?width: Imagekit::Models::SolidColorOverlayTransformation::width + ) -> void + + def to_hash: -> { + alpha: Float, + background: String, + gradient: Imagekit::Models::SolidColorOverlayTransformation::gradient, + height: Imagekit::Models::SolidColorOverlayTransformation::height, + radius: Imagekit::Models::SolidColorOverlayTransformation::radius, + width: Imagekit::Models::SolidColorOverlayTransformation::width + } + + type gradient = true | String + + module Gradient + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::gradient] + + TRUE: true + end + + type height = Float | String + + module Height + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::height] + end + + type radius = Float | :max + + module Radius + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::radius] + + MAX: :max + end + + type width = Float | String + + module Width + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::width] + end + end + end +end diff --git a/sig/imagekit/models/src_options.rbs b/sig/imagekit/models/src_options.rbs new file mode 100644 index 00000000..dd5048ec --- /dev/null +++ b/sig/imagekit/models/src_options.rbs @@ -0,0 +1,60 @@ +module Imagekit + module Models + type src_options = + { + src: String, + url_endpoint: String, + query_parameters: ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter], + transformation: ::Array[Imagekit::Transformation], + transformation_position: Imagekit::Models::transformation_position + } + + class SrcOptions < Imagekit::Internal::Type::BaseModel + attr_accessor src: String + + attr_accessor url_endpoint: String + + attr_reader query_parameters: ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter]? + + def query_parameters=: ( + ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter] + ) -> ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter] + + attr_reader transformation: ::Array[Imagekit::Transformation]? + + def transformation=: ( + ::Array[Imagekit::Transformation] + ) -> ::Array[Imagekit::Transformation] + + attr_reader transformation_position: Imagekit::Models::transformation_position? + + def transformation_position=: ( + Imagekit::Models::transformation_position + ) -> Imagekit::Models::transformation_position + + def initialize: ( + src: String, + url_endpoint: String, + ?query_parameters: ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter], + ?transformation: ::Array[Imagekit::Transformation], + ?transformation_position: Imagekit::Models::transformation_position + ) -> void + + def to_hash: -> { + src: String, + url_endpoint: String, + query_parameters: ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter], + transformation: ::Array[Imagekit::Transformation], + transformation_position: Imagekit::Models::transformation_position + } + + type query_parameter = String | Float + + module QueryParameter + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::SrcOptions::query_parameter] + end + end + end +end diff --git a/sig/imagekit/models/streaming_resolution.rbs b/sig/imagekit/models/streaming_resolution.rbs new file mode 100644 index 00000000..7892c2cf --- /dev/null +++ b/sig/imagekit/models/streaming_resolution.rbs @@ -0,0 +1,20 @@ +module Imagekit + module Models + type streaming_resolution = + :"240" | :"360" | :"480" | :"720" | :"1080" | :"1440" | :"2160" + + module StreamingResolution + extend Imagekit::Internal::Type::Enum + + STREAMING_RESOLUTION_240: :"240" + STREAMING_RESOLUTION_360: :"360" + STREAMING_RESOLUTION_480: :"480" + STREAMING_RESOLUTION_720: :"720" + STREAMING_RESOLUTION_1080: :"1080" + STREAMING_RESOLUTION_1440: :"1440" + STREAMING_RESOLUTION_2160: :"2160" + + def self?.values: -> ::Array[Imagekit::Models::streaming_resolution] + end + end +end diff --git a/sig/imagekit/models/subtitle_overlay.rbs b/sig/imagekit/models/subtitle_overlay.rbs new file mode 100644 index 00000000..cd9be699 --- /dev/null +++ b/sig/imagekit/models/subtitle_overlay.rbs @@ -0,0 +1,71 @@ +module Imagekit + module Models + type subtitle_overlay = + { + input: String, + type: Imagekit::Models::SubtitleOverlay::type_, + encoding: Imagekit::Models::SubtitleOverlay::encoding, + transformation: ::Array[Imagekit::SubtitleOverlayTransformation] + } + + class SubtitleOverlay < Imagekit::Models::BaseOverlay + def input: -> String + + def input=: (String _) -> String + + def `type`: -> Imagekit::Models::SubtitleOverlay::type_ + + def type=: ( + Imagekit::Models::SubtitleOverlay::type_ _ + ) -> Imagekit::Models::SubtitleOverlay::type_ + + def encoding: -> Imagekit::Models::SubtitleOverlay::encoding? + + def encoding=: ( + Imagekit::Models::SubtitleOverlay::encoding _ + ) -> Imagekit::Models::SubtitleOverlay::encoding + + def transformation: -> ::Array[Imagekit::SubtitleOverlayTransformation]? + + def transformation=: ( + ::Array[Imagekit::SubtitleOverlayTransformation] _ + ) -> ::Array[Imagekit::SubtitleOverlayTransformation] + + def initialize: ( + input: String, + type: Imagekit::Models::SubtitleOverlay::type_, + ?encoding: Imagekit::Models::SubtitleOverlay::encoding, + ?transformation: ::Array[Imagekit::SubtitleOverlayTransformation] + ) -> void + + def to_hash: -> { + input: String, + type: Imagekit::Models::SubtitleOverlay::type_, + encoding: Imagekit::Models::SubtitleOverlay::encoding, + transformation: ::Array[Imagekit::SubtitleOverlayTransformation] + } + + type type_ = :subtitle + + module Type + extend Imagekit::Internal::Type::Enum + + SUBTITLE: :subtitle + + def self?.values: -> ::Array[Imagekit::Models::SubtitleOverlay::type_] + end + + type encoding = :auto | :plain | :base64 + + module Encoding + extend Imagekit::Internal::Type::Enum + + AUTO: :auto + PLAIN: :plain + BASE64: :base64 + + def self?.values: -> ::Array[Imagekit::Models::SubtitleOverlay::encoding] + end + end + end +end diff --git a/sig/imagekit/models/subtitle_overlay_transformation.rbs b/sig/imagekit/models/subtitle_overlay_transformation.rbs new file mode 100644 index 00000000..35b7498d --- /dev/null +++ b/sig/imagekit/models/subtitle_overlay_transformation.rbs @@ -0,0 +1,88 @@ +module Imagekit + module Models + type subtitle_overlay_transformation = + { + background: String, + color: String, + font_family: String, + font_outline: String, + font_shadow: String, + font_size: Imagekit::Models::SubtitleOverlayTransformation::font_size, + typography: Imagekit::Models::SubtitleOverlayTransformation::typography + } + + class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel + attr_reader background: String? + + def background=: (String) -> String + + attr_reader color: String? + + def color=: (String) -> String + + attr_reader font_family: String? + + def font_family=: (String) -> String + + attr_reader font_outline: String? + + def font_outline=: (String) -> String + + attr_reader font_shadow: String? + + def font_shadow=: (String) -> String + + attr_reader font_size: Imagekit::Models::SubtitleOverlayTransformation::font_size? + + def font_size=: ( + Imagekit::Models::SubtitleOverlayTransformation::font_size + ) -> Imagekit::Models::SubtitleOverlayTransformation::font_size + + attr_reader typography: Imagekit::Models::SubtitleOverlayTransformation::typography? + + def typography=: ( + Imagekit::Models::SubtitleOverlayTransformation::typography + ) -> Imagekit::Models::SubtitleOverlayTransformation::typography + + def initialize: ( + ?background: String, + ?color: String, + ?font_family: String, + ?font_outline: String, + ?font_shadow: String, + ?font_size: Imagekit::Models::SubtitleOverlayTransformation::font_size, + ?typography: Imagekit::Models::SubtitleOverlayTransformation::typography + ) -> void + + def to_hash: -> { + background: String, + color: String, + font_family: String, + font_outline: String, + font_shadow: String, + font_size: Imagekit::Models::SubtitleOverlayTransformation::font_size, + typography: Imagekit::Models::SubtitleOverlayTransformation::typography + } + + type font_size = Float | String + + module FontSize + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::SubtitleOverlayTransformation::font_size] + end + + type typography = :b | :i | :b_i + + module Typography + extend Imagekit::Internal::Type::Enum + + B: :b + I: :i + B_I: :b_i + + def self?.values: -> ::Array[Imagekit::Models::SubtitleOverlayTransformation::typography] + end + end + end +end diff --git a/sig/imagekit/models/text_overlay.rbs b/sig/imagekit/models/text_overlay.rbs new file mode 100644 index 00000000..6a60c741 --- /dev/null +++ b/sig/imagekit/models/text_overlay.rbs @@ -0,0 +1,71 @@ +module Imagekit + module Models + type text_overlay = + { + text: String, + type: Imagekit::Models::TextOverlay::type_, + encoding: Imagekit::Models::TextOverlay::encoding, + transformation: ::Array[Imagekit::TextOverlayTransformation] + } + + class TextOverlay < Imagekit::Models::BaseOverlay + def text: -> String + + def text=: (String _) -> String + + def `type`: -> Imagekit::Models::TextOverlay::type_ + + def type=: ( + Imagekit::Models::TextOverlay::type_ _ + ) -> Imagekit::Models::TextOverlay::type_ + + def encoding: -> Imagekit::Models::TextOverlay::encoding? + + def encoding=: ( + Imagekit::Models::TextOverlay::encoding _ + ) -> Imagekit::Models::TextOverlay::encoding + + def transformation: -> ::Array[Imagekit::TextOverlayTransformation]? + + def transformation=: ( + ::Array[Imagekit::TextOverlayTransformation] _ + ) -> ::Array[Imagekit::TextOverlayTransformation] + + def initialize: ( + text: String, + type: Imagekit::Models::TextOverlay::type_, + ?encoding: Imagekit::Models::TextOverlay::encoding, + ?transformation: ::Array[Imagekit::TextOverlayTransformation] + ) -> void + + def to_hash: -> { + text: String, + type: Imagekit::Models::TextOverlay::type_, + encoding: Imagekit::Models::TextOverlay::encoding, + transformation: ::Array[Imagekit::TextOverlayTransformation] + } + + type type_ = :text + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :text + + def self?.values: -> ::Array[Imagekit::Models::TextOverlay::type_] + end + + type encoding = :auto | :plain | :base64 + + module Encoding + extend Imagekit::Internal::Type::Enum + + AUTO: :auto + PLAIN: :plain + BASE64: :base64 + + def self?.values: -> ::Array[Imagekit::Models::TextOverlay::encoding] + end + end + end +end diff --git a/sig/imagekit/models/text_overlay_transformation.rbs b/sig/imagekit/models/text_overlay_transformation.rbs new file mode 100644 index 00000000..685b1ea0 --- /dev/null +++ b/sig/imagekit/models/text_overlay_transformation.rbs @@ -0,0 +1,211 @@ +module Imagekit + module Models + type text_overlay_transformation = + { + alpha: Float, + background: String, + flip: Imagekit::Models::TextOverlayTransformation::flip, + font_color: String, + font_family: String, + font_size: Imagekit::Models::TextOverlayTransformation::font_size, + inner_alignment: Imagekit::Models::TextOverlayTransformation::inner_alignment, + line_height: Imagekit::Models::TextOverlayTransformation::line_height, + padding: Imagekit::Models::TextOverlayTransformation::padding, + radius: Imagekit::Models::TextOverlayTransformation::radius, + rotation: Imagekit::Models::TextOverlayTransformation::rotation, + typography: Imagekit::Models::TextOverlayTransformation::typography, + width: Imagekit::Models::TextOverlayTransformation::width + } + + class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel + attr_reader alpha: Float? + + def alpha=: (Float) -> Float + + attr_reader background: String? + + def background=: (String) -> String + + attr_reader flip: Imagekit::Models::TextOverlayTransformation::flip? + + def flip=: ( + Imagekit::Models::TextOverlayTransformation::flip + ) -> Imagekit::Models::TextOverlayTransformation::flip + + attr_reader font_color: String? + + def font_color=: (String) -> String + + attr_reader font_family: String? + + def font_family=: (String) -> String + + attr_reader font_size: Imagekit::Models::TextOverlayTransformation::font_size? + + def font_size=: ( + Imagekit::Models::TextOverlayTransformation::font_size + ) -> Imagekit::Models::TextOverlayTransformation::font_size + + attr_reader inner_alignment: Imagekit::Models::TextOverlayTransformation::inner_alignment? + + def inner_alignment=: ( + Imagekit::Models::TextOverlayTransformation::inner_alignment + ) -> Imagekit::Models::TextOverlayTransformation::inner_alignment + + attr_reader line_height: Imagekit::Models::TextOverlayTransformation::line_height? + + def line_height=: ( + Imagekit::Models::TextOverlayTransformation::line_height + ) -> Imagekit::Models::TextOverlayTransformation::line_height + + attr_reader padding: Imagekit::Models::TextOverlayTransformation::padding? + + def padding=: ( + Imagekit::Models::TextOverlayTransformation::padding + ) -> Imagekit::Models::TextOverlayTransformation::padding + + attr_reader radius: Imagekit::Models::TextOverlayTransformation::radius? + + def radius=: ( + Imagekit::Models::TextOverlayTransformation::radius + ) -> Imagekit::Models::TextOverlayTransformation::radius + + attr_reader rotation: Imagekit::Models::TextOverlayTransformation::rotation? + + def rotation=: ( + Imagekit::Models::TextOverlayTransformation::rotation + ) -> Imagekit::Models::TextOverlayTransformation::rotation + + attr_reader typography: Imagekit::Models::TextOverlayTransformation::typography? + + def typography=: ( + Imagekit::Models::TextOverlayTransformation::typography + ) -> Imagekit::Models::TextOverlayTransformation::typography + + attr_reader width: Imagekit::Models::TextOverlayTransformation::width? + + def width=: ( + Imagekit::Models::TextOverlayTransformation::width + ) -> Imagekit::Models::TextOverlayTransformation::width + + def initialize: ( + ?alpha: Float, + ?background: String, + ?flip: Imagekit::Models::TextOverlayTransformation::flip, + ?font_color: String, + ?font_family: String, + ?font_size: Imagekit::Models::TextOverlayTransformation::font_size, + ?inner_alignment: Imagekit::Models::TextOverlayTransformation::inner_alignment, + ?line_height: Imagekit::Models::TextOverlayTransformation::line_height, + ?padding: Imagekit::Models::TextOverlayTransformation::padding, + ?radius: Imagekit::Models::TextOverlayTransformation::radius, + ?rotation: Imagekit::Models::TextOverlayTransformation::rotation, + ?typography: Imagekit::Models::TextOverlayTransformation::typography, + ?width: Imagekit::Models::TextOverlayTransformation::width + ) -> void + + def to_hash: -> { + alpha: Float, + background: String, + flip: Imagekit::Models::TextOverlayTransformation::flip, + font_color: String, + font_family: String, + font_size: Imagekit::Models::TextOverlayTransformation::font_size, + inner_alignment: Imagekit::Models::TextOverlayTransformation::inner_alignment, + line_height: Imagekit::Models::TextOverlayTransformation::line_height, + padding: Imagekit::Models::TextOverlayTransformation::padding, + radius: Imagekit::Models::TextOverlayTransformation::radius, + rotation: Imagekit::Models::TextOverlayTransformation::rotation, + typography: Imagekit::Models::TextOverlayTransformation::typography, + width: Imagekit::Models::TextOverlayTransformation::width + } + + type flip = :h | :v | :h_v | :v_h + + module Flip + extend Imagekit::Internal::Type::Enum + + H: :h + V: :v + H_V: :h_v + V_H: :v_h + + def self?.values: -> ::Array[Imagekit::Models::TextOverlayTransformation::flip] + end + + type font_size = Float | String + + module FontSize + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::font_size] + end + + type inner_alignment = :left | :right | :center + + module InnerAlignment + extend Imagekit::Internal::Type::Enum + + LEFT: :left + RIGHT: :right + CENTER: :center + + def self?.values: -> ::Array[Imagekit::Models::TextOverlayTransformation::inner_alignment] + end + + type line_height = Float | String + + module LineHeight + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::line_height] + end + + type padding = Float | String + + module Padding + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::padding] + end + + type radius = Float | :max + + module Radius + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::radius] + + MAX: :max + end + + type rotation = Float | String + + module Rotation + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::rotation] + end + + type typography = :b | :i | :b_i + + module Typography + extend Imagekit::Internal::Type::Enum + + B: :b + I: :i + B_I: :b_i + + def self?.values: -> ::Array[Imagekit::Models::TextOverlayTransformation::typography] + end + + type width = Float | String + + module Width + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::width] + end + end + end +end diff --git a/sig/imagekit/models/transformation.rbs b/sig/imagekit/models/transformation.rbs new file mode 100644 index 00000000..55bde641 --- /dev/null +++ b/sig/imagekit/models/transformation.rbs @@ -0,0 +1,770 @@ +module Imagekit + module Models + type transformation = + { + ai_change_background: String, + ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, + ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, + ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, + ai_retouch: Imagekit::Models::Transformation::ai_retouch, + ai_upscale: Imagekit::Models::Transformation::ai_upscale, + ai_variation: Imagekit::Models::Transformation::ai_variation, + aspect_ratio: Imagekit::Models::Transformation::aspect_ratio, + audio_codec: Imagekit::Models::Transformation::audio_codec, + background: String, + blur: Float, + border: String, + color_profile: bool, + contrast_stretch: Imagekit::Models::Transformation::contrast_stretch, + crop: Imagekit::Models::Transformation::crop, + crop_mode: Imagekit::Models::Transformation::crop_mode, + default_image: String, + dpr: Float, + duration: Imagekit::Models::Transformation::duration, + end_offset: Imagekit::Models::Transformation::end_offset, + flip: Imagekit::Models::Transformation::flip, + focus: String, + format_: Imagekit::Models::Transformation::format_, + gradient: Imagekit::Models::Transformation::gradient, + grayscale: Imagekit::Models::Transformation::grayscale, + height: Imagekit::Models::Transformation::height, + lossless: bool, + metadata: bool, + named: String, + opacity: Float, + original: bool, + overlay: Imagekit::Models::overlay, + page: Imagekit::Models::Transformation::page, + progressive: bool, + quality: Float, + radius: Imagekit::Models::Transformation::radius, + raw: String, + rotation: Imagekit::Models::Transformation::rotation, + shadow: Imagekit::Models::Transformation::shadow, + sharpen: Imagekit::Models::Transformation::sharpen, + start_offset: Imagekit::Models::Transformation::start_offset, + streaming_resolutions: ::Array[Imagekit::Models::streaming_resolution], + trim: Imagekit::Models::Transformation::trim, + unsharp_mask: Imagekit::Models::Transformation::unsharp_mask, + video_codec: Imagekit::Models::Transformation::video_codec, + width: Imagekit::Models::Transformation::width, + x: Imagekit::Models::Transformation::x, + x_center: Imagekit::Models::Transformation::x_center, + y_: Imagekit::Models::Transformation::y_, + y_center: Imagekit::Models::Transformation::y_center, + zoom: Float + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_reader ai_change_background: String? + + def ai_change_background=: (String) -> String + + attr_reader ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow? + + def ai_drop_shadow=: ( + Imagekit::Models::Transformation::ai_drop_shadow + ) -> Imagekit::Models::Transformation::ai_drop_shadow + + attr_reader ai_remove_background: Imagekit::Models::Transformation::ai_remove_background? + + def ai_remove_background=: ( + Imagekit::Models::Transformation::ai_remove_background + ) -> Imagekit::Models::Transformation::ai_remove_background + + attr_reader ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external? + + def ai_remove_background_external=: ( + Imagekit::Models::Transformation::ai_remove_background_external + ) -> Imagekit::Models::Transformation::ai_remove_background_external + + attr_reader ai_retouch: Imagekit::Models::Transformation::ai_retouch? + + def ai_retouch=: ( + Imagekit::Models::Transformation::ai_retouch + ) -> Imagekit::Models::Transformation::ai_retouch + + attr_reader ai_upscale: Imagekit::Models::Transformation::ai_upscale? + + def ai_upscale=: ( + Imagekit::Models::Transformation::ai_upscale + ) -> Imagekit::Models::Transformation::ai_upscale + + attr_reader ai_variation: Imagekit::Models::Transformation::ai_variation? + + def ai_variation=: ( + Imagekit::Models::Transformation::ai_variation + ) -> Imagekit::Models::Transformation::ai_variation + + attr_reader aspect_ratio: Imagekit::Models::Transformation::aspect_ratio? + + def aspect_ratio=: ( + Imagekit::Models::Transformation::aspect_ratio + ) -> Imagekit::Models::Transformation::aspect_ratio + + attr_reader audio_codec: Imagekit::Models::Transformation::audio_codec? + + def audio_codec=: ( + Imagekit::Models::Transformation::audio_codec + ) -> Imagekit::Models::Transformation::audio_codec + + attr_reader background: String? + + def background=: (String) -> String + + attr_reader blur: Float? + + def blur=: (Float) -> Float + + attr_reader border: String? + + def border=: (String) -> String + + attr_reader color_profile: bool? + + def color_profile=: (bool) -> bool + + attr_reader contrast_stretch: Imagekit::Models::Transformation::contrast_stretch? + + def contrast_stretch=: ( + Imagekit::Models::Transformation::contrast_stretch + ) -> Imagekit::Models::Transformation::contrast_stretch + + attr_reader crop: Imagekit::Models::Transformation::crop? + + def crop=: ( + Imagekit::Models::Transformation::crop + ) -> Imagekit::Models::Transformation::crop + + attr_reader crop_mode: Imagekit::Models::Transformation::crop_mode? + + def crop_mode=: ( + Imagekit::Models::Transformation::crop_mode + ) -> Imagekit::Models::Transformation::crop_mode + + attr_reader default_image: String? + + def default_image=: (String) -> String + + attr_reader dpr: Float? + + def dpr=: (Float) -> Float + + attr_reader duration: Imagekit::Models::Transformation::duration? + + def duration=: ( + Imagekit::Models::Transformation::duration + ) -> Imagekit::Models::Transformation::duration + + attr_reader end_offset: Imagekit::Models::Transformation::end_offset? + + def end_offset=: ( + Imagekit::Models::Transformation::end_offset + ) -> Imagekit::Models::Transformation::end_offset + + attr_reader flip: Imagekit::Models::Transformation::flip? + + def flip=: ( + Imagekit::Models::Transformation::flip + ) -> Imagekit::Models::Transformation::flip + + attr_reader focus: String? + + def focus=: (String) -> String + + attr_reader format_: Imagekit::Models::Transformation::format_? + + def format_=: ( + Imagekit::Models::Transformation::format_ + ) -> Imagekit::Models::Transformation::format_ + + attr_reader gradient: Imagekit::Models::Transformation::gradient? + + def gradient=: ( + Imagekit::Models::Transformation::gradient + ) -> Imagekit::Models::Transformation::gradient + + attr_reader grayscale: Imagekit::Models::Transformation::grayscale? + + def grayscale=: ( + Imagekit::Models::Transformation::grayscale + ) -> Imagekit::Models::Transformation::grayscale + + attr_reader height: Imagekit::Models::Transformation::height? + + def height=: ( + Imagekit::Models::Transformation::height + ) -> Imagekit::Models::Transformation::height + + attr_reader lossless: bool? + + def lossless=: (bool) -> bool + + attr_reader metadata: bool? + + def metadata=: (bool) -> bool + + attr_reader named: String? + + def named=: (String) -> String + + attr_reader opacity: Float? + + def opacity=: (Float) -> Float + + attr_reader original: bool? + + def original=: (bool) -> bool + + attr_reader overlay: Imagekit::Models::overlay? + + def overlay=: (Imagekit::Models::overlay) -> Imagekit::Models::overlay + + attr_reader page: Imagekit::Models::Transformation::page? + + def page=: ( + Imagekit::Models::Transformation::page + ) -> Imagekit::Models::Transformation::page + + attr_reader progressive: bool? + + def progressive=: (bool) -> bool + + attr_reader quality: Float? + + def quality=: (Float) -> Float + + attr_reader radius: Imagekit::Models::Transformation::radius? + + def radius=: ( + Imagekit::Models::Transformation::radius + ) -> Imagekit::Models::Transformation::radius + + attr_reader raw: String? + + def raw=: (String) -> String + + attr_reader rotation: Imagekit::Models::Transformation::rotation? + + def rotation=: ( + Imagekit::Models::Transformation::rotation + ) -> Imagekit::Models::Transformation::rotation + + attr_reader shadow: Imagekit::Models::Transformation::shadow? + + def shadow=: ( + Imagekit::Models::Transformation::shadow + ) -> Imagekit::Models::Transformation::shadow + + attr_reader sharpen: Imagekit::Models::Transformation::sharpen? + + def sharpen=: ( + Imagekit::Models::Transformation::sharpen + ) -> Imagekit::Models::Transformation::sharpen + + attr_reader start_offset: Imagekit::Models::Transformation::start_offset? + + def start_offset=: ( + Imagekit::Models::Transformation::start_offset + ) -> Imagekit::Models::Transformation::start_offset + + attr_reader streaming_resolutions: ::Array[Imagekit::Models::streaming_resolution]? + + def streaming_resolutions=: ( + ::Array[Imagekit::Models::streaming_resolution] + ) -> ::Array[Imagekit::Models::streaming_resolution] + + attr_reader trim: Imagekit::Models::Transformation::trim? + + def trim=: ( + Imagekit::Models::Transformation::trim + ) -> Imagekit::Models::Transformation::trim + + attr_reader unsharp_mask: Imagekit::Models::Transformation::unsharp_mask? + + def unsharp_mask=: ( + Imagekit::Models::Transformation::unsharp_mask + ) -> Imagekit::Models::Transformation::unsharp_mask + + attr_reader video_codec: Imagekit::Models::Transformation::video_codec? + + def video_codec=: ( + Imagekit::Models::Transformation::video_codec + ) -> Imagekit::Models::Transformation::video_codec + + attr_reader width: Imagekit::Models::Transformation::width? + + def width=: ( + Imagekit::Models::Transformation::width + ) -> Imagekit::Models::Transformation::width + + attr_reader x: Imagekit::Models::Transformation::x? + + def x=: ( + Imagekit::Models::Transformation::x + ) -> Imagekit::Models::Transformation::x + + attr_reader x_center: Imagekit::Models::Transformation::x_center? + + def x_center=: ( + Imagekit::Models::Transformation::x_center + ) -> Imagekit::Models::Transformation::x_center + + attr_reader y_: Imagekit::Models::Transformation::y_? + + def y_=: ( + Imagekit::Models::Transformation::y_ + ) -> Imagekit::Models::Transformation::y_ + + attr_reader y_center: Imagekit::Models::Transformation::y_center? + + def y_center=: ( + Imagekit::Models::Transformation::y_center + ) -> Imagekit::Models::Transformation::y_center + + attr_reader zoom: Float? + + def zoom=: (Float) -> Float + + def initialize: ( + ?ai_change_background: String, + ?ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, + ?ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, + ?ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, + ?ai_retouch: Imagekit::Models::Transformation::ai_retouch, + ?ai_upscale: Imagekit::Models::Transformation::ai_upscale, + ?ai_variation: Imagekit::Models::Transformation::ai_variation, + ?aspect_ratio: Imagekit::Models::Transformation::aspect_ratio, + ?audio_codec: Imagekit::Models::Transformation::audio_codec, + ?background: String, + ?blur: Float, + ?border: String, + ?color_profile: bool, + ?contrast_stretch: Imagekit::Models::Transformation::contrast_stretch, + ?crop: Imagekit::Models::Transformation::crop, + ?crop_mode: Imagekit::Models::Transformation::crop_mode, + ?default_image: String, + ?dpr: Float, + ?duration: Imagekit::Models::Transformation::duration, + ?end_offset: Imagekit::Models::Transformation::end_offset, + ?flip: Imagekit::Models::Transformation::flip, + ?focus: String, + ?format_: Imagekit::Models::Transformation::format_, + ?gradient: Imagekit::Models::Transformation::gradient, + ?grayscale: Imagekit::Models::Transformation::grayscale, + ?height: Imagekit::Models::Transformation::height, + ?lossless: bool, + ?metadata: bool, + ?named: String, + ?opacity: Float, + ?original: bool, + ?overlay: Imagekit::Models::overlay, + ?page: Imagekit::Models::Transformation::page, + ?progressive: bool, + ?quality: Float, + ?radius: Imagekit::Models::Transformation::radius, + ?raw: String, + ?rotation: Imagekit::Models::Transformation::rotation, + ?shadow: Imagekit::Models::Transformation::shadow, + ?sharpen: Imagekit::Models::Transformation::sharpen, + ?start_offset: Imagekit::Models::Transformation::start_offset, + ?streaming_resolutions: ::Array[Imagekit::Models::streaming_resolution], + ?trim: Imagekit::Models::Transformation::trim, + ?unsharp_mask: Imagekit::Models::Transformation::unsharp_mask, + ?video_codec: Imagekit::Models::Transformation::video_codec, + ?width: Imagekit::Models::Transformation::width, + ?x: Imagekit::Models::Transformation::x, + ?x_center: Imagekit::Models::Transformation::x_center, + ?y_: Imagekit::Models::Transformation::y_, + ?y_center: Imagekit::Models::Transformation::y_center, + ?zoom: Float + ) -> void + + def to_hash: -> { + ai_change_background: String, + ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, + ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, + ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, + ai_retouch: Imagekit::Models::Transformation::ai_retouch, + ai_upscale: Imagekit::Models::Transformation::ai_upscale, + ai_variation: Imagekit::Models::Transformation::ai_variation, + aspect_ratio: Imagekit::Models::Transformation::aspect_ratio, + audio_codec: Imagekit::Models::Transformation::audio_codec, + background: String, + blur: Float, + border: String, + color_profile: bool, + contrast_stretch: Imagekit::Models::Transformation::contrast_stretch, + crop: Imagekit::Models::Transformation::crop, + crop_mode: Imagekit::Models::Transformation::crop_mode, + default_image: String, + dpr: Float, + duration: Imagekit::Models::Transformation::duration, + end_offset: Imagekit::Models::Transformation::end_offset, + flip: Imagekit::Models::Transformation::flip, + focus: String, + format_: Imagekit::Models::Transformation::format_, + gradient: Imagekit::Models::Transformation::gradient, + grayscale: Imagekit::Models::Transformation::grayscale, + height: Imagekit::Models::Transformation::height, + lossless: bool, + metadata: bool, + named: String, + opacity: Float, + original: bool, + overlay: Imagekit::Models::overlay, + page: Imagekit::Models::Transformation::page, + progressive: bool, + quality: Float, + radius: Imagekit::Models::Transformation::radius, + raw: String, + rotation: Imagekit::Models::Transformation::rotation, + shadow: Imagekit::Models::Transformation::shadow, + sharpen: Imagekit::Models::Transformation::sharpen, + start_offset: Imagekit::Models::Transformation::start_offset, + streaming_resolutions: ::Array[Imagekit::Models::streaming_resolution], + trim: Imagekit::Models::Transformation::trim, + unsharp_mask: Imagekit::Models::Transformation::unsharp_mask, + video_codec: Imagekit::Models::Transformation::video_codec, + width: Imagekit::Models::Transformation::width, + x: Imagekit::Models::Transformation::x, + x_center: Imagekit::Models::Transformation::x_center, + y_: Imagekit::Models::Transformation::y_, + y_center: Imagekit::Models::Transformation::y_center, + zoom: Float + } + + type ai_drop_shadow = true | String + + module AIDropShadow + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::ai_drop_shadow] + + TRUE: true + end + + type ai_remove_background = true + + module AIRemoveBackground + extend Imagekit::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_remove_background] + end + + type ai_remove_background_external = true + + module AIRemoveBackgroundExternal + extend Imagekit::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_remove_background_external] + end + + type ai_retouch = true + + module AIRetouch + extend Imagekit::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_retouch] + end + + type ai_upscale = true + + module AIUpscale + extend Imagekit::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_upscale] + end + + type ai_variation = true + + module AIVariation + extend Imagekit::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_variation] + end + + type aspect_ratio = Float | String + + module AspectRatio + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::aspect_ratio] + end + + type audio_codec = :aac | :opus | :none + + module AudioCodec + extend Imagekit::Internal::Type::Enum + + AAC: :aac + OPUS: :opus + NONE: :none + + def self?.values: -> ::Array[Imagekit::Models::Transformation::audio_codec] + end + + type contrast_stretch = true + + module ContrastStretch + extend Imagekit::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekit::Models::Transformation::contrast_stretch] + end + + type crop = + :force | :at_max | :at_max_enlarge | :at_least | :maintain_ratio + + module Crop + extend Imagekit::Internal::Type::Enum + + FORCE: :force + AT_MAX: :at_max + AT_MAX_ENLARGE: :at_max_enlarge + AT_LEAST: :at_least + MAINTAIN_RATIO: :maintain_ratio + + def self?.values: -> ::Array[Imagekit::Models::Transformation::crop] + end + + type crop_mode = :pad_resize | :extract | :pad_extract + + module CropMode + extend Imagekit::Internal::Type::Enum + + PAD_RESIZE: :pad_resize + EXTRACT: :extract + PAD_EXTRACT: :pad_extract + + def self?.values: -> ::Array[Imagekit::Models::Transformation::crop_mode] + end + + type duration = Float | String + + module Duration + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::duration] + end + + type end_offset = Float | String + + module EndOffset + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::end_offset] + end + + type flip = :h | :v | :h_v | :v_h + + module Flip + extend Imagekit::Internal::Type::Enum + + H: :h + V: :v + H_V: :h_v + V_H: :v_h + + def self?.values: -> ::Array[Imagekit::Models::Transformation::flip] + end + + type format_ = + :auto + | :webp + | :jpg + | :jpeg + | :png + | :gif + | :svg + | :mp4 + | :webm + | :avif + | :orig + + module Format + extend Imagekit::Internal::Type::Enum + + AUTO: :auto + WEBP: :webp + JPG: :jpg + JPEG: :jpeg + PNG: :png + GIF: :gif + SVG: :svg + MP4: :mp4 + WEBM: :webm + AVIF: :avif + ORIG: :orig + + def self?.values: -> ::Array[Imagekit::Models::Transformation::format_] + end + + type gradient = true | String + + module Gradient + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::gradient] + + TRUE: true + end + + type grayscale = true + + module Grayscale + extend Imagekit::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekit::Models::Transformation::grayscale] + end + + type height = Float | String + + module Height + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::height] + end + + type page = Float | String + + module Page + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::page] + end + + type radius = Float | :max + + module Radius + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::radius] + + MAX: :max + end + + type rotation = Float | String + + module Rotation + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::rotation] + end + + type shadow = true | String + + module Shadow + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::shadow] + + TRUE: true + end + + type sharpen = true | Float + + module Sharpen + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::sharpen] + + TRUE: true + end + + type start_offset = Float | String + + module StartOffset + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::start_offset] + end + + type trim = true | Float + + module Trim + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::trim] + + TRUE: true + end + + type unsharp_mask = true | String + + module UnsharpMask + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::unsharp_mask] + + TRUE: true + end + + type video_codec = :h264 | :vp9 | :av1 | :none + + module VideoCodec + extend Imagekit::Internal::Type::Enum + + H264: :h264 + VP9: :vp9 + AV1: :av1 + NONE: :none + + def self?.values: -> ::Array[Imagekit::Models::Transformation::video_codec] + end + + type width = Float | String + + module Width + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::width] + end + + type x = Float | String + + module X + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::x] + end + + type x_center = Float | String + + module XCenter + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::x_center] + end + + type y_ = Float | String + + module Y + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::y_] + end + + type y_center = Float | String + + module YCenter + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Transformation::y_center] + end + end + end +end diff --git a/sig/imagekit/models/transformation_position.rbs b/sig/imagekit/models/transformation_position.rbs new file mode 100644 index 00000000..60ed3513 --- /dev/null +++ b/sig/imagekit/models/transformation_position.rbs @@ -0,0 +1,14 @@ +module Imagekit + module Models + type transformation_position = :path | :query + + module TransformationPosition + extend Imagekit::Internal::Type::Enum + + PATH: :path + QUERY: :query + + def self?.values: -> ::Array[Imagekit::Models::transformation_position] + end + end +end diff --git a/sig/imagekit/models/video_overlay.rbs b/sig/imagekit/models/video_overlay.rbs new file mode 100644 index 00000000..ca6127d7 --- /dev/null +++ b/sig/imagekit/models/video_overlay.rbs @@ -0,0 +1,71 @@ +module Imagekit + module Models + type video_overlay = + { + input: String, + type: Imagekit::Models::VideoOverlay::type_, + encoding: Imagekit::Models::VideoOverlay::encoding, + transformation: ::Array[Imagekit::Transformation] + } + + class VideoOverlay < Imagekit::Models::BaseOverlay + def input: -> String + + def input=: (String _) -> String + + def `type`: -> Imagekit::Models::VideoOverlay::type_ + + def type=: ( + Imagekit::Models::VideoOverlay::type_ _ + ) -> Imagekit::Models::VideoOverlay::type_ + + def encoding: -> Imagekit::Models::VideoOverlay::encoding? + + def encoding=: ( + Imagekit::Models::VideoOverlay::encoding _ + ) -> Imagekit::Models::VideoOverlay::encoding + + def transformation: -> ::Array[Imagekit::Transformation]? + + def transformation=: ( + ::Array[Imagekit::Transformation] _ + ) -> ::Array[Imagekit::Transformation] + + def initialize: ( + input: String, + type: Imagekit::Models::VideoOverlay::type_, + ?encoding: Imagekit::Models::VideoOverlay::encoding, + ?transformation: ::Array[Imagekit::Transformation] + ) -> void + + def to_hash: -> { + input: String, + type: Imagekit::Models::VideoOverlay::type_, + encoding: Imagekit::Models::VideoOverlay::encoding, + transformation: ::Array[Imagekit::Transformation] + } + + type type_ = :video + + module Type + extend Imagekit::Internal::Type::Enum + + VIDEO: :video + + def self?.values: -> ::Array[Imagekit::Models::VideoOverlay::type_] + end + + type encoding = :auto | :plain | :base64 + + module Encoding + extend Imagekit::Internal::Type::Enum + + AUTO: :auto + PLAIN: :plain + BASE64: :base64 + + def self?.values: -> ::Array[Imagekit::Models::VideoOverlay::encoding] + end + end + end +end diff --git a/test/imagekit/resources/shared_test.rb b/test/imagekit/resources/shared_test.rb new file mode 100644 index 00000000..be22f0e4 --- /dev/null +++ b/test/imagekit/resources/shared_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekit::Test::Resources::SharedTest < Imagekit::Test::ResourceTest +end From 321ccde8d46a677a6200fe39ccd6818087d529dc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 10:56:03 +0000 Subject: [PATCH 072/178] feat(api): manual updates --- .stats.yml | 4 ++-- lib/imagekit/models/src_options.rb | 19 +++------------- rbi/imagekit/models/src_options.rbi | 35 ++++------------------------- sig/imagekit/models/src_options.rbs | 20 +++++------------ 4 files changed, 14 insertions(+), 64 deletions(-) diff --git a/.stats.yml b/.stats.yml index 64418ba8..67507d30 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-f3bff3868f6fb17535ab409692a079b9187de5922d7f04578082ea44680d28db.yml -openapi_spec_hash: 00e12ee294dedaf7afab030d42178bf2 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-81851750ac0e826623eae52a2361a85e97d1dc39cfcd47adea4b392440c897f1.yml +openapi_spec_hash: b36ee8d65b9b270168076c8d36420dc1 config_hash: 1dd1a96eff228aa2567b9973c36f5593 diff --git a/lib/imagekit/models/src_options.rb b/lib/imagekit/models/src_options.rb index c029bd0a..0bb39a4d 100644 --- a/lib/imagekit/models/src_options.rb +++ b/lib/imagekit/models/src_options.rb @@ -23,10 +23,8 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # 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. # - # @return [Hash{Symbol=>String, Float}, nil] - optional :query_parameters, - -> { Imagekit::Internal::Type::HashOf[union: Imagekit::SrcOptions::QueryParameter] }, - api_name: :queryParameters + # @return [Hash{Symbol=>String}, nil] + optional :query_parameters, Imagekit::Internal::Type::HashOf[String], api_name: :queryParameters # @!attribute transformation # An array of objects specifying the transformations to be applied in the URL. If @@ -56,22 +54,11 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # # @param url_endpoint [String] Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard # - # @param query_parameters [Hash{Symbol=>String, Float}] These are additional query parameters that you want to add to the final URL. + # @param query_parameters [Hash{Symbol=>String}] These are additional query parameters that you want to add to the final URL. # # @param transformation [Array] An array of objects specifying the transformations to be applied in the URL. If # # @param transformation_position [Symbol, Imagekit::Models::TransformationPosition] By default, the transformation string is added as a query parameter in the URL, - - module QueryParameter - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end end end end diff --git a/rbi/imagekit/models/src_options.rbi b/rbi/imagekit/models/src_options.rbi index 9283129a..99580e3a 100644 --- a/rbi/imagekit/models/src_options.rbi +++ b/rbi/imagekit/models/src_options.rbi @@ -22,21 +22,10 @@ module Imagekit # 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. - sig do - returns( - T.nilable( - T::Hash[Symbol, Imagekit::SrcOptions::QueryParameter::Variants] - ) - ) - end + sig { returns(T.nilable(T::Hash[Symbol, String])) } attr_reader :query_parameters - sig do - params( - query_parameters: - T::Hash[Symbol, Imagekit::SrcOptions::QueryParameter::Variants] - ).void - end + sig { params(query_parameters: T::Hash[Symbol, String]).void } attr_writer :query_parameters # An array of objects specifying the transformations to be applied in the URL. If @@ -68,8 +57,7 @@ module Imagekit params( src: String, url_endpoint: String, - query_parameters: - T::Hash[Symbol, Imagekit::SrcOptions::QueryParameter::Variants], + query_parameters: T::Hash[Symbol, String], transformation: T::Array[Imagekit::Transformation::OrHash], transformation_position: Imagekit::TransformationPosition::OrSymbol ).returns(T.attached_class) @@ -102,8 +90,7 @@ module Imagekit { src: String, url_endpoint: String, - query_parameters: - T::Hash[Symbol, Imagekit::SrcOptions::QueryParameter::Variants], + query_parameters: T::Hash[Symbol, String], transformation: T::Array[Imagekit::Transformation], transformation_position: Imagekit::TransformationPosition::OrSymbol } @@ -111,20 +98,6 @@ module Imagekit end def to_hash end - - module QueryParameter - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[Imagekit::SrcOptions::QueryParameter::Variants] - ) - end - def self.variants - end - end end end end diff --git a/sig/imagekit/models/src_options.rbs b/sig/imagekit/models/src_options.rbs index dd5048ec..e61692aa 100644 --- a/sig/imagekit/models/src_options.rbs +++ b/sig/imagekit/models/src_options.rbs @@ -4,7 +4,7 @@ module Imagekit { src: String, url_endpoint: String, - query_parameters: ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter], + query_parameters: ::Hash[Symbol, String], transformation: ::Array[Imagekit::Transformation], transformation_position: Imagekit::Models::transformation_position } @@ -14,11 +14,9 @@ module Imagekit attr_accessor url_endpoint: String - attr_reader query_parameters: ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter]? + attr_reader query_parameters: ::Hash[Symbol, String]? - def query_parameters=: ( - ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter] - ) -> ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter] + def query_parameters=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String] attr_reader transformation: ::Array[Imagekit::Transformation]? @@ -35,7 +33,7 @@ module Imagekit def initialize: ( src: String, url_endpoint: String, - ?query_parameters: ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter], + ?query_parameters: ::Hash[Symbol, String], ?transformation: ::Array[Imagekit::Transformation], ?transformation_position: Imagekit::Models::transformation_position ) -> void @@ -43,18 +41,10 @@ module Imagekit def to_hash: -> { src: String, url_endpoint: String, - query_parameters: ::Hash[Symbol, Imagekit::Models::SrcOptions::query_parameter], + query_parameters: ::Hash[Symbol, String], transformation: ::Array[Imagekit::Transformation], transformation_position: Imagekit::Models::transformation_position } - - type query_parameter = String | Float - - module QueryParameter - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::SrcOptions::query_parameter] - end end end end From f1701b66c85b1b3d1b46db2f847a9dd07f7b1320 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 30 Aug 2025 12:53:23 +0000 Subject: [PATCH 073/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 67507d30..c328b0a5 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-81851750ac0e826623eae52a2361a85e97d1dc39cfcd47adea4b392440c897f1.yml openapi_spec_hash: b36ee8d65b9b270168076c8d36420dc1 -config_hash: 1dd1a96eff228aa2567b9973c36f5593 +config_hash: 93458331374b86a886e325d435070b07 From c763ac8d9985f6d82f6ab0352fd1b33a32846e06 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 30 Aug 2025 12:59:52 +0000 Subject: [PATCH 074/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index c328b0a5..57157abd 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-81851750ac0e826623eae52a2361a85e97d1dc39cfcd47adea4b392440c897f1.yml openapi_spec_hash: b36ee8d65b9b270168076c8d36420dc1 -config_hash: 93458331374b86a886e325d435070b07 +config_hash: 0388cd86c33cbbc99abfb19c4abb324f From 13ffe4e3d4d9c4f4417ede91e36862be649ddbd2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 30 Aug 2025 13:17:35 +0000 Subject: [PATCH 075/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 57157abd..9af54678 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-81851750ac0e826623eae52a2361a85e97d1dc39cfcd47adea4b392440c897f1.yml openapi_spec_hash: b36ee8d65b9b270168076c8d36420dc1 -config_hash: 0388cd86c33cbbc99abfb19c4abb324f +config_hash: 1335a5f946838eb26cf469ddf59cd223 From 3ed62b4a3195449d4b71101e2a893ce246114c0f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 30 Aug 2025 13:21:56 +0000 Subject: [PATCH 076/178] feat(api): manual updates --- .stats.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 9af54678..fa65ec98 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-81851750ac0e826623eae52a2361a85e97d1dc39cfcd47adea4b392440c897f1.yml openapi_spec_hash: b36ee8d65b9b270168076c8d36420dc1 -config_hash: 1335a5f946838eb26cf469ddf59cd223 +config_hash: 249ee22f294858ab0971b8379f7cb519 diff --git a/README.md b/README.md index 6462d0fe..44761974 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ It is generated with [Stainless](https://www.stainless.com/). Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/imagekit). -The REST API documentation can be found on [imagekit.io](https://imagekit.io). +The REST API documentation can be found on [imagekit.io](https://imagekit.io/docs). ## Installation From 607b928d65fdc5486de83a38c575e27dfe1fec18 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 31 Aug 2025 08:43:58 +0000 Subject: [PATCH 077/178] feat(api): manual updates --- .stats.yml | 4 +- lib/imagekit.rb | 8 + lib/imagekit/models.rb | 8 + lib/imagekit/models/image_overlay.rb | 24 +- lib/imagekit/models/overlay.rb | 2 + lib/imagekit/models/overlay_position.rb | 16 +- lib/imagekit/models/solid_color_overlay.rb | 24 +- .../solid_color_overlay_transformation.rb | 87 +- lib/imagekit/models/src_options.rb | 9 +- lib/imagekit/models/streaming_resolution.rb | 3 +- lib/imagekit/models/subtitle_overlay.rb | 24 +- .../models/subtitle_overlay_transformation.rb | 87 +- lib/imagekit/models/text_overlay.rb | 24 +- .../models/text_overlay_transformation.rb | 67 +- lib/imagekit/models/transformation.rb | 429 ++++----- .../models/transformation_position.rb | 3 +- .../models/unsafe_unwrap_webhook_event.rb | 20 +- lib/imagekit/models/unwrap_webhook_event.rb | 20 +- ...load_post_transform_error_webhook_event.rb | 190 ++++ ...ad_post_transform_success_webhook_event.rb | 154 ++++ ...pload_pre_transform_error_webhook_event.rb | 118 +++ ...oad_pre_transform_success_webhook_event.rb | 448 ++++++++++ lib/imagekit/models/video_overlay.rb | 22 +- .../video_transformation_accepted_event.rb | 99 ++- .../video_transformation_error_event.rb | 118 ++- .../video_transformation_ready_event.rb | 142 ++- lib/imagekit/resources/webhooks.rb | 4 +- rbi/imagekit/models.rbi | 12 + rbi/imagekit/models/image_overlay.rbi | 38 +- rbi/imagekit/models/overlay.rbi | 2 + rbi/imagekit/models/overlay_position.rbi | 24 +- rbi/imagekit/models/solid_color_overlay.rbi | 41 +- .../solid_color_overlay_transformation.rbi | 172 ++-- rbi/imagekit/models/src_options.rbi | 15 +- rbi/imagekit/models/streaming_resolution.rbi | 3 +- rbi/imagekit/models/subtitle_overlay.rbi | 37 +- .../subtitle_overlay_transformation.rbi | 121 ++- rbi/imagekit/models/text_overlay.rbi | 34 +- .../models/text_overlay_transformation.rbi | 144 +-- rbi/imagekit/models/transformation.rbi | 653 +++++++------- .../models/transformation_position.rbi | 3 +- .../models/unsafe_unwrap_webhook_event.rbi | 9 +- rbi/imagekit/models/unwrap_webhook_event.rbi | 9 +- ...oad_post_transform_error_webhook_event.rbi | 444 ++++++++++ ...d_post_transform_success_webhook_event.rbi | 337 +++++++ ...load_pre_transform_error_webhook_event.rbi | 254 ++++++ ...ad_pre_transform_success_webhook_event.rbi | 820 ++++++++++++++++++ rbi/imagekit/models/video_overlay.rbi | 34 +- .../video_transformation_accepted_event.rbi | 79 +- .../video_transformation_error_event.rbi | 100 ++- .../video_transformation_ready_event.rbi | 119 ++- rbi/imagekit/resources/webhooks.rbi | 12 +- sig/imagekit/models.rbs | 8 + sig/imagekit/models/image_overlay.rbs | 24 +- sig/imagekit/models/solid_color_overlay.rbs | 24 +- .../solid_color_overlay_transformation.rbs | 4 - sig/imagekit/models/subtitle_overlay.rbs | 24 +- .../subtitle_overlay_transformation.rbs | 20 +- sig/imagekit/models/text_overlay.rbs | 24 +- .../models/text_overlay_transformation.rbs | 26 +- sig/imagekit/models/transformation.rbs | 21 +- .../models/unsafe_unwrap_webhook_event.rbs | 4 + sig/imagekit/models/unwrap_webhook_event.rbs | 4 + ...oad_post_transform_error_webhook_event.rbs | 183 ++++ ...d_post_transform_success_webhook_event.rbs | 133 +++ ...load_pre_transform_error_webhook_event.rbs | 106 +++ ...ad_pre_transform_success_webhook_event.rbs | 345 ++++++++ sig/imagekit/models/video_overlay.rbs | 24 +- sig/imagekit/resources/webhooks.rbs | 12 +- 69 files changed, 5285 insertions(+), 1371 deletions(-) create mode 100644 lib/imagekit/models/upload_post_transform_error_webhook_event.rb create mode 100644 lib/imagekit/models/upload_post_transform_success_webhook_event.rb create mode 100644 lib/imagekit/models/upload_pre_transform_error_webhook_event.rb create mode 100644 lib/imagekit/models/upload_pre_transform_success_webhook_event.rb create mode 100644 rbi/imagekit/models/upload_post_transform_error_webhook_event.rbi create mode 100644 rbi/imagekit/models/upload_post_transform_success_webhook_event.rbi create mode 100644 rbi/imagekit/models/upload_pre_transform_error_webhook_event.rbi create mode 100644 rbi/imagekit/models/upload_pre_transform_success_webhook_event.rbi create mode 100644 sig/imagekit/models/upload_post_transform_error_webhook_event.rbs create mode 100644 sig/imagekit/models/upload_post_transform_success_webhook_event.rbs create mode 100644 sig/imagekit/models/upload_pre_transform_error_webhook_event.rbs create mode 100644 sig/imagekit/models/upload_pre_transform_success_webhook_event.rbs diff --git a/.stats.yml b/.stats.yml index fa65ec98..caed6f5a 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-81851750ac0e826623eae52a2361a85e97d1dc39cfcd47adea4b392440c897f1.yml -openapi_spec_hash: b36ee8d65b9b270168076c8d36420dc1 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0cdbdd05084a8219bc003a34670472f198cf91e5f6402cede2cb1094b7bfd98d.yml +openapi_spec_hash: d337c89146f41fa215560bb5aef2e4ec config_hash: 249ee22f294858ab0971b8379f7cb519 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index 5032755e..fd31caf3 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -143,6 +143,14 @@ require_relative "imagekit/models/transformation_position" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" +require_relative "imagekit/models/upload_post_transform_error_webhook_event" +require_relative "imagekit/models/upload_post_transform_error_webhook_event" +require_relative "imagekit/models/upload_post_transform_success_webhook_event" +require_relative "imagekit/models/upload_post_transform_success_webhook_event" +require_relative "imagekit/models/upload_pre_transform_error_webhook_event" +require_relative "imagekit/models/upload_pre_transform_error_webhook_event" +require_relative "imagekit/models/upload_pre_transform_success_webhook_event" +require_relative "imagekit/models/upload_pre_transform_success_webhook_event" require_relative "imagekit/models/video_overlay" require_relative "imagekit/models/video_transformation_accepted_event" require_relative "imagekit/models/video_transformation_error_event" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 8d5fbec2..120f805f 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -125,6 +125,14 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + UploadPostTransformErrorWebhookEvent = Imagekit::Models::UploadPostTransformErrorWebhookEvent + + UploadPostTransformSuccessWebhookEvent = Imagekit::Models::UploadPostTransformSuccessWebhookEvent + + UploadPreTransformErrorWebhookEvent = Imagekit::Models::UploadPreTransformErrorWebhookEvent + + UploadPreTransformSuccessWebhookEvent = Imagekit::Models::UploadPreTransformSuccessWebhookEvent + VideoOverlay = Imagekit::Models::VideoOverlay VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent diff --git a/lib/imagekit/models/image_overlay.rb b/lib/imagekit/models/image_overlay.rb index b5cda19e..acd5bca8 100644 --- a/lib/imagekit/models/image_overlay.rb +++ b/lib/imagekit/models/image_overlay.rb @@ -11,8 +11,8 @@ class ImageOverlay < Imagekit::Models::BaseOverlay # @!attribute type # - # @return [Symbol, Imagekit::Models::ImageOverlay::Type] - required :type, enum: -> { Imagekit::ImageOverlay::Type } + # @return [Symbol, :image] + required :type, const: :image # @!attribute encoding # The input path can be included in the layer as either `i-{input}` or @@ -26,31 +26,25 @@ class ImageOverlay < Imagekit::Models::BaseOverlay # @!attribute transformation # Array of transformations to be applied to the overlay image. Supported - # transformations depends on the base/parent asset. + # 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). # # @return [Array, nil] optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } - # @!method initialize(input:, type:, encoding: nil, transformation: nil) + # @!method initialize(input:, encoding: nil, transformation: nil, type: :image) # Some parameter documentations has been truncated, see # {Imagekit::Models::ImageOverlay} for more details. # # @param input [String] Specifies the relative path to the image used as an overlay. # - # @param type [Symbol, Imagekit::Models::ImageOverlay::Type] - # # @param encoding [Symbol, Imagekit::Models::ImageOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 # # @param transformation [Array] Array of transformations to be applied to the overlay image. Supported transform - - module Type - extend Imagekit::Internal::Type::Enum - - IMAGE = :image - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :image] # 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 diff --git a/lib/imagekit/models/overlay.rb b/lib/imagekit/models/overlay.rb index 5bef33d3..3c1873ca 100644 --- a/lib/imagekit/models/overlay.rb +++ b/lib/imagekit/models/overlay.rb @@ -4,6 +4,8 @@ module Imagekit module Models # 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). module Overlay extend Imagekit::Internal::Type::Union diff --git a/lib/imagekit/models/overlay_position.rb b/lib/imagekit/models/overlay_position.rb index 77fac8ab..1613fe15 100644 --- a/lib/imagekit/models/overlay_position.rb +++ b/lib/imagekit/models/overlay_position.rb @@ -13,7 +13,9 @@ class OverlayPosition < Imagekit::Internal::Type::BaseModel # @!attribute x # 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. + # 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). # # @return [Float, String, nil] optional :x, union: -> { Imagekit::OverlayPosition::X } @@ -21,7 +23,9 @@ class OverlayPosition < Imagekit::Internal::Type::BaseModel # @!attribute y_ # 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. + # 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). # # @return [Float, String, nil] optional :y_, union: -> { Imagekit::OverlayPosition::Y }, api_name: :y @@ -59,7 +63,9 @@ module 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. + # 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). # # @see Imagekit::Models::OverlayPosition#x module X @@ -75,7 +81,9 @@ module 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. + # 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). # # @see Imagekit::Models::OverlayPosition#y_ module Y diff --git a/lib/imagekit/models/solid_color_overlay.rb b/lib/imagekit/models/solid_color_overlay.rb index 38bf49e8..e9851237 100644 --- a/lib/imagekit/models/solid_color_overlay.rb +++ b/lib/imagekit/models/solid_color_overlay.rb @@ -14,35 +14,29 @@ class SolidColorOverlay < Imagekit::Models::BaseOverlay # @!attribute type # - # @return [Symbol, Imagekit::Models::SolidColorOverlay::Type] - required :type, enum: -> { Imagekit::SolidColorOverlay::Type } + # @return [Symbol, :solidColor] + required :type, const: :solidColor # @!attribute transformation # Control width and height of the solid color overlay. Supported transformations - # depend on the base/parent asset. + # 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). # # @return [Array, nil] optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::SolidColorOverlayTransformation] } - # @!method initialize(color:, type:, transformation: nil) + # @!method initialize(color:, transformation: nil, type: :solidColor) # Some parameter documentations has been truncated, see # {Imagekit::Models::SolidColorOverlay} for more details. # # @param color [String] Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA # - # @param type [Symbol, Imagekit::Models::SolidColorOverlay::Type] - # # @param transformation [Array] Control width and height of the solid color overlay. Supported transformations d - - module Type - extend Imagekit::Internal::Type::Enum - - SOLID_COLOR = :solidColor - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :solidColor] end end end diff --git a/lib/imagekit/models/solid_color_overlay_transformation.rb b/lib/imagekit/models/solid_color_overlay_transformation.rb index 05e0959c..dacca6bb 100644 --- a/lib/imagekit/models/solid_color_overlay_transformation.rb +++ b/lib/imagekit/models/solid_color_overlay_transformation.rb @@ -4,79 +4,88 @@ module Imagekit module Models class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel # @!attribute alpha - # Alpha transparency level + # Specifies the transparency level of the solid color overlay. Accepts integers + # from `1` to `9`. # # @return [Float, nil] optional :alpha, Float # @!attribute background - # Background color + # 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. # # @return [String, nil] optional :background, String # @!attribute gradient - # Gradient effect for the overlay + # 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). # - # @return [Boolean, String, Imagekit::Models::SolidColorOverlayTransformation::Gradient, nil] + # @return [Boolean, true, String, nil] optional :gradient, union: -> { Imagekit::SolidColorOverlayTransformation::Gradient } # @!attribute height - # Height of the solid color overlay + # 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). # # @return [Float, String, nil] optional :height, union: -> { Imagekit::SolidColorOverlayTransformation::Height } # @!attribute radius - # Corner radius of the solid color overlay + # 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). # - # @return [Float, Symbol, Imagekit::Models::SolidColorOverlayTransformation::Radius, nil] + # @return [Float, Symbol, :max, nil] optional :radius, union: -> { Imagekit::SolidColorOverlayTransformation::Radius } # @!attribute width - # Width of the solid color overlay + # 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). # # @return [Float, String, nil] optional :width, union: -> { Imagekit::SolidColorOverlayTransformation::Width } # @!method initialize(alpha: nil, background: nil, gradient: nil, height: nil, radius: nil, width: nil) - # @param alpha [Float] Alpha transparency level + # Some parameter documentations has been truncated, see + # {Imagekit::Models::SolidColorOverlayTransformation} for more details. # - # @param background [String] Background color + # @param alpha [Float] Specifies the transparency level of the solid color overlay. Accepts integers fr # - # @param gradient [Boolean, String, Imagekit::Models::SolidColorOverlayTransformation::Gradient] Gradient effect for the overlay + # @param background [String] Specifies the background color of the solid color overlay. Accepts an RGB hex co # - # @param height [Float, String] Height of the solid color overlay + # @param gradient [Boolean, true, String] Creates a linear gradient with two colors. Pass `true` for a default gradient, o # - # @param radius [Float, Symbol, Imagekit::Models::SolidColorOverlayTransformation::Radius] Corner radius of the solid color overlay + # @param height [Float, String] Controls the height of the solid color overlay. Accepts a numeric value or an ar # - # @param width [Float, String] Width of the solid color overlay + # @param radius [Float, Symbol, :max] Specifies the corner radius of the solid color overlay. Set to `max` for circula + # + # @param width [Float, String] Controls the width of the solid color overlay. Accepts a numeric value or an ari - # Gradient effect for the overlay + # 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). # # @see Imagekit::Models::SolidColorOverlayTransformation#gradient module Gradient extend Imagekit::Internal::Type::Union - variant const: -> { Imagekit::Models::SolidColorOverlayTransformation::Gradient::TRUE } + variant const: true variant String # @!method self.variants - # @return [Array(Boolean, String)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Imagekit::SolidColorOverlayTransformation::Gradient::TaggedBoolean, String) } - end - - # @!group - - TRUE = true - - # @!endgroup + # @return [Array(Boolean, true, String)] end - # Height of the solid color overlay + # 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). # # @see Imagekit::Models::SolidColorOverlayTransformation#height module Height @@ -90,7 +99,9 @@ module Height # @return [Array(Float, String)] end - # Corner radius of the solid color overlay + # 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). # # @see Imagekit::Models::SolidColorOverlayTransformation#radius module Radius @@ -98,23 +109,15 @@ module Radius variant Float - variant const: -> { Imagekit::Models::SolidColorOverlayTransformation::Radius::MAX } + variant const: :max # @!method self.variants - # @return [Array(Float, Symbol)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Float, Imagekit::SolidColorOverlayTransformation::Radius::TaggedSymbol) } - end - - # @!group - - MAX = :max - - # @!endgroup + # @return [Array(Float, Symbol, :max)] end - # Width of the solid color overlay + # 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). # # @see Imagekit::Models::SolidColorOverlayTransformation#width module Width diff --git a/lib/imagekit/models/src_options.rb b/lib/imagekit/models/src_options.rb index 0bb39a4d..e6b2118c 100644 --- a/lib/imagekit/models/src_options.rb +++ b/lib/imagekit/models/src_options.rb @@ -29,7 +29,8 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # @!attribute transformation # 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. + # are specified as chained transformations. See + # [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations). # # @return [Array, nil] optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } @@ -37,7 +38,8 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # @!attribute transformation_position # 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`. + # path of the URL, set this to `path`. Learn more in the + # [Transformations guide](https://imagekit.io/docs/transformations). # # @return [Symbol, Imagekit::Models::TransformationPosition, nil] optional :transformation_position, @@ -48,7 +50,8 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekit::Models::SrcOptions} for more details. # - # Options for generating ImageKit URLs with transformations + # Options for generating ImageKit URLs with transformations. See the + # [Transformations guide](https://imagekit.io/docs/transformations). # # @param src [String] Accepts a relative or absolute path of the resource. If a relative path is provi # diff --git a/lib/imagekit/models/streaming_resolution.rb b/lib/imagekit/models/streaming_resolution.rb index 8ed00e6b..c30c25e1 100644 --- a/lib/imagekit/models/streaming_resolution.rb +++ b/lib/imagekit/models/streaming_resolution.rb @@ -2,7 +2,8 @@ module Imagekit module Models - # Available streaming resolutions for adaptive bitrate streaming + # Available streaming resolutions for + # [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming) module StreamingResolution extend Imagekit::Internal::Type::Enum diff --git a/lib/imagekit/models/subtitle_overlay.rb b/lib/imagekit/models/subtitle_overlay.rb index db5dbc3f..4fc0a96b 100644 --- a/lib/imagekit/models/subtitle_overlay.rb +++ b/lib/imagekit/models/subtitle_overlay.rb @@ -11,8 +11,8 @@ class SubtitleOverlay < Imagekit::Models::BaseOverlay # @!attribute type # - # @return [Symbol, Imagekit::Models::SubtitleOverlay::Type] - required :type, enum: -> { Imagekit::SubtitleOverlay::Type } + # @return [Symbol, :subtitle] + required :type, const: :subtitle # @!attribute encoding # The input path can be included in the layer as either `i-{input}` or @@ -25,32 +25,24 @@ class SubtitleOverlay < Imagekit::Models::BaseOverlay optional :encoding, enum: -> { Imagekit::SubtitleOverlay::Encoding } # @!attribute transformation - # Control styling of the subtitle. + # Control styling of the subtitle. See + # [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer). # # @return [Array, nil] optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::SubtitleOverlayTransformation] } - # @!method initialize(input:, type:, encoding: nil, transformation: nil) + # @!method initialize(input:, encoding: nil, transformation: nil, type: :subtitle) # Some parameter documentations has been truncated, see # {Imagekit::Models::SubtitleOverlay} for more details. # # @param input [String] Specifies the relative path to the subtitle file used as an overlay. # - # @param type [Symbol, Imagekit::Models::SubtitleOverlay::Type] - # # @param encoding [Symbol, Imagekit::Models::SubtitleOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 # - # @param transformation [Array] Control styling of the subtitle. - - module Type - extend Imagekit::Internal::Type::Enum - - SUBTITLE = :subtitle - - # @!method self.values - # @return [Array] - end + # @param transformation [Array] Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/doc + # + # @param type [Symbol, :subtitle] # 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 diff --git a/lib/imagekit/models/subtitle_overlay_transformation.rb b/lib/imagekit/models/subtitle_overlay_transformation.rb index 72715df0..a2586ae2 100644 --- a/lib/imagekit/models/subtitle_overlay_transformation.rb +++ b/lib/imagekit/models/subtitle_overlay_transformation.rb @@ -4,81 +4,98 @@ module Imagekit module Models class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel # @!attribute background - # Background color for subtitles + # 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) # # @return [String, nil] optional :background, String # @!attribute color - # Text color for subtitles + # 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) # # @return [String, nil] optional :color, String # @!attribute font_family - # Font family for subtitles + # Font family for subtitles. Refer to the + # [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list). # # @return [String, nil] optional :font_family, String, api_name: :fontFamily # @!attribute font_outline - # Font outline for subtitles + # 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) # # @return [String, nil] optional :font_outline, String, api_name: :fontOutline # @!attribute font_shadow - # Font shadow for subtitles + # 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) # # @return [String, nil] optional :font_shadow, String, api_name: :fontShadow # @!attribute font_size - # Font size for subtitles - # - # @return [Float, String, nil] - optional :font_size, - union: -> { - Imagekit::SubtitleOverlayTransformation::FontSize - }, - api_name: :fontSize + # Sets the font size of subtitle text. + # + # [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + # + # @return [Float, nil] + optional :font_size, Float, api_name: :fontSize # @!attribute typography - # Typography style for subtitles + # 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) # # @return [Symbol, Imagekit::Models::SubtitleOverlayTransformation::Typography, nil] optional :typography, enum: -> { Imagekit::SubtitleOverlayTransformation::Typography } # @!method initialize(background: nil, color: nil, font_family: nil, font_outline: nil, font_shadow: nil, font_size: nil, typography: nil) - # @param background [String] Background color for subtitles + # Some parameter documentations has been truncated, see + # {Imagekit::Models::SubtitleOverlayTransformation} for more details. # - # @param color [String] Text color for subtitles + # Subtitle styling options. + # [Learn more](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + # from the docs. # - # @param font_family [String] Font family for subtitles + # @param background [String] Specifies the subtitle background color using a standard color name, an RGB colo # - # @param font_outline [String] Font outline for subtitles + # @param color [String] Sets the font color of the subtitle text using a standard color name, an RGB col # - # @param font_shadow [String] Font shadow for subtitles + # @param font_family [String] Font family for subtitles. Refer to the [supported fonts](https://imagekit.io/do # - # @param font_size [Float, String] Font size for subtitles + # @param font_outline [String] Sets the font outline of the subtitle text. # - # @param typography [Symbol, Imagekit::Models::SubtitleOverlayTransformation::Typography] Typography style for subtitles - - # Font size for subtitles + # @param font_shadow [String] Sets the font shadow for the subtitle text. # - # @see Imagekit::Models::SubtitleOverlayTransformation#font_size - module FontSize - extend Imagekit::Internal::Type::Union - - variant Float - - variant String - - # @!method self.variants - # @return [Array(Float, String)] - end + # @param font_size [Float] Sets the font size of subtitle text. + # + # @param typography [Symbol, Imagekit::Models::SubtitleOverlayTransformation::Typography] Sets the typography style of the subtitle text. Supports values are `b` for bold - # Typography style for subtitles + # 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) # # @see Imagekit::Models::SubtitleOverlayTransformation#typography module Typography diff --git a/lib/imagekit/models/text_overlay.rb b/lib/imagekit/models/text_overlay.rb index 6a4d81d3..523cf4ff 100644 --- a/lib/imagekit/models/text_overlay.rb +++ b/lib/imagekit/models/text_overlay.rb @@ -12,8 +12,8 @@ class TextOverlay < Imagekit::Models::BaseOverlay # @!attribute type # - # @return [Symbol, Imagekit::Models::TextOverlay::Type] - required :type, enum: -> { Imagekit::TextOverlay::Type } + # @return [Symbol, :text] + required :type, const: :text # @!attribute encoding # Text can be included in the layer as either `i-{input}` (plain text) or @@ -26,31 +26,23 @@ class TextOverlay < Imagekit::Models::BaseOverlay optional :encoding, enum: -> { Imagekit::TextOverlay::Encoding } # @!attribute transformation - # Control styling of the text overlay. + # Control styling of the text overlay. See + # [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay). # # @return [Array, nil] optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::TextOverlayTransformation] } - # @!method initialize(text:, type:, encoding: nil, transformation: nil) + # @!method initialize(text:, encoding: nil, transformation: nil, type: :text) # Some parameter documentations has been truncated, see # {Imagekit::Models::TextOverlay} for more details. # # @param text [String] Specifies the text to be displayed in the overlay. The SDK automatically handles # - # @param type [Symbol, Imagekit::Models::TextOverlay::Type] - # # @param encoding [Symbol, Imagekit::Models::TextOverlay::Encoding] Text can be included in the layer as either `i-{input}` (plain text) or `ie-{bas # - # @param transformation [Array] Control styling of the text overlay. - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT = :text - - # @!method self.values - # @return [Array] - end + # @param transformation [Array] Control styling of the text overlay. See [Text overlays](https://imagekit.io/doc + # + # @param type [Symbol, :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 diff --git a/lib/imagekit/models/text_overlay_transformation.rb b/lib/imagekit/models/text_overlay_transformation.rb index 1d95eb17..710ad972 100644 --- a/lib/imagekit/models/text_overlay_transformation.rb +++ b/lib/imagekit/models/text_overlay_transformation.rb @@ -32,7 +32,10 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # @!attribute font_family # Specifies the font family of the overlaid text. Choose from the supported fonts - # list or use a custom font. + # 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). # # @return [String, nil] optional :font_family, String, api_name: :fontFamily @@ -54,7 +57,10 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel api_name: :innerAlignment # @!attribute line_height - # Specifies the line height of the text overlay. + # 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`. # # @return [Float, String, nil] optional :line_height, @@ -73,7 +79,7 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # Specifies the corner radius of the text overlay. Set to `max` to achieve a # circular or oval shape. # - # @return [Float, Symbol, Imagekit::Models::TextOverlayTransformation::Radius, nil] + # @return [Float, Symbol, :max, nil] optional :radius, union: -> { Imagekit::TextOverlayTransformation::Radius } # @!attribute rotation @@ -84,16 +90,20 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel optional :rotation, union: -> { Imagekit::TextOverlayTransformation::Rotation } # @!attribute typography - # Specifies the typography style of the text. Supported values: `b` for bold, `i` - # for italics, and `b_i` for bold with italics. + # Specifies the typography style of the text. Supported values: # - # @return [Symbol, Imagekit::Models::TextOverlayTransformation::Typography, nil] - optional :typography, enum: -> { Imagekit::TextOverlayTransformation::Typography } + # - Single styles: `b` (bold), `i` (italic), `strikethrough`. + # - Combinations: Any combination separated by underscores, e.g., `b_i`, + # `b_i_strikethrough`. + # + # @return [String, nil] + optional :typography, String # @!attribute width # 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`. + # supported. Useful when used in conjunction with the `background`. Learn about + # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # # @return [Float, String, nil] optional :width, union: -> { Imagekit::TextOverlayTransformation::Width } @@ -120,11 +130,11 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # # @param padding [Float, String] Specifies the padding around the overlaid text. # - # @param radius [Float, Symbol, Imagekit::Models::TextOverlayTransformation::Radius] Specifies the corner radius of the text overlay. + # @param radius [Float, Symbol, :max] Specifies the corner radius of the text overlay. # # @param rotation [Float, String] Specifies the rotation angle of the text overlay. # - # @param typography [Symbol, Imagekit::Models::TextOverlayTransformation::Typography] Specifies the typography style of the text. + # @param typography [String] Specifies the typography style of the text. # # @param width [Float, String] Specifies the maximum width (in pixels) of the overlaid text. The text wraps aut @@ -173,7 +183,10 @@ module InnerAlignment # @return [Array] end - # Specifies the line height of the text overlay. + # 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`. # # @see Imagekit::Models::TextOverlayTransformation#line_height module LineHeight @@ -212,20 +225,10 @@ module Radius variant Float - variant const: -> { Imagekit::Models::TextOverlayTransformation::Radius::MAX } + variant const: :max # @!method self.variants - # @return [Array(Float, Symbol)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Float, Imagekit::TextOverlayTransformation::Radius::TaggedSymbol) } - end - - # @!group - - MAX = :max - - # @!endgroup + # @return [Array(Float, Symbol, :max)] end # Specifies the rotation angle of the text overlay. Accepts a numeric value for @@ -243,24 +246,10 @@ module Rotation # @return [Array(Float, String)] end - # Specifies the typography style of the text. Supported values: `b` for bold, `i` - # for italics, and `b_i` for bold with italics. - # - # @see Imagekit::Models::TextOverlayTransformation#typography - module Typography - extend Imagekit::Internal::Type::Enum - - B = :b - I = :i - B_I = :b_i - - # @!method self.values - # @return [Array] - end - # 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`. + # supported. Useful when used in conjunction with the `background`. Learn about + # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # # @see Imagekit::Models::TextOverlayTransformation#width module Width diff --git a/lib/imagekit/models/transformation.rb b/lib/imagekit/models/transformation.rb index c21109fd..cd72bdb1 100644 --- a/lib/imagekit/models/transformation.rb +++ b/lib/imagekit/models/transformation.rb @@ -6,7 +6,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute ai_change_background # 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. + # Not supported inside overlay. See + # [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg). # # @return [String, nil] optional :ai_change_background, String, api_name: :aiChangeBackground @@ -16,13 +17,24 @@ class Transformation < Imagekit::Internal::Type::BaseModel # 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. + # inside overlay. See + # [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). # - # @return [Boolean, String, Imagekit::Models::Transformation::AIDropShadow, nil] + # @return [Boolean, true, String, nil] optional :ai_drop_shadow, union: -> { Imagekit::Transformation::AIDropShadow }, api_name: :aiDropShadow + # @!attribute ai_edit + # 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). + # + # @return [String, nil] + optional :ai_edit, String, api_name: :aiEdit + # @!attribute ai_remove_background - # Applies ImageKit's in-house background removal. Supported inside overlay. + # 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). # # @return [Boolean, Imagekit::Models::Transformation::AIRemoveBackground, nil] optional :ai_remove_background, @@ -32,7 +44,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute ai_remove_background_external # 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. + # Supported inside overlay. See + # [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). # # @return [Boolean, Imagekit::Models::Transformation::AIRemoveBackgroundExternal, nil] optional :ai_remove_background_external, @@ -41,14 +54,16 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute ai_retouch # Performs AI-based retouching to improve faces or product shots. Not supported - # inside overlay. + # inside overlay. See + # [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). # # @return [Boolean, Imagekit::Models::Transformation::AIRetouch, nil] optional :ai_retouch, enum: -> { Imagekit::Transformation::AIRetouch }, api_name: :aiRetouch # @!attribute ai_upscale # Upscales images beyond their original dimensions using AI. Not supported inside - # overlay. + # overlay. See + # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). # # @return [Boolean, Imagekit::Models::Transformation::AIUpscale, nil] optional :ai_upscale, enum: -> { Imagekit::Transformation::AIUpscale }, api_name: :aiUpscale @@ -57,7 +72,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # 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. + # original image. Not supported inside overlay. See + # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). # # @return [Boolean, Imagekit::Models::Transformation::AIVariation, nil] optional :ai_variation, enum: -> { Imagekit::Transformation::AIVariation }, api_name: :aiVariation @@ -65,13 +81,15 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute aspect_ratio # 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`. + # 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). # # @return [Float, String, nil] optional :aspect_ratio, union: -> { Imagekit::Transformation::AspectRatio }, api_name: :aspectRatio # @!attribute audio_codec - # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See + # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). # # @return [Symbol, Imagekit::Models::Transformation::AudioCodec, nil] optional :audio_codec, enum: -> { Imagekit::Transformation::AudioCodec }, api_name: :audioCodec @@ -80,19 +98,23 @@ class Transformation < Imagekit::Internal::Type::BaseModel # Specifies the background to be used in conjunction with certain cropping # strategies when resizing an image. # - # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. - # - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. + # - 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}]`. + # `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See + # [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill). # # @return [String, nil] optional :background, String # @!attribute blur # Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, - # or an expression like `bl-10`. + # or an expression like `bl-10`. See + # [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl). # # @return [Float, nil] optional :blur, Float @@ -100,19 +122,22 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute border # 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`. + # expression like `ih_div_20_FF00FF`. See + # [Border](https://imagekit.io/docs/effects-and-enhancements#border---b). # # @return [String, nil] optional :border, String # @!attribute color_profile - # Indicates whether the output image should retain the original color profile. + # Indicates whether the output image should retain the original color profile. See + # [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp). # # @return [Boolean, nil] optional :color_profile, Imagekit::Internal::Type::Boolean, api_name: :colorProfile # @!attribute contrast_stretch - # Automatically enhances the contrast of an image (contrast stretch). + # Automatically enhances the contrast of an image (contrast stretch). See + # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). # # @return [Boolean, Imagekit::Models::Transformation::ContrastStretch, nil] optional :contrast_stretch, @@ -120,27 +145,31 @@ class Transformation < Imagekit::Internal::Type::BaseModel api_name: :contrastStretch # @!attribute crop - # Crop modes for image resizing + # Crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). # # @return [Symbol, Imagekit::Models::Transformation::Crop, nil] optional :crop, enum: -> { Imagekit::Transformation::Crop } # @!attribute crop_mode - # Additional crop modes for image resizing + # Additional crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). # # @return [Symbol, Imagekit::Models::Transformation::CropMode, nil] optional :crop_mode, enum: -> { Imagekit::Transformation::CropMode }, api_name: :cropMode # @!attribute default_image # Specifies a fallback image if the resource is not found, e.g., a URL or file - # path. + # path. See + # [Default image](https://imagekit.io/docs/image-transformation#default-image---di). # # @return [String, nil] optional :default_image, String, api_name: :defaultImage # @!attribute dpr # Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio - # (DPR) calculation. + # (DPR) calculation. See + # [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr). # # @return [Float, nil] optional :dpr, Float @@ -148,7 +177,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute duration # 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. + # Arithmetic expressions are supported. See + # [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). # # @return [Float, String, nil] optional :duration, union: -> { Imagekit::Transformation::Duration } @@ -156,7 +186,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute end_offset # 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. + # are supported. See + # [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). # # @return [Float, String, nil] optional :end_offset, union: -> { Imagekit::Transformation::EndOffset }, api_name: :endOffset @@ -164,14 +195,20 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute flip # Flips or mirrors an image either horizontally, vertically, or both. Acceptable # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or - # `v_h`. + # `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). # # @return [Symbol, Imagekit::Models::Transformation::Flip, nil] optional :flip, enum: -> { Imagekit::Transformation::Flip } # @!attribute focus - # This parameter can be used with pad resize, maintain ratio, or extract crop to - # modify the padding or cropping behavior. + # 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) # # @return [String, nil] optional :focus, String @@ -181,20 +218,24 @@ class Transformation < Imagekit::Internal::Type::BaseModel # `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. + # format parameter. See + # [Image format](https://imagekit.io/docs/image-optimization#format---f) and + # [Video format](https://imagekit.io/docs/video-optimization#format---f). # # @return [Symbol, Imagekit::Models::Transformation::Format, nil] optional :format_, enum: -> { Imagekit::Transformation::Format }, api_name: :format # @!attribute gradient # Creates a linear gradient with two colors. Pass `true` for a default gradient, - # or provide a string for a custom gradient. + # or provide a string for a custom gradient. See + # [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). # - # @return [Boolean, String, Imagekit::Models::Transformation::Gradient, nil] + # @return [Boolean, true, String, nil] optional :gradient, union: -> { Imagekit::Transformation::Gradient } # @!attribute grayscale - # Enables a grayscale effect for images. + # Enables a grayscale effect for images. See + # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). # # @return [Boolean, Imagekit::Models::Transformation::Grayscale, nil] optional :grayscale, enum: -> { Imagekit::Transformation::Grayscale } @@ -202,39 +243,48 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute height # 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`). + # 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) # # @return [Float, String, nil] optional :height, union: -> { Imagekit::Transformation::Height } # @!attribute lossless # Specifies whether the output image (in JPEG or PNG) should be compressed - # losslessly. + # losslessly. See + # [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo). # # @return [Boolean, nil] optional :lossless, Imagekit::Internal::Type::Boolean # @!attribute metadata # By default, ImageKit removes all metadata during automatic image compression. - # Set this to true to preserve metadata. + # Set this to true to preserve metadata. See + # [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md). # # @return [Boolean, nil] optional :metadata, Imagekit::Internal::Type::Boolean # @!attribute named - # Named transformation reference + # Named transformation reference. See + # [Named transformations](https://imagekit.io/docs/transformations#named-transformations). # # @return [String, nil] optional :named, String # @!attribute opacity - # Specifies the opacity level of the output image. + # Specifies the opacity level of the output image. See + # [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o). # # @return [Float, nil] optional :opacity, Float # @!attribute original # 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). # # @return [Boolean, nil] optional :original, Imagekit::Internal::Type::Boolean @@ -242,6 +292,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute overlay # 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). # # @return [Imagekit::Models::Overlay, nil] optional :overlay, union: -> { Imagekit::Overlay } @@ -249,7 +301,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute page # 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). + # 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). # # @return [Float, String, nil] optional :page, union: -> { Imagekit::Transformation::Page } @@ -257,7 +310,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute progressive # 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. + # image, which gradually improves to provide a faster perceived load time. See + # [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr). # # @return [Boolean, nil] optional :progressive, Imagekit::Internal::Type::Boolean @@ -266,15 +320,17 @@ class Transformation < Imagekit::Internal::Type::BaseModel # 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). # # @return [Float, nil] optional :quality, Float # @!attribute radius - # Specifies the corner radius for rounded corners (e.g., 20) or `max` for - # circular/oval shapes. + # 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). # - # @return [Float, Symbol, Imagekit::Models::Transformation::Radius, nil] + # @return [Float, Symbol, :max, nil] optional :radius, union: -> { Imagekit::Transformation::Radius } # @!attribute raw @@ -288,7 +344,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # 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. + # only the following values are supported: 0, 90, 180, 270, or 360. See + # [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). # # @return [Float, String, nil] optional :rotation, union: -> { Imagekit::Transformation::Rotation } @@ -296,28 +353,32 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute shadow # 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. + # shadow, or provide a string for a custom shadow. See + # [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). # - # @return [Boolean, String, Imagekit::Models::Transformation::Shadow, nil] + # @return [Boolean, true, String, nil] optional :shadow, union: -> { Imagekit::Transformation::Shadow } # @!attribute sharpen # Sharpens the input image, highlighting edges and finer details. Pass `true` for - # default sharpening, or provide a numeric value for custom sharpening. + # default sharpening, or provide a numeric value for custom sharpening. See + # [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). # - # @return [Boolean, Float, Imagekit::Models::Transformation::Sharpen, nil] + # @return [Boolean, true, Float, nil] optional :sharpen, union: -> { Imagekit::Transformation::Sharpen } # @!attribute start_offset # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or - # `10.5`. Arithmetic expressions are also supported. + # `10.5`. Arithmetic expressions are also supported. See + # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). # # @return [Float, String, nil] optional :start_offset, union: -> { Imagekit::Transformation::StartOffset }, api_name: :startOffset # @!attribute streaming_resolutions # An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, - # `480`, `720`, `1080`]. + # `480`, `720`, `1080`]. See + # [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). # # @return [Array, nil] optional :streaming_resolutions, @@ -327,20 +388,23 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute trim # 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. + # output image. See + # [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). # - # @return [Boolean, Float, Imagekit::Models::Transformation::Trim, nil] + # @return [Boolean, true, Float, nil] optional :trim, union: -> { Imagekit::Transformation::Trim } # @!attribute unsharp_mask # Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a - # default unsharp mask, or provide a string for a custom unsharp mask. + # 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). # - # @return [Boolean, String, Imagekit::Models::Transformation::UnsharpMask, nil] + # @return [Boolean, true, String, nil] optional :unsharp_mask, union: -> { Imagekit::Transformation::UnsharpMask }, api_name: :unsharpMask # @!attribute video_codec - # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See + # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). # # @return [Symbol, Imagekit::Models::Transformation::VideoCodec, nil] optional :video_codec, enum: -> { Imagekit::Transformation::VideoCodec }, api_name: :videoCodec @@ -348,31 +412,37 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute width # 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`). + # 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) # # @return [Float, String, nil] optional :width, union: -> { Imagekit::Transformation::Width } # @!attribute x - # Focus using cropped image coordinates - X coordinate + # 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). # # @return [Float, String, nil] optional :x, union: -> { Imagekit::Transformation::X } # @!attribute x_center - # Focus using cropped image coordinates - X center coordinate + # 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). # # @return [Float, String, nil] optional :x_center, union: -> { Imagekit::Transformation::XCenter }, api_name: :xCenter # @!attribute y_ - # Focus using cropped image coordinates - Y coordinate + # 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). # # @return [Float, String, nil] optional :y_, union: -> { Imagekit::Transformation::Y }, api_name: :y # @!attribute y_center - # Focus using cropped image coordinates - Y center coordinate + # 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). # # @return [Float, String, nil] optional :y_center, union: -> { Imagekit::Transformation::YCenter }, api_name: :yCenter @@ -380,11 +450,12 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute zoom # 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). # # @return [Float, nil] optional :zoom, Float - # @!method initialize(ai_change_background: nil, ai_drop_shadow: nil, ai_remove_background: nil, ai_remove_background_external: nil, ai_retouch: nil, ai_upscale: nil, ai_variation: nil, aspect_ratio: nil, audio_codec: nil, background: nil, blur: nil, border: nil, color_profile: nil, contrast_stretch: nil, crop: nil, crop_mode: nil, default_image: nil, dpr: nil, duration: nil, end_offset: nil, flip: nil, focus: nil, format_: nil, gradient: nil, grayscale: nil, height: nil, lossless: nil, metadata: nil, named: nil, opacity: nil, original: nil, overlay: nil, page: nil, progressive: nil, quality: nil, radius: nil, raw: nil, rotation: nil, shadow: nil, sharpen: nil, start_offset: nil, streaming_resolutions: nil, trim: nil, unsharp_mask: nil, video_codec: nil, width: nil, x: nil, x_center: nil, y_: nil, y_center: nil, zoom: nil) + # @!method initialize(ai_change_background: nil, ai_drop_shadow: nil, ai_edit: nil, ai_remove_background: nil, ai_remove_background_external: nil, ai_retouch: nil, ai_upscale: nil, ai_variation: nil, aspect_ratio: nil, audio_codec: nil, background: nil, blur: nil, border: nil, color_profile: nil, contrast_stretch: nil, crop: nil, crop_mode: nil, default_image: nil, dpr: nil, duration: nil, end_offset: nil, flip: nil, focus: nil, format_: nil, gradient: nil, grayscale: nil, height: nil, lossless: nil, metadata: nil, named: nil, opacity: nil, original: nil, overlay: nil, page: nil, progressive: nil, quality: nil, radius: nil, raw: nil, rotation: nil, shadow: nil, sharpen: nil, start_offset: nil, streaming_resolutions: nil, trim: nil, unsharp_mask: nil, video_codec: nil, width: nil, x: nil, x_center: nil, y_: nil, y_center: nil, zoom: nil) # Some parameter documentations has been truncated, see # {Imagekit::Models::Transformation} for more details. # @@ -392,11 +463,14 @@ class Transformation < Imagekit::Internal::Type::BaseModel # converted to the corresponding transformation string before being added to the # URL. SDKs are updated regularly to support new transformations. If you want to # use a transformation that is not supported by the SDK, You can use the `raw` - # parameter to pass the transformation string directly. + # parameter to pass the transformation string directly. See the + # [Transformations documentation](https://imagekit.io/docs/transformations). # # @param ai_change_background [String] Uses AI to change the background. Provide a text prompt or a base64-encoded prom # - # @param ai_drop_shadow [Boolean, String, Imagekit::Models::Transformation::AIDropShadow] Adds an AI-based drop shadow around a foreground object on a transparent or remo + # @param ai_drop_shadow [Boolean, true, String] Adds an AI-based drop shadow around a foreground object on a transparent or remo + # + # @param ai_edit [String] Uses AI to edit images based on a text prompt. Provide a text prompt or a base64 # # @param ai_remove_background [Boolean, Imagekit::Models::Transformation::AIRemoveBackground] Applies ImageKit's in-house background removal. # @@ -410,7 +484,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param aspect_ratio [Float, String] Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with e # - # @param audio_codec [Symbol, Imagekit::Models::Transformation::AudioCodec] Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # @param audio_codec [Symbol, Imagekit::Models::Transformation::AudioCodec] Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](htt # # @param background [String] Specifies the background to be used in conjunction with certain cropping strateg # @@ -422,9 +496,9 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param contrast_stretch [Boolean, Imagekit::Models::Transformation::ContrastStretch] Automatically enhances the contrast of an image (contrast stretch). # - # @param crop [Symbol, Imagekit::Models::Transformation::Crop] Crop modes for image resizing + # @param crop [Symbol, Imagekit::Models::Transformation::Crop] Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs # - # @param crop_mode [Symbol, Imagekit::Models::Transformation::CropMode] Additional crop modes for image resizing + # @param crop_mode [Symbol, Imagekit::Models::Transformation::CropMode] Additional crop modes for image resizing. See [Crop modes & focus](https://image # # @param default_image [String] Specifies a fallback image if the resource is not found, e.g., a URL or file pat # @@ -436,13 +510,13 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param flip [Symbol, Imagekit::Models::Transformation::Flip] Flips or mirrors an image either horizontally, vertically, or both. # - # @param focus [String] This parameter can be used with pad resize, maintain ratio, or extract crop to m + # @param focus [String] Refines padding and cropping behavior for pad resize, maintain ratio, and extrac # # @param format_ [Symbol, Imagekit::Models::Transformation::Format] Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `m # - # @param gradient [Boolean, String, Imagekit::Models::Transformation::Gradient] Creates a linear gradient with two colors. Pass `true` for a default gradient, o + # @param gradient [Boolean, true, String] Creates a linear gradient with two colors. Pass `true` for a default gradient, o # - # @param grayscale [Boolean, Imagekit::Models::Transformation::Grayscale] Enables a grayscale effect for images. + # @param grayscale [Boolean, Imagekit::Models::Transformation::Grayscale] Enables a grayscale effect for images. See [Grayscale](https://imagekit.io/docs/ # # @param height [Float, String] Specifies the height of the output. If a value between 0 and 1 is provided, it i # @@ -450,9 +524,9 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param metadata [Boolean] By default, ImageKit removes all metadata during automatic image compression. # - # @param named [String] Named transformation reference + # @param named [String] Named transformation reference. See [Named transformations](https://imagekit.io/ # - # @param opacity [Float] Specifies the opacity level of the output image. + # @param opacity [Float] Specifies the opacity level of the output image. See [Opacity](https://imagekit. # # @param original [Boolean] If set to true, serves the original file without applying any transformations. # @@ -464,35 +538,35 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param quality [Float] Specifies the quality of the output image for lossy formats such as JPEG, WebP, # - # @param radius [Float, Symbol, Imagekit::Models::Transformation::Radius] Specifies the corner radius for rounded corners (e.g., 20) or `max` for circular + # @param radius [Float, Symbol, :max] Specifies the corner radius for rounded corners (e.g., 20) or `max` for circular # # @param raw [String] Pass any transformation not directly supported by the SDK. # # @param rotation [Float, String] Specifies the rotation angle in degrees. Positive values rotate the image clockw # - # @param shadow [Boolean, String, Imagekit::Models::Transformation::Shadow] Adds a shadow beneath solid objects in an image with a transparent background. + # @param shadow [Boolean, true, String] Adds a shadow beneath solid objects in an image with a transparent background. # - # @param sharpen [Boolean, Float, Imagekit::Models::Transformation::Sharpen] Sharpens the input image, highlighting edges and finer details. + # @param sharpen [Boolean, true, Float] Sharpens the input image, highlighting edges and finer details. # # @param start_offset [Float, String] Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5` # # @param streaming_resolutions [Array] An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `48 # - # @param trim [Boolean, Float, Imagekit::Models::Transformation::Trim] Useful for images with a solid or nearly solid background and a central object. + # @param trim [Boolean, true, Float] Useful for images with a solid or nearly solid background and a central object. # - # @param unsharp_mask [Boolean, String, Imagekit::Models::Transformation::UnsharpMask] Applies Unsharp Masking (USM), an image sharpening technique. + # @param unsharp_mask [Boolean, true, String] Applies Unsharp Masking (USM), an image sharpening technique. # - # @param video_codec [Symbol, Imagekit::Models::Transformation::VideoCodec] Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # @param video_codec [Symbol, Imagekit::Models::Transformation::VideoCodec] Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video cod # # @param width [Float, String] Specifies the width of the output. If a value between 0 and 1 is provided, it is # - # @param x [Float, String] Focus using cropped image coordinates - X coordinate + # @param x [Float, String] Focus using cropped image coordinates - X coordinate. See [Focus using cropped c # - # @param x_center [Float, String] Focus using cropped image coordinates - X center coordinate + # @param x_center [Float, String] Focus using cropped image coordinates - X center coordinate. See [Focus using cr # - # @param y_ [Float, String] Focus using cropped image coordinates - Y coordinate + # @param y_ [Float, String] Focus using cropped image coordinates - Y coordinate. See [Focus using cropped c # - # @param y_center [Float, String] Focus using cropped image coordinates - Y center coordinate + # @param y_center [Float, String] Focus using cropped image coordinates - Y center coordinate. See [Focus using cr # # @param zoom [Float] Accepts a numeric value that determines how much to zoom in or out of the croppe @@ -500,31 +574,23 @@ class Transformation < Imagekit::Internal::Type::BaseModel # 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. + # inside overlay. See + # [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). # # @see Imagekit::Models::Transformation#ai_drop_shadow module AIDropShadow extend Imagekit::Internal::Type::Union - variant const: -> { Imagekit::Models::Transformation::AIDropShadow::TRUE } + variant const: true variant String # @!method self.variants - # @return [Array(Boolean, String)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Imagekit::Transformation::AIDropShadow::TaggedBoolean, String) } - end - - # @!group - - TRUE = true - - # @!endgroup + # @return [Array(Boolean, true, String)] end - # Applies ImageKit's in-house background removal. Supported inside overlay. + # 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). # # @see Imagekit::Models::Transformation#ai_remove_background module AIRemoveBackground @@ -538,7 +604,8 @@ module 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. + # Supported inside overlay. See + # [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). # # @see Imagekit::Models::Transformation#ai_remove_background_external module AIRemoveBackgroundExternal @@ -551,7 +618,8 @@ module AIRemoveBackgroundExternal end # Performs AI-based retouching to improve faces or product shots. Not supported - # inside overlay. + # inside overlay. See + # [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). # # @see Imagekit::Models::Transformation#ai_retouch module AIRetouch @@ -564,7 +632,8 @@ module AIRetouch end # Upscales images beyond their original dimensions using AI. Not supported inside - # overlay. + # overlay. See + # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). # # @see Imagekit::Models::Transformation#ai_upscale module AIUpscale @@ -579,7 +648,8 @@ module 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. + # original image. Not supported inside overlay. See + # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). # # @see Imagekit::Models::Transformation#ai_variation module AIVariation @@ -593,7 +663,8 @@ module 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`. + # 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). # # @see Imagekit::Models::Transformation#aspect_ratio module AspectRatio @@ -607,7 +678,8 @@ module AspectRatio # @return [Array(Float, String)] end - # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See + # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). # # @see Imagekit::Models::Transformation#audio_codec module AudioCodec @@ -621,7 +693,8 @@ module AudioCodec # @return [Array] end - # Automatically enhances the contrast of an image (contrast stretch). + # Automatically enhances the contrast of an image (contrast stretch). See + # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). # # @see Imagekit::Models::Transformation#contrast_stretch module ContrastStretch @@ -633,7 +706,8 @@ module ContrastStretch # @return [Array] end - # Crop modes for image resizing + # Crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). # # @see Imagekit::Models::Transformation#crop module Crop @@ -649,7 +723,8 @@ module Crop # @return [Array] end - # Additional crop modes for image resizing + # Additional crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). # # @see Imagekit::Models::Transformation#crop_mode module CropMode @@ -665,7 +740,8 @@ module CropMode # 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. + # Arithmetic expressions are supported. See + # [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). # # @see Imagekit::Models::Transformation#duration module Duration @@ -681,7 +757,8 @@ module 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. + # are supported. See + # [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). # # @see Imagekit::Models::Transformation#end_offset module EndOffset @@ -697,7 +774,7 @@ module 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`. + # `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). # # @see Imagekit::Models::Transformation#flip module Flip @@ -716,7 +793,9 @@ module Flip # `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. + # format parameter. See + # [Image format](https://imagekit.io/docs/image-optimization#format---f) and + # [Video format](https://imagekit.io/docs/video-optimization#format---f). # # @see Imagekit::Models::Transformation#format_ module Format @@ -739,31 +818,23 @@ module Format end # Creates a linear gradient with two colors. Pass `true` for a default gradient, - # or provide a string for a custom gradient. + # or provide a string for a custom gradient. See + # [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). # # @see Imagekit::Models::Transformation#gradient module Gradient extend Imagekit::Internal::Type::Union - variant const: -> { Imagekit::Models::Transformation::Gradient::TRUE } + variant const: true variant String # @!method self.variants - # @return [Array(Boolean, String)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Imagekit::Transformation::Gradient::TaggedBoolean, String) } - end - - # @!group - - TRUE = true - - # @!endgroup + # @return [Array(Boolean, true, String)] end - # Enables a grayscale effect for images. + # Enables a grayscale effect for images. See + # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). # # @see Imagekit::Models::Transformation#grayscale module Grayscale @@ -777,7 +848,10 @@ module 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`). + # 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) # # @see Imagekit::Models::Transformation#height module Height @@ -793,7 +867,8 @@ module Height # 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). + # 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). # # @see Imagekit::Models::Transformation#page module Page @@ -807,8 +882,9 @@ module Page # @return [Array(Float, String)] end - # Specifies the corner radius for rounded corners (e.g., 20) or `max` for - # circular/oval shapes. + # 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). # # @see Imagekit::Models::Transformation#radius module Radius @@ -816,26 +892,17 @@ module Radius variant Float - variant const: -> { Imagekit::Models::Transformation::Radius::MAX } + variant const: :max # @!method self.variants - # @return [Array(Float, Symbol)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Float, Imagekit::Transformation::Radius::TaggedSymbol) } - end - - # @!group - - MAX = :max - - # @!endgroup + # @return [Array(Float, Symbol, :max)] end # 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. + # only the following values are supported: 0, 90, 180, 270, or 360. See + # [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). # # @see Imagekit::Models::Transformation#rotation module Rotation @@ -851,57 +918,40 @@ module 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. + # shadow, or provide a string for a custom shadow. See + # [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). # # @see Imagekit::Models::Transformation#shadow module Shadow extend Imagekit::Internal::Type::Union - variant const: -> { Imagekit::Models::Transformation::Shadow::TRUE } + variant const: true variant String # @!method self.variants - # @return [Array(Boolean, String)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Imagekit::Transformation::Shadow::TaggedBoolean, String) } - end - - # @!group - - TRUE = true - - # @!endgroup + # @return [Array(Boolean, true, String)] end # Sharpens the input image, highlighting edges and finer details. Pass `true` for - # default sharpening, or provide a numeric value for custom sharpening. + # default sharpening, or provide a numeric value for custom sharpening. See + # [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). # # @see Imagekit::Models::Transformation#sharpen module Sharpen extend Imagekit::Internal::Type::Union - variant const: -> { Imagekit::Models::Transformation::Sharpen::TRUE } + variant const: true variant Float # @!method self.variants - # @return [Array(Boolean, Float)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Imagekit::Transformation::Sharpen::TaggedBoolean, Float) } - end - - # @!group - - TRUE = true - - # @!endgroup + # @return [Array(Boolean, true, Float)] end # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or - # `10.5`. Arithmetic expressions are also supported. + # `10.5`. Arithmetic expressions are also supported. See + # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). # # @see Imagekit::Models::Transformation#start_offset module StartOffset @@ -917,56 +967,39 @@ module StartOffset # 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. + # output image. See + # [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). # # @see Imagekit::Models::Transformation#trim module Trim extend Imagekit::Internal::Type::Union - variant const: -> { Imagekit::Models::Transformation::Trim::TRUE } + variant const: true variant Float # @!method self.variants - # @return [Array(Boolean, Float)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Imagekit::Transformation::Trim::TaggedBoolean, Float) } - end - - # @!group - - TRUE = true - - # @!endgroup + # @return [Array(Boolean, true, Float)] end # Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a - # default unsharp mask, or provide a string for a custom unsharp mask. + # 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). # # @see Imagekit::Models::Transformation#unsharp_mask module UnsharpMask extend Imagekit::Internal::Type::Union - variant const: -> { Imagekit::Models::Transformation::UnsharpMask::TRUE } + variant const: true variant String # @!method self.variants - # @return [Array(Boolean, String)] - - define_sorbet_constant!(:Variants) do - T.type_alias { T.any(Imagekit::Transformation::UnsharpMask::TaggedBoolean, String) } - end - - # @!group - - TRUE = true - - # @!endgroup + # @return [Array(Boolean, true, String)] end - # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See + # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). # # @see Imagekit::Models::Transformation#video_codec module VideoCodec @@ -983,7 +1016,9 @@ module 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`). + # 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) # # @see Imagekit::Models::Transformation#width module Width @@ -997,7 +1032,8 @@ module Width # @return [Array(Float, String)] end - # Focus using cropped image coordinates - X coordinate + # 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). # # @see Imagekit::Models::Transformation#x module X @@ -1011,7 +1047,8 @@ module X # @return [Array(Float, String)] end - # Focus using cropped image coordinates - X center coordinate + # 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). # # @see Imagekit::Models::Transformation#x_center module XCenter @@ -1025,7 +1062,8 @@ module XCenter # @return [Array(Float, String)] end - # Focus using cropped image coordinates - Y coordinate + # 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). # # @see Imagekit::Models::Transformation#y_ module Y @@ -1039,7 +1077,8 @@ module Y # @return [Array(Float, String)] end - # Focus using cropped image coordinates - Y center coordinate + # 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). # # @see Imagekit::Models::Transformation#y_center module YCenter diff --git a/lib/imagekit/models/transformation_position.rb b/lib/imagekit/models/transformation_position.rb index 31246e1e..e2281215 100644 --- a/lib/imagekit/models/transformation_position.rb +++ b/lib/imagekit/models/transformation_position.rb @@ -4,7 +4,8 @@ module Imagekit module Models # 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`. + # path of the URL, set this to `path`. Learn more in the + # [Transformations guide](https://imagekit.io/docs/transformations). module TransformationPosition extend Imagekit::Internal::Type::Enum diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb index c86439e5..d8b4d18d 100644 --- a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb @@ -2,17 +2,35 @@ module Imagekit module Models + # 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. module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union + # 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. variant -> { Imagekit::VideoTransformationAcceptedEvent } + # 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. variant -> { Imagekit::VideoTransformationReadyEvent } + # 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. variant -> { Imagekit::VideoTransformationErrorEvent } + # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. + variant -> { Imagekit::UploadPreTransformSuccessWebhookEvent } + + # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. + variant -> { Imagekit::UploadPreTransformErrorWebhookEvent } + + # 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. + variant -> { Imagekit::UploadPostTransformSuccessWebhookEvent } + + # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. + variant -> { Imagekit::UploadPostTransformErrorWebhookEvent } + # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessWebhookEvent, Imagekit::Models::UploadPreTransformErrorWebhookEvent, Imagekit::Models::UploadPostTransformSuccessWebhookEvent, Imagekit::Models::UploadPostTransformErrorWebhookEvent)] end end end diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb index 1a570019..d4986749 100644 --- a/lib/imagekit/models/unwrap_webhook_event.rb +++ b/lib/imagekit/models/unwrap_webhook_event.rb @@ -2,17 +2,35 @@ module Imagekit module Models + # 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. module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union + # 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. variant -> { Imagekit::VideoTransformationAcceptedEvent } + # 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. variant -> { Imagekit::VideoTransformationReadyEvent } + # 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. variant -> { Imagekit::VideoTransformationErrorEvent } + # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. + variant -> { Imagekit::UploadPreTransformSuccessWebhookEvent } + + # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. + variant -> { Imagekit::UploadPreTransformErrorWebhookEvent } + + # 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. + variant -> { Imagekit::UploadPostTransformSuccessWebhookEvent } + + # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. + variant -> { Imagekit::UploadPostTransformErrorWebhookEvent } + # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessWebhookEvent, Imagekit::Models::UploadPreTransformErrorWebhookEvent, Imagekit::Models::UploadPostTransformSuccessWebhookEvent, Imagekit::Models::UploadPostTransformErrorWebhookEvent)] end end end diff --git a/lib/imagekit/models/upload_post_transform_error_webhook_event.rb b/lib/imagekit/models/upload_post_transform_error_webhook_event.rb new file mode 100644 index 00000000..edf4455c --- /dev/null +++ b/lib/imagekit/models/upload_post_transform_error_webhook_event.rb @@ -0,0 +1,190 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class UploadPostTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the event. + # + # @return [String] + required :id, String + + # @!attribute created_at + # Timestamp of when the event occurred in ISO8601 format. + # + # @return [Time] + required :created_at, Time + + # @!attribute data + # + # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data] + required :data, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Data } + + # @!attribute request + # + # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request] + required :request, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Request } + + # @!attribute type + # + # @return [Symbol, :"upload.post-transform.error"] + required :type, const: :"upload.post-transform.error" + + # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.error") + # Triggered when a post-transformation fails. The original file remains available, + # but the requested transformation could not be generated. + # + # @param id [String] Unique identifier for the event. + # + # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. + # + # @param data [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data] + # + # @param request [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request] + # + # @param type [Symbol, :"upload.post-transform.error"] + + # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent#data + class Data < Imagekit::Internal::Type::BaseModel + # @!attribute file_id + # Unique identifier of the originally uploaded file. + # + # @return [String] + required :file_id, String, api_name: :fileId + + # @!attribute name + # Name of the file. + # + # @return [String] + required :name, String + + # @!attribute path + # Path of the file. + # + # @return [String] + required :path, String + + # @!attribute transformation + # + # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation] + required :transformation, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation } + + # @!attribute url + # URL of the attempted post-transformation. + # + # @return [String] + required :url, String + + # @!method initialize(file_id:, name:, path:, transformation:, url:) + # @param file_id [String] Unique identifier of the originally uploaded file. + # + # @param name [String] Name of the file. + # + # @param path [String] Path of the file. + # + # @param transformation [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation] + # + # @param url [String] URL of the attempted post-transformation. + + # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data#transformation + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute error + # + # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error] + required :error, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error } + + # @!method initialize(error:) + # @param error [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error] + + # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation#error + class Error < Imagekit::Internal::Type::BaseModel + # @!attribute reason + # Reason for the post-transformation failure. + # + # @return [String] + required :reason, String + + # @!method initialize(reason:) + # @param reason [String] Reason for the post-transformation failure. + end + end + end + + # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent#request + class Request < Imagekit::Internal::Type::BaseModel + # @!attribute transformation + # + # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation] + required :transformation, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation } + + # @!attribute x_request_id + # Unique identifier for the originating request. + # + # @return [String] + required :x_request_id, String + + # @!method initialize(transformation:, x_request_id:) + # @param transformation [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation] + # + # @param x_request_id [String] Unique identifier for the originating request. + + # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request#transformation + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the requested post-transformation. + # + # @return [Symbol, Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type] + required :type, enum: -> { Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type } + + # @!attribute protocol + # Only applicable if transformation type is 'abs'. Streaming protocol used. + # + # @return [Symbol, Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol, nil] + optional :protocol, + enum: -> { Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol } + + # @!attribute value + # Value for the requested transformation type. + # + # @return [String, nil] + optional :value, String + + # @!method initialize(type:, protocol: nil, value: nil) + # @param type [Symbol, Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type] Type of the requested post-transformation. + # + # @param protocol [Symbol, Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. + # + # @param value [String] Value for the requested transformation type. + + # Type of the requested post-transformation. + # + # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation#type + module Type + extend Imagekit::Internal::Type::Enum + + TRANSFORMATION = :transformation + ABS = :abs + GIF_TO_VIDEO = :"gif-to-video" + THUMBNAIL = :thumbnail + + # @!method self.values + # @return [Array] + end + + # Only applicable if transformation type is 'abs'. Streaming protocol used. + # + # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation#protocol + module Protocol + extend Imagekit::Internal::Type::Enum + + HLS = :hls + DASH = :dash + + # @!method self.values + # @return [Array] + end + end + end + end + end +end diff --git a/lib/imagekit/models/upload_post_transform_success_webhook_event.rb b/lib/imagekit/models/upload_post_transform_success_webhook_event.rb new file mode 100644 index 00000000..16c0472b --- /dev/null +++ b/lib/imagekit/models/upload_post_transform_success_webhook_event.rb @@ -0,0 +1,154 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class UploadPostTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the event. + # + # @return [String] + required :id, String + + # @!attribute created_at + # Timestamp of when the event occurred in ISO8601 format. + # + # @return [Time] + required :created_at, Time + + # @!attribute data + # + # @return [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Data] + required :data, -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Data } + + # @!attribute request + # + # @return [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request] + required :request, -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Request } + + # @!attribute type + # + # @return [Symbol, :"upload.post-transform.success"] + required :type, const: :"upload.post-transform.success" + + # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.success") + # 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. + # + # @param id [String] Unique identifier for the event. + # + # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. + # + # @param data [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Data] + # + # @param request [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request] + # + # @param type [Symbol, :"upload.post-transform.success"] + + # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent#data + class Data < Imagekit::Internal::Type::BaseModel + # @!attribute file_id + # Unique identifier of the originally uploaded file. + # + # @return [String] + required :file_id, String, api_name: :fileId + + # @!attribute name + # Name of the file. + # + # @return [String] + required :name, String + + # @!attribute url + # URL of the generated post-transformation. + # + # @return [String] + required :url, String + + # @!method initialize(file_id:, name:, url:) + # @param file_id [String] Unique identifier of the originally uploaded file. + # + # @param name [String] Name of the file. + # + # @param url [String] URL of the generated post-transformation. + end + + # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent#request + class Request < Imagekit::Internal::Type::BaseModel + # @!attribute transformation + # + # @return [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation] + required :transformation, -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation } + + # @!attribute x_request_id + # Unique identifier for the originating request. + # + # @return [String] + required :x_request_id, String + + # @!method initialize(transformation:, x_request_id:) + # @param transformation [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation] + # + # @param x_request_id [String] Unique identifier for the originating request. + + # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request#transformation + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the requested post-transformation. + # + # @return [Symbol, Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type] + required :type, + enum: -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type } + + # @!attribute protocol + # Only applicable if transformation type is 'abs'. Streaming protocol used. + # + # @return [Symbol, Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol, nil] + optional :protocol, + enum: -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol } + + # @!attribute value + # Value for the requested transformation type. + # + # @return [String, nil] + optional :value, String + + # @!method initialize(type:, protocol: nil, value: nil) + # @param type [Symbol, Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type] Type of the requested post-transformation. + # + # @param protocol [Symbol, Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. + # + # @param value [String] Value for the requested transformation type. + + # Type of the requested post-transformation. + # + # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation#type + module Type + extend Imagekit::Internal::Type::Enum + + TRANSFORMATION = :transformation + ABS = :abs + GIF_TO_VIDEO = :"gif-to-video" + THUMBNAIL = :thumbnail + + # @!method self.values + # @return [Array] + end + + # Only applicable if transformation type is 'abs'. Streaming protocol used. + # + # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation#protocol + module Protocol + extend Imagekit::Internal::Type::Enum + + HLS = :hls + DASH = :dash + + # @!method self.values + # @return [Array] + end + end + end + end + end +end diff --git a/lib/imagekit/models/upload_pre_transform_error_webhook_event.rb b/lib/imagekit/models/upload_pre_transform_error_webhook_event.rb new file mode 100644 index 00000000..16c7ee42 --- /dev/null +++ b/lib/imagekit/models/upload_pre_transform_error_webhook_event.rb @@ -0,0 +1,118 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class UploadPreTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the event. + # + # @return [String] + required :id, String + + # @!attribute created_at + # Timestamp of when the event occurred in ISO8601 format. + # + # @return [Time] + required :created_at, Time + + # @!attribute data + # + # @return [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data] + required :data, -> { Imagekit::UploadPreTransformErrorWebhookEvent::Data } + + # @!attribute request + # + # @return [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Request] + required :request, -> { Imagekit::UploadPreTransformErrorWebhookEvent::Request } + + # @!attribute type + # + # @return [Symbol, :"upload.pre-transform.error"] + required :type, const: :"upload.pre-transform.error" + + # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.error") + # Triggered when a pre-transformation fails. The file upload may have been + # accepted, but the requested transformation could not be applied. + # + # @param id [String] Unique identifier for the event. + # + # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. + # + # @param data [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data] + # + # @param request [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Request] + # + # @param type [Symbol, :"upload.pre-transform.error"] + + # @see Imagekit::Models::UploadPreTransformErrorWebhookEvent#data + class Data < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Name of the file. + # + # @return [String] + required :name, String + + # @!attribute path + # Path of the file. + # + # @return [String] + required :path, String + + # @!attribute transformation + # + # @return [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation] + required :transformation, -> { Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation } + + # @!method initialize(name:, path:, transformation:) + # @param name [String] Name of the file. + # + # @param path [String] Path of the file. + # + # @param transformation [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation] + + # @see Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data#transformation + class Transformation < Imagekit::Internal::Type::BaseModel + # @!attribute error + # + # @return [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error] + required :error, -> { Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error } + + # @!method initialize(error:) + # @param error [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error] + + # @see Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation#error + class Error < Imagekit::Internal::Type::BaseModel + # @!attribute reason + # Reason for the pre-transformation failure. + # + # @return [String] + required :reason, String + + # @!method initialize(reason:) + # @param reason [String] Reason for the pre-transformation failure. + end + end + end + + # @see Imagekit::Models::UploadPreTransformErrorWebhookEvent#request + class Request < Imagekit::Internal::Type::BaseModel + # @!attribute transformation + # The requested pre-transformation string. + # + # @return [String] + required :transformation, String + + # @!attribute x_request_id + # Unique identifier for the originating request. + # + # @return [String] + required :x_request_id, String + + # @!method initialize(transformation:, x_request_id:) + # @param transformation [String] The requested pre-transformation string. + # + # @param x_request_id [String] Unique identifier for the originating request. + end + end + end +end diff --git a/lib/imagekit/models/upload_pre_transform_success_webhook_event.rb b/lib/imagekit/models/upload_pre_transform_success_webhook_event.rb new file mode 100644 index 00000000..24846b6d --- /dev/null +++ b/lib/imagekit/models/upload_pre_transform_success_webhook_event.rb @@ -0,0 +1,448 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class UploadPreTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the event. + # + # @return [String] + required :id, String + + # @!attribute created_at + # Timestamp of when the event occurred in ISO8601 format. + # + # @return [Time] + required :created_at, Time + + # @!attribute data + # Object containing details of a successful upload. + # + # @return [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data] + required :data, -> { Imagekit::UploadPreTransformSuccessWebhookEvent::Data } + + # @!attribute request + # + # @return [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Request] + required :request, -> { Imagekit::UploadPreTransformSuccessWebhookEvent::Request } + + # @!attribute type + # + # @return [Symbol, :"upload.pre-transform.success"] + required :type, const: :"upload.pre-transform.success" + + # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.success") + # Triggered when a pre-transformation completes successfully. The file has been + # processed with the requested transformation and is now available in the Media + # Library. + # + # @param id [String] Unique identifier for the event. + # + # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. + # + # @param data [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data] Object containing details of a successful upload. + # + # @param request [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Request] + # + # @param type [Symbol, :"upload.pre-transform.success"] + + # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent#data + class Data < Imagekit::Internal::Type::BaseModel + # @!attribute ai_tags + # An array of tags assigned to the uploaded file by auto tagging. + # + # @return [Array, nil] + optional :ai_tags, + -> { + Imagekit::Internal::Type::ArrayOf[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag] + }, + api_name: :AITags, + nil?: true + + # @!attribute audio_codec + # The audio codec used in the video (only for video). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # 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. + # + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata + + # @!attribute description + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + # + # @return [String, nil] + optional :description, String + + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute embedded_metadata + # 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. + # + # @return [Hash{Symbol=>Object}, nil] + optional :embedded_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :embeddedMetadata + + # @!attribute extension_status + # 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. + # + # @return [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, nil] + optional :extension_status, + -> { Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus }, + api_name: :extensionStatus + + # @!attribute file_id + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + # + # @return [String, nil] + optional :file_id, String, api_name: :fileId + + # @!attribute file_path + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + # + # @return [String, nil] + optional :file_path, String, api_name: :filePath + + # @!attribute file_type + # Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @return [String, nil] + optional :file_type, String, api_name: :fileType + + # @!attribute height + # Height of the image in pixels (Only for images) + # + # @return [Float, nil] + optional :height, Float + + # @!attribute is_private_file + # 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. + # + # @return [Boolean, nil] + optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + + # @!attribute is_published + # 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. + # + # @return [Boolean, nil] + optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute metadata + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + # + # @return [Imagekit::Models::Metadata, nil] + optional :metadata, -> { Imagekit::Metadata } + + # @!attribute name + # Name of the asset. + # + # @return [String, nil] + optional :name, String + + # @!attribute size + # Size of the image file in Bytes. + # + # @return [Float, nil] + optional :size, Float + + # @!attribute tags + # 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. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute thumbnail_url + # In the case of an image, a small thumbnail URL. + # + # @return [String, nil] + optional :thumbnail_url, String, api_name: :thumbnailUrl + + # @!attribute url + # A publicly accessible URL of the file. + # + # @return [String, nil] + optional :url, String + + # @!attribute version_info + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @return [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, nil] + optional :version_info, + -> { Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo }, + api_name: :versionInfo + + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + + # @!attribute width + # Width of the image in pixels (Only for Images) + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data} for more + # details. + # + # Object containing details of a successful upload. + # + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # + # @param audio_codec [String] The audio codec used in the video (only for video). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # + # @param custom_coordinates [String, nil] Value of custom coordinates associated with the image in the format `x,y,width,h + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data associated with the asset. Use `responseField` in API request t + # + # @param description [String] Optional text to describe the contents of the file. Can be set by the user or th + # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, + # + # @param extension_status [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # + # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo + # + # @param file_path [String] The relative path of the file in the media library e.g. `/marketing-assets/new-b + # + # @param file_type [String] Type of the uploaded file. Possible values are `image`, `non-image`. + # + # @param height [Float] Height of the image in pixels (Only for images) + # + # @param is_private_file [Boolean] Is the file marked as private. It can be either `true` or `false`. Send `isPriva + # + # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen + # + # @param metadata [Imagekit::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # + # @param name [String] Name of the asset. + # + # @param size [Float] Size of the image file in Bytes. + # + # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul + # + # @param thumbnail_url [String] In the case of an image, a small thumbnail URL. + # + # @param url [String] A publicly accessible URL of the file. + # + # @param version_info [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # + # @param video_codec [String] The video codec used in the video (only for video). + # + # @param width [Float] Width of the image in pixels (Only for Images) + + class AITag < Imagekit::Internal::Type::BaseModel + # @!attribute confidence + # Confidence score of the tag. + # + # @return [Float, nil] + optional :confidence, Float + + # @!attribute name + # Name of the tag. + # + # @return [String, nil] + optional :name, String + + # @!attribute source + # 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. + # + # @return [String, nil] + optional :source, String + + # @!method initialize(confidence: nil, name: nil, source: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::AITag} for more + # details. + # + # @param confidence [Float] Confidence score of the tag. + # + # @param name [String] Name of the tag. + # + # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be + end + + # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data#extension_status + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute aws_auto_tagging + # + # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging, nil] + optional :aws_auto_tagging, + enum: -> { + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging + }, + api_name: :"aws-auto-tagging" + + # @!attribute google_auto_tagging + # + # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging, nil] + optional :google_auto_tagging, + enum: -> { + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging + }, + api_name: :"google-auto-tagging" + + # @!attribute remove_bg + # + # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg, nil] + optional :remove_bg, + enum: -> { + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg + }, + api_name: :"remove-bg" + + # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # 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. + # + # @param aws_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg] + + # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus#aws_auto_tagging + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus#google_auto_tagging + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus#remove_bg + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + end + + # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data#version_info + class VersionInfo < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the file version. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # Name of the file version. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(id: nil, name: nil) + # An object containing the file or file version's `id` (versionId) and `name`. + # + # @param id [String] Unique identifier of the file version. + # + # @param name [String] Name of the file version. + end + end + + # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent#request + class Request < Imagekit::Internal::Type::BaseModel + # @!attribute transformation + # The requested pre-transformation string. + # + # @return [String] + required :transformation, String + + # @!attribute x_request_id + # Unique identifier for the originating request. + # + # @return [String] + required :x_request_id, String + + # @!method initialize(transformation:, x_request_id:) + # @param transformation [String] The requested pre-transformation string. + # + # @param x_request_id [String] Unique identifier for the originating request. + end + end + end +end diff --git a/lib/imagekit/models/video_overlay.rb b/lib/imagekit/models/video_overlay.rb index 8d3ebad4..3a134813 100644 --- a/lib/imagekit/models/video_overlay.rb +++ b/lib/imagekit/models/video_overlay.rb @@ -11,8 +11,8 @@ class VideoOverlay < Imagekit::Models::BaseOverlay # @!attribute type # - # @return [Symbol, Imagekit::Models::VideoOverlay::Type] - required :type, enum: -> { Imagekit::VideoOverlay::Type } + # @return [Symbol, :video] + required :type, const: :video # @!attribute encoding # The input path can be included in the layer as either `i-{input}` or @@ -26,31 +26,23 @@ class VideoOverlay < Imagekit::Models::BaseOverlay # @!attribute transformation # Array of transformation to be applied to the overlay video. Except - # `streamingResolutions`, all other video transformations are supported. + # `streamingResolutions`, all other video transformations are supported. See + # [Video transformations](https://imagekit.io/docs/video-transformation). # # @return [Array, nil] optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } - # @!method initialize(input:, type:, encoding: nil, transformation: nil) + # @!method initialize(input:, encoding: nil, transformation: nil, type: :video) # Some parameter documentations has been truncated, see # {Imagekit::Models::VideoOverlay} for more details. # # @param input [String] Specifies the relative path to the video used as an overlay. # - # @param type [Symbol, Imagekit::Models::VideoOverlay::Type] - # # @param encoding [Symbol, Imagekit::Models::VideoOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 # # @param transformation [Array] Array of transformation to be applied to the overlay video. Except `streamingRes - - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO = :video - - # @!method self.values - # @return [Array] - end + # + # @param type [Symbol, :video] # 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 diff --git a/lib/imagekit/models/video_transformation_accepted_event.rb b/lib/imagekit/models/video_transformation_accepted_event.rb index fc8eaec5..1674c5ed 100644 --- a/lib/imagekit/models/video_transformation_accepted_event.rb +++ b/lib/imagekit/models/video_transformation_accepted_event.rb @@ -10,6 +10,7 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel required :id, String # @!attribute created_at + # Timestamp when the event was created in ISO8601 format. # # @return [Time] required :created_at, Time @@ -20,6 +21,7 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel required :data, -> { Imagekit::VideoTransformationAcceptedEvent::Data } # @!attribute request + # Information about the original request that triggered the video transformation. # # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Request] required :request, -> { Imagekit::VideoTransformationAcceptedEvent::Request } @@ -30,60 +32,90 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"video.transformation.accepted" # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.accepted") + # 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. + # # @param id [String] Unique identifier for the event. # - # @param created_at [Time] + # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # # @param data [Imagekit::Models::VideoTransformationAcceptedEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationAcceptedEvent::Request] + # @param request [Imagekit::Models::VideoTransformationAcceptedEvent::Request] Information about the original request that triggered the video transformation. # # @param type [Symbol, :"video.transformation.accepted"] # @see Imagekit::Models::VideoTransformationAcceptedEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset + # Information about the source video asset being transformed. # # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] required :asset, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Asset } # @!attribute transformation + # Base information about a video transformation request. # # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] required :transformation, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] - # @param transformation [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] + # @param asset [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] Information about the source video asset being transformed. + # + # @param transformation [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] Base information about a video transformation request. # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url - # Source asset URL. + # URL to download or access the source video file. # # @return [String] required :url, String # @!method initialize(url:) - # @param url [String] Source asset URL. + # Information about the source video asset being transformed. + # + # @param url [String] URL to download or access the source video file. end # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type + # 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 # # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] required :type, enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type } # @!attribute options + # Configuration options for video transformations. # # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options, nil] optional :options, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } # @!method initialize(type:, options: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] - # @param options [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options] + # Some parameter documentations has been truncated, see + # {Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation} for + # more details. + # + # Base information about a video transformation request. + # + # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] Type of video transformation: + # + # @param options [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options] Configuration options for video transformations. + # 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 + # # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -99,17 +131,20 @@ module Type # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec + # Audio codec used for encoding (aac or opus). # # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate + # Whether to automatically rotate the video based on metadata. # # @return [Boolean, nil] optional :auto_rotate, Imagekit::Internal::Type::Boolean # @!attribute format_ + # Output format for the transformed video or thumbnail. # # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format, nil] optional :format_, @@ -119,36 +154,50 @@ class Options < Imagekit::Internal::Type::BaseModel api_name: :format # @!attribute quality + # Quality setting for the output video. # # @return [Integer, nil] optional :quality, Integer # @!attribute stream_protocol + # Streaming protocol for adaptive bitrate streaming. # # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants + # Array of quality representations for adaptive bitrate streaming. # # @return [Array, nil] optional :variants, Imagekit::Internal::Type::ArrayOf[String] # @!attribute video_codec + # Video codec used for encoding (h264 or vp9). # # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec] - # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format] - # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol] - # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] + # Configuration options for video transformations. + # + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). + # + # @param auto_rotate [Boolean] Whether to automatically rotate the video based on metadata. + # + # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. + # + # @param quality [Integer] Quality setting for the output video. + # + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. + # + # @param variants [Array] Array of quality representations for adaptive bitrate streaming. + # + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264 or vp9). + # Audio codec used for encoding (aac or opus). + # # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -160,6 +209,8 @@ module AudioCodec # @return [Array] end + # Output format for the transformed video or thumbnail. + # # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -174,6 +225,8 @@ module Format # @return [Array] end + # Streaming protocol for adaptive bitrate streaming. + # # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -185,6 +238,8 @@ module StreamProtocol # @return [Array] end + # Video codec used for encoding (h264 or vp9). + # # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -202,29 +257,31 @@ module VideoCodec # @see Imagekit::Models::VideoTransformationAcceptedEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url - # URL of the submitted request. + # Full URL of the transformation request that was submitted. # # @return [String] required :url, String # @!attribute x_request_id - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. # # @return [String] required :x_request_id, String # @!attribute user_agent - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. # # @return [String, nil] optional :user_agent, String # @!method initialize(url:, x_request_id:, user_agent: nil) - # @param url [String] URL of the submitted request. + # Information about the original request that triggered the video transformation. + # + # @param url [String] Full URL of the transformation request that was submitted. # - # @param x_request_id [String] Unique ID for the originating request. + # @param x_request_id [String] Unique identifier for the originating transformation request. # - # @param user_agent [String] User-Agent header of the originating request. + # @param user_agent [String] User-Agent header from the original request that triggered the transformation. end end end diff --git a/lib/imagekit/models/video_transformation_error_event.rb b/lib/imagekit/models/video_transformation_error_event.rb index 5b199f18..8d783e74 100644 --- a/lib/imagekit/models/video_transformation_error_event.rb +++ b/lib/imagekit/models/video_transformation_error_event.rb @@ -10,6 +10,7 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel required :id, String # @!attribute created_at + # Timestamp when the event was created in ISO8601 format. # # @return [Time] required :created_at, Time @@ -20,6 +21,7 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel required :data, -> { Imagekit::VideoTransformationErrorEvent::Data } # @!attribute request + # Information about the original request that triggered the video transformation. # # @return [Imagekit::Models::VideoTransformationErrorEvent::Request] required :request, -> { Imagekit::VideoTransformationErrorEvent::Request } @@ -30,19 +32,25 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"video.transformation.error" # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.error") + # 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. + # # @param id [String] Unique identifier for the event. # - # @param created_at [Time] + # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # # @param data [Imagekit::Models::VideoTransformationErrorEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationErrorEvent::Request] + # @param request [Imagekit::Models::VideoTransformationErrorEvent::Request] Information about the original request that triggered the video transformation. # # @param type [Symbol, :"video.transformation.error"] # @see Imagekit::Models::VideoTransformationErrorEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset + # Information about the source video asset being transformed. # # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] required :asset, -> { Imagekit::VideoTransformationErrorEvent::Data::Asset } @@ -53,43 +61,67 @@ class Data < Imagekit::Internal::Type::BaseModel required :transformation, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] + # @param asset [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] Information about the source video asset being transformed. + # # @param transformation [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] # @see Imagekit::Models::VideoTransformationErrorEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url - # Source asset URL. + # URL to download or access the source video file. # # @return [String] required :url, String # @!method initialize(url:) - # @param url [String] Source asset URL. + # Information about the source video asset being transformed. + # + # @param url [String] URL to download or access the source video file. end # @see Imagekit::Models::VideoTransformationErrorEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type + # 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 # # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] required :type, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type } # @!attribute error + # Details about the transformation error. # # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error, nil] optional :error, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error } # @!attribute options + # Configuration options for video transformations. # # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options, nil] optional :options, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } # @!method initialize(type:, error: nil, options: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] - # @param error [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error] - # @param options [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options] + # Some parameter documentations has been truncated, see + # {Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation} for more + # details. + # + # @param type [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] Type of video transformation: + # + # @param error [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error] Details about the transformation error. + # + # @param options [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options] Configuration options for video transformations. + # 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 + # # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -105,14 +137,31 @@ module Type # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#error class Error < Imagekit::Internal::Type::BaseModel # @!attribute reason + # 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 # # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] required :reason, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason } # @!method initialize(reason:) - # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] + # Some parameter documentations has been truncated, see + # {Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error} + # for more details. + # + # Details about the transformation error. + # + # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] Specific reason for the transformation failure: + # 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 + # # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error#reason module Reason extend Imagekit::Internal::Type::Enum @@ -129,17 +178,20 @@ module Reason # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec + # Audio codec used for encoding (aac or opus). # # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate + # Whether to automatically rotate the video based on metadata. # # @return [Boolean, nil] optional :auto_rotate, Imagekit::Internal::Type::Boolean # @!attribute format_ + # Output format for the transformed video or thumbnail. # # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format, nil] optional :format_, @@ -149,36 +201,50 @@ class Options < Imagekit::Internal::Type::BaseModel api_name: :format # @!attribute quality + # Quality setting for the output video. # # @return [Integer, nil] optional :quality, Integer # @!attribute stream_protocol + # Streaming protocol for adaptive bitrate streaming. # # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants + # Array of quality representations for adaptive bitrate streaming. # # @return [Array, nil] optional :variants, Imagekit::Internal::Type::ArrayOf[String] # @!attribute video_codec + # Video codec used for encoding (h264 or vp9). # # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec] - # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format] - # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol] - # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] + # Configuration options for video transformations. + # + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). + # + # @param auto_rotate [Boolean] Whether to automatically rotate the video based on metadata. + # + # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. + # + # @param quality [Integer] Quality setting for the output video. + # + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. + # + # @param variants [Array] Array of quality representations for adaptive bitrate streaming. + # + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264 or vp9). + # Audio codec used for encoding (aac or opus). + # # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -190,6 +256,8 @@ module AudioCodec # @return [Array] end + # Output format for the transformed video or thumbnail. + # # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -204,6 +272,8 @@ module Format # @return [Array] end + # Streaming protocol for adaptive bitrate streaming. + # # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -215,6 +285,8 @@ module StreamProtocol # @return [Array] end + # Video codec used for encoding (h264 or vp9). + # # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -232,29 +304,31 @@ module VideoCodec # @see Imagekit::Models::VideoTransformationErrorEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url - # URL of the submitted request. + # Full URL of the transformation request that was submitted. # # @return [String] required :url, String # @!attribute x_request_id - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. # # @return [String] required :x_request_id, String # @!attribute user_agent - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. # # @return [String, nil] optional :user_agent, String # @!method initialize(url:, x_request_id:, user_agent: nil) - # @param url [String] URL of the submitted request. + # Information about the original request that triggered the video transformation. + # + # @param url [String] Full URL of the transformation request that was submitted. # - # @param x_request_id [String] Unique ID for the originating request. + # @param x_request_id [String] Unique identifier for the originating transformation request. # - # @param user_agent [String] User-Agent header of the originating request. + # @param user_agent [String] User-Agent header from the original request that triggered the transformation. end end end diff --git a/lib/imagekit/models/video_transformation_ready_event.rb b/lib/imagekit/models/video_transformation_ready_event.rb index 5e6d463b..8937ab8e 100644 --- a/lib/imagekit/models/video_transformation_ready_event.rb +++ b/lib/imagekit/models/video_transformation_ready_event.rb @@ -10,6 +10,7 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel required :id, String # @!attribute created_at + # Timestamp when the event was created in ISO8601 format. # # @return [Time] required :created_at, Time @@ -20,6 +21,7 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel required :data, -> { Imagekit::VideoTransformationReadyEvent::Data } # @!attribute request + # Information about the original request that triggered the video transformation. # # @return [Imagekit::Models::VideoTransformationReadyEvent::Request] required :request, -> { Imagekit::VideoTransformationReadyEvent::Request } @@ -30,26 +32,33 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"video.transformation.ready" # @!attribute timings + # Performance metrics for the transformation process. # # @return [Imagekit::Models::VideoTransformationReadyEvent::Timings, nil] optional :timings, -> { Imagekit::VideoTransformationReadyEvent::Timings } # @!method initialize(id:, created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") + # 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. + # # @param id [String] Unique identifier for the event. # - # @param created_at [Time] + # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # # @param data [Imagekit::Models::VideoTransformationReadyEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationReadyEvent::Request] + # @param request [Imagekit::Models::VideoTransformationReadyEvent::Request] Information about the original request that triggered the video transformation. # - # @param timings [Imagekit::Models::VideoTransformationReadyEvent::Timings] + # @param timings [Imagekit::Models::VideoTransformationReadyEvent::Timings] Performance metrics for the transformation process. # # @param type [Symbol, :"video.transformation.ready"] # @see Imagekit::Models::VideoTransformationReadyEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset + # Information about the source video asset being transformed. # # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] required :asset, -> { Imagekit::VideoTransformationReadyEvent::Data::Asset } @@ -60,43 +69,67 @@ class Data < Imagekit::Internal::Type::BaseModel required :transformation, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] + # @param asset [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] Information about the source video asset being transformed. + # # @param transformation [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] # @see Imagekit::Models::VideoTransformationReadyEvent::Data#asset class Asset < Imagekit::Internal::Type::BaseModel # @!attribute url - # Source asset URL. + # URL to download or access the source video file. # # @return [String] required :url, String # @!method initialize(url:) - # @param url [String] Source asset URL. + # Information about the source video asset being transformed. + # + # @param url [String] URL to download or access the source video file. end # @see Imagekit::Models::VideoTransformationReadyEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type + # 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 # # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] required :type, enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type } # @!attribute options + # Configuration options for video transformations. # # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options, nil] optional :options, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options } # @!attribute output + # Information about the transformed output video. # # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output, nil] optional :output, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } # @!method initialize(type:, options: nil, output: nil) - # @param type [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] - # @param options [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options] - # @param output [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output] + # Some parameter documentations has been truncated, see + # {Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation} for more + # details. + # + # @param type [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] Type of video transformation: + # + # @param options [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options] Configuration options for video transformations. + # + # @param output [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output] Information about the transformed output video. + # 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 + # # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -112,17 +145,20 @@ module Type # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#options class Options < Imagekit::Internal::Type::BaseModel # @!attribute audio_codec + # Audio codec used for encoding (aac or opus). # # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate + # Whether to automatically rotate the video based on metadata. # # @return [Boolean, nil] optional :auto_rotate, Imagekit::Internal::Type::Boolean # @!attribute format_ + # Output format for the transformed video or thumbnail. # # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format, nil] optional :format_, @@ -132,36 +168,50 @@ class Options < Imagekit::Internal::Type::BaseModel api_name: :format # @!attribute quality + # Quality setting for the output video. # # @return [Integer, nil] optional :quality, Integer # @!attribute stream_protocol + # Streaming protocol for adaptive bitrate streaming. # # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants + # Array of quality representations for adaptive bitrate streaming. # # @return [Array, nil] optional :variants, Imagekit::Internal::Type::ArrayOf[String] # @!attribute video_codec + # Video codec used for encoding (h264 or vp9). # # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec] - # @param auto_rotate [Boolean] - # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format] - # @param quality [Integer] - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol] - # @param variants [Array] - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] + # Configuration options for video transformations. + # + # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). + # + # @param auto_rotate [Boolean] Whether to automatically rotate the video based on metadata. + # + # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. + # + # @param quality [Integer] Quality setting for the output video. + # + # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. + # + # @param variants [Array] Array of quality representations for adaptive bitrate streaming. + # + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264 or vp9). + # Audio codec used for encoding (aac or opus). + # # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#audio_codec module AudioCodec extend Imagekit::Internal::Type::Enum @@ -173,6 +223,8 @@ module AudioCodec # @return [Array] end + # Output format for the transformed video or thumbnail. + # # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#format_ module Format extend Imagekit::Internal::Type::Enum @@ -187,6 +239,8 @@ module Format # @return [Array] end + # Streaming protocol for adaptive bitrate streaming. + # # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#stream_protocol module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -198,6 +252,8 @@ module StreamProtocol # @return [Array] end + # Video codec used for encoding (h264 or vp9). + # # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#video_codec module VideoCodec extend Imagekit::Internal::Type::Enum @@ -213,47 +269,61 @@ module VideoCodec # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#output class Output < Imagekit::Internal::Type::BaseModel # @!attribute url + # URL to access the transformed video. # # @return [String] required :url, String # @!attribute video_metadata + # Metadata of the output video file. # # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, nil] optional :video_metadata, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } # @!method initialize(url:, video_metadata: nil) - # @param url [String] - # @param video_metadata [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata] + # Information about the transformed output video. + # + # @param url [String] URL to access the transformed video. + # + # @param video_metadata [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata] Metadata of the output video file. # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output#video_metadata class VideoMetadata < Imagekit::Internal::Type::BaseModel # @!attribute bitrate + # Bitrate of the output video in bits per second. # # @return [Integer] required :bitrate, Integer # @!attribute duration + # Duration of the output video in seconds. # # @return [Float] required :duration, Float # @!attribute height + # Height of the output video in pixels. # # @return [Integer] required :height, Integer # @!attribute width + # Width of the output video in pixels. # # @return [Integer] required :width, Integer # @!method initialize(bitrate:, duration:, height:, width:) - # @param bitrate [Integer] - # @param duration [Float] - # @param height [Integer] - # @param width [Integer] + # Metadata of the output video file. + # + # @param bitrate [Integer] Bitrate of the output video in bits per second. + # + # @param duration [Float] Duration of the output video in seconds. + # + # @param height [Integer] Height of the output video in pixels. + # + # @param width [Integer] Width of the output video in pixels. end end end @@ -262,49 +332,57 @@ class VideoMetadata < Imagekit::Internal::Type::BaseModel # @see Imagekit::Models::VideoTransformationReadyEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url - # URL of the submitted request. + # Full URL of the transformation request that was submitted. # # @return [String] required :url, String # @!attribute x_request_id - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. # # @return [String] required :x_request_id, String # @!attribute user_agent - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. # # @return [String, nil] optional :user_agent, String # @!method initialize(url:, x_request_id:, user_agent: nil) - # @param url [String] URL of the submitted request. + # Information about the original request that triggered the video transformation. # - # @param x_request_id [String] Unique ID for the originating request. + # @param url [String] Full URL of the transformation request that was submitted. # - # @param user_agent [String] User-Agent header of the originating request. + # @param x_request_id [String] Unique identifier for the originating transformation request. + # + # @param user_agent [String] User-Agent header from the original request that triggered the transformation. end # @see Imagekit::Models::VideoTransformationReadyEvent#timings class Timings < Imagekit::Internal::Type::BaseModel # @!attribute download_duration - # Milliseconds spent downloading the source. + # Time spent downloading the source video from your origin or media library, in + # milliseconds. # # @return [Integer, nil] optional :download_duration, Integer # @!attribute encoding_duration - # Milliseconds spent encoding. + # Time spent encoding the video, in milliseconds. # # @return [Integer, nil] optional :encoding_duration, Integer # @!method initialize(download_duration: nil, encoding_duration: nil) - # @param download_duration [Integer] Milliseconds spent downloading the source. + # Some parameter documentations has been truncated, see + # {Imagekit::Models::VideoTransformationReadyEvent::Timings} for more details. + # + # Performance metrics for the transformation process. + # + # @param download_duration [Integer] Time spent downloading the source video from your origin or media library, in mi # - # @param encoding_duration [Integer] Milliseconds spent encoding. + # @param encoding_duration [Integer] Time spent encoding the video, in milliseconds. end end end diff --git a/lib/imagekit/resources/webhooks.rb b/lib/imagekit/resources/webhooks.rb index abc4b41e..208f8727 100644 --- a/lib/imagekit/resources/webhooks.rb +++ b/lib/imagekit/resources/webhooks.rb @@ -5,7 +5,7 @@ module Resources class Webhooks # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessWebhookEvent, Imagekit::Models::UploadPreTransformErrorWebhookEvent, Imagekit::Models::UploadPostTransformSuccessWebhookEvent, Imagekit::Models::UploadPostTransformErrorWebhookEvent] def unsafe_unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnsafeUnwrapWebhookEvent, parsed) @@ -13,7 +13,7 @@ def unsafe_unwrap(payload) # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessWebhookEvent, Imagekit::Models::UploadPreTransformErrorWebhookEvent, Imagekit::Models::UploadPostTransformSuccessWebhookEvent, Imagekit::Models::UploadPostTransformErrorWebhookEvent] def unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnwrapWebhookEvent, parsed) diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 95e6fa74..edbc9e8f 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -93,6 +93,18 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + UploadPostTransformErrorWebhookEvent = + Imagekit::Models::UploadPostTransformErrorWebhookEvent + + UploadPostTransformSuccessWebhookEvent = + Imagekit::Models::UploadPostTransformSuccessWebhookEvent + + UploadPreTransformErrorWebhookEvent = + Imagekit::Models::UploadPreTransformErrorWebhookEvent + + UploadPreTransformSuccessWebhookEvent = + Imagekit::Models::UploadPreTransformSuccessWebhookEvent + VideoOverlay = Imagekit::Models::VideoOverlay VideoTransformationAcceptedEvent = diff --git a/rbi/imagekit/models/image_overlay.rbi b/rbi/imagekit/models/image_overlay.rbi index b34471e5..409aa105 100644 --- a/rbi/imagekit/models/image_overlay.rbi +++ b/rbi/imagekit/models/image_overlay.rbi @@ -12,7 +12,7 @@ module Imagekit sig { returns(String) } attr_accessor :input - sig { returns(Imagekit::ImageOverlay::Type::OrSymbol) } + sig { returns(Symbol) } attr_accessor :type # The input path can be included in the layer as either `i-{input}` or @@ -27,7 +27,10 @@ module Imagekit attr_writer :encoding # Array of transformations to be applied to the overlay image. Supported - # transformations depends on the base/parent asset. + # 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). sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } attr_reader :transformation @@ -37,15 +40,14 @@ module Imagekit sig do params( input: String, - type: Imagekit::ImageOverlay::Type::OrSymbol, encoding: Imagekit::ImageOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::Transformation] + transformation: T::Array[Imagekit::Transformation], + type: Symbol ).returns(T.attached_class) end def self.new( # Specifies the relative path to the image used as an overlay. input:, - type:, # 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 @@ -53,8 +55,12 @@ module Imagekit # `plain`. encoding: nil, # Array of transformations to be applied to the overlay image. Supported - # transformations depends on the base/parent asset. - transformation: nil + # 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). + transformation: nil, + type: :image ) end @@ -62,7 +68,7 @@ module Imagekit override.returns( { input: String, - type: Imagekit::ImageOverlay::Type::OrSymbol, + type: Symbol, encoding: Imagekit::ImageOverlay::Encoding::OrSymbol, transformation: T::Array[Imagekit::Transformation] } @@ -71,22 +77,6 @@ module Imagekit def to_hash end - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::ImageOverlay::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IMAGE = T.let(:image, Imagekit::ImageOverlay::Type::TaggedSymbol) - - sig do - override.returns(T::Array[Imagekit::ImageOverlay::Type::TaggedSymbol]) - end - def self.values - end - end - # 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 diff --git a/rbi/imagekit/models/overlay.rbi b/rbi/imagekit/models/overlay.rbi index 8de9c66d..59e0e042 100644 --- a/rbi/imagekit/models/overlay.rbi +++ b/rbi/imagekit/models/overlay.rbi @@ -4,6 +4,8 @@ module Imagekit module Models # 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). module Overlay extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/overlay_position.rbi b/rbi/imagekit/models/overlay_position.rbi index f5ca4087..96202b12 100644 --- a/rbi/imagekit/models/overlay_position.rbi +++ b/rbi/imagekit/models/overlay_position.rbi @@ -18,7 +18,9 @@ module Imagekit # 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. + # 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). sig { returns(T.nilable(Imagekit::OverlayPosition::X::Variants)) } attr_reader :x @@ -27,7 +29,9 @@ module Imagekit # 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. + # 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). sig { returns(T.nilable(Imagekit::OverlayPosition::Y::Variants)) } attr_reader :y_ @@ -47,11 +51,15 @@ module Imagekit focus: nil, # 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. + # 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). x: nil, # 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. + # 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). y_: nil ) end @@ -102,7 +110,9 @@ module Imagekit # 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. + # 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). module X extend Imagekit::Internal::Type::Union @@ -117,7 +127,9 @@ module Imagekit # 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. + # 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). module Y extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/solid_color_overlay.rbi b/rbi/imagekit/models/solid_color_overlay.rbi index 71b3cedc..54cbbac7 100644 --- a/rbi/imagekit/models/solid_color_overlay.rbi +++ b/rbi/imagekit/models/solid_color_overlay.rbi @@ -15,11 +15,14 @@ module Imagekit sig { returns(String) } attr_accessor :color - sig { returns(Imagekit::SolidColorOverlay::Type::OrSymbol) } + sig { returns(Symbol) } attr_accessor :type # Control width and height of the solid color overlay. Supported transformations - # depend on the base/parent asset. + # 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). sig do returns(T.nilable(T::Array[Imagekit::SolidColorOverlayTransformation])) end @@ -36,9 +39,9 @@ module Imagekit sig do params( color: String, - type: Imagekit::SolidColorOverlay::Type::OrSymbol, transformation: - T::Array[Imagekit::SolidColorOverlayTransformation::OrHash] + T::Array[Imagekit::SolidColorOverlayTransformation::OrHash], + type: Symbol ).returns(T.attached_class) end def self.new( @@ -47,10 +50,13 @@ module Imagekit # is provided, the last two characters represent the opacity level (from `00` for # 0.00 to `99` for 0.99). color:, - type:, # Control width and height of the solid color overlay. Supported transformations - # depend on the base/parent asset. - transformation: nil + # 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). + transformation: nil, + type: :solidColor ) end @@ -58,32 +64,13 @@ module Imagekit override.returns( { color: String, - type: Imagekit::SolidColorOverlay::Type::OrSymbol, + type: Symbol, transformation: T::Array[Imagekit::SolidColorOverlayTransformation] } ) end def to_hash end - - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::SolidColorOverlay::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SOLID_COLOR = - T.let(:solidColor, Imagekit::SolidColorOverlay::Type::TaggedSymbol) - - sig do - override.returns( - T::Array[Imagekit::SolidColorOverlay::Type::TaggedSymbol] - ) - end - def self.values - end - end end end end diff --git a/rbi/imagekit/models/solid_color_overlay_transformation.rbi b/rbi/imagekit/models/solid_color_overlay_transformation.rbi index 1836cb91..698a29f6 100644 --- a/rbi/imagekit/models/solid_color_overlay_transformation.rbi +++ b/rbi/imagekit/models/solid_color_overlay_transformation.rbi @@ -11,45 +11,35 @@ module Imagekit ) end - # Alpha transparency level + # Specifies the transparency level of the solid color overlay. Accepts integers + # from `1` to `9`. sig { returns(T.nilable(Float)) } attr_reader :alpha sig { params(alpha: Float).void } attr_writer :alpha - # Background color + # 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. sig { returns(T.nilable(String)) } attr_reader :background sig { params(background: String).void } attr_writer :background - # Gradient effect for the overlay - sig do - returns( - T.nilable( - T.any( - Imagekit::SolidColorOverlayTransformation::Gradient::OrBoolean, - String - ) - ) - ) - end + # 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). + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :gradient - sig do - params( - gradient: - T.any( - Imagekit::SolidColorOverlayTransformation::Gradient::OrBoolean, - String - ) - ).void - end + sig { params(gradient: T.any(T::Boolean, String)).void } attr_writer :gradient - # Height of the solid color overlay + # 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). sig do returns( T.nilable(Imagekit::SolidColorOverlayTransformation::Height::Variants) @@ -64,31 +54,18 @@ module Imagekit end attr_writer :height - # Corner radius of the solid color overlay - sig do - returns( - T.nilable( - T.any( - Float, - Imagekit::SolidColorOverlayTransformation::Radius::OrSymbol - ) - ) - ) - end + # 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). + sig { returns(T.nilable(T.any(Float, Symbol))) } attr_reader :radius - sig do - params( - radius: - T.any( - Float, - Imagekit::SolidColorOverlayTransformation::Radius::OrSymbol - ) - ).void - end + sig { params(radius: T.any(Float, Symbol)).void } attr_writer :radius - # Width of the solid color overlay + # 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). sig do returns( T.nilable(Imagekit::SolidColorOverlayTransformation::Width::Variants) @@ -107,32 +84,35 @@ module Imagekit params( alpha: Float, background: String, - gradient: - T.any( - Imagekit::SolidColorOverlayTransformation::Gradient::OrBoolean, - String - ), + gradient: T.any(T::Boolean, String), height: Imagekit::SolidColorOverlayTransformation::Height::Variants, - radius: - T.any( - Float, - Imagekit::SolidColorOverlayTransformation::Radius::OrSymbol - ), + radius: T.any(Float, Symbol), width: Imagekit::SolidColorOverlayTransformation::Width::Variants ).returns(T.attached_class) end def self.new( - # Alpha transparency level + # Specifies the transparency level of the solid color overlay. Accepts integers + # from `1` to `9`. alpha: nil, - # Background color + # 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. background: nil, - # Gradient effect for the overlay + # 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). gradient: nil, - # Height of the solid color overlay + # 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). height: nil, - # Corner radius of the solid color overlay + # 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). radius: nil, - # Width of the solid color overlay + # 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). width: nil ) end @@ -142,17 +122,9 @@ module Imagekit { alpha: Float, background: String, - gradient: - T.any( - Imagekit::SolidColorOverlayTransformation::Gradient::OrBoolean, - String - ), + gradient: T.any(T::Boolean, String), height: Imagekit::SolidColorOverlayTransformation::Height::Variants, - radius: - T.any( - Float, - Imagekit::SolidColorOverlayTransformation::Radius::OrSymbol - ), + radius: T.any(Float, Symbol), width: Imagekit::SolidColorOverlayTransformation::Width::Variants } ) @@ -160,17 +132,14 @@ module Imagekit def to_hash end - # Gradient effect for the overlay + # 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). module Gradient extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any( - Imagekit::SolidColorOverlayTransformation::Gradient::TaggedBoolean, - String - ) - end + Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns( @@ -181,24 +150,11 @@ module Imagekit end def self.variants end - - TaggedBoolean = - T.type_alias do - T.all( - T::Boolean, - Imagekit::SolidColorOverlayTransformation::Gradient - ) - end - OrBoolean = T.type_alias { T::Boolean } - - TRUE = - T.let( - true, - Imagekit::SolidColorOverlayTransformation::Gradient::TaggedBoolean - ) end - # Height of the solid color overlay + # 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). module Height extend Imagekit::Internal::Type::Union @@ -215,17 +171,13 @@ module Imagekit end end - # Corner radius of the solid color overlay + # 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). module Radius extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any( - Float, - Imagekit::SolidColorOverlayTransformation::Radius::TaggedSymbol - ) - end + Variants = T.type_alias { T.any(Float, Symbol) } sig do override.returns( @@ -236,21 +188,11 @@ module Imagekit end def self.variants end - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::SolidColorOverlayTransformation::Radius) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - MAX = - T.let( - :max, - Imagekit::SolidColorOverlayTransformation::Radius::TaggedSymbol - ) end - # Width of the solid color overlay + # 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). module Width extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/src_options.rbi b/rbi/imagekit/models/src_options.rbi index 99580e3a..9e03f135 100644 --- a/rbi/imagekit/models/src_options.rbi +++ b/rbi/imagekit/models/src_options.rbi @@ -30,7 +30,8 @@ module Imagekit # 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. + # are specified as chained transformations. See + # [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations). sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } attr_reader :transformation @@ -41,7 +42,8 @@ module Imagekit # 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`. + # path of the URL, set this to `path`. Learn more in the + # [Transformations guide](https://imagekit.io/docs/transformations). sig { returns(T.nilable(Imagekit::TransformationPosition::OrSymbol)) } attr_reader :transformation_position @@ -52,7 +54,8 @@ module Imagekit end attr_writer :transformation_position - # Options for generating ImageKit URLs with transformations + # Options for generating ImageKit URLs with transformations. See the + # [Transformations guide](https://imagekit.io/docs/transformations). sig do params( src: String, @@ -76,11 +79,13 @@ module Imagekit query_parameters: nil, # 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. + # are specified as chained transformations. See + # [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations). transformation: nil, # 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`. + # path of the URL, set this to `path`. Learn more in the + # [Transformations guide](https://imagekit.io/docs/transformations). transformation_position: nil ) end diff --git a/rbi/imagekit/models/streaming_resolution.rbi b/rbi/imagekit/models/streaming_resolution.rbi index 41bd7f5d..d64a122e 100644 --- a/rbi/imagekit/models/streaming_resolution.rbi +++ b/rbi/imagekit/models/streaming_resolution.rbi @@ -2,7 +2,8 @@ module Imagekit module Models - # Available streaming resolutions for adaptive bitrate streaming + # Available streaming resolutions for + # [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming) module StreamingResolution extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/models/subtitle_overlay.rbi b/rbi/imagekit/models/subtitle_overlay.rbi index 909ddf47..baa166f0 100644 --- a/rbi/imagekit/models/subtitle_overlay.rbi +++ b/rbi/imagekit/models/subtitle_overlay.rbi @@ -12,7 +12,7 @@ module Imagekit sig { returns(String) } attr_accessor :input - sig { returns(Imagekit::SubtitleOverlay::Type::OrSymbol) } + sig { returns(Symbol) } attr_accessor :type # The input path can be included in the layer as either `i-{input}` or @@ -28,7 +28,8 @@ module Imagekit end attr_writer :encoding - # Control styling of the subtitle. + # Control styling of the subtitle. See + # [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer). sig do returns(T.nilable(T::Array[Imagekit::SubtitleOverlayTransformation])) end @@ -45,24 +46,25 @@ module Imagekit sig do params( input: String, - type: Imagekit::SubtitleOverlay::Type::OrSymbol, encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol, transformation: - T::Array[Imagekit::SubtitleOverlayTransformation::OrHash] + T::Array[Imagekit::SubtitleOverlayTransformation::OrHash], + type: Symbol ).returns(T.attached_class) end def self.new( # Specifies the relative path to the subtitle file used as an overlay. input:, - type:, # 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`. encoding: nil, - # Control styling of the subtitle. - transformation: nil + # Control styling of the subtitle. See + # [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer). + transformation: nil, + type: :subtitle ) end @@ -70,7 +72,7 @@ module Imagekit override.returns( { input: String, - type: Imagekit::SubtitleOverlay::Type::OrSymbol, + type: Symbol, encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol, transformation: T::Array[Imagekit::SubtitleOverlayTransformation] } @@ -79,25 +81,6 @@ module Imagekit def to_hash end - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::SubtitleOverlay::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SUBTITLE = - T.let(:subtitle, Imagekit::SubtitleOverlay::Type::TaggedSymbol) - - sig do - override.returns( - T::Array[Imagekit::SubtitleOverlay::Type::TaggedSymbol] - ) - end - def self.values - end - end - # 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 diff --git a/rbi/imagekit/models/subtitle_overlay_transformation.rbi b/rbi/imagekit/models/subtitle_overlay_transformation.rbi index 01341381..3ad34a2b 100644 --- a/rbi/imagekit/models/subtitle_overlay_transformation.rbi +++ b/rbi/imagekit/models/subtitle_overlay_transformation.rbi @@ -11,57 +11,74 @@ module Imagekit ) end - # Background color for subtitles + # 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) sig { returns(T.nilable(String)) } attr_reader :background sig { params(background: String).void } attr_writer :background - # Text color for subtitles + # 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) sig { returns(T.nilable(String)) } attr_reader :color sig { params(color: String).void } attr_writer :color - # Font family for subtitles + # Font family for subtitles. Refer to the + # [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list). sig { returns(T.nilable(String)) } attr_reader :font_family sig { params(font_family: String).void } attr_writer :font_family - # Font outline for subtitles + # 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) sig { returns(T.nilable(String)) } attr_reader :font_outline sig { params(font_outline: String).void } attr_writer :font_outline - # Font shadow for subtitles + # 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) sig { returns(T.nilable(String)) } attr_reader :font_shadow sig { params(font_shadow: String).void } attr_writer :font_shadow - # Font size for subtitles - sig do - returns( - T.nilable(Imagekit::SubtitleOverlayTransformation::FontSize::Variants) - ) - end + # Sets the font size of subtitle text. + # + # [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + sig { returns(T.nilable(Float)) } attr_reader :font_size - sig do - params( - font_size: Imagekit::SubtitleOverlayTransformation::FontSize::Variants - ).void - end + sig { params(font_size: Float).void } attr_writer :font_size - # Typography style for subtitles + # 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) sig do returns( T.nilable( @@ -79,6 +96,9 @@ module Imagekit end attr_writer :typography + # Subtitle styling options. + # [Learn more](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + # from the docs. sig do params( background: String, @@ -86,26 +106,50 @@ module Imagekit font_family: String, font_outline: String, font_shadow: String, - font_size: - Imagekit::SubtitleOverlayTransformation::FontSize::Variants, + font_size: Float, typography: Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol ).returns(T.attached_class) end def self.new( - # Background color for subtitles + # 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) background: nil, - # Text color for subtitles + # 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) color: nil, - # Font family for subtitles + # Font family for subtitles. Refer to the + # [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list). font_family: nil, - # Font outline for subtitles + # 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) font_outline: nil, - # Font shadow for subtitles + # 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) font_shadow: nil, - # Font size for subtitles + # Sets the font size of subtitle text. + # + # [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) font_size: nil, - # Typography style for subtitles + # 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) typography: nil ) end @@ -118,8 +162,7 @@ module Imagekit font_family: String, font_outline: String, font_shadow: String, - font_size: - Imagekit::SubtitleOverlayTransformation::FontSize::Variants, + font_size: Float, typography: Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol } @@ -128,24 +171,10 @@ module Imagekit def to_hash end - # Font size for subtitles - module FontSize - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(Float, String) } - - sig do - override.returns( - T::Array[ - Imagekit::SubtitleOverlayTransformation::FontSize::Variants - ] - ) - end - def self.variants - end - end - - # Typography style for subtitles + # 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) module Typography extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/models/text_overlay.rbi b/rbi/imagekit/models/text_overlay.rbi index 35bf6c07..9ee9cb98 100644 --- a/rbi/imagekit/models/text_overlay.rbi +++ b/rbi/imagekit/models/text_overlay.rbi @@ -13,7 +13,7 @@ module Imagekit sig { returns(String) } attr_accessor :text - sig { returns(Imagekit::TextOverlay::Type::OrSymbol) } + sig { returns(Symbol) } attr_accessor :type # Text can be included in the layer as either `i-{input}` (plain text) or @@ -27,7 +27,8 @@ module Imagekit sig { params(encoding: Imagekit::TextOverlay::Encoding::OrSymbol).void } attr_writer :encoding - # Control styling of the text overlay. + # Control styling of the text overlay. See + # [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay). sig { returns(T.nilable(T::Array[Imagekit::TextOverlayTransformation])) } attr_reader :transformation @@ -41,24 +42,25 @@ module Imagekit sig do params( text: String, - type: Imagekit::TextOverlay::Type::OrSymbol, encoding: Imagekit::TextOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::TextOverlayTransformation::OrHash] + transformation: T::Array[Imagekit::TextOverlayTransformation::OrHash], + type: Symbol ).returns(T.attached_class) end def self.new( # Specifies the text to be displayed in the overlay. The SDK automatically handles # special characters and encoding. text:, - type:, # 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`. encoding: nil, - # Control styling of the text overlay. - transformation: nil + # Control styling of the text overlay. See + # [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay). + transformation: nil, + type: :text ) end @@ -66,7 +68,7 @@ module Imagekit override.returns( { text: String, - type: Imagekit::TextOverlay::Type::OrSymbol, + type: Symbol, encoding: Imagekit::TextOverlay::Encoding::OrSymbol, transformation: T::Array[Imagekit::TextOverlayTransformation] } @@ -75,22 +77,6 @@ module Imagekit def to_hash end - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::TextOverlay::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TEXT = T.let(:text, Imagekit::TextOverlay::Type::TaggedSymbol) - - sig do - override.returns(T::Array[Imagekit::TextOverlay::Type::TaggedSymbol]) - end - def self.values - end - end - # 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 diff --git a/rbi/imagekit/models/text_overlay_transformation.rbi b/rbi/imagekit/models/text_overlay_transformation.rbi index f33ac2f1..a2ea165d 100644 --- a/rbi/imagekit/models/text_overlay_transformation.rbi +++ b/rbi/imagekit/models/text_overlay_transformation.rbi @@ -47,7 +47,10 @@ module Imagekit attr_writer :font_color # Specifies the font family of the overlaid text. Choose from the supported fonts - # list or use a custom font. + # 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). sig { returns(T.nilable(String)) } attr_reader :font_family @@ -89,7 +92,10 @@ module Imagekit end attr_writer :inner_alignment - # Specifies the line height of the text overlay. + # 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`. sig do returns( T.nilable(Imagekit::TextOverlayTransformation::LineHeight::Variants) @@ -123,21 +129,10 @@ module Imagekit # Specifies the corner radius of the text overlay. Set to `max` to achieve a # circular or oval shape. - sig do - returns( - T.nilable( - T.any(Float, Imagekit::TextOverlayTransformation::Radius::OrSymbol) - ) - ) - end + sig { returns(T.nilable(T.any(Float, Symbol))) } attr_reader :radius - sig do - params( - radius: - T.any(Float, Imagekit::TextOverlayTransformation::Radius::OrSymbol) - ).void - end + sig { params(radius: T.any(Float, Symbol)).void } attr_writer :radius # Specifies the rotation angle of the text overlay. Accepts a numeric value for @@ -156,25 +151,21 @@ module Imagekit end attr_writer :rotation - # Specifies the typography style of the text. Supported values: `b` for bold, `i` - # for italics, and `b_i` for bold with italics. - sig do - returns( - T.nilable(Imagekit::TextOverlayTransformation::Typography::OrSymbol) - ) - end + # 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`. + sig { returns(T.nilable(String)) } attr_reader :typography - sig do - params( - typography: Imagekit::TextOverlayTransformation::Typography::OrSymbol - ).void - end + sig { params(typography: String).void } attr_writer :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`. + # supported. Useful when used in conjunction with the `background`. Learn about + # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). sig do returns(T.nilable(Imagekit::TextOverlayTransformation::Width::Variants)) end @@ -198,10 +189,9 @@ module Imagekit line_height: Imagekit::TextOverlayTransformation::LineHeight::Variants, padding: Imagekit::TextOverlayTransformation::Padding::Variants, - radius: - T.any(Float, Imagekit::TextOverlayTransformation::Radius::OrSymbol), + radius: T.any(Float, Symbol), rotation: Imagekit::TextOverlayTransformation::Rotation::Variants, - typography: Imagekit::TextOverlayTransformation::Typography::OrSymbol, + typography: String, width: Imagekit::TextOverlayTransformation::Width::Variants ).returns(T.attached_class) end @@ -218,7 +208,10 @@ module Imagekit # `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name. font_color: nil, # Specifies the font family of the overlaid text. Choose from the supported fonts - # list or use a custom font. + # 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). font_family: nil, # Specifies the font size of the overlaid text. Accepts a numeric value or an # arithmetic expression. @@ -226,7 +219,10 @@ module Imagekit # Specifies the inner alignment of the text when width is more than the text # length. inner_alignment: nil, - # Specifies the line height of the text overlay. + # 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`. line_height: nil, # Specifies the padding around the overlaid text. Can be provided as a single # positive integer or multiple values separated by underscores (following CSS @@ -238,12 +234,16 @@ module Imagekit # 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. rotation: nil, - # Specifies the typography style of the text. Supported values: `b` for bold, `i` - # for italics, and `b_i` for bold with italics. + # 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`. typography: nil, # 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`. + # supported. Useful when used in conjunction with the `background`. Learn about + # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). width: nil ) end @@ -262,14 +262,9 @@ module Imagekit line_height: Imagekit::TextOverlayTransformation::LineHeight::Variants, padding: Imagekit::TextOverlayTransformation::Padding::Variants, - radius: - T.any( - Float, - Imagekit::TextOverlayTransformation::Radius::OrSymbol - ), + radius: T.any(Float, Symbol), rotation: Imagekit::TextOverlayTransformation::Rotation::Variants, - typography: - Imagekit::TextOverlayTransformation::Typography::OrSymbol, + typography: String, width: Imagekit::TextOverlayTransformation::Width::Variants } ) @@ -357,7 +352,10 @@ module Imagekit end end - # Specifies the line height of the text overlay. + # 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`. module LineHeight extend Imagekit::Internal::Type::Union @@ -394,13 +392,7 @@ module Imagekit module Radius extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any( - Float, - Imagekit::TextOverlayTransformation::Radius::TaggedSymbol - ) - end + Variants = T.type_alias { T.any(Float, Symbol) } sig do override.returns( @@ -409,15 +401,6 @@ module Imagekit end def self.variants end - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::TextOverlayTransformation::Radius) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - MAX = - T.let(:max, Imagekit::TextOverlayTransformation::Radius::TaggedSymbol) end # Specifies the rotation angle of the text overlay. Accepts a numeric value for @@ -436,47 +419,10 @@ module Imagekit end end - # Specifies the typography style of the text. Supported values: `b` for bold, `i` - # for italics, and `b_i` for bold with italics. - module Typography - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Imagekit::TextOverlayTransformation::Typography) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - B = - T.let( - :b, - Imagekit::TextOverlayTransformation::Typography::TaggedSymbol - ) - I = - T.let( - :i, - Imagekit::TextOverlayTransformation::Typography::TaggedSymbol - ) - B_I = - T.let( - :b_i, - Imagekit::TextOverlayTransformation::Typography::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::TextOverlayTransformation::Typography::TaggedSymbol - ] - ) - end - def self.values - end - end - # 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`. + # supported. Useful when used in conjunction with the `background`. Learn about + # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). module Width extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/transformation.rbi b/rbi/imagekit/models/transformation.rbi index f36c78ff..2c0f7137 100644 --- a/rbi/imagekit/models/transformation.rbi +++ b/rbi/imagekit/models/transformation.rbi @@ -10,7 +10,8 @@ module Imagekit # 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. + # Not supported inside overlay. See + # [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg). sig { returns(T.nilable(String)) } attr_reader :ai_change_background @@ -21,25 +22,26 @@ module Imagekit # 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. - sig do - returns( - T.nilable( - T.any(Imagekit::Transformation::AIDropShadow::OrBoolean, String) - ) - ) - end + # inside overlay. See + # [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :ai_drop_shadow - sig do - params( - ai_drop_shadow: - T.any(Imagekit::Transformation::AIDropShadow::OrBoolean, String) - ).void - end + sig { params(ai_drop_shadow: T.any(T::Boolean, String)).void } attr_writer :ai_drop_shadow - # Applies ImageKit's in-house background removal. Supported inside overlay. + # 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). + sig { returns(T.nilable(String)) } + attr_reader :ai_edit + + sig { params(ai_edit: String).void } + attr_writer :ai_edit + + # 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). sig do returns( T.nilable(Imagekit::Transformation::AIRemoveBackground::OrBoolean) @@ -57,7 +59,8 @@ module Imagekit # 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. + # Supported inside overlay. See + # [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). sig do returns( T.nilable( @@ -76,7 +79,8 @@ module Imagekit attr_writer :ai_remove_background_external # Performs AI-based retouching to improve faces or product shots. Not supported - # inside overlay. + # inside overlay. See + # [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). sig { returns(T.nilable(Imagekit::Transformation::AIRetouch::OrBoolean)) } attr_reader :ai_retouch @@ -86,7 +90,8 @@ module Imagekit attr_writer :ai_retouch # Upscales images beyond their original dimensions using AI. Not supported inside - # overlay. + # overlay. See + # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). sig { returns(T.nilable(Imagekit::Transformation::AIUpscale::OrBoolean)) } attr_reader :ai_upscale @@ -98,7 +103,8 @@ module Imagekit # 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. + # original image. Not supported inside overlay. See + # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). sig do returns(T.nilable(Imagekit::Transformation::AIVariation::OrBoolean)) end @@ -113,7 +119,8 @@ module Imagekit # 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`. + # 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). sig do returns(T.nilable(Imagekit::Transformation::AspectRatio::Variants)) end @@ -126,7 +133,8 @@ module Imagekit end attr_writer :aspect_ratio - # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See + # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). sig { returns(T.nilable(Imagekit::Transformation::AudioCodec::OrSymbol)) } attr_reader :audio_codec @@ -138,12 +146,15 @@ module Imagekit # Specifies the background to be used in conjunction with certain cropping # strategies when resizing an image. # - # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. - # - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. + # - 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}]`. + # `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See + # [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill). sig { returns(T.nilable(String)) } attr_reader :background @@ -151,7 +162,8 @@ module Imagekit attr_writer :background # Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, - # or an expression like `bl-10`. + # or an expression like `bl-10`. See + # [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl). sig { returns(T.nilable(Float)) } attr_reader :blur @@ -160,21 +172,24 @@ module Imagekit # 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`. + # expression like `ih_div_20_FF00FF`. See + # [Border](https://imagekit.io/docs/effects-and-enhancements#border---b). sig { returns(T.nilable(String)) } attr_reader :border sig { params(border: String).void } attr_writer :border - # Indicates whether the output image should retain the original color profile. + # Indicates whether the output image should retain the original color profile. See + # [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp). sig { returns(T.nilable(T::Boolean)) } attr_reader :color_profile sig { params(color_profile: T::Boolean).void } attr_writer :color_profile - # Automatically enhances the contrast of an image (contrast stretch). + # Automatically enhances the contrast of an image (contrast stretch). See + # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). sig do returns(T.nilable(Imagekit::Transformation::ContrastStretch::OrBoolean)) end @@ -187,14 +202,16 @@ module Imagekit end attr_writer :contrast_stretch - # Crop modes for image resizing + # Crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). sig { returns(T.nilable(Imagekit::Transformation::Crop::OrSymbol)) } attr_reader :crop sig { params(crop: Imagekit::Transformation::Crop::OrSymbol).void } attr_writer :crop - # Additional crop modes for image resizing + # Additional crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). sig { returns(T.nilable(Imagekit::Transformation::CropMode::OrSymbol)) } attr_reader :crop_mode @@ -204,7 +221,8 @@ module Imagekit attr_writer :crop_mode # Specifies a fallback image if the resource is not found, e.g., a URL or file - # path. + # path. See + # [Default image](https://imagekit.io/docs/image-transformation#default-image---di). sig { returns(T.nilable(String)) } attr_reader :default_image @@ -212,7 +230,8 @@ module Imagekit attr_writer :default_image # Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio - # (DPR) calculation. + # (DPR) calculation. See + # [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr). sig { returns(T.nilable(Float)) } attr_reader :dpr @@ -221,7 +240,8 @@ module Imagekit # 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. + # Arithmetic expressions are supported. See + # [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). sig { returns(T.nilable(Imagekit::Transformation::Duration::Variants)) } attr_reader :duration @@ -232,7 +252,8 @@ module Imagekit # 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. + # are supported. See + # [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). sig { returns(T.nilable(Imagekit::Transformation::EndOffset::Variants)) } attr_reader :end_offset @@ -243,15 +264,21 @@ module Imagekit # Flips or mirrors an image either horizontally, vertically, or both. Acceptable # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or - # `v_h`. + # `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). sig { returns(T.nilable(Imagekit::Transformation::Flip::OrSymbol)) } attr_reader :flip sig { params(flip: Imagekit::Transformation::Flip::OrSymbol).void } attr_writer :flip - # This parameter can be used with pad resize, maintain ratio, or extract crop to - # modify the padding or cropping behavior. + # 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) sig { returns(T.nilable(String)) } attr_reader :focus @@ -262,7 +289,9 @@ module Imagekit # `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. + # format parameter. See + # [Image format](https://imagekit.io/docs/image-optimization#format---f) and + # [Video format](https://imagekit.io/docs/video-optimization#format---f). sig { returns(T.nilable(Imagekit::Transformation::Format::OrSymbol)) } attr_reader :format_ @@ -270,24 +299,16 @@ module Imagekit attr_writer :format_ # Creates a linear gradient with two colors. Pass `true` for a default gradient, - # or provide a string for a custom gradient. - sig do - returns( - T.nilable( - T.any(Imagekit::Transformation::Gradient::OrBoolean, String) - ) - ) - end + # or provide a string for a custom gradient. See + # [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :gradient - sig do - params( - gradient: T.any(Imagekit::Transformation::Gradient::OrBoolean, String) - ).void - end + sig { params(gradient: T.any(T::Boolean, String)).void } attr_writer :gradient - # Enables a grayscale effect for images. + # Enables a grayscale effect for images. See + # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). sig { returns(T.nilable(Imagekit::Transformation::Grayscale::OrBoolean)) } attr_reader :grayscale @@ -298,7 +319,10 @@ module Imagekit # 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`). + # 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) sig { returns(T.nilable(Imagekit::Transformation::Height::Variants)) } attr_reader :height @@ -306,7 +330,8 @@ module Imagekit attr_writer :height # Specifies whether the output image (in JPEG or PNG) should be compressed - # losslessly. + # losslessly. See + # [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo). sig { returns(T.nilable(T::Boolean)) } attr_reader :lossless @@ -314,21 +339,24 @@ module Imagekit attr_writer :lossless # By default, ImageKit removes all metadata during automatic image compression. - # Set this to true to preserve metadata. + # Set this to true to preserve metadata. See + # [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md). sig { returns(T.nilable(T::Boolean)) } attr_reader :metadata sig { params(metadata: T::Boolean).void } attr_writer :metadata - # Named transformation reference + # Named transformation reference. See + # [Named transformations](https://imagekit.io/docs/transformations#named-transformations). sig { returns(T.nilable(String)) } attr_reader :named sig { params(named: String).void } attr_writer :named - # Specifies the opacity level of the output image. + # Specifies the opacity level of the output image. See + # [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o). sig { returns(T.nilable(Float)) } attr_reader :opacity @@ -336,6 +364,8 @@ module Imagekit attr_writer :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). sig { returns(T.nilable(T::Boolean)) } attr_reader :original @@ -344,6 +374,8 @@ module Imagekit # 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). sig { returns(T.nilable(Imagekit::Overlay)) } attr_reader :overlay @@ -352,7 +384,8 @@ module Imagekit # 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). + # 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). sig { returns(T.nilable(Imagekit::Transformation::Page::Variants)) } attr_reader :page @@ -361,7 +394,8 @@ module Imagekit # 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. + # image, which gradually improves to provide a faster perceived load time. See + # [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr). sig { returns(T.nilable(T::Boolean)) } attr_reader :progressive @@ -371,26 +405,20 @@ module Imagekit # 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). sig { returns(T.nilable(Float)) } attr_reader :quality sig { params(quality: Float).void } attr_writer :quality - # Specifies the corner radius for rounded corners (e.g., 20) or `max` for - # circular/oval shapes. - sig do - returns( - T.nilable(T.any(Float, Imagekit::Transformation::Radius::OrSymbol)) - ) - end + # 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). + sig { returns(T.nilable(T.any(Float, Symbol))) } attr_reader :radius - sig do - params( - radius: T.any(Float, Imagekit::Transformation::Radius::OrSymbol) - ).void - end + sig { params(radius: T.any(Float, Symbol)).void } attr_writer :radius # Pass any transformation not directly supported by the SDK. This transformation @@ -404,7 +432,8 @@ module Imagekit # 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. + # only the following values are supported: 0, 90, 180, 270, or 360. See + # [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). sig { returns(T.nilable(Imagekit::Transformation::Rotation::Variants)) } attr_reader :rotation @@ -415,39 +444,26 @@ module Imagekit # 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. - sig do - returns( - T.nilable(T.any(Imagekit::Transformation::Shadow::OrBoolean, String)) - ) - end + # shadow, or provide a string for a custom shadow. See + # [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :shadow - sig do - params( - shadow: T.any(Imagekit::Transformation::Shadow::OrBoolean, String) - ).void - end + sig { params(shadow: T.any(T::Boolean, String)).void } attr_writer :shadow # Sharpens the input image, highlighting edges and finer details. Pass `true` for - # default sharpening, or provide a numeric value for custom sharpening. - sig do - returns( - T.nilable(T.any(Imagekit::Transformation::Sharpen::OrBoolean, Float)) - ) - end + # default sharpening, or provide a numeric value for custom sharpening. See + # [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). + sig { returns(T.nilable(T.any(T::Boolean, Float))) } attr_reader :sharpen - sig do - params( - sharpen: T.any(Imagekit::Transformation::Sharpen::OrBoolean, Float) - ).void - end + sig { params(sharpen: T.any(T::Boolean, Float)).void } attr_writer :sharpen # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or - # `10.5`. Arithmetic expressions are also supported. + # `10.5`. Arithmetic expressions are also supported. See + # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). sig do returns(T.nilable(Imagekit::Transformation::StartOffset::Variants)) end @@ -461,7 +477,8 @@ module Imagekit attr_writer :start_offset # An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, - # `480`, `720`, `1080`]. + # `480`, `720`, `1080`]. See + # [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). sig do returns(T.nilable(T::Array[Imagekit::StreamingResolution::OrSymbol])) end @@ -477,41 +494,25 @@ module Imagekit # 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. - sig do - returns( - T.nilable(T.any(Imagekit::Transformation::Trim::OrBoolean, Float)) - ) - end + # output image. See + # [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). + sig { returns(T.nilable(T.any(T::Boolean, Float))) } attr_reader :trim - sig do - params( - trim: T.any(Imagekit::Transformation::Trim::OrBoolean, Float) - ).void - end + sig { params(trim: T.any(T::Boolean, Float)).void } attr_writer :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. - sig do - returns( - T.nilable( - T.any(Imagekit::Transformation::UnsharpMask::OrBoolean, String) - ) - ) - end + # 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). + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :unsharp_mask - sig do - params( - unsharp_mask: - T.any(Imagekit::Transformation::UnsharpMask::OrBoolean, String) - ).void - end + sig { params(unsharp_mask: T.any(T::Boolean, String)).void } attr_writer :unsharp_mask - # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See + # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). sig { returns(T.nilable(Imagekit::Transformation::VideoCodec::OrSymbol)) } attr_reader :video_codec @@ -522,35 +523,41 @@ module Imagekit # 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`). + # 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) sig { returns(T.nilable(Imagekit::Transformation::Width::Variants)) } attr_reader :width sig { params(width: Imagekit::Transformation::Width::Variants).void } attr_writer :width - # Focus using cropped image coordinates - X coordinate + # 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). sig { returns(T.nilable(Imagekit::Transformation::X::Variants)) } attr_reader :x sig { params(x: Imagekit::Transformation::X::Variants).void } attr_writer :x - # Focus using cropped image coordinates - X center coordinate + # 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). sig { returns(T.nilable(Imagekit::Transformation::XCenter::Variants)) } attr_reader :x_center sig { params(x_center: Imagekit::Transformation::XCenter::Variants).void } attr_writer :x_center - # Focus using cropped image coordinates - Y coordinate + # 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). sig { returns(T.nilable(Imagekit::Transformation::Y::Variants)) } attr_reader :y_ sig { params(y_: Imagekit::Transformation::Y::Variants).void } attr_writer :y_ - # Focus using cropped image coordinates - Y center coordinate + # 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). sig { returns(T.nilable(Imagekit::Transformation::YCenter::Variants)) } attr_reader :y_center @@ -559,6 +566,7 @@ module Imagekit # 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). sig { returns(T.nilable(Float)) } attr_reader :zoom @@ -569,12 +577,13 @@ module Imagekit # converted to the corresponding transformation string before being added to the # URL. SDKs are updated regularly to support new transformations. If you want to # use a transformation that is not supported by the SDK, You can use the `raw` - # parameter to pass the transformation string directly. + # parameter to pass the transformation string directly. See the + # [Transformations documentation](https://imagekit.io/docs/transformations). sig do params( ai_change_background: String, - ai_drop_shadow: - T.any(Imagekit::Transformation::AIDropShadow::OrBoolean, String), + ai_drop_shadow: T.any(T::Boolean, String), + ai_edit: String, ai_remove_background: Imagekit::Transformation::AIRemoveBackground::OrBoolean, ai_remove_background_external: @@ -599,8 +608,7 @@ module Imagekit flip: Imagekit::Transformation::Flip::OrSymbol, focus: String, format_: Imagekit::Transformation::Format::OrSymbol, - gradient: - T.any(Imagekit::Transformation::Gradient::OrBoolean, String), + gradient: T.any(T::Boolean, String), grayscale: Imagekit::Transformation::Grayscale::OrBoolean, height: Imagekit::Transformation::Height::Variants, lossless: T::Boolean, @@ -612,17 +620,16 @@ module Imagekit page: Imagekit::Transformation::Page::Variants, progressive: T::Boolean, quality: Float, - radius: T.any(Float, Imagekit::Transformation::Radius::OrSymbol), + radius: T.any(Float, Symbol), raw: String, rotation: Imagekit::Transformation::Rotation::Variants, - shadow: T.any(Imagekit::Transformation::Shadow::OrBoolean, String), - sharpen: T.any(Imagekit::Transformation::Sharpen::OrBoolean, Float), + shadow: T.any(T::Boolean, String), + sharpen: T.any(T::Boolean, Float), start_offset: Imagekit::Transformation::StartOffset::Variants, streaming_resolutions: T::Array[Imagekit::StreamingResolution::OrSymbol], - trim: T.any(Imagekit::Transformation::Trim::OrBoolean, Float), - unsharp_mask: - T.any(Imagekit::Transformation::UnsharpMask::OrBoolean, String), + trim: T.any(T::Boolean, Float), + unsharp_mask: T.any(T::Boolean, String), video_codec: Imagekit::Transformation::VideoCodec::OrSymbol, width: Imagekit::Transformation::Width::Variants, x: Imagekit::Transformation::X::Variants, @@ -635,127 +642,179 @@ module Imagekit def self.new( # 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. + # Not supported inside overlay. See + # [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg). ai_change_background: nil, # 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. + # inside overlay. See + # [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). ai_drop_shadow: nil, - # Applies ImageKit's in-house background removal. Supported inside overlay. + # 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). + ai_edit: nil, + # 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). ai_remove_background: nil, # 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. + # Supported inside overlay. See + # [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). ai_remove_background_external: nil, # Performs AI-based retouching to improve faces or product shots. Not supported - # inside overlay. + # inside overlay. See + # [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). ai_retouch: nil, # Upscales images beyond their original dimensions using AI. Not supported inside - # overlay. + # overlay. See + # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). ai_upscale: nil, # 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. + # original image. Not supported inside overlay. See + # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). ai_variation: nil, # 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`. + # 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). aspect_ratio: nil, - # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See + # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). audio_codec: nil, # Specifies the background to be used in conjunction with certain cropping # strategies when resizing an image. # - # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. - # - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. + # - 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}]`. + # `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See + # [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill). background: nil, # Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, - # or an expression like `bl-10`. + # or an expression like `bl-10`. See + # [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl). blur: nil, # 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`. + # expression like `ih_div_20_FF00FF`. See + # [Border](https://imagekit.io/docs/effects-and-enhancements#border---b). border: nil, - # Indicates whether the output image should retain the original color profile. + # Indicates whether the output image should retain the original color profile. See + # [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp). color_profile: nil, - # Automatically enhances the contrast of an image (contrast stretch). + # Automatically enhances the contrast of an image (contrast stretch). See + # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). contrast_stretch: nil, - # Crop modes for image resizing + # Crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). crop: nil, - # Additional crop modes for image resizing + # Additional crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). crop_mode: nil, # Specifies a fallback image if the resource is not found, e.g., a URL or file - # path. + # path. See + # [Default image](https://imagekit.io/docs/image-transformation#default-image---di). default_image: nil, # Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio - # (DPR) calculation. + # (DPR) calculation. See + # [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr). dpr: nil, # 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. + # Arithmetic expressions are supported. See + # [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). duration: nil, # 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. + # are supported. See + # [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). end_offset: nil, # Flips or mirrors an image either horizontally, vertically, or both. Acceptable # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or - # `v_h`. + # `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). flip: nil, - # This parameter can be used with pad resize, maintain ratio, or extract crop to - # modify the padding or cropping behavior. + # 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) focus: nil, # 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. + # format parameter. See + # [Image format](https://imagekit.io/docs/image-optimization#format---f) and + # [Video format](https://imagekit.io/docs/video-optimization#format---f). format_: nil, # Creates a linear gradient with two colors. Pass `true` for a default gradient, - # or provide a string for a custom gradient. + # or provide a string for a custom gradient. See + # [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). gradient: nil, - # Enables a grayscale effect for images. + # Enables a grayscale effect for images. See + # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). grayscale: nil, # 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`). + # 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) height: nil, # Specifies whether the output image (in JPEG or PNG) should be compressed - # losslessly. + # losslessly. See + # [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo). lossless: nil, # By default, ImageKit removes all metadata during automatic image compression. - # Set this to true to preserve metadata. + # Set this to true to preserve metadata. See + # [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md). metadata: nil, - # Named transformation reference + # Named transformation reference. See + # [Named transformations](https://imagekit.io/docs/transformations#named-transformations). named: nil, - # Specifies the opacity level of the output image. + # Specifies the opacity level of the output image. See + # [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o). opacity: nil, # 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). original: nil, # 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). overlay: nil, # 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). + # 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). page: nil, # 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. + # image, which gradually improves to provide a faster perceived load time. See + # [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr). progressive: nil, # 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). quality: nil, - # Specifies the corner radius for rounded corners (e.g., 20) or `max` for - # circular/oval shapes. + # 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). radius: nil, # Pass any transformation not directly supported by the SDK. This transformation # string is appended to the URL as provided. @@ -763,44 +822,59 @@ module Imagekit # 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. + # only the following values are supported: 0, 90, 180, 270, or 360. See + # [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). rotation: nil, # 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. + # shadow, or provide a string for a custom shadow. See + # [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). shadow: nil, # Sharpens the input image, highlighting edges and finer details. Pass `true` for - # default sharpening, or provide a numeric value for custom sharpening. + # default sharpening, or provide a numeric value for custom sharpening. See + # [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). sharpen: nil, # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or - # `10.5`. Arithmetic expressions are also supported. + # `10.5`. Arithmetic expressions are also supported. See + # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). start_offset: nil, # An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, - # `480`, `720`, `1080`]. + # `480`, `720`, `1080`]. See + # [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). streaming_resolutions: nil, # 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. + # output image. See + # [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). trim: nil, # Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a - # default unsharp mask, or provide a string for a custom unsharp mask. + # 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). unsharp_mask: nil, - # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See + # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). video_codec: nil, # 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`). + # 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) width: nil, - # Focus using cropped image coordinates - X coordinate + # 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). x: nil, - # Focus using cropped image coordinates - X center coordinate + # 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). x_center: nil, - # Focus using cropped image coordinates - Y coordinate + # 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). y_: nil, - # Focus using cropped image coordinates - Y center coordinate + # 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). y_center: nil, # 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). zoom: nil ) end @@ -809,8 +883,8 @@ module Imagekit override.returns( { ai_change_background: String, - ai_drop_shadow: - T.any(Imagekit::Transformation::AIDropShadow::OrBoolean, String), + ai_drop_shadow: T.any(T::Boolean, String), + ai_edit: String, ai_remove_background: Imagekit::Transformation::AIRemoveBackground::OrBoolean, ai_remove_background_external: @@ -835,8 +909,7 @@ module Imagekit flip: Imagekit::Transformation::Flip::OrSymbol, focus: String, format_: Imagekit::Transformation::Format::OrSymbol, - gradient: - T.any(Imagekit::Transformation::Gradient::OrBoolean, String), + gradient: T.any(T::Boolean, String), grayscale: Imagekit::Transformation::Grayscale::OrBoolean, height: Imagekit::Transformation::Height::Variants, lossless: T::Boolean, @@ -848,17 +921,16 @@ module Imagekit page: Imagekit::Transformation::Page::Variants, progressive: T::Boolean, quality: Float, - radius: T.any(Float, Imagekit::Transformation::Radius::OrSymbol), + radius: T.any(Float, Symbol), raw: String, rotation: Imagekit::Transformation::Rotation::Variants, - shadow: T.any(Imagekit::Transformation::Shadow::OrBoolean, String), - sharpen: T.any(Imagekit::Transformation::Sharpen::OrBoolean, Float), + shadow: T.any(T::Boolean, String), + sharpen: T.any(T::Boolean, Float), start_offset: Imagekit::Transformation::StartOffset::Variants, streaming_resolutions: T::Array[Imagekit::StreamingResolution::OrSymbol], - trim: T.any(Imagekit::Transformation::Trim::OrBoolean, Float), - unsharp_mask: - T.any(Imagekit::Transformation::UnsharpMask::OrBoolean, String), + trim: T.any(T::Boolean, Float), + unsharp_mask: T.any(T::Boolean, String), video_codec: Imagekit::Transformation::VideoCodec::OrSymbol, width: Imagekit::Transformation::Width::Variants, x: Imagekit::Transformation::X::Variants, @@ -876,14 +948,12 @@ module Imagekit # 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. + # inside overlay. See + # [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). module AIDropShadow extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any(Imagekit::Transformation::AIDropShadow::TaggedBoolean, String) - end + Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns( @@ -892,18 +962,10 @@ module Imagekit end def self.variants end - - TaggedBoolean = - T.type_alias do - T.all(T::Boolean, Imagekit::Transformation::AIDropShadow) - end - OrBoolean = T.type_alias { T::Boolean } - - TRUE = - T.let(true, Imagekit::Transformation::AIDropShadow::TaggedBoolean) end - # Applies ImageKit's in-house background removal. Supported inside overlay. + # 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). module AIRemoveBackground extend Imagekit::Internal::Type::Enum @@ -932,7 +994,8 @@ module Imagekit # 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. + # Supported inside overlay. See + # [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). module AIRemoveBackgroundExternal extend Imagekit::Internal::Type::Enum @@ -963,7 +1026,8 @@ module Imagekit end # Performs AI-based retouching to improve faces or product shots. Not supported - # inside overlay. + # inside overlay. See + # [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). module AIRetouch extend Imagekit::Internal::Type::Enum @@ -985,7 +1049,8 @@ module Imagekit end # Upscales images beyond their original dimensions using AI. Not supported inside - # overlay. + # overlay. See + # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). module AIUpscale extend Imagekit::Internal::Type::Enum @@ -1009,7 +1074,8 @@ module Imagekit # 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. + # original image. Not supported inside overlay. See + # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). module AIVariation extend Imagekit::Internal::Type::Enum @@ -1032,7 +1098,8 @@ module Imagekit # 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`. + # 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). module AspectRatio extend Imagekit::Internal::Type::Union @@ -1047,7 +1114,8 @@ module Imagekit end end - # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. + # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See + # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). module AudioCodec extend Imagekit::Internal::Type::Enum @@ -1068,7 +1136,8 @@ module Imagekit end end - # Automatically enhances the contrast of an image (contrast stretch). + # Automatically enhances the contrast of an image (contrast stretch). See + # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). module ContrastStretch extend Imagekit::Internal::Type::Enum @@ -1090,7 +1159,8 @@ module Imagekit end end - # Crop modes for image resizing + # Crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). module Crop extend Imagekit::Internal::Type::Enum @@ -1116,7 +1186,8 @@ module Imagekit end end - # Additional crop modes for image resizing + # Additional crop modes for image resizing. See + # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). module CropMode extend Imagekit::Internal::Type::Enum @@ -1142,7 +1213,8 @@ module Imagekit # 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. + # Arithmetic expressions are supported. See + # [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). module Duration extend Imagekit::Internal::Type::Union @@ -1159,7 +1231,8 @@ module Imagekit # 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. + # are supported. See + # [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). module EndOffset extend Imagekit::Internal::Type::Union @@ -1176,7 +1249,7 @@ module Imagekit # Flips or mirrors an image either horizontally, vertically, or both. Acceptable # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or - # `v_h`. + # `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). module Flip extend Imagekit::Internal::Type::Enum @@ -1202,7 +1275,9 @@ module Imagekit # `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. + # format parameter. See + # [Image format](https://imagekit.io/docs/image-optimization#format---f) and + # [Video format](https://imagekit.io/docs/video-optimization#format---f). module Format extend Imagekit::Internal::Type::Enum @@ -1232,14 +1307,12 @@ module Imagekit end # Creates a linear gradient with two colors. Pass `true` for a default gradient, - # or provide a string for a custom gradient. + # or provide a string for a custom gradient. See + # [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). module Gradient extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any(Imagekit::Transformation::Gradient::TaggedBoolean, String) - end + Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns( @@ -1248,15 +1321,10 @@ module Imagekit end def self.variants end - - TaggedBoolean = - T.type_alias { T.all(T::Boolean, Imagekit::Transformation::Gradient) } - OrBoolean = T.type_alias { T::Boolean } - - TRUE = T.let(true, Imagekit::Transformation::Gradient::TaggedBoolean) end - # Enables a grayscale effect for images. + # Enables a grayscale effect for images. See + # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). module Grayscale extend Imagekit::Internal::Type::Enum @@ -1279,7 +1347,10 @@ module Imagekit # 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`). + # 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) module Height extend Imagekit::Internal::Type::Union @@ -1294,7 +1365,8 @@ module Imagekit # 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). + # 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). module Page extend Imagekit::Internal::Type::Union @@ -1307,33 +1379,26 @@ module Imagekit end end - # Specifies the corner radius for rounded corners (e.g., 20) or `max` for - # circular/oval shapes. + # 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). module Radius extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any(Float, Imagekit::Transformation::Radius::TaggedSymbol) - end + Variants = T.type_alias { T.any(Float, Symbol) } sig do override.returns(T::Array[Imagekit::Transformation::Radius::Variants]) end def self.variants end - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::Transformation::Radius) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - MAX = T.let(:max, Imagekit::Transformation::Radius::TaggedSymbol) end # 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. + # only the following values are supported: 0, 90, 180, 270, or 360. See + # [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). module Rotation extend Imagekit::Internal::Type::Union @@ -1350,37 +1415,27 @@ module Imagekit # 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. + # shadow, or provide a string for a custom shadow. See + # [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). module Shadow extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any(Imagekit::Transformation::Shadow::TaggedBoolean, String) - end + Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns(T::Array[Imagekit::Transformation::Shadow::Variants]) end def self.variants end - - TaggedBoolean = - T.type_alias { T.all(T::Boolean, Imagekit::Transformation::Shadow) } - OrBoolean = T.type_alias { T::Boolean } - - TRUE = T.let(true, Imagekit::Transformation::Shadow::TaggedBoolean) end # Sharpens the input image, highlighting edges and finer details. Pass `true` for - # default sharpening, or provide a numeric value for custom sharpening. + # default sharpening, or provide a numeric value for custom sharpening. See + # [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). module Sharpen extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any(Imagekit::Transformation::Sharpen::TaggedBoolean, Float) - end + Variants = T.type_alias { T.any(T::Boolean, Float) } sig do override.returns( @@ -1389,16 +1444,11 @@ module Imagekit end def self.variants end - - TaggedBoolean = - T.type_alias { T.all(T::Boolean, Imagekit::Transformation::Sharpen) } - OrBoolean = T.type_alias { T::Boolean } - - TRUE = T.let(true, Imagekit::Transformation::Sharpen::TaggedBoolean) end # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or - # `10.5`. Arithmetic expressions are also supported. + # `10.5`. Arithmetic expressions are also supported. See + # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). module StartOffset extend Imagekit::Internal::Type::Union @@ -1415,37 +1465,27 @@ module Imagekit # 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. + # output image. See + # [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). module Trim extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any(Imagekit::Transformation::Trim::TaggedBoolean, Float) - end + Variants = T.type_alias { T.any(T::Boolean, Float) } sig do override.returns(T::Array[Imagekit::Transformation::Trim::Variants]) end def self.variants end - - TaggedBoolean = - T.type_alias { T.all(T::Boolean, Imagekit::Transformation::Trim) } - OrBoolean = T.type_alias { T::Boolean } - - TRUE = T.let(true, Imagekit::Transformation::Trim::TaggedBoolean) end # Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a - # default unsharp mask, or provide a string for a custom unsharp mask. + # 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). module UnsharpMask extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any(Imagekit::Transformation::UnsharpMask::TaggedBoolean, String) - end + Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns( @@ -1454,17 +1494,10 @@ module Imagekit end def self.variants end - - TaggedBoolean = - T.type_alias do - T.all(T::Boolean, Imagekit::Transformation::UnsharpMask) - end - OrBoolean = T.type_alias { T::Boolean } - - TRUE = T.let(true, Imagekit::Transformation::UnsharpMask::TaggedBoolean) end - # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. + # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See + # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). module VideoCodec extend Imagekit::Internal::Type::Enum @@ -1488,7 +1521,9 @@ module Imagekit # 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`). + # 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) module Width extend Imagekit::Internal::Type::Union @@ -1501,7 +1536,8 @@ module Imagekit end end - # Focus using cropped image coordinates - X coordinate + # 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). module X extend Imagekit::Internal::Type::Union @@ -1514,7 +1550,8 @@ module Imagekit end end - # Focus using cropped image coordinates - X center coordinate + # 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). module XCenter extend Imagekit::Internal::Type::Union @@ -1529,7 +1566,8 @@ module Imagekit end end - # Focus using cropped image coordinates - Y coordinate + # 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). module Y extend Imagekit::Internal::Type::Union @@ -1542,7 +1580,8 @@ module Imagekit end end - # Focus using cropped image coordinates - Y center coordinate + # 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). module YCenter extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/transformation_position.rbi b/rbi/imagekit/models/transformation_position.rbi index 9ae4af39..603588e6 100644 --- a/rbi/imagekit/models/transformation_position.rbi +++ b/rbi/imagekit/models/transformation_position.rbi @@ -4,7 +4,8 @@ module Imagekit module Models # 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`. + # path of the URL, set this to `path`. Learn more in the + # [Transformations guide](https://imagekit.io/docs/transformations). module TransformationPosition extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi index e4fe5870..56008983 100644 --- a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi @@ -2,6 +2,9 @@ module Imagekit module Models + # 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. module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union @@ -10,7 +13,11 @@ module Imagekit T.any( Imagekit::VideoTransformationAcceptedEvent, Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationErrorEvent, + Imagekit::UploadPreTransformSuccessWebhookEvent, + Imagekit::UploadPreTransformErrorWebhookEvent, + Imagekit::UploadPostTransformSuccessWebhookEvent, + Imagekit::UploadPostTransformErrorWebhookEvent ) end diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi index d2d814d5..bb1ea24e 100644 --- a/rbi/imagekit/models/unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unwrap_webhook_event.rbi @@ -2,6 +2,9 @@ module Imagekit module Models + # 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. module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union @@ -10,7 +13,11 @@ module Imagekit T.any( Imagekit::VideoTransformationAcceptedEvent, Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationErrorEvent, + Imagekit::UploadPreTransformSuccessWebhookEvent, + Imagekit::UploadPreTransformErrorWebhookEvent, + Imagekit::UploadPostTransformSuccessWebhookEvent, + Imagekit::UploadPostTransformErrorWebhookEvent ) end diff --git a/rbi/imagekit/models/upload_post_transform_error_webhook_event.rbi b/rbi/imagekit/models/upload_post_transform_error_webhook_event.rbi new file mode 100644 index 00000000..6745cbee --- /dev/null +++ b/rbi/imagekit/models/upload_post_transform_error_webhook_event.rbi @@ -0,0 +1,444 @@ +# typed: strong + +module Imagekit + module Models + class UploadPostTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformErrorWebhookEvent, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the event. + sig { returns(String) } + attr_accessor :id + + # Timestamp of when the event occurred in ISO8601 format. + sig { returns(Time) } + attr_accessor :created_at + + sig { returns(Imagekit::UploadPostTransformErrorWebhookEvent::Data) } + attr_reader :data + + sig do + params( + data: Imagekit::UploadPostTransformErrorWebhookEvent::Data::OrHash + ).void + end + attr_writer :data + + sig { returns(Imagekit::UploadPostTransformErrorWebhookEvent::Request) } + attr_reader :request + + sig do + params( + request: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::OrHash + ).void + end + attr_writer :request + + sig { returns(Symbol) } + attr_accessor :type + + # Triggered when a post-transformation fails. The original file remains available, + # but the requested transformation could not be generated. + sig do + params( + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformErrorWebhookEvent::Data::OrHash, + request: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::OrHash, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the event. + id:, + # Timestamp of when the event occurred in ISO8601 format. + created_at:, + data:, + request:, + type: :"upload.post-transform.error" + ) + end + + sig do + override.returns( + { + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformErrorWebhookEvent::Data, + request: Imagekit::UploadPostTransformErrorWebhookEvent::Request, + type: Symbol + } + ) + end + def to_hash + end + + class Data < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformErrorWebhookEvent::Data, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the originally uploaded file. + sig { returns(String) } + attr_accessor :file_id + + # Name of the file. + sig { returns(String) } + attr_accessor :name + + # Path of the file. + sig { returns(String) } + attr_accessor :path + + sig do + returns( + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation + ) + end + attr_reader :transformation + + sig do + params( + transformation: + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::OrHash + ).void + end + attr_writer :transformation + + # URL of the attempted post-transformation. + sig { returns(String) } + attr_accessor :url + + sig do + params( + file_id: String, + name: String, + path: String, + transformation: + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::OrHash, + url: String + ).returns(T.attached_class) + end + def self.new( + # Unique identifier of the originally uploaded file. + file_id:, + # Name of the file. + name:, + # Path of the file. + path:, + transformation:, + # URL of the attempted post-transformation. + url: + ) + end + + sig do + override.returns( + { + file_id: String, + name: String, + path: String, + transformation: + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + url: String + } + ) + end + def to_hash + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + ) + end + attr_reader :error + + sig do + params( + error: + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error::OrHash + ).void + end + attr_writer :error + + sig do + params( + error: + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error::OrHash + ).returns(T.attached_class) + end + def self.new(error:) + end + + sig do + override.returns( + { + error: + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + } + ) + end + def to_hash + end + + class Error < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error, + Imagekit::Internal::AnyHash + ) + end + + # Reason for the post-transformation failure. + sig { returns(String) } + attr_accessor :reason + + sig { params(reason: String).returns(T.attached_class) } + def self.new( + # Reason for the post-transformation failure. + reason: + ) + end + + sig { override.returns({ reason: String }) } + def to_hash + end + end + end + end + + class Request < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformErrorWebhookEvent::Request, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation + ) + end + attr_reader :transformation + + sig do + params( + transformation: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::OrHash + ).void + end + attr_writer :transformation + + # Unique identifier for the originating request. + sig { returns(String) } + attr_accessor :x_request_id + + sig do + params( + transformation: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::OrHash, + x_request_id: String + ).returns(T.attached_class) + end + def self.new( + transformation:, + # Unique identifier for the originating request. + x_request_id: + ) + end + + sig do + override.returns( + { + transformation: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + x_request_id: String + } + ) + end + def to_hash + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + Imagekit::Internal::AnyHash + ) + end + + # Type of the requested post-transformation. + sig do + returns( + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + end + attr_accessor :type + + # Only applicable if transformation type is 'abs'. Streaming protocol used. + sig do + returns( + T.nilable( + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + ) + ) + end + attr_reader :protocol + + sig do + params( + protocol: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::OrSymbol + ).void + end + attr_writer :protocol + + # Value for the requested transformation type. + sig { returns(T.nilable(String)) } + attr_reader :value + + sig { params(value: String).void } + attr_writer :value + + sig do + params( + type: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::OrSymbol, + protocol: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Type of the requested post-transformation. + type:, + # Only applicable if transformation type is 'abs'. Streaming protocol used. + protocol: nil, + # Value for the requested transformation type. + value: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol, + protocol: + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol, + value: String + } + ) + end + def to_hash + end + + # Type of the requested post-transformation. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRANSFORMATION = + T.let( + :transformation, + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + ABS = + T.let( + :abs, + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + GIF_TO_VIDEO = + T.let( + :"gif-to-video", + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + THUMBNAIL = + T.let( + :thumbnail, + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Only applicable if transformation type is 'abs'. Streaming protocol used. + module Protocol + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HLS = + T.let( + :hls, + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + ) + DASH = + T.let( + :dash, + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end + end +end diff --git a/rbi/imagekit/models/upload_post_transform_success_webhook_event.rbi b/rbi/imagekit/models/upload_post_transform_success_webhook_event.rbi new file mode 100644 index 00000000..676aa3ad --- /dev/null +++ b/rbi/imagekit/models/upload_post_transform_success_webhook_event.rbi @@ -0,0 +1,337 @@ +# typed: strong + +module Imagekit + module Models + class UploadPostTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformSuccessWebhookEvent, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the event. + sig { returns(String) } + attr_accessor :id + + # Timestamp of when the event occurred in ISO8601 format. + sig { returns(Time) } + attr_accessor :created_at + + sig { returns(Imagekit::UploadPostTransformSuccessWebhookEvent::Data) } + attr_reader :data + + sig do + params( + data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data::OrHash + ).void + end + attr_writer :data + + sig { returns(Imagekit::UploadPostTransformSuccessWebhookEvent::Request) } + attr_reader :request + + sig do + params( + request: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::OrHash + ).void + end + attr_writer :request + + sig { returns(Symbol) } + attr_accessor :type + + # 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. + sig do + params( + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data::OrHash, + request: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::OrHash, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the event. + id:, + # Timestamp of when the event occurred in ISO8601 format. + created_at:, + data:, + request:, + type: :"upload.post-transform.success" + ) + end + + sig do + override.returns( + { + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data, + request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + type: Symbol + } + ) + end + def to_hash + end + + class Data < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformSuccessWebhookEvent::Data, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the originally uploaded file. + sig { returns(String) } + attr_accessor :file_id + + # Name of the file. + sig { returns(String) } + attr_accessor :name + + # URL of the generated post-transformation. + sig { returns(String) } + attr_accessor :url + + sig do + params(file_id: String, name: String, url: String).returns( + T.attached_class + ) + end + def self.new( + # Unique identifier of the originally uploaded file. + file_id:, + # Name of the file. + name:, + # URL of the generated post-transformation. + url: + ) + end + + sig { override.returns({ file_id: String, name: String, url: String }) } + def to_hash + end + end + + class Request < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation + ) + end + attr_reader :transformation + + sig do + params( + transformation: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::OrHash + ).void + end + attr_writer :transformation + + # Unique identifier for the originating request. + sig { returns(String) } + attr_accessor :x_request_id + + sig do + params( + transformation: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::OrHash, + x_request_id: String + ).returns(T.attached_class) + end + def self.new( + transformation:, + # Unique identifier for the originating request. + x_request_id: + ) + end + + sig do + override.returns( + { + transformation: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + x_request_id: String + } + ) + end + def to_hash + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + Imagekit::Internal::AnyHash + ) + end + + # Type of the requested post-transformation. + sig do + returns( + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + end + attr_accessor :type + + # Only applicable if transformation type is 'abs'. Streaming protocol used. + sig do + returns( + T.nilable( + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + ) + ) + end + attr_reader :protocol + + sig do + params( + protocol: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::OrSymbol + ).void + end + attr_writer :protocol + + # Value for the requested transformation type. + sig { returns(T.nilable(String)) } + attr_reader :value + + sig { params(value: String).void } + attr_writer :value + + sig do + params( + type: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::OrSymbol, + protocol: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::OrSymbol, + value: String + ).returns(T.attached_class) + end + def self.new( + # Type of the requested post-transformation. + type:, + # Only applicable if transformation type is 'abs'. Streaming protocol used. + protocol: nil, + # Value for the requested transformation type. + value: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol, + protocol: + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol, + value: String + } + ) + end + def to_hash + end + + # Type of the requested post-transformation. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TRANSFORMATION = + T.let( + :transformation, + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + ABS = + T.let( + :abs, + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + GIF_TO_VIDEO = + T.let( + :"gif-to-video", + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + THUMBNAIL = + T.let( + :thumbnail, + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Only applicable if transformation type is 'abs'. Streaming protocol used. + module Protocol + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HLS = + T.let( + :hls, + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + ) + DASH = + T.let( + :dash, + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end + end +end diff --git a/rbi/imagekit/models/upload_pre_transform_error_webhook_event.rbi b/rbi/imagekit/models/upload_pre_transform_error_webhook_event.rbi new file mode 100644 index 00000000..625d300a --- /dev/null +++ b/rbi/imagekit/models/upload_pre_transform_error_webhook_event.rbi @@ -0,0 +1,254 @@ +# typed: strong + +module Imagekit + module Models + class UploadPreTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformErrorWebhookEvent, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the event. + sig { returns(String) } + attr_accessor :id + + # Timestamp of when the event occurred in ISO8601 format. + sig { returns(Time) } + attr_accessor :created_at + + sig { returns(Imagekit::UploadPreTransformErrorWebhookEvent::Data) } + attr_reader :data + + sig do + params( + data: Imagekit::UploadPreTransformErrorWebhookEvent::Data::OrHash + ).void + end + attr_writer :data + + sig { returns(Imagekit::UploadPreTransformErrorWebhookEvent::Request) } + attr_reader :request + + sig do + params( + request: + Imagekit::UploadPreTransformErrorWebhookEvent::Request::OrHash + ).void + end + attr_writer :request + + sig { returns(Symbol) } + attr_accessor :type + + # Triggered when a pre-transformation fails. The file upload may have been + # accepted, but the requested transformation could not be applied. + sig do + params( + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformErrorWebhookEvent::Data::OrHash, + request: + Imagekit::UploadPreTransformErrorWebhookEvent::Request::OrHash, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the event. + id:, + # Timestamp of when the event occurred in ISO8601 format. + created_at:, + data:, + request:, + type: :"upload.pre-transform.error" + ) + end + + sig do + override.returns( + { + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformErrorWebhookEvent::Data, + request: Imagekit::UploadPreTransformErrorWebhookEvent::Request, + type: Symbol + } + ) + end + def to_hash + end + + class Data < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformErrorWebhookEvent::Data, + Imagekit::Internal::AnyHash + ) + end + + # Name of the file. + sig { returns(String) } + attr_accessor :name + + # Path of the file. + sig { returns(String) } + attr_accessor :path + + sig do + returns( + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + ) + end + attr_reader :transformation + + sig do + params( + transformation: + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::OrHash + ).void + end + attr_writer :transformation + + sig do + params( + name: String, + path: String, + transformation: + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::OrHash + ).returns(T.attached_class) + end + def self.new( + # Name of the file. + name:, + # Path of the file. + path:, + transformation: + ) + end + + sig do + override.returns( + { + name: String, + path: String, + transformation: + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + } + ) + end + def to_hash + end + + class Transformation < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + ) + end + attr_reader :error + + sig do + params( + error: + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error::OrHash + ).void + end + attr_writer :error + + sig do + params( + error: + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error::OrHash + ).returns(T.attached_class) + end + def self.new(error:) + end + + sig do + override.returns( + { + error: + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + } + ) + end + def to_hash + end + + class Error < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error, + Imagekit::Internal::AnyHash + ) + end + + # Reason for the pre-transformation failure. + sig { returns(String) } + attr_accessor :reason + + sig { params(reason: String).returns(T.attached_class) } + def self.new( + # Reason for the pre-transformation failure. + reason: + ) + end + + sig { override.returns({ reason: String }) } + def to_hash + end + end + end + end + + class Request < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformErrorWebhookEvent::Request, + Imagekit::Internal::AnyHash + ) + end + + # The requested pre-transformation string. + sig { returns(String) } + attr_accessor :transformation + + # Unique identifier for the originating request. + sig { returns(String) } + attr_accessor :x_request_id + + sig do + params(transformation: String, x_request_id: String).returns( + T.attached_class + ) + end + def self.new( + # The requested pre-transformation string. + transformation:, + # Unique identifier for the originating request. + x_request_id: + ) + end + + sig do + override.returns({ transformation: String, x_request_id: String }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/upload_pre_transform_success_webhook_event.rbi b/rbi/imagekit/models/upload_pre_transform_success_webhook_event.rbi new file mode 100644 index 00000000..9677c0ae --- /dev/null +++ b/rbi/imagekit/models/upload_pre_transform_success_webhook_event.rbi @@ -0,0 +1,820 @@ +# typed: strong + +module Imagekit + module Models + class UploadPreTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformSuccessWebhookEvent, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier for the event. + sig { returns(String) } + attr_accessor :id + + # Timestamp of when the event occurred in ISO8601 format. + sig { returns(Time) } + attr_accessor :created_at + + # Object containing details of a successful upload. + sig { returns(Imagekit::UploadPreTransformSuccessWebhookEvent::Data) } + attr_reader :data + + sig do + params( + data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::OrHash + ).void + end + attr_writer :data + + sig { returns(Imagekit::UploadPreTransformSuccessWebhookEvent::Request) } + attr_reader :request + + sig do + params( + request: + Imagekit::UploadPreTransformSuccessWebhookEvent::Request::OrHash + ).void + end + attr_writer :request + + sig { returns(Symbol) } + attr_accessor :type + + # Triggered when a pre-transformation completes successfully. The file has been + # processed with the requested transformation and is now available in the Media + # Library. + sig do + params( + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::OrHash, + request: + Imagekit::UploadPreTransformSuccessWebhookEvent::Request::OrHash, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the event. + id:, + # Timestamp of when the event occurred in ISO8601 format. + created_at:, + # Object containing details of a successful upload. + data:, + request:, + type: :"upload.pre-transform.success" + ) + end + + sig do + override.returns( + { + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data, + request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + type: Symbol + } + ) + end + def to_hash + end + + class Data < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data, + Imagekit::Internal::AnyHash + ) + end + + # An array of tags assigned to the uploaded file by auto tagging. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag + ] + ) + ) + end + attr_accessor :ai_tags + + # The audio codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :embedded_metadata + + sig { params(embedded_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :embedded_metadata + + # 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. + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus + ) + ) + end + attr_reader :extension_status + + sig do + params( + extension_status: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::OrHash + ).void + end + attr_writer :extension_status + + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + sig { returns(T.nilable(String)) } + attr_reader :file_id + + sig { params(file_id: String).void } + attr_writer :file_id + + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + sig { returns(T.nilable(String)) } + attr_reader :file_path + + sig { params(file_path: String).void } + attr_writer :file_path + + # Type of the uploaded file. Possible values are `image`, `non-image`. + sig { returns(T.nilable(String)) } + attr_reader :file_type + + sig { params(file_type: String).void } + attr_writer :file_type + + # Height of the image in pixels (Only for images) + sig { returns(T.nilable(Float)) } + attr_reader :height + + sig { params(height: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private_file + + sig { params(is_private_file: T::Boolean).void } + attr_writer :is_private_file + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_published + + sig { params(is_published: T::Boolean).void } + attr_writer :is_published + + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + sig { returns(T.nilable(Imagekit::Metadata)) } + attr_reader :metadata + + sig { params(metadata: Imagekit::Metadata::OrHash).void } + attr_writer :metadata + + # Name of the asset. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Size of the image file in Bytes. + sig { returns(T.nilable(Float)) } + attr_reader :size + + sig { params(size: Float).void } + attr_writer :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. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :tags + + # In the case of an image, a small thumbnail URL. + sig { returns(T.nilable(String)) } + attr_reader :thumbnail_url + + sig { params(thumbnail_url: String).void } + attr_writer :thumbnail_url + + # A publicly accessible URL of the file. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # An object containing the file or file version's `id` (versionId) and `name`. + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo + ) + ) + end + attr_reader :version_info + + sig do + params( + version_info: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo::OrHash + ).void + end + attr_writer :version_info + + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + + # Width of the image in pixels (Only for Images) + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Object containing details of a successful upload. + sig do + params( + ai_tags: + T.nilable( + T::Array[ + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag::OrHash + ] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + duration: Integer, + embedded_metadata: T::Hash[Symbol, T.anything], + extension_status: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::OrHash, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: Imagekit::Metadata::OrHash, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo::OrHash, + video_codec: String, + width: Float + ).returns(T.attached_class) + end + def self.new( + # An array of tags assigned to the uploaded file by auto tagging. + ai_tags: nil, + # The audio codec used in the video (only for video). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. Can be set by the user or + # the ai-auto-description extension. + description: nil, + # The duration of the video in seconds (only for video). + duration: nil, + # 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. + embedded_metadata: nil, + # 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. + extension_status: nil, + # Unique fileId. Store this fileld in your database, as this will be used to + # perform update action on this file. + file_id: nil, + # The relative path of the file in the media library e.g. + # `/marketing-assets/new-banner.jpg`. + file_path: nil, + # Type of the uploaded file. Possible values are `image`, `non-image`. + file_type: nil, + # Height of the image in pixels (Only for images) + height: nil, + # 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. + is_private_file: nil, + # 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. + is_published: nil, + # Legacy metadata. Send `metadata` in `responseFields` in API request to get + # metadata in the upload API response. + metadata: nil, + # Name of the asset. + name: nil, + # Size of the image file in Bytes. + size: nil, + # 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. + tags: nil, + # In the case of an image, a small thumbnail URL. + thumbnail_url: nil, + # A publicly accessible URL of the file. + url: nil, + # An object containing the file or file version's `id` (versionId) and `name`. + version_info: nil, + # The video codec used in the video (only for video). + video_codec: nil, + # Width of the image in pixels (Only for Images) + width: nil + ) + end + + sig do + override.returns( + { + ai_tags: + T.nilable( + T::Array[ + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag + ] + ), + audio_codec: String, + bit_rate: Integer, + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + duration: Integer, + embedded_metadata: T::Hash[Symbol, T.anything], + extension_status: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: T::Boolean, + is_published: T::Boolean, + metadata: Imagekit::Metadata, + name: String, + size: Float, + tags: T.nilable(T::Array[String]), + thumbnail_url: String, + url: String, + version_info: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + video_codec: String, + width: Float + } + ) + end + def to_hash + end + + class AITag < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag, + Imagekit::Internal::AnyHash + ) + end + + # Confidence score of the tag. + sig { returns(T.nilable(Float)) } + attr_reader :confidence + + sig { params(confidence: Float).void } + attr_writer :confidence + + # Name of the tag. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :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. + sig { returns(T.nilable(String)) } + attr_reader :source + + sig { params(source: String).void } + attr_writer :source + + sig do + params(confidence: Float, name: String, source: String).returns( + T.attached_class + ) + end + def self.new( + # Confidence score of the tag. + confidence: nil, + # Name of the tag. + name: nil, + # 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. + source: nil + ) + end + + sig do + override.returns( + { confidence: Float, name: String, source: String } + ) + end + def to_hash + end + end + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + Imagekit::Internal::AnyHash + ) + end + + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :aws_auto_tagging + + sig do + params( + aws_auto_tagging: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol + ).void + end + attr_writer :aws_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + ) + end + attr_reader :google_auto_tagging + + sig do + params( + google_auto_tagging: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol + ).void + end + attr_writer :google_auto_tagging + + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + ) + ) + end + attr_reader :remove_bg + + sig do + params( + remove_bg: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::OrSymbol + ).void + end + attr_writer :remove_bg + + # 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. + sig do + params( + aws_auto_tagging: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol, + google_auto_tagging: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol, + remove_bg: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::OrSymbol + ).returns(T.attached_class) + end + def self.new( + aws_auto_tagging: nil, + google_auto_tagging: nil, + remove_bg: nil + ) + end + + sig do + override.returns( + { + aws_auto_tagging: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + google_auto_tagging: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + remove_bg: + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + } + ) + end + def to_hash + end + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + ] + ) + end + def self.values + end + end + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class VersionInfo < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + Imagekit::Internal::AnyHash + ) + end + + # Unique identifier of the file version. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Name of the file version. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # An object containing the file or file version's `id` (versionId) and `name`. + sig { params(id: String, name: String).returns(T.attached_class) } + def self.new( + # Unique identifier of the file version. + id: nil, + # Name of the file version. + name: nil + ) + end + + sig { override.returns({ id: String, name: String }) } + def to_hash + end + end + end + + class Request < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + Imagekit::Internal::AnyHash + ) + end + + # The requested pre-transformation string. + sig { returns(String) } + attr_accessor :transformation + + # Unique identifier for the originating request. + sig { returns(String) } + attr_accessor :x_request_id + + sig do + params(transformation: String, x_request_id: String).returns( + T.attached_class + ) + end + def self.new( + # The requested pre-transformation string. + transformation:, + # Unique identifier for the originating request. + x_request_id: + ) + end + + sig do + override.returns({ transformation: String, x_request_id: String }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/video_overlay.rbi b/rbi/imagekit/models/video_overlay.rbi index 71690f70..84c9aaed 100644 --- a/rbi/imagekit/models/video_overlay.rbi +++ b/rbi/imagekit/models/video_overlay.rbi @@ -12,7 +12,7 @@ module Imagekit sig { returns(String) } attr_accessor :input - sig { returns(Imagekit::VideoOverlay::Type::OrSymbol) } + sig { returns(Symbol) } attr_accessor :type # The input path can be included in the layer as either `i-{input}` or @@ -27,7 +27,8 @@ module Imagekit attr_writer :encoding # Array of transformation to be applied to the overlay video. Except - # `streamingResolutions`, all other video transformations are supported. + # `streamingResolutions`, all other video transformations are supported. See + # [Video transformations](https://imagekit.io/docs/video-transformation). sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } attr_reader :transformation @@ -37,15 +38,14 @@ module Imagekit sig do params( input: String, - type: Imagekit::VideoOverlay::Type::OrSymbol, encoding: Imagekit::VideoOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::Transformation] + transformation: T::Array[Imagekit::Transformation], + type: Symbol ).returns(T.attached_class) end def self.new( # Specifies the relative path to the video used as an overlay. input:, - type:, # 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 @@ -53,8 +53,10 @@ module Imagekit # `plain`. encoding: nil, # Array of transformation to be applied to the overlay video. Except - # `streamingResolutions`, all other video transformations are supported. - transformation: nil + # `streamingResolutions`, all other video transformations are supported. See + # [Video transformations](https://imagekit.io/docs/video-transformation). + transformation: nil, + type: :video ) end @@ -62,7 +64,7 @@ module Imagekit override.returns( { input: String, - type: Imagekit::VideoOverlay::Type::OrSymbol, + type: Symbol, encoding: Imagekit::VideoOverlay::Encoding::OrSymbol, transformation: T::Array[Imagekit::Transformation] } @@ -71,22 +73,6 @@ module Imagekit def to_hash end - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::VideoOverlay::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - VIDEO = T.let(:video, Imagekit::VideoOverlay::Type::TaggedSymbol) - - sig do - override.returns(T::Array[Imagekit::VideoOverlay::Type::TaggedSymbol]) - end - def self.values - end - end - # 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 diff --git a/rbi/imagekit/models/video_transformation_accepted_event.rbi b/rbi/imagekit/models/video_transformation_accepted_event.rbi index 3e0a9e1b..0fae8a8e 100644 --- a/rbi/imagekit/models/video_transformation_accepted_event.rbi +++ b/rbi/imagekit/models/video_transformation_accepted_event.rbi @@ -15,6 +15,7 @@ module Imagekit sig { returns(String) } attr_accessor :id + # Timestamp when the event was created in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -28,6 +29,7 @@ module Imagekit end attr_writer :data + # Information about the original request that triggered the video transformation. sig { returns(Imagekit::VideoTransformationAcceptedEvent::Request) } attr_reader :request @@ -41,6 +43,9 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # 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. sig do params( id: String, @@ -53,8 +58,10 @@ module Imagekit def self.new( # Unique identifier for the event. id:, + # Timestamp when the event was created in ISO8601 format. created_at:, data:, + # Information about the original request that triggered the video transformation. request:, type: :"video.transformation.accepted" ) @@ -83,6 +90,7 @@ module Imagekit ) end + # Information about the source video asset being transformed. sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data::Asset) } attr_reader :asset @@ -94,6 +102,7 @@ module Imagekit end attr_writer :asset + # Base information about a video transformation request. sig do returns( Imagekit::VideoTransformationAcceptedEvent::Data::Transformation @@ -117,7 +126,12 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash ).returns(T.attached_class) end - def self.new(asset:, transformation:) + def self.new( + # Information about the source video asset being transformed. + asset:, + # Base information about a video transformation request. + transformation: + ) end sig do @@ -141,13 +155,14 @@ module Imagekit ) end - # Source asset URL. + # URL to download or access the source video file. sig { returns(String) } attr_accessor :url + # Information about the source video asset being transformed. sig { params(url: String).returns(T.attached_class) } def self.new( - # Source asset URL. + # URL to download or access the source video file. url: ) end @@ -166,6 +181,12 @@ module Imagekit ) end + # 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 sig do returns( Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol @@ -173,6 +194,7 @@ module Imagekit end attr_accessor :type + # Configuration options for video transformations. sig do returns( T.nilable( @@ -190,6 +212,7 @@ module Imagekit end attr_writer :options + # Base information about a video transformation request. sig do params( type: @@ -198,7 +221,17 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end - def self.new(type:, options: nil) + def self.new( + # 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 + type:, + # Configuration options for video transformations. + options: nil + ) end sig do @@ -214,6 +247,12 @@ module Imagekit def to_hash end + # 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 module Type extend Imagekit::Internal::Type::Enum @@ -262,6 +301,7 @@ module Imagekit ) end + # Audio codec used for encoding (aac or opus). sig do returns( T.nilable( @@ -279,12 +319,14 @@ module Imagekit end attr_writer :audio_codec + # Whether to automatically rotate the video based on metadata. sig { returns(T.nilable(T::Boolean)) } attr_reader :auto_rotate sig { params(auto_rotate: T::Boolean).void } attr_writer :auto_rotate + # Output format for the transformed video or thumbnail. sig do returns( T.nilable( @@ -302,12 +344,14 @@ module Imagekit end attr_writer :format_ + # Quality setting for the output video. sig { returns(T.nilable(Integer)) } attr_reader :quality sig { params(quality: Integer).void } attr_writer :quality + # Streaming protocol for adaptive bitrate streaming. sig do returns( T.nilable( @@ -325,12 +369,14 @@ module Imagekit end attr_writer :stream_protocol + # Array of quality representations for adaptive bitrate streaming. sig { returns(T.nilable(T::Array[String])) } attr_reader :variants sig { params(variants: T::Array[String]).void } attr_writer :variants + # Video codec used for encoding (h264 or vp9). sig do returns( T.nilable( @@ -348,6 +394,7 @@ module Imagekit end attr_writer :video_codec + # Configuration options for video transformations. sig do params( audio_codec: @@ -364,12 +411,19 @@ module Imagekit ).returns(T.attached_class) end def self.new( + # Audio codec used for encoding (aac or opus). audio_codec: nil, + # Whether to automatically rotate the video based on metadata. auto_rotate: nil, + # Output format for the transformed video or thumbnail. format_: nil, + # Quality setting for the output video. quality: nil, + # Streaming protocol for adaptive bitrate streaming. stream_protocol: nil, + # Array of quality representations for adaptive bitrate streaming. variants: nil, + # Video codec used for encoding (h264 or vp9). video_codec: nil ) end @@ -394,6 +448,7 @@ module Imagekit def to_hash end + # Audio codec used for encoding (aac or opus). module AudioCodec extend Imagekit::Internal::Type::Enum @@ -428,6 +483,7 @@ module Imagekit end end + # Output format for the transformed video or thumbnail. module Format extend Imagekit::Internal::Type::Enum @@ -477,6 +533,7 @@ module Imagekit end end + # Streaming protocol for adaptive bitrate streaming. module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -511,6 +568,7 @@ module Imagekit end end + # Video codec used for encoding (h264 or vp9). module VideoCodec extend Imagekit::Internal::Type::Enum @@ -557,32 +615,33 @@ module Imagekit ) end - # URL of the submitted request. + # Full URL of the transformation request that was submitted. sig { returns(String) } attr_accessor :url - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. sig { returns(String) } attr_accessor :x_request_id - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. sig { returns(T.nilable(String)) } attr_reader :user_agent sig { params(user_agent: String).void } attr_writer :user_agent + # Information about the original request that triggered the video transformation. sig do params(url: String, x_request_id: String, user_agent: String).returns( T.attached_class ) end def self.new( - # URL of the submitted request. + # Full URL of the transformation request that was submitted. url:, - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. x_request_id:, - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. user_agent: nil ) end diff --git a/rbi/imagekit/models/video_transformation_error_event.rbi b/rbi/imagekit/models/video_transformation_error_event.rbi index 1f6f27bb..f18ffb63 100644 --- a/rbi/imagekit/models/video_transformation_error_event.rbi +++ b/rbi/imagekit/models/video_transformation_error_event.rbi @@ -15,6 +15,7 @@ module Imagekit sig { returns(String) } attr_accessor :id + # Timestamp when the event was created in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -26,6 +27,7 @@ module Imagekit end attr_writer :data + # Information about the original request that triggered the video transformation. sig { returns(Imagekit::VideoTransformationErrorEvent::Request) } attr_reader :request @@ -39,6 +41,10 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # 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. sig do params( id: String, @@ -51,8 +57,10 @@ module Imagekit def self.new( # Unique identifier for the event. id:, + # Timestamp when the event was created in ISO8601 format. created_at:, data:, + # Information about the original request that triggered the video transformation. request:, type: :"video.transformation.error" ) @@ -81,6 +89,7 @@ module Imagekit ) end + # Information about the source video asset being transformed. sig { returns(Imagekit::VideoTransformationErrorEvent::Data::Asset) } attr_reader :asset @@ -111,7 +120,11 @@ module Imagekit Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash ).returns(T.attached_class) end - def self.new(asset:, transformation:) + def self.new( + # Information about the source video asset being transformed. + asset:, + transformation: + ) end sig do @@ -135,13 +148,14 @@ module Imagekit ) end - # Source asset URL. + # URL to download or access the source video file. sig { returns(String) } attr_accessor :url + # Information about the source video asset being transformed. sig { params(url: String).returns(T.attached_class) } def self.new( - # Source asset URL. + # URL to download or access the source video file. url: ) end @@ -160,6 +174,12 @@ module Imagekit ) end + # 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 sig do returns( Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol @@ -167,6 +187,7 @@ module Imagekit end attr_accessor :type + # Details about the transformation error. sig do returns( T.nilable( @@ -184,6 +205,7 @@ module Imagekit end attr_writer :error + # Configuration options for video transformations. sig do returns( T.nilable( @@ -211,7 +233,19 @@ module Imagekit Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end - def self.new(type:, error: nil, options: nil) + def self.new( + # 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 + type:, + # Details about the transformation error. + error: nil, + # Configuration options for video transformations. + options: nil + ) end sig do @@ -229,6 +263,12 @@ module Imagekit def to_hash end + # 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 module Type extend Imagekit::Internal::Type::Enum @@ -277,6 +317,11 @@ module Imagekit ) end + # 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 sig do returns( Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol @@ -284,13 +329,21 @@ module Imagekit end attr_accessor :reason + # Details about the transformation error. sig do params( reason: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::OrSymbol ).returns(T.attached_class) end - def self.new(reason:) + def self.new( + # 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 + reason: + ) end sig do @@ -304,6 +357,11 @@ module Imagekit def to_hash end + # 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 module Reason extend Imagekit::Internal::Type::Enum @@ -353,6 +411,7 @@ module Imagekit ) end + # Audio codec used for encoding (aac or opus). sig do returns( T.nilable( @@ -370,12 +429,14 @@ module Imagekit end attr_writer :audio_codec + # Whether to automatically rotate the video based on metadata. sig { returns(T.nilable(T::Boolean)) } attr_reader :auto_rotate sig { params(auto_rotate: T::Boolean).void } attr_writer :auto_rotate + # Output format for the transformed video or thumbnail. sig do returns( T.nilable( @@ -393,12 +454,14 @@ module Imagekit end attr_writer :format_ + # Quality setting for the output video. sig { returns(T.nilable(Integer)) } attr_reader :quality sig { params(quality: Integer).void } attr_writer :quality + # Streaming protocol for adaptive bitrate streaming. sig do returns( T.nilable( @@ -416,12 +479,14 @@ module Imagekit end attr_writer :stream_protocol + # Array of quality representations for adaptive bitrate streaming. sig { returns(T.nilable(T::Array[String])) } attr_reader :variants sig { params(variants: T::Array[String]).void } attr_writer :variants + # Video codec used for encoding (h264 or vp9). sig do returns( T.nilable( @@ -439,6 +504,7 @@ module Imagekit end attr_writer :video_codec + # Configuration options for video transformations. sig do params( audio_codec: @@ -455,12 +521,19 @@ module Imagekit ).returns(T.attached_class) end def self.new( + # Audio codec used for encoding (aac or opus). audio_codec: nil, + # Whether to automatically rotate the video based on metadata. auto_rotate: nil, + # Output format for the transformed video or thumbnail. format_: nil, + # Quality setting for the output video. quality: nil, + # Streaming protocol for adaptive bitrate streaming. stream_protocol: nil, + # Array of quality representations for adaptive bitrate streaming. variants: nil, + # Video codec used for encoding (h264 or vp9). video_codec: nil ) end @@ -485,6 +558,7 @@ module Imagekit def to_hash end + # Audio codec used for encoding (aac or opus). module AudioCodec extend Imagekit::Internal::Type::Enum @@ -519,6 +593,7 @@ module Imagekit end end + # Output format for the transformed video or thumbnail. module Format extend Imagekit::Internal::Type::Enum @@ -568,6 +643,7 @@ module Imagekit end end + # Streaming protocol for adaptive bitrate streaming. module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -602,6 +678,7 @@ module Imagekit end end + # Video codec used for encoding (h264 or vp9). module VideoCodec extend Imagekit::Internal::Type::Enum @@ -648,32 +725,33 @@ module Imagekit ) end - # URL of the submitted request. + # Full URL of the transformation request that was submitted. sig { returns(String) } attr_accessor :url - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. sig { returns(String) } attr_accessor :x_request_id - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. sig { returns(T.nilable(String)) } attr_reader :user_agent sig { params(user_agent: String).void } attr_writer :user_agent + # Information about the original request that triggered the video transformation. sig do params(url: String, x_request_id: String, user_agent: String).returns( T.attached_class ) end def self.new( - # URL of the submitted request. + # Full URL of the transformation request that was submitted. url:, - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. x_request_id:, - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. user_agent: nil ) end diff --git a/rbi/imagekit/models/video_transformation_ready_event.rbi b/rbi/imagekit/models/video_transformation_ready_event.rbi index 15b4c135..e68293f3 100644 --- a/rbi/imagekit/models/video_transformation_ready_event.rbi +++ b/rbi/imagekit/models/video_transformation_ready_event.rbi @@ -15,6 +15,7 @@ module Imagekit sig { returns(String) } attr_accessor :id + # Timestamp when the event was created in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -26,6 +27,7 @@ module Imagekit end attr_writer :data + # Information about the original request that triggered the video transformation. sig { returns(Imagekit::VideoTransformationReadyEvent::Request) } attr_reader :request @@ -39,6 +41,7 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # Performance metrics for the transformation process. sig do returns(T.nilable(Imagekit::VideoTransformationReadyEvent::Timings)) end @@ -51,6 +54,10 @@ module Imagekit end attr_writer :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. sig do params( id: String, @@ -64,9 +71,12 @@ module Imagekit def self.new( # Unique identifier for the event. id:, + # Timestamp when the event was created in ISO8601 format. created_at:, data:, + # Information about the original request that triggered the video transformation. request:, + # Performance metrics for the transformation process. timings: nil, type: :"video.transformation.ready" ) @@ -96,6 +106,7 @@ module Imagekit ) end + # Information about the source video asset being transformed. sig { returns(Imagekit::VideoTransformationReadyEvent::Data::Asset) } attr_reader :asset @@ -126,7 +137,11 @@ module Imagekit Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash ).returns(T.attached_class) end - def self.new(asset:, transformation:) + def self.new( + # Information about the source video asset being transformed. + asset:, + transformation: + ) end sig do @@ -150,13 +165,14 @@ module Imagekit ) end - # Source asset URL. + # URL to download or access the source video file. sig { returns(String) } attr_accessor :url + # Information about the source video asset being transformed. sig { params(url: String).returns(T.attached_class) } def self.new( - # Source asset URL. + # URL to download or access the source video file. url: ) end @@ -175,6 +191,12 @@ module Imagekit ) end + # 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 sig do returns( Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol @@ -182,6 +204,7 @@ module Imagekit end attr_accessor :type + # Configuration options for video transformations. sig do returns( T.nilable( @@ -199,6 +222,7 @@ module Imagekit end attr_writer :options + # Information about the transformed output video. sig do returns( T.nilable( @@ -226,7 +250,19 @@ module Imagekit Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash ).returns(T.attached_class) end - def self.new(type:, options: nil, output: nil) + def self.new( + # 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 + type:, + # Configuration options for video transformations. + options: nil, + # Information about the transformed output video. + output: nil + ) end sig do @@ -244,6 +280,12 @@ module Imagekit def to_hash end + # 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 module Type extend Imagekit::Internal::Type::Enum @@ -292,6 +334,7 @@ module Imagekit ) end + # Audio codec used for encoding (aac or opus). sig do returns( T.nilable( @@ -309,12 +352,14 @@ module Imagekit end attr_writer :audio_codec + # Whether to automatically rotate the video based on metadata. sig { returns(T.nilable(T::Boolean)) } attr_reader :auto_rotate sig { params(auto_rotate: T::Boolean).void } attr_writer :auto_rotate + # Output format for the transformed video or thumbnail. sig do returns( T.nilable( @@ -332,12 +377,14 @@ module Imagekit end attr_writer :format_ + # Quality setting for the output video. sig { returns(T.nilable(Integer)) } attr_reader :quality sig { params(quality: Integer).void } attr_writer :quality + # Streaming protocol for adaptive bitrate streaming. sig do returns( T.nilable( @@ -355,12 +402,14 @@ module Imagekit end attr_writer :stream_protocol + # Array of quality representations for adaptive bitrate streaming. sig { returns(T.nilable(T::Array[String])) } attr_reader :variants sig { params(variants: T::Array[String]).void } attr_writer :variants + # Video codec used for encoding (h264 or vp9). sig do returns( T.nilable( @@ -378,6 +427,7 @@ module Imagekit end attr_writer :video_codec + # Configuration options for video transformations. sig do params( audio_codec: @@ -394,12 +444,19 @@ module Imagekit ).returns(T.attached_class) end def self.new( + # Audio codec used for encoding (aac or opus). audio_codec: nil, + # Whether to automatically rotate the video based on metadata. auto_rotate: nil, + # Output format for the transformed video or thumbnail. format_: nil, + # Quality setting for the output video. quality: nil, + # Streaming protocol for adaptive bitrate streaming. stream_protocol: nil, + # Array of quality representations for adaptive bitrate streaming. variants: nil, + # Video codec used for encoding (h264 or vp9). video_codec: nil ) end @@ -424,6 +481,7 @@ module Imagekit def to_hash end + # Audio codec used for encoding (aac or opus). module AudioCodec extend Imagekit::Internal::Type::Enum @@ -458,6 +516,7 @@ module Imagekit end end + # Output format for the transformed video or thumbnail. module Format extend Imagekit::Internal::Type::Enum @@ -507,6 +566,7 @@ module Imagekit end end + # Streaming protocol for adaptive bitrate streaming. module StreamProtocol extend Imagekit::Internal::Type::Enum @@ -541,6 +601,7 @@ module Imagekit end end + # Video codec used for encoding (h264 or vp9). module VideoCodec extend Imagekit::Internal::Type::Enum @@ -585,9 +646,11 @@ module Imagekit ) end + # URL to access the transformed video. sig { returns(String) } attr_accessor :url + # Metadata of the output video file. sig do returns( T.nilable( @@ -605,6 +668,7 @@ module Imagekit end attr_writer :video_metadata + # Information about the transformed output video. sig do params( url: String, @@ -612,7 +676,12 @@ module Imagekit Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash ).returns(T.attached_class) end - def self.new(url:, video_metadata: nil) + def self.new( + # URL to access the transformed video. + url:, + # Metadata of the output video file. + video_metadata: nil + ) end sig do @@ -636,18 +705,23 @@ module Imagekit ) end + # Bitrate of the output video in bits per second. sig { returns(Integer) } attr_accessor :bitrate + # Duration of the output video in seconds. sig { returns(Float) } attr_accessor :duration + # Height of the output video in pixels. sig { returns(Integer) } attr_accessor :height + # Width of the output video in pixels. sig { returns(Integer) } attr_accessor :width + # Metadata of the output video file. sig do params( bitrate: Integer, @@ -656,7 +730,16 @@ module Imagekit width: Integer ).returns(T.attached_class) end - def self.new(bitrate:, duration:, height:, width:) + def self.new( + # Bitrate of the output video in bits per second. + bitrate:, + # Duration of the output video in seconds. + duration:, + # Height of the output video in pixels. + height:, + # Width of the output video in pixels. + width: + ) end sig do @@ -685,32 +768,33 @@ module Imagekit ) end - # URL of the submitted request. + # Full URL of the transformation request that was submitted. sig { returns(String) } attr_accessor :url - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. sig { returns(String) } attr_accessor :x_request_id - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. sig { returns(T.nilable(String)) } attr_reader :user_agent sig { params(user_agent: String).void } attr_writer :user_agent + # Information about the original request that triggered the video transformation. sig do params(url: String, x_request_id: String, user_agent: String).returns( T.attached_class ) end def self.new( - # URL of the submitted request. + # Full URL of the transformation request that was submitted. url:, - # Unique ID for the originating request. + # Unique identifier for the originating transformation request. x_request_id:, - # User-Agent header of the originating request. + # User-Agent header from the original request that triggered the transformation. user_agent: nil ) end @@ -733,20 +817,22 @@ module Imagekit ) end - # Milliseconds spent downloading the source. + # Time spent downloading the source video from your origin or media library, in + # milliseconds. sig { returns(T.nilable(Integer)) } attr_reader :download_duration sig { params(download_duration: Integer).void } attr_writer :download_duration - # Milliseconds spent encoding. + # Time spent encoding the video, in milliseconds. sig { returns(T.nilable(Integer)) } attr_reader :encoding_duration sig { params(encoding_duration: Integer).void } attr_writer :encoding_duration + # Performance metrics for the transformation process. sig do params( download_duration: Integer, @@ -754,9 +840,10 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Milliseconds spent downloading the source. + # Time spent downloading the source video from your origin or media library, in + # milliseconds. download_duration: nil, - # Milliseconds spent encoding. + # Time spent encoding the video, in milliseconds. encoding_duration: nil ) end diff --git a/rbi/imagekit/resources/webhooks.rbi b/rbi/imagekit/resources/webhooks.rbi index 05c1e68b..4405ca05 100644 --- a/rbi/imagekit/resources/webhooks.rbi +++ b/rbi/imagekit/resources/webhooks.rbi @@ -8,7 +8,11 @@ module Imagekit T.any( Imagekit::VideoTransformationAcceptedEvent, Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationErrorEvent, + Imagekit::UploadPreTransformSuccessWebhookEvent, + Imagekit::UploadPreTransformErrorWebhookEvent, + Imagekit::UploadPostTransformSuccessWebhookEvent, + Imagekit::UploadPostTransformErrorWebhookEvent ) ) end @@ -23,7 +27,11 @@ module Imagekit T.any( Imagekit::VideoTransformationAcceptedEvent, Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent + Imagekit::VideoTransformationErrorEvent, + Imagekit::UploadPreTransformSuccessWebhookEvent, + Imagekit::UploadPreTransformErrorWebhookEvent, + Imagekit::UploadPostTransformSuccessWebhookEvent, + Imagekit::UploadPostTransformErrorWebhookEvent ) ) end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 13ded142..b6c590cc 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -85,6 +85,14 @@ module Imagekit module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + class UploadPostTransformErrorWebhookEvent = Imagekit::Models::UploadPostTransformErrorWebhookEvent + + class UploadPostTransformSuccessWebhookEvent = Imagekit::Models::UploadPostTransformSuccessWebhookEvent + + class UploadPreTransformErrorWebhookEvent = Imagekit::Models::UploadPreTransformErrorWebhookEvent + + class UploadPreTransformSuccessWebhookEvent = Imagekit::Models::UploadPreTransformSuccessWebhookEvent + class VideoOverlay = Imagekit::Models::VideoOverlay class VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent diff --git a/sig/imagekit/models/image_overlay.rbs b/sig/imagekit/models/image_overlay.rbs index 7628473e..83313253 100644 --- a/sig/imagekit/models/image_overlay.rbs +++ b/sig/imagekit/models/image_overlay.rbs @@ -3,7 +3,7 @@ module Imagekit type image_overlay = { input: String, - type: Imagekit::Models::ImageOverlay::type_, + type: :image, encoding: Imagekit::Models::ImageOverlay::encoding, transformation: ::Array[Imagekit::Transformation] } @@ -13,11 +13,9 @@ module Imagekit def input=: (String _) -> String - def `type`: -> Imagekit::Models::ImageOverlay::type_ + def `type`: -> :image - def type=: ( - Imagekit::Models::ImageOverlay::type_ _ - ) -> Imagekit::Models::ImageOverlay::type_ + def type=: (:image _) -> :image def encoding: -> Imagekit::Models::ImageOverlay::encoding? @@ -33,28 +31,18 @@ module Imagekit def initialize: ( input: String, - type: Imagekit::Models::ImageOverlay::type_, ?encoding: Imagekit::Models::ImageOverlay::encoding, - ?transformation: ::Array[Imagekit::Transformation] + ?transformation: ::Array[Imagekit::Transformation], + ?type: :image ) -> void def to_hash: -> { input: String, - type: Imagekit::Models::ImageOverlay::type_, + type: :image, encoding: Imagekit::Models::ImageOverlay::encoding, transformation: ::Array[Imagekit::Transformation] } - type type_ = :image - - module Type - extend Imagekit::Internal::Type::Enum - - IMAGE: :image - - def self?.values: -> ::Array[Imagekit::Models::ImageOverlay::type_] - end - type encoding = :auto | :plain | :base64 module Encoding diff --git a/sig/imagekit/models/solid_color_overlay.rbs b/sig/imagekit/models/solid_color_overlay.rbs index f006d7a6..1b4271e4 100644 --- a/sig/imagekit/models/solid_color_overlay.rbs +++ b/sig/imagekit/models/solid_color_overlay.rbs @@ -3,7 +3,7 @@ module Imagekit type solid_color_overlay = { color: String, - type: Imagekit::Models::SolidColorOverlay::type_, + type: :solidColor, transformation: ::Array[Imagekit::SolidColorOverlayTransformation] } @@ -12,11 +12,9 @@ module Imagekit def color=: (String _) -> String - def `type`: -> Imagekit::Models::SolidColorOverlay::type_ + def `type`: -> :solidColor - def type=: ( - Imagekit::Models::SolidColorOverlay::type_ _ - ) -> Imagekit::Models::SolidColorOverlay::type_ + def type=: (:solidColor _) -> :solidColor def transformation: -> ::Array[Imagekit::SolidColorOverlayTransformation]? @@ -26,25 +24,15 @@ module Imagekit def initialize: ( color: String, - type: Imagekit::Models::SolidColorOverlay::type_, - ?transformation: ::Array[Imagekit::SolidColorOverlayTransformation] + ?transformation: ::Array[Imagekit::SolidColorOverlayTransformation], + ?type: :solidColor ) -> void def to_hash: -> { color: String, - type: Imagekit::Models::SolidColorOverlay::type_, + type: :solidColor, transformation: ::Array[Imagekit::SolidColorOverlayTransformation] } - - type type_ = :solidColor - - module Type - extend Imagekit::Internal::Type::Enum - - SOLID_COLOR: :solidColor - - def self?.values: -> ::Array[Imagekit::Models::SolidColorOverlay::type_] - end end end end diff --git a/sig/imagekit/models/solid_color_overlay_transformation.rbs b/sig/imagekit/models/solid_color_overlay_transformation.rbs index d750909f..3e664364 100644 --- a/sig/imagekit/models/solid_color_overlay_transformation.rbs +++ b/sig/imagekit/models/solid_color_overlay_transformation.rbs @@ -67,8 +67,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::gradient] - - TRUE: true end type height = Float | String @@ -85,8 +83,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::radius] - - MAX: :max end type width = Float | String diff --git a/sig/imagekit/models/subtitle_overlay.rbs b/sig/imagekit/models/subtitle_overlay.rbs index cd9be699..ce4b25d9 100644 --- a/sig/imagekit/models/subtitle_overlay.rbs +++ b/sig/imagekit/models/subtitle_overlay.rbs @@ -3,7 +3,7 @@ module Imagekit type subtitle_overlay = { input: String, - type: Imagekit::Models::SubtitleOverlay::type_, + type: :subtitle, encoding: Imagekit::Models::SubtitleOverlay::encoding, transformation: ::Array[Imagekit::SubtitleOverlayTransformation] } @@ -13,11 +13,9 @@ module Imagekit def input=: (String _) -> String - def `type`: -> Imagekit::Models::SubtitleOverlay::type_ + def `type`: -> :subtitle - def type=: ( - Imagekit::Models::SubtitleOverlay::type_ _ - ) -> Imagekit::Models::SubtitleOverlay::type_ + def type=: (:subtitle _) -> :subtitle def encoding: -> Imagekit::Models::SubtitleOverlay::encoding? @@ -33,28 +31,18 @@ module Imagekit def initialize: ( input: String, - type: Imagekit::Models::SubtitleOverlay::type_, ?encoding: Imagekit::Models::SubtitleOverlay::encoding, - ?transformation: ::Array[Imagekit::SubtitleOverlayTransformation] + ?transformation: ::Array[Imagekit::SubtitleOverlayTransformation], + ?type: :subtitle ) -> void def to_hash: -> { input: String, - type: Imagekit::Models::SubtitleOverlay::type_, + type: :subtitle, encoding: Imagekit::Models::SubtitleOverlay::encoding, transformation: ::Array[Imagekit::SubtitleOverlayTransformation] } - type type_ = :subtitle - - module Type - extend Imagekit::Internal::Type::Enum - - SUBTITLE: :subtitle - - def self?.values: -> ::Array[Imagekit::Models::SubtitleOverlay::type_] - end - type encoding = :auto | :plain | :base64 module Encoding diff --git a/sig/imagekit/models/subtitle_overlay_transformation.rbs b/sig/imagekit/models/subtitle_overlay_transformation.rbs index 35b7498d..21d04177 100644 --- a/sig/imagekit/models/subtitle_overlay_transformation.rbs +++ b/sig/imagekit/models/subtitle_overlay_transformation.rbs @@ -7,7 +7,7 @@ module Imagekit font_family: String, font_outline: String, font_shadow: String, - font_size: Imagekit::Models::SubtitleOverlayTransformation::font_size, + font_size: Float, typography: Imagekit::Models::SubtitleOverlayTransformation::typography } @@ -32,11 +32,9 @@ module Imagekit def font_shadow=: (String) -> String - attr_reader font_size: Imagekit::Models::SubtitleOverlayTransformation::font_size? + attr_reader font_size: Float? - def font_size=: ( - Imagekit::Models::SubtitleOverlayTransformation::font_size - ) -> Imagekit::Models::SubtitleOverlayTransformation::font_size + def font_size=: (Float) -> Float attr_reader typography: Imagekit::Models::SubtitleOverlayTransformation::typography? @@ -50,7 +48,7 @@ module Imagekit ?font_family: String, ?font_outline: String, ?font_shadow: String, - ?font_size: Imagekit::Models::SubtitleOverlayTransformation::font_size, + ?font_size: Float, ?typography: Imagekit::Models::SubtitleOverlayTransformation::typography ) -> void @@ -60,18 +58,10 @@ module Imagekit font_family: String, font_outline: String, font_shadow: String, - font_size: Imagekit::Models::SubtitleOverlayTransformation::font_size, + font_size: Float, typography: Imagekit::Models::SubtitleOverlayTransformation::typography } - type font_size = Float | String - - module FontSize - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::SubtitleOverlayTransformation::font_size] - end - type typography = :b | :i | :b_i module Typography diff --git a/sig/imagekit/models/text_overlay.rbs b/sig/imagekit/models/text_overlay.rbs index 6a60c741..ae294eef 100644 --- a/sig/imagekit/models/text_overlay.rbs +++ b/sig/imagekit/models/text_overlay.rbs @@ -3,7 +3,7 @@ module Imagekit type text_overlay = { text: String, - type: Imagekit::Models::TextOverlay::type_, + type: :text, encoding: Imagekit::Models::TextOverlay::encoding, transformation: ::Array[Imagekit::TextOverlayTransformation] } @@ -13,11 +13,9 @@ module Imagekit def text=: (String _) -> String - def `type`: -> Imagekit::Models::TextOverlay::type_ + def `type`: -> :text - def type=: ( - Imagekit::Models::TextOverlay::type_ _ - ) -> Imagekit::Models::TextOverlay::type_ + def type=: (:text _) -> :text def encoding: -> Imagekit::Models::TextOverlay::encoding? @@ -33,28 +31,18 @@ module Imagekit def initialize: ( text: String, - type: Imagekit::Models::TextOverlay::type_, ?encoding: Imagekit::Models::TextOverlay::encoding, - ?transformation: ::Array[Imagekit::TextOverlayTransformation] + ?transformation: ::Array[Imagekit::TextOverlayTransformation], + ?type: :text ) -> void def to_hash: -> { text: String, - type: Imagekit::Models::TextOverlay::type_, + type: :text, encoding: Imagekit::Models::TextOverlay::encoding, transformation: ::Array[Imagekit::TextOverlayTransformation] } - type type_ = :text - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :text - - def self?.values: -> ::Array[Imagekit::Models::TextOverlay::type_] - end - type encoding = :auto | :plain | :base64 module Encoding diff --git a/sig/imagekit/models/text_overlay_transformation.rbs b/sig/imagekit/models/text_overlay_transformation.rbs index 685b1ea0..db0f4c8b 100644 --- a/sig/imagekit/models/text_overlay_transformation.rbs +++ b/sig/imagekit/models/text_overlay_transformation.rbs @@ -13,7 +13,7 @@ module Imagekit padding: Imagekit::Models::TextOverlayTransformation::padding, radius: Imagekit::Models::TextOverlayTransformation::radius, rotation: Imagekit::Models::TextOverlayTransformation::rotation, - typography: Imagekit::Models::TextOverlayTransformation::typography, + typography: String, width: Imagekit::Models::TextOverlayTransformation::width } @@ -76,11 +76,9 @@ module Imagekit Imagekit::Models::TextOverlayTransformation::rotation ) -> Imagekit::Models::TextOverlayTransformation::rotation - attr_reader typography: Imagekit::Models::TextOverlayTransformation::typography? + attr_reader typography: String? - def typography=: ( - Imagekit::Models::TextOverlayTransformation::typography - ) -> Imagekit::Models::TextOverlayTransformation::typography + def typography=: (String) -> String attr_reader width: Imagekit::Models::TextOverlayTransformation::width? @@ -100,7 +98,7 @@ module Imagekit ?padding: Imagekit::Models::TextOverlayTransformation::padding, ?radius: Imagekit::Models::TextOverlayTransformation::radius, ?rotation: Imagekit::Models::TextOverlayTransformation::rotation, - ?typography: Imagekit::Models::TextOverlayTransformation::typography, + ?typography: String, ?width: Imagekit::Models::TextOverlayTransformation::width ) -> void @@ -116,7 +114,7 @@ module Imagekit padding: Imagekit::Models::TextOverlayTransformation::padding, radius: Imagekit::Models::TextOverlayTransformation::radius, rotation: Imagekit::Models::TextOverlayTransformation::rotation, - typography: Imagekit::Models::TextOverlayTransformation::typography, + typography: String, width: Imagekit::Models::TextOverlayTransformation::width } @@ -175,8 +173,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::radius] - - MAX: :max end type rotation = Float | String @@ -187,18 +183,6 @@ module Imagekit def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::rotation] end - type typography = :b | :i | :b_i - - module Typography - extend Imagekit::Internal::Type::Enum - - B: :b - I: :i - B_I: :b_i - - def self?.values: -> ::Array[Imagekit::Models::TextOverlayTransformation::typography] - end - type width = Float | String module Width diff --git a/sig/imagekit/models/transformation.rbs b/sig/imagekit/models/transformation.rbs index 55bde641..afbf4af0 100644 --- a/sig/imagekit/models/transformation.rbs +++ b/sig/imagekit/models/transformation.rbs @@ -4,6 +4,7 @@ module Imagekit { ai_change_background: String, ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, + ai_edit: String, ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, ai_retouch: Imagekit::Models::Transformation::ai_retouch, @@ -66,6 +67,10 @@ module Imagekit Imagekit::Models::Transformation::ai_drop_shadow ) -> Imagekit::Models::Transformation::ai_drop_shadow + attr_reader ai_edit: String? + + def ai_edit=: (String) -> String + attr_reader ai_remove_background: Imagekit::Models::Transformation::ai_remove_background? def ai_remove_background=: ( @@ -329,6 +334,7 @@ module Imagekit def initialize: ( ?ai_change_background: String, ?ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, + ?ai_edit: String, ?ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, ?ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, ?ai_retouch: Imagekit::Models::Transformation::ai_retouch, @@ -383,6 +389,7 @@ module Imagekit def to_hash: -> { ai_change_background: String, ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, + ai_edit: String, ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, ai_retouch: Imagekit::Models::Transformation::ai_retouch, @@ -440,8 +447,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::Transformation::ai_drop_shadow] - - TRUE: true end type ai_remove_background = true @@ -617,8 +622,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::Transformation::gradient] - - TRUE: true end type grayscale = true @@ -653,8 +656,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::Transformation::radius] - - MAX: :max end type rotation = Float | String @@ -671,8 +672,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::Transformation::shadow] - - TRUE: true end type sharpen = true | Float @@ -681,8 +680,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::Transformation::sharpen] - - TRUE: true end type start_offset = Float | String @@ -699,8 +696,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::Transformation::trim] - - TRUE: true end type unsharp_mask = true | String @@ -709,8 +704,6 @@ module Imagekit extend Imagekit::Internal::Type::Union def self?.variants: -> ::Array[Imagekit::Models::Transformation::unsharp_mask] - - TRUE: true end type video_codec = :h264 | :vp9 | :av1 | :none diff --git a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs index 0a683e9d..a7f19f5c 100644 --- a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs @@ -4,6 +4,10 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent | Imagekit::VideoTransformationReadyEvent | Imagekit::VideoTransformationErrorEvent + | Imagekit::UploadPreTransformSuccessWebhookEvent + | Imagekit::UploadPreTransformErrorWebhookEvent + | Imagekit::UploadPostTransformSuccessWebhookEvent + | Imagekit::UploadPostTransformErrorWebhookEvent module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/unwrap_webhook_event.rbs b/sig/imagekit/models/unwrap_webhook_event.rbs index c3224e6d..ab4bec4e 100644 --- a/sig/imagekit/models/unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unwrap_webhook_event.rbs @@ -4,6 +4,10 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent | Imagekit::VideoTransformationReadyEvent | Imagekit::VideoTransformationErrorEvent + | Imagekit::UploadPreTransformSuccessWebhookEvent + | Imagekit::UploadPreTransformErrorWebhookEvent + | Imagekit::UploadPostTransformSuccessWebhookEvent + | Imagekit::UploadPostTransformErrorWebhookEvent module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/upload_post_transform_error_webhook_event.rbs b/sig/imagekit/models/upload_post_transform_error_webhook_event.rbs new file mode 100644 index 00000000..33442c0d --- /dev/null +++ b/sig/imagekit/models/upload_post_transform_error_webhook_event.rbs @@ -0,0 +1,183 @@ +module Imagekit + module Models + type upload_post_transform_error_webhook_event = + { + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformErrorWebhookEvent::Data, + request: Imagekit::UploadPostTransformErrorWebhookEvent::Request, + type: :"upload.post-transform.error" + } + + class UploadPostTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor created_at: Time + + attr_accessor data: Imagekit::UploadPostTransformErrorWebhookEvent::Data + + attr_accessor request: Imagekit::UploadPostTransformErrorWebhookEvent::Request + + attr_accessor type: :"upload.post-transform.error" + + def initialize: ( + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformErrorWebhookEvent::Data, + request: Imagekit::UploadPostTransformErrorWebhookEvent::Request, + ?type: :"upload.post-transform.error" + ) -> void + + def to_hash: -> { + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformErrorWebhookEvent::Data, + request: Imagekit::UploadPostTransformErrorWebhookEvent::Request, + type: :"upload.post-transform.error" + } + + type data = + { + file_id: String, + name: String, + path: String, + transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + url: String + } + + class Data < Imagekit::Internal::Type::BaseModel + attr_accessor file_id: String + + attr_accessor name: String + + attr_accessor path: String + + attr_accessor transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation + + attr_accessor url: String + + def initialize: ( + file_id: String, + name: String, + path: String, + transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + url: String + ) -> void + + def to_hash: -> { + file_id: String, + name: String, + path: String, + transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + url: String + } + + type transformation = + { + error: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor error: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + + def initialize: ( + error: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + ) -> void + + def to_hash: -> { + error: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + } + + type error = { reason: String } + + class Error < Imagekit::Internal::Type::BaseModel + attr_accessor reason: String + + def initialize: (reason: String) -> void + + def to_hash: -> { reason: String } + end + end + end + + type request = + { + transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + x_request_id: String + } + + class Request < Imagekit::Internal::Type::BaseModel + attr_accessor transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation + + attr_accessor x_request_id: String + + def initialize: ( + transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + x_request_id: String + ) -> void + + def to_hash: -> { + transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + x_request_id: String + } + + type transformation = + { + type: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_, + protocol: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol, + value: String + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_ + + attr_reader protocol: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol? + + def protocol=: ( + Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol + ) -> Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol + + attr_reader value: String? + + def value=: (String) -> String + + def initialize: ( + type: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_, + ?protocol: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol, + ?value: String + ) -> void + + def to_hash: -> { + type: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_, + protocol: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol, + value: String + } + + type type_ = :transformation | :abs | :"gif-to-video" | :thumbnail + + module Type + extend Imagekit::Internal::Type::Enum + + TRANSFORMATION: :transformation + ABS: :abs + GIF_TO_VIDEO: :"gif-to-video" + THUMBNAIL: :thumbnail + + def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_] + end + + type protocol = :hls | :dash + + module Protocol + extend Imagekit::Internal::Type::Enum + + HLS: :hls + DASH: :dash + + def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol] + end + end + end + end + end +end diff --git a/sig/imagekit/models/upload_post_transform_success_webhook_event.rbs b/sig/imagekit/models/upload_post_transform_success_webhook_event.rbs new file mode 100644 index 00000000..d26578f7 --- /dev/null +++ b/sig/imagekit/models/upload_post_transform_success_webhook_event.rbs @@ -0,0 +1,133 @@ +module Imagekit + module Models + type upload_post_transform_success_webhook_event = + { + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data, + request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + type: :"upload.post-transform.success" + } + + class UploadPostTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor created_at: Time + + attr_accessor data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data + + attr_accessor request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request + + attr_accessor type: :"upload.post-transform.success" + + def initialize: ( + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data, + request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + ?type: :"upload.post-transform.success" + ) -> void + + def to_hash: -> { + id: String, + created_at: Time, + data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data, + request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + type: :"upload.post-transform.success" + } + + type data = { file_id: String, name: String, url: String } + + class Data < Imagekit::Internal::Type::BaseModel + attr_accessor file_id: String + + attr_accessor name: String + + attr_accessor url: String + + def initialize: (file_id: String, name: String, url: String) -> void + + def to_hash: -> { file_id: String, name: String, url: String } + end + + type request = + { + transformation: Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + x_request_id: String + } + + class Request < Imagekit::Internal::Type::BaseModel + attr_accessor transformation: Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation + + attr_accessor x_request_id: String + + def initialize: ( + transformation: Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + x_request_id: String + ) -> void + + def to_hash: -> { + transformation: Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + x_request_id: String + } + + type transformation = + { + type: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_, + protocol: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol, + value: String + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_ + + attr_reader protocol: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol? + + def protocol=: ( + Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol + ) -> Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol + + attr_reader value: String? + + def value=: (String) -> String + + def initialize: ( + type: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_, + ?protocol: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol, + ?value: String + ) -> void + + def to_hash: -> { + type: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_, + protocol: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol, + value: String + } + + type type_ = :transformation | :abs | :"gif-to-video" | :thumbnail + + module Type + extend Imagekit::Internal::Type::Enum + + TRANSFORMATION: :transformation + ABS: :abs + GIF_TO_VIDEO: :"gif-to-video" + THUMBNAIL: :thumbnail + + def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_] + end + + type protocol = :hls | :dash + + module Protocol + extend Imagekit::Internal::Type::Enum + + HLS: :hls + DASH: :dash + + def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol] + end + end + end + end + end +end diff --git a/sig/imagekit/models/upload_pre_transform_error_webhook_event.rbs b/sig/imagekit/models/upload_pre_transform_error_webhook_event.rbs new file mode 100644 index 00000000..b5304e7a --- /dev/null +++ b/sig/imagekit/models/upload_pre_transform_error_webhook_event.rbs @@ -0,0 +1,106 @@ +module Imagekit + module Models + type upload_pre_transform_error_webhook_event = + { + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformErrorWebhookEvent::Data, + request: Imagekit::UploadPreTransformErrorWebhookEvent::Request, + type: :"upload.pre-transform.error" + } + + class UploadPreTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor created_at: Time + + attr_accessor data: Imagekit::UploadPreTransformErrorWebhookEvent::Data + + attr_accessor request: Imagekit::UploadPreTransformErrorWebhookEvent::Request + + attr_accessor type: :"upload.pre-transform.error" + + def initialize: ( + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformErrorWebhookEvent::Data, + request: Imagekit::UploadPreTransformErrorWebhookEvent::Request, + ?type: :"upload.pre-transform.error" + ) -> void + + def to_hash: -> { + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformErrorWebhookEvent::Data, + request: Imagekit::UploadPreTransformErrorWebhookEvent::Request, + type: :"upload.pre-transform.error" + } + + type data = + { + name: String, + path: String, + transformation: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + } + + class Data < Imagekit::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor path: String + + attr_accessor transformation: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + + def initialize: ( + name: String, + path: String, + transformation: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + ) -> void + + def to_hash: -> { + name: String, + path: String, + transformation: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + } + + type transformation = + { + error: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + } + + class Transformation < Imagekit::Internal::Type::BaseModel + attr_accessor error: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + + def initialize: ( + error: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + ) -> void + + def to_hash: -> { + error: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + } + + type error = { reason: String } + + class Error < Imagekit::Internal::Type::BaseModel + attr_accessor reason: String + + def initialize: (reason: String) -> void + + def to_hash: -> { reason: String } + end + end + end + + type request = { transformation: String, x_request_id: String } + + class Request < Imagekit::Internal::Type::BaseModel + attr_accessor transformation: String + + attr_accessor x_request_id: String + + def initialize: (transformation: String, x_request_id: String) -> void + + def to_hash: -> { transformation: String, x_request_id: String } + end + end + end +end diff --git a/sig/imagekit/models/upload_pre_transform_success_webhook_event.rbs b/sig/imagekit/models/upload_pre_transform_success_webhook_event.rbs new file mode 100644 index 00000000..5c22fbe1 --- /dev/null +++ b/sig/imagekit/models/upload_pre_transform_success_webhook_event.rbs @@ -0,0 +1,345 @@ +module Imagekit + module Models + type upload_pre_transform_success_webhook_event = + { + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data, + request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + type: :"upload.pre-transform.success" + } + + class UploadPreTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor created_at: Time + + attr_accessor data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data + + attr_accessor request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request + + attr_accessor type: :"upload.pre-transform.success" + + def initialize: ( + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data, + request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + ?type: :"upload.pre-transform.success" + ) -> void + + def to_hash: -> { + id: String, + created_at: Time, + data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data, + request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + type: :"upload.pre-transform.success" + } + + type data = + { + ai_tags: ::Array[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + video_codec: String, + width: Float + } + + class Data < Imagekit::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag]? + + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: ::Hash[Symbol, top]? + + def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader extension_status: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus? + + def extension_status=: ( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus + ) -> Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader metadata: Imagekit::Metadata? + + def metadata=: (Imagekit::Metadata) -> Imagekit::Metadata + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail_url: String? + + def thumbnail_url=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo? + + def version_info=: ( + Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo + ) -> Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?duration: Integer, + ?embedded_metadata: ::Hash[Symbol, top], + ?extension_status: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?metadata: Imagekit::Metadata, + ?name: String, + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail_url: String, + ?url: String, + ?version_info: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + ?video_codec: String, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekit::Metadata, + name: String, + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + video_codec: String, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekit::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type extension_status = + { + aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging + ) -> Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging + ) -> Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + ) -> Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + + def initialize: ( + ?aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + } + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg] + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekit::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + + type request = { transformation: String, x_request_id: String } + + class Request < Imagekit::Internal::Type::BaseModel + attr_accessor transformation: String + + attr_accessor x_request_id: String + + def initialize: (transformation: String, x_request_id: String) -> void + + def to_hash: -> { transformation: String, x_request_id: String } + end + end + end +end diff --git a/sig/imagekit/models/video_overlay.rbs b/sig/imagekit/models/video_overlay.rbs index ca6127d7..1c25b201 100644 --- a/sig/imagekit/models/video_overlay.rbs +++ b/sig/imagekit/models/video_overlay.rbs @@ -3,7 +3,7 @@ module Imagekit type video_overlay = { input: String, - type: Imagekit::Models::VideoOverlay::type_, + type: :video, encoding: Imagekit::Models::VideoOverlay::encoding, transformation: ::Array[Imagekit::Transformation] } @@ -13,11 +13,9 @@ module Imagekit def input=: (String _) -> String - def `type`: -> Imagekit::Models::VideoOverlay::type_ + def `type`: -> :video - def type=: ( - Imagekit::Models::VideoOverlay::type_ _ - ) -> Imagekit::Models::VideoOverlay::type_ + def type=: (:video _) -> :video def encoding: -> Imagekit::Models::VideoOverlay::encoding? @@ -33,28 +31,18 @@ module Imagekit def initialize: ( input: String, - type: Imagekit::Models::VideoOverlay::type_, ?encoding: Imagekit::Models::VideoOverlay::encoding, - ?transformation: ::Array[Imagekit::Transformation] + ?transformation: ::Array[Imagekit::Transformation], + ?type: :video ) -> void def to_hash: -> { input: String, - type: Imagekit::Models::VideoOverlay::type_, + type: :video, encoding: Imagekit::Models::VideoOverlay::encoding, transformation: ::Array[Imagekit::Transformation] } - type type_ = :video - - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO: :video - - def self?.values: -> ::Array[Imagekit::Models::VideoOverlay::type_] - end - type encoding = :auto | :plain | :base64 module Encoding diff --git a/sig/imagekit/resources/webhooks.rbs b/sig/imagekit/resources/webhooks.rbs index d0ffe5de..10c283c2 100644 --- a/sig/imagekit/resources/webhooks.rbs +++ b/sig/imagekit/resources/webhooks.rbs @@ -5,13 +5,21 @@ module Imagekit String payload ) -> (Imagekit::VideoTransformationAcceptedEvent | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent) + | Imagekit::VideoTransformationErrorEvent + | Imagekit::UploadPreTransformSuccessWebhookEvent + | Imagekit::UploadPreTransformErrorWebhookEvent + | Imagekit::UploadPostTransformSuccessWebhookEvent + | Imagekit::UploadPostTransformErrorWebhookEvent) def unwrap: ( String payload ) -> (Imagekit::VideoTransformationAcceptedEvent | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent) + | Imagekit::VideoTransformationErrorEvent + | Imagekit::UploadPreTransformSuccessWebhookEvent + | Imagekit::UploadPreTransformErrorWebhookEvent + | Imagekit::UploadPostTransformSuccessWebhookEvent + | Imagekit::UploadPostTransformErrorWebhookEvent) def initialize: (client: Imagekit::Client) -> void end From e754e53cede42c634061e9dec654cbfef833def1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 31 Aug 2025 08:49:09 +0000 Subject: [PATCH 078/178] feat(api): manual updates --- .stats.yml | 4 ++-- .../models/video_transformation_accepted_event.rb | 7 ++++--- .../models/video_transformation_error_event.rb | 7 ++++--- .../models/video_transformation_ready_event.rb | 7 ++++--- .../models/video_transformation_accepted_event.rbi | 11 ++++++++--- .../models/video_transformation_error_event.rbi | 11 ++++++++--- .../models/video_transformation_ready_event.rbi | 11 ++++++++--- .../models/video_transformation_accepted_event.rbs | 3 ++- .../models/video_transformation_error_event.rbs | 3 ++- .../models/video_transformation_ready_event.rbs | 3 ++- 10 files changed, 44 insertions(+), 23 deletions(-) diff --git a/.stats.yml b/.stats.yml index caed6f5a..66a8df1f 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-0cdbdd05084a8219bc003a34670472f198cf91e5f6402cede2cb1094b7bfd98d.yml -openapi_spec_hash: d337c89146f41fa215560bb5aef2e4ec +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-a49f0e337789b1a4368194ed004ac4c1b0c0cd2ce4344e14546422632242d897.yml +openapi_spec_hash: a7f3999c6227aac108cd80253ffc7730 config_hash: 249ee22f294858ab0971b8379f7cb519 diff --git a/lib/imagekit/models/video_transformation_accepted_event.rb b/lib/imagekit/models/video_transformation_accepted_event.rb index 1674c5ed..05cf00ab 100644 --- a/lib/imagekit/models/video_transformation_accepted_event.rb +++ b/lib/imagekit/models/video_transformation_accepted_event.rb @@ -173,7 +173,7 @@ class Options < Imagekit::Internal::Type::BaseModel optional :variants, Imagekit::Internal::Type::ArrayOf[String] # @!attribute video_codec - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). # # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, @@ -194,7 +194,7 @@ class Options < Imagekit::Internal::Type::BaseModel # # @param variants [Array] Array of quality representations for adaptive bitrate streaming. # - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264 or vp9). + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). # Audio codec used for encoding (aac or opus). # @@ -238,7 +238,7 @@ module StreamProtocol # @return [Array] end - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). # # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#video_codec module VideoCodec @@ -246,6 +246,7 @@ module VideoCodec H264 = :h264 VP9 = :vp9 + AV1 = :av1 # @!method self.values # @return [Array] diff --git a/lib/imagekit/models/video_transformation_error_event.rb b/lib/imagekit/models/video_transformation_error_event.rb index 8d783e74..fe6c9a88 100644 --- a/lib/imagekit/models/video_transformation_error_event.rb +++ b/lib/imagekit/models/video_transformation_error_event.rb @@ -220,7 +220,7 @@ class Options < Imagekit::Internal::Type::BaseModel optional :variants, Imagekit::Internal::Type::ArrayOf[String] # @!attribute video_codec - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). # # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, @@ -241,7 +241,7 @@ class Options < Imagekit::Internal::Type::BaseModel # # @param variants [Array] Array of quality representations for adaptive bitrate streaming. # - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264 or vp9). + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). # Audio codec used for encoding (aac or opus). # @@ -285,7 +285,7 @@ module StreamProtocol # @return [Array] end - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). # # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#video_codec module VideoCodec @@ -293,6 +293,7 @@ module VideoCodec H264 = :h264 VP9 = :vp9 + AV1 = :av1 # @!method self.values # @return [Array] diff --git a/lib/imagekit/models/video_transformation_ready_event.rb b/lib/imagekit/models/video_transformation_ready_event.rb index 8937ab8e..076e88c4 100644 --- a/lib/imagekit/models/video_transformation_ready_event.rb +++ b/lib/imagekit/models/video_transformation_ready_event.rb @@ -187,7 +187,7 @@ class Options < Imagekit::Internal::Type::BaseModel optional :variants, Imagekit::Internal::Type::ArrayOf[String] # @!attribute video_codec - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). # # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, @@ -208,7 +208,7 @@ class Options < Imagekit::Internal::Type::BaseModel # # @param variants [Array] Array of quality representations for adaptive bitrate streaming. # - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264 or vp9). + # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). # Audio codec used for encoding (aac or opus). # @@ -252,7 +252,7 @@ module StreamProtocol # @return [Array] end - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). # # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#video_codec module VideoCodec @@ -260,6 +260,7 @@ module VideoCodec H264 = :h264 VP9 = :vp9 + AV1 = :av1 # @!method self.values # @return [Array] diff --git a/rbi/imagekit/models/video_transformation_accepted_event.rbi b/rbi/imagekit/models/video_transformation_accepted_event.rbi index 0fae8a8e..a7b609fc 100644 --- a/rbi/imagekit/models/video_transformation_accepted_event.rbi +++ b/rbi/imagekit/models/video_transformation_accepted_event.rbi @@ -376,7 +376,7 @@ module Imagekit sig { params(variants: T::Array[String]).void } attr_writer :variants - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). sig do returns( T.nilable( @@ -423,7 +423,7 @@ module Imagekit stream_protocol: nil, # Array of quality representations for adaptive bitrate streaming. variants: nil, - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). video_codec: nil ) end @@ -568,7 +568,7 @@ module Imagekit end end - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). module VideoCodec extend Imagekit::Internal::Type::Enum @@ -591,6 +591,11 @@ module Imagekit :vp9, Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) + AV1 = + T.let( + :av1, + Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/imagekit/models/video_transformation_error_event.rbi b/rbi/imagekit/models/video_transformation_error_event.rbi index f18ffb63..8b6b316d 100644 --- a/rbi/imagekit/models/video_transformation_error_event.rbi +++ b/rbi/imagekit/models/video_transformation_error_event.rbi @@ -486,7 +486,7 @@ module Imagekit sig { params(variants: T::Array[String]).void } attr_writer :variants - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). sig do returns( T.nilable( @@ -533,7 +533,7 @@ module Imagekit stream_protocol: nil, # Array of quality representations for adaptive bitrate streaming. variants: nil, - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). video_codec: nil ) end @@ -678,7 +678,7 @@ module Imagekit end end - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). module VideoCodec extend Imagekit::Internal::Type::Enum @@ -701,6 +701,11 @@ module Imagekit :vp9, Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) + AV1 = + T.let( + :av1, + Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/imagekit/models/video_transformation_ready_event.rbi b/rbi/imagekit/models/video_transformation_ready_event.rbi index e68293f3..3b8c06d0 100644 --- a/rbi/imagekit/models/video_transformation_ready_event.rbi +++ b/rbi/imagekit/models/video_transformation_ready_event.rbi @@ -409,7 +409,7 @@ module Imagekit sig { params(variants: T::Array[String]).void } attr_writer :variants - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). sig do returns( T.nilable( @@ -456,7 +456,7 @@ module Imagekit stream_protocol: nil, # Array of quality representations for adaptive bitrate streaming. variants: nil, - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). video_codec: nil ) end @@ -601,7 +601,7 @@ module Imagekit end end - # Video codec used for encoding (h264 or vp9). + # Video codec used for encoding (h264, vp9, or av1). module VideoCodec extend Imagekit::Internal::Type::Enum @@ -624,6 +624,11 @@ module Imagekit :vp9, Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) + AV1 = + T.let( + :av1, + Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + ) sig do override.returns( diff --git a/sig/imagekit/models/video_transformation_accepted_event.rbs b/sig/imagekit/models/video_transformation_accepted_event.rbs index c1e84f58..110ece17 100644 --- a/sig/imagekit/models/video_transformation_accepted_event.rbs +++ b/sig/imagekit/models/video_transformation_accepted_event.rbs @@ -209,13 +209,14 @@ module Imagekit def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol] end - type video_codec = :h264 | :vp9 + type video_codec = :h264 | :vp9 | :av1 module VideoCodec extend Imagekit::Internal::Type::Enum H264: :h264 VP9: :vp9 + AV1: :av1 def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec] end diff --git a/sig/imagekit/models/video_transformation_error_event.rbs b/sig/imagekit/models/video_transformation_error_event.rbs index f0a40b5a..18a7d33c 100644 --- a/sig/imagekit/models/video_transformation_error_event.rbs +++ b/sig/imagekit/models/video_transformation_error_event.rbs @@ -248,13 +248,14 @@ module Imagekit def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol] end - type video_codec = :h264 | :vp9 + type video_codec = :h264 | :vp9 | :av1 module VideoCodec extend Imagekit::Internal::Type::Enum H264: :h264 VP9: :vp9 + AV1: :av1 def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec] end diff --git a/sig/imagekit/models/video_transformation_ready_event.rbs b/sig/imagekit/models/video_transformation_ready_event.rbs index 7af03de5..99c49603 100644 --- a/sig/imagekit/models/video_transformation_ready_event.rbs +++ b/sig/imagekit/models/video_transformation_ready_event.rbs @@ -227,13 +227,14 @@ module Imagekit def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol] end - type video_codec = :h264 | :vp9 + type video_codec = :h264 | :vp9 | :av1 module VideoCodec extend Imagekit::Internal::Type::Enum H264: :h264 VP9: :vp9 + AV1: :av1 def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec] end From 2b6a1063601dde20c374f357e00b17f63f333171 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 1 Sep 2025 05:26:30 +0000 Subject: [PATCH 079/178] feat(api): add signed URL options with expiration settings to enhance security features --- .stats.yml | 4 +-- lib/imagekit/models/src_options.rb | 31 ++++++++++++++++++- rbi/imagekit/models/src_options.rbi | 48 +++++++++++++++++++++++++++++ sig/imagekit/models/src_options.rbs | 14 +++++++++ 4 files changed, 94 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index 66a8df1f..cb2a3979 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-a49f0e337789b1a4368194ed004ac4c1b0c0cd2ce4344e14546422632242d897.yml -openapi_spec_hash: a7f3999c6227aac108cd80253ffc7730 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d857341f30517b11df568dd6c5a0e9dea3a854930f7f6583718114d311f2d5ee.yml +openapi_spec_hash: db94bfd556220d6244a1b2bbae9d7d00 config_hash: 249ee22f294858ab0971b8379f7cb519 diff --git a/lib/imagekit/models/src_options.rb b/lib/imagekit/models/src_options.rb index e6b2118c..ed73d6c7 100644 --- a/lib/imagekit/models/src_options.rb +++ b/lib/imagekit/models/src_options.rb @@ -18,6 +18,21 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # @return [String] required :url_endpoint, String, api_name: :urlEndpoint + # @!attribute expires_in + # 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). + # + # @return [Float, nil] + optional :expires_in, Float, api_name: :expiresIn + # @!attribute query_parameters # 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 @@ -26,6 +41,16 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # @return [Hash{Symbol=>String}, nil] optional :query_parameters, Imagekit::Internal::Type::HashOf[String], api_name: :queryParameters + # @!attribute signed + # 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). + # + # @return [Boolean, nil] + optional :signed, Imagekit::Internal::Type::Boolean + # @!attribute transformation # 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 @@ -46,7 +71,7 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel enum: -> { Imagekit::TransformationPosition }, api_name: :transformationPosition - # @!method initialize(src:, url_endpoint:, query_parameters: nil, transformation: nil, transformation_position: nil) + # @!method initialize(src:, url_endpoint:, expires_in: nil, query_parameters: nil, signed: nil, transformation: nil, transformation_position: nil) # Some parameter documentations has been truncated, see # {Imagekit::Models::SrcOptions} for more details. # @@ -57,8 +82,12 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # # @param url_endpoint [String] Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard # + # @param expires_in [Float] When you want the signed URL to expire, specified in seconds. If `expiresIn` is + # # @param query_parameters [Hash{Symbol=>String}] These are additional query parameters that you want to add to the final URL. # + # @param signed [Boolean] Whether to sign the URL or not. Set this to `true` if you want to generate a sig + # # @param transformation [Array] An array of objects specifying the transformations to be applied in the URL. If # # @param transformation_position [Symbol, Imagekit::Models::TransformationPosition] By default, the transformation string is added as a query parameter in the URL, diff --git a/rbi/imagekit/models/src_options.rbi b/rbi/imagekit/models/src_options.rbi index 9e03f135..30c5cdaf 100644 --- a/rbi/imagekit/models/src_options.rbi +++ b/rbi/imagekit/models/src_options.rbi @@ -19,6 +19,22 @@ module Imagekit sig { returns(String) } attr_accessor :url_endpoint + # 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). + sig { returns(T.nilable(Float)) } + attr_reader :expires_in + + sig { params(expires_in: Float).void } + attr_writer :expires_in + # 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. @@ -28,6 +44,17 @@ module Imagekit sig { params(query_parameters: T::Hash[Symbol, String]).void } attr_writer :query_parameters + # 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). + sig { returns(T.nilable(T::Boolean)) } + attr_reader :signed + + sig { params(signed: T::Boolean).void } + attr_writer :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 @@ -60,7 +87,9 @@ module Imagekit params( src: String, url_endpoint: String, + expires_in: Float, query_parameters: T::Hash[Symbol, String], + signed: T::Boolean, transformation: T::Array[Imagekit::Transformation::OrHash], transformation_position: Imagekit::TransformationPosition::OrSymbol ).returns(T.attached_class) @@ -73,10 +102,27 @@ module Imagekit # Get your urlEndpoint from the # [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints). url_endpoint:, + # 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). + expires_in: nil, # 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. query_parameters: nil, + # 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). + signed: nil, # 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 @@ -95,7 +141,9 @@ module Imagekit { src: String, url_endpoint: String, + expires_in: Float, query_parameters: T::Hash[Symbol, String], + signed: T::Boolean, transformation: T::Array[Imagekit::Transformation], transformation_position: Imagekit::TransformationPosition::OrSymbol } diff --git a/sig/imagekit/models/src_options.rbs b/sig/imagekit/models/src_options.rbs index e61692aa..185f2522 100644 --- a/sig/imagekit/models/src_options.rbs +++ b/sig/imagekit/models/src_options.rbs @@ -4,7 +4,9 @@ module Imagekit { src: String, url_endpoint: String, + expires_in: Float, query_parameters: ::Hash[Symbol, String], + signed: bool, transformation: ::Array[Imagekit::Transformation], transformation_position: Imagekit::Models::transformation_position } @@ -14,10 +16,18 @@ module Imagekit attr_accessor url_endpoint: String + attr_reader expires_in: Float? + + def expires_in=: (Float) -> Float + attr_reader query_parameters: ::Hash[Symbol, String]? def query_parameters=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String] + attr_reader signed: bool? + + def signed=: (bool) -> bool + attr_reader transformation: ::Array[Imagekit::Transformation]? def transformation=: ( @@ -33,7 +43,9 @@ module Imagekit def initialize: ( src: String, url_endpoint: String, + ?expires_in: Float, ?query_parameters: ::Hash[Symbol, String], + ?signed: bool, ?transformation: ::Array[Imagekit::Transformation], ?transformation_position: Imagekit::Models::transformation_position ) -> void @@ -41,7 +53,9 @@ module Imagekit def to_hash: -> { src: String, url_endpoint: String, + expires_in: Float, query_parameters: ::Hash[Symbol, String], + signed: bool, transformation: ::Array[Imagekit::Transformation], transformation_position: Imagekit::Models::transformation_position } From 09d943bf05bdcf12df30e3f3d0da1b572794af28 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 1 Sep 2025 08:32:03 +0000 Subject: [PATCH 080/178] feat(api): add new webhook events for upload transformations to enhance event tracking --- .stats.yml | 2 +- lib/imagekit.rb | 12 +- lib/imagekit/models.rb | 8 +- .../models/unsafe_unwrap_webhook_event.rb | 10 +- lib/imagekit/models/unwrap_webhook_event.rb | 10 +- ...b => upload_post_transform_error_event.rb} | 58 ++++----- ...=> upload_post_transform_success_event.rb} | 43 ++++--- ...rb => upload_pre_transform_error_event.rb} | 34 +++--- ... => upload_pre_transform_success_event.rb} | 71 ++++++----- lib/imagekit/resources/webhooks.rb | 4 +- rbi/imagekit/models.rbi | 15 ++- .../models/unsafe_unwrap_webhook_event.rbi | 8 +- rbi/imagekit/models/unwrap_webhook_event.rbi | 8 +- ... => upload_post_transform_error_event.rbi} | 94 +++++++-------- ...> upload_post_transform_success_event.rbi} | 70 ++++++----- ...i => upload_pre_transform_error_event.rbi} | 50 ++++---- ...=> upload_pre_transform_success_event.rbi} | 110 +++++++++--------- rbi/imagekit/resources/webhooks.rbi | 16 +-- sig/imagekit/models.rbs | 8 +- .../models/unsafe_unwrap_webhook_event.rbs | 8 +- sig/imagekit/models/unwrap_webhook_event.rbs | 8 +- ... => upload_post_transform_error_event.rbs} | 68 +++++------ ...> upload_post_transform_success_event.rbs} | 52 ++++----- ...s => upload_pre_transform_error_event.rbs} | 36 +++--- ...=> upload_pre_transform_success_event.rbs} | 94 +++++++-------- sig/imagekit/resources/webhooks.rbs | 16 +-- 26 files changed, 443 insertions(+), 470 deletions(-) rename lib/imagekit/models/{upload_post_transform_error_webhook_event.rb => upload_post_transform_error_event.rb} (73%) rename lib/imagekit/models/{upload_post_transform_success_webhook_event.rb => upload_post_transform_success_event.rb} (74%) rename lib/imagekit/models/{upload_pre_transform_error_webhook_event.rb => upload_pre_transform_error_event.rb} (74%) rename lib/imagekit/models/{upload_pre_transform_success_webhook_event.rb => upload_pre_transform_success_event.rb} (85%) rename rbi/imagekit/models/{upload_post_transform_error_webhook_event.rbi => upload_post_transform_error_event.rbi} (67%) rename rbi/imagekit/models/{upload_post_transform_success_webhook_event.rbi => upload_post_transform_success_event.rbi} (67%) rename rbi/imagekit/models/{upload_pre_transform_error_webhook_event.rbi => upload_pre_transform_error_event.rbi} (72%) rename rbi/imagekit/models/{upload_pre_transform_success_webhook_event.rbi => upload_pre_transform_success_event.rbi} (81%) rename sig/imagekit/models/{upload_post_transform_error_webhook_event.rbs => upload_post_transform_error_event.rbs} (57%) rename sig/imagekit/models/{upload_post_transform_success_webhook_event.rbs => upload_post_transform_success_event.rbs} (58%) rename sig/imagekit/models/{upload_pre_transform_error_webhook_event.rbs => upload_pre_transform_error_event.rbs} (58%) rename sig/imagekit/models/{upload_pre_transform_success_webhook_event.rbs => upload_pre_transform_success_event.rbs} (70%) diff --git a/.stats.yml b/.stats.yml index cb2a3979..6bb89db0 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-d857341f30517b11df568dd6c5a0e9dea3a854930f7f6583718114d311f2d5ee.yml openapi_spec_hash: db94bfd556220d6244a1b2bbae9d7d00 -config_hash: 249ee22f294858ab0971b8379f7cb519 +config_hash: 4ef178e13ecfdb97211f284f13a21e83 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index fd31caf3..4d38be1e 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -143,14 +143,10 @@ require_relative "imagekit/models/transformation_position" require_relative "imagekit/models/unsafe_unwrap_webhook_event" require_relative "imagekit/models/unwrap_webhook_event" -require_relative "imagekit/models/upload_post_transform_error_webhook_event" -require_relative "imagekit/models/upload_post_transform_error_webhook_event" -require_relative "imagekit/models/upload_post_transform_success_webhook_event" -require_relative "imagekit/models/upload_post_transform_success_webhook_event" -require_relative "imagekit/models/upload_pre_transform_error_webhook_event" -require_relative "imagekit/models/upload_pre_transform_error_webhook_event" -require_relative "imagekit/models/upload_pre_transform_success_webhook_event" -require_relative "imagekit/models/upload_pre_transform_success_webhook_event" +require_relative "imagekit/models/upload_post_transform_error_event" +require_relative "imagekit/models/upload_post_transform_success_event" +require_relative "imagekit/models/upload_pre_transform_error_event" +require_relative "imagekit/models/upload_pre_transform_success_event" require_relative "imagekit/models/video_overlay" require_relative "imagekit/models/video_transformation_accepted_event" require_relative "imagekit/models/video_transformation_error_event" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 120f805f..b8653a86 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -125,13 +125,13 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - UploadPostTransformErrorWebhookEvent = Imagekit::Models::UploadPostTransformErrorWebhookEvent + UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent - UploadPostTransformSuccessWebhookEvent = Imagekit::Models::UploadPostTransformSuccessWebhookEvent + UploadPostTransformSuccessEvent = Imagekit::Models::UploadPostTransformSuccessEvent - UploadPreTransformErrorWebhookEvent = Imagekit::Models::UploadPreTransformErrorWebhookEvent + UploadPreTransformErrorEvent = Imagekit::Models::UploadPreTransformErrorEvent - UploadPreTransformSuccessWebhookEvent = Imagekit::Models::UploadPreTransformSuccessWebhookEvent + UploadPreTransformSuccessEvent = Imagekit::Models::UploadPreTransformSuccessEvent VideoOverlay = Imagekit::Models::VideoOverlay diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb index d8b4d18d..28e1b855 100644 --- a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb @@ -18,19 +18,19 @@ module UnsafeUnwrapWebhookEvent variant -> { Imagekit::VideoTransformationErrorEvent } # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. - variant -> { Imagekit::UploadPreTransformSuccessWebhookEvent } + variant -> { Imagekit::UploadPreTransformSuccessEvent } # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. - variant -> { Imagekit::UploadPreTransformErrorWebhookEvent } + variant -> { Imagekit::UploadPreTransformErrorEvent } # 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. - variant -> { Imagekit::UploadPostTransformSuccessWebhookEvent } + variant -> { Imagekit::UploadPostTransformSuccessEvent } # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. - variant -> { Imagekit::UploadPostTransformErrorWebhookEvent } + variant -> { Imagekit::UploadPostTransformErrorEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessWebhookEvent, Imagekit::Models::UploadPreTransformErrorWebhookEvent, Imagekit::Models::UploadPostTransformSuccessWebhookEvent, Imagekit::Models::UploadPostTransformErrorWebhookEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessEvent, Imagekit::Models::UploadPreTransformErrorEvent, Imagekit::Models::UploadPostTransformSuccessEvent, Imagekit::Models::UploadPostTransformErrorEvent)] end end end diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb index d4986749..c200c085 100644 --- a/lib/imagekit/models/unwrap_webhook_event.rb +++ b/lib/imagekit/models/unwrap_webhook_event.rb @@ -18,19 +18,19 @@ module UnwrapWebhookEvent variant -> { Imagekit::VideoTransformationErrorEvent } # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. - variant -> { Imagekit::UploadPreTransformSuccessWebhookEvent } + variant -> { Imagekit::UploadPreTransformSuccessEvent } # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. - variant -> { Imagekit::UploadPreTransformErrorWebhookEvent } + variant -> { Imagekit::UploadPreTransformErrorEvent } # 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. - variant -> { Imagekit::UploadPostTransformSuccessWebhookEvent } + variant -> { Imagekit::UploadPostTransformSuccessEvent } # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. - variant -> { Imagekit::UploadPostTransformErrorWebhookEvent } + variant -> { Imagekit::UploadPostTransformErrorEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessWebhookEvent, Imagekit::Models::UploadPreTransformErrorWebhookEvent, Imagekit::Models::UploadPostTransformSuccessWebhookEvent, Imagekit::Models::UploadPostTransformErrorWebhookEvent)] + # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessEvent, Imagekit::Models::UploadPreTransformErrorEvent, Imagekit::Models::UploadPostTransformSuccessEvent, Imagekit::Models::UploadPostTransformErrorEvent)] end end end diff --git a/lib/imagekit/models/upload_post_transform_error_webhook_event.rb b/lib/imagekit/models/upload_post_transform_error_event.rb similarity index 73% rename from lib/imagekit/models/upload_post_transform_error_webhook_event.rb rename to lib/imagekit/models/upload_post_transform_error_event.rb index edf4455c..3569da50 100644 --- a/lib/imagekit/models/upload_post_transform_error_webhook_event.rb +++ b/lib/imagekit/models/upload_post_transform_error_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class UploadPostTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -17,13 +17,13 @@ class UploadPostTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data] - required :data, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Data } + # @return [Imagekit::Models::UploadPostTransformErrorEvent::Data] + required :data, -> { Imagekit::UploadPostTransformErrorEvent::Data } # @!attribute request # - # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request] - required :request, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Request } + # @return [Imagekit::Models::UploadPostTransformErrorEvent::Request] + required :request, -> { Imagekit::UploadPostTransformErrorEvent::Request } # @!attribute type # @@ -38,13 +38,13 @@ class UploadPostTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # - # @param data [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data] + # @param data [Imagekit::Models::UploadPostTransformErrorEvent::Data] # - # @param request [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request] + # @param request [Imagekit::Models::UploadPostTransformErrorEvent::Request] # # @param type [Symbol, :"upload.post-transform.error"] - # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent#data + # @see Imagekit::Models::UploadPostTransformErrorEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute file_id # Unique identifier of the originally uploaded file. @@ -66,8 +66,8 @@ class Data < Imagekit::Internal::Type::BaseModel # @!attribute transformation # - # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation] - required :transformation, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation } + # @return [Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation] + required :transformation, -> { Imagekit::UploadPostTransformErrorEvent::Data::Transformation } # @!attribute url # URL of the attempted post-transformation. @@ -82,21 +82,21 @@ class Data < Imagekit::Internal::Type::BaseModel # # @param path [String] Path of the file. # - # @param transformation [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation] + # @param transformation [Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation] # # @param url [String] URL of the attempted post-transformation. - # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data#transformation + # @see Imagekit::Models::UploadPostTransformErrorEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute error # - # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error] - required :error, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error } + # @return [Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation::Error] + required :error, -> { Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error } # @!method initialize(error:) - # @param error [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error] + # @param error [Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation::Error] - # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Data::Transformation#error + # @see Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation#error class Error < Imagekit::Internal::Type::BaseModel # @!attribute reason # Reason for the post-transformation failure. @@ -110,12 +110,12 @@ class Error < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent#request + # @see Imagekit::Models::UploadPostTransformErrorEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute transformation # - # @return [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation] - required :transformation, -> { Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation } + # @return [Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation] + required :transformation, -> { Imagekit::UploadPostTransformErrorEvent::Request::Transformation } # @!attribute x_request_id # Unique identifier for the originating request. @@ -124,24 +124,24 @@ class Request < Imagekit::Internal::Type::BaseModel required :x_request_id, String # @!method initialize(transformation:, x_request_id:) - # @param transformation [Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation] + # @param transformation [Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation] # # @param x_request_id [String] Unique identifier for the originating request. - # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request#transformation + # @see Imagekit::Models::UploadPostTransformErrorEvent::Request#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the requested post-transformation. # - # @return [Symbol, Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type] - required :type, enum: -> { Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type } + # @return [Symbol, Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::Type] + required :type, enum: -> { Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type } # @!attribute protocol # Only applicable if transformation type is 'abs'. Streaming protocol used. # - # @return [Symbol, Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol, nil] + # @return [Symbol, Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::Protocol, nil] optional :protocol, - enum: -> { Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol } + enum: -> { Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol } # @!attribute value # Value for the requested transformation type. @@ -150,15 +150,15 @@ class Transformation < Imagekit::Internal::Type::BaseModel optional :value, String # @!method initialize(type:, protocol: nil, value: nil) - # @param type [Symbol, Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type] Type of the requested post-transformation. + # @param type [Symbol, Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::Type] Type of the requested post-transformation. # - # @param protocol [Symbol, Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. + # @param protocol [Symbol, Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. # # @param value [String] Value for the requested transformation type. # Type of the requested post-transformation. # - # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation#type + # @see Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -173,7 +173,7 @@ module Type # Only applicable if transformation type is 'abs'. Streaming protocol used. # - # @see Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation#protocol + # @see Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation#protocol module Protocol extend Imagekit::Internal::Type::Enum diff --git a/lib/imagekit/models/upload_post_transform_success_webhook_event.rb b/lib/imagekit/models/upload_post_transform_success_event.rb similarity index 74% rename from lib/imagekit/models/upload_post_transform_success_webhook_event.rb rename to lib/imagekit/models/upload_post_transform_success_event.rb index 16c0472b..07b856b2 100644 --- a/lib/imagekit/models/upload_post_transform_success_webhook_event.rb +++ b/lib/imagekit/models/upload_post_transform_success_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class UploadPostTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -17,13 +17,13 @@ class UploadPostTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseMod # @!attribute data # - # @return [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Data] - required :data, -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Data } + # @return [Imagekit::Models::UploadPostTransformSuccessEvent::Data] + required :data, -> { Imagekit::UploadPostTransformSuccessEvent::Data } # @!attribute request # - # @return [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request] - required :request, -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Request } + # @return [Imagekit::Models::UploadPostTransformSuccessEvent::Request] + required :request, -> { Imagekit::UploadPostTransformSuccessEvent::Request } # @!attribute type # @@ -39,13 +39,13 @@ class UploadPostTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseMod # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # - # @param data [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Data] + # @param data [Imagekit::Models::UploadPostTransformSuccessEvent::Data] # - # @param request [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request] + # @param request [Imagekit::Models::UploadPostTransformSuccessEvent::Request] # # @param type [Symbol, :"upload.post-transform.success"] - # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent#data + # @see Imagekit::Models::UploadPostTransformSuccessEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute file_id # Unique identifier of the originally uploaded file. @@ -73,12 +73,12 @@ class Data < Imagekit::Internal::Type::BaseModel # @param url [String] URL of the generated post-transformation. end - # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent#request + # @see Imagekit::Models::UploadPostTransformSuccessEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute transformation # - # @return [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation] - required :transformation, -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation } + # @return [Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation] + required :transformation, -> { Imagekit::UploadPostTransformSuccessEvent::Request::Transformation } # @!attribute x_request_id # Unique identifier for the originating request. @@ -87,25 +87,24 @@ class Request < Imagekit::Internal::Type::BaseModel required :x_request_id, String # @!method initialize(transformation:, x_request_id:) - # @param transformation [Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation] + # @param transformation [Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation] # # @param x_request_id [String] Unique identifier for the originating request. - # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request#transformation + # @see Imagekit::Models::UploadPostTransformSuccessEvent::Request#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the requested post-transformation. # - # @return [Symbol, Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type] - required :type, - enum: -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type } + # @return [Symbol, Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::Type] + required :type, enum: -> { Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type } # @!attribute protocol # Only applicable if transformation type is 'abs'. Streaming protocol used. # - # @return [Symbol, Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol, nil] + # @return [Symbol, Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::Protocol, nil] optional :protocol, - enum: -> { Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol } + enum: -> { Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol } # @!attribute value # Value for the requested transformation type. @@ -114,15 +113,15 @@ class Transformation < Imagekit::Internal::Type::BaseModel optional :value, String # @!method initialize(type:, protocol: nil, value: nil) - # @param type [Symbol, Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type] Type of the requested post-transformation. + # @param type [Symbol, Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::Type] Type of the requested post-transformation. # - # @param protocol [Symbol, Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. + # @param protocol [Symbol, Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. # # @param value [String] Value for the requested transformation type. # Type of the requested post-transformation. # - # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation#type + # @see Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation#type module Type extend Imagekit::Internal::Type::Enum @@ -137,7 +136,7 @@ module Type # Only applicable if transformation type is 'abs'. Streaming protocol used. # - # @see Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation#protocol + # @see Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation#protocol module Protocol extend Imagekit::Internal::Type::Enum diff --git a/lib/imagekit/models/upload_pre_transform_error_webhook_event.rb b/lib/imagekit/models/upload_pre_transform_error_event.rb similarity index 74% rename from lib/imagekit/models/upload_pre_transform_error_webhook_event.rb rename to lib/imagekit/models/upload_pre_transform_error_event.rb index 16c7ee42..d672e680 100644 --- a/lib/imagekit/models/upload_pre_transform_error_webhook_event.rb +++ b/lib/imagekit/models/upload_pre_transform_error_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class UploadPreTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -17,13 +17,13 @@ class UploadPreTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # @!attribute data # - # @return [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data] - required :data, -> { Imagekit::UploadPreTransformErrorWebhookEvent::Data } + # @return [Imagekit::Models::UploadPreTransformErrorEvent::Data] + required :data, -> { Imagekit::UploadPreTransformErrorEvent::Data } # @!attribute request # - # @return [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Request] - required :request, -> { Imagekit::UploadPreTransformErrorWebhookEvent::Request } + # @return [Imagekit::Models::UploadPreTransformErrorEvent::Request] + required :request, -> { Imagekit::UploadPreTransformErrorEvent::Request } # @!attribute type # @@ -38,13 +38,13 @@ class UploadPreTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # - # @param data [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data] + # @param data [Imagekit::Models::UploadPreTransformErrorEvent::Data] # - # @param request [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Request] + # @param request [Imagekit::Models::UploadPreTransformErrorEvent::Request] # # @param type [Symbol, :"upload.pre-transform.error"] - # @see Imagekit::Models::UploadPreTransformErrorWebhookEvent#data + # @see Imagekit::Models::UploadPreTransformErrorEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute name # Name of the file. @@ -60,27 +60,27 @@ class Data < Imagekit::Internal::Type::BaseModel # @!attribute transformation # - # @return [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation] - required :transformation, -> { Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation } + # @return [Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation] + required :transformation, -> { Imagekit::UploadPreTransformErrorEvent::Data::Transformation } # @!method initialize(name:, path:, transformation:) # @param name [String] Name of the file. # # @param path [String] Path of the file. # - # @param transformation [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation] + # @param transformation [Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation] - # @see Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data#transformation + # @see Imagekit::Models::UploadPreTransformErrorEvent::Data#transformation class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute error # - # @return [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error] - required :error, -> { Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error } + # @return [Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation::Error] + required :error, -> { Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error } # @!method initialize(error:) - # @param error [Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error] + # @param error [Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation::Error] - # @see Imagekit::Models::UploadPreTransformErrorWebhookEvent::Data::Transformation#error + # @see Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation#error class Error < Imagekit::Internal::Type::BaseModel # @!attribute reason # Reason for the pre-transformation failure. @@ -94,7 +94,7 @@ class Error < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::UploadPreTransformErrorWebhookEvent#request + # @see Imagekit::Models::UploadPreTransformErrorEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute transformation # The requested pre-transformation string. diff --git a/lib/imagekit/models/upload_pre_transform_success_webhook_event.rb b/lib/imagekit/models/upload_pre_transform_success_event.rb similarity index 85% rename from lib/imagekit/models/upload_pre_transform_success_webhook_event.rb rename to lib/imagekit/models/upload_pre_transform_success_event.rb index 24846b6d..a9f0f0ce 100644 --- a/lib/imagekit/models/upload_pre_transform_success_webhook_event.rb +++ b/lib/imagekit/models/upload_pre_transform_success_event.rb @@ -2,7 +2,7 @@ module Imagekit module Models - class UploadPreTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # @@ -18,13 +18,13 @@ class UploadPreTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseMode # @!attribute data # Object containing details of a successful upload. # - # @return [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data] - required :data, -> { Imagekit::UploadPreTransformSuccessWebhookEvent::Data } + # @return [Imagekit::Models::UploadPreTransformSuccessEvent::Data] + required :data, -> { Imagekit::UploadPreTransformSuccessEvent::Data } # @!attribute request # - # @return [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Request] - required :request, -> { Imagekit::UploadPreTransformSuccessWebhookEvent::Request } + # @return [Imagekit::Models::UploadPreTransformSuccessEvent::Request] + required :request, -> { Imagekit::UploadPreTransformSuccessEvent::Request } # @!attribute type # @@ -40,21 +40,21 @@ class UploadPreTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseMode # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # - # @param data [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data] Object containing details of a successful upload. + # @param data [Imagekit::Models::UploadPreTransformSuccessEvent::Data] Object containing details of a successful upload. # - # @param request [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Request] + # @param request [Imagekit::Models::UploadPreTransformSuccessEvent::Request] # # @param type [Symbol, :"upload.pre-transform.success"] - # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent#data + # @see Imagekit::Models::UploadPreTransformSuccessEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the uploaded file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, -> { - Imagekit::Internal::Type::ArrayOf[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag] + Imagekit::Internal::Type::ArrayOf[Imagekit::UploadPreTransformSuccessEvent::Data::AITag] }, api_name: :AITags, nil?: true @@ -126,9 +126,9 @@ class Data < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # - # @return [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, nil] + # @return [Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus, nil] optional :extension_status, - -> { Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus }, + -> { Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus }, api_name: :extensionStatus # @!attribute file_id @@ -215,9 +215,9 @@ class Data < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object containing the file or file version's `id` (versionId) and `name`. # - # @return [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, nil] + # @return [Imagekit::Models::UploadPreTransformSuccessEvent::Data::VersionInfo, nil] optional :version_info, - -> { Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo }, + -> { Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo }, api_name: :versionInfo # @!attribute video_codec @@ -234,12 +234,11 @@ class Data < Imagekit::Internal::Type::BaseModel # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data} for more - # details. + # {Imagekit::Models::UploadPreTransformSuccessEvent::Data} for more details. # # Object containing details of a successful upload. # - # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. # # @param audio_codec [String] The audio codec used in the video (only for video). # @@ -255,7 +254,7 @@ class Data < Imagekit::Internal::Type::BaseModel # # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, # - # @param extension_status [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # @param extension_status [Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus] Extension names with their processing status at the time of completion of the re # # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo # @@ -281,7 +280,7 @@ class Data < Imagekit::Internal::Type::BaseModel # # @param url [String] A publicly accessible URL of the file. # - # @param version_info [Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # @param version_info [Imagekit::Models::UploadPreTransformSuccessEvent::Data::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. # # @param video_codec [String] The video codec used in the video (only for video). # @@ -310,7 +309,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::AITag} for more + # {Imagekit::Models::UploadPreTransformSuccessEvent::Data::AITag} for more # details. # # @param confidence [Float] Confidence score of the tag. @@ -320,33 +319,31 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be end - # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data#extension_status + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data#extension_status class ExtensionStatus < Imagekit::Internal::Type::BaseModel # @!attribute aws_auto_tagging # - # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging, nil] + # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging, nil] optional :aws_auto_tagging, enum: -> { - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging }, api_name: :"aws-auto-tagging" # @!attribute google_auto_tagging # - # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging, nil] + # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging, nil] optional :google_auto_tagging, enum: -> { - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging }, api_name: :"google-auto-tagging" # @!attribute remove_bg # - # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg, nil] + # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg, nil] optional :remove_bg, - enum: -> { - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg - }, + enum: -> { Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) @@ -360,11 +357,11 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # - # @param aws_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging] - # @param google_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging] - # @param remove_bg [Symbol, Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg] + # @param aws_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg] - # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus#aws_auto_tagging + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#aws_auto_tagging module AwsAutoTagging extend Imagekit::Internal::Type::Enum @@ -376,7 +373,7 @@ module AwsAutoTagging # @return [Array] end - # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus#google_auto_tagging + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#google_auto_tagging module GoogleAutoTagging extend Imagekit::Internal::Type::Enum @@ -388,7 +385,7 @@ module GoogleAutoTagging # @return [Array] end - # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus#remove_bg + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#remove_bg module RemoveBg extend Imagekit::Internal::Type::Enum @@ -401,7 +398,7 @@ module RemoveBg end end - # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data#version_info + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. @@ -424,7 +421,7 @@ class VersionInfo < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::UploadPreTransformSuccessWebhookEvent#request + # @see Imagekit::Models::UploadPreTransformSuccessEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute transformation # The requested pre-transformation string. diff --git a/lib/imagekit/resources/webhooks.rb b/lib/imagekit/resources/webhooks.rb index 208f8727..067574cf 100644 --- a/lib/imagekit/resources/webhooks.rb +++ b/lib/imagekit/resources/webhooks.rb @@ -5,7 +5,7 @@ module Resources class Webhooks # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessWebhookEvent, Imagekit::Models::UploadPreTransformErrorWebhookEvent, Imagekit::Models::UploadPostTransformSuccessWebhookEvent, Imagekit::Models::UploadPostTransformErrorWebhookEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessEvent, Imagekit::Models::UploadPreTransformErrorEvent, Imagekit::Models::UploadPostTransformSuccessEvent, Imagekit::Models::UploadPostTransformErrorEvent] def unsafe_unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnsafeUnwrapWebhookEvent, parsed) @@ -13,7 +13,7 @@ def unsafe_unwrap(payload) # @param payload [String] The raw webhook payload as a string # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessWebhookEvent, Imagekit::Models::UploadPreTransformErrorWebhookEvent, Imagekit::Models::UploadPostTransformSuccessWebhookEvent, Imagekit::Models::UploadPostTransformErrorWebhookEvent] + # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessEvent, Imagekit::Models::UploadPreTransformErrorEvent, Imagekit::Models::UploadPostTransformSuccessEvent, Imagekit::Models::UploadPostTransformErrorEvent] def unwrap(payload) parsed = JSON.parse(payload, symbolize_names: true) Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnwrapWebhookEvent, parsed) diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index edbc9e8f..b16eec98 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -93,17 +93,16 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - UploadPostTransformErrorWebhookEvent = - Imagekit::Models::UploadPostTransformErrorWebhookEvent + UploadPostTransformErrorEvent = + Imagekit::Models::UploadPostTransformErrorEvent - UploadPostTransformSuccessWebhookEvent = - Imagekit::Models::UploadPostTransformSuccessWebhookEvent + UploadPostTransformSuccessEvent = + Imagekit::Models::UploadPostTransformSuccessEvent - UploadPreTransformErrorWebhookEvent = - Imagekit::Models::UploadPreTransformErrorWebhookEvent + UploadPreTransformErrorEvent = Imagekit::Models::UploadPreTransformErrorEvent - UploadPreTransformSuccessWebhookEvent = - Imagekit::Models::UploadPreTransformSuccessWebhookEvent + UploadPreTransformSuccessEvent = + Imagekit::Models::UploadPreTransformSuccessEvent VideoOverlay = Imagekit::Models::VideoOverlay diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi index 56008983..4dbc761c 100644 --- a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi @@ -14,10 +14,10 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent, Imagekit::VideoTransformationReadyEvent, Imagekit::VideoTransformationErrorEvent, - Imagekit::UploadPreTransformSuccessWebhookEvent, - Imagekit::UploadPreTransformErrorWebhookEvent, - Imagekit::UploadPostTransformSuccessWebhookEvent, - Imagekit::UploadPostTransformErrorWebhookEvent + Imagekit::UploadPreTransformSuccessEvent, + Imagekit::UploadPreTransformErrorEvent, + Imagekit::UploadPostTransformSuccessEvent, + Imagekit::UploadPostTransformErrorEvent ) end diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi index bb1ea24e..b94a7e27 100644 --- a/rbi/imagekit/models/unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unwrap_webhook_event.rbi @@ -14,10 +14,10 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent, Imagekit::VideoTransformationReadyEvent, Imagekit::VideoTransformationErrorEvent, - Imagekit::UploadPreTransformSuccessWebhookEvent, - Imagekit::UploadPreTransformErrorWebhookEvent, - Imagekit::UploadPostTransformSuccessWebhookEvent, - Imagekit::UploadPostTransformErrorWebhookEvent + Imagekit::UploadPreTransformSuccessEvent, + Imagekit::UploadPreTransformErrorEvent, + Imagekit::UploadPostTransformSuccessEvent, + Imagekit::UploadPostTransformErrorEvent ) end diff --git a/rbi/imagekit/models/upload_post_transform_error_webhook_event.rbi b/rbi/imagekit/models/upload_post_transform_error_event.rbi similarity index 67% rename from rbi/imagekit/models/upload_post_transform_error_webhook_event.rbi rename to rbi/imagekit/models/upload_post_transform_error_event.rbi index 6745cbee..a2fd2772 100644 --- a/rbi/imagekit/models/upload_post_transform_error_webhook_event.rbi +++ b/rbi/imagekit/models/upload_post_transform_error_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class UploadPostTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorWebhookEvent, + Imagekit::UploadPostTransformErrorEvent, Imagekit::Internal::AnyHash ) end @@ -19,23 +19,20 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::UploadPostTransformErrorWebhookEvent::Data) } + sig { returns(Imagekit::UploadPostTransformErrorEvent::Data) } attr_reader :data sig do - params( - data: Imagekit::UploadPostTransformErrorWebhookEvent::Data::OrHash - ).void + params(data: Imagekit::UploadPostTransformErrorEvent::Data::OrHash).void end attr_writer :data - sig { returns(Imagekit::UploadPostTransformErrorWebhookEvent::Request) } + sig { returns(Imagekit::UploadPostTransformErrorEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::OrHash + request: Imagekit::UploadPostTransformErrorEvent::Request::OrHash ).void end attr_writer :request @@ -49,9 +46,8 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::UploadPostTransformErrorWebhookEvent::Data::OrHash, - request: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::OrHash, + data: Imagekit::UploadPostTransformErrorEvent::Data::OrHash, + request: Imagekit::UploadPostTransformErrorEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -71,8 +67,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::UploadPostTransformErrorWebhookEvent::Data, - request: Imagekit::UploadPostTransformErrorWebhookEvent::Request, + data: Imagekit::UploadPostTransformErrorEvent::Data, + request: Imagekit::UploadPostTransformErrorEvent::Request, type: Symbol } ) @@ -84,7 +80,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorWebhookEvent::Data, + Imagekit::UploadPostTransformErrorEvent::Data, Imagekit::Internal::AnyHash ) end @@ -102,16 +98,14 @@ module Imagekit attr_accessor :path sig do - returns( - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation - ) + returns(Imagekit::UploadPostTransformErrorEvent::Data::Transformation) end attr_reader :transformation sig do params( transformation: - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::OrHash + Imagekit::UploadPostTransformErrorEvent::Data::Transformation::OrHash ).void end attr_writer :transformation @@ -126,7 +120,7 @@ module Imagekit name: String, path: String, transformation: - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::OrHash, + Imagekit::UploadPostTransformErrorEvent::Data::Transformation::OrHash, url: String ).returns(T.attached_class) end @@ -150,7 +144,7 @@ module Imagekit name: String, path: String, transformation: - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + Imagekit::UploadPostTransformErrorEvent::Data::Transformation, url: String } ) @@ -162,14 +156,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + Imagekit::UploadPostTransformErrorEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error ) end attr_reader :error @@ -177,7 +171,7 @@ module Imagekit sig do params( error: - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error::OrHash + Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error::OrHash ).void end attr_writer :error @@ -185,7 +179,7 @@ module Imagekit sig do params( error: - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error::OrHash + Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error::OrHash ).returns(T.attached_class) end def self.new(error:) @@ -195,7 +189,7 @@ module Imagekit override.returns( { error: - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error } ) end @@ -206,7 +200,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error, + Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error, Imagekit::Internal::AnyHash ) end @@ -233,14 +227,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorWebhookEvent::Request, + Imagekit::UploadPostTransformErrorEvent::Request, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation + Imagekit::UploadPostTransformErrorEvent::Request::Transformation ) end attr_reader :transformation @@ -248,7 +242,7 @@ module Imagekit sig do params( transformation: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::OrHash + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::OrHash ).void end attr_writer :transformation @@ -260,7 +254,7 @@ module Imagekit sig do params( transformation: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::OrHash, + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::OrHash, x_request_id: String ).returns(T.attached_class) end @@ -275,7 +269,7 @@ module Imagekit override.returns( { transformation: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + Imagekit::UploadPostTransformErrorEvent::Request::Transformation, x_request_id: String } ) @@ -287,7 +281,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + Imagekit::UploadPostTransformErrorEvent::Request::Transformation, Imagekit::Internal::AnyHash ) end @@ -295,7 +289,7 @@ module Imagekit # Type of the requested post-transformation. sig do returns( - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -304,7 +298,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol ) ) end @@ -313,7 +307,7 @@ module Imagekit sig do params( protocol: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::OrSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::OrSymbol ).void end attr_writer :protocol @@ -328,9 +322,9 @@ module Imagekit sig do params( type: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::OrSymbol, + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::OrSymbol, protocol: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::OrSymbol, + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::OrSymbol, value: String ).returns(T.attached_class) end @@ -348,9 +342,9 @@ module Imagekit override.returns( { type: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol, + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol, protocol: - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol, + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol, value: String } ) @@ -366,7 +360,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -374,28 +368,28 @@ module Imagekit TRANSFORMATION = T.let( :transformation, - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) ABS = T.let( :abs, - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) THUMBNAIL = T.let( :thumbnail, - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ] ) end @@ -411,7 +405,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -419,18 +413,18 @@ module Imagekit HLS = T.let( :hls, - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol ) DASH = T.let( :dash, - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/upload_post_transform_success_webhook_event.rbi b/rbi/imagekit/models/upload_post_transform_success_event.rbi similarity index 67% rename from rbi/imagekit/models/upload_post_transform_success_webhook_event.rbi rename to rbi/imagekit/models/upload_post_transform_success_event.rbi index 676aa3ad..189c4ad9 100644 --- a/rbi/imagekit/models/upload_post_transform_success_webhook_event.rbi +++ b/rbi/imagekit/models/upload_post_transform_success_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class UploadPostTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformSuccessWebhookEvent, + Imagekit::UploadPostTransformSuccessEvent, Imagekit::Internal::AnyHash ) end @@ -19,23 +19,22 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::UploadPostTransformSuccessWebhookEvent::Data) } + sig { returns(Imagekit::UploadPostTransformSuccessEvent::Data) } attr_reader :data sig do params( - data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data::OrHash + data: Imagekit::UploadPostTransformSuccessEvent::Data::OrHash ).void end attr_writer :data - sig { returns(Imagekit::UploadPostTransformSuccessWebhookEvent::Request) } + sig { returns(Imagekit::UploadPostTransformSuccessEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::OrHash + request: Imagekit::UploadPostTransformSuccessEvent::Request::OrHash ).void end attr_writer :request @@ -50,9 +49,8 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data::OrHash, - request: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::OrHash, + data: Imagekit::UploadPostTransformSuccessEvent::Data::OrHash, + request: Imagekit::UploadPostTransformSuccessEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -72,8 +70,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data, - request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + data: Imagekit::UploadPostTransformSuccessEvent::Data, + request: Imagekit::UploadPostTransformSuccessEvent::Request, type: Symbol } ) @@ -85,7 +83,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformSuccessWebhookEvent::Data, + Imagekit::UploadPostTransformSuccessEvent::Data, Imagekit::Internal::AnyHash ) end @@ -126,14 +124,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + Imagekit::UploadPostTransformSuccessEvent::Request, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation ) end attr_reader :transformation @@ -141,7 +139,7 @@ module Imagekit sig do params( transformation: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::OrHash + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::OrHash ).void end attr_writer :transformation @@ -153,7 +151,7 @@ module Imagekit sig do params( transformation: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::OrHash, + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::OrHash, x_request_id: String ).returns(T.attached_class) end @@ -168,7 +166,7 @@ module Imagekit override.returns( { transformation: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, x_request_id: String } ) @@ -180,7 +178,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, Imagekit::Internal::AnyHash ) end @@ -188,7 +186,7 @@ module Imagekit # Type of the requested post-transformation. sig do returns( - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -197,7 +195,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol ) ) end @@ -206,7 +204,7 @@ module Imagekit sig do params( protocol: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::OrSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::OrSymbol ).void end attr_writer :protocol @@ -221,9 +219,9 @@ module Imagekit sig do params( type: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::OrSymbol, + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::OrSymbol, protocol: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::OrSymbol, + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::OrSymbol, value: String ).returns(T.attached_class) end @@ -241,9 +239,9 @@ module Imagekit override.returns( { type: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol, + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol, protocol: - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol, + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol, value: String } ) @@ -259,7 +257,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -267,28 +265,28 @@ module Imagekit TRANSFORMATION = T.let( :transformation, - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) ABS = T.let( :abs, - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) THUMBNAIL = T.let( :thumbnail, - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Type::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ] ) end @@ -304,7 +302,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -312,18 +310,18 @@ module Imagekit HLS = T.let( :hls, - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol ) DASH = T.let( :dash, - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/upload_pre_transform_error_webhook_event.rbi b/rbi/imagekit/models/upload_pre_transform_error_event.rbi similarity index 72% rename from rbi/imagekit/models/upload_pre_transform_error_webhook_event.rbi rename to rbi/imagekit/models/upload_pre_transform_error_event.rbi index 625d300a..a6338f83 100644 --- a/rbi/imagekit/models/upload_pre_transform_error_webhook_event.rbi +++ b/rbi/imagekit/models/upload_pre_transform_error_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class UploadPreTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorWebhookEvent, + Imagekit::UploadPreTransformErrorEvent, Imagekit::Internal::AnyHash ) end @@ -19,23 +19,20 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::UploadPreTransformErrorWebhookEvent::Data) } + sig { returns(Imagekit::UploadPreTransformErrorEvent::Data) } attr_reader :data sig do - params( - data: Imagekit::UploadPreTransformErrorWebhookEvent::Data::OrHash - ).void + params(data: Imagekit::UploadPreTransformErrorEvent::Data::OrHash).void end attr_writer :data - sig { returns(Imagekit::UploadPreTransformErrorWebhookEvent::Request) } + sig { returns(Imagekit::UploadPreTransformErrorEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::UploadPreTransformErrorWebhookEvent::Request::OrHash + request: Imagekit::UploadPreTransformErrorEvent::Request::OrHash ).void end attr_writer :request @@ -49,9 +46,8 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::UploadPreTransformErrorWebhookEvent::Data::OrHash, - request: - Imagekit::UploadPreTransformErrorWebhookEvent::Request::OrHash, + data: Imagekit::UploadPreTransformErrorEvent::Data::OrHash, + request: Imagekit::UploadPreTransformErrorEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -71,8 +67,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::UploadPreTransformErrorWebhookEvent::Data, - request: Imagekit::UploadPreTransformErrorWebhookEvent::Request, + data: Imagekit::UploadPreTransformErrorEvent::Data, + request: Imagekit::UploadPreTransformErrorEvent::Request, type: Symbol } ) @@ -84,7 +80,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorWebhookEvent::Data, + Imagekit::UploadPreTransformErrorEvent::Data, Imagekit::Internal::AnyHash ) end @@ -98,16 +94,14 @@ module Imagekit attr_accessor :path sig do - returns( - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation - ) + returns(Imagekit::UploadPreTransformErrorEvent::Data::Transformation) end attr_reader :transformation sig do params( transformation: - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::OrHash + Imagekit::UploadPreTransformErrorEvent::Data::Transformation::OrHash ).void end attr_writer :transformation @@ -117,7 +111,7 @@ module Imagekit name: String, path: String, transformation: - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::OrHash + Imagekit::UploadPreTransformErrorEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new( @@ -135,7 +129,7 @@ module Imagekit name: String, path: String, transformation: - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + Imagekit::UploadPreTransformErrorEvent::Data::Transformation } ) end @@ -146,14 +140,14 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation, + Imagekit::UploadPreTransformErrorEvent::Data::Transformation, Imagekit::Internal::AnyHash ) end sig do returns( - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error ) end attr_reader :error @@ -161,7 +155,7 @@ module Imagekit sig do params( error: - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error::OrHash + Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error::OrHash ).void end attr_writer :error @@ -169,7 +163,7 @@ module Imagekit sig do params( error: - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error::OrHash + Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error::OrHash ).returns(T.attached_class) end def self.new(error:) @@ -179,7 +173,7 @@ module Imagekit override.returns( { error: - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error } ) end @@ -190,7 +184,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error, + Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error, Imagekit::Internal::AnyHash ) end @@ -217,7 +211,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorWebhookEvent::Request, + Imagekit::UploadPreTransformErrorEvent::Request, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/upload_pre_transform_success_webhook_event.rbi b/rbi/imagekit/models/upload_pre_transform_success_event.rbi similarity index 81% rename from rbi/imagekit/models/upload_pre_transform_success_webhook_event.rbi rename to rbi/imagekit/models/upload_pre_transform_success_event.rbi index 9677c0ae..da38d8ab 100644 --- a/rbi/imagekit/models/upload_pre_transform_success_webhook_event.rbi +++ b/rbi/imagekit/models/upload_pre_transform_success_event.rbi @@ -2,11 +2,11 @@ module Imagekit module Models - class UploadPreTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessWebhookEvent, + Imagekit::UploadPreTransformSuccessEvent, Imagekit::Internal::AnyHash ) end @@ -20,23 +20,22 @@ module Imagekit attr_accessor :created_at # Object containing details of a successful upload. - sig { returns(Imagekit::UploadPreTransformSuccessWebhookEvent::Data) } + sig { returns(Imagekit::UploadPreTransformSuccessEvent::Data) } attr_reader :data sig do params( - data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::OrHash + data: Imagekit::UploadPreTransformSuccessEvent::Data::OrHash ).void end attr_writer :data - sig { returns(Imagekit::UploadPreTransformSuccessWebhookEvent::Request) } + sig { returns(Imagekit::UploadPreTransformSuccessEvent::Request) } attr_reader :request sig do params( - request: - Imagekit::UploadPreTransformSuccessWebhookEvent::Request::OrHash + request: Imagekit::UploadPreTransformSuccessEvent::Request::OrHash ).void end attr_writer :request @@ -51,9 +50,8 @@ module Imagekit params( id: String, created_at: Time, - data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::OrHash, - request: - Imagekit::UploadPreTransformSuccessWebhookEvent::Request::OrHash, + data: Imagekit::UploadPreTransformSuccessEvent::Data::OrHash, + request: Imagekit::UploadPreTransformSuccessEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -74,8 +72,8 @@ module Imagekit { id: String, created_at: Time, - data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data, - request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + data: Imagekit::UploadPreTransformSuccessEvent::Data, + request: Imagekit::UploadPreTransformSuccessEvent::Request, type: Symbol } ) @@ -87,7 +85,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data, + Imagekit::UploadPreTransformSuccessEvent::Data, Imagekit::Internal::AnyHash ) end @@ -96,9 +94,7 @@ module Imagekit sig do returns( T.nilable( - T::Array[ - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag - ] + T::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag] ) ) end @@ -172,7 +168,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus ) ) end @@ -181,7 +177,7 @@ module Imagekit sig do params( extension_status: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::OrHash + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::OrHash ).void end attr_writer :extension_status @@ -280,7 +276,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo + Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo ) ) end @@ -289,7 +285,7 @@ module Imagekit sig do params( version_info: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo::OrHash + Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo::OrHash ).void end attr_writer :version_info @@ -314,7 +310,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag::OrHash + Imagekit::UploadPreTransformSuccessEvent::Data::AITag::OrHash ] ), audio_codec: String, @@ -325,7 +321,7 @@ module Imagekit duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::OrHash, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::OrHash, file_id: String, file_path: String, file_type: String, @@ -339,7 +335,7 @@ module Imagekit thumbnail_url: String, url: String, version_info: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo::OrHash, + Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo::OrHash, video_codec: String, width: Float ).returns(T.attached_class) @@ -429,7 +425,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag + Imagekit::UploadPreTransformSuccessEvent::Data::AITag ] ), audio_codec: String, @@ -440,7 +436,7 @@ module Imagekit duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, file_id: String, file_path: String, file_type: String, @@ -454,7 +450,7 @@ module Imagekit thumbnail_url: String, url: String, version_info: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, video_codec: String, width: Float } @@ -467,7 +463,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag, + Imagekit::UploadPreTransformSuccessEvent::Data::AITag, Imagekit::Internal::AnyHash ) end @@ -525,7 +521,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, Imagekit::Internal::AnyHash ) end @@ -533,7 +529,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) ) end @@ -542,7 +538,7 @@ module Imagekit sig do params( aws_auto_tagging: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol ).void end attr_writer :aws_auto_tagging @@ -550,7 +546,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) ) end @@ -559,7 +555,7 @@ module Imagekit sig do params( google_auto_tagging: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol ).void end attr_writer :google_auto_tagging @@ -567,7 +563,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ) ) end @@ -576,7 +572,7 @@ module Imagekit sig do params( remove_bg: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::OrSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::OrSymbol ).void end attr_writer :remove_bg @@ -593,11 +589,11 @@ module Imagekit sig do params( aws_auto_tagging: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol, remove_bg: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::OrSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::OrSymbol ).returns(T.attached_class) end def self.new( @@ -611,11 +607,11 @@ module Imagekit override.returns( { aws_auto_tagging: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, remove_bg: - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol } ) end @@ -629,7 +625,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -637,23 +633,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ] ) end @@ -668,7 +664,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -676,23 +672,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ] ) end @@ -707,7 +703,7 @@ module Imagekit T.type_alias do T.all( Symbol, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -715,23 +711,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ] ) end @@ -744,7 +740,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, Imagekit::Internal::AnyHash ) end @@ -783,7 +779,7 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + Imagekit::UploadPreTransformSuccessEvent::Request, Imagekit::Internal::AnyHash ) end diff --git a/rbi/imagekit/resources/webhooks.rbi b/rbi/imagekit/resources/webhooks.rbi index 4405ca05..76b48078 100644 --- a/rbi/imagekit/resources/webhooks.rbi +++ b/rbi/imagekit/resources/webhooks.rbi @@ -9,10 +9,10 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent, Imagekit::VideoTransformationReadyEvent, Imagekit::VideoTransformationErrorEvent, - Imagekit::UploadPreTransformSuccessWebhookEvent, - Imagekit::UploadPreTransformErrorWebhookEvent, - Imagekit::UploadPostTransformSuccessWebhookEvent, - Imagekit::UploadPostTransformErrorWebhookEvent + Imagekit::UploadPreTransformSuccessEvent, + Imagekit::UploadPreTransformErrorEvent, + Imagekit::UploadPostTransformSuccessEvent, + Imagekit::UploadPostTransformErrorEvent ) ) end @@ -28,10 +28,10 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent, Imagekit::VideoTransformationReadyEvent, Imagekit::VideoTransformationErrorEvent, - Imagekit::UploadPreTransformSuccessWebhookEvent, - Imagekit::UploadPreTransformErrorWebhookEvent, - Imagekit::UploadPostTransformSuccessWebhookEvent, - Imagekit::UploadPostTransformErrorWebhookEvent + Imagekit::UploadPreTransformSuccessEvent, + Imagekit::UploadPreTransformErrorEvent, + Imagekit::UploadPostTransformSuccessEvent, + Imagekit::UploadPostTransformErrorEvent ) ) end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index b6c590cc..746736e2 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -85,13 +85,13 @@ module Imagekit module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - class UploadPostTransformErrorWebhookEvent = Imagekit::Models::UploadPostTransformErrorWebhookEvent + class UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent - class UploadPostTransformSuccessWebhookEvent = Imagekit::Models::UploadPostTransformSuccessWebhookEvent + class UploadPostTransformSuccessEvent = Imagekit::Models::UploadPostTransformSuccessEvent - class UploadPreTransformErrorWebhookEvent = Imagekit::Models::UploadPreTransformErrorWebhookEvent + class UploadPreTransformErrorEvent = Imagekit::Models::UploadPreTransformErrorEvent - class UploadPreTransformSuccessWebhookEvent = Imagekit::Models::UploadPreTransformSuccessWebhookEvent + class UploadPreTransformSuccessEvent = Imagekit::Models::UploadPreTransformSuccessEvent class VideoOverlay = Imagekit::Models::VideoOverlay diff --git a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs index a7f19f5c..b3cb218a 100644 --- a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs @@ -4,10 +4,10 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent | Imagekit::VideoTransformationReadyEvent | Imagekit::VideoTransformationErrorEvent - | Imagekit::UploadPreTransformSuccessWebhookEvent - | Imagekit::UploadPreTransformErrorWebhookEvent - | Imagekit::UploadPostTransformSuccessWebhookEvent - | Imagekit::UploadPostTransformErrorWebhookEvent + | Imagekit::UploadPreTransformSuccessEvent + | Imagekit::UploadPreTransformErrorEvent + | Imagekit::UploadPostTransformSuccessEvent + | Imagekit::UploadPostTransformErrorEvent module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/unwrap_webhook_event.rbs b/sig/imagekit/models/unwrap_webhook_event.rbs index ab4bec4e..8c1551ec 100644 --- a/sig/imagekit/models/unwrap_webhook_event.rbs +++ b/sig/imagekit/models/unwrap_webhook_event.rbs @@ -4,10 +4,10 @@ module Imagekit Imagekit::VideoTransformationAcceptedEvent | Imagekit::VideoTransformationReadyEvent | Imagekit::VideoTransformationErrorEvent - | Imagekit::UploadPreTransformSuccessWebhookEvent - | Imagekit::UploadPreTransformErrorWebhookEvent - | Imagekit::UploadPostTransformSuccessWebhookEvent - | Imagekit::UploadPostTransformErrorWebhookEvent + | Imagekit::UploadPreTransformSuccessEvent + | Imagekit::UploadPreTransformErrorEvent + | Imagekit::UploadPostTransformSuccessEvent + | Imagekit::UploadPostTransformErrorEvent module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/sig/imagekit/models/upload_post_transform_error_webhook_event.rbs b/sig/imagekit/models/upload_post_transform_error_event.rbs similarity index 57% rename from sig/imagekit/models/upload_post_transform_error_webhook_event.rbs rename to sig/imagekit/models/upload_post_transform_error_event.rbs index 33442c0d..09c5bd73 100644 --- a/sig/imagekit/models/upload_post_transform_error_webhook_event.rbs +++ b/sig/imagekit/models/upload_post_transform_error_event.rbs @@ -1,38 +1,38 @@ module Imagekit module Models - type upload_post_transform_error_webhook_event = + type upload_post_transform_error_event = { id: String, created_at: Time, - data: Imagekit::UploadPostTransformErrorWebhookEvent::Data, - request: Imagekit::UploadPostTransformErrorWebhookEvent::Request, + data: Imagekit::UploadPostTransformErrorEvent::Data, + request: Imagekit::UploadPostTransformErrorEvent::Request, type: :"upload.post-transform.error" } - class UploadPostTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::UploadPostTransformErrorWebhookEvent::Data + attr_accessor data: Imagekit::UploadPostTransformErrorEvent::Data - attr_accessor request: Imagekit::UploadPostTransformErrorWebhookEvent::Request + attr_accessor request: Imagekit::UploadPostTransformErrorEvent::Request attr_accessor type: :"upload.post-transform.error" def initialize: ( id: String, created_at: Time, - data: Imagekit::UploadPostTransformErrorWebhookEvent::Data, - request: Imagekit::UploadPostTransformErrorWebhookEvent::Request, + data: Imagekit::UploadPostTransformErrorEvent::Data, + request: Imagekit::UploadPostTransformErrorEvent::Request, ?type: :"upload.post-transform.error" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::UploadPostTransformErrorWebhookEvent::Data, - request: Imagekit::UploadPostTransformErrorWebhookEvent::Request, + data: Imagekit::UploadPostTransformErrorEvent::Data, + request: Imagekit::UploadPostTransformErrorEvent::Request, type: :"upload.post-transform.error" } @@ -41,7 +41,7 @@ module Imagekit file_id: String, name: String, path: String, - transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + transformation: Imagekit::UploadPostTransformErrorEvent::Data::Transformation, url: String } @@ -52,7 +52,7 @@ module Imagekit attr_accessor path: String - attr_accessor transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation + attr_accessor transformation: Imagekit::UploadPostTransformErrorEvent::Data::Transformation attr_accessor url: String @@ -60,7 +60,7 @@ module Imagekit file_id: String, name: String, path: String, - transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + transformation: Imagekit::UploadPostTransformErrorEvent::Data::Transformation, url: String ) -> void @@ -68,24 +68,24 @@ module Imagekit file_id: String, name: String, path: String, - transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation, + transformation: Imagekit::UploadPostTransformErrorEvent::Data::Transformation, url: String } type transformation = { - error: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + error: Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor error: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + attr_accessor error: Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error def initialize: ( - error: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + error: Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error ) -> void def to_hash: -> { - error: Imagekit::UploadPostTransformErrorWebhookEvent::Data::Transformation::Error + error: Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error } type error = { reason: String } @@ -102,54 +102,54 @@ module Imagekit type request = { - transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + transformation: Imagekit::UploadPostTransformErrorEvent::Request::Transformation, x_request_id: String } class Request < Imagekit::Internal::Type::BaseModel - attr_accessor transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation + attr_accessor transformation: Imagekit::UploadPostTransformErrorEvent::Request::Transformation attr_accessor x_request_id: String def initialize: ( - transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + transformation: Imagekit::UploadPostTransformErrorEvent::Request::Transformation, x_request_id: String ) -> void def to_hash: -> { - transformation: Imagekit::UploadPostTransformErrorWebhookEvent::Request::Transformation, + transformation: Imagekit::UploadPostTransformErrorEvent::Request::Transformation, x_request_id: String } type transformation = { - type: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_, - protocol: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol, + type: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, + protocol: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, value: String } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_ + attr_accessor type: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_ - attr_reader protocol: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol? + attr_reader protocol: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol? def protocol=: ( - Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol - ) -> Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol + Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol + ) -> Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol attr_reader value: String? def value=: (String) -> String def initialize: ( - type: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_, - ?protocol: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol, + type: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, + ?protocol: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, ?value: String ) -> void def to_hash: -> { - type: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_, - protocol: Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol, + type: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, + protocol: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, value: String } @@ -163,7 +163,7 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" THUMBNAIL: :thumbnail - def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_] end type protocol = :hls | :dash @@ -174,7 +174,7 @@ module Imagekit HLS: :hls DASH: :dash - def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformErrorWebhookEvent::Request::Transformation::protocol] + def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol] end end end diff --git a/sig/imagekit/models/upload_post_transform_success_webhook_event.rbs b/sig/imagekit/models/upload_post_transform_success_event.rbs similarity index 58% rename from sig/imagekit/models/upload_post_transform_success_webhook_event.rbs rename to sig/imagekit/models/upload_post_transform_success_event.rbs index d26578f7..01bf3180 100644 --- a/sig/imagekit/models/upload_post_transform_success_webhook_event.rbs +++ b/sig/imagekit/models/upload_post_transform_success_event.rbs @@ -1,38 +1,38 @@ module Imagekit module Models - type upload_post_transform_success_webhook_event = + type upload_post_transform_success_event = { id: String, created_at: Time, - data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data, - request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + data: Imagekit::UploadPostTransformSuccessEvent::Data, + request: Imagekit::UploadPostTransformSuccessEvent::Request, type: :"upload.post-transform.success" } - class UploadPostTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data + attr_accessor data: Imagekit::UploadPostTransformSuccessEvent::Data - attr_accessor request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request + attr_accessor request: Imagekit::UploadPostTransformSuccessEvent::Request attr_accessor type: :"upload.post-transform.success" def initialize: ( id: String, created_at: Time, - data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data, - request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + data: Imagekit::UploadPostTransformSuccessEvent::Data, + request: Imagekit::UploadPostTransformSuccessEvent::Request, ?type: :"upload.post-transform.success" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::UploadPostTransformSuccessWebhookEvent::Data, - request: Imagekit::UploadPostTransformSuccessWebhookEvent::Request, + data: Imagekit::UploadPostTransformSuccessEvent::Data, + request: Imagekit::UploadPostTransformSuccessEvent::Request, type: :"upload.post-transform.success" } @@ -52,54 +52,54 @@ module Imagekit type request = { - transformation: Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + transformation: Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, x_request_id: String } class Request < Imagekit::Internal::Type::BaseModel - attr_accessor transformation: Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation + attr_accessor transformation: Imagekit::UploadPostTransformSuccessEvent::Request::Transformation attr_accessor x_request_id: String def initialize: ( - transformation: Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + transformation: Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, x_request_id: String ) -> void def to_hash: -> { - transformation: Imagekit::UploadPostTransformSuccessWebhookEvent::Request::Transformation, + transformation: Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, x_request_id: String } type transformation = { - type: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_, - protocol: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol, + type: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, + protocol: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, value: String } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_ + attr_accessor type: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_ - attr_reader protocol: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol? + attr_reader protocol: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol? def protocol=: ( - Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol - ) -> Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol + Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol + ) -> Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol attr_reader value: String? def value=: (String) -> String def initialize: ( - type: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_, - ?protocol: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol, + type: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, + ?protocol: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, ?value: String ) -> void def to_hash: -> { - type: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_, - protocol: Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol, + type: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, + protocol: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, value: String } @@ -113,7 +113,7 @@ module Imagekit GIF_TO_VIDEO: :"gif-to-video" THUMBNAIL: :thumbnail - def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::type_] + def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_] end type protocol = :hls | :dash @@ -124,7 +124,7 @@ module Imagekit HLS: :hls DASH: :dash - def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformSuccessWebhookEvent::Request::Transformation::protocol] + def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol] end end end diff --git a/sig/imagekit/models/upload_pre_transform_error_webhook_event.rbs b/sig/imagekit/models/upload_pre_transform_error_event.rbs similarity index 58% rename from sig/imagekit/models/upload_pre_transform_error_webhook_event.rbs rename to sig/imagekit/models/upload_pre_transform_error_event.rbs index b5304e7a..73935081 100644 --- a/sig/imagekit/models/upload_pre_transform_error_webhook_event.rbs +++ b/sig/imagekit/models/upload_pre_transform_error_event.rbs @@ -1,38 +1,38 @@ module Imagekit module Models - type upload_pre_transform_error_webhook_event = + type upload_pre_transform_error_event = { id: String, created_at: Time, - data: Imagekit::UploadPreTransformErrorWebhookEvent::Data, - request: Imagekit::UploadPreTransformErrorWebhookEvent::Request, + data: Imagekit::UploadPreTransformErrorEvent::Data, + request: Imagekit::UploadPreTransformErrorEvent::Request, type: :"upload.pre-transform.error" } - class UploadPreTransformErrorWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::UploadPreTransformErrorWebhookEvent::Data + attr_accessor data: Imagekit::UploadPreTransformErrorEvent::Data - attr_accessor request: Imagekit::UploadPreTransformErrorWebhookEvent::Request + attr_accessor request: Imagekit::UploadPreTransformErrorEvent::Request attr_accessor type: :"upload.pre-transform.error" def initialize: ( id: String, created_at: Time, - data: Imagekit::UploadPreTransformErrorWebhookEvent::Data, - request: Imagekit::UploadPreTransformErrorWebhookEvent::Request, + data: Imagekit::UploadPreTransformErrorEvent::Data, + request: Imagekit::UploadPreTransformErrorEvent::Request, ?type: :"upload.pre-transform.error" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::UploadPreTransformErrorWebhookEvent::Data, - request: Imagekit::UploadPreTransformErrorWebhookEvent::Request, + data: Imagekit::UploadPreTransformErrorEvent::Data, + request: Imagekit::UploadPreTransformErrorEvent::Request, type: :"upload.pre-transform.error" } @@ -40,7 +40,7 @@ module Imagekit { name: String, path: String, - transformation: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + transformation: Imagekit::UploadPreTransformErrorEvent::Data::Transformation } class Data < Imagekit::Internal::Type::BaseModel @@ -48,34 +48,34 @@ module Imagekit attr_accessor path: String - attr_accessor transformation: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + attr_accessor transformation: Imagekit::UploadPreTransformErrorEvent::Data::Transformation def initialize: ( name: String, path: String, - transformation: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + transformation: Imagekit::UploadPreTransformErrorEvent::Data::Transformation ) -> void def to_hash: -> { name: String, path: String, - transformation: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation + transformation: Imagekit::UploadPreTransformErrorEvent::Data::Transformation } type transformation = { - error: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + error: Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error } class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor error: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + attr_accessor error: Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error def initialize: ( - error: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + error: Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error ) -> void def to_hash: -> { - error: Imagekit::UploadPreTransformErrorWebhookEvent::Data::Transformation::Error + error: Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error } type error = { reason: String } diff --git a/sig/imagekit/models/upload_pre_transform_success_webhook_event.rbs b/sig/imagekit/models/upload_pre_transform_success_event.rbs similarity index 70% rename from sig/imagekit/models/upload_pre_transform_success_webhook_event.rbs rename to sig/imagekit/models/upload_pre_transform_success_event.rbs index 5c22fbe1..b0933490 100644 --- a/sig/imagekit/models/upload_pre_transform_success_webhook_event.rbs +++ b/sig/imagekit/models/upload_pre_transform_success_event.rbs @@ -1,44 +1,44 @@ module Imagekit module Models - type upload_pre_transform_success_webhook_event = + type upload_pre_transform_success_event = { id: String, created_at: Time, - data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data, - request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + data: Imagekit::UploadPreTransformSuccessEvent::Data, + request: Imagekit::UploadPreTransformSuccessEvent::Request, type: :"upload.pre-transform.success" } - class UploadPreTransformSuccessWebhookEvent < Imagekit::Internal::Type::BaseModel + class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel attr_accessor id: String attr_accessor created_at: Time - attr_accessor data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data + attr_accessor data: Imagekit::UploadPreTransformSuccessEvent::Data - attr_accessor request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request + attr_accessor request: Imagekit::UploadPreTransformSuccessEvent::Request attr_accessor type: :"upload.pre-transform.success" def initialize: ( id: String, created_at: Time, - data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data, - request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + data: Imagekit::UploadPreTransformSuccessEvent::Data, + request: Imagekit::UploadPreTransformSuccessEvent::Request, ?type: :"upload.pre-transform.success" ) -> void def to_hash: -> { id: String, created_at: Time, - data: Imagekit::UploadPreTransformSuccessWebhookEvent::Data, - request: Imagekit::UploadPreTransformSuccessWebhookEvent::Request, + data: Imagekit::UploadPreTransformSuccessEvent::Data, + request: Imagekit::UploadPreTransformSuccessEvent::Request, type: :"upload.pre-transform.success" } type data = { - ai_tags: ::Array[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag]?, + ai_tags: ::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag]?, audio_codec: String, bit_rate: Integer, custom_coordinates: String?, @@ -46,7 +46,7 @@ module Imagekit description: String, duration: Integer, embedded_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + extension_status: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, file_id: String, file_path: String, file_type: String, @@ -59,13 +59,13 @@ module Imagekit tags: ::Array[String]?, thumbnail_url: String, url: String, - version_info: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + version_info: Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, video_codec: String, width: Float } class Data < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag]? + attr_accessor ai_tags: ::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag]? attr_reader audio_codec: String? @@ -93,11 +93,11 @@ module Imagekit def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader extension_status: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus? + attr_reader extension_status: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus? def extension_status=: ( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus - ) -> Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus + ) -> Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus attr_reader file_id: String? @@ -145,11 +145,11 @@ module Imagekit def url=: (String) -> String - attr_reader version_info: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo? + attr_reader version_info: Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo? def version_info=: ( - Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo - ) -> Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo + Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo + ) -> Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo attr_reader video_codec: String? @@ -160,7 +160,7 @@ module Imagekit def width=: (Float) -> Float def initialize: ( - ?ai_tags: ::Array[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag]?, + ?ai_tags: ::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag]?, ?audio_codec: String, ?bit_rate: Integer, ?custom_coordinates: String?, @@ -168,7 +168,7 @@ module Imagekit ?description: String, ?duration: Integer, ?embedded_metadata: ::Hash[Symbol, top], - ?extension_status: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + ?extension_status: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, ?file_id: String, ?file_path: String, ?file_type: String, @@ -181,13 +181,13 @@ module Imagekit ?tags: ::Array[String]?, ?thumbnail_url: String, ?url: String, - ?version_info: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + ?version_info: Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, ?video_codec: String, ?width: Float ) -> void def to_hash: -> { - ai_tags: ::Array[Imagekit::UploadPreTransformSuccessWebhookEvent::Data::AITag]?, + ai_tags: ::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag]?, audio_codec: String, bit_rate: Integer, custom_coordinates: String?, @@ -195,7 +195,7 @@ module Imagekit description: String, duration: Integer, embedded_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus, + extension_status: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, file_id: String, file_path: String, file_type: String, @@ -208,7 +208,7 @@ module Imagekit tags: ::Array[String]?, thumbnail_url: String, url: String, - version_info: Imagekit::UploadPreTransformSuccessWebhookEvent::Data::VersionInfo, + version_info: Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, video_codec: String, width: Float } @@ -239,40 +239,40 @@ module Imagekit type extension_status = { - aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg } class ExtensionStatus < Imagekit::Internal::Type::BaseModel - attr_reader aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging? + attr_reader aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging? def aws_auto_tagging=: ( - Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging - ) -> Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging + Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging + ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging - attr_reader google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging? + attr_reader google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging? def google_auto_tagging=: ( - Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging - ) -> Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging + Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging + ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging - attr_reader remove_bg: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg? + attr_reader remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg? def remove_bg=: ( - Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg - ) -> Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg + ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg def initialize: ( - ?aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging, - ?google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging, - ?remove_bg: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + ?aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg ) -> void def to_hash: -> { - aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg + aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg } type aws_auto_tagging = :success | :pending | :failed @@ -284,7 +284,7 @@ module Imagekit PENDING: :pending FAILED: :failed - def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::aws_auto_tagging] + def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging] end type google_auto_tagging = :success | :pending | :failed @@ -296,7 +296,7 @@ module Imagekit PENDING: :pending FAILED: :failed - def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::google_auto_tagging] + def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging] end type remove_bg = :success | :pending | :failed @@ -308,7 +308,7 @@ module Imagekit PENDING: :pending FAILED: :failed - def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessWebhookEvent::Data::ExtensionStatus::remove_bg] + def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg] end end diff --git a/sig/imagekit/resources/webhooks.rbs b/sig/imagekit/resources/webhooks.rbs index 10c283c2..ea4242dd 100644 --- a/sig/imagekit/resources/webhooks.rbs +++ b/sig/imagekit/resources/webhooks.rbs @@ -6,20 +6,20 @@ module Imagekit ) -> (Imagekit::VideoTransformationAcceptedEvent | Imagekit::VideoTransformationReadyEvent | Imagekit::VideoTransformationErrorEvent - | Imagekit::UploadPreTransformSuccessWebhookEvent - | Imagekit::UploadPreTransformErrorWebhookEvent - | Imagekit::UploadPostTransformSuccessWebhookEvent - | Imagekit::UploadPostTransformErrorWebhookEvent) + | Imagekit::UploadPreTransformSuccessEvent + | Imagekit::UploadPreTransformErrorEvent + | Imagekit::UploadPostTransformSuccessEvent + | Imagekit::UploadPostTransformErrorEvent) def unwrap: ( String payload ) -> (Imagekit::VideoTransformationAcceptedEvent | Imagekit::VideoTransformationReadyEvent | Imagekit::VideoTransformationErrorEvent - | Imagekit::UploadPreTransformSuccessWebhookEvent - | Imagekit::UploadPreTransformErrorWebhookEvent - | Imagekit::UploadPostTransformSuccessWebhookEvent - | Imagekit::UploadPostTransformErrorWebhookEvent) + | Imagekit::UploadPreTransformSuccessEvent + | Imagekit::UploadPreTransformErrorEvent + | Imagekit::UploadPostTransformSuccessEvent + | Imagekit::UploadPostTransformErrorEvent) def initialize: (client: Imagekit::Client) -> void end From e6f6c2fad095adcbd39d93da1d98ddc5372e4ac8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 1 Sep 2025 10:26:09 +0000 Subject: [PATCH 081/178] feat(api): add ai-auto-description field with status options to components schema --- .stats.yml | 4 +- .../models/beta/v2/file_upload_response.rb | 22 ++++++- lib/imagekit/models/file_upload_response.rb | 22 ++++++- .../upload_pre_transform_success_event.rb | 24 +++++++- .../models/beta/v2/file_upload_response.rbi | 61 +++++++++++++++++++ rbi/imagekit/models/file_upload_response.rbi | 61 +++++++++++++++++++ .../upload_pre_transform_success_event.rbi | 61 +++++++++++++++++++ .../models/beta/v2/file_upload_response.rbs | 21 +++++++ sig/imagekit/models/file_upload_response.rbs | 21 +++++++ .../upload_pre_transform_success_event.rbs | 21 +++++++ 10 files changed, 313 insertions(+), 5 deletions(-) diff --git a/.stats.yml b/.stats.yml index 6bb89db0..bd62087f 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-d857341f30517b11df568dd6c5a0e9dea3a854930f7f6583718114d311f2d5ee.yml -openapi_spec_hash: db94bfd556220d6244a1b2bbae9d7d00 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-3d7da4b8ef2ed30aa32c4fb3e98e498e67402e91aaa5fd4c628fc080bfe82ea1.yml +openapi_spec_hash: aaa50fcbccec6f2cf1165f34bc6ac886 config_hash: 4ef178e13ecfdb97211f284f13a21e83 diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekit/models/beta/v2/file_upload_response.rb index 5d90c5b0..65cab1f9 100644 --- a/lib/imagekit/models/beta/v2/file_upload_response.rb +++ b/lib/imagekit/models/beta/v2/file_upload_response.rb @@ -276,6 +276,13 @@ class AITag < Imagekit::Internal::Type::BaseModel # @see Imagekit::Models::Beta::V2::FileUploadResponse#extension_status class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute ai_auto_description + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription, nil] + optional :ai_auto_description, + enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription }, + api_name: :"ai-auto-description" + # @!attribute aws_auto_tagging # # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] @@ -297,7 +304,7 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" - # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) # Extension names with their processing status at the time of completion of the # request. It could have one of the following status values: # @@ -308,10 +315,23 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # + # @param ai_auto_description [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription] # @param aws_auto_tagging [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging] # @param google_auto_tagging [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] # @param remove_bg [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg] + # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#ai_auto_description + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#aws_auto_tagging module AwsAutoTagging extend Imagekit::Internal::Type::Enum diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekit/models/file_upload_response.rb index 2d9c67ec..85ebf598 100644 --- a/lib/imagekit/models/file_upload_response.rb +++ b/lib/imagekit/models/file_upload_response.rb @@ -272,6 +272,13 @@ class AITag < Imagekit::Internal::Type::BaseModel # @see Imagekit::Models::FileUploadResponse#extension_status class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute ai_auto_description + # + # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription, nil] + optional :ai_auto_description, + enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription }, + api_name: :"ai-auto-description" + # @!attribute aws_auto_tagging # # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] @@ -293,7 +300,7 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" - # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) # Extension names with their processing status at the time of completion of the # request. It could have one of the following status values: # @@ -304,10 +311,23 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # + # @param ai_auto_description [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription] # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging] # @param google_auto_tagging [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] # @param remove_bg [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg] + # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#ai_auto_description + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#aws_auto_tagging module AwsAutoTagging extend Imagekit::Internal::Type::Enum diff --git a/lib/imagekit/models/upload_pre_transform_success_event.rb b/lib/imagekit/models/upload_pre_transform_success_event.rb index a9f0f0ce..37c3be87 100644 --- a/lib/imagekit/models/upload_pre_transform_success_event.rb +++ b/lib/imagekit/models/upload_pre_transform_success_event.rb @@ -321,6 +321,15 @@ class AITag < Imagekit::Internal::Type::BaseModel # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data#extension_status class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @!attribute ai_auto_description + # + # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription, nil] + optional :ai_auto_description, + enum: -> { + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription + }, + api_name: :"ai-auto-description" + # @!attribute aws_auto_tagging # # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging, nil] @@ -346,7 +355,7 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel enum: -> { Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" - # @!method initialize(aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) # Extension names with their processing status at the time of completion of the # request. It could have one of the following status values: # @@ -357,10 +366,23 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # + # @param ai_auto_description [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription] # @param aws_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging] # @param google_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging] # @param remove_bg [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg] + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#ai_auto_description + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#aws_auto_tagging module AwsAutoTagging extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekit/models/beta/v2/file_upload_response.rbi index d2c558c3..ea3ffd3d 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_response.rbi @@ -449,6 +449,23 @@ module Imagekit ) end + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + ) + end + attr_reader :ai_auto_description + + sig do + params( + ai_auto_description: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol + ).void + end + attr_writer :ai_auto_description + sig do returns( T.nilable( @@ -511,6 +528,8 @@ module Imagekit # If no extension was requested, then this parameter is not returned. sig do params( + ai_auto_description: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol, aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: @@ -520,6 +539,7 @@ module Imagekit ).returns(T.attached_class) end def self.new( + ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil @@ -529,6 +549,8 @@ module Imagekit sig do override.returns( { + ai_auto_description: + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: @@ -541,6 +563,45 @@ module Imagekit def to_hash end + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ] + ) + end + def self.values + end + end + module AwsAutoTagging extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekit/models/file_upload_response.rbi index e71a13fc..aa46ceb4 100644 --- a/rbi/imagekit/models/file_upload_response.rbi +++ b/rbi/imagekit/models/file_upload_response.rbi @@ -430,6 +430,23 @@ module Imagekit ) end + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + ) + end + attr_reader :ai_auto_description + + sig do + params( + ai_auto_description: + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol + ).void + end + attr_writer :ai_auto_description + sig do returns( T.nilable( @@ -492,6 +509,8 @@ module Imagekit # If no extension was requested, then this parameter is not returned. sig do params( + ai_auto_description: + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol, aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: @@ -501,6 +520,7 @@ module Imagekit ).returns(T.attached_class) end def self.new( + ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil @@ -510,6 +530,8 @@ module Imagekit sig do override.returns( { + ai_auto_description: + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: @@ -522,6 +544,45 @@ module Imagekit def to_hash end + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + ] + ) + end + def self.values + end + end + module AwsAutoTagging extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/models/upload_pre_transform_success_event.rbi b/rbi/imagekit/models/upload_pre_transform_success_event.rbi index da38d8ab..92358f5d 100644 --- a/rbi/imagekit/models/upload_pre_transform_success_event.rbi +++ b/rbi/imagekit/models/upload_pre_transform_success_event.rbi @@ -526,6 +526,23 @@ module Imagekit ) end + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + ) + end + attr_reader :ai_auto_description + + sig do + params( + ai_auto_description: + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::OrSymbol + ).void + end + attr_writer :ai_auto_description + sig do returns( T.nilable( @@ -588,6 +605,8 @@ module Imagekit # If no extension was requested, then this parameter is not returned. sig do params( + ai_auto_description: + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::OrSymbol, aws_auto_tagging: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: @@ -597,6 +616,7 @@ module Imagekit ).returns(T.attached_class) end def self.new( + ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil @@ -606,6 +626,8 @@ module Imagekit sig do override.returns( { + ai_auto_description: + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol, aws_auto_tagging: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: @@ -618,6 +640,45 @@ module Imagekit def to_hash end + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + ] + ) + end + def self.values + end + end + module AwsAutoTagging extend Imagekit::Internal::Type::Enum diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs index 1e41ee42..3955ca0d 100644 --- a/sig/imagekit/models/beta/v2/file_upload_response.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_response.rbs @@ -205,12 +205,19 @@ module Imagekit type extension_status = { + ai_auto_description: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg } class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader ai_auto_description: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description? + + def ai_auto_description=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description + attr_reader aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging? def aws_auto_tagging=: ( @@ -230,17 +237,31 @@ module Imagekit ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg def initialize: ( + ?ai_auto_description: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, ?aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, ?google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, ?remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg ) -> void def to_hash: -> { + ai_auto_description: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg } + type ai_auto_description = :success | :pending | :failed + + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description] + end + type aws_auto_tagging = :success | :pending | :failed module AwsAutoTagging diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs index 5d6d5bc2..10348f34 100644 --- a/sig/imagekit/models/file_upload_response.rbs +++ b/sig/imagekit/models/file_upload_response.rbs @@ -203,12 +203,19 @@ module Imagekit type extension_status = { + ai_auto_description: Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg } class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader ai_auto_description: Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description? + + def ai_auto_description=: ( + Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description + ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description + attr_reader aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging? def aws_auto_tagging=: ( @@ -228,17 +235,31 @@ module Imagekit ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg def initialize: ( + ?ai_auto_description: Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, ?aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, ?google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, ?remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg ) -> void def to_hash: -> { + ai_auto_description: Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg } + type ai_auto_description = :success | :pending | :failed + + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description] + end + type aws_auto_tagging = :success | :pending | :failed module AwsAutoTagging diff --git a/sig/imagekit/models/upload_pre_transform_success_event.rbs b/sig/imagekit/models/upload_pre_transform_success_event.rbs index b0933490..d043704c 100644 --- a/sig/imagekit/models/upload_pre_transform_success_event.rbs +++ b/sig/imagekit/models/upload_pre_transform_success_event.rbs @@ -239,12 +239,19 @@ module Imagekit type extension_status = { + ai_auto_description: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg } class ExtensionStatus < Imagekit::Internal::Type::BaseModel + attr_reader ai_auto_description: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description? + + def ai_auto_description=: ( + Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description + ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description + attr_reader aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging? def aws_auto_tagging=: ( @@ -264,17 +271,31 @@ module Imagekit ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg def initialize: ( + ?ai_auto_description: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, ?aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, ?google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, ?remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg ) -> void def to_hash: -> { + ai_auto_description: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg } + type ai_auto_description = :success | :pending | :failed + + module AIAutoDescription + extend Imagekit::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description] + end + type aws_auto_tagging = :success | :pending | :failed module AwsAutoTagging From f187429363ca0f8330c7cd432672177247b1aa30 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 1 Sep 2025 10:53:23 +0000 Subject: [PATCH 082/178] feat(docs): improve descriptions for private API key and password fields in client settings --- .stats.yml | 2 +- README.md | 2 +- lib/imagekit/client.rb | 16 +++++++++++----- rbi/imagekit/client.rbi | 16 +++++++++++----- 4 files changed, 24 insertions(+), 12 deletions(-) diff --git a/.stats.yml b/.stats.yml index bd62087f..a4e72d08 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: 4ef178e13ecfdb97211f284f13a21e83 +config_hash: 7218b2df6efd609f88bac0ac591a70e9 diff --git a/README.md b/README.md index 44761974..8d9c1b92 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ require "imagekit" image_kit = Imagekit::Client.new( private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], # This is the default and can be omitted - password: ENV["ORG_MY_PASSWORD_TOKEN"] # This is the default and can be omitted + password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) response = image_kit.files.upload( diff --git a/lib/imagekit/client.rb b/lib/imagekit/client.rb index e44d7323..fd57748a 100644 --- a/lib/imagekit/client.rb +++ b/lib/imagekit/client.rb @@ -15,11 +15,14 @@ class Client < Imagekit::Internal::Transport::BaseClient # Default max retry delay in seconds. DEFAULT_MAX_RETRY_DELAY = 8.0 - # Your ImageKit private key starts with `private_`. + # Your ImageKit private API key (it starts with `private_`). You can view and + # manage API keys in the + # [dashboard](https://imagekit.io/dashboard/developer/api-keys). # @return [String] attr_reader :private_api_key - # Do not set this, its value is ignored + # ImageKit Basic Auth only uses the username field and ignores the password. This + # field is unused. # @return [String, nil] attr_reader :password @@ -64,10 +67,13 @@ def base_url_overridden? = @base_url_overridden # Creates and returns a new client for interacting with the API. # - # @param private_api_key [String, nil] Your ImageKit private key starts with `private_`. Defaults to + # @param private_api_key [String, nil] Your ImageKit private API key (it starts with `private_`). You can view and + # manage API keys in the + # [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to # `ENV["IMAGEKIT_PRIVATE_API_KEY"]` # - # @param password [String, nil] Do not set this, its value is ignored Defaults to `ENV["ORG_MY_PASSWORD_TOKEN"]` + # @param password [String, nil] ImageKit Basic Auth only uses the username field and ignores the password. This + # field is unused. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` # # @param base_url [String, nil] Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` @@ -81,7 +87,7 @@ def base_url_overridden? = @base_url_overridden # @param max_retry_delay [Float] def initialize( private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], - password: ENV.fetch("ORG_MY_PASSWORD_TOKEN", "does_not_matter"), + password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"), base_url: ENV["IMAGE_KIT_BASE_URL"], max_retries: self.class::DEFAULT_MAX_RETRIES, timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS, diff --git a/rbi/imagekit/client.rbi b/rbi/imagekit/client.rbi index be03b7df..f290a74d 100644 --- a/rbi/imagekit/client.rbi +++ b/rbi/imagekit/client.rbi @@ -10,11 +10,14 @@ module Imagekit DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float) - # Your ImageKit private key starts with `private_`. + # Your ImageKit private API key (it starts with `private_`). You can view and + # manage API keys in the + # [dashboard](https://imagekit.io/dashboard/developer/api-keys). sig { returns(String) } attr_reader :private_api_key - # Do not set this, its value is ignored + # ImageKit Basic Auth only uses the username field and ignores the password. This + # field is unused. sig { returns(T.nilable(String)) } attr_reader :password @@ -65,11 +68,14 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Your ImageKit private key starts with `private_`. Defaults to + # Your ImageKit private API key (it starts with `private_`). You can view and + # manage API keys in the + # [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to # `ENV["IMAGEKIT_PRIVATE_API_KEY"]` private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], - # Do not set this, its value is ignored Defaults to `ENV["ORG_MY_PASSWORD_TOKEN"]` - password: ENV.fetch("ORG_MY_PASSWORD_TOKEN", "does_not_matter"), + # ImageKit Basic Auth only uses the username field and ignores the password. This + # field is unused. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` + password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"), # Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` base_url: ENV["IMAGE_KIT_BASE_URL"], From 7feceafaf296dc436ea61322513a27df673df996 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 1 Sep 2025 12:45:07 +0000 Subject: [PATCH 083/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index a4e72d08..93aeb615 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: 7218b2df6efd609f88bac0ac591a70e9 +config_hash: af15f7df8a4590c14cdce4460983aba6 From 5b12e66b6995ae9d47fd1bed12157532d388e4b3 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:06:09 +0000 Subject: [PATCH 084/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 93aeb615..8599545e 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: af15f7df8a4590c14cdce4460983aba6 +config_hash: 84bf9f929b0248a6cdf2d526331ed8eb From 6dce486c9c11cdab5d8d0a2f7ca84ea673464a9e 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:13:04 +0000 Subject: [PATCH 085/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 8599545e..28637701 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: 84bf9f929b0248a6cdf2d526331ed8eb +config_hash: 0f760028496146ece9431573b1ab0e46 From 22de5b726adfde1d5a0a31f57d637bf51a9df45b 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:07 +0000 Subject: [PATCH 086/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 28637701..ad85869b 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: 0f760028496146ece9431573b1ab0e46 +config_hash: cf9d50fe62973f4e91ef65c147aabcc1 From e9d572b3dd5e7188ce3b38a65cc6490bd4b48080 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:51:02 +0000 Subject: [PATCH 087/178] chore: update SDK settings --- .github/workflows/publish-gem.yml | 31 ++++++++++++ .github/workflows/release-doctor.yml | 22 +++++++++ .release-please-manifest.json | 3 ++ .stats.yml | 2 +- CONTRIBUTING.md | 4 +- README.md | 8 +++- bin/check-release-environment | 21 +++++++++ imagekit.gemspec | 2 +- release-please-config.json | 70 ++++++++++++++++++++++++++++ 9 files changed, 157 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/publish-gem.yml create mode 100644 .github/workflows/release-doctor.yml create mode 100644 .release-please-manifest.json create mode 100644 bin/check-release-environment create mode 100644 release-please-config.json diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml new file mode 100644 index 00000000..a3de9dee --- /dev/null +++ b/.github/workflows/publish-gem.yml @@ -0,0 +1,31 @@ +# This workflow is triggered when a GitHub release is created. +# It can also be run manually to re-publish to rubygems.org in case it failed for some reason. +# You can run this workflow by navigating to https://www.github.com/imagekit-developer/imagekit-ruby/actions/workflows/publish-gem.yml +name: Publish Gem +on: + workflow_dispatch: + + release: + types: [published] + +jobs: + publish: + name: publish + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: false + - run: |- + bundle install + + - name: Publish to RubyGems.org + run: | + bash ./bin/publish-gem + env: + # `RUBYGEMS_HOST` is only required for private gem repositories, not https://rubygems.org + RUBYGEMS_HOST: ${{ secrets.IMAGE_KIT_RUBYGEMS_HOST || secrets.RUBYGEMS_HOST }} + GEM_HOST_API_KEY: ${{ secrets.IMAGE_KIT_GEM_HOST_API_KEY || secrets.GEM_HOST_API_KEY }} diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml new file mode 100644 index 00000000..9d9c1e66 --- /dev/null +++ b/.github/workflows/release-doctor.yml @@ -0,0 +1,22 @@ +name: Release Doctor +on: + pull_request: + branches: + - master + workflow_dispatch: + +jobs: + release_doctor: + name: release doctor + runs-on: ubuntu-latest + if: github.repository == 'imagekit-developer/imagekit-ruby' && (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: + RUBYGEMS_HOST: ${{ secrets.IMAGE_KIT_RUBYGEMS_HOST || secrets.RUBYGEMS_HOST }} + GEM_HOST_API_KEY: ${{ secrets.IMAGE_KIT_GEM_HOST_API_KEY || secrets.GEM_HOST_API_KEY }} 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 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/CONTRIBUTING.md b/CONTRIBUTING.md index ff57412c..15b2dbaa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,13 +43,13 @@ If you’d like to use the repository from source, you can either install from g To install via git in your `Gemfile`: ```ruby -gem "imagekit", git: "https://www.github.com/stainless-sdks/imagekit-ruby" +gem "imagekit", git: "https://www.github.com/imagekit-developer/imagekit-ruby" ``` Alternatively, reference local copy of the repo: ```bash -$ git clone -- 'https://www.github.com/stainless-sdks/imagekit-ruby' '' +$ git clone -- 'https://www.github.com/imagekit-developer/imagekit-ruby' '' ``` ```ruby diff --git a/README.md b/README.md index 8d9c1b92..32341ee0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Image Kit Ruby API library -The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/stainless-sdks/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. +The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/imagekit-developer/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. It is generated with [Stainless](https://www.stainless.com/). @@ -14,10 +14,14 @@ The REST API documentation can be found on [imagekit.io](https://imagekit.io/doc To use this gem, install via Bundler by adding the following to your application's `Gemfile`: + + ```ruby gem "imagekit", "~> 0.0.1" ``` + + ## Usage ```ruby @@ -275,4 +279,4 @@ Ruby 3.2.0 or higher. ## Contributing -See [the contributing documentation](https://github.com/stainless-sdks/imagekit-ruby/tree/main/CONTRIBUTING.md). +See [the contributing documentation](https://github.com/imagekit-developer/imagekit-ruby/tree/master/CONTRIBUTING.md). diff --git a/bin/check-release-environment b/bin/check-release-environment new file mode 100644 index 00000000..c05436e8 --- /dev/null +++ b/bin/check-release-environment @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +errors=() + +if [ -z "${GEM_HOST_API_KEY}" ]; then + errors+=("The GEM_HOST_API_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/imagekit.gemspec b/imagekit.gemspec index a29c6731..f094efa0 100644 --- a/imagekit.gemspec +++ b/imagekit.gemspec @@ -10,7 +10,7 @@ Gem::Specification.new do |s| s.email = "developer@imagekit.io" s.homepage = "https://gemdocs.org/gems/imagekit" s.metadata["homepage_uri"] = s.homepage - s.metadata["source_code_uri"] = "https://github.com/stainless-sdks/imagekit-ruby" + s.metadata["source_code_uri"] = "https://github.com/imagekit-developer/imagekit-ruby" s.metadata["rubygems_mfa_required"] = false.to_s s.required_ruby_version = ">= 3.2.0" diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 00000000..32536019 --- /dev/null +++ b/release-please-config.json @@ -0,0 +1,70 @@ +{ + "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": "ruby", + "version-file": "lib/imagekit/version.rb", + "extra-files": [ + { + "type": "ruby-readme", + "path": "README.md" + } + ] +} \ No newline at end of file From b09e8b676a1c39f8e36ebd03fc142085325ecf06 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:37 +0000 Subject: [PATCH 088/178] feat(api): add BaseWebhookEvent --- .stats.yml | 6 +++--- lib/imagekit/models/unsafe_unwrap_webhook_event.rb | 10 ---------- lib/imagekit/models/unwrap_webhook_event.rb | 10 ---------- .../models/upload_post_transform_error_event.rb | 3 --- .../models/upload_post_transform_success_event.rb | 4 ---- .../models/upload_pre_transform_error_event.rb | 3 --- .../models/upload_pre_transform_success_event.rb | 4 ---- .../models/video_transformation_accepted_event.rb | 4 ---- .../models/video_transformation_error_event.rb | 5 ----- .../models/video_transformation_ready_event.rb | 5 ----- rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi | 3 --- rbi/imagekit/models/unwrap_webhook_event.rbi | 3 --- .../models/upload_post_transform_error_event.rbi | 2 -- .../models/upload_post_transform_success_event.rbi | 3 --- .../models/upload_pre_transform_error_event.rbi | 2 -- .../models/upload_pre_transform_success_event.rbi | 3 --- .../models/video_transformation_accepted_event.rbi | 3 --- .../models/video_transformation_error_event.rbi | 4 ---- .../models/video_transformation_ready_event.rbi | 4 ---- 19 files changed, 3 insertions(+), 78 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/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb index 28e1b855..8c7385c2 100644 --- a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb @@ -2,31 +2,21 @@ module Imagekit module Models - # 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. module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union - # 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. variant -> { Imagekit::VideoTransformationAcceptedEvent } - # 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. variant -> { Imagekit::VideoTransformationReadyEvent } - # 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. variant -> { Imagekit::VideoTransformationErrorEvent } - # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. variant -> { Imagekit::UploadPreTransformSuccessEvent } - # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. variant -> { Imagekit::UploadPreTransformErrorEvent } - # 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. variant -> { Imagekit::UploadPostTransformSuccessEvent } - # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. variant -> { Imagekit::UploadPostTransformErrorEvent } # @!method self.variants diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb index c200c085..f01a6770 100644 --- a/lib/imagekit/models/unwrap_webhook_event.rb +++ b/lib/imagekit/models/unwrap_webhook_event.rb @@ -2,31 +2,21 @@ module Imagekit module Models - # 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. module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union - # 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. variant -> { Imagekit::VideoTransformationAcceptedEvent } - # 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. variant -> { Imagekit::VideoTransformationReadyEvent } - # 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. variant -> { Imagekit::VideoTransformationErrorEvent } - # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. variant -> { Imagekit::UploadPreTransformSuccessEvent } - # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. variant -> { Imagekit::UploadPreTransformErrorEvent } - # 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. variant -> { Imagekit::UploadPostTransformSuccessEvent } - # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. variant -> { Imagekit::UploadPostTransformErrorEvent } # @!method self.variants diff --git a/lib/imagekit/models/upload_post_transform_error_event.rb b/lib/imagekit/models/upload_post_transform_error_event.rb index 3569da50..bf8ddb2b 100644 --- a/lib/imagekit/models/upload_post_transform_error_event.rb +++ b/lib/imagekit/models/upload_post_transform_error_event.rb @@ -31,9 +31,6 @@ class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"upload.post-transform.error" # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.error") - # Triggered when a post-transformation fails. The original file remains available, - # but the requested transformation could not be generated. - # # @param id [String] Unique identifier for the event. # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. diff --git a/lib/imagekit/models/upload_post_transform_success_event.rb b/lib/imagekit/models/upload_post_transform_success_event.rb index 07b856b2..9dfe77d7 100644 --- a/lib/imagekit/models/upload_post_transform_success_event.rb +++ b/lib/imagekit/models/upload_post_transform_success_event.rb @@ -31,10 +31,6 @@ class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"upload.post-transform.success" # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.success") - # 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. - # # @param id [String] Unique identifier for the event. # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. diff --git a/lib/imagekit/models/upload_pre_transform_error_event.rb b/lib/imagekit/models/upload_pre_transform_error_event.rb index d672e680..3c9b9453 100644 --- a/lib/imagekit/models/upload_pre_transform_error_event.rb +++ b/lib/imagekit/models/upload_pre_transform_error_event.rb @@ -31,9 +31,6 @@ class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"upload.pre-transform.error" # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.error") - # Triggered when a pre-transformation fails. The file upload may have been - # accepted, but the requested transformation could not be applied. - # # @param id [String] Unique identifier for the event. # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. diff --git a/lib/imagekit/models/upload_pre_transform_success_event.rb b/lib/imagekit/models/upload_pre_transform_success_event.rb index 37c3be87..ca0e39c3 100644 --- a/lib/imagekit/models/upload_pre_transform_success_event.rb +++ b/lib/imagekit/models/upload_pre_transform_success_event.rb @@ -32,10 +32,6 @@ class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"upload.pre-transform.success" # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.success") - # Triggered when a pre-transformation completes successfully. The file has been - # processed with the requested transformation and is now available in the Media - # Library. - # # @param id [String] Unique identifier for the event. # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. diff --git a/lib/imagekit/models/video_transformation_accepted_event.rb b/lib/imagekit/models/video_transformation_accepted_event.rb index 05cf00ab..3c90be50 100644 --- a/lib/imagekit/models/video_transformation_accepted_event.rb +++ b/lib/imagekit/models/video_transformation_accepted_event.rb @@ -32,10 +32,6 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"video.transformation.accepted" # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.accepted") - # 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. - # # @param id [String] Unique identifier for the event. # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. diff --git a/lib/imagekit/models/video_transformation_error_event.rb b/lib/imagekit/models/video_transformation_error_event.rb index fe6c9a88..8b56b9f3 100644 --- a/lib/imagekit/models/video_transformation_error_event.rb +++ b/lib/imagekit/models/video_transformation_error_event.rb @@ -32,11 +32,6 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel required :type, const: :"video.transformation.error" # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.error") - # 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. - # # @param id [String] Unique identifier for the event. # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. diff --git a/lib/imagekit/models/video_transformation_ready_event.rb b/lib/imagekit/models/video_transformation_ready_event.rb index 076e88c4..5ab29898 100644 --- a/lib/imagekit/models/video_transformation_ready_event.rb +++ b/lib/imagekit/models/video_transformation_ready_event.rb @@ -38,11 +38,6 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel optional :timings, -> { Imagekit::VideoTransformationReadyEvent::Timings } # @!method initialize(id:, created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") - # 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. - # # @param id [String] Unique identifier for the event. # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi index 4dbc761c..10ea4aa8 100644 --- a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi @@ -2,9 +2,6 @@ module Imagekit module Models - # 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. module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi index b94a7e27..3c4a71a8 100644 --- a/rbi/imagekit/models/unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unwrap_webhook_event.rbi @@ -2,9 +2,6 @@ module Imagekit module Models - # 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. module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/upload_post_transform_error_event.rbi b/rbi/imagekit/models/upload_post_transform_error_event.rbi index a2fd2772..07bb8841 100644 --- a/rbi/imagekit/models/upload_post_transform_error_event.rbi +++ b/rbi/imagekit/models/upload_post_transform_error_event.rbi @@ -40,8 +40,6 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type - # Triggered when a post-transformation fails. The original file remains available, - # but the requested transformation could not be generated. sig do params( id: String, diff --git a/rbi/imagekit/models/upload_post_transform_success_event.rbi b/rbi/imagekit/models/upload_post_transform_success_event.rbi index 189c4ad9..5cee3967 100644 --- a/rbi/imagekit/models/upload_post_transform_success_event.rbi +++ b/rbi/imagekit/models/upload_post_transform_success_event.rbi @@ -42,9 +42,6 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type - # 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. sig do params( id: String, diff --git a/rbi/imagekit/models/upload_pre_transform_error_event.rbi b/rbi/imagekit/models/upload_pre_transform_error_event.rbi index a6338f83..ed5847ac 100644 --- a/rbi/imagekit/models/upload_pre_transform_error_event.rbi +++ b/rbi/imagekit/models/upload_pre_transform_error_event.rbi @@ -40,8 +40,6 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type - # Triggered when a pre-transformation fails. The file upload may have been - # accepted, but the requested transformation could not be applied. sig do params( id: String, diff --git a/rbi/imagekit/models/upload_pre_transform_success_event.rbi b/rbi/imagekit/models/upload_pre_transform_success_event.rbi index 92358f5d..33574306 100644 --- a/rbi/imagekit/models/upload_pre_transform_success_event.rbi +++ b/rbi/imagekit/models/upload_pre_transform_success_event.rbi @@ -43,9 +43,6 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type - # Triggered when a pre-transformation completes successfully. The file has been - # processed with the requested transformation and is now available in the Media - # Library. sig do params( id: String, diff --git a/rbi/imagekit/models/video_transformation_accepted_event.rbi b/rbi/imagekit/models/video_transformation_accepted_event.rbi index a7b609fc..a149c0c1 100644 --- a/rbi/imagekit/models/video_transformation_accepted_event.rbi +++ b/rbi/imagekit/models/video_transformation_accepted_event.rbi @@ -43,9 +43,6 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type - # 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. sig do params( id: String, diff --git a/rbi/imagekit/models/video_transformation_error_event.rbi b/rbi/imagekit/models/video_transformation_error_event.rbi index 8b6b316d..94beea16 100644 --- a/rbi/imagekit/models/video_transformation_error_event.rbi +++ b/rbi/imagekit/models/video_transformation_error_event.rbi @@ -41,10 +41,6 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type - # 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. sig do params( id: String, diff --git a/rbi/imagekit/models/video_transformation_ready_event.rbi b/rbi/imagekit/models/video_transformation_ready_event.rbi index 3b8c06d0..1891cda8 100644 --- a/rbi/imagekit/models/video_transformation_ready_event.rbi +++ b/rbi/imagekit/models/video_transformation_ready_event.rbi @@ -54,10 +54,6 @@ module Imagekit end attr_writer :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. sig do params( id: String, From e5961b7591bc44e40f46084172e6824130624737 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:04 +0000 Subject: [PATCH 089/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 1 + lib/imagekit/models.rb | 2 ++ lib/imagekit/models/base_webhook_event.rb | 24 ++++++++++++++ .../models/unsafe_unwrap_webhook_event.rb | 10 ++++++ lib/imagekit/models/unwrap_webhook_event.rb | 10 ++++++ .../upload_post_transform_error_event.rb | 15 +++------ .../upload_post_transform_success_event.rb | 16 +++------ .../upload_pre_transform_error_event.rb | 15 +++------ .../upload_pre_transform_success_event.rb | 16 +++------ .../video_transformation_accepted_event.rb | 16 +++------ .../video_transformation_error_event.rb | 17 ++++------ .../video_transformation_ready_event.rb | 18 ++++------ rbi/imagekit/models.rbi | 2 ++ rbi/imagekit/models/base_webhook_event.rbi | 33 +++++++++++++++++++ .../models/unsafe_unwrap_webhook_event.rbi | 3 ++ rbi/imagekit/models/unwrap_webhook_event.rbi | 3 ++ .../upload_post_transform_error_event.rbi | 12 ++----- .../upload_post_transform_success_event.rbi | 13 +++----- .../upload_pre_transform_error_event.rbi | 12 ++----- .../upload_pre_transform_success_event.rbi | 13 +++----- .../video_transformation_accepted_event.rbi | 13 +++----- .../video_transformation_error_event.rbi | 14 +++----- .../video_transformation_ready_event.rbi | 14 +++----- sig/imagekit/models.rbs | 2 ++ sig/imagekit/models/base_webhook_event.rbs | 15 +++++++++ .../upload_post_transform_error_event.rbs | 27 ++++++++++----- .../upload_post_transform_success_event.rbs | 27 ++++++++++----- .../upload_pre_transform_error_event.rbs | 27 ++++++++++----- .../upload_pre_transform_success_event.rbs | 27 ++++++++++----- .../video_transformation_accepted_event.rbs | 27 ++++++++++----- .../video_transformation_error_event.rbs | 27 ++++++++++----- .../video_transformation_ready_event.rbs | 31 ++++++++++------- 33 files changed, 297 insertions(+), 207 deletions(-) create mode 100644 lib/imagekit/models/base_webhook_event.rb create mode 100644 rbi/imagekit/models/base_webhook_event.rbi create mode 100644 sig/imagekit/models/base_webhook_event.rbs 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/lib/imagekit.rb b/lib/imagekit.rb index 4d38be1e..657d3c0d 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -54,6 +54,7 @@ require_relative "imagekit/models/accounts/url_endpoint_request" require_relative "imagekit/models/file" require_relative "imagekit/models/base_overlay" +require_relative "imagekit/models/base_webhook_event" require_relative "imagekit/models/accounts/origin_create_params" require_relative "imagekit/models/accounts/origin_delete_params" require_relative "imagekit/models/accounts/origin_get_params" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index b8653a86..5c3ae2fe 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -45,6 +45,8 @@ module Imagekit BaseOverlay = Imagekit::Models::BaseOverlay + BaseWebhookEvent = Imagekit::Models::BaseWebhookEvent + Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache diff --git a/lib/imagekit/models/base_webhook_event.rb b/lib/imagekit/models/base_webhook_event.rb new file mode 100644 index 00000000..d34435b2 --- /dev/null +++ b/lib/imagekit/models/base_webhook_event.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class BaseWebhookEvent < Imagekit::Internal::Type::BaseModel + # @!attribute id + # Unique identifier for the event. + # + # @return [String] + required :id, String + + # @!attribute type + # The type of webhook event. + # + # @return [String] + required :type, String + + # @!method initialize(id:, type:) + # @param id [String] Unique identifier for the event. + # + # @param type [String] The type of webhook event. + end + end +end diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb index 8c7385c2..28e1b855 100644 --- a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb @@ -2,21 +2,31 @@ module Imagekit module Models + # 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. module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union + # 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. variant -> { Imagekit::VideoTransformationAcceptedEvent } + # 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. variant -> { Imagekit::VideoTransformationReadyEvent } + # 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. variant -> { Imagekit::VideoTransformationErrorEvent } + # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. variant -> { Imagekit::UploadPreTransformSuccessEvent } + # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. variant -> { Imagekit::UploadPreTransformErrorEvent } + # 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. variant -> { Imagekit::UploadPostTransformSuccessEvent } + # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. variant -> { Imagekit::UploadPostTransformErrorEvent } # @!method self.variants diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb index f01a6770..c200c085 100644 --- a/lib/imagekit/models/unwrap_webhook_event.rb +++ b/lib/imagekit/models/unwrap_webhook_event.rb @@ -2,21 +2,31 @@ module Imagekit module Models + # 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. module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union + # 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. variant -> { Imagekit::VideoTransformationAcceptedEvent } + # 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. variant -> { Imagekit::VideoTransformationReadyEvent } + # 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. variant -> { Imagekit::VideoTransformationErrorEvent } + # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. variant -> { Imagekit::UploadPreTransformSuccessEvent } + # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. variant -> { Imagekit::UploadPreTransformErrorEvent } + # 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. variant -> { Imagekit::UploadPostTransformSuccessEvent } + # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. variant -> { Imagekit::UploadPostTransformErrorEvent } # @!method self.variants diff --git a/lib/imagekit/models/upload_post_transform_error_event.rb b/lib/imagekit/models/upload_post_transform_error_event.rb index bf8ddb2b..31abc43b 100644 --- a/lib/imagekit/models/upload_post_transform_error_event.rb +++ b/lib/imagekit/models/upload_post_transform_error_event.rb @@ -2,13 +2,7 @@ module Imagekit module Models - class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the event. - # - # @return [String] - required :id, String - + class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent # @!attribute created_at # Timestamp of when the event occurred in ISO8601 format. # @@ -30,8 +24,9 @@ class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel # @return [Symbol, :"upload.post-transform.error"] required :type, const: :"upload.post-transform.error" - # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.error") - # @param id [String] Unique identifier for the event. + # @!method initialize(created_at:, data:, request:, type: :"upload.post-transform.error") + # Triggered when a post-transformation fails. The original file remains available, + # but the requested transformation could not be generated. # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # @@ -41,7 +36,6 @@ class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel # # @param type [Symbol, :"upload.post-transform.error"] - # @see Imagekit::Models::UploadPostTransformErrorEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute file_id # Unique identifier of the originally uploaded file. @@ -107,7 +101,6 @@ class Error < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::UploadPostTransformErrorEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute transformation # diff --git a/lib/imagekit/models/upload_post_transform_success_event.rb b/lib/imagekit/models/upload_post_transform_success_event.rb index 9dfe77d7..e181c6d2 100644 --- a/lib/imagekit/models/upload_post_transform_success_event.rb +++ b/lib/imagekit/models/upload_post_transform_success_event.rb @@ -2,13 +2,7 @@ module Imagekit module Models - class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the event. - # - # @return [String] - required :id, String - + class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent # @!attribute created_at # Timestamp of when the event occurred in ISO8601 format. # @@ -30,8 +24,10 @@ class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel # @return [Symbol, :"upload.post-transform.success"] required :type, const: :"upload.post-transform.success" - # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.success") - # @param id [String] Unique identifier for the event. + # @!method initialize(created_at:, data:, request:, type: :"upload.post-transform.success") + # 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. # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # @@ -41,7 +37,6 @@ class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel # # @param type [Symbol, :"upload.post-transform.success"] - # @see Imagekit::Models::UploadPostTransformSuccessEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute file_id # Unique identifier of the originally uploaded file. @@ -69,7 +64,6 @@ class Data < Imagekit::Internal::Type::BaseModel # @param url [String] URL of the generated post-transformation. end - # @see Imagekit::Models::UploadPostTransformSuccessEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute transformation # diff --git a/lib/imagekit/models/upload_pre_transform_error_event.rb b/lib/imagekit/models/upload_pre_transform_error_event.rb index 3c9b9453..76eb4981 100644 --- a/lib/imagekit/models/upload_pre_transform_error_event.rb +++ b/lib/imagekit/models/upload_pre_transform_error_event.rb @@ -2,13 +2,7 @@ module Imagekit module Models - class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the event. - # - # @return [String] - required :id, String - + class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent # @!attribute created_at # Timestamp of when the event occurred in ISO8601 format. # @@ -30,8 +24,9 @@ class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel # @return [Symbol, :"upload.pre-transform.error"] required :type, const: :"upload.pre-transform.error" - # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.error") - # @param id [String] Unique identifier for the event. + # @!method initialize(created_at:, data:, request:, type: :"upload.pre-transform.error") + # Triggered when a pre-transformation fails. The file upload may have been + # accepted, but the requested transformation could not be applied. # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # @@ -41,7 +36,6 @@ class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel # # @param type [Symbol, :"upload.pre-transform.error"] - # @see Imagekit::Models::UploadPreTransformErrorEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute name # Name of the file. @@ -91,7 +85,6 @@ class Error < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::UploadPreTransformErrorEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute transformation # The requested pre-transformation string. diff --git a/lib/imagekit/models/upload_pre_transform_success_event.rb b/lib/imagekit/models/upload_pre_transform_success_event.rb index ca0e39c3..4ba20c4e 100644 --- a/lib/imagekit/models/upload_pre_transform_success_event.rb +++ b/lib/imagekit/models/upload_pre_transform_success_event.rb @@ -2,13 +2,7 @@ module Imagekit module Models - class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the event. - # - # @return [String] - required :id, String - + class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent # @!attribute created_at # Timestamp of when the event occurred in ISO8601 format. # @@ -31,8 +25,10 @@ class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel # @return [Symbol, :"upload.pre-transform.success"] required :type, const: :"upload.pre-transform.success" - # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.success") - # @param id [String] Unique identifier for the event. + # @!method initialize(created_at:, data:, request:, type: :"upload.pre-transform.success") + # Triggered when a pre-transformation completes successfully. The file has been + # processed with the requested transformation and is now available in the Media + # Library. # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # @@ -42,7 +38,6 @@ class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel # # @param type [Symbol, :"upload.pre-transform.success"] - # @see Imagekit::Models::UploadPreTransformSuccessEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the uploaded file by auto tagging. @@ -439,7 +434,6 @@ class VersionInfo < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::UploadPreTransformSuccessEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute transformation # The requested pre-transformation string. diff --git a/lib/imagekit/models/video_transformation_accepted_event.rb b/lib/imagekit/models/video_transformation_accepted_event.rb index 3c90be50..1be102a0 100644 --- a/lib/imagekit/models/video_transformation_accepted_event.rb +++ b/lib/imagekit/models/video_transformation_accepted_event.rb @@ -2,13 +2,7 @@ module Imagekit module Models - class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the event. - # - # @return [String] - required :id, String - + class VideoTransformationAcceptedEvent < Imagekit::Models::BaseWebhookEvent # @!attribute created_at # Timestamp when the event was created in ISO8601 format. # @@ -31,8 +25,10 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel # @return [Symbol, :"video.transformation.accepted"] required :type, const: :"video.transformation.accepted" - # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.accepted") - # @param id [String] Unique identifier for the event. + # @!method initialize(created_at:, data:, request:, type: :"video.transformation.accepted") + # 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. # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # @@ -42,7 +38,6 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel # # @param type [Symbol, :"video.transformation.accepted"] - # @see Imagekit::Models::VideoTransformationAcceptedEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # Information about the source video asset being transformed. @@ -251,7 +246,6 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationAcceptedEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # Full URL of the transformation request that was submitted. diff --git a/lib/imagekit/models/video_transformation_error_event.rb b/lib/imagekit/models/video_transformation_error_event.rb index 8b56b9f3..8c357035 100644 --- a/lib/imagekit/models/video_transformation_error_event.rb +++ b/lib/imagekit/models/video_transformation_error_event.rb @@ -2,13 +2,7 @@ module Imagekit module Models - class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the event. - # - # @return [String] - required :id, String - + class VideoTransformationErrorEvent < Imagekit::Models::BaseWebhookEvent # @!attribute created_at # Timestamp when the event was created in ISO8601 format. # @@ -31,8 +25,11 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel # @return [Symbol, :"video.transformation.error"] required :type, const: :"video.transformation.error" - # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.error") - # @param id [String] Unique identifier for the event. + # @!method initialize(created_at:, data:, request:, type: :"video.transformation.error") + # 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. # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # @@ -42,7 +39,6 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel # # @param type [Symbol, :"video.transformation.error"] - # @see Imagekit::Models::VideoTransformationErrorEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # Information about the source video asset being transformed. @@ -297,7 +293,6 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationErrorEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # Full URL of the transformation request that was submitted. diff --git a/lib/imagekit/models/video_transformation_ready_event.rb b/lib/imagekit/models/video_transformation_ready_event.rb index 5ab29898..d4053bf4 100644 --- a/lib/imagekit/models/video_transformation_ready_event.rb +++ b/lib/imagekit/models/video_transformation_ready_event.rb @@ -2,13 +2,7 @@ module Imagekit module Models - class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel - # @!attribute id - # Unique identifier for the event. - # - # @return [String] - required :id, String - + class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent # @!attribute created_at # Timestamp when the event was created in ISO8601 format. # @@ -37,8 +31,11 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel # @return [Imagekit::Models::VideoTransformationReadyEvent::Timings, nil] optional :timings, -> { Imagekit::VideoTransformationReadyEvent::Timings } - # @!method initialize(id:, created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") - # @param id [String] Unique identifier for the event. + # @!method initialize(created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") + # 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. # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # @@ -50,7 +47,6 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel # # @param type [Symbol, :"video.transformation.ready"] - # @see Imagekit::Models::VideoTransformationReadyEvent#data class Data < Imagekit::Internal::Type::BaseModel # @!attribute asset # Information about the source video asset being transformed. @@ -325,7 +321,6 @@ class VideoMetadata < Imagekit::Internal::Type::BaseModel end end - # @see Imagekit::Models::VideoTransformationReadyEvent#request class Request < Imagekit::Internal::Type::BaseModel # @!attribute url # Full URL of the transformation request that was submitted. @@ -355,7 +350,6 @@ class Request < Imagekit::Internal::Type::BaseModel # @param user_agent [String] User-Agent header from the original request that triggered the transformation. end - # @see Imagekit::Models::VideoTransformationReadyEvent#timings class Timings < Imagekit::Internal::Type::BaseModel # @!attribute download_duration # Time spent downloading the source video from your origin or media library, in diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index b16eec98..e14a9662 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -7,6 +7,8 @@ module Imagekit BaseOverlay = Imagekit::Models::BaseOverlay + BaseWebhookEvent = Imagekit::Models::BaseWebhookEvent + Beta = Imagekit::Models::Beta Cache = Imagekit::Models::Cache diff --git a/rbi/imagekit/models/base_webhook_event.rbi b/rbi/imagekit/models/base_webhook_event.rbi new file mode 100644 index 00000000..1420720c --- /dev/null +++ b/rbi/imagekit/models/base_webhook_event.rbi @@ -0,0 +1,33 @@ +# typed: strong + +module Imagekit + module Models + class BaseWebhookEvent < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekit::BaseWebhookEvent, Imagekit::Internal::AnyHash) + end + + # Unique identifier for the event. + sig { returns(String) } + attr_accessor :id + + # The type of webhook event. + sig { returns(String) } + attr_accessor :type + + sig { params(id: String, type: String).returns(T.attached_class) } + def self.new( + # Unique identifier for the event. + id:, + # The type of webhook event. + type: + ) + end + + sig { override.returns({ id: String, type: String }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi index 10ea4aa8..4dbc761c 100644 --- a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi @@ -2,6 +2,9 @@ module Imagekit module Models + # 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. module UnsafeUnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi index 3c4a71a8..b94a7e27 100644 --- a/rbi/imagekit/models/unwrap_webhook_event.rbi +++ b/rbi/imagekit/models/unwrap_webhook_event.rbi @@ -2,6 +2,9 @@ module Imagekit module Models + # 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. module UnwrapWebhookEvent extend Imagekit::Internal::Type::Union diff --git a/rbi/imagekit/models/upload_post_transform_error_event.rbi b/rbi/imagekit/models/upload_post_transform_error_event.rbi index 07bb8841..71aa5b20 100644 --- a/rbi/imagekit/models/upload_post_transform_error_event.rbi +++ b/rbi/imagekit/models/upload_post_transform_error_event.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel + class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( @@ -11,10 +11,6 @@ module Imagekit ) end - # Unique identifier for the event. - sig { returns(String) } - attr_accessor :id - # Timestamp of when the event occurred in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -40,9 +36,10 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # Triggered when a post-transformation fails. The original file remains available, + # but the requested transformation could not be generated. sig do params( - id: String, created_at: Time, data: Imagekit::UploadPostTransformErrorEvent::Data::OrHash, request: Imagekit::UploadPostTransformErrorEvent::Request::OrHash, @@ -50,8 +47,6 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Unique identifier for the event. - id:, # Timestamp of when the event occurred in ISO8601 format. created_at:, data:, @@ -63,7 +58,6 @@ module Imagekit sig do override.returns( { - id: String, created_at: Time, data: Imagekit::UploadPostTransformErrorEvent::Data, request: Imagekit::UploadPostTransformErrorEvent::Request, diff --git a/rbi/imagekit/models/upload_post_transform_success_event.rbi b/rbi/imagekit/models/upload_post_transform_success_event.rbi index 5cee3967..c86f6212 100644 --- a/rbi/imagekit/models/upload_post_transform_success_event.rbi +++ b/rbi/imagekit/models/upload_post_transform_success_event.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel + class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( @@ -11,10 +11,6 @@ module Imagekit ) end - # Unique identifier for the event. - sig { returns(String) } - attr_accessor :id - # Timestamp of when the event occurred in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -42,9 +38,11 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # 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. sig do params( - id: String, created_at: Time, data: Imagekit::UploadPostTransformSuccessEvent::Data::OrHash, request: Imagekit::UploadPostTransformSuccessEvent::Request::OrHash, @@ -52,8 +50,6 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Unique identifier for the event. - id:, # Timestamp of when the event occurred in ISO8601 format. created_at:, data:, @@ -65,7 +61,6 @@ module Imagekit sig do override.returns( { - id: String, created_at: Time, data: Imagekit::UploadPostTransformSuccessEvent::Data, request: Imagekit::UploadPostTransformSuccessEvent::Request, diff --git a/rbi/imagekit/models/upload_pre_transform_error_event.rbi b/rbi/imagekit/models/upload_pre_transform_error_event.rbi index ed5847ac..d95f5534 100644 --- a/rbi/imagekit/models/upload_pre_transform_error_event.rbi +++ b/rbi/imagekit/models/upload_pre_transform_error_event.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel + class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( @@ -11,10 +11,6 @@ module Imagekit ) end - # Unique identifier for the event. - sig { returns(String) } - attr_accessor :id - # Timestamp of when the event occurred in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -40,9 +36,10 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # Triggered when a pre-transformation fails. The file upload may have been + # accepted, but the requested transformation could not be applied. sig do params( - id: String, created_at: Time, data: Imagekit::UploadPreTransformErrorEvent::Data::OrHash, request: Imagekit::UploadPreTransformErrorEvent::Request::OrHash, @@ -50,8 +47,6 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Unique identifier for the event. - id:, # Timestamp of when the event occurred in ISO8601 format. created_at:, data:, @@ -63,7 +58,6 @@ module Imagekit sig do override.returns( { - id: String, created_at: Time, data: Imagekit::UploadPreTransformErrorEvent::Data, request: Imagekit::UploadPreTransformErrorEvent::Request, diff --git a/rbi/imagekit/models/upload_pre_transform_success_event.rbi b/rbi/imagekit/models/upload_pre_transform_success_event.rbi index 33574306..b5d15c02 100644 --- a/rbi/imagekit/models/upload_pre_transform_success_event.rbi +++ b/rbi/imagekit/models/upload_pre_transform_success_event.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel + class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( @@ -11,10 +11,6 @@ module Imagekit ) end - # Unique identifier for the event. - sig { returns(String) } - attr_accessor :id - # Timestamp of when the event occurred in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -43,9 +39,11 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # Triggered when a pre-transformation completes successfully. The file has been + # processed with the requested transformation and is now available in the Media + # Library. sig do params( - id: String, created_at: Time, data: Imagekit::UploadPreTransformSuccessEvent::Data::OrHash, request: Imagekit::UploadPreTransformSuccessEvent::Request::OrHash, @@ -53,8 +51,6 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Unique identifier for the event. - id:, # Timestamp of when the event occurred in ISO8601 format. created_at:, # Object containing details of a successful upload. @@ -67,7 +63,6 @@ module Imagekit sig do override.returns( { - id: String, created_at: Time, data: Imagekit::UploadPreTransformSuccessEvent::Data, request: Imagekit::UploadPreTransformSuccessEvent::Request, diff --git a/rbi/imagekit/models/video_transformation_accepted_event.rbi b/rbi/imagekit/models/video_transformation_accepted_event.rbi index a149c0c1..b6bb2056 100644 --- a/rbi/imagekit/models/video_transformation_accepted_event.rbi +++ b/rbi/imagekit/models/video_transformation_accepted_event.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationAcceptedEvent < Imagekit::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( @@ -11,10 +11,6 @@ module Imagekit ) end - # Unique identifier for the event. - sig { returns(String) } - attr_accessor :id - # Timestamp when the event was created in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -43,9 +39,11 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # 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. sig do params( - id: String, created_at: Time, data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash, request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash, @@ -53,8 +51,6 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Unique identifier for the event. - id:, # Timestamp when the event was created in ISO8601 format. created_at:, data:, @@ -67,7 +63,6 @@ module Imagekit sig do override.returns( { - id: String, created_at: Time, data: Imagekit::VideoTransformationAcceptedEvent::Data, request: Imagekit::VideoTransformationAcceptedEvent::Request, diff --git a/rbi/imagekit/models/video_transformation_error_event.rbi b/rbi/imagekit/models/video_transformation_error_event.rbi index 94beea16..3c9c19d2 100644 --- a/rbi/imagekit/models/video_transformation_error_event.rbi +++ b/rbi/imagekit/models/video_transformation_error_event.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationErrorEvent < Imagekit::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( @@ -11,10 +11,6 @@ module Imagekit ) end - # Unique identifier for the event. - sig { returns(String) } - attr_accessor :id - # Timestamp when the event was created in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -41,9 +37,12 @@ module Imagekit sig { returns(Symbol) } attr_accessor :type + # 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. sig do params( - id: String, created_at: Time, data: Imagekit::VideoTransformationErrorEvent::Data::OrHash, request: Imagekit::VideoTransformationErrorEvent::Request::OrHash, @@ -51,8 +50,6 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Unique identifier for the event. - id:, # Timestamp when the event was created in ISO8601 format. created_at:, data:, @@ -65,7 +62,6 @@ module Imagekit sig do override.returns( { - id: String, created_at: Time, data: Imagekit::VideoTransformationErrorEvent::Data, request: Imagekit::VideoTransformationErrorEvent::Request, diff --git a/rbi/imagekit/models/video_transformation_ready_event.rbi b/rbi/imagekit/models/video_transformation_ready_event.rbi index 1891cda8..75a934d1 100644 --- a/rbi/imagekit/models/video_transformation_ready_event.rbi +++ b/rbi/imagekit/models/video_transformation_ready_event.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel + class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( @@ -11,10 +11,6 @@ module Imagekit ) end - # Unique identifier for the event. - sig { returns(String) } - attr_accessor :id - # Timestamp when the event was created in ISO8601 format. sig { returns(Time) } attr_accessor :created_at @@ -54,9 +50,12 @@ module Imagekit end attr_writer :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. sig do params( - id: String, created_at: Time, data: Imagekit::VideoTransformationReadyEvent::Data::OrHash, request: Imagekit::VideoTransformationReadyEvent::Request::OrHash, @@ -65,8 +64,6 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Unique identifier for the event. - id:, # Timestamp when the event was created in ISO8601 format. created_at:, data:, @@ -81,7 +78,6 @@ module Imagekit sig do override.returns( { - id: String, created_at: Time, data: Imagekit::VideoTransformationReadyEvent::Data, request: Imagekit::VideoTransformationReadyEvent::Request, diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 746736e2..15ef64cd 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -5,6 +5,8 @@ module Imagekit class BaseOverlay = Imagekit::Models::BaseOverlay + class BaseWebhookEvent = Imagekit::Models::BaseWebhookEvent + module Beta = Imagekit::Models::Beta module Cache = Imagekit::Models::Cache diff --git a/sig/imagekit/models/base_webhook_event.rbs b/sig/imagekit/models/base_webhook_event.rbs new file mode 100644 index 00000000..287ff9cc --- /dev/null +++ b/sig/imagekit/models/base_webhook_event.rbs @@ -0,0 +1,15 @@ +module Imagekit + module Models + type base_webhook_event = { id: String, type: String } + + class BaseWebhookEvent < Imagekit::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor type: String + + def initialize: (id: String, type: String) -> void + + def to_hash: -> { id: String, type: String } + end + end +end diff --git a/sig/imagekit/models/upload_post_transform_error_event.rbs b/sig/imagekit/models/upload_post_transform_error_event.rbs index 09c5bd73..7ef7256c 100644 --- a/sig/imagekit/models/upload_post_transform_error_event.rbs +++ b/sig/imagekit/models/upload_post_transform_error_event.rbs @@ -2,26 +2,36 @@ module Imagekit module Models type upload_post_transform_error_event = { - id: String, created_at: Time, data: Imagekit::UploadPostTransformErrorEvent::Data, request: Imagekit::UploadPostTransformErrorEvent::Request, type: :"upload.post-transform.error" } - class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel - attr_accessor id: String + class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent + def created_at: -> Time - attr_accessor created_at: Time + def created_at=: (Time _) -> Time - attr_accessor data: Imagekit::UploadPostTransformErrorEvent::Data + def data: -> Imagekit::UploadPostTransformErrorEvent::Data - attr_accessor request: Imagekit::UploadPostTransformErrorEvent::Request + def data=: ( + Imagekit::UploadPostTransformErrorEvent::Data _ + ) -> Imagekit::UploadPostTransformErrorEvent::Data - attr_accessor type: :"upload.post-transform.error" + def request: -> Imagekit::UploadPostTransformErrorEvent::Request + + def request=: ( + Imagekit::UploadPostTransformErrorEvent::Request _ + ) -> Imagekit::UploadPostTransformErrorEvent::Request + + def `type`: -> :"upload.post-transform.error" + + def type=: ( + :"upload.post-transform.error" _ + ) -> :"upload.post-transform.error" def initialize: ( - id: String, created_at: Time, data: Imagekit::UploadPostTransformErrorEvent::Data, request: Imagekit::UploadPostTransformErrorEvent::Request, @@ -29,7 +39,6 @@ module Imagekit ) -> void def to_hash: -> { - id: String, created_at: Time, data: Imagekit::UploadPostTransformErrorEvent::Data, request: Imagekit::UploadPostTransformErrorEvent::Request, diff --git a/sig/imagekit/models/upload_post_transform_success_event.rbs b/sig/imagekit/models/upload_post_transform_success_event.rbs index 01bf3180..526a877f 100644 --- a/sig/imagekit/models/upload_post_transform_success_event.rbs +++ b/sig/imagekit/models/upload_post_transform_success_event.rbs @@ -2,26 +2,36 @@ module Imagekit module Models type upload_post_transform_success_event = { - id: String, created_at: Time, data: Imagekit::UploadPostTransformSuccessEvent::Data, request: Imagekit::UploadPostTransformSuccessEvent::Request, type: :"upload.post-transform.success" } - class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel - attr_accessor id: String + class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent + def created_at: -> Time - attr_accessor created_at: Time + def created_at=: (Time _) -> Time - attr_accessor data: Imagekit::UploadPostTransformSuccessEvent::Data + def data: -> Imagekit::UploadPostTransformSuccessEvent::Data - attr_accessor request: Imagekit::UploadPostTransformSuccessEvent::Request + def data=: ( + Imagekit::UploadPostTransformSuccessEvent::Data _ + ) -> Imagekit::UploadPostTransformSuccessEvent::Data - attr_accessor type: :"upload.post-transform.success" + def request: -> Imagekit::UploadPostTransformSuccessEvent::Request + + def request=: ( + Imagekit::UploadPostTransformSuccessEvent::Request _ + ) -> Imagekit::UploadPostTransformSuccessEvent::Request + + def `type`: -> :"upload.post-transform.success" + + def type=: ( + :"upload.post-transform.success" _ + ) -> :"upload.post-transform.success" def initialize: ( - id: String, created_at: Time, data: Imagekit::UploadPostTransformSuccessEvent::Data, request: Imagekit::UploadPostTransformSuccessEvent::Request, @@ -29,7 +39,6 @@ module Imagekit ) -> void def to_hash: -> { - id: String, created_at: Time, data: Imagekit::UploadPostTransformSuccessEvent::Data, request: Imagekit::UploadPostTransformSuccessEvent::Request, diff --git a/sig/imagekit/models/upload_pre_transform_error_event.rbs b/sig/imagekit/models/upload_pre_transform_error_event.rbs index 73935081..6af7d3e6 100644 --- a/sig/imagekit/models/upload_pre_transform_error_event.rbs +++ b/sig/imagekit/models/upload_pre_transform_error_event.rbs @@ -2,26 +2,36 @@ module Imagekit module Models type upload_pre_transform_error_event = { - id: String, created_at: Time, data: Imagekit::UploadPreTransformErrorEvent::Data, request: Imagekit::UploadPreTransformErrorEvent::Request, type: :"upload.pre-transform.error" } - class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel - attr_accessor id: String + class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent + def created_at: -> Time - attr_accessor created_at: Time + def created_at=: (Time _) -> Time - attr_accessor data: Imagekit::UploadPreTransformErrorEvent::Data + def data: -> Imagekit::UploadPreTransformErrorEvent::Data - attr_accessor request: Imagekit::UploadPreTransformErrorEvent::Request + def data=: ( + Imagekit::UploadPreTransformErrorEvent::Data _ + ) -> Imagekit::UploadPreTransformErrorEvent::Data - attr_accessor type: :"upload.pre-transform.error" + def request: -> Imagekit::UploadPreTransformErrorEvent::Request + + def request=: ( + Imagekit::UploadPreTransformErrorEvent::Request _ + ) -> Imagekit::UploadPreTransformErrorEvent::Request + + def `type`: -> :"upload.pre-transform.error" + + def type=: ( + :"upload.pre-transform.error" _ + ) -> :"upload.pre-transform.error" def initialize: ( - id: String, created_at: Time, data: Imagekit::UploadPreTransformErrorEvent::Data, request: Imagekit::UploadPreTransformErrorEvent::Request, @@ -29,7 +39,6 @@ module Imagekit ) -> void def to_hash: -> { - id: String, created_at: Time, data: Imagekit::UploadPreTransformErrorEvent::Data, request: Imagekit::UploadPreTransformErrorEvent::Request, diff --git a/sig/imagekit/models/upload_pre_transform_success_event.rbs b/sig/imagekit/models/upload_pre_transform_success_event.rbs index d043704c..1efc8382 100644 --- a/sig/imagekit/models/upload_pre_transform_success_event.rbs +++ b/sig/imagekit/models/upload_pre_transform_success_event.rbs @@ -2,26 +2,36 @@ module Imagekit module Models type upload_pre_transform_success_event = { - id: String, created_at: Time, data: Imagekit::UploadPreTransformSuccessEvent::Data, request: Imagekit::UploadPreTransformSuccessEvent::Request, type: :"upload.pre-transform.success" } - class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel - attr_accessor id: String + class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent + def created_at: -> Time - attr_accessor created_at: Time + def created_at=: (Time _) -> Time - attr_accessor data: Imagekit::UploadPreTransformSuccessEvent::Data + def data: -> Imagekit::UploadPreTransformSuccessEvent::Data - attr_accessor request: Imagekit::UploadPreTransformSuccessEvent::Request + def data=: ( + Imagekit::UploadPreTransformSuccessEvent::Data _ + ) -> Imagekit::UploadPreTransformSuccessEvent::Data - attr_accessor type: :"upload.pre-transform.success" + def request: -> Imagekit::UploadPreTransformSuccessEvent::Request + + def request=: ( + Imagekit::UploadPreTransformSuccessEvent::Request _ + ) -> Imagekit::UploadPreTransformSuccessEvent::Request + + def `type`: -> :"upload.pre-transform.success" + + def type=: ( + :"upload.pre-transform.success" _ + ) -> :"upload.pre-transform.success" def initialize: ( - id: String, created_at: Time, data: Imagekit::UploadPreTransformSuccessEvent::Data, request: Imagekit::UploadPreTransformSuccessEvent::Request, @@ -29,7 +39,6 @@ module Imagekit ) -> void def to_hash: -> { - id: String, created_at: Time, data: Imagekit::UploadPreTransformSuccessEvent::Data, request: Imagekit::UploadPreTransformSuccessEvent::Request, diff --git a/sig/imagekit/models/video_transformation_accepted_event.rbs b/sig/imagekit/models/video_transformation_accepted_event.rbs index 110ece17..f742ea55 100644 --- a/sig/imagekit/models/video_transformation_accepted_event.rbs +++ b/sig/imagekit/models/video_transformation_accepted_event.rbs @@ -2,26 +2,36 @@ module Imagekit module Models type video_transformation_accepted_event = { - id: String, created_at: Time, data: Imagekit::VideoTransformationAcceptedEvent::Data, request: Imagekit::VideoTransformationAcceptedEvent::Request, type: :"video.transformation.accepted" } - class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel - attr_accessor id: String + class VideoTransformationAcceptedEvent < Imagekit::Models::BaseWebhookEvent + def created_at: -> Time - attr_accessor created_at: Time + def created_at=: (Time _) -> Time - attr_accessor data: Imagekit::VideoTransformationAcceptedEvent::Data + def data: -> Imagekit::VideoTransformationAcceptedEvent::Data - attr_accessor request: Imagekit::VideoTransformationAcceptedEvent::Request + def data=: ( + Imagekit::VideoTransformationAcceptedEvent::Data _ + ) -> Imagekit::VideoTransformationAcceptedEvent::Data - attr_accessor type: :"video.transformation.accepted" + def request: -> Imagekit::VideoTransformationAcceptedEvent::Request + + def request=: ( + Imagekit::VideoTransformationAcceptedEvent::Request _ + ) -> Imagekit::VideoTransformationAcceptedEvent::Request + + def `type`: -> :"video.transformation.accepted" + + def type=: ( + :"video.transformation.accepted" _ + ) -> :"video.transformation.accepted" def initialize: ( - id: String, created_at: Time, data: Imagekit::VideoTransformationAcceptedEvent::Data, request: Imagekit::VideoTransformationAcceptedEvent::Request, @@ -29,7 +39,6 @@ module Imagekit ) -> void def to_hash: -> { - id: String, created_at: Time, data: Imagekit::VideoTransformationAcceptedEvent::Data, request: Imagekit::VideoTransformationAcceptedEvent::Request, diff --git a/sig/imagekit/models/video_transformation_error_event.rbs b/sig/imagekit/models/video_transformation_error_event.rbs index 18a7d33c..42a582dd 100644 --- a/sig/imagekit/models/video_transformation_error_event.rbs +++ b/sig/imagekit/models/video_transformation_error_event.rbs @@ -2,26 +2,36 @@ module Imagekit module Models type video_transformation_error_event = { - id: String, created_at: Time, data: Imagekit::VideoTransformationErrorEvent::Data, request: Imagekit::VideoTransformationErrorEvent::Request, type: :"video.transformation.error" } - class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel - attr_accessor id: String + class VideoTransformationErrorEvent < Imagekit::Models::BaseWebhookEvent + def created_at: -> Time - attr_accessor created_at: Time + def created_at=: (Time _) -> Time - attr_accessor data: Imagekit::VideoTransformationErrorEvent::Data + def data: -> Imagekit::VideoTransformationErrorEvent::Data - attr_accessor request: Imagekit::VideoTransformationErrorEvent::Request + def data=: ( + Imagekit::VideoTransformationErrorEvent::Data _ + ) -> Imagekit::VideoTransformationErrorEvent::Data - attr_accessor type: :"video.transformation.error" + def request: -> Imagekit::VideoTransformationErrorEvent::Request + + def request=: ( + Imagekit::VideoTransformationErrorEvent::Request _ + ) -> Imagekit::VideoTransformationErrorEvent::Request + + def `type`: -> :"video.transformation.error" + + def type=: ( + :"video.transformation.error" _ + ) -> :"video.transformation.error" def initialize: ( - id: String, created_at: Time, data: Imagekit::VideoTransformationErrorEvent::Data, request: Imagekit::VideoTransformationErrorEvent::Request, @@ -29,7 +39,6 @@ module Imagekit ) -> void def to_hash: -> { - id: String, created_at: Time, data: Imagekit::VideoTransformationErrorEvent::Data, request: Imagekit::VideoTransformationErrorEvent::Request, diff --git a/sig/imagekit/models/video_transformation_ready_event.rbs b/sig/imagekit/models/video_transformation_ready_event.rbs index 99c49603..0b4478a6 100644 --- a/sig/imagekit/models/video_transformation_ready_event.rbs +++ b/sig/imagekit/models/video_transformation_ready_event.rbs @@ -2,7 +2,6 @@ module Imagekit module Models type video_transformation_ready_event = { - id: String, created_at: Time, data: Imagekit::VideoTransformationReadyEvent::Data, request: Imagekit::VideoTransformationReadyEvent::Request, @@ -10,25 +9,36 @@ module Imagekit timings: Imagekit::VideoTransformationReadyEvent::Timings } - class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel - attr_accessor id: String + class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent + def created_at: -> Time - attr_accessor created_at: Time + def created_at=: (Time _) -> Time - attr_accessor data: Imagekit::VideoTransformationReadyEvent::Data + def data: -> Imagekit::VideoTransformationReadyEvent::Data - attr_accessor request: Imagekit::VideoTransformationReadyEvent::Request + def data=: ( + Imagekit::VideoTransformationReadyEvent::Data _ + ) -> Imagekit::VideoTransformationReadyEvent::Data - attr_accessor type: :"video.transformation.ready" + def request: -> Imagekit::VideoTransformationReadyEvent::Request - attr_reader timings: Imagekit::VideoTransformationReadyEvent::Timings? + def request=: ( + Imagekit::VideoTransformationReadyEvent::Request _ + ) -> Imagekit::VideoTransformationReadyEvent::Request + + def `type`: -> :"video.transformation.ready" + + def type=: ( + :"video.transformation.ready" _ + ) -> :"video.transformation.ready" + + def timings: -> Imagekit::VideoTransformationReadyEvent::Timings? def timings=: ( - Imagekit::VideoTransformationReadyEvent::Timings + Imagekit::VideoTransformationReadyEvent::Timings _ ) -> Imagekit::VideoTransformationReadyEvent::Timings def initialize: ( - id: String, created_at: Time, data: Imagekit::VideoTransformationReadyEvent::Data, request: Imagekit::VideoTransformationReadyEvent::Request, @@ -37,7 +47,6 @@ module Imagekit ) -> void def to_hash: -> { - id: String, created_at: Time, data: Imagekit::VideoTransformationReadyEvent::Data, request: Imagekit::VideoTransformationReadyEvent::Request, From 12a935a0788c47fc7a0b94d2d9d09cfc2238de8c 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:00 +0000 Subject: [PATCH 090/178] 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 85449fa502e4b5e6548c64b92496991ef4bf3b59 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:45 +0000 Subject: [PATCH 091/178] feat(api): manual updates --- .stats.yml | 4 +-- README.md | 37 +++++++--------------- lib/imagekit/models/file_upload_params.rb | 6 ++-- lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models/file_upload_params.rbi | 6 ++-- rbi/imagekit/resources/files.rbi | 2 +- sig/imagekit/models/file_upload_params.rbs | 8 ++--- sig/imagekit/resources/files.rbs | 2 +- test/imagekit/client_test.rb | 30 +++++++++--------- test/imagekit/resources/files_test.rb | 3 +- 10 files changed, 43 insertions(+), 57 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 32341ee0..5d8d2289 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,7 @@ image_kit = Imagekit::Client.new( password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) -response = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +response = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") puts(response.videoCodec) ``` @@ -49,14 +46,14 @@ Request parameters that correspond to file uploads can be passed as raw contents require "pathname" # Use `Pathname` to send the filename and/or avoid paging a large file into memory: -response = image_kit.files.upload(file: Pathname("/path/to/file")) +response = image_kit.beta.v2.files.upload(file: Pathname("/path/to/file")) # Alternatively, pass file contents or a `StringIO` directly: -response = image_kit.files.upload(file: File.read("/path/to/file")) +response = image_kit.beta.v2.files.upload(file: File.read("/path/to/file")) # Or, to control the filename and/or content type: file = Imagekit::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…") -response = image_kit.files.upload(file: file) +response = image_kit.beta.v2.files.upload(file: file) puts(response.videoCodec) ``` @@ -69,10 +66,7 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" - ) + file = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -116,7 +110,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: {max_retries: 5} ) @@ -134,7 +128,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: {timeout: 5} ) @@ -169,7 +163,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: { extra_query: {my_query_parameter: value}, @@ -216,26 +210,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +params = Imagekit::FileUploadParams.new(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") image_kit.files.upload(**params) ``` diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index f1a86697..6f3f74c1 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -18,8 +18,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # When supplying a URL, the server must receive the response headers within 8 # seconds; otherwise the request fails with 400 Bad Request. # - # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] - required :file, Imagekit::Internal::Type::FileInput + # @return [String] + required :file, String # @!attribute file_name # The name with which the file has to be uploaded. The file name can contain: @@ -240,7 +240,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadParams} for more details. # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [String] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index d138d933..a436fcc2 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -221,7 +221,7 @@ def rename(params) # # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [String] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 4d836828..a362f96f 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -20,7 +20,7 @@ module Imagekit # # When supplying a URL, the server must receive the response headers within 8 # seconds; otherwise the request fails with 400 Bad Request. - sig { returns(Imagekit::Internal::FileInput) } + sig { returns(String) } attr_accessor :file # The name with which the file has to be uploaded. The file name can contain: @@ -290,7 +290,7 @@ module Imagekit sig do params( - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, @@ -462,7 +462,7 @@ module Imagekit sig do override.returns( { - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 9d1db383..ad9f0840 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -189,7 +189,7 @@ module Imagekit # technologies. sig do params( - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index 4a2ea622..d8eeef40 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -2,7 +2,7 @@ module Imagekit module Models type file_upload_params = { - file: Imagekit::Internal::file_input, + file: String, file_name: String, token: String, checks: String, @@ -32,7 +32,7 @@ module Imagekit extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor file: Imagekit::Internal::file_input + attr_accessor file: String attr_accessor file_name: String @@ -127,7 +127,7 @@ module Imagekit def webhook_url=: (String) -> String def initialize: ( - file: Imagekit::Internal::file_input, + file: String, file_name: String, ?token: String, ?checks: String, @@ -154,7 +154,7 @@ module Imagekit ) -> void def to_hash: -> { - file: Imagekit::Internal::file_input, + file: String, file_name: String, token: String, checks: String, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 991b1f14..33303e87 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -44,7 +44,7 @@ module Imagekit ) -> Imagekit::Models::FileRenameResponse def upload: ( - file: Imagekit::Internal::file_input, + file: String, file_name: String, ?token: String, ?checks: String, diff --git a/test/imagekit/client_test.rb b/test/imagekit/client_test.rb index 22cda48d..5e42e052 100644 --- a/test/imagekit/client_test.rb +++ b/test/imagekit/client_test.rb @@ -45,7 +45,7 @@ def test_client_default_request_default_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") + image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") end assert_requested(:any, /./, times: 3) @@ -63,7 +63,7 @@ def test_client_given_request_default_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") + image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") end assert_requested(:any, /./, times: 4) @@ -81,7 +81,7 @@ def test_client_default_request_given_retry_attempts assert_raises(Imagekit::Errors::InternalServerError) do image_kit.files.upload( - file: Pathname(__FILE__), + file: "https://www.example.com/path/to-image.jpg", file_name: "fileName", request_options: {max_retries: 3} ) @@ -103,7 +103,7 @@ def test_client_given_request_given_retry_attempts assert_raises(Imagekit::Errors::InternalServerError) do image_kit.files.upload( - file: Pathname(__FILE__), + file: "https://www.example.com/path/to-image.jpg", file_name: "fileName", request_options: {max_retries: 4} ) @@ -128,7 +128,7 @@ def test_client_retry_after_seconds ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") + image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") end assert_requested(:any, /./, times: 2) @@ -152,7 +152,7 @@ def test_client_retry_after_date assert_raises(Imagekit::Errors::InternalServerError) do Thread.current.thread_variable_set(:time_now, Time.now) - image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") + image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") Thread.current.thread_variable_set(:time_now, nil) end @@ -176,7 +176,7 @@ def test_client_retry_after_ms ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") + image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") end assert_requested(:any, /./, times: 2) @@ -194,7 +194,7 @@ def test_retry_count_header ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") + image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") end 3.times do @@ -214,7 +214,7 @@ def test_omit_retry_count_header assert_raises(Imagekit::Errors::InternalServerError) do image_kit.files.upload( - file: Pathname(__FILE__), + file: "https://www.example.com/path/to-image.jpg", file_name: "fileName", request_options: {extra_headers: {"x-stainless-retry-count" => nil}} ) @@ -237,7 +237,7 @@ def test_overwrite_retry_count_header assert_raises(Imagekit::Errors::InternalServerError) do image_kit.files.upload( - file: Pathname(__FILE__), + file: "https://www.example.com/path/to-image.jpg", file_name: "fileName", request_options: {extra_headers: {"x-stainless-retry-count" => "42"}} ) @@ -266,7 +266,7 @@ def test_client_redirect_307 assert_raises(Imagekit::Errors::APIConnectionError) do image_kit.files.upload( - file: Pathname(__FILE__), + file: "https://www.example.com/path/to-image.jpg", file_name: "fileName", request_options: {extra_headers: {}} ) @@ -304,7 +304,7 @@ def test_client_redirect_303 assert_raises(Imagekit::Errors::APIConnectionError) do image_kit.files.upload( - file: Pathname(__FILE__), + file: "https://www.example.com/path/to-image.jpg", file_name: "fileName", request_options: {extra_headers: {}} ) @@ -337,7 +337,7 @@ def test_client_redirect_auth_keep_same_origin assert_raises(Imagekit::Errors::APIConnectionError) do image_kit.files.upload( - file: Pathname(__FILE__), + file: "https://www.example.com/path/to-image.jpg", file_name: "fileName", request_options: {extra_headers: {"authorization" => "Bearer xyz"}} ) @@ -373,7 +373,7 @@ def test_client_redirect_auth_strip_cross_origin assert_raises(Imagekit::Errors::APIConnectionError) do image_kit.files.upload( - file: Pathname(__FILE__), + file: "https://www.example.com/path/to-image.jpg", file_name: "fileName", request_options: {extra_headers: {"authorization" => "Bearer xyz"}} ) @@ -395,7 +395,7 @@ def test_default_headers password: "My Password" ) - image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") + image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") assert_requested(:any, /./) do |req| headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type") diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index c09eb4bb..21c57e3c 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -113,7 +113,8 @@ def test_rename_required_params def test_upload_required_params skip("Prism tests are disabled") - response = @image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") + response = + @image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") assert_pattern do response => Imagekit::Models::FileUploadResponse From aaf75d425333accb860cc1282726cbf6ca01017e 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:34 +0000 Subject: [PATCH 092/178] feat(api): manual updates --- .stats.yml | 4 +-- test/imagekit/client_test.rb | 46 +++++++++------------------ test/imagekit/resources/files_test.rb | 3 +- 3 files changed, 18 insertions(+), 35 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/test/imagekit/client_test.rb b/test/imagekit/client_test.rb index 5e42e052..40f15aa5 100644 --- a/test/imagekit/client_test.rb +++ b/test/imagekit/client_test.rb @@ -45,7 +45,7 @@ def test_client_default_request_default_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") + image_kit.files.upload(file: "file", file_name: "fileName") end assert_requested(:any, /./, times: 3) @@ -63,7 +63,7 @@ def test_client_given_request_default_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") + image_kit.files.upload(file: "file", file_name: "fileName") end assert_requested(:any, /./, times: 4) @@ -80,11 +80,7 @@ def test_client_default_request_given_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload( - file: "https://www.example.com/path/to-image.jpg", - file_name: "fileName", - request_options: {max_retries: 3} - ) + image_kit.files.upload(file: "file", file_name: "fileName", request_options: {max_retries: 3}) end assert_requested(:any, /./, times: 4) @@ -102,11 +98,7 @@ def test_client_given_request_given_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload( - file: "https://www.example.com/path/to-image.jpg", - file_name: "fileName", - request_options: {max_retries: 4} - ) + image_kit.files.upload(file: "file", file_name: "fileName", request_options: {max_retries: 4}) end assert_requested(:any, /./, times: 5) @@ -128,7 +120,7 @@ def test_client_retry_after_seconds ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") + image_kit.files.upload(file: "file", file_name: "fileName") end assert_requested(:any, /./, times: 2) @@ -152,7 +144,7 @@ def test_client_retry_after_date assert_raises(Imagekit::Errors::InternalServerError) do Thread.current.thread_variable_set(:time_now, Time.now) - image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") + image_kit.files.upload(file: "file", file_name: "fileName") Thread.current.thread_variable_set(:time_now, nil) end @@ -176,7 +168,7 @@ def test_client_retry_after_ms ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") + image_kit.files.upload(file: "file", file_name: "fileName") end assert_requested(:any, /./, times: 2) @@ -194,7 +186,7 @@ def test_retry_count_header ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") + image_kit.files.upload(file: "file", file_name: "fileName") end 3.times do @@ -214,7 +206,7 @@ def test_omit_retry_count_header assert_raises(Imagekit::Errors::InternalServerError) do image_kit.files.upload( - file: "https://www.example.com/path/to-image.jpg", + file: "file", file_name: "fileName", request_options: {extra_headers: {"x-stainless-retry-count" => nil}} ) @@ -237,7 +229,7 @@ def test_overwrite_retry_count_header assert_raises(Imagekit::Errors::InternalServerError) do image_kit.files.upload( - file: "https://www.example.com/path/to-image.jpg", + file: "file", file_name: "fileName", request_options: {extra_headers: {"x-stainless-retry-count" => "42"}} ) @@ -265,11 +257,7 @@ def test_client_redirect_307 ) assert_raises(Imagekit::Errors::APIConnectionError) do - image_kit.files.upload( - file: "https://www.example.com/path/to-image.jpg", - file_name: "fileName", - request_options: {extra_headers: {}} - ) + image_kit.files.upload(file: "file", file_name: "fileName", request_options: {extra_headers: {}}) end recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first @@ -303,11 +291,7 @@ def test_client_redirect_303 ) assert_raises(Imagekit::Errors::APIConnectionError) do - image_kit.files.upload( - file: "https://www.example.com/path/to-image.jpg", - file_name: "fileName", - request_options: {extra_headers: {}} - ) + image_kit.files.upload(file: "file", file_name: "fileName", request_options: {extra_headers: {}}) end assert_requested(:get, "http://localhost/redirected", times: Imagekit::Client::MAX_REDIRECTS) do @@ -337,7 +321,7 @@ def test_client_redirect_auth_keep_same_origin assert_raises(Imagekit::Errors::APIConnectionError) do image_kit.files.upload( - file: "https://www.example.com/path/to-image.jpg", + file: "file", file_name: "fileName", request_options: {extra_headers: {"authorization" => "Bearer xyz"}} ) @@ -373,7 +357,7 @@ def test_client_redirect_auth_strip_cross_origin assert_raises(Imagekit::Errors::APIConnectionError) do image_kit.files.upload( - file: "https://www.example.com/path/to-image.jpg", + file: "file", file_name: "fileName", request_options: {extra_headers: {"authorization" => "Bearer xyz"}} ) @@ -395,7 +379,7 @@ def test_default_headers password: "My Password" ) - image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") + image_kit.files.upload(file: "file", file_name: "fileName") assert_requested(:any, /./) do |req| headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type") diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index 21c57e3c..ed2c44a3 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -113,8 +113,7 @@ def test_rename_required_params def test_upload_required_params skip("Prism tests are disabled") - response = - @image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName") + response = @image_kit.files.upload(file: "file", file_name: "fileName") assert_pattern do response => Imagekit::Models::FileUploadResponse From 00a34877a93eeabc52bcb5b1d54680c72cf33c9e 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:49 +0000 Subject: [PATCH 093/178] feat(api): manual updates --- .stats.yml | 4 +- README.md | 37 +++++++++++------ lib/imagekit/models/file_upload_params.rb | 6 +-- lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models/file_upload_params.rbi | 6 +-- rbi/imagekit/resources/files.rbi | 2 +- sig/imagekit/models/file_upload_params.rbs | 8 ++-- sig/imagekit/resources/files.rbs | 2 +- test/imagekit/client_test.rb | 46 +++++++++++++++------- test/imagekit/resources/files_test.rb | 2 +- 10 files changed, 73 insertions(+), 42 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 5d8d2289..32341ee0 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,10 @@ image_kit = Imagekit::Client.new( password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) -response = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +response = image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) puts(response.videoCodec) ``` @@ -46,14 +49,14 @@ Request parameters that correspond to file uploads can be passed as raw contents require "pathname" # Use `Pathname` to send the filename and/or avoid paging a large file into memory: -response = image_kit.beta.v2.files.upload(file: Pathname("/path/to/file")) +response = image_kit.files.upload(file: Pathname("/path/to/file")) # Alternatively, pass file contents or a `StringIO` directly: -response = image_kit.beta.v2.files.upload(file: File.read("/path/to/file")) +response = image_kit.files.upload(file: File.read("/path/to/file")) # Or, to control the filename and/or content type: file = Imagekit::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…") -response = image_kit.beta.v2.files.upload(file: file) +response = image_kit.files.upload(file: file) puts(response.videoCodec) ``` @@ -66,7 +69,10 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") + file = image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" + ) rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -110,7 +116,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: {max_retries: 5} ) @@ -128,7 +134,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: {timeout: 5} ) @@ -163,7 +169,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: { extra_query: {my_query_parameter: value}, @@ -210,17 +216,26 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +params = Imagekit::FileUploadParams.new( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) image_kit.files.upload(**params) ``` diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index 6f3f74c1..f1a86697 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -18,8 +18,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # When supplying a URL, the server must receive the response headers within 8 # seconds; otherwise the request fails with 400 Bad Request. # - # @return [String] - required :file, String + # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] + required :file, Imagekit::Internal::Type::FileInput # @!attribute file_name # The name with which the file has to be uploaded. The file name can contain: @@ -240,7 +240,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadParams} for more details. # - # @param file [String] The API accepts any of the following: + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index a436fcc2..d138d933 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -221,7 +221,7 @@ def rename(params) # # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [String] The API accepts any of the following: + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index a362f96f..4d836828 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -20,7 +20,7 @@ module Imagekit # # When supplying a URL, the server must receive the response headers within 8 # seconds; otherwise the request fails with 400 Bad Request. - sig { returns(String) } + sig { returns(Imagekit::Internal::FileInput) } attr_accessor :file # The name with which the file has to be uploaded. The file name can contain: @@ -290,7 +290,7 @@ module Imagekit sig do params( - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, @@ -462,7 +462,7 @@ module Imagekit sig do override.returns( { - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index ad9f0840..9d1db383 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -189,7 +189,7 @@ module Imagekit # technologies. sig do params( - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index d8eeef40..4a2ea622 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -2,7 +2,7 @@ module Imagekit module Models type file_upload_params = { - file: String, + file: Imagekit::Internal::file_input, file_name: String, token: String, checks: String, @@ -32,7 +32,7 @@ module Imagekit extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor file: String + attr_accessor file: Imagekit::Internal::file_input attr_accessor file_name: String @@ -127,7 +127,7 @@ module Imagekit def webhook_url=: (String) -> String def initialize: ( - file: String, + file: Imagekit::Internal::file_input, file_name: String, ?token: String, ?checks: String, @@ -154,7 +154,7 @@ module Imagekit ) -> void def to_hash: -> { - file: String, + file: Imagekit::Internal::file_input, file_name: String, token: String, checks: String, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 33303e87..991b1f14 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -44,7 +44,7 @@ module Imagekit ) -> Imagekit::Models::FileRenameResponse def upload: ( - file: String, + file: Imagekit::Internal::file_input, file_name: String, ?token: String, ?checks: String, diff --git a/test/imagekit/client_test.rb b/test/imagekit/client_test.rb index 40f15aa5..22cda48d 100644 --- a/test/imagekit/client_test.rb +++ b/test/imagekit/client_test.rb @@ -45,7 +45,7 @@ def test_client_default_request_default_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "file", file_name: "fileName") + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end assert_requested(:any, /./, times: 3) @@ -63,7 +63,7 @@ def test_client_given_request_default_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "file", file_name: "fileName") + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end assert_requested(:any, /./, times: 4) @@ -80,7 +80,11 @@ def test_client_default_request_given_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "file", file_name: "fileName", request_options: {max_retries: 3}) + image_kit.files.upload( + file: Pathname(__FILE__), + file_name: "fileName", + request_options: {max_retries: 3} + ) end assert_requested(:any, /./, times: 4) @@ -98,7 +102,11 @@ def test_client_given_request_given_retry_attempts ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "file", file_name: "fileName", request_options: {max_retries: 4}) + image_kit.files.upload( + file: Pathname(__FILE__), + file_name: "fileName", + request_options: {max_retries: 4} + ) end assert_requested(:any, /./, times: 5) @@ -120,7 +128,7 @@ def test_client_retry_after_seconds ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "file", file_name: "fileName") + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end assert_requested(:any, /./, times: 2) @@ -144,7 +152,7 @@ def test_client_retry_after_date assert_raises(Imagekit::Errors::InternalServerError) do Thread.current.thread_variable_set(:time_now, Time.now) - image_kit.files.upload(file: "file", file_name: "fileName") + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") Thread.current.thread_variable_set(:time_now, nil) end @@ -168,7 +176,7 @@ def test_client_retry_after_ms ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "file", file_name: "fileName") + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end assert_requested(:any, /./, times: 2) @@ -186,7 +194,7 @@ def test_retry_count_header ) assert_raises(Imagekit::Errors::InternalServerError) do - image_kit.files.upload(file: "file", file_name: "fileName") + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end 3.times do @@ -206,7 +214,7 @@ def test_omit_retry_count_header assert_raises(Imagekit::Errors::InternalServerError) do image_kit.files.upload( - file: "file", + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {"x-stainless-retry-count" => nil}} ) @@ -229,7 +237,7 @@ def test_overwrite_retry_count_header assert_raises(Imagekit::Errors::InternalServerError) do image_kit.files.upload( - file: "file", + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {"x-stainless-retry-count" => "42"}} ) @@ -257,7 +265,11 @@ def test_client_redirect_307 ) assert_raises(Imagekit::Errors::APIConnectionError) do - image_kit.files.upload(file: "file", file_name: "fileName", request_options: {extra_headers: {}}) + image_kit.files.upload( + file: Pathname(__FILE__), + file_name: "fileName", + request_options: {extra_headers: {}} + ) end recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first @@ -291,7 +303,11 @@ def test_client_redirect_303 ) assert_raises(Imagekit::Errors::APIConnectionError) do - image_kit.files.upload(file: "file", file_name: "fileName", request_options: {extra_headers: {}}) + image_kit.files.upload( + file: Pathname(__FILE__), + file_name: "fileName", + request_options: {extra_headers: {}} + ) end assert_requested(:get, "http://localhost/redirected", times: Imagekit::Client::MAX_REDIRECTS) do @@ -321,7 +337,7 @@ def test_client_redirect_auth_keep_same_origin assert_raises(Imagekit::Errors::APIConnectionError) do image_kit.files.upload( - file: "file", + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {"authorization" => "Bearer xyz"}} ) @@ -357,7 +373,7 @@ def test_client_redirect_auth_strip_cross_origin assert_raises(Imagekit::Errors::APIConnectionError) do image_kit.files.upload( - file: "file", + file: Pathname(__FILE__), file_name: "fileName", request_options: {extra_headers: {"authorization" => "Bearer xyz"}} ) @@ -379,7 +395,7 @@ def test_default_headers password: "My Password" ) - image_kit.files.upload(file: "file", file_name: "fileName") + image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") assert_requested(:any, /./) do |req| headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type") diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index ed2c44a3..c09eb4bb 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -113,7 +113,7 @@ def test_rename_required_params def test_upload_required_params skip("Prism tests are disabled") - response = @image_kit.files.upload(file: "file", file_name: "fileName") + response = @image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") assert_pattern do response => Imagekit::Models::FileUploadResponse From f2b075bd31461d1bf088e65bcc74711327af2469 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:32:51 +0000 Subject: [PATCH 094/178] 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 5636ea745c5237560e2dd8e0e6109fbdc06e246a 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:29 +0000 Subject: [PATCH 095/178] feat(api): manual updates --- .stats.yml | 4 +-- README.md | 31 ++++++---------------- lib/imagekit/models/file_upload_params.rb | 18 +++++-------- lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models/file_upload_params.rbi | 30 +++++++-------------- rbi/imagekit/resources/files.rbi | 14 +++------- sig/imagekit/models/file_upload_params.rbs | 8 +++--- sig/imagekit/resources/files.rbs | 2 +- 8 files changed, 35 insertions(+), 74 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 32341ee0..92b56406 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,7 @@ image_kit = Imagekit::Client.new( password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) -response = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +response = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") puts(response.videoCodec) ``` @@ -69,10 +66,7 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" - ) + file = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -116,7 +110,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: {max_retries: 5} ) @@ -134,7 +128,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: {timeout: 5} ) @@ -169,7 +163,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: { extra_query: {my_query_parameter: value}, @@ -216,26 +210,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +params = Imagekit::FileUploadParams.new(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") image_kit.files.upload(**params) ``` diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index f1a86697..df0d2ab8 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -8,18 +8,12 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel include Imagekit::Internal::Type::RequestParameters # @!attribute file - # The API accepts any of the following: + # 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. # - # - **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. - # - # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] - required :file, Imagekit::Internal::Type::FileInput + # @return [String] + required :file, String # @!attribute file_name # The name with which the file has to be uploaded. The file name can contain: @@ -240,7 +234,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadParams} for more details. # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [String] A publicly reachable URL that ImageKit’s servers can fetch. The server must rece # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index d138d933..0cc9db23 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -221,7 +221,7 @@ def rename(params) # # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [String] A publicly reachable URL that ImageKit’s servers can fetch. The server must rece # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 4d836828..2e7239f7 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -11,16 +11,10 @@ module Imagekit T.any(Imagekit::FileUploadParams, Imagekit::Internal::AnyHash) end - # 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. - sig { returns(Imagekit::Internal::FileInput) } + # 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. + sig { returns(String) } attr_accessor :file # The name with which the file has to be uploaded. The file name can contain: @@ -290,7 +284,7 @@ module Imagekit sig do params( - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, @@ -325,15 +319,9 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # @@ -462,7 +450,7 @@ module Imagekit sig do override.returns( { - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 9d1db383..546a6831 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -189,7 +189,7 @@ module Imagekit # technologies. sig do params( - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, @@ -224,15 +224,9 @@ module Imagekit ).returns(Imagekit::Models::FileUploadResponse) end def upload( - # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index 4a2ea622..d8eeef40 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -2,7 +2,7 @@ module Imagekit module Models type file_upload_params = { - file: Imagekit::Internal::file_input, + file: String, file_name: String, token: String, checks: String, @@ -32,7 +32,7 @@ module Imagekit extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor file: Imagekit::Internal::file_input + attr_accessor file: String attr_accessor file_name: String @@ -127,7 +127,7 @@ module Imagekit def webhook_url=: (String) -> String def initialize: ( - file: Imagekit::Internal::file_input, + file: String, file_name: String, ?token: String, ?checks: String, @@ -154,7 +154,7 @@ module Imagekit ) -> void def to_hash: -> { - file: Imagekit::Internal::file_input, + file: String, file_name: String, token: String, checks: String, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 991b1f14..33303e87 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -44,7 +44,7 @@ module Imagekit ) -> Imagekit::Models::FileRenameResponse def upload: ( - file: Imagekit::Internal::file_input, + file: String, file_name: String, ?token: String, ?checks: String, From 97271a6ef160fa5a7abd17141f4c3891d24d7fa5 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:10:57 +0000 Subject: [PATCH 096/178] feat(api): manual updates --- .stats.yml | 4 +-- README.md | 31 ++++++++++++++++------ lib/imagekit/models/file_upload_params.rb | 18 ++++++++----- lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models/file_upload_params.rbi | 30 ++++++++++++++------- rbi/imagekit/resources/files.rbi | 14 +++++++--- sig/imagekit/models/file_upload_params.rbs | 8 +++--- sig/imagekit/resources/files.rbs | 2 +- 8 files changed, 74 insertions(+), 35 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 92b56406..32341ee0 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,10 @@ image_kit = Imagekit::Client.new( password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) -response = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +response = image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) puts(response.videoCodec) ``` @@ -66,7 +69,10 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") + file = image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" + ) rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -110,7 +116,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: {max_retries: 5} ) @@ -128,7 +134,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: {timeout: 5} ) @@ -163,7 +169,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: { extra_query: {my_query_parameter: value}, @@ -210,17 +216,26 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +params = Imagekit::FileUploadParams.new( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) image_kit.files.upload(**params) ``` diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index df0d2ab8..f1a86697 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -8,12 +8,18 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel include Imagekit::Internal::Type::RequestParameters # @!attribute 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. + # The API accepts any of the following: # - # @return [String] - required :file, String + # - **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. + # + # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] + required :file, Imagekit::Internal::Type::FileInput # @!attribute file_name # The name with which the file has to be uploaded. The file name can contain: @@ -234,7 +240,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadParams} for more details. # - # @param file [String] A publicly reachable URL that ImageKit’s servers can fetch. The server must rece + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 0cc9db23..d138d933 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -221,7 +221,7 @@ def rename(params) # # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [String] A publicly reachable URL that ImageKit’s servers can fetch. The server must rece + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 2e7239f7..4d836828 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -11,10 +11,16 @@ module Imagekit T.any(Imagekit::FileUploadParams, Imagekit::Internal::AnyHash) end - # 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. - sig { returns(String) } + # 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. + sig { returns(Imagekit::Internal::FileInput) } attr_accessor :file # The name with which the file has to be uploaded. The file name can contain: @@ -284,7 +290,7 @@ module Imagekit sig do params( - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, @@ -319,9 +325,15 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # @@ -450,7 +462,7 @@ module Imagekit sig do override.returns( { - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 546a6831..9d1db383 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -189,7 +189,7 @@ module Imagekit # technologies. sig do params( - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, @@ -224,9 +224,15 @@ module Imagekit ).returns(Imagekit::Models::FileUploadResponse) end def upload( - # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index d8eeef40..4a2ea622 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -2,7 +2,7 @@ module Imagekit module Models type file_upload_params = { - file: String, + file: Imagekit::Internal::file_input, file_name: String, token: String, checks: String, @@ -32,7 +32,7 @@ module Imagekit extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor file: String + attr_accessor file: Imagekit::Internal::file_input attr_accessor file_name: String @@ -127,7 +127,7 @@ module Imagekit def webhook_url=: (String) -> String def initialize: ( - file: String, + file: Imagekit::Internal::file_input, file_name: String, ?token: String, ?checks: String, @@ -154,7 +154,7 @@ module Imagekit ) -> void def to_hash: -> { - file: String, + file: Imagekit::Internal::file_input, file_name: String, token: String, checks: String, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 33303e87..991b1f14 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -44,7 +44,7 @@ module Imagekit ) -> Imagekit::Models::FileRenameResponse def upload: ( - file: String, + file: Imagekit::Internal::file_input, file_name: String, ?token: String, ?checks: String, From 3567e4d0a0773db00bc5519f5ffef45605434f6a 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:08 +0000 Subject: [PATCH 097/178] feat(api): manual updates --- .stats.yml | 4 +-- README.md | 31 ++++++---------------- lib/imagekit/models/file_upload_params.rb | 18 +++++-------- lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models/file_upload_params.rbi | 30 +++++++-------------- rbi/imagekit/resources/files.rbi | 14 +++------- sig/imagekit/models/file_upload_params.rbs | 8 +++--- sig/imagekit/resources/files.rbs | 2 +- 8 files changed, 35 insertions(+), 74 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 32341ee0..92b56406 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,7 @@ image_kit = Imagekit::Client.new( password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) -response = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +response = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") puts(response.videoCodec) ``` @@ -69,10 +66,7 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" - ) + file = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -116,7 +110,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: {max_retries: 5} ) @@ -134,7 +128,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: {timeout: 5} ) @@ -169,7 +163,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), + file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg", request_options: { extra_query: {my_query_parameter: value}, @@ -216,26 +210,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new( - file: StringIO.new("https://www.example.com/public-url.jpg"), - file_name: "file-name.jpg" -) +params = Imagekit::FileUploadParams.new(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") image_kit.files.upload(**params) ``` diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index f1a86697..49c6efff 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -8,18 +8,12 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel include Imagekit::Internal::Type::RequestParameters # @!attribute file - # The API accepts any of the following: + # 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. # - # - **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. - # - # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] - required :file, Imagekit::Internal::Type::FileInput + # @return [String] + required :file, String # @!attribute file_name # The name with which the file has to be uploaded. The file name can contain: @@ -240,7 +234,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadParams} for more details. # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [String] The URL of the file to upload. A publicly reachable URL that ImageKit servers ca # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index d138d933..8f57dd29 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -221,7 +221,7 @@ def rename(params) # # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [String] The URL of the file to upload. A publicly reachable URL that ImageKit servers ca # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 4d836828..bb4da1be 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -11,16 +11,10 @@ module Imagekit T.any(Imagekit::FileUploadParams, Imagekit::Internal::AnyHash) end - # 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. - sig { returns(Imagekit::Internal::FileInput) } + # 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. + sig { returns(String) } attr_accessor :file # The name with which the file has to be uploaded. The file name can contain: @@ -290,7 +284,7 @@ module Imagekit sig do params( - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, @@ -325,15 +319,9 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # @@ -462,7 +450,7 @@ module Imagekit sig do override.returns( { - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 9d1db383..81eca148 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -189,7 +189,7 @@ module Imagekit # technologies. sig do params( - file: Imagekit::Internal::FileInput, + file: String, file_name: String, token: String, checks: String, @@ -224,15 +224,9 @@ module Imagekit ).returns(Imagekit::Models::FileUploadResponse) end def upload( - # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index 4a2ea622..d8eeef40 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -2,7 +2,7 @@ module Imagekit module Models type file_upload_params = { - file: Imagekit::Internal::file_input, + file: String, file_name: String, token: String, checks: String, @@ -32,7 +32,7 @@ module Imagekit extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor file: Imagekit::Internal::file_input + attr_accessor file: String attr_accessor file_name: String @@ -127,7 +127,7 @@ module Imagekit def webhook_url=: (String) -> String def initialize: ( - file: Imagekit::Internal::file_input, + file: String, file_name: String, ?token: String, ?checks: String, @@ -154,7 +154,7 @@ module Imagekit ) -> void def to_hash: -> { - file: Imagekit::Internal::file_input, + file: String, file_name: String, token: String, checks: String, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 991b1f14..33303e87 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -44,7 +44,7 @@ module Imagekit ) -> Imagekit::Models::FileRenameResponse def upload: ( - file: Imagekit::Internal::file_input, + file: String, file_name: String, ?token: String, ?checks: String, From 8e515de3e7957d1f4596c2f23f0f39b187b8e902 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:30 +0000 Subject: [PATCH 098/178] 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 148e48b6adeb5eaddb84557e034b12e6a912b18c 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:50 +0000 Subject: [PATCH 099/178] feat(api): manual updates --- .stats.yml | 4 +-- README.md | 31 ++++++++++++++++------ lib/imagekit/models/file_upload_params.rb | 18 ++++++++----- lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models/file_upload_params.rbi | 30 ++++++++++++++------- rbi/imagekit/resources/files.rbi | 14 +++++++--- sig/imagekit/models/file_upload_params.rbs | 8 +++--- sig/imagekit/resources/files.rbs | 2 +- 8 files changed, 74 insertions(+), 35 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 92b56406..32341ee0 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,10 @@ image_kit = Imagekit::Client.new( password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) -response = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +response = image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) puts(response.videoCodec) ``` @@ -66,7 +69,10 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin - file = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") + file = image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" + ) rescue Imagekit::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` @@ -110,7 +116,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: {max_retries: 5} ) @@ -128,7 +134,7 @@ image_kit = Imagekit::Client.new( # Or, configure per-request: image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: {timeout: 5} ) @@ -163,7 +169,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete ```ruby response = image_kit.files.upload( - file: "https://www.example.com/public-url.jpg", + file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg", request_options: { extra_query: {my_query_parameter: value}, @@ -210,17 +216,26 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio You can provide typesafe request parameters like so: ```ruby -image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) ``` Or, equivalently: ```ruby # Hashes work, but are not typesafe: -image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +image_kit.files.upload( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg") +params = Imagekit::FileUploadParams.new( + file: StringIO.new("https://www.example.com/public-url.jpg"), + file_name: "file-name.jpg" +) image_kit.files.upload(**params) ``` diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index 49c6efff..f1a86697 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -8,12 +8,18 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel include Imagekit::Internal::Type::RequestParameters # @!attribute 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. + # The API accepts any of the following: # - # @return [String] - required :file, String + # - **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. + # + # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] + required :file, Imagekit::Internal::Type::FileInput # @!attribute file_name # The name with which the file has to be uploaded. The file name can contain: @@ -234,7 +240,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadParams} for more details. # - # @param file [String] The URL of the file to upload. A publicly reachable URL that ImageKit servers ca + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 8f57dd29..d138d933 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -221,7 +221,7 @@ def rename(params) # # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [String] The URL of the file to upload. A publicly reachable URL that ImageKit servers ca + # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index bb4da1be..4d836828 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -11,10 +11,16 @@ module Imagekit T.any(Imagekit::FileUploadParams, Imagekit::Internal::AnyHash) end - # 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. - sig { returns(String) } + # 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. + sig { returns(Imagekit::Internal::FileInput) } attr_accessor :file # The name with which the file has to be uploaded. The file name can contain: @@ -284,7 +290,7 @@ module Imagekit sig do params( - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, @@ -319,9 +325,15 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # @@ -450,7 +462,7 @@ module Imagekit sig do override.returns( { - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 81eca148..9d1db383 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -189,7 +189,7 @@ module Imagekit # technologies. sig do params( - file: String, + file: Imagekit::Internal::FileInput, file_name: String, token: String, checks: String, @@ -224,9 +224,15 @@ module Imagekit ).returns(Imagekit::Models::FileUploadResponse) end def upload( - # 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. file:, # The name with which the file has to be uploaded. The file name can contain: # diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index d8eeef40..4a2ea622 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -2,7 +2,7 @@ module Imagekit module Models type file_upload_params = { - file: String, + file: Imagekit::Internal::file_input, file_name: String, token: String, checks: String, @@ -32,7 +32,7 @@ module Imagekit extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor file: String + attr_accessor file: Imagekit::Internal::file_input attr_accessor file_name: String @@ -127,7 +127,7 @@ module Imagekit def webhook_url=: (String) -> String def initialize: ( - file: String, + file: Imagekit::Internal::file_input, file_name: String, ?token: String, ?checks: String, @@ -154,7 +154,7 @@ module Imagekit ) -> void def to_hash: -> { - file: String, + file: Imagekit::Internal::file_input, file_name: String, token: String, checks: String, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 33303e87..991b1f14 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -44,7 +44,7 @@ module Imagekit ) -> Imagekit::Models::FileRenameResponse def upload: ( - file: String, + file: Imagekit::Internal::file_input, file_name: String, ?token: String, ?checks: String, From 6045a8c1299c09ab7ef995dbae39ce3e915db5c1 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:10 +0000 Subject: [PATCH 100/178] feat(api): manual updates --- .stats.yml | 4 ++-- lib/imagekit/models/beta/v2/file_upload_params.rb | 4 ++-- lib/imagekit/models/file_upload_params.rb | 4 ++-- lib/imagekit/resources/beta/v2/files.rb | 2 +- lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models/beta/v2/file_upload_params.rbi | 4 ++-- rbi/imagekit/models/file_upload_params.rbi | 4 ++-- rbi/imagekit/resources/beta/v2/files.rbi | 2 +- rbi/imagekit/resources/files.rbi | 2 +- 9 files changed, 14 insertions(+), 14 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/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index 044d0f30..18faeb10 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -84,7 +84,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel optional :description, String # @!attribute extensions - # Array of extensions to be applied to the image. Each extension can be configured + # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # # @return [Array, nil] @@ -225,7 +225,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index f1a86697..5871d7d8 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -91,7 +91,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel optional :expire, Integer # @!attribute extensions - # Array of extensions to be applied to the image. Each extension can be configured + # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # # @return [Array, nil] @@ -256,7 +256,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekit/resources/beta/v2/files.rb index c50545df..628747bc 100644 --- a/lib/imagekit/resources/beta/v2/files.rb +++ b/lib/imagekit/resources/beta/v2/files.rb @@ -52,7 +52,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index d138d933..a125df81 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -237,7 +237,7 @@ def rename(params) # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the image. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi index d33124a6..66e8162b 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -89,7 +89,7 @@ module Imagekit sig { params(description: String).void } attr_writer :description - # Array of extensions to be applied to the image. Each extension can be configured + # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. sig do returns( @@ -347,7 +347,7 @@ module Imagekit custom_metadata: nil, # Optional text to describe the contents of the file. description: nil, - # Array of extensions to be applied to the image. Each extension can be configured + # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. extensions: nil, # The folder path in which the image has to be uploaded. If the folder(s) didn't diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 4d836828..14b9033d 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -94,7 +94,7 @@ module Imagekit sig { params(expire: Integer).void } attr_writer :expire - # Array of extensions to be applied to the image. Each extension can be configured + # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. sig do returns( @@ -374,7 +374,7 @@ module Imagekit # the future. It should be in seconds. This field is only required for # authentication when uploading a file from the client side. expire: nil, - # Array of extensions to be applied to the image. Each extension can be configured + # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. extensions: nil, # The folder path in which the image has to be uploaded. If the folder(s) didn't diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekit/resources/beta/v2/files.rbi index 9c757f11..7dca87db 100644 --- a/rbi/imagekit/resources/beta/v2/files.rbi +++ b/rbi/imagekit/resources/beta/v2/files.rbi @@ -113,7 +113,7 @@ module Imagekit custom_metadata: nil, # Optional text to describe the contents of the file. description: nil, - # Array of extensions to be applied to the image. Each extension can be configured + # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. extensions: nil, # The folder path in which the image has to be uploaded. If the folder(s) didn't diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 9d1db383..3ca11dc7 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -273,7 +273,7 @@ module Imagekit # the future. It should be in seconds. This field is only required for # authentication when uploading a file from the client side. expire: nil, - # Array of extensions to be applied to the image. Each extension can be configured + # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. extensions: nil, # The folder path in which the image has to be uploaded. If the folder(s) didn't From 74ff6d6f91c27f78c81a9b4f436cae008e265099 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:12 +0000 Subject: [PATCH 101/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit.rb | 1 + lib/imagekit/models.rb | 5 + .../models/beta/v2/file_upload_params.rb | 136 +------- lib/imagekit/models/extensions.rb | 136 ++++++++ lib/imagekit/models/file_update_params.rb | 139 +------- lib/imagekit/models/file_upload_params.rb | 136 +------- lib/imagekit/resources/beta/v2/files.rb | 2 +- lib/imagekit/resources/files.rb | 2 +- rbi/imagekit/models.rbi | 5 + .../models/beta/v2/file_upload_params.rbi | 302 +----------------- rbi/imagekit/models/extensions.rbi | 268 ++++++++++++++++ rbi/imagekit/models/file_update_params.rbi | 302 +----------------- rbi/imagekit/models/file_upload_params.rbi | 300 +---------------- rbi/imagekit/resources/beta/v2/files.rbi | 6 +- rbi/imagekit/resources/files.rbi | 6 +- sig/imagekit/models.rbs | 4 + .../models/beta/v2/file_upload_params.rbs | 137 +------- sig/imagekit/models/extensions.rbs | 132 ++++++++ sig/imagekit/models/file_update_params.rbs | 137 +------- sig/imagekit/models/file_upload_params.rbs | 137 +------- sig/imagekit/resources/beta/v2/files.rbs | 2 +- sig/imagekit/resources/files.rbs | 2 +- 23 files changed, 625 insertions(+), 1674 deletions(-) create mode 100644 lib/imagekit/models/extensions.rb create mode 100644 rbi/imagekit/models/extensions.rbi create mode 100644 sig/imagekit/models/extensions.rbs 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/lib/imagekit.rb b/lib/imagekit.rb index 657d3c0d..c831bf55 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -86,6 +86,7 @@ require_relative "imagekit/models/custom_metadata_field_list_params" require_relative "imagekit/models/custom_metadata_field_list_response" require_relative "imagekit/models/custom_metadata_field_update_params" +require_relative "imagekit/models/extensions" require_relative "imagekit/models/file_copy_params" require_relative "imagekit/models/file_copy_response" require_relative "imagekit/models/file_delete_params" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 5c3ae2fe..1792d026 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -61,6 +61,11 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + ExtensionItem = Imagekit::Models::ExtensionItem + + # @type [Imagekit::Internal::Type::Converter] + Extensions = Imagekit::Models::Extensions + File = Imagekit::Models::File FileCopyParams = Imagekit::Models::FileCopyParams diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index 18faeb10..2b4cc97d 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -87,9 +87,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] - optional :extensions, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Extension] } + # @return [Array, nil] + optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } # @!attribute folder # The folder path in which the image has to be uploaded. If the folder(s) didn't @@ -225,7 +224,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -253,135 +252,6 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - module Extension - extend Imagekit::Internal::Type::Union - - discriminator :name - - variant :"remove-bg", -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg } - - variant :"ai-auto-description", -> { Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription } - - variant -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension } - - class RemoveBg < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, :"remove-bg"] - required :name, const: :"remove-bg" - - # @!attribute options - # - # @return [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg::Options, nil] - optional :options, -> { Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options } - - # @!method initialize(options: nil, name: :"remove-bg") - # @param options [Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg::Options] - # - # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. - - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg::Options} for - # more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name] - required :name, enum: -> { Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. - # - # @return [Symbol, :"ai-auto-description"] - required :name, const: :"ai-auto-description" - - # @!method initialize(name: :"ai-auto-description") - # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. - end - - # @!method self.variants - # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Extension::RemoveBg, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AIAutoDescription, Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension)] - end - module ResponseField extend Imagekit::Internal::Type::Enum diff --git a/lib/imagekit/models/extensions.rb b/lib/imagekit/models/extensions.rb new file mode 100644 index 00000000..d0b187c3 --- /dev/null +++ b/lib/imagekit/models/extensions.rb @@ -0,0 +1,136 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module ExtensionItem + extend Imagekit::Internal::Type::Union + + discriminator :name + + variant :"remove-bg", -> { Imagekit::ExtensionItem::RemoveBg } + + variant :"ai-auto-description", -> { Imagekit::ExtensionItem::AIAutoDescription } + + variant -> { Imagekit::ExtensionItem::AutoTaggingExtension } + + class RemoveBg < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, :"remove-bg"] + required :name, const: :"remove-bg" + + # @!attribute options + # + # @return [Imagekit::Models::ExtensionItem::RemoveBg::Options, nil] + optional :options, -> { Imagekit::ExtensionItem::RemoveBg::Options } + + # @!method initialize(options: nil, name: :"remove-bg") + # @param options [Imagekit::Models::ExtensionItem::RemoveBg::Options] + # + # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. + + # @see Imagekit::Models::ExtensionItem::RemoveBg#options + class Options < Imagekit::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekit::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekit::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::ExtensionItem::RemoveBg::Options} for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekit::Models::ExtensionItem::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekit::ExtensionItem::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekit::Models::ExtensionItem::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekit::Models::ExtensionItem::AutoTaggingExtension#name + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, :"ai-auto-description"] + required :name, const: :"ai-auto-description" + + # @!method initialize(name: :"ai-auto-description") + # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. + end + + # @!method self.variants + # @return [Array(Imagekit::Models::ExtensionItem::RemoveBg, Imagekit::Models::ExtensionItem::AIAutoDescription, Imagekit::Models::ExtensionItem::AutoTaggingExtension)] + end + + # @type [Imagekit::Internal::Type::Converter] + Extensions = Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::ExtensionItem }] + end +end diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index 7efbdd37..46e3ec4f 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -51,9 +51,8 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] - optional :extensions, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension] } + # @return [Array, nil] + optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } # @!attribute remove_ai_tags # An array of AITags associated with the file that you want to remove, e.g. @@ -97,7 +96,7 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car # @@ -105,138 +104,6 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - module Extension - extend Imagekit::Internal::Type::Union - - discriminator :name - - variant :"remove-bg", -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg } - - variant :"ai-auto-description", - -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription } - - variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension } - - class RemoveBg < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, :"remove-bg"] - required :name, const: :"remove-bg" - - # @!attribute options - # - # @return [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options, nil] - optional :options, - -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options } - - # @!method initialize(options: nil, name: :"remove-bg") - # @param options [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options] - # - # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. - - # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options} - # for more details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name] - required :name, - enum: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. - # - # @return [Symbol, :"ai-auto-description"] - required :name, const: :"ai-auto-description" - - # @!method initialize(name: :"ai-auto-description") - # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. - end - - # @!method self.variants - # @return [Array(Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension)] - end - # An array of AITags associated with the file that you want to remove, e.g. # `["car", "vehicle", "motorsports"]`. # diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index 5871d7d8..282c8f74 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -94,9 +94,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] - optional :extensions, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Extension] } + # @return [Array, nil] + optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } # @!attribute folder # The folder path in which the image has to be uploaded. If the folder(s) didn't @@ -256,7 +255,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -288,135 +287,6 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - module Extension - extend Imagekit::Internal::Type::Union - - discriminator :name - - variant :"remove-bg", -> { Imagekit::FileUploadParams::Extension::RemoveBg } - - variant :"ai-auto-description", -> { Imagekit::FileUploadParams::Extension::AIAutoDescription } - - variant -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension } - - class RemoveBg < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the background removal extension. - # - # @return [Symbol, :"remove-bg"] - required :name, const: :"remove-bg" - - # @!attribute options - # - # @return [Imagekit::Models::FileUploadParams::Extension::RemoveBg::Options, nil] - optional :options, -> { Imagekit::FileUploadParams::Extension::RemoveBg::Options } - - # @!method initialize(options: nil, name: :"remove-bg") - # @param options [Imagekit::Models::FileUploadParams::Extension::RemoveBg::Options] - # - # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. - - # @see Imagekit::Models::FileUploadParams::Extension::RemoveBg#options - class Options < Imagekit::Internal::Type::BaseModel - # @!attribute add_shadow - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - # - # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean - - # @!attribute bg_color - # 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. - # - # @return [String, nil] - optional :bg_color, String - - # @!attribute bg_image_url - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - # - # @return [String, nil] - optional :bg_image_url, String - - # @!attribute semitransparency - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - # - # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean - - # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Extension::RemoveBg::Options} for more - # details. - # - # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin - # - # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col - # - # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be - # - # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - # @!attribute max_tags - # Maximum number of tags to attach to the asset. - # - # @return [Integer] - required :max_tags, Integer, api_name: :maxTags - - # @!attribute min_confidence - # Minimum confidence level for tags to be considered valid. - # - # @return [Integer] - required :min_confidence, Integer, api_name: :minConfidence - - # @!attribute name - # Specifies the auto-tagging extension used. - # - # @return [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::Name] - required :name, enum: -> { Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name } - - # @!method initialize(max_tags:, min_confidence:, name:) - # @param max_tags [Integer] Maximum number of tags to attach to the asset. - # - # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. - # - # @param name [Symbol, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. - - # Specifies the auto-tagging extension used. - # - # @see Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension#name - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING = :"google-auto-tagging" - AWS_AUTO_TAGGING = :"aws-auto-tagging" - - # @!method self.values - # @return [Array] - end - end - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - # @!attribute name - # Specifies the auto description extension. - # - # @return [Symbol, :"ai-auto-description"] - required :name, const: :"ai-auto-description" - - # @!method initialize(name: :"ai-auto-description") - # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. - end - - # @!method self.variants - # @return [Array(Imagekit::Models::FileUploadParams::Extension::RemoveBg, Imagekit::Models::FileUploadParams::Extension::AIAutoDescription, Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension)] - end - module ResponseField extend Imagekit::Internal::Type::Enum diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekit/resources/beta/v2/files.rb index 628747bc..670d5a60 100644 --- a/lib/imagekit/resources/beta/v2/files.rb +++ b/lib/imagekit/resources/beta/v2/files.rb @@ -52,7 +52,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index a125df81..1e0d8f83 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -237,7 +237,7 @@ def rename(params) # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index e14a9662..75eeb800 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -27,6 +27,11 @@ module Imagekit CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + ExtensionItem = Imagekit::Models::ExtensionItem + + Extensions = + T.let(Imagekit::Models::Extensions, Imagekit::Internal::Type::Converter) + File = Imagekit::Models::File FileCopyParams = Imagekit::Models::FileCopyParams diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi index 66e8162b..b09ec71f 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -96,9 +96,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg, - Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension ) ] ) @@ -111,9 +111,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash ) ] ).void @@ -278,9 +278,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash ) ], folder: String, @@ -429,9 +429,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg, - Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension ) ], folder: String, @@ -457,284 +457,6 @@ module Imagekit def to_hash end - module Extension - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg, - Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension - ) - end - - class RemoveBg < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the background removal extension. - sig { returns(Symbol) } - attr_accessor :name - - sig do - returns( - T.nilable( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options - ) - ) - end - attr_reader :options - - sig do - params( - options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options::OrHash - ).void - end - attr_writer :options - - sig do - params( - options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options::OrHash, - name: Symbol - ).returns(T.attached_class) - end - def self.new( - options: nil, - # Specifies the background removal extension. - name: :"remove-bg" - ) - end - - sig do - override.returns( - { - name: Symbol, - options: - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options - } - ) - end - def to_hash - end - - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash - ) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the auto description extension. - sig { returns(Symbol) } - attr_accessor :name - - sig { params(name: Symbol).returns(T.attached_class) } - def self.new( - # Specifies the auto description extension. - name: :"ai-auto-description" - ) - end - - sig { override.returns({ name: Symbol }) } - def to_hash - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::Extension::Variants - ] - ) - end - def self.variants - end - end - module ResponseField extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/models/extensions.rbi b/rbi/imagekit/models/extensions.rbi new file mode 100644 index 00000000..46f00ece --- /dev/null +++ b/rbi/imagekit/models/extensions.rbi @@ -0,0 +1,268 @@ +# typed: strong + +module Imagekit + module Models + module ExtensionItem + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension + ) + end + + class RemoveBg < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::ExtensionItem::RemoveBg, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig { returns(Symbol) } + attr_accessor :name + + sig { returns(T.nilable(Imagekit::ExtensionItem::RemoveBg::Options)) } + attr_reader :options + + sig do + params( + options: Imagekit::ExtensionItem::RemoveBg::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + options: Imagekit::ExtensionItem::RemoveBg::Options::OrHash, + name: Symbol + ).returns(T.attached_class) + end + def self.new( + options: nil, + # Specifies the background removal extension. + name: :"remove-bg" + ) + end + + sig do + override.returns( + { + name: Symbol, + options: Imagekit::ExtensionItem::RemoveBg::Options + } + ) + end + def to_hash + end + + class Options < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::ExtensionItem::RemoveBg::Options, + Imagekit::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::ExtensionItem::AutoTaggingExtension, + Imagekit::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns(Imagekit::ExtensionItem::AutoTaggingExtension::Name::OrSymbol) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::ExtensionItem::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekit::ExtensionItem::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::ExtensionItem::AutoTaggingExtension::Name) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekit::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekit::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig { returns(Symbol) } + attr_accessor :name + + sig { params(name: Symbol).returns(T.attached_class) } + def self.new( + # Specifies the auto description extension. + name: :"ai-auto-description" + ) + end + + sig { override.returns({ name: Symbol }) } + def to_hash + end + end + + sig { override.returns(T::Array[Imagekit::ExtensionItem::Variants]) } + def self.variants + end + end + + Extensions = + T.let( + Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem], + Imagekit::Internal::Type::Converter + ) + end +end diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index bbe71faf..1660ce17 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -110,9 +110,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension ) ] ) @@ -125,9 +125,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::OrHash, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription::OrHash, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::OrHash + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash ) ] ).void @@ -171,9 +171,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::OrHash, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription::OrHash, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::OrHash + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash ) ], remove_ai_tags: T.any(T::Array[String], Symbol), @@ -223,9 +223,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension ) ], remove_ai_tags: T.any(T::Array[String], Symbol), @@ -237,284 +237,6 @@ module Imagekit def to_hash end - module Extension - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension - ) - end - - class RemoveBg < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the background removal extension. - sig { returns(Symbol) } - attr_accessor :name - - sig do - returns( - T.nilable( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options - ) - ) - end - attr_reader :options - - sig do - params( - options: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options::OrHash - ).void - end - attr_writer :options - - sig do - params( - options: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options::OrHash, - name: Symbol - ).returns(T.attached_class) - end - def self.new( - options: nil, - # Specifies the background removal extension. - name: :"remove-bg" - ) - end - - sig do - override.returns( - { - name: Symbol, - options: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options - } - ) - end - def to_hash - end - - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash - ) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the auto description extension. - sig { returns(Symbol) } - attr_accessor :name - - sig { params(name: Symbol).returns(T.attached_class) } - def self.new( - # Specifies the auto description extension. - name: :"ai-auto-description" - ) - end - - sig { override.returns({ name: Symbol }) } - def to_hash - end - end - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::Variants - ] - ) - end - def self.variants - end - end - # An array of AITags associated with the file that you want to remove, e.g. # `["car", "vehicle", "motorsports"]`. # diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 14b9033d..3c74f2da 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -101,9 +101,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemoveBg, - Imagekit::FileUploadParams::Extension::AIAutoDescription, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension ) ] ) @@ -116,9 +116,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemoveBg::OrHash, - Imagekit::FileUploadParams::Extension::AIAutoDescription::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash ) ] ).void @@ -301,9 +301,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemoveBg::OrHash, - Imagekit::FileUploadParams::Extension::AIAutoDescription::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash ) ], folder: String, @@ -473,9 +473,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemoveBg, - Imagekit::FileUploadParams::Extension::AIAutoDescription, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension ) ], folder: String, @@ -500,282 +500,6 @@ module Imagekit def to_hash end - module Extension - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::RemoveBg, - Imagekit::FileUploadParams::Extension::AIAutoDescription, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension - ) - end - - class RemoveBg < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::RemoveBg, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the background removal extension. - sig { returns(Symbol) } - attr_accessor :name - - sig do - returns( - T.nilable( - Imagekit::FileUploadParams::Extension::RemoveBg::Options - ) - ) - end - attr_reader :options - - sig do - params( - options: - Imagekit::FileUploadParams::Extension::RemoveBg::Options::OrHash - ).void - end - attr_writer :options - - sig do - params( - options: - Imagekit::FileUploadParams::Extension::RemoveBg::Options::OrHash, - name: Symbol - ).returns(T.attached_class) - end - def self.new( - options: nil, - # Specifies the background removal extension. - name: :"remove-bg" - ) - end - - sig do - override.returns( - { - name: Symbol, - options: - Imagekit::FileUploadParams::Extension::RemoveBg::Options - } - ) - end - def to_hash - end - - class Options < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::RemoveBg::Options, - Imagekit::Internal::AnyHash - ) - end - - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :add_shadow - - sig { params(add_shadow: T::Boolean).void } - attr_writer :add_shadow - - # 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. - sig { returns(T.nilable(String)) } - attr_reader :bg_color - - sig { params(bg_color: String).void } - attr_writer :bg_color - - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - sig { returns(T.nilable(String)) } - attr_reader :bg_image_url - - sig { params(bg_image_url: String).void } - attr_writer :bg_image_url - - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :semitransparency - - sig { params(semitransparency: T::Boolean).void } - attr_writer :semitransparency - - sig do - params( - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Whether to add an artificial shadow to the result. Default is false. Note: - # Adding shadows is currently only supported for car photos. - add_shadow: nil, - # 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. - bg_color: nil, - # Sets a background image from a URL. If this parameter is set, `bg_color` must be - # empty. - bg_image_url: nil, - # Allows semi-transparent regions in the result. Default is true. Note: - # Semitransparency is currently only supported for car windows. - semitransparency: nil - ) - end - - sig do - override.returns( - { - add_shadow: T::Boolean, - bg_color: String, - bg_image_url: String, - semitransparency: T::Boolean - } - ) - end - def to_hash - end - end - end - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::AutoTaggingExtension, - Imagekit::Internal::AnyHash - ) - end - - # Maximum number of tags to attach to the asset. - sig { returns(Integer) } - attr_accessor :max_tags - - # Minimum confidence level for tags to be considered valid. - sig { returns(Integer) } - attr_accessor :min_confidence - - # Specifies the auto-tagging extension used. - sig do - returns( - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - ) - end - attr_accessor :name - - sig do - params( - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Maximum number of tags to attach to the asset. - max_tags:, - # Minimum confidence level for tags to be considered valid. - min_confidence:, - # Specifies the auto-tagging extension used. - name: - ) - end - - sig do - override.returns( - { - max_tags: Integer, - min_confidence: Integer, - name: - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::OrSymbol - } - ) - end - def to_hash - end - - # Specifies the auto-tagging extension used. - module Name - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE_AUTO_TAGGING = - T.let( - :"google-auto-tagging", - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - AWS_AUTO_TAGGING = - T.let( - :"aws-auto-tagging", - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::Name::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::Extension::AIAutoDescription, - Imagekit::Internal::AnyHash - ) - end - - # Specifies the auto description extension. - sig { returns(Symbol) } - attr_accessor :name - - sig { params(name: Symbol).returns(T.attached_class) } - def self.new( - # Specifies the auto description extension. - name: :"ai-auto-description" - ) - end - - sig { override.returns({ name: Symbol }) } - def to_hash - end - end - - sig do - override.returns( - T::Array[Imagekit::FileUploadParams::Extension::Variants] - ) - end - def self.variants - end - end - module ResponseField extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekit/resources/beta/v2/files.rbi index 7dca87db..b78dc1c3 100644 --- a/rbi/imagekit/resources/beta/v2/files.rbi +++ b/rbi/imagekit/resources/beta/v2/files.rbi @@ -44,9 +44,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription::OrHash, - Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::OrHash + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash ) ], folder: String, diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 3ca11dc7..e31ba244 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -200,9 +200,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::FileUploadParams::Extension::RemoveBg::OrHash, - Imagekit::FileUploadParams::Extension::AIAutoDescription::OrHash, - Imagekit::FileUploadParams::Extension::AutoTaggingExtension::OrHash + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash ) ], folder: String, diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 15ef64cd..8228a4e3 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -21,6 +21,10 @@ module Imagekit class CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams + type extension_item = Imagekit::Models::extension_item + + Extensions: Imagekit::Internal::Type::Converter + class File = Imagekit::Models::File class FileCopyParams = Imagekit::Models::FileCopyParams diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekit/models/beta/v2/file_upload_params.rbs index 0546ac88..d9f7ef7f 100644 --- a/sig/imagekit/models/beta/v2/file_upload_params.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_params.rbs @@ -11,7 +11,7 @@ module Imagekit custom_coordinates: String, custom_metadata: ::Hash[Symbol, top], description: String, - extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension], + extensions: Imagekit::Models::extensions, folder: String, is_private_file: bool, is_published: bool, @@ -55,11 +55,11 @@ module Imagekit def description=: (String) -> String - attr_reader extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension]? + attr_reader extensions: Imagekit::Models::extensions? def extensions=: ( - ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] - ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] + Imagekit::Models::extensions + ) -> Imagekit::Models::extensions attr_reader folder: String? @@ -121,7 +121,7 @@ module Imagekit ?custom_coordinates: String, ?custom_metadata: ::Hash[Symbol, top], ?description: String, - ?extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension], + ?extensions: Imagekit::Models::extensions, ?folder: String, ?is_private_file: bool, ?is_published: bool, @@ -145,7 +145,7 @@ module Imagekit custom_coordinates: String, custom_metadata: ::Hash[Symbol, top], description: String, - extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension], + extensions: Imagekit::Models::extensions, folder: String, is_private_file: bool, is_published: bool, @@ -161,131 +161,6 @@ module Imagekit request_options: Imagekit::RequestOptions } - type extension = - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg - | Imagekit::Beta::V2::FileUploadParams::Extension::AIAutoDescription - | Imagekit::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension - - module Extension - extend Imagekit::Internal::Type::Union - - type remove_bg = - { - name: :"remove-bg", - options: Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options - } - - class RemoveBg < Imagekit::Internal::Type::BaseModel - attr_accessor name: :"remove-bg" - - attr_reader options: Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options? - - def options=: ( - Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options - ) -> Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options - - def initialize: ( - ?options: Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options, - ?name: :"remove-bg" - ) -> void - - def to_hash: -> { - name: :"remove-bg", - options: Imagekit::Beta::V2::FileUploadParams::Extension::RemoveBg::Options - } - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? - - def add_shadow=: (bool) -> bool - - attr_reader bg_color: String? - - def bg_color=: (String) -> String - - attr_reader bg_image_url: String? - - def bg_image_url=: (String) -> String - - attr_reader semitransparency: bool? - - def semitransparency=: (bool) -> bool - - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void - - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end - - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ - } - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer - - attr_accessor min_confidence: Integer - - attr_accessor name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ - - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ - ) -> void - - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_ - } - - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Extension::AutoTaggingExtension::name_] - end - end - - type ai_auto_description = { name: :"ai-auto-description" } - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - attr_accessor name: :"ai-auto-description" - - def initialize: (?name: :"ai-auto-description") -> void - - def to_hash: -> { name: :"ai-auto-description" } - end - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension] - end - type response_field = :tags | :customCoordinates diff --git a/sig/imagekit/models/extensions.rbs b/sig/imagekit/models/extensions.rbs new file mode 100644 index 00000000..783d12ea --- /dev/null +++ b/sig/imagekit/models/extensions.rbs @@ -0,0 +1,132 @@ +module Imagekit + module Models + type extension_item = + Imagekit::ExtensionItem::RemoveBg + | Imagekit::ExtensionItem::AIAutoDescription + | Imagekit::ExtensionItem::AutoTaggingExtension + + module ExtensionItem + extend Imagekit::Internal::Type::Union + + type remove_bg = + { + name: :"remove-bg", + options: Imagekit::ExtensionItem::RemoveBg::Options + } + + class RemoveBg < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"remove-bg" + + attr_reader options: Imagekit::ExtensionItem::RemoveBg::Options? + + def options=: ( + Imagekit::ExtensionItem::RemoveBg::Options + ) -> Imagekit::ExtensionItem::RemoveBg::Options + + def initialize: ( + ?options: Imagekit::ExtensionItem::RemoveBg::Options, + ?name: :"remove-bg" + ) -> void + + def to_hash: -> { + name: :"remove-bg", + options: Imagekit::ExtensionItem::RemoveBg::Options + } + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekit::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekit::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_] + end + end + + type ai_auto_description = { name: :"ai-auto-description" } + + class AIAutoDescription < Imagekit::Internal::Type::BaseModel + attr_accessor name: :"ai-auto-description" + + def initialize: (?name: :"ai-auto-description") -> void + + def to_hash: -> { name: :"ai-auto-description" } + end + + def self?.variants: -> ::Array[Imagekit::Models::extension_item] + end + + type extensions = ::Array[Imagekit::Models::extension_item] + + Extensions: Imagekit::Internal::Type::Converter + end +end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index 3ffb7254..3b3bc454 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -36,7 +36,7 @@ module Imagekit custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], description: String, - extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + extensions: Imagekit::Models::extensions, remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, tags: ::Array[String]?, webhook_url: String @@ -53,11 +53,11 @@ module Imagekit def description=: (String) -> String - attr_reader extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension]? + attr_reader extensions: Imagekit::Models::extensions? def extensions=: ( - ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] - ) -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] + Imagekit::Models::extensions + ) -> Imagekit::Models::extensions attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags? @@ -75,7 +75,7 @@ module Imagekit ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], ?description: String, - ?extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + ?extensions: Imagekit::Models::extensions, ?remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, ?tags: ::Array[String]?, ?webhook_url: String @@ -85,137 +85,12 @@ module Imagekit custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], description: String, - extensions: ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension], + extensions: Imagekit::Models::extensions, remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, tags: ::Array[String]?, webhook_url: String } - type extension = - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg - | Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AIAutoDescription - | Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension - - module Extension - extend Imagekit::Internal::Type::Union - - type remove_bg = - { - name: :"remove-bg", - options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options - } - - class RemoveBg < Imagekit::Internal::Type::BaseModel - attr_accessor name: :"remove-bg" - - attr_reader options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options? - - def options=: ( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options - ) -> Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options - - def initialize: ( - ?options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options, - ?name: :"remove-bg" - ) -> void - - def to_hash: -> { - name: :"remove-bg", - options: Imagekit::FileUpdateParams::Update::UpdateFileDetails::Extension::RemoveBg::Options - } - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? - - def add_shadow=: (bool) -> bool - - attr_reader bg_color: String? - - def bg_color=: (String) -> String - - attr_reader bg_image_url: String? - - def bg_image_url=: (String) -> String - - attr_reader semitransparency: bool? - - def semitransparency=: (bool) -> bool - - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void - - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end - - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ - } - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer - - attr_accessor min_confidence: Integer - - attr_accessor name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ - - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ - ) -> void - - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_ - } - - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::Extension::AutoTaggingExtension::name_] - end - end - - type ai_auto_description = { name: :"ai-auto-description" } - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - attr_accessor name: :"ai-auto-description" - - def initialize: (?name: :"ai-auto-description") -> void - - def to_hash: -> { name: :"ai-auto-description" } - end - - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::extension] - end - type remove_ai_tags = ::Array[String] | :all module RemoveAITags diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index 4a2ea622..62ca0281 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -10,7 +10,7 @@ module Imagekit custom_metadata: ::Hash[Symbol, top], description: String, expire: Integer, - extensions: ::Array[Imagekit::Models::FileUploadParams::extension], + extensions: Imagekit::Models::extensions, folder: String, is_private_file: bool, is_published: bool, @@ -60,11 +60,11 @@ module Imagekit def expire=: (Integer) -> Integer - attr_reader extensions: ::Array[Imagekit::Models::FileUploadParams::extension]? + attr_reader extensions: Imagekit::Models::extensions? def extensions=: ( - ::Array[Imagekit::Models::FileUploadParams::extension] - ) -> ::Array[Imagekit::Models::FileUploadParams::extension] + Imagekit::Models::extensions + ) -> Imagekit::Models::extensions attr_reader folder: String? @@ -135,7 +135,7 @@ module Imagekit ?custom_metadata: ::Hash[Symbol, top], ?description: String, ?expire: Integer, - ?extensions: ::Array[Imagekit::Models::FileUploadParams::extension], + ?extensions: Imagekit::Models::extensions, ?folder: String, ?is_private_file: bool, ?is_published: bool, @@ -162,7 +162,7 @@ module Imagekit custom_metadata: ::Hash[Symbol, top], description: String, expire: Integer, - extensions: ::Array[Imagekit::Models::FileUploadParams::extension], + extensions: Imagekit::Models::extensions, folder: String, is_private_file: bool, is_published: bool, @@ -180,131 +180,6 @@ module Imagekit request_options: Imagekit::RequestOptions } - type extension = - Imagekit::FileUploadParams::Extension::RemoveBg - | Imagekit::FileUploadParams::Extension::AIAutoDescription - | Imagekit::FileUploadParams::Extension::AutoTaggingExtension - - module Extension - extend Imagekit::Internal::Type::Union - - type remove_bg = - { - name: :"remove-bg", - options: Imagekit::FileUploadParams::Extension::RemoveBg::Options - } - - class RemoveBg < Imagekit::Internal::Type::BaseModel - attr_accessor name: :"remove-bg" - - attr_reader options: Imagekit::FileUploadParams::Extension::RemoveBg::Options? - - def options=: ( - Imagekit::FileUploadParams::Extension::RemoveBg::Options - ) -> Imagekit::FileUploadParams::Extension::RemoveBg::Options - - def initialize: ( - ?options: Imagekit::FileUploadParams::Extension::RemoveBg::Options, - ?name: :"remove-bg" - ) -> void - - def to_hash: -> { - name: :"remove-bg", - options: Imagekit::FileUploadParams::Extension::RemoveBg::Options - } - - type options = - { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader add_shadow: bool? - - def add_shadow=: (bool) -> bool - - attr_reader bg_color: String? - - def bg_color=: (String) -> String - - attr_reader bg_image_url: String? - - def bg_image_url=: (String) -> String - - attr_reader semitransparency: bool? - - def semitransparency=: (bool) -> bool - - def initialize: ( - ?add_shadow: bool, - ?bg_color: String, - ?bg_image_url: String, - ?semitransparency: bool - ) -> void - - def to_hash: -> { - add_shadow: bool, - bg_color: String, - bg_image_url: String, - semitransparency: bool - } - end - end - - type auto_tagging_extension = - { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ - } - - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel - attr_accessor max_tags: Integer - - attr_accessor min_confidence: Integer - - attr_accessor name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ - - def initialize: ( - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ - ) -> void - - def to_hash: -> { - max_tags: Integer, - min_confidence: Integer, - name: Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_ - } - - type name_ = :"google-auto-tagging" | :"aws-auto-tagging" - - module Name - extend Imagekit::Internal::Type::Enum - - GOOGLE_AUTO_TAGGING: :"google-auto-tagging" - AWS_AUTO_TAGGING: :"aws-auto-tagging" - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Extension::AutoTaggingExtension::name_] - end - end - - type ai_auto_description = { name: :"ai-auto-description" } - - class AIAutoDescription < Imagekit::Internal::Type::BaseModel - attr_accessor name: :"ai-auto-description" - - def initialize: (?name: :"ai-auto-description") -> void - - def to_hash: -> { name: :"ai-auto-description" } - end - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::extension] - end - type response_field = :tags | :customCoordinates diff --git a/sig/imagekit/resources/beta/v2/files.rbs b/sig/imagekit/resources/beta/v2/files.rbs index 1bc818b9..a2d266ae 100644 --- a/sig/imagekit/resources/beta/v2/files.rbs +++ b/sig/imagekit/resources/beta/v2/files.rbs @@ -11,7 +11,7 @@ module Imagekit ?custom_coordinates: String, ?custom_metadata: ::Hash[Symbol, top], ?description: String, - ?extensions: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::extension], + ?extensions: Imagekit::Models::extensions, ?folder: String, ?is_private_file: bool, ?is_published: bool, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 991b1f14..ca0f846d 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -52,7 +52,7 @@ module Imagekit ?custom_metadata: ::Hash[Symbol, top], ?description: String, ?expire: Integer, - ?extensions: ::Array[Imagekit::Models::FileUploadParams::extension], + ?extensions: Imagekit::Models::extensions, ?folder: String, ?is_private_file: bool, ?is_published: bool, From d72e0cc371e7fc69ed39307c302524df31830d52 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:13 +0000 Subject: [PATCH 102/178] feat(api): manual updates --- .stats.yml | 2 +- .../models/accounts/origin_create_params.rb | 10 +- .../models/accounts/origin_update_params.rb | 10 +- lib/imagekit/models/file_update_params.rb | 286 +++++----- lib/imagekit/resources/accounts/origins.rb | 22 +- lib/imagekit/resources/files.rb | 20 +- .../models/accounts/origin_create_params.rbi | 57 +- .../models/accounts/origin_update_params.rbi | 57 +- rbi/imagekit/models/file_update_params.rbi | 502 +++++++----------- rbi/imagekit/resources/accounts/origins.rbi | 28 +- rbi/imagekit/resources/files.rbi | 52 +- .../models/accounts/origin_create_params.rbs | 19 +- .../models/accounts/origin_update_params.rbs | 19 +- sig/imagekit/models/file_update_params.rbs | 177 +++--- sig/imagekit/resources/accounts/origins.rbs | 4 +- sig/imagekit/resources/files.rbs | 9 +- .../resources/accounts/origins_test.rb | 28 +- 17 files changed, 651 insertions(+), 651 deletions(-) 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/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb index d3f005e4..120fed5d 100644 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ b/lib/imagekit/models/accounts/origin_create_params.rb @@ -8,7 +8,15 @@ class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute origin_request + # Schema for origin request resources. + # + # @return [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] + required :origin_request, union: -> { Imagekit::Accounts::OriginRequest } + + # @!method initialize(origin_request:, request_options: {}) + # @param origin_request [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb index d97a3cc0..2cbe03a7 100644 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ b/lib/imagekit/models/accounts/origin_update_params.rb @@ -8,7 +8,15 @@ class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute origin_request + # Schema for origin request resources. + # + # @return [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] + required :origin_request, union: -> { Imagekit::Accounts::OriginRequest } + + # @!method initialize(origin_request:, request_options: {}) + # @param origin_request [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index 46e3ec4f..043a0f24 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -7,172 +7,142 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute update + # @!attribute custom_coordinates + # 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. # - # @return [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus, nil] - optional :update, union: -> { Imagekit::FileUpdateParams::Update } + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - # @!method initialize(update: nil, request_options: {}) - # @param update [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus] + # @!attribute custom_metadata + # 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. + # + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata + + # @!attribute description + # Optional text to describe the contents of the file. + # + # @return [String, nil] + optional :description, String + + # @!attribute extensions + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + # + # @return [Array, nil] + optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } + + # @!attribute remove_ai_tags + # 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. + # + # @return [Array, Symbol, :all, nil] + optional :remove_ai_tags, + union: -> { + Imagekit::FileUpdateParams::RemoveAITags + }, + api_name: :removeAITags + + # @!attribute tags + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!attribute publish + # Configure the publication status of a file and its versions. + # + # @return [Imagekit::Models::FileUpdateParams::Publish, nil] + optional :publish, -> { Imagekit::FileUpdateParams::Publish } + + # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams} for more details. + # + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - module Update + # 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. + module RemoveAITags extend Imagekit::Internal::Type::Union - variant -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails } - - variant -> { Imagekit::FileUpdateParams::Update::ChangePublicationStatus } - - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel - # @!attribute custom_coordinates - # 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. - # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true - - # @!attribute custom_metadata - # 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. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - - # @!attribute description - # Optional text to describe the contents of the file. - # - # @return [String, nil] - optional :description, String - - # @!attribute extensions - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - # - # @return [Array, nil] - optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } - - # @!attribute remove_ai_tags - # 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. - # - # @return [Array, Symbol, :all, nil] - optional :remove_ai_tags, - union: -> { Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags }, - api_name: :removeAITags - - # @!attribute tags - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute webhook_url - # 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 [String, nil] - optional :webhook_url, String, api_name: :webhookUrl - - # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails} for more - # details. - # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param description [String] Optional text to describe the contents of the file. - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - - # 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. - # - # @see Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails#remove_ai_tags - module RemoveAITags - extend Imagekit::Internal::Type::Union - - variant -> { Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::StringArray } - - variant const: :all - - # @!method self.variants - # @return [Array(Array, Symbol, :all)] - - # @type [Imagekit::Internal::Type::Converter] - StringArray = Imagekit::Internal::Type::ArrayOf[String] - end - end - - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - # @!attribute publish - # Configure the publication status of a file and its versions. - # - # @return [Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish, nil] - optional :publish, -> { Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish } - - # @!method initialize(publish: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus} for more - # details. - # - # @param publish [Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. - - # @see Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus#publish - class Publish < Imagekit::Internal::Type::BaseModel - # @!attribute is_published - # Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @return [Boolean] - required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute include_file_versions - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - # - # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions - - # @!method initialize(is_published:, include_file_versions: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus::Publish} - # for more details. - # - # Configure the publication status of a file and its versions. - # - # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p - end - end + variant -> { Imagekit::Models::FileUpdateParams::RemoveAITags::StringArray } + + variant const: :all # @!method self.variants - # @return [Array(Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus)] + # @return [Array(Array, Symbol, :all)] + + # @type [Imagekit::Internal::Type::Converter] + StringArray = Imagekit::Internal::Type::ArrayOf[String] + end + + class Publish < Imagekit::Internal::Type::BaseModel + # @!attribute is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @return [Boolean] + required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + # + # @return [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + + # @!method initialize(is_published:, include_file_versions: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUpdateParams::Publish} for more details. + # + # Configure the publication status of a file and its versions. + # + # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p end end end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb index c4b0cba9..5ae00800 100644 --- a/lib/imagekit/resources/accounts/origins.rb +++ b/lib/imagekit/resources/accounts/origins.rb @@ -7,9 +7,9 @@ class Origins # **Note:** This API is currently in beta. # Creates a new origin and returns the origin object. # - # @overload create(origin:, request_options: {}) + # @overload create(origin_request:, request_options: {}) # - # @param origin [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. + # @param origin_request [Imagekit::Accounts::OriginRequest] Schema for origin request resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -18,10 +18,15 @@ class Origins # @see Imagekit::Models::Accounts::OriginCreateParams def create(params) parsed, options = Imagekit::Accounts::OriginCreateParams.dump_request(params) + case parsed + in {origin_request: Hash => union, **rest} + parsed = {**rest, **union} + else + end @client.request( method: :post, path: "v1/accounts/origins", - body: parsed[:origin], + body: parsed, model: Imagekit::Accounts::OriginResponse, options: options ) @@ -33,11 +38,11 @@ def create(params) # **Note:** This API is currently in beta. # Updates the origin identified by `id` and returns the updated origin object. # - # @overload update(id, origin:, request_options: {}) + # @overload update(id, origin_request:, request_options: {}) # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # - # @param origin [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. + # @param origin_request [Imagekit::Accounts::OriginRequest] Schema for origin request resources. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -46,10 +51,15 @@ def create(params) # @see Imagekit::Models::Accounts::OriginUpdateParams def update(id, params) parsed, options = Imagekit::Accounts::OriginUpdateParams.dump_request(params) + case parsed + in {origin_request: Hash => union, **rest} + parsed = {**rest, **union} + else + end @client.request( method: :put, path: ["v1/accounts/origins/%1$s", id], - body: parsed[:origin], + body: parsed, model: Imagekit::Accounts::OriginResponse, options: options ) diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 1e0d8f83..382667c4 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -19,11 +19,25 @@ class Files # You can update `tags`, `customCoordinates`, `customMetadata`, publication # status, remove existing `AITags` and apply extensions using this API. # - # @overload update(file_id, update: nil, request_options: {}) + # @overload update(file_id, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param update [Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails, Imagekit::Models::FileUpdateParams::Update::ChangePublicationStatus] + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # + # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -35,7 +49,7 @@ def update(file_id, params = {}) @client.request( method: :patch, path: ["v1/files/%1$s/details", file_id], - body: parsed[:update], + body: parsed, model: Imagekit::Models::FileUpdateResponse, options: options ) diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi index f53d55e5..96e32302 100644 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ b/rbi/imagekit/models/accounts/origin_create_params.rbi @@ -15,15 +15,64 @@ module Imagekit ) end + # Schema for origin request resources. sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class + returns( + T.any( + Imagekit::Accounts::OriginRequest::S3, + Imagekit::Accounts::OriginRequest::S3Compatible, + Imagekit::Accounts::OriginRequest::CloudinaryBackup, + Imagekit::Accounts::OriginRequest::WebFolder, + Imagekit::Accounts::OriginRequest::WebProxy, + Imagekit::Accounts::OriginRequest::Gcs, + Imagekit::Accounts::OriginRequest::AzureBlob, + Imagekit::Accounts::OriginRequest::AkeneoPim + ) ) end - def self.new(request_options: {}) + attr_accessor :origin_request + + sig do + params( + origin_request: + T.any( + Imagekit::Accounts::OriginRequest::S3::OrHash, + Imagekit::Accounts::OriginRequest::S3Compatible::OrHash, + Imagekit::Accounts::OriginRequest::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginRequest::WebFolder::OrHash, + Imagekit::Accounts::OriginRequest::WebProxy::OrHash, + Imagekit::Accounts::OriginRequest::Gcs::OrHash, + Imagekit::Accounts::OriginRequest::AzureBlob::OrHash, + Imagekit::Accounts::OriginRequest::AkeneoPim::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for origin request resources. + origin_request:, + request_options: {} + ) end - sig { override.returns({ request_options: Imagekit::RequestOptions }) } + sig do + override.returns( + { + origin_request: + T.any( + Imagekit::Accounts::OriginRequest::S3, + Imagekit::Accounts::OriginRequest::S3Compatible, + Imagekit::Accounts::OriginRequest::CloudinaryBackup, + Imagekit::Accounts::OriginRequest::WebFolder, + Imagekit::Accounts::OriginRequest::WebProxy, + Imagekit::Accounts::OriginRequest::Gcs, + Imagekit::Accounts::OriginRequest::AzureBlob, + Imagekit::Accounts::OriginRequest::AkeneoPim + ), + request_options: Imagekit::RequestOptions + } + ) + end def to_hash end end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi index 51783397..99f6e6f2 100644 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ b/rbi/imagekit/models/accounts/origin_update_params.rbi @@ -15,15 +15,64 @@ module Imagekit ) end + # Schema for origin request resources. sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class + returns( + T.any( + Imagekit::Accounts::OriginRequest::S3, + Imagekit::Accounts::OriginRequest::S3Compatible, + Imagekit::Accounts::OriginRequest::CloudinaryBackup, + Imagekit::Accounts::OriginRequest::WebFolder, + Imagekit::Accounts::OriginRequest::WebProxy, + Imagekit::Accounts::OriginRequest::Gcs, + Imagekit::Accounts::OriginRequest::AzureBlob, + Imagekit::Accounts::OriginRequest::AkeneoPim + ) ) end - def self.new(request_options: {}) + attr_accessor :origin_request + + sig do + params( + origin_request: + T.any( + Imagekit::Accounts::OriginRequest::S3::OrHash, + Imagekit::Accounts::OriginRequest::S3Compatible::OrHash, + Imagekit::Accounts::OriginRequest::CloudinaryBackup::OrHash, + Imagekit::Accounts::OriginRequest::WebFolder::OrHash, + Imagekit::Accounts::OriginRequest::WebProxy::OrHash, + Imagekit::Accounts::OriginRequest::Gcs::OrHash, + Imagekit::Accounts::OriginRequest::AzureBlob::OrHash, + Imagekit::Accounts::OriginRequest::AkeneoPim::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for origin request resources. + origin_request:, + request_options: {} + ) end - sig { override.returns({ request_options: Imagekit::RequestOptions }) } + sig do + override.returns( + { + origin_request: + T.any( + Imagekit::Accounts::OriginRequest::S3, + Imagekit::Accounts::OriginRequest::S3Compatible, + Imagekit::Accounts::OriginRequest::CloudinaryBackup, + Imagekit::Accounts::OriginRequest::WebFolder, + Imagekit::Accounts::OriginRequest::WebProxy, + Imagekit::Accounts::OriginRequest::Gcs, + Imagekit::Accounts::OriginRequest::AzureBlob, + Imagekit::Accounts::OriginRequest::AkeneoPim + ), + request_options: Imagekit::RequestOptions + } + ) + end def to_hash end end diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index 1660ce17..3f8f60e8 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -11,50 +11,168 @@ module Imagekit T.any(Imagekit::FileUpdateParams, Imagekit::Internal::AnyHash) end + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. sig do returns( T.nilable( - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus - ) + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension + ) + ] ) ) end - attr_reader :update + attr_reader :extensions sig do params( - update: - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash - ) + extensions: + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + ) + ] ).void end - attr_writer :update + attr_writer :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. + sig { returns(T.nilable(T.any(T::Array[String], Symbol))) } + attr_reader :remove_ai_tags + + sig { params(remove_ai_tags: T.any(T::Array[String], Symbol)).void } + attr_writer :remove_ai_tags + + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + # Configure the publication status of a file and its versions. + sig { returns(T.nilable(Imagekit::FileUpdateParams::Publish)) } + attr_reader :publish + + sig { params(publish: Imagekit::FileUpdateParams::Publish::OrHash).void } + attr_writer :publish sig do params( - update: - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash - ), + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + ) + ], + remove_ai_tags: T.any(T::Array[String], Symbol), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(update: nil, request_options: {}) + def self.new( + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, + # Configure the publication status of a file and its versions. + publish: nil, + request_options: {} + ) end sig do override.returns( { - update: - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus - ), + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension + ) + ], + remove_ai_tags: T.any(T::Array[String], Symbol), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish, request_options: Imagekit::RequestOptions } ) @@ -62,315 +180,77 @@ module Imagekit def to_hash end - module Update + # 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. + module RemoveAITags extend Imagekit::Internal::Type::Union - Variants = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus - ) - end - - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails, - Imagekit::Internal::AnyHash - ) - end - - # 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. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # 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. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata + Variants = T.type_alias { T.any(T::Array[String], Symbol) } - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Optional text to describe the contents of the file. - sig { returns(T.nilable(String)) } - attr_reader :description - - sig { params(description: String).void } - attr_writer :description - - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - sig do - returns( - T.nilable( - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension - ) - ] - ) - ) - end - attr_reader :extensions - - sig do - params( - extensions: - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash - ) - ] - ).void - end - attr_writer :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. - sig { returns(T.nilable(T.any(T::Array[String], Symbol))) } - attr_reader :remove_ai_tags - - sig { params(remove_ai_tags: T.any(T::Array[String], Symbol)).void } - attr_writer :remove_ai_tags - - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :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. - sig { returns(T.nilable(String)) } - attr_reader :webhook_url - - sig { params(webhook_url: String).void } - attr_writer :webhook_url - - sig do - params( - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String - ).returns(T.attached_class) - end - def self.new( - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil + sig do + override.returns( + T::Array[Imagekit::FileUpdateParams::RemoveAITags::Variants] ) - end - - sig do - override.returns( - { - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String - } - ) - end - def to_hash - end - - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(T::Array[String], Symbol) } - - sig do - override.returns( - T::Array[ - Imagekit::FileUpdateParams::Update::UpdateFileDetails::RemoveAITags::Variants - ] - ) - end - def self.variants - end - - StringArray = - T.let( - Imagekit::Internal::Type::ArrayOf[String], - Imagekit::Internal::Type::Converter - ) - end + end + def self.variants end - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::ChangePublicationStatus, - Imagekit::Internal::AnyHash - ) - end - - # Configure the publication status of a file and its versions. - sig do - returns( - T.nilable( - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - ) - ) - end - attr_reader :publish - - sig do - params( - publish: - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish::OrHash - ).void - end - attr_writer :publish - - sig do - params( - publish: - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish::OrHash - ).returns(T.attached_class) - end - def self.new( - # Configure the publication status of a file and its versions. - publish: nil + StringArray = + T.let( + Imagekit::Internal::Type::ArrayOf[String], + Imagekit::Internal::Type::Converter ) - end + end - sig do - override.returns( - { - publish: - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - } + class Publish < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUpdateParams::Publish, + Imagekit::Internal::AnyHash ) end - def to_hash - end - class Publish < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish, - Imagekit::Internal::AnyHash - ) - end - - # Set to `true` to publish the file. Set to `false` to unpublish the file. - sig { returns(T::Boolean) } - attr_accessor :is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + sig { returns(T::Boolean) } + attr_accessor :is_published - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions - sig { params(include_file_versions: T::Boolean).void } - attr_writer :include_file_versions + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions - # Configure the publication status of a file and its versions. - sig do - params( - is_published: T::Boolean, - include_file_versions: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Set to `true` to publish the file. Set to `false` to unpublish the file. - is_published:, - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - include_file_versions: nil - ) - end - - sig do - override.returns( - { is_published: T::Boolean, include_file_versions: T::Boolean } - ) - end - def to_hash - end - end + # Configure the publication status of a file and its versions. + sig do + params( + is_published: T::Boolean, + include_file_versions: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Set to `true` to publish the file. Set to `false` to unpublish the file. + is_published:, + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + include_file_versions: nil + ) end sig do override.returns( - T::Array[Imagekit::FileUpdateParams::Update::Variants] + { is_published: T::Boolean, include_file_versions: T::Boolean } ) end - def self.variants + def to_hash end end end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekit/resources/accounts/origins.rbi index 5eb4899b..d7489d06 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekit/resources/accounts/origins.rbi @@ -8,23 +8,13 @@ module Imagekit # Creates a new origin and returns the origin object. sig do params( - origin: - T.any( - Imagekit::Accounts::OriginRequest::S3::OrHash, - Imagekit::Accounts::OriginRequest::S3Compatible::OrHash, - Imagekit::Accounts::OriginRequest::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginRequest::WebFolder::OrHash, - Imagekit::Accounts::OriginRequest::WebProxy::OrHash, - Imagekit::Accounts::OriginRequest::Gcs::OrHash, - Imagekit::Accounts::OriginRequest::AzureBlob::OrHash, - Imagekit::Accounts::OriginRequest::AkeneoPim::OrHash - ), + origin_request: Imagekit::Accounts::OriginRequest, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Accounts::OriginResponse::Variants) end def create( # Schema for origin request resources. - origin:, + origin_request:, request_options: {} ) end @@ -34,17 +24,7 @@ module Imagekit sig do params( id: String, - origin: - T.any( - Imagekit::Accounts::OriginRequest::S3::OrHash, - Imagekit::Accounts::OriginRequest::S3Compatible::OrHash, - Imagekit::Accounts::OriginRequest::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginRequest::WebFolder::OrHash, - Imagekit::Accounts::OriginRequest::WebProxy::OrHash, - Imagekit::Accounts::OriginRequest::Gcs::OrHash, - Imagekit::Accounts::OriginRequest::AzureBlob::OrHash, - Imagekit::Accounts::OriginRequest::AkeneoPim::OrHash - ), + origin_request: Imagekit::Accounts::OriginRequest, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Accounts::OriginResponse::Variants) end @@ -53,7 +33,7 @@ module Imagekit # a new origin. id, # Schema for origin request resources. - origin:, + origin_request:, request_options: {} ) end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index e31ba244..b8c6513c 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -18,11 +18,21 @@ module Imagekit sig do params( file_id: String, - update: - T.any( - Imagekit::FileUpdateParams::Update::UpdateFileDetails::OrHash, - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::OrHash - ), + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + ) + ], + remove_ai_tags: T.any(T::Array[String], Symbol), + tags: T.nilable(T::Array[String]), + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish::OrHash, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::FileUpdateResponse) end @@ -30,7 +40,37 @@ module Imagekit # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. file_id, - update: nil, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, + # Configure the publication status of a file and its versions. + publish: nil, request_options: {} ) end diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs index 60ad3272..a51e6472 100644 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ b/sig/imagekit/models/accounts/origin_create_params.rbs @@ -2,15 +2,28 @@ module Imagekit module Models module Accounts type origin_create_params = - { } & Imagekit::Internal::Type::request_parameters + { origin_request: Imagekit::Models::Accounts::origin_request } + & Imagekit::Internal::Type::request_parameters class OriginCreateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - def initialize: (?request_options: Imagekit::request_opts) -> void + def origin_request: -> Imagekit::Models::Accounts::origin_request - def to_hash: -> { request_options: Imagekit::RequestOptions } + def origin_request=: ( + Imagekit::Models::Accounts::origin_request _ + ) -> Imagekit::Models::Accounts::origin_request + + def initialize: ( + origin_request: Imagekit::Models::Accounts::origin_request, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + origin_request: Imagekit::Models::Accounts::origin_request, + request_options: Imagekit::RequestOptions + } end end end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs index cb2744ce..e6e08583 100644 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ b/sig/imagekit/models/accounts/origin_update_params.rbs @@ -2,15 +2,28 @@ module Imagekit module Models module Accounts type origin_update_params = - { } & Imagekit::Internal::Type::request_parameters + { origin_request: Imagekit::Models::Accounts::origin_request } + & Imagekit::Internal::Type::request_parameters class OriginUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - def initialize: (?request_options: Imagekit::request_opts) -> void + def origin_request: -> Imagekit::Models::Accounts::origin_request - def to_hash: -> { request_options: Imagekit::RequestOptions } + def origin_request=: ( + Imagekit::Models::Accounts::origin_request _ + ) -> Imagekit::Models::Accounts::origin_request + + def initialize: ( + origin_request: Imagekit::Models::Accounts::origin_request, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + origin_request: Imagekit::Models::Accounts::origin_request, + request_options: Imagekit::RequestOptions + } end end end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index 3b3bc454..dad939dc 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -1,146 +1,105 @@ module Imagekit module Models type file_update_params = - { update: Imagekit::Models::FileUpdateParams::update } + { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: Imagekit::Models::extensions, + remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish + } & Imagekit::Internal::Type::request_parameters class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_reader update: Imagekit::Models::FileUpdateParams::update? - - def update=: ( - Imagekit::Models::FileUpdateParams::update - ) -> Imagekit::Models::FileUpdateParams::update - - def initialize: ( - ?update: Imagekit::Models::FileUpdateParams::update, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - update: Imagekit::Models::FileUpdateParams::update, - request_options: Imagekit::RequestOptions - } - - type update = - Imagekit::FileUpdateParams::Update::UpdateFileDetails - | Imagekit::FileUpdateParams::Update::ChangePublicationStatus - - module Update - extend Imagekit::Internal::Type::Union - - type update_file_details = - { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: Imagekit::Models::extensions, - remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String - } + attr_accessor custom_coordinates: String? - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel - attr_accessor custom_coordinates: String? + attr_reader custom_metadata: ::Hash[Symbol, top]? - attr_reader custom_metadata: ::Hash[Symbol, top]? + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader description: String? - attr_reader description: String? + def description=: (String) -> String - def description=: (String) -> String + attr_reader extensions: Imagekit::Models::extensions? - attr_reader extensions: Imagekit::Models::extensions? + def extensions=: ( + Imagekit::Models::extensions + ) -> Imagekit::Models::extensions - def extensions=: ( - Imagekit::Models::extensions - ) -> Imagekit::Models::extensions + attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags? - attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags? + def remove_ai_tags=: ( + Imagekit::Models::FileUpdateParams::remove_ai_tags + ) -> Imagekit::Models::FileUpdateParams::remove_ai_tags - def remove_ai_tags=: ( - Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags - ) -> Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags + attr_accessor tags: ::Array[String]? - attr_accessor tags: ::Array[String]? + attr_reader webhook_url: String? - attr_reader webhook_url: String? + def webhook_url=: (String) -> String - def webhook_url=: (String) -> String + attr_reader publish: Imagekit::FileUpdateParams::Publish? - def initialize: ( - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: Imagekit::Models::extensions, - ?remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String - ) -> void + def publish=: ( + Imagekit::FileUpdateParams::Publish + ) -> Imagekit::FileUpdateParams::Publish - def to_hash: -> { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: Imagekit::Models::extensions, - remove_ai_tags: Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String - } - - type remove_ai_tags = ::Array[String] | :all - - module RemoveAITags - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::Update::UpdateFileDetails::remove_ai_tags] - - StringArray: Imagekit::Internal::Type::Converter - end - end - - type change_publication_status = - { - publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - } + def initialize: ( + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: Imagekit::Models::extensions, + ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, + ?publish: Imagekit::FileUpdateParams::Publish, + ?request_options: Imagekit::request_opts + ) -> void - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - attr_reader publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish? + def to_hash: -> { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: Imagekit::Models::extensions, + remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String, + publish: Imagekit::FileUpdateParams::Publish, + request_options: Imagekit::RequestOptions + } - def publish=: ( - Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - ) -> Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish + type remove_ai_tags = ::Array[String] | :all - def initialize: ( - ?publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - ) -> void + module RemoveAITags + extend Imagekit::Internal::Type::Union - def to_hash: -> { - publish: Imagekit::FileUpdateParams::Update::ChangePublicationStatus::Publish - } + def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::remove_ai_tags] - type publish = { is_published: bool, include_file_versions: bool } + StringArray: Imagekit::Internal::Type::Converter + end - class Publish < Imagekit::Internal::Type::BaseModel - attr_accessor is_published: bool + type publish = { is_published: bool, include_file_versions: bool } - attr_reader include_file_versions: bool? + class Publish < Imagekit::Internal::Type::BaseModel + attr_accessor is_published: bool - def include_file_versions=: (bool) -> bool + attr_reader include_file_versions: bool? - def initialize: ( - is_published: bool, - ?include_file_versions: bool - ) -> void + def include_file_versions=: (bool) -> bool - def to_hash: -> { is_published: bool, include_file_versions: bool } - end - end + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::update] + def to_hash: -> { is_published: bool, include_file_versions: bool } end end end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs index 3cc90be7..6fe76931 100644 --- a/sig/imagekit/resources/accounts/origins.rbs +++ b/sig/imagekit/resources/accounts/origins.rbs @@ -3,13 +3,13 @@ module Imagekit class Accounts class Origins def create: ( - origin: Imagekit::Models::Accounts::origin_request, + origin_request: Imagekit::Models::Accounts::OriginRequest, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_response def update: ( String id, - origin: Imagekit::Models::Accounts::origin_request, + origin_request: Imagekit::Models::Accounts::OriginRequest, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::Accounts::origin_response diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index ca0f846d..496acf8f 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -9,7 +9,14 @@ module Imagekit def update: ( String file_id, - ?update: Imagekit::Models::FileUpdateParams::update, + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: Imagekit::Models::extensions, + ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, + ?publish: Imagekit::FileUpdateParams::Publish, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::FileUpdateResponse diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekit/resources/accounts/origins_test.rb index 55df4efe..87930425 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekit/resources/accounts/origins_test.rb @@ -8,13 +8,13 @@ def test_create_required_params response = @image_kit.accounts.origins.create( - origin: { - accessKey: "AKIATEST123", - bucket: "test-bucket", - name: "My S3 Origin", - secretKey: "secrettest123", - type: :S3 - } + base_url: "https://akeneo.company.com", + client_id: "akeneo-client-id", + client_secret: "akeneo-client-secret", + name: "US S3 Storage", + password: "strongpassword123", + type: :AKENEO_PIM, + username: "integration-user" ) assert_pattern do @@ -119,13 +119,13 @@ def test_update_required_params response = @image_kit.accounts.origins.update( "id", - origin: { - accessKey: "AKIATEST123", - bucket: "test-bucket", - name: "My S3 Origin", - secretKey: "secrettest123", - type: :S3 - } + base_url: "https://akeneo.company.com", + client_id: "akeneo-client-id", + client_secret: "akeneo-client-secret", + name: "US S3 Storage", + password: "strongpassword123", + type: :AKENEO_PIM, + username: "integration-user" ) assert_pattern do From f72d995cdc704c59c305fc95bc775b5b64172506 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:29 +0000 Subject: [PATCH 103/178] 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 3fe4c826409b84a416f2e6c08338a85c892da4f3 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:09 +0000 Subject: [PATCH 104/178] 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 7e33e9aac8b85f05c89b2912e216a2f84dcec7fe 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:49 +0000 Subject: [PATCH 105/178] feat(api): extract UpdateFileDetailsRequest to model --- .stats.yml | 2 +- lib/imagekit.rb | 1 + lib/imagekit/models.rb | 2 + lib/imagekit/models/file_update_params.rb | 139 +------- .../models/update_file_details_request.rb | 164 +++++++++ lib/imagekit/resources/files.rb | 25 +- rbi/imagekit/models.rbi | 2 + rbi/imagekit/models/file_update_params.rbi | 235 +------------ .../models/update_file_details_request.rbi | 315 ++++++++++++++++++ rbi/imagekit/resources/files.rbi | 48 +-- sig/imagekit/models.rbs | 2 + sig/imagekit/models/file_update_params.rbs | 90 +---- .../models/update_file_details_request.rbs | 122 +++++++ sig/imagekit/resources/files.rbs | 9 +- 14 files changed, 647 insertions(+), 509 deletions(-) create mode 100644 lib/imagekit/models/update_file_details_request.rb create mode 100644 rbi/imagekit/models/update_file_details_request.rbi create mode 100644 sig/imagekit/models/update_file_details_request.rbs 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/lib/imagekit.rb b/lib/imagekit.rb index c831bf55..863d5586 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -52,6 +52,7 @@ require_relative "imagekit/client" require_relative "imagekit/models/accounts/origin_request" require_relative "imagekit/models/accounts/url_endpoint_request" +require_relative "imagekit/models/update_file_details_request" require_relative "imagekit/models/file" require_relative "imagekit/models/base_overlay" require_relative "imagekit/models/base_webhook_event" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 1792d026..eb9ab9d9 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -132,6 +132,8 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + UpdateFileDetailsRequest = Imagekit::Models::UpdateFileDetailsRequest + UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent UploadPostTransformSuccessEvent = Imagekit::Models::UploadPostTransformSuccessEvent diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index 043a0f24..794b79be 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -7,143 +7,14 @@ class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute custom_coordinates - # 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. + # @!attribute update_file_details_request # - # @return [String, nil] - optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + # @return [Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails, Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus] + required :update_file_details_request, union: -> { Imagekit::UpdateFileDetailsRequest } - # @!attribute custom_metadata - # 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. - # - # @return [Hash{Symbol=>Object}, nil] - optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], - api_name: :customMetadata - - # @!attribute description - # Optional text to describe the contents of the file. - # - # @return [String, nil] - optional :description, String - - # @!attribute extensions - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - # - # @return [Array, nil] - optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } - - # @!attribute remove_ai_tags - # 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. - # - # @return [Array, Symbol, :all, nil] - optional :remove_ai_tags, - union: -> { - Imagekit::FileUpdateParams::RemoveAITags - }, - api_name: :removeAITags - - # @!attribute tags - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - # - # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute webhook_url - # 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 [String, nil] - optional :webhook_url, String, api_name: :webhookUrl - - # @!attribute publish - # Configure the publication status of a file and its versions. - # - # @return [Imagekit::Models::FileUpdateParams::Publish, nil] - optional :publish, -> { Imagekit::FileUpdateParams::Publish } - - # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams} for more details. - # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param description [String] Optional text to describe the contents of the file. - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. - # + # @!method initialize(update_file_details_request:, request_options: {}) + # @param update_file_details_request [Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails, Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus] # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union - - variant -> { Imagekit::Models::FileUpdateParams::RemoveAITags::StringArray } - - variant const: :all - - # @!method self.variants - # @return [Array(Array, Symbol, :all)] - - # @type [Imagekit::Internal::Type::Converter] - StringArray = Imagekit::Internal::Type::ArrayOf[String] - end - - class Publish < Imagekit::Internal::Type::BaseModel - # @!attribute is_published - # Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @return [Boolean] - required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute include_file_versions - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - # - # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions - - # @!method initialize(is_published:, include_file_versions: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams::Publish} for more details. - # - # Configure the publication status of a file and its versions. - # - # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p - end end end end diff --git a/lib/imagekit/models/update_file_details_request.rb b/lib/imagekit/models/update_file_details_request.rb new file mode 100644 index 00000000..b224fc58 --- /dev/null +++ b/lib/imagekit/models/update_file_details_request.rb @@ -0,0 +1,164 @@ +# frozen_string_literal: true + +module Imagekit + module Models + module UpdateFileDetailsRequest + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::UpdateFileDetailsRequest::UpdateFileDetails } + + variant -> { Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus } + + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + # @!attribute custom_coordinates + # 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. + # + # @return [String, nil] + optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true + + # @!attribute custom_metadata + # 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. + # + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + api_name: :customMetadata + + # @!attribute description + # Optional text to describe the contents of the file. + # + # @return [String, nil] + optional :description, String + + # @!attribute extensions + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + # + # @return [Array, nil] + optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } + + # @!attribute remove_ai_tags + # 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. + # + # @return [Array, Symbol, :all, nil] + optional :remove_ai_tags, + union: -> { Imagekit::UpdateFileDetailsRequest::UpdateFileDetails::RemoveAITags }, + api_name: :removeAITags + + # @!attribute tags + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + # + # @return [Array, nil] + optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + + # @!attribute webhook_url + # 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 [String, nil] + optional :webhook_url, String, api_name: :webhookUrl + + # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails} for more + # details. + # + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + + # 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. + # + # @see Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails#remove_ai_tags + module RemoveAITags + extend Imagekit::Internal::Type::Union + + variant -> { Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::RemoveAITags::StringArray } + + variant const: :all + + # @!method self.variants + # @return [Array(Array, Symbol, :all)] + + # @type [Imagekit::Internal::Type::Converter] + StringArray = Imagekit::Internal::Type::ArrayOf[String] + end + end + + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + # @!attribute publish + # Configure the publication status of a file and its versions. + # + # @return [Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus::Publish, nil] + optional :publish, -> { Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish } + + # @!method initialize(publish: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus} for more + # details. + # + # @param publish [Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. + + # @see Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus#publish + class Publish < Imagekit::Internal::Type::BaseModel + # @!attribute is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @return [Boolean] + required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + # + # @return [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + + # @!method initialize(is_published:, include_file_versions: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus::Publish} + # for more details. + # + # Configure the publication status of a file and its versions. + # + # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p + end + end + + # @!method self.variants + # @return [Array(Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails, Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus)] + end + end +end diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 382667c4..356144c0 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -19,33 +19,24 @@ class Files # You can update `tags`, `customCoordinates`, `customMetadata`, publication # status, remove existing `AITags` and apply extensions using this API. # - # @overload update(file_id, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, publish: nil, request_options: {}) + # @overload update(file_id, update_file_details_request:, request_options: {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param description [String] Optional text to describe the contents of the file. - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv - # - # @param publish [Imagekit::Models::FileUpdateParams::Publish] Configure the publication status of a file and its versions. + # @param update_file_details_request [Imagekit::UpdateFileDetailsRequest] # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Imagekit::Models::FileUpdateResponse] # # @see Imagekit::Models::FileUpdateParams - def update(file_id, params = {}) + def update(file_id, params) parsed, options = Imagekit::FileUpdateParams.dump_request(params) + case parsed + in {update_file_details_request: Hash => union, **rest} + parsed = {**rest, **union} + else + end @client.request( method: :patch, path: ["v1/files/%1$s/details", file_id], diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index 75eeb800..a231e8d1 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -100,6 +100,8 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + UpdateFileDetailsRequest = Imagekit::Models::UpdateFileDetailsRequest + UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index 3f8f60e8..7154df5d 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -11,248 +11,43 @@ module Imagekit T.any(Imagekit::FileUpdateParams, Imagekit::Internal::AnyHash) end - # 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. - sig { returns(T.nilable(String)) } - attr_accessor :custom_coordinates - - # 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. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - attr_reader :custom_metadata - - sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } - attr_writer :custom_metadata - - # Optional text to describe the contents of the file. - sig { returns(T.nilable(String)) } - attr_reader :description - - sig { params(description: String).void } - attr_writer :description - - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. sig do returns( - T.nilable( - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension - ) - ] + T.any( + Imagekit::UpdateFileDetailsRequest::UpdateFileDetails, + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus ) ) end - attr_reader :extensions - - sig do - params( - extensions: - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash - ) - ] - ).void - end - attr_writer :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. - sig { returns(T.nilable(T.any(T::Array[String], Symbol))) } - attr_reader :remove_ai_tags - - sig { params(remove_ai_tags: T.any(T::Array[String], Symbol)).void } - attr_writer :remove_ai_tags - - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :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. - sig { returns(T.nilable(String)) } - attr_reader :webhook_url - - sig { params(webhook_url: String).void } - attr_writer :webhook_url - - # Configure the publication status of a file and its versions. - sig { returns(T.nilable(Imagekit::FileUpdateParams::Publish)) } - attr_reader :publish - - sig { params(publish: Imagekit::FileUpdateParams::Publish::OrHash).void } - attr_writer :publish + attr_accessor :update_file_details_request sig do params( - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish::OrHash, + update_file_details_request: + T.any( + Imagekit::UpdateFileDetailsRequest::UpdateFileDetails::OrHash, + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::OrHash + ), request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new( - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, - # Configure the publication status of a file and its versions. - publish: nil, - request_options: {} - ) + def self.new(update_file_details_request:, request_options: {}) end sig do override.returns( { - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish, + update_file_details_request: + T.any( + Imagekit::UpdateFileDetailsRequest::UpdateFileDetails, + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus + ), request_options: Imagekit::RequestOptions } ) end def to_hash end - - # 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. - module RemoveAITags - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(T::Array[String], Symbol) } - - sig do - override.returns( - T::Array[Imagekit::FileUpdateParams::RemoveAITags::Variants] - ) - end - def self.variants - end - - StringArray = - T.let( - Imagekit::Internal::Type::ArrayOf[String], - Imagekit::Internal::Type::Converter - ) - end - - class Publish < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUpdateParams::Publish, - Imagekit::Internal::AnyHash - ) - end - - # Set to `true` to publish the file. Set to `false` to unpublish the file. - sig { returns(T::Boolean) } - attr_accessor :is_published - - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_file_versions - - sig { params(include_file_versions: T::Boolean).void } - attr_writer :include_file_versions - - # Configure the publication status of a file and its versions. - sig do - params( - is_published: T::Boolean, - include_file_versions: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Set to `true` to publish the file. Set to `false` to unpublish the file. - is_published:, - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - include_file_versions: nil - ) - end - - sig do - override.returns( - { is_published: T::Boolean, include_file_versions: T::Boolean } - ) - end - def to_hash - end - end end end end diff --git a/rbi/imagekit/models/update_file_details_request.rbi b/rbi/imagekit/models/update_file_details_request.rbi new file mode 100644 index 00000000..8b8ebba2 --- /dev/null +++ b/rbi/imagekit/models/update_file_details_request.rbi @@ -0,0 +1,315 @@ +# typed: strong + +module Imagekit + module Models + module UpdateFileDetailsRequest + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekit::UpdateFileDetailsRequest::UpdateFileDetails, + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus + ) + end + + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UpdateFileDetailsRequest::UpdateFileDetails, + Imagekit::Internal::AnyHash + ) + end + + # 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. + sig { returns(T.nilable(String)) } + attr_accessor :custom_coordinates + + # 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. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + + # Optional text to describe the contents of the file. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + sig do + returns( + T.nilable( + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension + ) + ] + ) + ) + end + attr_reader :extensions + + sig do + params( + extensions: + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + ) + ] + ).void + end + attr_writer :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. + sig { returns(T.nilable(T.any(T::Array[String], Symbol))) } + attr_reader :remove_ai_tags + + sig { params(remove_ai_tags: T.any(T::Array[String], Symbol)).void } + attr_writer :remove_ai_tags + + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :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. + sig { returns(T.nilable(String)) } + attr_reader :webhook_url + + sig { params(webhook_url: String).void } + attr_writer :webhook_url + + sig do + params( + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + ) + ], + remove_ai_tags: T.any(T::Array[String], Symbol), + tags: T.nilable(T::Array[String]), + webhook_url: String + ).returns(T.attached_class) + end + def self.new( + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil + ) + end + + sig do + override.returns( + { + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg, + Imagekit::ExtensionItem::AIAutoDescription, + Imagekit::ExtensionItem::AutoTaggingExtension + ) + ], + remove_ai_tags: T.any(T::Array[String], Symbol), + tags: T.nilable(T::Array[String]), + webhook_url: String + } + ) + end + def to_hash + end + + # 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. + module RemoveAITags + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(T::Array[String], Symbol) } + + sig do + override.returns( + T::Array[ + Imagekit::UpdateFileDetailsRequest::UpdateFileDetails::RemoveAITags::Variants + ] + ) + end + def self.variants + end + + StringArray = + T.let( + Imagekit::Internal::Type::ArrayOf[String], + Imagekit::Internal::Type::Converter + ) + end + end + + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus, + Imagekit::Internal::AnyHash + ) + end + + # Configure the publication status of a file and its versions. + sig do + returns( + T.nilable( + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish + ) + ) + end + attr_reader :publish + + sig do + params( + publish: + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish::OrHash + ).void + end + attr_writer :publish + + sig do + params( + publish: + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish::OrHash + ).returns(T.attached_class) + end + def self.new( + # Configure the publication status of a file and its versions. + publish: nil + ) + end + + sig do + override.returns( + { + publish: + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish + } + ) + end + def to_hash + end + + class Publish < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish, + Imagekit::Internal::AnyHash + ) + end + + # Set to `true` to publish the file. Set to `false` to unpublish the file. + sig { returns(T::Boolean) } + attr_accessor :is_published + + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions + + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions + + # Configure the publication status of a file and its versions. + sig do + params( + is_published: T::Boolean, + include_file_versions: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Set to `true` to publish the file. Set to `false` to unpublish the file. + is_published:, + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + include_file_versions: nil + ) + end + + sig do + override.returns( + { is_published: T::Boolean, include_file_versions: T::Boolean } + ) + end + def to_hash + end + end + end + + sig do + override.returns(T::Array[Imagekit::UpdateFileDetailsRequest::Variants]) + end + def self.variants + end + end + end +end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index b8c6513c..33e7e9e3 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -18,21 +18,7 @@ module Imagekit sig do params( file_id: String, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish::OrHash, + update_file_details_request: Imagekit::UpdateFileDetailsRequest, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::FileUpdateResponse) end @@ -40,37 +26,7 @@ module Imagekit # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. file_id, - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, - # Configure the publication status of a file and its versions. - publish: nil, + update_file_details_request:, request_options: {} ) end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 8228a4e3..51c5af26 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -91,6 +91,8 @@ module Imagekit module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent + module UpdateFileDetailsRequest = Imagekit::Models::UpdateFileDetailsRequest + class UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent class UploadPostTransformSuccessEvent = Imagekit::Models::UploadPostTransformSuccessEvent diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index dad939dc..cb64fd0e 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -2,14 +2,7 @@ module Imagekit module Models type file_update_params = { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: Imagekit::Models::extensions, - remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish + update_file_details_request: Imagekit::Models::update_file_details_request } & Imagekit::Internal::Type::request_parameters @@ -17,90 +10,21 @@ module Imagekit extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - attr_accessor custom_coordinates: String? + def update_file_details_request: -> Imagekit::Models::update_file_details_request - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader extensions: Imagekit::Models::extensions? - - def extensions=: ( - Imagekit::Models::extensions - ) -> Imagekit::Models::extensions - - attr_reader remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags? - - def remove_ai_tags=: ( - Imagekit::Models::FileUpdateParams::remove_ai_tags - ) -> Imagekit::Models::FileUpdateParams::remove_ai_tags - - attr_accessor tags: ::Array[String]? - - attr_reader webhook_url: String? - - def webhook_url=: (String) -> String - - attr_reader publish: Imagekit::FileUpdateParams::Publish? - - def publish=: ( - Imagekit::FileUpdateParams::Publish - ) -> Imagekit::FileUpdateParams::Publish + def update_file_details_request=: ( + Imagekit::Models::update_file_details_request _ + ) -> Imagekit::Models::update_file_details_request def initialize: ( - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: Imagekit::Models::extensions, - ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, - ?publish: Imagekit::FileUpdateParams::Publish, + update_file_details_request: Imagekit::Models::update_file_details_request, ?request_options: Imagekit::request_opts ) -> void def to_hash: -> { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: Imagekit::Models::extensions, - remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String, - publish: Imagekit::FileUpdateParams::Publish, + update_file_details_request: Imagekit::Models::update_file_details_request, request_options: Imagekit::RequestOptions } - - type remove_ai_tags = ::Array[String] | :all - - module RemoveAITags - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUpdateParams::remove_ai_tags] - - StringArray: Imagekit::Internal::Type::Converter - end - - type publish = { is_published: bool, include_file_versions: bool } - - class Publish < Imagekit::Internal::Type::BaseModel - attr_accessor is_published: bool - - attr_reader include_file_versions: bool? - - def include_file_versions=: (bool) -> bool - - def initialize: ( - is_published: bool, - ?include_file_versions: bool - ) -> void - - def to_hash: -> { is_published: bool, include_file_versions: bool } - end end end end diff --git a/sig/imagekit/models/update_file_details_request.rbs b/sig/imagekit/models/update_file_details_request.rbs new file mode 100644 index 00000000..47c46027 --- /dev/null +++ b/sig/imagekit/models/update_file_details_request.rbs @@ -0,0 +1,122 @@ +module Imagekit + module Models + type update_file_details_request = + Imagekit::UpdateFileDetailsRequest::UpdateFileDetails + | Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus + + module UpdateFileDetailsRequest + extend Imagekit::Internal::Type::Union + + type update_file_details = + { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: Imagekit::Models::extensions, + remove_ai_tags: Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String + } + + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader extensions: Imagekit::Models::extensions? + + def extensions=: ( + Imagekit::Models::extensions + ) -> Imagekit::Models::extensions + + attr_reader remove_ai_tags: Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags? + + def remove_ai_tags=: ( + Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags + ) -> Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags + + attr_accessor tags: ::Array[String]? + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + def initialize: ( + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: Imagekit::Models::extensions, + ?remove_ai_tags: Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String + ) -> void + + def to_hash: -> { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: Imagekit::Models::extensions, + remove_ai_tags: Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String + } + + type remove_ai_tags = ::Array[String] | :all + + module RemoveAITags + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags] + + StringArray: Imagekit::Internal::Type::Converter + end + end + + type change_publication_status = + { + publish: Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish + } + + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + attr_reader publish: Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish? + + def publish=: ( + Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish + ) -> Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish + + def initialize: ( + ?publish: Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish + ) -> void + + def to_hash: -> { + publish: Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish + } + + type publish = { is_published: bool, include_file_versions: bool } + + class Publish < Imagekit::Internal::Type::BaseModel + attr_accessor is_published: bool + + attr_reader include_file_versions: bool? + + def include_file_versions=: (bool) -> bool + + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void + + def to_hash: -> { is_published: bool, include_file_versions: bool } + end + end + + def self?.variants: -> ::Array[Imagekit::Models::update_file_details_request] + end + end +end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 496acf8f..973f26df 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -9,14 +9,7 @@ module Imagekit def update: ( String file_id, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: Imagekit::Models::extensions, - ?remove_ai_tags: Imagekit::Models::FileUpdateParams::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, - ?publish: Imagekit::FileUpdateParams::Publish, + update_file_details_request: Imagekit::Models::UpdateFileDetailsRequest, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::FileUpdateResponse From 359a2f15c6a0cb67b4e4c93c90656d85b771a32c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 18 Sep 2025 02:15:59 +0000 Subject: [PATCH 106/178] feat: expose response headers for both streams and errors --- lib/imagekit/errors.rb | 36 +++++++++++++------ .../internal/transport/base_client.rb | 18 ++++++---- lib/imagekit/internal/type/base_page.rb | 2 +- lib/imagekit/internal/util.rb | 2 +- rbi/imagekit/errors.rbi | 31 ++++++++++++++-- .../internal/transport/base_client.rbi | 9 +++-- rbi/imagekit/internal/type/base_page.rbi | 2 +- rbi/imagekit/internal/util.rbi | 2 +- sig/imagekit/errors.rbs | 7 ++++ 9 files changed, 80 insertions(+), 29 deletions(-) diff --git a/lib/imagekit/errors.rb b/lib/imagekit/errors.rb index b61fb677..354509a3 100644 --- a/lib/imagekit/errors.rb +++ b/lib/imagekit/errors.rb @@ -40,6 +40,9 @@ class APIError < Imagekit::Errors::Error # @return [Integer, nil] attr_accessor :status + # @return [Hash{String=>String}, nil] + attr_accessor :headers + # @return [Object, nil] attr_accessor :body @@ -47,13 +50,15 @@ class APIError < Imagekit::Errors::Error # # @param url [URI::Generic] # @param status [Integer, nil] + # @param headers [Hash{String=>String}, nil] # @param body [Object, nil] # @param request [nil] # @param response [nil] # @param message [String, nil] - def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil) + def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil) @url = url @status = status + @headers = headers @body = body @request = request @response = response @@ -74,6 +79,7 @@ class APIConnectionError < Imagekit::Errors::APIError # # @param url [URI::Generic] # @param status [nil] + # @param headers [Hash{String=>String}, nil] # @param body [nil] # @param request [nil] # @param response [nil] @@ -81,6 +87,7 @@ class APIConnectionError < Imagekit::Errors::APIError def initialize( url:, status: nil, + headers: nil, body: nil, request: nil, response: nil, @@ -95,6 +102,7 @@ class APITimeoutError < Imagekit::Errors::APIConnectionError # # @param url [URI::Generic] # @param status [nil] + # @param headers [Hash{String=>String}, nil] # @param body [nil] # @param request [nil] # @param response [nil] @@ -102,6 +110,7 @@ class APITimeoutError < Imagekit::Errors::APIConnectionError def initialize( url:, status: nil, + headers: nil, body: nil, request: nil, response: nil, @@ -116,21 +125,24 @@ class APIStatusError < Imagekit::Errors::APIError # # @param url [URI::Generic] # @param status [Integer] + # @param headers [Hash{String=>String}, nil] # @param body [Object, nil] # @param request [nil] # @param response [nil] # @param message [String, nil] # # @return [self] - def self.for(url:, status:, body:, request:, response:, message: nil) - kwargs = { - url: url, - status: status, - body: body, - request: request, - response: response, - message: message - } + def self.for(url:, status:, headers:, body:, request:, response:, message: nil) + kwargs = + { + url: url, + status: status, + headers: headers, + body: body, + request: request, + response: response, + message: message + } case status in 400 @@ -162,15 +174,17 @@ def self.for(url:, status:, body:, request:, response:, message: nil) # # @param url [URI::Generic] # @param status [Integer] + # @param headers [Hash{String=>String}, nil] # @param body [Object, nil] # @param request [nil] # @param response [nil] # @param message [String, nil] - def initialize(url:, status:, body:, request:, response:, message: nil) + def initialize(url:, status:, headers:, body:, request:, response:, message: nil) message ||= {url: url.to_s, status: status, body: body} super( url: url, status: status, + headers: headers, body: body, request: request, response: response, diff --git a/lib/imagekit/internal/transport/base_client.rb b/lib/imagekit/internal/transport/base_client.rb index 3bab4fc6..222a48cf 100644 --- a/lib/imagekit/internal/transport/base_client.rb +++ b/lib/imagekit/internal/transport/base_client.rb @@ -47,7 +47,7 @@ def validate!(req) # @api private # # @param status [Integer] - # @param headers [Hash{String=>String}, Net::HTTPHeader] + # @param headers [Hash{String=>String}] # # @return [Boolean] def should_retry?(status, headers:) @@ -85,7 +85,7 @@ def should_retry?(status, headers:) # # @param status [Integer] # - # @param response_headers [Hash{String=>String}, Net::HTTPHeader] + # @param response_headers [Hash{String=>String}] # # @return [Hash{Symbol=>Object}] def follow_redirect(request, status:, response_headers:) @@ -378,6 +378,7 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) rescue Imagekit::Errors::APIConnectionError => e status = e end + headers = Imagekit::Internal::Util.normalized_headers(response&.each_header&.to_h) case status in ..299 @@ -390,7 +391,7 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) in 300..399 self.class.reap_connection!(status, stream: stream) - request = self.class.follow_redirect(request, status: status, response_headers: response) + request = self.class.follow_redirect(request, status: status, response_headers: headers) send_request( request, redirect_count: redirect_count + 1, @@ -399,9 +400,9 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) ) in Imagekit::Errors::APIConnectionError if retry_count >= max_retries raise status - in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response) + in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers) decoded = Kernel.then do - Imagekit::Internal::Util.decode_content(response, stream: stream, suppress_error: true) + Imagekit::Internal::Util.decode_content(headers, stream: stream, suppress_error: true) ensure self.class.reap_connection!(status, stream: stream) end @@ -409,6 +410,7 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) raise Imagekit::Errors::APIStatusError.for( url: url, status: status, + headers: headers, body: decoded, request: nil, response: response @@ -485,19 +487,21 @@ def request(req) send_retry_header: send_retry_header ) - decoded = Imagekit::Internal::Util.decode_content(response, stream: stream) + headers = Imagekit::Internal::Util.normalized_headers(response.each_header.to_h) + decoded = Imagekit::Internal::Util.decode_content(headers, stream: stream) case req in {stream: Class => st} st.new( model: model, url: url, status: status, + headers: headers, response: response, unwrap: unwrap, stream: decoded ) in {page: Class => page} - page.new(client: self, req: req, headers: response, page_data: decoded) + page.new(client: self, req: req, headers: headers, page_data: decoded) else unwrapped = Imagekit::Internal::Util.dig(decoded, unwrap) Imagekit::Internal::Type::Converter.coerce(model, unwrapped) diff --git a/lib/imagekit/internal/type/base_page.rb b/lib/imagekit/internal/type/base_page.rb index f216334d..37df829b 100644 --- a/lib/imagekit/internal/type/base_page.rb +++ b/lib/imagekit/internal/type/base_page.rb @@ -39,7 +39,7 @@ def to_enum = super(:auto_paging_each) # # @param client [Imagekit::Internal::Transport::BaseClient] # @param req [Hash{Symbol=>Object}] - # @param headers [Hash{String=>String}, Net::HTTPHeader] + # @param headers [Hash{String=>String}] # @param page_data [Object] def initialize(client:, req:, headers:, page_data:) @client = client diff --git a/lib/imagekit/internal/util.rb b/lib/imagekit/internal/util.rb index e1561bc5..14ac714a 100644 --- a/lib/imagekit/internal/util.rb +++ b/lib/imagekit/internal/util.rb @@ -647,7 +647,7 @@ def force_charset!(content_type, text:) # # Assumes each chunk in stream has `Encoding::BINARY`. # - # @param headers [Hash{String=>String}, Net::HTTPHeader] + # @param headers [Hash{String=>String}] # @param stream [Enumerable] # @param suppress_error [Boolean] # diff --git a/rbi/imagekit/errors.rbi b/rbi/imagekit/errors.rbi index 733211e0..c39dffaf 100644 --- a/rbi/imagekit/errors.rbi +++ b/rbi/imagekit/errors.rbi @@ -33,6 +33,9 @@ module Imagekit sig { returns(T.nilable(Integer)) } attr_accessor :status + sig { returns(T.nilable(T::Hash[String, String])) } + attr_accessor :headers + sig { returns(T.nilable(T.anything)) } attr_accessor :body @@ -41,6 +44,7 @@ module Imagekit params( url: URI::Generic, status: T.nilable(Integer), + headers: T.nilable(T::Hash[String, String]), body: T.nilable(Object), request: NilClass, response: NilClass, @@ -50,6 +54,7 @@ module Imagekit def self.new( url:, status: nil, + headers: nil, body: nil, request: nil, response: nil, @@ -70,6 +75,7 @@ module Imagekit params( url: URI::Generic, status: NilClass, + headers: T.nilable(T::Hash[String, String]), body: NilClass, request: NilClass, response: NilClass, @@ -79,6 +85,7 @@ module Imagekit def self.new( url:, status: nil, + headers: nil, body: nil, request: nil, response: nil, @@ -93,6 +100,7 @@ module Imagekit params( url: URI::Generic, status: NilClass, + headers: T.nilable(T::Hash[String, String]), body: NilClass, request: NilClass, response: NilClass, @@ -102,6 +110,7 @@ module Imagekit def self.new( url:, status: nil, + headers: nil, body: nil, request: nil, response: nil, @@ -116,13 +125,22 @@ module Imagekit params( url: URI::Generic, status: Integer, + headers: T.nilable(T::Hash[String, String]), body: T.nilable(Object), request: NilClass, response: NilClass, message: T.nilable(String) ).returns(T.attached_class) end - def self.for(url:, status:, body:, request:, response:, message: nil) + def self.for( + url:, + status:, + headers:, + body:, + request:, + response:, + message: nil + ) end sig { returns(Integer) } @@ -133,13 +151,22 @@ module Imagekit params( url: URI::Generic, status: Integer, + headers: T.nilable(T::Hash[String, String]), body: T.nilable(Object), request: NilClass, response: NilClass, message: T.nilable(String) ).returns(T.attached_class) end - def self.new(url:, status:, body:, request:, response:, message: nil) + def self.new( + url:, + status:, + headers:, + body:, + request:, + response:, + message: nil + ) end end diff --git a/rbi/imagekit/internal/transport/base_client.rbi b/rbi/imagekit/internal/transport/base_client.rbi index 3e5fda85..1c4bbe6b 100644 --- a/rbi/imagekit/internal/transport/base_client.rbi +++ b/rbi/imagekit/internal/transport/base_client.rbi @@ -84,10 +84,9 @@ module Imagekit # @api private sig do - params( - status: Integer, - headers: T.any(T::Hash[String, String], Net::HTTPHeader) - ).returns(T::Boolean) + params(status: Integer, headers: T::Hash[String, String]).returns( + T::Boolean + ) end def should_retry?(status, headers:) end @@ -97,7 +96,7 @@ module Imagekit params( request: Imagekit::Internal::Transport::BaseClient::RequestInput, status: Integer, - response_headers: T.any(T::Hash[String, String], Net::HTTPHeader) + response_headers: T::Hash[String, String] ).returns(Imagekit::Internal::Transport::BaseClient::RequestInput) end def follow_redirect(request, status:, response_headers:) diff --git a/rbi/imagekit/internal/type/base_page.rbi b/rbi/imagekit/internal/type/base_page.rbi index dab911be..b720ff81 100644 --- a/rbi/imagekit/internal/type/base_page.rbi +++ b/rbi/imagekit/internal/type/base_page.rbi @@ -30,7 +30,7 @@ module Imagekit params( client: Imagekit::Internal::Transport::BaseClient, req: Imagekit::Internal::Transport::BaseClient::RequestComponents, - headers: T.any(T::Hash[String, String], Net::HTTPHeader), + headers: T::Hash[String, String], page_data: T.anything ).void end diff --git a/rbi/imagekit/internal/util.rbi b/rbi/imagekit/internal/util.rbi index 268628ae..808c028d 100644 --- a/rbi/imagekit/internal/util.rbi +++ b/rbi/imagekit/internal/util.rbi @@ -361,7 +361,7 @@ module Imagekit # Assumes each chunk in stream has `Encoding::BINARY`. sig do params( - headers: T.any(T::Hash[String, String], Net::HTTPHeader), + headers: T::Hash[String, String], stream: T::Enumerable[String], suppress_error: T::Boolean ).returns(T.anything) diff --git a/sig/imagekit/errors.rbs b/sig/imagekit/errors.rbs index 40508602..c24034f6 100644 --- a/sig/imagekit/errors.rbs +++ b/sig/imagekit/errors.rbs @@ -21,11 +21,14 @@ module Imagekit attr_accessor status: Integer? + attr_accessor headers: ::Hash[String, String]? + attr_accessor body: top? def initialize: ( url: URI::Generic, ?status: Integer?, + ?headers: ::Hash[String, String]?, ?body: Object?, ?request: nil, ?response: nil, @@ -37,6 +40,7 @@ module Imagekit def initialize: ( url: URI::Generic, ?status: nil, + ?headers: ::Hash[String, String]?, ?body: nil, ?request: nil, ?response: nil, @@ -48,6 +52,7 @@ module Imagekit def initialize: ( url: URI::Generic, ?status: nil, + ?headers: ::Hash[String, String]?, ?body: nil, ?request: nil, ?response: nil, @@ -59,6 +64,7 @@ module Imagekit def self.for: ( url: URI::Generic, status: Integer, + headers: ::Hash[String, String]?, body: Object?, request: nil, response: nil, @@ -68,6 +74,7 @@ module Imagekit def initialize: ( url: URI::Generic, status: Integer, + headers: ::Hash[String, String]?, body: Object?, request: nil, response: nil, From edd0585e83aeffcecbb9c0a1ad12213025e7f21d 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:57:59 +0000 Subject: [PATCH 107/178] feat(api): manual updates --- .stats.yml | 6 +- lib/imagekit.rb | 2 +- lib/imagekit/models.rb | 2 +- lib/imagekit/models/file_update_params.rb | 10 +- ...ails_request.rb => update_file_request.rb} | 60 ++------- lib/imagekit/resources/files.rb | 23 +++- rbi/imagekit/models.rbi | 2 +- rbi/imagekit/models/file_update_params.rbi | 36 +----- ...ls_request.rbi => update_file_request.rbi} | 113 +--------------- rbi/imagekit/resources/files.rbi | 47 ++++++- sig/imagekit/models.rbs | 2 +- sig/imagekit/models/file_update_params.rbs | 23 +--- .../models/update_file_details_request.rbs | 122 ------------------ sig/imagekit/models/update_file_request.rbs | 83 ++++++++++++ sig/imagekit/resources/files.rbs | 9 +- test/imagekit/resources/files_test.rb | 2 +- 16 files changed, 186 insertions(+), 356 deletions(-) rename lib/imagekit/models/{update_file_details_request.rb => update_file_request.rb} (63%) rename rbi/imagekit/models/{update_file_details_request.rbi => update_file_request.rbi} (68%) delete mode 100644 sig/imagekit/models/update_file_details_request.rbs create mode 100644 sig/imagekit/models/update_file_request.rbs 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/lib/imagekit.rb b/lib/imagekit.rb index 863d5586..a6f92b0c 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -52,7 +52,7 @@ require_relative "imagekit/client" require_relative "imagekit/models/accounts/origin_request" require_relative "imagekit/models/accounts/url_endpoint_request" -require_relative "imagekit/models/update_file_details_request" +require_relative "imagekit/models/update_file_request" require_relative "imagekit/models/file" require_relative "imagekit/models/base_overlay" require_relative "imagekit/models/base_webhook_event" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index eb9ab9d9..03ac79a0 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -132,7 +132,7 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - UpdateFileDetailsRequest = Imagekit::Models::UpdateFileDetailsRequest + UpdateFileRequest = Imagekit::Models::UpdateFileRequest UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index 794b79be..fd8c7342 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -3,17 +3,11 @@ module Imagekit module Models # @see Imagekit::Resources::Files#update - class FileUpdateParams < Imagekit::Internal::Type::BaseModel + class FileUpdateParams < Imagekit::Models::UpdateFileRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!attribute update_file_details_request - # - # @return [Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails, Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus] - required :update_file_details_request, union: -> { Imagekit::UpdateFileDetailsRequest } - - # @!method initialize(update_file_details_request:, request_options: {}) - # @param update_file_details_request [Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails, Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus] + # @!method initialize(request_options: {}) # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/imagekit/models/update_file_details_request.rb b/lib/imagekit/models/update_file_request.rb similarity index 63% rename from lib/imagekit/models/update_file_details_request.rb rename to lib/imagekit/models/update_file_request.rb index b224fc58..fc200a35 100644 --- a/lib/imagekit/models/update_file_details_request.rb +++ b/lib/imagekit/models/update_file_request.rb @@ -2,12 +2,13 @@ module Imagekit module Models - module UpdateFileDetailsRequest + # Schema for update file update request. + module UpdateFileRequest extend Imagekit::Internal::Type::Union - variant -> { Imagekit::UpdateFileDetailsRequest::UpdateFileDetails } + variant -> { Imagekit::UpdateFileRequest::UpdateFileDetails } - variant -> { Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus } + variant Imagekit::Internal::Type::Unknown class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # @!attribute custom_coordinates @@ -52,7 +53,7 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # # @return [Array, Symbol, :all, nil] optional :remove_ai_tags, - union: -> { Imagekit::UpdateFileDetailsRequest::UpdateFileDetails::RemoveAITags }, + union: -> { Imagekit::UpdateFileRequest::UpdateFileDetails::RemoveAITags }, api_name: :removeAITags # @!attribute tags @@ -73,8 +74,7 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails} for more - # details. + # {Imagekit::Models::UpdateFileRequest::UpdateFileDetails} for more details. # # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, # @@ -99,11 +99,11 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # Note: The remove operation for `AITags` executes before any of the `extensions` # are processed. # - # @see Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails#remove_ai_tags + # @see Imagekit::Models::UpdateFileRequest::UpdateFileDetails#remove_ai_tags module RemoveAITags extend Imagekit::Internal::Type::Union - variant -> { Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::RemoveAITags::StringArray } + variant -> { Imagekit::Models::UpdateFileRequest::UpdateFileDetails::RemoveAITags::StringArray } variant const: :all @@ -115,50 +115,8 @@ module RemoveAITags end end - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - # @!attribute publish - # Configure the publication status of a file and its versions. - # - # @return [Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus::Publish, nil] - optional :publish, -> { Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish } - - # @!method initialize(publish: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus} for more - # details. - # - # @param publish [Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. - - # @see Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus#publish - class Publish < Imagekit::Internal::Type::BaseModel - # @!attribute is_published - # Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @return [Boolean] - required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished - - # @!attribute include_file_versions - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - # - # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions - - # @!method initialize(is_published:, include_file_versions: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus::Publish} - # for more details. - # - # Configure the publication status of a file and its versions. - # - # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. - # - # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p - end - end - # @!method self.variants - # @return [Array(Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails, Imagekit::Models::UpdateFileDetailsRequest::ChangePublicationStatus)] + # @return [Array(Imagekit::Models::UpdateFileRequest::UpdateFileDetails, Object)] end end end diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 356144c0..9960c440 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -19,11 +19,25 @@ class Files # You can update `tags`, `customCoordinates`, `customMetadata`, publication # status, remove existing `AITags` and apply extensions using this API. # - # @overload update(file_id, update_file_details_request:, request_options: {}) + # @overload update(file_id, body:, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, request_options: {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param update_file_details_request [Imagekit::UpdateFileDetailsRequest] + # @param body [Object] + # + # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, + # + # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va + # + # @param description [String] Optional text to describe the contents of the file. + # + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # + # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car + # + # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul + # + # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -32,11 +46,6 @@ class Files # @see Imagekit::Models::FileUpdateParams def update(file_id, params) parsed, options = Imagekit::FileUpdateParams.dump_request(params) - case parsed - in {update_file_details_request: Hash => union, **rest} - parsed = {**rest, **union} - else - end @client.request( method: :patch, path: ["v1/files/%1$s/details", file_id], diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index a231e8d1..e8fe39e0 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -100,7 +100,7 @@ module Imagekit UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - UpdateFileDetailsRequest = Imagekit::Models::UpdateFileDetailsRequest + UpdateFileRequest = Imagekit::Models::UpdateFileRequest UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index 7154df5d..a88e63be 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class FileUpdateParams < Imagekit::Internal::Type::BaseModel + class FileUpdateParams < Imagekit::Models::UpdateFileRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -12,40 +12,14 @@ module Imagekit end sig do - returns( - T.any( - Imagekit::UpdateFileDetailsRequest::UpdateFileDetails, - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus - ) + params(request_options: Imagekit::RequestOptions::OrHash).returns( + T.attached_class ) end - attr_accessor :update_file_details_request - - sig do - params( - update_file_details_request: - T.any( - Imagekit::UpdateFileDetailsRequest::UpdateFileDetails::OrHash, - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new(update_file_details_request:, request_options: {}) + def self.new(request_options: {}) end - sig do - override.returns( - { - update_file_details_request: - T.any( - Imagekit::UpdateFileDetailsRequest::UpdateFileDetails, - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus - ), - request_options: Imagekit::RequestOptions - } - ) - end + sig { override.returns({ request_options: Imagekit::RequestOptions }) } def to_hash end end diff --git a/rbi/imagekit/models/update_file_details_request.rbi b/rbi/imagekit/models/update_file_request.rbi similarity index 68% rename from rbi/imagekit/models/update_file_details_request.rbi rename to rbi/imagekit/models/update_file_request.rbi index 8b8ebba2..c345c856 100644 --- a/rbi/imagekit/models/update_file_details_request.rbi +++ b/rbi/imagekit/models/update_file_request.rbi @@ -2,22 +2,20 @@ module Imagekit module Models - module UpdateFileDetailsRequest + # Schema for update file update request. + module UpdateFileRequest extend Imagekit::Internal::Type::Union Variants = T.type_alias do - T.any( - Imagekit::UpdateFileDetailsRequest::UpdateFileDetails, - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus - ) + T.any(Imagekit::UpdateFileRequest::UpdateFileDetails, T.anything) end class UpdateFileDetails < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UpdateFileDetailsRequest::UpdateFileDetails, + Imagekit::UpdateFileRequest::UpdateFileDetails, Imagekit::Internal::AnyHash ) end @@ -193,7 +191,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::UpdateFileDetailsRequest::UpdateFileDetails::RemoveAITags::Variants + Imagekit::UpdateFileRequest::UpdateFileDetails::RemoveAITags::Variants ] ) end @@ -208,106 +206,7 @@ module Imagekit end end - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus, - Imagekit::Internal::AnyHash - ) - end - - # Configure the publication status of a file and its versions. - sig do - returns( - T.nilable( - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish - ) - ) - end - attr_reader :publish - - sig do - params( - publish: - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish::OrHash - ).void - end - attr_writer :publish - - sig do - params( - publish: - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish::OrHash - ).returns(T.attached_class) - end - def self.new( - # Configure the publication status of a file and its versions. - publish: nil - ) - end - - sig do - override.returns( - { - publish: - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish - } - ) - end - def to_hash - end - - class Publish < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish, - Imagekit::Internal::AnyHash - ) - end - - # Set to `true` to publish the file. Set to `false` to unpublish the file. - sig { returns(T::Boolean) } - attr_accessor :is_published - - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :include_file_versions - - sig { params(include_file_versions: T::Boolean).void } - attr_writer :include_file_versions - - # Configure the publication status of a file and its versions. - sig do - params( - is_published: T::Boolean, - include_file_versions: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Set to `true` to publish the file. Set to `false` to unpublish the file. - is_published:, - # Set to `true` to publish/unpublish all versions of the file. Set to `false` to - # publish/unpublish only the current version of the file. - include_file_versions: nil - ) - end - - sig do - override.returns( - { is_published: T::Boolean, include_file_versions: T::Boolean } - ) - end - def to_hash - end - end - end - - sig do - override.returns(T::Array[Imagekit::UpdateFileDetailsRequest::Variants]) - end + sig { override.returns(T::Array[Imagekit::UpdateFileRequest::Variants]) } def self.variants end end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index 33e7e9e3..d5522618 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -18,7 +18,21 @@ module Imagekit sig do params( file_id: String, - update_file_details_request: Imagekit::UpdateFileDetailsRequest, + body: T.anything, + custom_coordinates: T.nilable(String), + custom_metadata: T::Hash[Symbol, T.anything], + description: String, + extensions: + T::Array[ + T.any( + Imagekit::ExtensionItem::RemoveBg::OrHash, + Imagekit::ExtensionItem::AIAutoDescription::OrHash, + Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + ) + ], + remove_ai_tags: T.any(T::Array[String], Symbol), + tags: T.nilable(T::Array[String]), + webhook_url: String, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::FileUpdateResponse) end @@ -26,7 +40,36 @@ module Imagekit # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. file_id, - update_file_details_request:, + body:, + # 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. + custom_coordinates: nil, + # 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. + custom_metadata: nil, + # Optional text to describe the contents of the file. + description: nil, + # Array of extensions to be applied to the asset. Each extension can be configured + # with specific parameters based on the extension type. + extensions: nil, + # 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. + remove_ai_tags: nil, + # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send + # `null` to unset all tags associated with the file. + tags: nil, + # 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. + webhook_url: nil, request_options: {} ) end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index 51c5af26..bd520b8e 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -91,7 +91,7 @@ module Imagekit module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - module UpdateFileDetailsRequest = Imagekit::Models::UpdateFileDetailsRequest + module UpdateFileRequest = Imagekit::Models::UpdateFileRequest class UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index cb64fd0e..3bc2f7c8 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -1,30 +1,15 @@ module Imagekit module Models type file_update_params = - { - update_file_details_request: Imagekit::Models::update_file_details_request - } - & Imagekit::Internal::Type::request_parameters + { } & Imagekit::Internal::Type::request_parameters - class FileUpdateParams < Imagekit::Internal::Type::BaseModel + class FileUpdateParams < Imagekit::Models::UpdateFileRequest extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - def update_file_details_request: -> Imagekit::Models::update_file_details_request + def initialize: (?request_options: Imagekit::request_opts) -> void - def update_file_details_request=: ( - Imagekit::Models::update_file_details_request _ - ) -> Imagekit::Models::update_file_details_request - - def initialize: ( - update_file_details_request: Imagekit::Models::update_file_details_request, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - update_file_details_request: Imagekit::Models::update_file_details_request, - request_options: Imagekit::RequestOptions - } + def to_hash: -> { request_options: Imagekit::RequestOptions } end end end diff --git a/sig/imagekit/models/update_file_details_request.rbs b/sig/imagekit/models/update_file_details_request.rbs deleted file mode 100644 index 47c46027..00000000 --- a/sig/imagekit/models/update_file_details_request.rbs +++ /dev/null @@ -1,122 +0,0 @@ -module Imagekit - module Models - type update_file_details_request = - Imagekit::UpdateFileDetailsRequest::UpdateFileDetails - | Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus - - module UpdateFileDetailsRequest - extend Imagekit::Internal::Type::Union - - type update_file_details = - { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: Imagekit::Models::extensions, - remove_ai_tags: Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String - } - - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader extensions: Imagekit::Models::extensions? - - def extensions=: ( - Imagekit::Models::extensions - ) -> Imagekit::Models::extensions - - attr_reader remove_ai_tags: Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags? - - def remove_ai_tags=: ( - Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags - ) -> Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags - - attr_accessor tags: ::Array[String]? - - attr_reader webhook_url: String? - - def webhook_url=: (String) -> String - - def initialize: ( - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: Imagekit::Models::extensions, - ?remove_ai_tags: Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String - ) -> void - - def to_hash: -> { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: Imagekit::Models::extensions, - remove_ai_tags: Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String - } - - type remove_ai_tags = ::Array[String] | :all - - module RemoveAITags - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::UpdateFileDetailsRequest::UpdateFileDetails::remove_ai_tags] - - StringArray: Imagekit::Internal::Type::Converter - end - end - - type change_publication_status = - { - publish: Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish - } - - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - attr_reader publish: Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish? - - def publish=: ( - Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish - ) -> Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish - - def initialize: ( - ?publish: Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish - ) -> void - - def to_hash: -> { - publish: Imagekit::UpdateFileDetailsRequest::ChangePublicationStatus::Publish - } - - type publish = { is_published: bool, include_file_versions: bool } - - class Publish < Imagekit::Internal::Type::BaseModel - attr_accessor is_published: bool - - attr_reader include_file_versions: bool? - - def include_file_versions=: (bool) -> bool - - def initialize: ( - is_published: bool, - ?include_file_versions: bool - ) -> void - - def to_hash: -> { is_published: bool, include_file_versions: bool } - end - end - - def self?.variants: -> ::Array[Imagekit::Models::update_file_details_request] - end - end -end diff --git a/sig/imagekit/models/update_file_request.rbs b/sig/imagekit/models/update_file_request.rbs new file mode 100644 index 00000000..218023a8 --- /dev/null +++ b/sig/imagekit/models/update_file_request.rbs @@ -0,0 +1,83 @@ +module Imagekit + module Models + type update_file_request = + Imagekit::UpdateFileRequest::UpdateFileDetails | top + + module UpdateFileRequest + extend Imagekit::Internal::Type::Union + + type update_file_details = + { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: Imagekit::Models::extensions, + remove_ai_tags: Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String + } + + class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader extensions: Imagekit::Models::extensions? + + def extensions=: ( + Imagekit::Models::extensions + ) -> Imagekit::Models::extensions + + attr_reader remove_ai_tags: Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags? + + def remove_ai_tags=: ( + Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags + ) -> Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags + + attr_accessor tags: ::Array[String]? + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + def initialize: ( + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: Imagekit::Models::extensions, + ?remove_ai_tags: Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String + ) -> void + + def to_hash: -> { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: Imagekit::Models::extensions, + remove_ai_tags: Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String + } + + type remove_ai_tags = ::Array[String] | :all + + module RemoveAITags + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags] + + StringArray: Imagekit::Internal::Type::Converter + end + end + + def self?.variants: -> ::Array[Imagekit::Models::update_file_request] + end + end +end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 973f26df..22bf487b 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -9,7 +9,14 @@ module Imagekit def update: ( String file_id, - update_file_details_request: Imagekit::Models::UpdateFileDetailsRequest, + body: top, + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: Imagekit::Models::extensions, + ?remove_ai_tags: Imagekit::Models::UpdateFileRequest::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::FileUpdateResponse diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index c09eb4bb..dc229400 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -6,7 +6,7 @@ class Imagekit::Test::Resources::FilesTest < Imagekit::Test::ResourceTest def test_update skip("Prism tests are disabled") - response = @image_kit.files.update("fileId") + response = @image_kit.files.update("fileId", body: {}) assert_pattern do response => Imagekit::Models::FileUpdateResponse From 416f19e4bf2ae3c005a832bb0b0fe126693622a5 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:32 +0000 Subject: [PATCH 108/178] feat(api): manual updates --- .stats.yml | 4 +- lib/imagekit/models/file_update_params.rb | 12 ++- lib/imagekit/models/update_file_request.rb | 45 ++++++++- lib/imagekit/resources/files.rb | 23 ++--- rbi/imagekit/models/file_update_params.rbi | 41 +++++++- rbi/imagekit/models/update_file_request.rbi | 102 +++++++++++++++++++- rbi/imagekit/resources/files.rbi | 48 +-------- sig/imagekit/models/file_update_params.rbs | 21 +++- sig/imagekit/models/update_file_request.rbs | 41 +++++++- sig/imagekit/resources/files.rbs | 9 +- test/imagekit/resources/files_test.rb | 2 +- 11 files changed, 261 insertions(+), 87 deletions(-) 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/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb index fd8c7342..1685dfad 100644 --- a/lib/imagekit/models/file_update_params.rb +++ b/lib/imagekit/models/file_update_params.rb @@ -3,11 +3,19 @@ module Imagekit module Models # @see Imagekit::Resources::Files#update - class FileUpdateParams < Imagekit::Models::UpdateFileRequest + class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute update_file_request + # Schema for update file update request. + # + # @return [Imagekit::Models::UpdateFileRequest::UpdateFileDetails, Imagekit::Models::UpdateFileRequest::ChangePublicationStatus] + required :update_file_request, union: -> { Imagekit::UpdateFileRequest } + + # @!method initialize(update_file_request:, request_options: {}) + # @param update_file_request [Imagekit::Models::UpdateFileRequest::UpdateFileDetails, Imagekit::Models::UpdateFileRequest::ChangePublicationStatus] Schema for update file update request. + # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/imagekit/models/update_file_request.rb b/lib/imagekit/models/update_file_request.rb index fc200a35..08fcdd07 100644 --- a/lib/imagekit/models/update_file_request.rb +++ b/lib/imagekit/models/update_file_request.rb @@ -8,7 +8,7 @@ module UpdateFileRequest variant -> { Imagekit::UpdateFileRequest::UpdateFileDetails } - variant Imagekit::Internal::Type::Unknown + variant -> { Imagekit::UpdateFileRequest::ChangePublicationStatus } class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # @!attribute custom_coordinates @@ -115,8 +115,49 @@ module RemoveAITags end end + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + # @!attribute publish + # Configure the publication status of a file and its versions. + # + # @return [Imagekit::Models::UpdateFileRequest::ChangePublicationStatus::Publish, nil] + optional :publish, -> { Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish } + + # @!method initialize(publish: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::UpdateFileRequest::ChangePublicationStatus} for more details. + # + # @param publish [Imagekit::Models::UpdateFileRequest::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. + + # @see Imagekit::Models::UpdateFileRequest::ChangePublicationStatus#publish + class Publish < Imagekit::Internal::Type::BaseModel + # @!attribute is_published + # Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @return [Boolean] + required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + + # @!attribute include_file_versions + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + # + # @return [Boolean, nil] + optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + + # @!method initialize(is_published:, include_file_versions: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::UpdateFileRequest::ChangePublicationStatus::Publish} for more + # details. + # + # Configure the publication status of a file and its versions. + # + # @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file. + # + # @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p + end + end + # @!method self.variants - # @return [Array(Imagekit::Models::UpdateFileRequest::UpdateFileDetails, Object)] + # @return [Array(Imagekit::Models::UpdateFileRequest::UpdateFileDetails, Imagekit::Models::UpdateFileRequest::ChangePublicationStatus)] end end end diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 9960c440..2ddc77ef 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -19,25 +19,11 @@ class Files # You can update `tags`, `customCoordinates`, `customMetadata`, publication # status, remove existing `AITags` and apply extensions using this API. # - # @overload update(file_id, body:, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil, request_options: {}) + # @overload update(file_id, update_file_request:, request_options: {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param body [Object] - # - # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, - # - # @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va - # - # @param description [String] Optional text to describe the contents of the file. - # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured - # - # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car - # - # @param tags [Array, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul - # - # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv + # @param update_file_request [Imagekit::UpdateFileRequest] Schema for update file update request. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -46,6 +32,11 @@ class Files # @see Imagekit::Models::FileUpdateParams def update(file_id, params) parsed, options = Imagekit::FileUpdateParams.dump_request(params) + case parsed + in {update_file_request: Hash => union, **rest} + parsed = {**rest, **union} + else + end @client.request( method: :patch, path: ["v1/files/%1$s/details", file_id], diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi index a88e63be..908bd758 100644 --- a/rbi/imagekit/models/file_update_params.rbi +++ b/rbi/imagekit/models/file_update_params.rbi @@ -2,7 +2,7 @@ module Imagekit module Models - class FileUpdateParams < Imagekit::Models::UpdateFileRequest + class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters @@ -11,15 +11,46 @@ module Imagekit T.any(Imagekit::FileUpdateParams, Imagekit::Internal::AnyHash) end + # Schema for update file update request. sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class + returns( + T.any( + Imagekit::UpdateFileRequest::UpdateFileDetails, + Imagekit::UpdateFileRequest::ChangePublicationStatus + ) ) end - def self.new(request_options: {}) + attr_accessor :update_file_request + + sig do + params( + update_file_request: + T.any( + Imagekit::UpdateFileRequest::UpdateFileDetails::OrHash, + Imagekit::UpdateFileRequest::ChangePublicationStatus::OrHash + ), + request_options: Imagekit::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for update file update request. + update_file_request:, + request_options: {} + ) end - sig { override.returns({ request_options: Imagekit::RequestOptions }) } + sig do + override.returns( + { + update_file_request: + T.any( + Imagekit::UpdateFileRequest::UpdateFileDetails, + Imagekit::UpdateFileRequest::ChangePublicationStatus + ), + request_options: Imagekit::RequestOptions + } + ) + end def to_hash end end diff --git a/rbi/imagekit/models/update_file_request.rbi b/rbi/imagekit/models/update_file_request.rbi index c345c856..b259bf0e 100644 --- a/rbi/imagekit/models/update_file_request.rbi +++ b/rbi/imagekit/models/update_file_request.rbi @@ -8,7 +8,10 @@ module Imagekit Variants = T.type_alias do - T.any(Imagekit::UpdateFileRequest::UpdateFileDetails, T.anything) + T.any( + Imagekit::UpdateFileRequest::UpdateFileDetails, + Imagekit::UpdateFileRequest::ChangePublicationStatus + ) end class UpdateFileDetails < Imagekit::Internal::Type::BaseModel @@ -206,6 +209,103 @@ module Imagekit end end + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UpdateFileRequest::ChangePublicationStatus, + Imagekit::Internal::AnyHash + ) + end + + # Configure the publication status of a file and its versions. + sig do + returns( + T.nilable( + Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + ) + ) + end + attr_reader :publish + + sig do + params( + publish: + Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish::OrHash + ).void + end + attr_writer :publish + + sig do + params( + publish: + Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish::OrHash + ).returns(T.attached_class) + end + def self.new( + # Configure the publication status of a file and its versions. + publish: nil + ) + end + + sig do + override.returns( + { + publish: + Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + } + ) + end + def to_hash + end + + class Publish < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish, + Imagekit::Internal::AnyHash + ) + end + + # Set to `true` to publish the file. Set to `false` to unpublish the file. + sig { returns(T::Boolean) } + attr_accessor :is_published + + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_file_versions + + sig { params(include_file_versions: T::Boolean).void } + attr_writer :include_file_versions + + # Configure the publication status of a file and its versions. + sig do + params( + is_published: T::Boolean, + include_file_versions: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Set to `true` to publish the file. Set to `false` to unpublish the file. + is_published:, + # Set to `true` to publish/unpublish all versions of the file. Set to `false` to + # publish/unpublish only the current version of the file. + include_file_versions: nil + ) + end + + sig do + override.returns( + { is_published: T::Boolean, include_file_versions: T::Boolean } + ) + end + def to_hash + end + end + end + sig { override.returns(T::Array[Imagekit::UpdateFileRequest::Variants]) } def self.variants end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index d5522618..cec1cf6e 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -18,21 +18,7 @@ module Imagekit sig do params( file_id: String, - body: T.anything, - custom_coordinates: T.nilable(String), - custom_metadata: T::Hash[Symbol, T.anything], - description: String, - extensions: - T::Array[ - T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash - ) - ], - remove_ai_tags: T.any(T::Array[String], Symbol), - tags: T.nilable(T::Array[String]), - webhook_url: String, + update_file_request: Imagekit::UpdateFileRequest, request_options: Imagekit::RequestOptions::OrHash ).returns(Imagekit::Models::FileUpdateResponse) end @@ -40,36 +26,8 @@ module Imagekit # The unique `fileId` of the uploaded file. `fileId` is returned in list and # search assets API and upload API. file_id, - body:, - # 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. - custom_coordinates: nil, - # 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. - custom_metadata: nil, - # Optional text to describe the contents of the file. - description: nil, - # Array of extensions to be applied to the asset. Each extension can be configured - # with specific parameters based on the extension type. - extensions: nil, - # 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. - remove_ai_tags: nil, - # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send - # `null` to unset all tags associated with the file. - tags: nil, - # 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. - webhook_url: nil, + # Schema for update file update request. + update_file_request:, request_options: {} ) end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs index 3bc2f7c8..be8da6ac 100644 --- a/sig/imagekit/models/file_update_params.rbs +++ b/sig/imagekit/models/file_update_params.rbs @@ -1,15 +1,28 @@ module Imagekit module Models type file_update_params = - { } & Imagekit::Internal::Type::request_parameters + { update_file_request: Imagekit::Models::update_file_request } + & Imagekit::Internal::Type::request_parameters - class FileUpdateParams < Imagekit::Models::UpdateFileRequest + class FileUpdateParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters - def initialize: (?request_options: Imagekit::request_opts) -> void + def update_file_request: -> Imagekit::Models::update_file_request - def to_hash: -> { request_options: Imagekit::RequestOptions } + def update_file_request=: ( + Imagekit::Models::update_file_request _ + ) -> Imagekit::Models::update_file_request + + def initialize: ( + update_file_request: Imagekit::Models::update_file_request, + ?request_options: Imagekit::request_opts + ) -> void + + def to_hash: -> { + update_file_request: Imagekit::Models::update_file_request, + request_options: Imagekit::RequestOptions + } end end end diff --git a/sig/imagekit/models/update_file_request.rbs b/sig/imagekit/models/update_file_request.rbs index 218023a8..68701252 100644 --- a/sig/imagekit/models/update_file_request.rbs +++ b/sig/imagekit/models/update_file_request.rbs @@ -1,7 +1,8 @@ module Imagekit module Models type update_file_request = - Imagekit::UpdateFileRequest::UpdateFileDetails | top + Imagekit::UpdateFileRequest::UpdateFileDetails + | Imagekit::UpdateFileRequest::ChangePublicationStatus module UpdateFileRequest extend Imagekit::Internal::Type::Union @@ -77,6 +78,44 @@ module Imagekit end end + type change_publication_status = + { + publish: Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + } + + class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + attr_reader publish: Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish? + + def publish=: ( + Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + ) -> Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + + def initialize: ( + ?publish: Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + ) -> void + + def to_hash: -> { + publish: Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + } + + type publish = { is_published: bool, include_file_versions: bool } + + class Publish < Imagekit::Internal::Type::BaseModel + attr_accessor is_published: bool + + attr_reader include_file_versions: bool? + + def include_file_versions=: (bool) -> bool + + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void + + def to_hash: -> { is_published: bool, include_file_versions: bool } + end + end + def self?.variants: -> ::Array[Imagekit::Models::update_file_request] end end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 22bf487b..e2c281c0 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -9,14 +9,7 @@ module Imagekit def update: ( String file_id, - body: top, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: Imagekit::Models::extensions, - ?remove_ai_tags: Imagekit::Models::UpdateFileRequest::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String, + update_file_request: Imagekit::Models::UpdateFileRequest, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::FileUpdateResponse diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index dc229400..c09eb4bb 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -6,7 +6,7 @@ class Imagekit::Test::Resources::FilesTest < Imagekit::Test::ResourceTest def test_update skip("Prism tests are disabled") - response = @image_kit.files.update("fileId", body: {}) + response = @image_kit.files.update("fileId") assert_pattern do response => Imagekit::Models::FileUpdateResponse From b574460c1f18cf96f91f3dc697c707296bc2d749 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:28 +0000 Subject: [PATCH 109/178] feat(api): manual updates --- .stats.yml | 2 +- README.md | 2 +- lib/imagekit/client.rb | 24 ++++++++++++------------ rbi/imagekit/client.rbi | 14 +++++++------- sig/imagekit/client.rbs | 4 ++-- test/imagekit/client_test.rb | 30 +++++++++++++++--------------- test/imagekit/test_helper.rb | 2 +- 7 files changed, 39 insertions(+), 39 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 32341ee0..0636e207 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ require "bundler/setup" require "imagekit" image_kit = Imagekit::Client.new( - private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], # This is the default and can be omitted + private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], # This is the default and can be omitted password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) diff --git a/lib/imagekit/client.rb b/lib/imagekit/client.rb index fd57748a..999da4c8 100644 --- a/lib/imagekit/client.rb +++ b/lib/imagekit/client.rb @@ -19,10 +19,10 @@ class Client < Imagekit::Internal::Transport::BaseClient # manage API keys in the # [dashboard](https://imagekit.io/dashboard/developer/api-keys). # @return [String] - attr_reader :private_api_key + attr_reader :private_key - # ImageKit Basic Auth only uses the username field and ignores the password. This - # field is unused. + # ImageKit Basic Auth only uses the `private_key` as username and ignores the + # password. # @return [String, nil] attr_reader :password @@ -54,9 +54,9 @@ class Client < Imagekit::Internal::Transport::BaseClient # # @return [Hash{String=>String}] private def auth_headers - return {} if @private_api_key.nil? || @password.nil? + return {} if @private_key.nil? || @password.nil? - base64_credentials = ["#{@private_api_key}:#{@password}"].pack("m0") + base64_credentials = ["#{@private_key}:#{@password}"].pack("m0") {"authorization" => "Basic #{base64_credentials}"} end @@ -67,13 +67,13 @@ def base_url_overridden? = @base_url_overridden # Creates and returns a new client for interacting with the API. # - # @param private_api_key [String, nil] Your ImageKit private API key (it starts with `private_`). You can view and + # @param private_key [String, nil] Your ImageKit private API key (it starts with `private_`). You can view and # manage API keys in the # [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to # `ENV["IMAGEKIT_PRIVATE_API_KEY"]` # - # @param password [String, nil] ImageKit Basic Auth only uses the username field and ignores the password. This - # field is unused. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` + # @param password [String, nil] ImageKit Basic Auth only uses the `private_key` as username and ignores the + # password. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` # # @param base_url [String, nil] Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` @@ -86,7 +86,7 @@ def base_url_overridden? = @base_url_overridden # # @param max_retry_delay [Float] def initialize( - private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], + private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"), base_url: ENV["IMAGE_KIT_BASE_URL"], max_retries: self.class::DEFAULT_MAX_RETRIES, @@ -98,11 +98,11 @@ def initialize( base_url ||= "https://api.imagekit.io" - if private_api_key.nil? - raise ArgumentError.new("private_api_key is required, and can be set via environ: \"IMAGEKIT_PRIVATE_API_KEY\"") + if private_key.nil? + raise ArgumentError.new("private_key is required, and can be set via environ: \"IMAGEKIT_PRIVATE_API_KEY\"") end - @private_api_key = private_api_key.to_s + @private_key = private_key.to_s @password = password.to_s super( diff --git a/rbi/imagekit/client.rbi b/rbi/imagekit/client.rbi index f290a74d..c97cd45b 100644 --- a/rbi/imagekit/client.rbi +++ b/rbi/imagekit/client.rbi @@ -14,10 +14,10 @@ module Imagekit # manage API keys in the # [dashboard](https://imagekit.io/dashboard/developer/api-keys). sig { returns(String) } - attr_reader :private_api_key + attr_reader :private_key - # ImageKit Basic Auth only uses the username field and ignores the password. This - # field is unused. + # ImageKit Basic Auth only uses the `private_key` as username and ignores the + # password. sig { returns(T.nilable(String)) } attr_reader :password @@ -58,7 +58,7 @@ module Imagekit # Creates and returns a new client for interacting with the API. sig do params( - private_api_key: T.nilable(String), + private_key: T.nilable(String), password: T.nilable(String), base_url: T.nilable(String), max_retries: Integer, @@ -72,9 +72,9 @@ module Imagekit # manage API keys in the # [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to # `ENV["IMAGEKIT_PRIVATE_API_KEY"]` - private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], - # ImageKit Basic Auth only uses the username field and ignores the password. This - # field is unused. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` + private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], + # ImageKit Basic Auth only uses the `private_key` as username and ignores the + # password. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"), # Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` diff --git a/sig/imagekit/client.rbs b/sig/imagekit/client.rbs index 5e7f6ff8..754fe43e 100644 --- a/sig/imagekit/client.rbs +++ b/sig/imagekit/client.rbs @@ -8,7 +8,7 @@ module Imagekit DEFAULT_MAX_RETRY_DELAY: Float - attr_reader private_api_key: String + attr_reader private_key: String attr_reader password: String? @@ -33,7 +33,7 @@ module Imagekit def base_url_overridden?: -> bool def initialize: ( - ?private_api_key: String?, + ?private_key: String?, ?password: String?, ?base_url: String?, ?max_retries: Integer, diff --git a/test/imagekit/client_test.rb b/test/imagekit/client_test.rb index 22cda48d..5280fad1 100644 --- a/test/imagekit/client_test.rb +++ b/test/imagekit/client_test.rb @@ -40,7 +40,7 @@ def test_client_default_request_default_retry_attempts image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -57,7 +57,7 @@ def test_client_given_request_default_retry_attempts image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password", max_retries: 3 ) @@ -75,7 +75,7 @@ def test_client_default_request_given_retry_attempts image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -96,7 +96,7 @@ def test_client_given_request_given_retry_attempts image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password", max_retries: 3 ) @@ -122,7 +122,7 @@ def test_client_retry_after_seconds image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password", max_retries: 1 ) @@ -145,7 +145,7 @@ def test_client_retry_after_date image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password", max_retries: 1 ) @@ -170,7 +170,7 @@ def test_client_retry_after_ms image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password", max_retries: 1 ) @@ -189,7 +189,7 @@ def test_retry_count_header image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -208,7 +208,7 @@ def test_omit_retry_count_header image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -231,7 +231,7 @@ def test_overwrite_retry_count_header image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -260,7 +260,7 @@ def test_client_redirect_307 image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -298,7 +298,7 @@ def test_client_redirect_303 image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -331,7 +331,7 @@ def test_client_redirect_auth_keep_same_origin image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -367,7 +367,7 @@ def test_client_redirect_auth_strip_cross_origin image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) @@ -391,7 +391,7 @@ def test_default_headers image_kit = Imagekit::Client.new( base_url: "http://localhost", - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) diff --git a/test/imagekit/test_helper.rb b/test/imagekit/test_helper.rb index 92dbd107..56fd104f 100644 --- a/test/imagekit/test_helper.rb +++ b/test/imagekit/test_helper.rb @@ -50,7 +50,7 @@ class Imagekit::Test::SingletonClient < Imagekit::Client def initialize super( base_url: Imagekit::Test::SingletonClient::TEST_API_BASE_URL, - private_api_key: "My Private API Key", + private_key: "My Private Key", password: "My Password" ) end From d8a24585ebafcf90adbd6d64ae89a3599817a810 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:53 +0000 Subject: [PATCH 110/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit/client.rb | 23 ++++++++++++----------- rbi/imagekit/client.rbi | 23 ++++++++++++----------- 3 files changed, 25 insertions(+), 23 deletions(-) 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 diff --git a/lib/imagekit/client.rb b/lib/imagekit/client.rb index 999da4c8..dd58cd05 100644 --- a/lib/imagekit/client.rb +++ b/lib/imagekit/client.rb @@ -15,14 +15,14 @@ class Client < Imagekit::Internal::Transport::BaseClient # Default max retry delay in seconds. DEFAULT_MAX_RETRY_DELAY = 8.0 - # Your ImageKit private API key (it starts with `private_`). You can view and - # manage API keys in the - # [dashboard](https://imagekit.io/dashboard/developer/api-keys). + # Your ImageKit private API key (starts with `private_`). You can find this in the + # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). # @return [String] attr_reader :private_key - # ImageKit Basic Auth only uses the `private_key` as username and ignores the - # password. + # Leave this field unset. ImageKit uses Basic Authentication scheme that requires + # the `private_key` as the username and empty string as the password. The password + # field is automatically managed by the SDK and should not be set. # @return [String, nil] attr_reader :password @@ -67,13 +67,14 @@ def base_url_overridden? = @base_url_overridden # Creates and returns a new client for interacting with the API. # - # @param private_key [String, nil] Your ImageKit private API key (it starts with `private_`). You can view and - # manage API keys in the - # [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to - # `ENV["IMAGEKIT_PRIVATE_API_KEY"]` + # @param private_key [String, nil] Your ImageKit private API key (starts with `private_`). You can find this in the + # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults + # to `ENV["IMAGEKIT_PRIVATE_API_KEY"]` # - # @param password [String, nil] ImageKit Basic Auth only uses the `private_key` as username and ignores the - # password. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` + # @param password [String, nil] Leave this field unset. ImageKit uses Basic Authentication scheme that requires + # the `private_key` as the username and empty string as the password. The password + # field is automatically managed by the SDK and should not be set. Defaults to + # `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` # # @param base_url [String, nil] Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` diff --git a/rbi/imagekit/client.rbi b/rbi/imagekit/client.rbi index c97cd45b..4bcc13f9 100644 --- a/rbi/imagekit/client.rbi +++ b/rbi/imagekit/client.rbi @@ -10,14 +10,14 @@ module Imagekit DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float) - # Your ImageKit private API key (it starts with `private_`). You can view and - # manage API keys in the - # [dashboard](https://imagekit.io/dashboard/developer/api-keys). + # Your ImageKit private API key (starts with `private_`). You can find this in the + # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). sig { returns(String) } attr_reader :private_key - # ImageKit Basic Auth only uses the `private_key` as username and ignores the - # password. + # Leave this field unset. ImageKit uses Basic Authentication scheme that requires + # the `private_key` as the username and empty string as the password. The password + # field is automatically managed by the SDK and should not be set. sig { returns(T.nilable(String)) } attr_reader :password @@ -68,13 +68,14 @@ module Imagekit ).returns(T.attached_class) end def self.new( - # Your ImageKit private API key (it starts with `private_`). You can view and - # manage API keys in the - # [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to - # `ENV["IMAGEKIT_PRIVATE_API_KEY"]` + # Your ImageKit private API key (starts with `private_`). You can find this in the + # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults + # to `ENV["IMAGEKIT_PRIVATE_API_KEY"]` private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], - # ImageKit Basic Auth only uses the `private_key` as username and ignores the - # password. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` + # Leave this field unset. ImageKit uses Basic Authentication scheme that requires + # the `private_key` as the username and empty string as the password. The password + # field is automatically managed by the SDK and should not be set. Defaults to + # `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"), # Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` From 6e431e76882295b6a5d501aa858322847c5549d9 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:22 +0000 Subject: [PATCH 111/178] feat(api): manual updates --- .stats.yml | 2 +- lib/imagekit/client.rb | 10 ++++------ rbi/imagekit/client.rbi | 10 ++++------ 3 files changed, 9 insertions(+), 13 deletions(-) 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 diff --git a/lib/imagekit/client.rb b/lib/imagekit/client.rb index dd58cd05..97dacb3a 100644 --- a/lib/imagekit/client.rb +++ b/lib/imagekit/client.rb @@ -20,9 +20,8 @@ class Client < Imagekit::Internal::Transport::BaseClient # @return [String] attr_reader :private_key - # Leave this field unset. ImageKit uses Basic Authentication scheme that requires - # the `private_key` as the username and empty string as the password. The password - # field is automatically managed by the SDK and should not be set. + # ImageKit uses your API key as username and ignores the password. The SDK sets a + # dummy value. You can ignore this field. # @return [String, nil] attr_reader :password @@ -71,9 +70,8 @@ def base_url_overridden? = @base_url_overridden # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults # to `ENV["IMAGEKIT_PRIVATE_API_KEY"]` # - # @param password [String, nil] Leave this field unset. ImageKit uses Basic Authentication scheme that requires - # the `private_key` as the username and empty string as the password. The password - # field is automatically managed by the SDK and should not be set. Defaults to + # @param password [String, nil] ImageKit uses your API key as username and ignores the password. The SDK sets a + # dummy value. You can ignore this field. Defaults to # `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` # # @param base_url [String, nil] Override the default base URL for the API, e.g., diff --git a/rbi/imagekit/client.rbi b/rbi/imagekit/client.rbi index 4bcc13f9..2d819388 100644 --- a/rbi/imagekit/client.rbi +++ b/rbi/imagekit/client.rbi @@ -15,9 +15,8 @@ module Imagekit sig { returns(String) } attr_reader :private_key - # Leave this field unset. ImageKit uses Basic Authentication scheme that requires - # the `private_key` as the username and empty string as the password. The password - # field is automatically managed by the SDK and should not be set. + # ImageKit uses your API key as username and ignores the password. The SDK sets a + # dummy value. You can ignore this field. sig { returns(T.nilable(String)) } attr_reader :password @@ -72,9 +71,8 @@ module Imagekit # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults # to `ENV["IMAGEKIT_PRIVATE_API_KEY"]` private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], - # Leave this field unset. ImageKit uses Basic Authentication scheme that requires - # the `private_key` as the username and empty string as the password. The password - # field is automatically managed by the SDK and should not be set. Defaults to + # ImageKit uses your API key as username and ignores the password. The SDK sets a + # dummy value. You can ignore this field. Defaults to # `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"), # Override the default base URL for the API, e.g., From 246fe32f9f41ed90a85b8b0409b1f945700d93ec Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 20 Sep 2025 02:50:03 +0000 Subject: [PATCH 112/178] chore: do not install brew dependencies in ./scripts/bootstrap by default --- scripts/bootstrap | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/scripts/bootstrap b/scripts/bootstrap index cc31aa85..34878642 100755 --- a/scripts/bootstrap +++ b/scripts/bootstrap @@ -4,10 +4,18 @@ set -e cd -- "$(dirname -- "$0")/.." -if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ]; then +if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ] && [ -t 0 ]; then brew bundle check >/dev/null 2>&1 || { - echo "==> Installing Homebrew dependencies…" - brew bundle + echo -n "==> Install Homebrew dependencies? (y/N): " + read -r response + case "$response" in + [yY][eE][sS]|[yY]) + brew bundle + ;; + *) + ;; + esac + echo } fi From e0b39ef274d53ef0d9bce63490064a0b08b2b569 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:36 +0000 Subject: [PATCH 113/178] feat(api): Update env var name --- .stats.yml | 2 +- README.md | 2 +- lib/imagekit/client.rb | 6 +++--- rbi/imagekit/client.rbi | 4 ++-- 4 files changed, 7 insertions(+), 7 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 0636e207..bb1a65d3 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ require "bundler/setup" require "imagekit" image_kit = Imagekit::Client.new( - private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], # This is the default and can be omitted + private_key: ENV["IMAGEKIT_PRIVATE_KEY"], # This is the default and can be omitted password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) diff --git a/lib/imagekit/client.rb b/lib/imagekit/client.rb index 97dacb3a..e3f5f7c3 100644 --- a/lib/imagekit/client.rb +++ b/lib/imagekit/client.rb @@ -68,7 +68,7 @@ def base_url_overridden? = @base_url_overridden # # @param private_key [String, nil] Your ImageKit private API key (starts with `private_`). You can find this in the # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults - # to `ENV["IMAGEKIT_PRIVATE_API_KEY"]` + # to `ENV["IMAGEKIT_PRIVATE_KEY"]` # # @param password [String, nil] ImageKit uses your API key as username and ignores the password. The SDK sets a # dummy value. You can ignore this field. Defaults to @@ -85,7 +85,7 @@ def base_url_overridden? = @base_url_overridden # # @param max_retry_delay [Float] def initialize( - private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], + private_key: ENV["IMAGEKIT_PRIVATE_KEY"], password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"), base_url: ENV["IMAGE_KIT_BASE_URL"], max_retries: self.class::DEFAULT_MAX_RETRIES, @@ -98,7 +98,7 @@ def initialize( base_url ||= "https://api.imagekit.io" if private_key.nil? - raise ArgumentError.new("private_key is required, and can be set via environ: \"IMAGEKIT_PRIVATE_API_KEY\"") + raise ArgumentError.new("private_key is required, and can be set via environ: \"IMAGEKIT_PRIVATE_KEY\"") end @private_key = private_key.to_s diff --git a/rbi/imagekit/client.rbi b/rbi/imagekit/client.rbi index 2d819388..703786c5 100644 --- a/rbi/imagekit/client.rbi +++ b/rbi/imagekit/client.rbi @@ -69,8 +69,8 @@ module Imagekit def self.new( # Your ImageKit private API key (starts with `private_`). You can find this in the # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults - # to `ENV["IMAGEKIT_PRIVATE_API_KEY"]` - private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], + # to `ENV["IMAGEKIT_PRIVATE_KEY"]` + private_key: ENV["IMAGEKIT_PRIVATE_KEY"], # ImageKit uses your API key as username and ignores the password. The SDK sets a # dummy value. You can ignore this field. Defaults to # `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]` From f9c882858a1b63780b786c52bd0c23b24f3f38fa 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:13 +0000 Subject: [PATCH 114/178] 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 bb1a65d3..cd2b44cd 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ It is generated with [Stainless](https://www.stainless.com/). Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/imagekit). -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 75bfcde6ea7cfd52e73169efc9641c2bef5486c5 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:26 +0000 Subject: [PATCH 115/178] 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 cd2b44cd..6f4f19f8 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/imagekit-developer/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. -It is generated with [Stainless](https://www.stainless.com/). - ## Documentation Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/imagekit). From 63d8ce1491171394062d640776a8a5f419ed9ebe 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:22 +0000 Subject: [PATCH 116/178] 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 97c4e7978cc24160f85c1975fe8187ad8356b277 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 22 Sep 2025 12:34:22 +0000 Subject: [PATCH 117/178] feat(api): manual updates --- .github/workflows/publish-gem.yml | 31 ------------ .github/workflows/release-doctor.yml | 22 --------- .release-please-manifest.json | 3 -- .stats.yml | 2 +- CONTRIBUTING.md | 4 +- README.md | 8 +--- bin/check-release-environment | 21 --------- imagekit.gemspec | 2 +- release-please-config.json | 70 ---------------------------- 9 files changed, 6 insertions(+), 157 deletions(-) delete mode 100644 .github/workflows/publish-gem.yml delete mode 100644 .github/workflows/release-doctor.yml delete mode 100644 .release-please-manifest.json delete mode 100644 bin/check-release-environment delete mode 100644 release-please-config.json diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml deleted file mode 100644 index a3de9dee..00000000 --- a/.github/workflows/publish-gem.yml +++ /dev/null @@ -1,31 +0,0 @@ -# This workflow is triggered when a GitHub release is created. -# It can also be run manually to re-publish to rubygems.org in case it failed for some reason. -# You can run this workflow by navigating to https://www.github.com/imagekit-developer/imagekit-ruby/actions/workflows/publish-gem.yml -name: Publish Gem -on: - workflow_dispatch: - - release: - types: [published] - -jobs: - publish: - name: publish - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - name: Set up Ruby - uses: ruby/setup-ruby@v1 - with: - bundler-cache: false - - run: |- - bundle install - - - name: Publish to RubyGems.org - run: | - bash ./bin/publish-gem - env: - # `RUBYGEMS_HOST` is only required for private gem repositories, not https://rubygems.org - RUBYGEMS_HOST: ${{ secrets.IMAGE_KIT_RUBYGEMS_HOST || secrets.RUBYGEMS_HOST }} - GEM_HOST_API_KEY: ${{ secrets.IMAGE_KIT_GEM_HOST_API_KEY || secrets.GEM_HOST_API_KEY }} diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml deleted file mode 100644 index 9d9c1e66..00000000 --- a/.github/workflows/release-doctor.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Release Doctor -on: - pull_request: - branches: - - master - workflow_dispatch: - -jobs: - release_doctor: - name: release doctor - runs-on: ubuntu-latest - if: github.repository == 'imagekit-developer/imagekit-ruby' && (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: - RUBYGEMS_HOST: ${{ secrets.IMAGE_KIT_RUBYGEMS_HOST || secrets.RUBYGEMS_HOST }} - GEM_HOST_API_KEY: ${{ secrets.IMAGE_KIT_GEM_HOST_API_KEY || secrets.GEM_HOST_API_KEY }} diff --git a/.release-please-manifest.json b/.release-please-manifest.json deleted file mode 100644 index 1332969b..00000000 --- a/.release-please-manifest.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - ".": "0.0.1" -} \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 031fed99..7c3aae1c 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: d57f3c7c581048428b41398f30da8b9b +config_hash: e42d7fc3a8c92c35099cc283f9a4467a diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15b2dbaa..ff57412c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,13 +43,13 @@ If you’d like to use the repository from source, you can either install from g To install via git in your `Gemfile`: ```ruby -gem "imagekit", git: "https://www.github.com/imagekit-developer/imagekit-ruby" +gem "imagekit", git: "https://www.github.com/stainless-sdks/imagekit-ruby" ``` Alternatively, reference local copy of the repo: ```bash -$ git clone -- 'https://www.github.com/imagekit-developer/imagekit-ruby' '' +$ git clone -- 'https://www.github.com/stainless-sdks/imagekit-ruby' '' ``` ```ruby diff --git a/README.md b/README.md index 6f4f19f8..dbc5335f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Image Kit Ruby API library -The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/imagekit-developer/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. +The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/stainless-sdks/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. ## Documentation @@ -12,14 +12,10 @@ The REST API documentation can be found on [imagekit.io](https://imagekit.io/doc To use this gem, install via Bundler by adding the following to your application's `Gemfile`: - - ```ruby gem "imagekit", "~> 0.0.1" ``` - - ## Usage ```ruby @@ -277,4 +273,4 @@ Ruby 3.2.0 or higher. ## Contributing -See [the contributing documentation](https://github.com/imagekit-developer/imagekit-ruby/tree/master/CONTRIBUTING.md). +See [the contributing documentation](https://github.com/stainless-sdks/imagekit-ruby/tree/main/CONTRIBUTING.md). diff --git a/bin/check-release-environment b/bin/check-release-environment deleted file mode 100644 index c05436e8..00000000 --- a/bin/check-release-environment +++ /dev/null @@ -1,21 +0,0 @@ -#!/usr/bin/env bash - -errors=() - -if [ -z "${GEM_HOST_API_KEY}" ]; then - errors+=("The GEM_HOST_API_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/imagekit.gemspec b/imagekit.gemspec index f094efa0..a29c6731 100644 --- a/imagekit.gemspec +++ b/imagekit.gemspec @@ -10,7 +10,7 @@ Gem::Specification.new do |s| s.email = "developer@imagekit.io" s.homepage = "https://gemdocs.org/gems/imagekit" s.metadata["homepage_uri"] = s.homepage - s.metadata["source_code_uri"] = "https://github.com/imagekit-developer/imagekit-ruby" + s.metadata["source_code_uri"] = "https://github.com/stainless-sdks/imagekit-ruby" s.metadata["rubygems_mfa_required"] = false.to_s s.required_ruby_version = ">= 3.2.0" diff --git a/release-please-config.json b/release-please-config.json deleted file mode 100644 index 32536019..00000000 --- a/release-please-config.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "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": "ruby", - "version-file": "lib/imagekit/version.rb", - "extra-files": [ - { - "type": "ruby-readme", - "path": "README.md" - } - ] -} \ No newline at end of file From 0bfc5ad2dcbafaa451b151fac71f8ac7c567717e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 26 Sep 2025 02:51:33 +0000 Subject: [PATCH 118/178] perf: faster code formatting --- Rakefile | 18 ++++++++++-------- scripts/fast-format | 18 ++++++++++++++++++ 2 files changed, 28 insertions(+), 8 deletions(-) create mode 100755 scripts/fast-format diff --git a/Rakefile b/Rakefile index 6b5be685..ac41d473 100644 --- a/Rakefile +++ b/Rakefile @@ -12,6 +12,8 @@ tapioca = "sorbet/tapioca" examples = "examples" ignore_file = ".ignore" +FILES_ENV = "FORMAT_FILE" + CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/ doc/], *FileList["*.gem"], ignore_file) CLOBBER.push(*%w[sorbet/rbi/annotations/ sorbet/rbi/gems/], tapioca) @@ -55,21 +57,21 @@ end desc("Format `*.rb`") multitask(:"format:rb") do # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support - find = %w[find ./lib ./test ./examples -type f -and -name *.rb -print0] + files = ENV.key?(FILES_ENV) ? %w[sed -E -n -e /\.rb$/p --] << ENV.fetch(FILES_ENV) : %w[find ./lib ./test ./examples -type f -and -name *.rb -print0] fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --] - sh("#{find.shelljoin} | #{fmt.shelljoin}") + sh("#{files.shelljoin} | #{fmt.shelljoin}") end desc("Format `*.rbi`") multitask(:"format:rbi") do - find = %w[find ./rbi -type f -and -name *.rbi -print0] + files = ENV.key?(FILES_ENV) ? %w[sed -E -n -e /\.rbi$/p --] << ENV.fetch(FILES_ENV) : %w[find ./rbi -type f -and -name *.rbi -print0] fmt = xargs + %w[stree write --] - sh(ruby_opt, "#{find.shelljoin} | #{fmt.shelljoin}") + sh(ruby_opt, "#{files.shelljoin} | #{fmt.shelljoin}") end desc("Format `*.rbs`") multitask(:"format:rbs") do - find = %w[find ./sig -type f -name *.rbs -print0] + files = ENV.key?(FILES_ENV) ? %w[sed -E -n -e /\.rbs$/p --] << ENV.fetch(FILES_ENV) : %w[find ./sig -type f -name *.rbs -print0] inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? ["-i", ""] : %w[-i] uuid = SecureRandom.uuid @@ -98,13 +100,13 @@ multitask(:"format:rbs") do success = false # transform class aliases to type aliases, which syntax tree has no trouble with - sh("#{find.shelljoin} | #{pre.shelljoin}") + sh("#{files.shelljoin} | #{pre.shelljoin}") # run syntax tree to format `*.rbs` files - sh(ruby_opt, "#{find.shelljoin} | #{fmt.shelljoin}") do + sh(ruby_opt, "#{files.shelljoin} | #{fmt.shelljoin}") do success = _1 end # transform type aliases back to class aliases - sh("#{find.shelljoin} | #{pst.shelljoin}") + sh("#{files.shelljoin} | #{pst.shelljoin}") # always run post-processing to remove comment marker fail unless success diff --git a/scripts/fast-format b/scripts/fast-format new file mode 100755 index 00000000..7f2f820e --- /dev/null +++ b/scripts/fast-format @@ -0,0 +1,18 @@ +#!/usr/bin/env bash + +set -euo pipefail + +echo "Script started with $# arguments" +echo "Arguments: $*" +echo "Script location: $(dirname "$0")" + +cd "$(dirname "$0")/.." +echo "Changed to directory: $(pwd)" + +if [ $# -eq 0 ]; then + echo "Usage: $0 [additional-formatter-args...]" + echo "The file should contain one file path per line" + exit 1 +fi + +FORMAT_FILE="$1" exec -- bundle exec rake format From 648421b4e304c2beb2d30868bae2bb24d4316cc5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 27 Sep 2025 03:13:30 +0000 Subject: [PATCH 119/178] chore(internal): codegen related update --- Rakefile | 6 +++--- scripts/fast-format | 9 ++++++--- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/Rakefile b/Rakefile index ac41d473..e6974f39 100644 --- a/Rakefile +++ b/Rakefile @@ -57,21 +57,21 @@ end desc("Format `*.rb`") multitask(:"format:rb") do # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support - files = ENV.key?(FILES_ENV) ? %w[sed -E -n -e /\.rb$/p --] << ENV.fetch(FILES_ENV) : %w[find ./lib ./test ./examples -type f -and -name *.rb -print0] + files = ENV.key?(FILES_ENV) ? %w[sed -E -z -n -e /\.rb$/p --] << ENV.fetch(FILES_ENV) : %w[find ./lib ./test ./examples -type f -and -name *.rb -print0] fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --] sh("#{files.shelljoin} | #{fmt.shelljoin}") end desc("Format `*.rbi`") multitask(:"format:rbi") do - files = ENV.key?(FILES_ENV) ? %w[sed -E -n -e /\.rbi$/p --] << ENV.fetch(FILES_ENV) : %w[find ./rbi -type f -and -name *.rbi -print0] + files = ENV.key?(FILES_ENV) ? %w[sed -E -z -n -e /\.rbi$/p --] << ENV.fetch(FILES_ENV) : %w[find ./rbi -type f -and -name *.rbi -print0] fmt = xargs + %w[stree write --] sh(ruby_opt, "#{files.shelljoin} | #{fmt.shelljoin}") end desc("Format `*.rbs`") multitask(:"format:rbs") do - files = ENV.key?(FILES_ENV) ? %w[sed -E -n -e /\.rbs$/p --] << ENV.fetch(FILES_ENV) : %w[find ./sig -type f -name *.rbs -print0] + files = ENV.key?(FILES_ENV) ? %w[sed -E -z -n -e /\.rbs$/p --] << ENV.fetch(FILES_ENV) : %w[find ./sig -type f -name *.rbs -print0] inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? ["-i", ""] : %w[-i] uuid = SecureRandom.uuid diff --git a/scripts/fast-format b/scripts/fast-format index 7f2f820e..8df0aa26 100755 --- a/scripts/fast-format +++ b/scripts/fast-format @@ -6,8 +6,8 @@ echo "Script started with $# arguments" echo "Arguments: $*" echo "Script location: $(dirname "$0")" -cd "$(dirname "$0")/.." -echo "Changed to directory: $(pwd)" +cd -- "$(dirname "$0")/.." +echo "Changed to directory: $PWD" if [ $# -eq 0 ]; then echo "Usage: $0 [additional-formatter-args...]" @@ -15,4 +15,7 @@ if [ $# -eq 0 ]; then exit 1 fi -FORMAT_FILE="$1" exec -- bundle exec rake format +FILE="$(mktemp)" +tr -- '\n' '\0' < "$1" > "$FILE" + +exec -- bundle exec rake format FORMAT_FILE="$FILE" From bce078dc627a0dd9a0c7bb41fc6102f6ca8d8cbc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 27 Sep 2025 03:15:39 +0000 Subject: [PATCH 120/178] fix: shorten multipart boundary sep to less than RFC specificed max length --- lib/imagekit/internal/util.rb | 3 ++- test/imagekit/internal/util_test.rb | 12 ++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/lib/imagekit/internal/util.rb b/lib/imagekit/internal/util.rb index 14ac714a..c5b3aa74 100644 --- a/lib/imagekit/internal/util.rb +++ b/lib/imagekit/internal/util.rb @@ -566,7 +566,8 @@ class << self # # @return [Array(String, Enumerable)] private def encode_multipart_streaming(body) - boundary = SecureRandom.urlsafe_base64(60) + # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length + boundary = SecureRandom.urlsafe_base64(46) closing = [] strio = writable_enum do |y| diff --git a/test/imagekit/internal/util_test.rb b/test/imagekit/internal/util_test.rb index 48616831..ad3a9a4e 100644 --- a/test/imagekit/internal/util_test.rb +++ b/test/imagekit/internal/util_test.rb @@ -213,6 +213,18 @@ def env_table end end + def test_encoding_length + headers, = Imagekit::Internal::Util.encode_content( + {"content-type" => "multipart/form-data"}, + Pathname(__FILE__) + ) + assert_pattern do + headers.fetch("content-type") => /boundary=(.+)$/ + end + field, = Regexp.last_match.captures + assert(field.length < 70 - 6) + end + def test_file_encode file = Pathname(__FILE__) headers = {"content-type" => "multipart/form-data"} From b8f0d09a60cb0e65880d4dd7616b921f857398c6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 27 Sep 2025 03:19:22 +0000 Subject: [PATCH 121/178] chore: allow fast-format to use bsd sed as well --- Rakefile | 26 ++++++++++++++++++-------- scripts/fast-format | 5 +---- 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/Rakefile b/Rakefile index e6974f39..6712d7f1 100644 --- a/Rakefile +++ b/Rakefile @@ -40,6 +40,14 @@ end xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --] ruby_opt = {"RUBYOPT" => [ENV["RUBYOPT"], "--encoding=UTF-8"].compact.join(" ")} +filtered = ->(ext, dirs) do + if ENV.key?(FILES_ENV) + %w[sed -E -n -e] << "/\\.#{ext}$/p" << "--" << ENV.fetch(FILES_ENV) + else + (%w[find] + dirs + %w[-type f -and -name]) << "*.#{ext}" << "-print0" + end +end + desc("Lint `*.rb(i)`") multitask(:"lint:rubocop") do find = %w[find ./lib ./test ./rbi ./examples -type f -and ( -name *.rb -or -name *.rbi ) -print0] @@ -54,24 +62,26 @@ multitask(:"lint:rubocop") do sh("#{find.shelljoin} | #{lint.shelljoin}") end +norm_lines = %w[tr -- \n \0].shelljoin + desc("Format `*.rb`") multitask(:"format:rb") do # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support - files = ENV.key?(FILES_ENV) ? %w[sed -E -z -n -e /\.rb$/p --] << ENV.fetch(FILES_ENV) : %w[find ./lib ./test ./examples -type f -and -name *.rb -print0] + files = filtered["rb", %w[./lib ./test ./examples]] fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --] - sh("#{files.shelljoin} | #{fmt.shelljoin}") + sh("#{files.shelljoin} | #{norm_lines} | #{fmt.shelljoin}") end desc("Format `*.rbi`") multitask(:"format:rbi") do - files = ENV.key?(FILES_ENV) ? %w[sed -E -z -n -e /\.rbi$/p --] << ENV.fetch(FILES_ENV) : %w[find ./rbi -type f -and -name *.rbi -print0] + files = filtered["rbi", %w[./rbi]] fmt = xargs + %w[stree write --] - sh(ruby_opt, "#{files.shelljoin} | #{fmt.shelljoin}") + sh(ruby_opt, "#{files.shelljoin} | #{norm_lines} | #{fmt.shelljoin}") end desc("Format `*.rbs`") multitask(:"format:rbs") do - files = ENV.key?(FILES_ENV) ? %w[sed -E -z -n -e /\.rbs$/p --] << ENV.fetch(FILES_ENV) : %w[find ./sig -type f -name *.rbs -print0] + files = filtered["rbs", %w[./sig]] inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? ["-i", ""] : %w[-i] uuid = SecureRandom.uuid @@ -100,13 +110,13 @@ multitask(:"format:rbs") do success = false # transform class aliases to type aliases, which syntax tree has no trouble with - sh("#{files.shelljoin} | #{pre.shelljoin}") + sh("#{files.shelljoin} | #{norm_lines} | #{pre.shelljoin}") # run syntax tree to format `*.rbs` files - sh(ruby_opt, "#{files.shelljoin} | #{fmt.shelljoin}") do + sh(ruby_opt, "#{files.shelljoin} | #{norm_lines} | #{fmt.shelljoin}") do success = _1 end # transform type aliases back to class aliases - sh("#{files.shelljoin} | #{pst.shelljoin}") + sh("#{files.shelljoin} | #{norm_lines} | #{pst.shelljoin}") # always run post-processing to remove comment marker fail unless success diff --git a/scripts/fast-format b/scripts/fast-format index 8df0aa26..6d5973fb 100755 --- a/scripts/fast-format +++ b/scripts/fast-format @@ -15,7 +15,4 @@ if [ $# -eq 0 ]; then exit 1 fi -FILE="$(mktemp)" -tr -- '\n' '\0' < "$1" > "$FILE" - -exec -- bundle exec rake format FORMAT_FILE="$FILE" +exec -- bundle exec rake format FORMAT_FILE="$1" From bac355d605dfe46b533a7c39b461aab1a1bca5f5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 02:53:25 +0000 Subject: [PATCH 122/178] fix: always send `filename=...` for multipart requests where a file is expected --- lib/imagekit/file_part.rb | 17 ++++++++------ lib/imagekit/internal/type/file_input.rb | 11 +++++---- rbi/imagekit/file_part.rbi | 2 +- sig/imagekit/file_part.rbs | 2 +- test/imagekit/internal/util_test.rb | 29 ++++++++++++++++-------- 5 files changed, 39 insertions(+), 22 deletions(-) diff --git a/lib/imagekit/file_part.rb b/lib/imagekit/file_part.rb index 7676aada..2fbbc110 100644 --- a/lib/imagekit/file_part.rb +++ b/lib/imagekit/file_part.rb @@ -38,18 +38,21 @@ def to_json(*a) = read.to_json(*a) def to_yaml(*a) = read.to_yaml(*a) # @param content [Pathname, StringIO, IO, String] - # @param filename [String, nil] + # @param filename [Pathname, String, nil] # @param content_type [String, nil] def initialize(content, filename: nil, content_type: nil) - @content = content + @content_type = content_type @filename = - case content - in Pathname - filename.nil? ? content.basename.to_path : ::File.basename(filename) + case [filename, (@content = content)] + in [String | Pathname, _] + ::File.basename(filename) + in [nil, Pathname] + content.basename.to_path + in [nil, IO] + content.to_path else - filename.nil? ? nil : ::File.basename(filename) + filename end - @content_type = content_type end end end diff --git a/lib/imagekit/internal/type/file_input.rb b/lib/imagekit/internal/type/file_input.rb index 125add8f..0a2dd463 100644 --- a/lib/imagekit/internal/type/file_input.rb +++ b/lib/imagekit/internal/type/file_input.rb @@ -82,17 +82,20 @@ def coerce(value, state:) # # @return [Pathname, StringIO, IO, String, Object] def dump(value, state:) - # rubocop:disable Lint/DuplicateBranch case value + in StringIO | String + # https://datatracker.ietf.org/doc/html/rfc7578#section-4.2 + # while not required, a filename is recommended, and in practice many servers do expect this + Imagekit::FilePart.new(value, filename: "upload") in IO state[:can_retry] = false + value.to_path.nil? ? Imagekit::FilePart.new(value, filename: "upload") : value in Imagekit::FilePart if value.content.is_a?(IO) state[:can_retry] = false + value else + value end - # rubocop:enable Lint/DuplicateBranch - - value end # @api private diff --git a/rbi/imagekit/file_part.rbi b/rbi/imagekit/file_part.rbi index 6662978f..b19ed2fb 100644 --- a/rbi/imagekit/file_part.rbi +++ b/rbi/imagekit/file_part.rbi @@ -27,7 +27,7 @@ module Imagekit sig do params( content: T.any(Pathname, StringIO, IO, String), - filename: T.nilable(String), + filename: T.nilable(T.any(Pathname, String)), content_type: T.nilable(String) ).returns(T.attached_class) end diff --git a/sig/imagekit/file_part.rbs b/sig/imagekit/file_part.rbs index 3a8befa0..0e12e8df 100644 --- a/sig/imagekit/file_part.rbs +++ b/sig/imagekit/file_part.rbs @@ -14,7 +14,7 @@ module Imagekit def initialize: ( Pathname | StringIO | IO | String content, - ?filename: String?, + ?filename: (Pathname | String)?, ?content_type: String? ) -> void end diff --git a/test/imagekit/internal/util_test.rb b/test/imagekit/internal/util_test.rb index ad3a9a4e..22bb128f 100644 --- a/test/imagekit/internal/util_test.rb +++ b/test/imagekit/internal/util_test.rb @@ -227,20 +227,24 @@ def test_encoding_length def test_file_encode file = Pathname(__FILE__) + fileinput = Imagekit::Internal::Type::Converter.dump(Imagekit::Internal::Type::FileInput, "abc") headers = {"content-type" => "multipart/form-data"} cases = { - "abc" => "abc", - StringIO.new("abc") => "abc", - Imagekit::FilePart.new("abc") => "abc", - Imagekit::FilePart.new(StringIO.new("abc")) => "abc", - file => /^class Imagekit/, - Imagekit::FilePart.new(file) => /^class Imagekit/ + "abc" => ["", "abc"], + StringIO.new("abc") => ["", "abc"], + fileinput => %w[upload abc], + Imagekit::FilePart.new(StringIO.new("abc")) => ["", "abc"], + file => [file.basename.to_path, /^class Imagekit/], + Imagekit::FilePart.new(file, filename: "d o g") => ["d%20o%20g", /^class Imagekit/] } - cases.each do |body, val| + cases.each do |body, testcase| + filename, val = testcase encoded = Imagekit::Internal::Util.encode_content(headers, body) cgi = FakeCGI.new(*encoded) + io = cgi[""] assert_pattern do - cgi[""].read => ^val + io.original_filename => ^filename + io.read => ^val end end end @@ -261,7 +265,14 @@ def test_hash_encode cgi = FakeCGI.new(*encoded) testcase.each do |key, val| assert_pattern do - cgi[key] => ^val + parsed = + case (p = cgi[key]) + in StringIO + p.read + else + p + end + parsed => ^val end end end From 8fc2c84a4fb0d161f6296fda03c866a951d2ea73 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 07:21:54 +0000 Subject: [PATCH 123/178] feat(api): add path policy related non-breaking changes --- .stats.yml | 4 ++-- .../models/beta/v2/file_upload_params.rb | 1 + .../models/custom_metadata_field_list_params.rb | 13 ++++++++++++- lib/imagekit/models/file_upload_params.rb | 1 + .../resources/custom_metadata_fields.rb | 11 +++++++++-- .../models/beta/v2/file_upload_params.rbi | 5 +++++ .../custom_metadata_field_list_params.rbi | 17 +++++++++++++++++ rbi/imagekit/models/file_upload_params.rbi | 5 +++++ .../resources/custom_metadata_fields.rbi | 11 +++++++++++ .../models/beta/v2/file_upload_params.rbs | 2 ++ .../custom_metadata_field_list_params.rbs | 9 ++++++++- sig/imagekit/models/file_upload_params.rbs | 2 ++ .../resources/custom_metadata_fields.rbs | 1 + 13 files changed, 76 insertions(+), 6 deletions(-) diff --git a/.stats.yml b/.stats.yml index 7c3aae1c..da19a2b5 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 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-1499148ce5fc81b4d8c8b3eaadf7adfaf54df5fa0b3a0452c3f5ef0dfe884a95.yml +openapi_spec_hash: e91526b143d3e696bef2b4d0ea3aa2b4 config_hash: e42d7fc3a8c92c35099cc283f9a4467a diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index 2b4cc97d..4117e1bf 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -262,6 +262,7 @@ module ResponseField IS_PUBLISHED = :isPublished CUSTOM_METADATA = :customMetadata METADATA = :metadata + SELECTED_FIELDS_SCHEMA = :selectedFieldsSchema # @!method self.values # @return [Array] diff --git a/lib/imagekit/models/custom_metadata_field_list_params.rb b/lib/imagekit/models/custom_metadata_field_list_params.rb index f2c94cec..9ffc8a12 100644 --- a/lib/imagekit/models/custom_metadata_field_list_params.rb +++ b/lib/imagekit/models/custom_metadata_field_list_params.rb @@ -7,16 +7,27 @@ class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters + # @!attribute folder_path + # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable + # custom metadata fields. + # Useful for determining path-specific field selections when the + # [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use. + # + # @return [String, nil] + optional :folder_path, String + # @!attribute include_deleted # Set it to `true` to include deleted field objects in the API response. # # @return [Boolean, nil] optional :include_deleted, Imagekit::Internal::Type::Boolean - # @!method initialize(include_deleted: nil, request_options: {}) + # @!method initialize(folder_path: nil, include_deleted: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Imagekit::Models::CustomMetadataFieldListParams} for more details. # + # @param folder_path [String] The folder path (e.g., `/path/to/folder`) for which to retrieve applicable custo + # # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. # # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index 282c8f74..3d8df9b3 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -297,6 +297,7 @@ module ResponseField IS_PUBLISHED = :isPublished CUSTOM_METADATA = :customMetadata METADATA = :metadata + SELECTED_FIELDS_SCHEMA = :selectedFieldsSchema # @!method self.values # @return [Array] diff --git a/lib/imagekit/resources/custom_metadata_fields.rb b/lib/imagekit/resources/custom_metadata_fields.rb index 29da6980..3dc56680 100644 --- a/lib/imagekit/resources/custom_metadata_fields.rb +++ b/lib/imagekit/resources/custom_metadata_fields.rb @@ -71,7 +71,14 @@ def update(id, params = {}) # the API returns only non deleted field objects, but you can include deleted # fields in the API response. # - # @overload list(include_deleted: nil, request_options: {}) + # You can also filter results by a specific folder path to retrieve custom + # metadata fields applicable at that location. This path-specific filtering is + # useful when using the **Path policy** feature to determine which custom metadata + # fields are selected for a given path. + # + # @overload list(folder_path: nil, include_deleted: nil, request_options: {}) + # + # @param folder_path [String] The folder path (e.g., `/path/to/folder`) for which to retrieve applicable custo # # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. # @@ -85,7 +92,7 @@ def list(params = {}) @client.request( method: :get, path: "v1/customMetadataFields", - query: parsed.transform_keys(include_deleted: "includeDeleted"), + query: parsed.transform_keys(folder_path: "folderPath", include_deleted: "includeDeleted"), model: Imagekit::Internal::Type::ArrayOf[Imagekit::CustomMetadataField], options: options ) diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi index b09ec71f..91f54bd2 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -504,6 +504,11 @@ module Imagekit :metadata, Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) + SELECTED_FIELDS_SCHEMA = + T.let( + :selectedFieldsSchema, + Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/imagekit/models/custom_metadata_field_list_params.rbi b/rbi/imagekit/models/custom_metadata_field_list_params.rbi index db9f7dac..a74feb8d 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_list_params.rbi @@ -14,6 +14,16 @@ module Imagekit ) end + # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable + # custom metadata fields. + # Useful for determining path-specific field selections when the + # [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use. + sig { returns(T.nilable(String)) } + attr_reader :folder_path + + sig { params(folder_path: String).void } + attr_writer :folder_path + # Set it to `true` to include deleted field objects in the API response. sig { returns(T.nilable(T::Boolean)) } attr_reader :include_deleted @@ -23,11 +33,17 @@ module Imagekit sig do params( + folder_path: String, include_deleted: T::Boolean, request_options: Imagekit::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable + # custom metadata fields. + # Useful for determining path-specific field selections when the + # [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use. + folder_path: nil, # Set it to `true` to include deleted field objects in the API response. include_deleted: nil, request_options: {} @@ -37,6 +53,7 @@ module Imagekit sig do override.returns( { + folder_path: String, include_deleted: T::Boolean, request_options: Imagekit::RequestOptions } diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 3c74f2da..6d987762 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -541,6 +541,11 @@ module Imagekit :metadata, Imagekit::FileUploadParams::ResponseField::TaggedSymbol ) + SELECTED_FIELDS_SCHEMA = + T.let( + :selectedFieldsSchema, + Imagekit::FileUploadParams::ResponseField::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/imagekit/resources/custom_metadata_fields.rbi b/rbi/imagekit/resources/custom_metadata_fields.rbi index ed2578c3..88e38418 100644 --- a/rbi/imagekit/resources/custom_metadata_fields.rbi +++ b/rbi/imagekit/resources/custom_metadata_fields.rbi @@ -58,13 +58,24 @@ module Imagekit # 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. + # + # You can also filter results by a specific folder path to retrieve custom + # metadata fields applicable at that location. This path-specific filtering is + # useful when using the **Path policy** feature to determine which custom metadata + # fields are selected for a given path. sig do params( + folder_path: String, include_deleted: T::Boolean, request_options: Imagekit::RequestOptions::OrHash ).returns(T::Array[Imagekit::CustomMetadataField]) end def list( + # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable + # custom metadata fields. + # Useful for determining path-specific field selections when the + # [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use. + folder_path: nil, # Set it to `true` to include deleted field objects in the API response. include_deleted: nil, request_options: {} diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekit/models/beta/v2/file_upload_params.rbs index d9f7ef7f..9ae50878 100644 --- a/sig/imagekit/models/beta/v2/file_upload_params.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_params.rbs @@ -169,6 +169,7 @@ module Imagekit | :isPublished | :customMetadata | :metadata + | :selectedFieldsSchema module ResponseField extend Imagekit::Internal::Type::Enum @@ -180,6 +181,7 @@ module Imagekit IS_PUBLISHED: :isPublished CUSTOM_METADATA: :customMetadata METADATA: :metadata + SELECTED_FIELDS_SCHEMA: :selectedFieldsSchema def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] end diff --git a/sig/imagekit/models/custom_metadata_field_list_params.rbs b/sig/imagekit/models/custom_metadata_field_list_params.rbs index 314b835e..c1359525 100644 --- a/sig/imagekit/models/custom_metadata_field_list_params.rbs +++ b/sig/imagekit/models/custom_metadata_field_list_params.rbs @@ -1,22 +1,29 @@ module Imagekit module Models type custom_metadata_field_list_params = - { include_deleted: bool } & Imagekit::Internal::Type::request_parameters + { folder_path: String, include_deleted: bool } + & Imagekit::Internal::Type::request_parameters class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel extend Imagekit::Internal::Type::RequestParameters::Converter include Imagekit::Internal::Type::RequestParameters + attr_reader folder_path: String? + + def folder_path=: (String) -> String + attr_reader include_deleted: bool? def include_deleted=: (bool) -> bool def initialize: ( + ?folder_path: String, ?include_deleted: bool, ?request_options: Imagekit::request_opts ) -> void def to_hash: -> { + folder_path: String, include_deleted: bool, request_options: Imagekit::RequestOptions } diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index 62ca0281..4a819dc1 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -188,6 +188,7 @@ module Imagekit | :isPublished | :customMetadata | :metadata + | :selectedFieldsSchema module ResponseField extend Imagekit::Internal::Type::Enum @@ -199,6 +200,7 @@ module Imagekit IS_PUBLISHED: :isPublished CUSTOM_METADATA: :customMetadata METADATA: :metadata + SELECTED_FIELDS_SCHEMA: :selectedFieldsSchema def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::response_field] end diff --git a/sig/imagekit/resources/custom_metadata_fields.rbs b/sig/imagekit/resources/custom_metadata_fields.rbs index f14f6f73..23ba7089 100644 --- a/sig/imagekit/resources/custom_metadata_fields.rbs +++ b/sig/imagekit/resources/custom_metadata_fields.rbs @@ -16,6 +16,7 @@ module Imagekit ) -> Imagekit::CustomMetadataField def list: ( + ?folder_path: String, ?include_deleted: bool, ?request_options: Imagekit::request_opts ) -> Imagekit::Models::custom_metadata_field_list_response From da6ea58c21979419bf779b48e9cb2ea942d8c181 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 07:25:00 +0000 Subject: [PATCH 124/178] feat(api): updated docs --- .stats.yml | 4 ++-- .../models/custom_metadata_field_list_params.rb | 6 +++--- .../models/custom_metadata_field_list_params.rbi | 12 ++++++------ rbi/imagekit/resources/custom_metadata_fields.rbi | 6 +++--- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.stats.yml b/.stats.yml index da19a2b5..6b1c558b 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-1499148ce5fc81b4d8c8b3eaadf7adfaf54df5fa0b3a0452c3f5ef0dfe884a95.yml -openapi_spec_hash: e91526b143d3e696bef2b4d0ea3aa2b4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-8d944c932f09191791cc09e90ebf8142e523c0a6dd82ae9d1dbd7ff884acfc4b.yml +openapi_spec_hash: 179e38a7a472a5f98d17aed41099cbfd config_hash: e42d7fc3a8c92c35099cc283f9a4467a diff --git a/lib/imagekit/models/custom_metadata_field_list_params.rb b/lib/imagekit/models/custom_metadata_field_list_params.rb index 9ffc8a12..37650f76 100644 --- a/lib/imagekit/models/custom_metadata_field_list_params.rb +++ b/lib/imagekit/models/custom_metadata_field_list_params.rb @@ -9,9 +9,9 @@ class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel # @!attribute folder_path # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable - # custom metadata fields. - # Useful for determining path-specific field selections when the - # [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use. + # custom metadata fields. Useful for determining path-specific field selections + # when the [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in + # use. # # @return [String, nil] optional :folder_path, String diff --git a/rbi/imagekit/models/custom_metadata_field_list_params.rbi b/rbi/imagekit/models/custom_metadata_field_list_params.rbi index a74feb8d..b4c95edf 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_params.rbi +++ b/rbi/imagekit/models/custom_metadata_field_list_params.rbi @@ -15,9 +15,9 @@ module Imagekit end # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable - # custom metadata fields. - # Useful for determining path-specific field selections when the - # [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use. + # custom metadata fields. Useful for determining path-specific field selections + # when the [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in + # use. sig { returns(T.nilable(String)) } attr_reader :folder_path @@ -40,9 +40,9 @@ module Imagekit end def self.new( # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable - # custom metadata fields. - # Useful for determining path-specific field selections when the - # [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use. + # custom metadata fields. Useful for determining path-specific field selections + # when the [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in + # use. folder_path: nil, # Set it to `true` to include deleted field objects in the API response. include_deleted: nil, diff --git a/rbi/imagekit/resources/custom_metadata_fields.rbi b/rbi/imagekit/resources/custom_metadata_fields.rbi index 88e38418..15e89170 100644 --- a/rbi/imagekit/resources/custom_metadata_fields.rbi +++ b/rbi/imagekit/resources/custom_metadata_fields.rbi @@ -72,9 +72,9 @@ module Imagekit end def list( # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable - # custom metadata fields. - # Useful for determining path-specific field selections when the - # [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use. + # custom metadata fields. Useful for determining path-specific field selections + # when the [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in + # use. folder_path: nil, # Set it to `true` to include deleted field objects in the API response. include_deleted: nil, From 94dfd3a07800168ca0d5f6afc631284413af1bd6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 07:29:25 +0000 Subject: [PATCH 125/178] feat(api): add selectedFieldsSchema in upload and list API response --- .stats.yml | 4 +- .../models/beta/v2/file_upload_params.rb | 229 +++++++++- lib/imagekit/models/file.rb | 222 ++++++++- lib/imagekit/models/file_upload_params.rb | 226 ++++++++- lib/imagekit/resources/beta/v2/files.rb | 4 +- lib/imagekit/resources/files.rb | 4 +- .../models/beta/v2/file_upload_params.rbi | 431 ++++++++++++++++++ rbi/imagekit/models/file.rbi | 395 ++++++++++++++++ rbi/imagekit/models/file_upload_params.rbi | 425 +++++++++++++++++ rbi/imagekit/resources/beta/v2/files.rbi | 13 + rbi/imagekit/resources/files.rbi | 13 + .../models/beta/v2/file_upload_params.rbs | 166 +++++++ sig/imagekit/models/file.rbs | 166 +++++++ sig/imagekit/models/file_upload_params.rbs | 166 +++++++ sig/imagekit/resources/beta/v2/files.rbs | 1 + sig/imagekit/resources/files.rbs | 1 + .../imagekit/resources/files/versions_test.rb | 2 + test/imagekit/resources/files_test.rb | 1 + 18 files changed, 2462 insertions(+), 7 deletions(-) diff --git a/.stats.yml b/.stats.yml index 6b1c558b..bceb847c 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-8d944c932f09191791cc09e90ebf8142e523c0a6dd82ae9d1dbd7ff884acfc4b.yml -openapi_spec_hash: 179e38a7a472a5f98d17aed41099cbfd +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-7a42233daaf82345cc6d92cc49d4885126176b014c05ea0618c035869319fe53.yml +openapi_spec_hash: c41b1b6062b7c2ea548b16e0462aa358 config_hash: e42d7fc3a8c92c35099cc283f9a4467a diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index 4117e1bf..0571b957 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -160,6 +160,22 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel }, api_name: :responseFields + # @!attribute selected_fields_schema + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + # + # @return [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema}, nil] + optional :selected_fields_schema, + -> { + Imagekit::Internal::Type::HashOf[Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema] + }, + api_name: :selectedFieldsSchema + # @!attribute 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 @@ -206,7 +222,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :webhook_url, String, api_name: :webhookUrl - # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, selected_fields_schema: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Imagekit::Models::Beta::V2::FileUploadParams} for more details. # @@ -242,6 +258,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param response_fields [Array] Array of response field keys to include in the API response body. # + # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # # @param tags [Array] Set the tags while uploading the file. # # @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. @@ -268,6 +286,215 @@ module ResponseField # @return [Array] end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue }, + api_name: :minValue + + # @!attribute read_only + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + # + # @return [Boolean, nil] + optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption] + }, + api_name: :selectOptions + + # @!attribute select_options_truncated + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + # + # @return [Boolean, nil] + optional :select_options_truncated, + Imagekit::Internal::Type::Boolean, + api_name: :selectOptionsTruncated + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema} for more + # details. + # + # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty + # + # @param is_value_required [Boolean] Specifies if the custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o + + # Type of the custom metadata field. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXTAREA = :Textarea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::MixedArray } + + module Mixed + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed + }] + end + + # 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. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute post # List of transformations to apply _after_ the file is uploaded. diff --git a/lib/imagekit/models/file.rb b/lib/imagekit/models/file.rb index d1c2aacb..7bc653cd 100644 --- a/lib/imagekit/models/file.rb +++ b/lib/imagekit/models/file.rb @@ -98,6 +98,20 @@ class File < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :name, String + # @!attribute selected_fields_schema + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + # + # @return [Hash{Symbol=>Imagekit::Models::File::SelectedFieldsSchema}, nil] + optional :selected_fields_schema, + -> { Imagekit::Internal::Type::HashOf[Imagekit::File::SelectedFieldsSchema] }, + api_name: :selectedFieldsSchema + # @!attribute size # Size of the file in bytes. # @@ -149,7 +163,7 @@ class File < Imagekit::Internal::Type::BaseModel # @return [Float, nil] optional :width, Float - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) # Some parameter documentations has been truncated, see {Imagekit::Models::File} # for more details. # @@ -183,6 +197,8 @@ class File < Imagekit::Internal::Type::BaseModel # # @param name [String] Name of the asset. # + # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::File::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # # @param size [Float] Size of the file in bytes. # # @param tags [Array, nil] An array of tags assigned to the file. Tags are used to search files in the medi @@ -230,6 +246,210 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::File::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekit::File::SelectedFieldsSchema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::File::SelectedFieldsSchema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, union: -> { Imagekit::File::SelectedFieldsSchema::MaxValue }, api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, union: -> { Imagekit::File::SelectedFieldsSchema::MinValue }, api_name: :minValue + + # @!attribute read_only + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + # + # @return [Boolean, nil] + optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::File::SelectedFieldsSchema::SelectOption] + }, + api_name: :selectOptions + + # @!attribute select_options_truncated + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + # + # @return [Boolean, nil] + optional :select_options_truncated, + Imagekit::Internal::Type::Boolean, + api_name: :selectOptionsTruncated + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::File::SelectedFieldsSchema} for more details. + # + # @param type [Symbol, Imagekit::Models::File::SelectedFieldsSchema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty + # + # @param is_value_required [Boolean] Specifies if the custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o + + # Type of the custom metadata field. + # + # @see Imagekit::Models::File::SelectedFieldsSchema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXTAREA = :Textarea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @see Imagekit::Models::File::SelectedFieldsSchema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::File::SelectedFieldsSchema::DefaultValue::MixedArray } + + module Mixed + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { + Imagekit::File::SelectedFieldsSchema::DefaultValue::Mixed + }] + end + + # 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. + # + # @see Imagekit::Models::File::SelectedFieldsSchema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::File::SelectedFieldsSchema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + # Type of the asset. # # @see Imagekit::Models::File#type diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index 3d8df9b3..4c17089a 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -178,6 +178,20 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel -> { Imagekit::Internal::Type::ArrayOf[enum: Imagekit::FileUploadParams::ResponseField] }, api_name: :responseFields + # @!attribute selected_fields_schema + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + # + # @return [Hash{Symbol=>Imagekit::Models::FileUploadParams::SelectedFieldsSchema}, nil] + optional :selected_fields_schema, + -> { Imagekit::Internal::Type::HashOf[Imagekit::FileUploadParams::SelectedFieldsSchema] }, + api_name: :selectedFieldsSchema + # @!attribute 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 @@ -235,7 +249,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :webhook_url, String, api_name: :webhookUrl - # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, selected_fields_schema: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadParams} for more details. # @@ -275,6 +289,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param response_fields [Array] Array of response field keys to include in the API response body. # + # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a # # @param tags [Array] Set the tags while uploading the file. @@ -303,6 +319,214 @@ module ResponseField # @return [Array] end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::FileUploadParams::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekit::FileUploadParams::SelectedFieldsSchema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue }, + api_name: :minValue + + # @!attribute read_only + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + # + # @return [Boolean, nil] + optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption] + }, + api_name: :selectOptions + + # @!attribute select_options_truncated + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + # + # @return [Boolean, nil] + optional :select_options_truncated, + Imagekit::Internal::Type::Boolean, + api_name: :selectOptionsTruncated + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadParams::SelectedFieldsSchema} for more details. + # + # @param type [Symbol, Imagekit::Models::FileUploadParams::SelectedFieldsSchema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty + # + # @param is_value_required [Boolean] Specifies if the custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o + + # Type of the custom metadata field. + # + # @see Imagekit::Models::FileUploadParams::SelectedFieldsSchema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXTAREA = :Textarea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @see Imagekit::Models::FileUploadParams::SelectedFieldsSchema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::FileUploadParams::SelectedFieldsSchema::DefaultValue::MixedArray } + + module Mixed + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed + }] + end + + # 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. + # + # @see Imagekit::Models::FileUploadParams::SelectedFieldsSchema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::FileUploadParams::SelectedFieldsSchema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute post # List of transformations to apply _after_ the file is uploaded. diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekit/resources/beta/v2/files.rb index 670d5a60..db7c62bc 100644 --- a/lib/imagekit/resources/beta/v2/files.rb +++ b/lib/imagekit/resources/beta/v2/files.rb @@ -36,7 +36,7 @@ class Files # - [Quick start guides](/docs/quick-start-guides) for various frameworks and # technologies. # - # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, selected_fields_schema: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # @@ -70,6 +70,8 @@ class Files # # @param response_fields [Array] Array of response field keys to include in the API response body. # + # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # # @param tags [Array] Set the tags while uploading the file. # # @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index 2ddc77ef..b120077b 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -224,7 +224,7 @@ def rename(params) # - [Quick start guides](/docs/quick-start-guides) for various frameworks and # technologies. # - # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, selected_fields_schema: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # @@ -262,6 +262,8 @@ def rename(params) # # @param response_fields [Array] Array of response field keys to include in the API response body. # + # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a # # @param tags [Array] Set the tags while uploading the file. diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi index 91f54bd2..5e04259d 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -207,6 +207,36 @@ module Imagekit end attr_writer :response_fields + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema + ] + ) + ) + end + attr_reader :selected_fields_schema + + sig do + params( + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::OrHash + ] + ).void + end + attr_writer :selected_fields_schema + # 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 @@ -294,6 +324,11 @@ module Imagekit T::Array[ Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::OrHash + ], tags: T::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash, @@ -382,6 +417,14 @@ module Imagekit overwrite_tags: nil, # Array of response field keys to include in the API response body. response_fields: nil, + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + selected_fields_schema: nil, # 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 @@ -445,6 +488,11 @@ module Imagekit T::Array[ Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema + ], tags: T::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, @@ -521,6 +569,389 @@ module Imagekit end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol + ) + end + attr_accessor :type + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + sig do + returns( + T.nilable( + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants + ).void + end + attr_writer :min_value + + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :read_only + + sig { params(read_only: T::Boolean).void } + attr_writer :read_only + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :select_options_truncated + + sig { params(select_options_truncated: T::Boolean).void } + attr_writer :select_options_truncated + + sig do + params( + type: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol, + default_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + default_value: nil, + # Specifies if the custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + read_only: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil, + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + select_options_truncated: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol, + default_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + TEXTAREA = + T.let( + :Textarea, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + class Transformation < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/file.rbi b/rbi/imagekit/models/file.rbi index 4d68e344..febf4c75 100644 --- a/rbi/imagekit/models/file.rbi +++ b/rbi/imagekit/models/file.rbi @@ -103,6 +103,28 @@ module Imagekit sig { params(name: String).void } attr_writer :name + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + sig do + returns( + T.nilable(T::Hash[Symbol, Imagekit::File::SelectedFieldsSchema]) + ) + end + attr_reader :selected_fields_schema + + sig do + params( + selected_fields_schema: + T::Hash[Symbol, Imagekit::File::SelectedFieldsSchema::OrHash] + ).void + end + attr_writer :selected_fields_schema + # Size of the file in bytes. sig { returns(T.nilable(Float)) } attr_reader :size @@ -176,6 +198,8 @@ module Imagekit is_published: T::Boolean, mime: String, name: String, + selected_fields_schema: + T::Hash[Symbol, Imagekit::File::SelectedFieldsSchema::OrHash], size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, @@ -220,6 +244,14 @@ module Imagekit mime: nil, # Name of the asset. name: nil, + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + selected_fields_schema: nil, # Size of the file in bytes. size: nil, # An array of tags assigned to the file. Tags are used to search files in the @@ -259,6 +291,8 @@ module Imagekit is_published: T::Boolean, mime: String, name: String, + selected_fields_schema: + T::Hash[Symbol, Imagekit::File::SelectedFieldsSchema], size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, @@ -324,6 +358,367 @@ module Imagekit end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::File::SelectedFieldsSchema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns(Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol) + end + attr_accessor :type + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + sig do + returns( + T.nilable( + Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable(Imagekit::File::SelectedFieldsSchema::MaxValue::Variants) + ) + end + attr_reader :max_value + + sig do + params( + max_value: Imagekit::File::SelectedFieldsSchema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable(Imagekit::File::SelectedFieldsSchema::MinValue::Variants) + ) + end + attr_reader :min_value + + sig do + params( + min_value: Imagekit::File::SelectedFieldsSchema::MinValue::Variants + ).void + end + attr_writer :min_value + + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :read_only + + sig { params(read_only: T::Boolean).void } + attr_writer :read_only + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :select_options_truncated + + sig { params(select_options_truncated: T::Boolean).void } + attr_writer :select_options_truncated + + sig do + params( + type: Imagekit::File::SelectedFieldsSchema::Type::OrSymbol, + default_value: + Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: Imagekit::File::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: Imagekit::File::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + default_value: nil, + # Specifies if the custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + read_only: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil, + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + select_options_truncated: nil + ) + end + + sig do + override.returns( + { + type: Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol, + default_value: + Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::File::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::File::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Imagekit::File::SelectedFieldsSchema::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + ) + TEXTAREA = + T.let( + :Textarea, + Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::File::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::File::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: Imagekit::File::SelectedFieldsSchema::DefaultValue::Mixed + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[Imagekit::File::SelectedFieldsSchema::MaxValue::Variants] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[Imagekit::File::SelectedFieldsSchema::MinValue::Variants] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + # Type of the asset. module Type extend Imagekit::Internal::Type::Enum diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index 6d987762..d28caa2a 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -222,6 +222,33 @@ module Imagekit end attr_writer :response_fields + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + sig do + returns( + T.nilable( + T::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema] + ) + ) + end + attr_reader :selected_fields_schema + + sig do + params( + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::FileUploadParams::SelectedFieldsSchema::OrHash + ] + ).void + end + attr_writer :selected_fields_schema + # 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. @@ -316,6 +343,11 @@ module Imagekit public_key: String, response_fields: T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::FileUploadParams::SelectedFieldsSchema::OrHash + ], signature: String, tags: T::Array[String], transformation: Imagekit::FileUploadParams::Transformation::OrHash, @@ -418,6 +450,14 @@ module Imagekit public_key: nil, # Array of response field keys to include in the API response body. response_fields: nil, + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + selected_fields_schema: nil, # 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. @@ -488,6 +528,8 @@ module Imagekit public_key: String, response_fields: T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], + selected_fields_schema: + T::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], signature: String, tags: T::Array[String], transformation: Imagekit::FileUploadParams::Transformation, @@ -556,6 +598,389 @@ module Imagekit end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::FileUploadParams::SelectedFieldsSchema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol + ) + end + attr_accessor :type + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + sig do + returns( + T.nilable( + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants + ).void + end + attr_writer :min_value + + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :read_only + + sig { params(read_only: T::Boolean).void } + attr_writer :read_only + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :select_options_truncated + + sig { params(select_options_truncated: T::Boolean).void } + attr_writer :select_options_truncated + + sig do + params( + type: + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol, + default_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + default_value: nil, + # Specifies if the custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + read_only: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil, + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + select_options_truncated: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol, + default_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::FileUploadParams::SelectedFieldsSchema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + TEXTAREA = + T.let( + :Textarea, + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + class Transformation < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekit/resources/beta/v2/files.rbi index b78dc1c3..5cfc8118 100644 --- a/rbi/imagekit/resources/beta/v2/files.rbi +++ b/rbi/imagekit/resources/beta/v2/files.rbi @@ -60,6 +60,11 @@ module Imagekit T::Array[ Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::OrHash + ], tags: T::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash, @@ -148,6 +153,14 @@ module Imagekit overwrite_tags: nil, # Array of response field keys to include in the API response body. response_fields: nil, + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + selected_fields_schema: nil, # 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 diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index cec1cf6e..a7e102d8 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -212,6 +212,11 @@ module Imagekit public_key: String, response_fields: T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::FileUploadParams::SelectedFieldsSchema::OrHash + ], signature: String, tags: T::Array[String], transformation: Imagekit::FileUploadParams::Transformation::OrHash, @@ -314,6 +319,14 @@ module Imagekit public_key: nil, # Array of response field keys to include in the API response body. response_fields: nil, + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + selected_fields_schema: nil, # 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. diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekit/models/beta/v2/file_upload_params.rbs index 9ae50878..ba890cfd 100644 --- a/sig/imagekit/models/beta/v2/file_upload_params.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_params.rbs @@ -20,6 +20,7 @@ module Imagekit overwrite_file: bool, overwrite_tags: bool, response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema], tags: ::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, use_unique_file_name: bool, @@ -95,6 +96,12 @@ module Imagekit ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema] + attr_reader tags: ::Array[String]? def tags=: (::Array[String]) -> ::Array[String] @@ -130,6 +137,7 @@ module Imagekit ?overwrite_file: bool, ?overwrite_tags: bool, ?response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + ?selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema], ?tags: ::Array[String], ?transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, ?use_unique_file_name: bool, @@ -154,6 +162,7 @@ module Imagekit overwrite_file: bool, overwrite_tags: bool, response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema], tags: ::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, use_unique_file_name: bool, @@ -186,6 +195,163 @@ module Imagekit def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] end + type selected_fields_schema = + { + type: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value + ) -> Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value + ) -> Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value + ) -> Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_, + ?default_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value] + + MixedArray: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option] + end + end + type transformation = { post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post], diff --git a/sig/imagekit/models/file.rbs b/sig/imagekit/models/file.rbs index 9331ad13..4758455c 100644 --- a/sig/imagekit/models/file.rbs +++ b/sig/imagekit/models/file.rbs @@ -16,6 +16,7 @@ module Imagekit is_published: bool, mime: String, name: String, + selected_fields_schema: ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail: String, @@ -79,6 +80,12 @@ module Imagekit def name=: (String) -> String + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema] + attr_reader size: Float? def size=: (Float) -> Float @@ -128,6 +135,7 @@ module Imagekit ?is_published: bool, ?mime: String, ?name: String, + ?selected_fields_schema: ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema], ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, @@ -153,6 +161,7 @@ module Imagekit is_published: bool, mime: String, name: String, + selected_fields_schema: ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail: String, @@ -187,6 +196,163 @@ module Imagekit def to_hash: -> { confidence: Float, name: String, source: String } end + type selected_fields_schema = + { + type: Imagekit::Models::File::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::File::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::File::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::File::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::File::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekit::Models::File::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekit::Models::File::SelectedFieldsSchema::default_value + ) -> Imagekit::Models::File::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::File::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekit::Models::File::SelectedFieldsSchema::max_value + ) -> Imagekit::Models::File::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::File::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekit::Models::File::SelectedFieldsSchema::min_value + ) -> Imagekit::Models::File::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekit::Models::File::SelectedFieldsSchema::type_, + ?default_value: Imagekit::Models::File::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::File::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::File::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekit::Models::File::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::File::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::File::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::File::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::File::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::default_value] + + MixedArray: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option] + end + end + type type_ = :file | :"file-version" module Type diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index 4a819dc1..baa5baa9 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -20,6 +20,7 @@ module Imagekit overwrite_tags: bool, public_key: String, response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], signature: String, tags: ::Array[String], transformation: Imagekit::FileUploadParams::Transformation, @@ -104,6 +105,12 @@ module Imagekit ::Array[Imagekit::Models::FileUploadParams::response_field] ) -> ::Array[Imagekit::Models::FileUploadParams::response_field] + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema] + attr_reader signature: String? def signature=: (String) -> String @@ -145,6 +152,7 @@ module Imagekit ?overwrite_tags: bool, ?public_key: String, ?response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + ?selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], ?signature: String, ?tags: ::Array[String], ?transformation: Imagekit::FileUploadParams::Transformation, @@ -172,6 +180,7 @@ module Imagekit overwrite_tags: bool, public_key: String, response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], signature: String, tags: ::Array[String], transformation: Imagekit::FileUploadParams::Transformation, @@ -205,6 +214,163 @@ module Imagekit def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::response_field] end + type selected_fields_schema = + { + type: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value + ) -> Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value + ) -> Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value + ) -> Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_, + ?default_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value] + + MixedArray: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option] + end + end + type transformation = { post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post], diff --git a/sig/imagekit/resources/beta/v2/files.rbs b/sig/imagekit/resources/beta/v2/files.rbs index a2d266ae..0519cf69 100644 --- a/sig/imagekit/resources/beta/v2/files.rbs +++ b/sig/imagekit/resources/beta/v2/files.rbs @@ -20,6 +20,7 @@ module Imagekit ?overwrite_file: bool, ?overwrite_tags: bool, ?response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + ?selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema], ?tags: ::Array[String], ?transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, ?use_unique_file_name: bool, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index e2c281c0..1a68270a 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -62,6 +62,7 @@ module Imagekit ?overwrite_tags: bool, ?public_key: String, ?response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + ?selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], ?signature: String, ?tags: ::Array[String], ?transformation: Imagekit::FileUploadParams::Transformation, diff --git a/test/imagekit/resources/files/versions_test.rb b/test/imagekit/resources/files/versions_test.rb index cb25fb21..a2a71dbf 100644 --- a/test/imagekit/resources/files/versions_test.rb +++ b/test/imagekit/resources/files/versions_test.rb @@ -54,6 +54,7 @@ def test_get_required_params is_published: Imagekit::Internal::Type::Boolean | nil, mime: String | nil, name: String | nil, + selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::File::SelectedFieldsSchema]) | nil, size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, @@ -91,6 +92,7 @@ def test_restore_required_params is_published: Imagekit::Internal::Type::Boolean | nil, mime: String | nil, name: String | nil, + selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::File::SelectedFieldsSchema]) | nil, size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index c09eb4bb..87d26254 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -65,6 +65,7 @@ def test_get is_published: Imagekit::Internal::Type::Boolean | nil, mime: String | nil, name: String | nil, + selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::File::SelectedFieldsSchema]) | nil, size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, From 0102bc1986fdeeaeba0972d18b7f01a0137c55a5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 07:39:04 +0000 Subject: [PATCH 126/178] docs: correct typo in default value description for custom metadata field --- .stats.yml | 4 ++-- lib/imagekit/models/custom_metadata_field.rb | 6 +++--- rbi/imagekit/models/custom_metadata_field.rbi | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.stats.yml b/.stats.yml index bceb847c..56e1384b 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-7a42233daaf82345cc6d92cc49d4885126176b014c05ea0618c035869319fe53.yml -openapi_spec_hash: c41b1b6062b7c2ea548b16e0462aa358 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-aa4c8e857ae03b12dabf168c83c62f759e2706d69fa4eb77d11519d45a5dada2.yml +openapi_spec_hash: 6ea00242c4685fb6422328f0dd53f9b1 config_hash: e42d7fc3a8c92c35099cc283f9a4467a diff --git a/lib/imagekit/models/custom_metadata_field.rb b/lib/imagekit/models/custom_metadata_field.rb index c82382bc..42c30777 100644 --- a/lib/imagekit/models/custom_metadata_field.rb +++ b/lib/imagekit/models/custom_metadata_field.rb @@ -54,7 +54,7 @@ class Schema < Imagekit::Internal::Type::BaseModel required :type, enum: -> { Imagekit::CustomMetadataField::Schema::Type } # @!attribute default_value - # The default value for this custom metadata field. Date type of default value + # The default value for this custom metadata field. Data type of default value # depends on the field type. # # @return [String, Float, Boolean, Array, nil] @@ -122,7 +122,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @param type [Symbol, Imagekit::Models::CustomMetadataField::Schema::Type] Type of the custom metadata field. # - # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Date type of default value dep + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Data type of default value dep # # @param is_value_required [Boolean] Specifies if the this custom metadata field is required or not. # @@ -154,7 +154,7 @@ module Type # @return [Array] end - # The default value for this custom metadata field. Date type of default value + # The default value for this custom metadata field. Data type of default value # depends on the field type. # # @see Imagekit::Models::CustomMetadataField::Schema#default_value diff --git a/rbi/imagekit/models/custom_metadata_field.rbi b/rbi/imagekit/models/custom_metadata_field.rbi index eb7b8b93..10854816 100644 --- a/rbi/imagekit/models/custom_metadata_field.rbi +++ b/rbi/imagekit/models/custom_metadata_field.rbi @@ -82,7 +82,7 @@ module Imagekit end attr_accessor :type - # The default value for this custom metadata field. Date type of default value + # The default value for this custom metadata field. Data type of default value # depends on the field type. sig do returns( @@ -200,7 +200,7 @@ module Imagekit def self.new( # Type of the custom metadata field. type:, - # The default value for this custom metadata field. Date type of default value + # The default value for this custom metadata field. Data type of default value # depends on the field type. default_value: nil, # Specifies if the this custom metadata field is required or not. @@ -302,7 +302,7 @@ module Imagekit end end - # The default value for this custom metadata field. Date type of default value + # The default value for this custom metadata field. Data type of default value # depends on the field type. module DefaultValue extend Imagekit::Internal::Type::Union From 11d096487213e2862832e5da7573605867285370 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 07:49:26 +0000 Subject: [PATCH 127/178] feat(api): fix upload API request params --- .stats.yml | 4 +- .../models/beta/v2/file_upload_params.rb | 229 +--------- .../models/beta/v2/file_upload_response.rb | 223 ++++++++- lib/imagekit/models/file_upload_params.rb | 226 +-------- lib/imagekit/models/file_upload_response.rb | 222 ++++++++- .../upload_pre_transform_success_event.rb | 235 +++++++++- lib/imagekit/resources/beta/v2/files.rb | 4 +- lib/imagekit/resources/files.rb | 4 +- .../models/beta/v2/file_upload_params.rbi | 431 ------------------ .../models/beta/v2/file_upload_response.rbi | 431 ++++++++++++++++++ rbi/imagekit/models/file_upload_params.rbi | 425 ----------------- rbi/imagekit/models/file_upload_response.rbi | 431 ++++++++++++++++++ .../upload_pre_transform_success_event.rbi | 431 ++++++++++++++++++ rbi/imagekit/resources/beta/v2/files.rbi | 13 - rbi/imagekit/resources/files.rbi | 13 - .../models/beta/v2/file_upload_params.rbs | 166 ------- .../models/beta/v2/file_upload_response.rbs | 166 +++++++ sig/imagekit/models/file_upload_params.rbs | 166 ------- sig/imagekit/models/file_upload_response.rbs | 166 +++++++ .../upload_pre_transform_success_event.rbs | 166 +++++++ sig/imagekit/resources/beta/v2/files.rbs | 1 - sig/imagekit/resources/files.rbs | 1 - test/imagekit/resources/beta/v2/files_test.rb | 1 + test/imagekit/resources/files_test.rb | 1 + 24 files changed, 2476 insertions(+), 1680 deletions(-) diff --git a/.stats.yml b/.stats.yml index 56e1384b..0c9c486c 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-aa4c8e857ae03b12dabf168c83c62f759e2706d69fa4eb77d11519d45a5dada2.yml -openapi_spec_hash: 6ea00242c4685fb6422328f0dd53f9b1 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml +openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa config_hash: e42d7fc3a8c92c35099cc283f9a4467a diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekit/models/beta/v2/file_upload_params.rb index 0571b957..4117e1bf 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekit/models/beta/v2/file_upload_params.rb @@ -160,22 +160,6 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel }, api_name: :responseFields - # @!attribute selected_fields_schema - # This field is included in the response only if the Path policy feature is - # available in the plan. It contains schema definitions for the custom metadata - # fields selected for the specified file path. Field selection can only be done - # when the Path policy feature is enabled. - # - # Keys are the names of the custom metadata fields; the value object has details - # about the custom metadata schema. - # - # @return [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema}, nil] - optional :selected_fields_schema, - -> { - Imagekit::Internal::Type::HashOf[Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema] - }, - api_name: :selectedFieldsSchema - # @!attribute 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 @@ -222,7 +206,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :webhook_url, String, api_name: :webhookUrl - # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, selected_fields_schema: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Imagekit::Models::Beta::V2::FileUploadParams} for more details. # @@ -258,8 +242,6 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param response_fields [Array] Array of response field keys to include in the API response body. # - # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa - # # @param tags [Array] Set the tags while uploading the file. # # @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. @@ -286,215 +268,6 @@ module ResponseField # @return [Array] end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - # @!attribute type - # Type of the custom metadata field. - # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type] - required :type, enum: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type } - - # @!attribute default_value - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - # - # @return [String, Float, Boolean, Array, nil] - optional :default_value, - union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue }, - api_name: :defaultValue - - # @!attribute is_value_required - # Specifies if the custom metadata field is required or not. - # - # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired - - # @!attribute max_length - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @return [Float, nil] - optional :max_length, Float, api_name: :maxLength - - # @!attribute max_value - # 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. - # - # @return [String, Float, nil] - optional :max_value, - union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue }, - api_name: :maxValue - - # @!attribute min_length - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @return [Float, nil] - optional :min_length, Float, api_name: :minLength - - # @!attribute min_value - # 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. - # - # @return [String, Float, nil] - optional :min_value, - union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue }, - api_name: :minValue - - # @!attribute read_only - # Indicates whether the custom metadata field is read only. A read only field - # cannot be modified after being set. This field is configurable only via the - # **Path policy** feature. - # - # @return [Boolean, nil] - optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly - - # @!attribute select_options - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - # - # @return [Array, nil] - optional :select_options, - -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption] - }, - api_name: :selectOptions - - # @!attribute select_options_truncated - # Specifies if the selectOptions array is truncated. It is truncated when number - # of options are > 100. - # - # @return [Boolean, nil] - optional :select_options_truncated, - Imagekit::Internal::Type::Boolean, - api_name: :selectOptionsTruncated - - # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema} for more - # details. - # - # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type] Type of the custom metadata field. - # - # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty - # - # @param is_value_required [Boolean] Specifies if the custom metadata field is required or not. - # - # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D - # - # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D - # - # @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann - # - # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - # - # @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o - - # Type of the custom metadata field. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#type - module Type - extend Imagekit::Internal::Type::Enum - - TEXT = :Text - TEXTAREA = :Textarea - NUMBER = :Number - DATE = :Date - BOOLEAN = :Boolean - SINGLE_SELECT = :SingleSelect - MULTI_SELECT = :MultiSelect - - # @!method self.values - # @return [Array] - end - - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#default_value - module DefaultValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::MixedArray } - - module Mixed - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end - - # @!method self.variants - # @return [Array(String, Float, Boolean, Array)] - - # @type [Imagekit::Internal::Type::Converter] - MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed - }] - end - - # 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. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#max_value - module MaxValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end - - # 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. - # - # @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#min_value - module MinValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end - - module SelectOption - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end - end - class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute post # List of transformations to apply _after_ the file is uploaded. diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekit/models/beta/v2/file_upload_response.rb index 65cab1f9..c00da403 100644 --- a/lib/imagekit/models/beta/v2/file_upload_response.rb +++ b/lib/imagekit/models/beta/v2/file_upload_response.rb @@ -142,6 +142,20 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :name, String + # @!attribute selected_fields_schema + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + # + # @return [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}, nil] + optional :selected_fields_schema, + -> { Imagekit::Internal::Type::HashOf[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] }, + api_name: :selectedFieldsSchema + # @!attribute size # Size of the image file in Bytes. # @@ -188,7 +202,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @return [Float, nil] optional :width, Float - # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see # {Imagekit::Models::Beta::V2::FileUploadResponse} for more details. # @@ -228,6 +242,8 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param name [String] Name of the asset. # + # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # # @param size [Float] Size of the image file in Bytes. # # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul @@ -369,6 +385,211 @@ module RemoveBg end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue }, + api_name: :minValue + + # @!attribute read_only + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + # + # @return [Boolean, nil] + optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption] }, + api_name: :selectOptions + + # @!attribute select_options_truncated + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + # + # @return [Boolean, nil] + optional :select_options_truncated, + Imagekit::Internal::Type::Boolean, + api_name: :selectOptionsTruncated + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema} for more + # details. + # + # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty + # + # @param is_value_required [Boolean] Specifies if the custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o + + # Type of the custom metadata field. + # + # @see Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXTAREA = :Textarea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @see Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::MixedArray } + + module Mixed + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed }] + end + + # 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. + # + # @see Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + # @see Imagekit::Models::Beta::V2::FileUploadResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekit/models/file_upload_params.rb index 4c17089a..3d8df9b3 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekit/models/file_upload_params.rb @@ -178,20 +178,6 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel -> { Imagekit::Internal::Type::ArrayOf[enum: Imagekit::FileUploadParams::ResponseField] }, api_name: :responseFields - # @!attribute selected_fields_schema - # This field is included in the response only if the Path policy feature is - # available in the plan. It contains schema definitions for the custom metadata - # fields selected for the specified file path. Field selection can only be done - # when the Path policy feature is enabled. - # - # Keys are the names of the custom metadata fields; the value object has details - # about the custom metadata schema. - # - # @return [Hash{Symbol=>Imagekit::Models::FileUploadParams::SelectedFieldsSchema}, nil] - optional :selected_fields_schema, - -> { Imagekit::Internal::Type::HashOf[Imagekit::FileUploadParams::SelectedFieldsSchema] }, - api_name: :selectedFieldsSchema - # @!attribute 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 @@ -249,7 +235,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :webhook_url, String, api_name: :webhookUrl - # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, selected_fields_schema: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadParams} for more details. # @@ -289,8 +275,6 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param response_fields [Array] Array of response field keys to include in the API response body. # - # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa - # # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a # # @param tags [Array] Set the tags while uploading the file. @@ -319,214 +303,6 @@ module ResponseField # @return [Array] end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - # @!attribute type - # Type of the custom metadata field. - # - # @return [Symbol, Imagekit::Models::FileUploadParams::SelectedFieldsSchema::Type] - required :type, enum: -> { Imagekit::FileUploadParams::SelectedFieldsSchema::Type } - - # @!attribute default_value - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - # - # @return [String, Float, Boolean, Array, nil] - optional :default_value, - union: -> { Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue }, - api_name: :defaultValue - - # @!attribute is_value_required - # Specifies if the custom metadata field is required or not. - # - # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired - - # @!attribute max_length - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @return [Float, nil] - optional :max_length, Float, api_name: :maxLength - - # @!attribute max_value - # 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. - # - # @return [String, Float, nil] - optional :max_value, - union: -> { Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue }, - api_name: :maxValue - - # @!attribute min_length - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @return [Float, nil] - optional :min_length, Float, api_name: :minLength - - # @!attribute min_value - # 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. - # - # @return [String, Float, nil] - optional :min_value, - union: -> { Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue }, - api_name: :minValue - - # @!attribute read_only - # Indicates whether the custom metadata field is read only. A read only field - # cannot be modified after being set. This field is configurable only via the - # **Path policy** feature. - # - # @return [Boolean, nil] - optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly - - # @!attribute select_options - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - # - # @return [Array, nil] - optional :select_options, - -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption] - }, - api_name: :selectOptions - - # @!attribute select_options_truncated - # Specifies if the selectOptions array is truncated. It is truncated when number - # of options are > 100. - # - # @return [Boolean, nil] - optional :select_options_truncated, - Imagekit::Internal::Type::Boolean, - api_name: :selectOptionsTruncated - - # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::SelectedFieldsSchema} for more details. - # - # @param type [Symbol, Imagekit::Models::FileUploadParams::SelectedFieldsSchema::Type] Type of the custom metadata field. - # - # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty - # - # @param is_value_required [Boolean] Specifies if the custom metadata field is required or not. - # - # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D - # - # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - # - # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D - # - # @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann - # - # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - # - # @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o - - # Type of the custom metadata field. - # - # @see Imagekit::Models::FileUploadParams::SelectedFieldsSchema#type - module Type - extend Imagekit::Internal::Type::Enum - - TEXT = :Text - TEXTAREA = :Textarea - NUMBER = :Number - DATE = :Date - BOOLEAN = :Boolean - SINGLE_SELECT = :SingleSelect - MULTI_SELECT = :MultiSelect - - # @!method self.values - # @return [Array] - end - - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - # - # @see Imagekit::Models::FileUploadParams::SelectedFieldsSchema#default_value - module DefaultValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::FileUploadParams::SelectedFieldsSchema::DefaultValue::MixedArray } - - module Mixed - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end - - # @!method self.variants - # @return [Array(String, Float, Boolean, Array)] - - # @type [Imagekit::Internal::Type::Converter] - MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed - }] - end - - # 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. - # - # @see Imagekit::Models::FileUploadParams::SelectedFieldsSchema#max_value - module MaxValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end - - # 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. - # - # @see Imagekit::Models::FileUploadParams::SelectedFieldsSchema#min_value - module MinValue - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - # @!method self.variants - # @return [Array(String, Float)] - end - - module SelectOption - extend Imagekit::Internal::Type::Union - - variant String - - variant Float - - variant Imagekit::Internal::Type::Boolean - - # @!method self.variants - # @return [Array(String, Float, Boolean)] - end - end - class Transformation < Imagekit::Internal::Type::BaseModel # @!attribute post # List of transformations to apply _after_ the file is uploaded. diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekit/models/file_upload_response.rb index 85ebf598..abf623b1 100644 --- a/lib/imagekit/models/file_upload_response.rb +++ b/lib/imagekit/models/file_upload_response.rb @@ -140,6 +140,20 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :name, String + # @!attribute selected_fields_schema + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + # + # @return [Hash{Symbol=>Imagekit::Models::FileUploadResponse::SelectedFieldsSchema}, nil] + optional :selected_fields_schema, + -> { Imagekit::Internal::Type::HashOf[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema] }, + api_name: :selectedFieldsSchema + # @!attribute size # Size of the image file in Bytes. # @@ -184,7 +198,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @return [Float, nil] optional :width, Float - # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see # {Imagekit::Models::FileUploadResponse} for more details. # @@ -224,6 +238,8 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param name [String] Name of the asset. # + # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::FileUploadResponse::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # # @param size [Float] Size of the image file in Bytes. # # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul @@ -365,6 +381,210 @@ module RemoveBg end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue }, + api_name: :minValue + + # @!attribute read_only + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + # + # @return [Boolean, nil] + optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption] }, + api_name: :selectOptions + + # @!attribute select_options_truncated + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + # + # @return [Boolean, nil] + optional :select_options_truncated, + Imagekit::Internal::Type::Boolean, + api_name: :selectOptionsTruncated + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::FileUploadResponse::SelectedFieldsSchema} for more details. + # + # @param type [Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty + # + # @param is_value_required [Boolean] Specifies if the custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o + + # Type of the custom metadata field. + # + # @see Imagekit::Models::FileUploadResponse::SelectedFieldsSchema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXTAREA = :Textarea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @see Imagekit::Models::FileUploadResponse::SelectedFieldsSchema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::MixedArray } + + module Mixed + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed }] + end + + # 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. + # + # @see Imagekit::Models::FileUploadResponse::SelectedFieldsSchema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::FileUploadResponse::SelectedFieldsSchema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + # @see Imagekit::Models::FileUploadResponse#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/models/upload_pre_transform_success_event.rb b/lib/imagekit/models/upload_pre_transform_success_event.rb index 4ba20c4e..d8cc16e4 100644 --- a/lib/imagekit/models/upload_pre_transform_success_event.rb +++ b/lib/imagekit/models/upload_pre_transform_success_event.rb @@ -177,6 +177,22 @@ class Data < Imagekit::Internal::Type::BaseModel # @return [String, nil] optional :name, String + # @!attribute selected_fields_schema + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + # + # @return [Hash{Symbol=>Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema}, nil] + optional :selected_fields_schema, + -> { + Imagekit::Internal::Type::HashOf[Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] + }, + api_name: :selectedFieldsSchema + # @!attribute size # Size of the image file in Bytes. # @@ -223,7 +239,7 @@ class Data < Imagekit::Internal::Type::BaseModel # @return [Float, nil] optional :width, Float - # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see # {Imagekit::Models::UploadPreTransformSuccessEvent::Data} for more details. # @@ -263,6 +279,8 @@ class Data < Imagekit::Internal::Type::BaseModel # # @param name [String] Name of the asset. # + # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # # @param size [Float] Size of the image file in Bytes. # # @param tags [Array, nil] The array of tags associated with the asset. If no tags are set, it will be `nul @@ -411,6 +429,221 @@ module RemoveBg end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + # @!attribute type + # Type of the custom metadata field. + # + # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type } + + # @!attribute default_value + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @return [String, Float, Boolean, Array, nil] + optional :default_value, + union: -> { + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue + }, + api_name: :defaultValue + + # @!attribute is_value_required + # Specifies if the custom metadata field is required or not. + # + # @return [Boolean, nil] + optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + + # @!attribute max_length + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :max_length, Float, api_name: :maxLength + + # @!attribute max_value + # 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. + # + # @return [String, Float, nil] + optional :max_value, + union: -> { + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue + }, + api_name: :maxValue + + # @!attribute min_length + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @return [Float, nil] + optional :min_length, Float, api_name: :minLength + + # @!attribute min_value + # 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. + # + # @return [String, Float, nil] + optional :min_value, + union: -> { + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue + }, + api_name: :minValue + + # @!attribute read_only + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + # + # @return [Boolean, nil] + optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + + # @!attribute select_options + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @return [Array, nil] + optional :select_options, + -> { + Imagekit::Internal::Type::ArrayOf[union: Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption] + }, + api_name: :selectOptions + + # @!attribute select_options_truncated + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + # + # @return [Boolean, nil] + optional :select_options_truncated, + Imagekit::Internal::Type::Boolean, + api_name: :selectOptionsTruncated + + # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema} + # for more details. + # + # @param type [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type] Type of the custom metadata field. + # + # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty + # + # @param is_value_required [Boolean] Specifies if the custom metadata field is required or not. + # + # @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + # + # @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D + # + # @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann + # + # @param select_options [Array] An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + # + # @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o + + # Type of the custom metadata field. + # + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#type + module Type + extend Imagekit::Internal::Type::Enum + + TEXT = :Text + TEXTAREA = :Textarea + NUMBER = :Number + DATE = :Date + BOOLEAN = :Boolean + SINGLE_SELECT = :SingleSelect + MULTI_SELECT = :MultiSelect + + # @!method self.values + # @return [Array] + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + # + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#default_value + module DefaultValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # Default value should be of type array when custom metadata field type is set to `MultiSelect`. + variant -> { Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::MixedArray } + + module Mixed + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekit::Internal::Type::Converter] + MixedArray = + Imagekit::Internal::Type::ArrayOf[union: -> { + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed + }] + end + + # 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. + # + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#max_value + module MaxValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + # 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. + # + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#min_value + module MinValue + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + # @!method self.variants + # @return [Array(String, Float)] + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + variant String + + variant Float + + variant Imagekit::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data#version_info class VersionInfo < Imagekit::Internal::Type::BaseModel # @!attribute id diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekit/resources/beta/v2/files.rb index db7c62bc..670d5a60 100644 --- a/lib/imagekit/resources/beta/v2/files.rb +++ b/lib/imagekit/resources/beta/v2/files.rb @@ -36,7 +36,7 @@ class Files # - [Quick start guides](/docs/quick-start-guides) for various frameworks and # technologies. # - # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, selected_fields_schema: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # @@ -70,8 +70,6 @@ class Files # # @param response_fields [Array] Array of response field keys to include in the API response body. # - # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa - # # @param tags [Array] Set the tags while uploading the file. # # @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. diff --git a/lib/imagekit/resources/files.rb b/lib/imagekit/resources/files.rb index b120077b..2ddc77ef 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekit/resources/files.rb @@ -224,7 +224,7 @@ def rename(params) # - [Quick start guides](/docs/quick-start-guides) for various frameworks and # technologies. # - # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, selected_fields_schema: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) + # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: # @@ -262,8 +262,6 @@ def rename(params) # # @param response_fields [Array] Array of response field keys to include in the API response body. # - # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa - # # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a # # @param tags [Array] Set the tags while uploading the file. diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekit/models/beta/v2/file_upload_params.rbi index 5e04259d..91f54bd2 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_params.rbi @@ -207,36 +207,6 @@ module Imagekit end attr_writer :response_fields - # This field is included in the response only if the Path policy feature is - # available in the plan. It contains schema definitions for the custom metadata - # fields selected for the specified file path. Field selection can only be done - # when the Path policy feature is enabled. - # - # Keys are the names of the custom metadata fields; the value object has details - # about the custom metadata schema. - sig do - returns( - T.nilable( - T::Hash[ - Symbol, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema - ] - ) - ) - end - attr_reader :selected_fields_schema - - sig do - params( - selected_fields_schema: - T::Hash[ - Symbol, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::OrHash - ] - ).void - end - attr_writer :selected_fields_schema - # 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 @@ -324,11 +294,6 @@ module Imagekit T::Array[ Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], - selected_fields_schema: - T::Hash[ - Symbol, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::OrHash - ], tags: T::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash, @@ -417,14 +382,6 @@ module Imagekit overwrite_tags: nil, # Array of response field keys to include in the API response body. response_fields: nil, - # This field is included in the response only if the Path policy feature is - # available in the plan. It contains schema definitions for the custom metadata - # fields selected for the specified file path. Field selection can only be done - # when the Path policy feature is enabled. - # - # Keys are the names of the custom metadata fields; the value object has details - # about the custom metadata schema. - selected_fields_schema: nil, # 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 @@ -488,11 +445,6 @@ module Imagekit T::Array[ Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], - selected_fields_schema: - T::Hash[ - Symbol, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema - ], tags: T::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, @@ -569,389 +521,6 @@ module Imagekit end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema, - Imagekit::Internal::AnyHash - ) - end - - # Type of the custom metadata field. - sig do - returns( - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol - ) - end - attr_accessor :type - - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - sig do - returns( - T.nilable( - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants - ) - ) - end - attr_reader :default_value - - sig do - params( - default_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants - ).void - end - attr_writer :default_value - - # Specifies if the custom metadata field is required or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_value_required - - sig { params(is_value_required: T::Boolean).void } - attr_writer :is_value_required - - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - sig { returns(T.nilable(Float)) } - attr_reader :max_length - - sig { params(max_length: Float).void } - attr_writer :max_length - - # 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. - sig do - returns( - T.nilable( - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants - ) - ) - end - attr_reader :max_value - - sig do - params( - max_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants - ).void - end - attr_writer :max_value - - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - sig { returns(T.nilable(Float)) } - attr_reader :min_length - - sig { params(min_length: Float).void } - attr_writer :min_length - - # 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. - sig do - returns( - T.nilable( - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants - ) - ) - end - attr_reader :min_value - - sig do - params( - min_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants - ).void - end - attr_writer :min_value - - # Indicates whether the custom metadata field is read only. A read only field - # cannot be modified after being set. This field is configurable only via the - # **Path policy** feature. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :read_only - - sig { params(read_only: T::Boolean).void } - attr_writer :read_only - - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - sig do - returns( - T.nilable( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ] - ) - ) - end - attr_reader :select_options - - sig do - params( - select_options: - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ] - ).void - end - attr_writer :select_options - - # Specifies if the selectOptions array is truncated. It is truncated when number - # of options are > 100. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :select_options_truncated - - sig { params(select_options_truncated: T::Boolean).void } - attr_writer :select_options_truncated - - sig do - params( - type: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol, - default_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants, - is_value_required: T::Boolean, - max_length: Float, - max_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants, - min_length: Float, - min_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants, - read_only: T::Boolean, - select_options: - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ], - select_options_truncated: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Type of the custom metadata field. - type:, - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - default_value: nil, - # Specifies if the custom metadata field is required or not. - is_value_required: nil, - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - max_length: nil, - # 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. - max_value: nil, - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - min_length: nil, - # 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. - min_value: nil, - # Indicates whether the custom metadata field is read only. A read only field - # cannot be modified after being set. This field is configurable only via the - # **Path policy** feature. - read_only: nil, - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - select_options: nil, - # Specifies if the selectOptions array is truncated. It is truncated when number - # of options are > 100. - select_options_truncated: nil - ) - end - - sig do - override.returns( - { - type: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol, - default_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants, - is_value_required: T::Boolean, - max_length: Float, - max_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants, - min_length: Float, - min_value: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants, - read_only: T::Boolean, - select_options: - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ], - select_options_truncated: T::Boolean - } - ) - end - def to_hash - end - - # Type of the custom metadata field. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TEXT = - T.let( - :Text, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - TEXTAREA = - T.let( - :Textarea, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - NUMBER = - T.let( - :Number, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - DATE = - T.let( - :Date, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - BOOLEAN = - T.let( - :Boolean, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - SINGLE_SELECT = - T.let( - :SingleSelect, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - MULTI_SELECT = - T.let( - :MultiSelect, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - module DefaultValue - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - String, - Float, - T::Boolean, - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed::Variants - ] - ) - end - - module Mixed - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed::Variants - ] - ) - end - def self.variants - end - end - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants - ] - ) - end - def self.variants - end - - MixedArray = - T.let( - Imagekit::Internal::Type::ArrayOf[ - union: - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed - ], - Imagekit::Internal::Type::Converter - ) - end - - # 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. - module MaxValue - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants - ] - ) - end - def self.variants - end - end - - # 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. - module MinValue - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue::Variants - ] - ) - end - def self.variants - end - end - - module SelectOption - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ] - ) - end - def self.variants - end - end - end - class Transformation < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekit/models/beta/v2/file_upload_response.rbi index ea3ffd3d..f05bfcb0 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekit/models/beta/v2/file_upload_response.rbi @@ -168,6 +168,36 @@ module Imagekit sig { params(name: String).void } attr_writer :name + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema + ] + ) + ) + end + attr_reader :selected_fields_schema + + sig do + params( + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::OrHash + ] + ).void + end + attr_writer :selected_fields_schema + # Size of the image file in Bytes. sig { returns(T.nilable(Float)) } attr_reader :size @@ -253,6 +283,11 @@ module Imagekit is_published: T::Boolean, metadata: Imagekit::Metadata::OrHash, name: String, + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::OrHash + ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, @@ -323,6 +358,14 @@ module Imagekit metadata: nil, # Name of the asset. name: nil, + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + selected_fields_schema: nil, # Size of the image file in Bytes. size: nil, # The array of tags associated with the asset. If no tags are set, it will be @@ -368,6 +411,11 @@ module Imagekit is_published: T::Boolean, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema + ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, @@ -720,6 +768,389 @@ module Imagekit end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + end + attr_accessor :type + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + ).void + end + attr_writer :min_value + + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :read_only + + sig { params(read_only: T::Boolean).void } + attr_writer :read_only + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :select_options_truncated + + sig { params(select_options_truncated: T::Boolean).void } + attr_writer :select_options_truncated + + sig do + params( + type: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::OrSymbol, + default_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + default_value: nil, + # Specifies if the custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + read_only: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil, + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + select_options_truncated: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol, + default_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + TEXTAREA = + T.let( + :Textarea, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekit/models/file_upload_params.rbi index d28caa2a..6d987762 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekit/models/file_upload_params.rbi @@ -222,33 +222,6 @@ module Imagekit end attr_writer :response_fields - # This field is included in the response only if the Path policy feature is - # available in the plan. It contains schema definitions for the custom metadata - # fields selected for the specified file path. Field selection can only be done - # when the Path policy feature is enabled. - # - # Keys are the names of the custom metadata fields; the value object has details - # about the custom metadata schema. - sig do - returns( - T.nilable( - T::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema] - ) - ) - end - attr_reader :selected_fields_schema - - sig do - params( - selected_fields_schema: - T::Hash[ - Symbol, - Imagekit::FileUploadParams::SelectedFieldsSchema::OrHash - ] - ).void - end - attr_writer :selected_fields_schema - # 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. @@ -343,11 +316,6 @@ module Imagekit public_key: String, response_fields: T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], - selected_fields_schema: - T::Hash[ - Symbol, - Imagekit::FileUploadParams::SelectedFieldsSchema::OrHash - ], signature: String, tags: T::Array[String], transformation: Imagekit::FileUploadParams::Transformation::OrHash, @@ -450,14 +418,6 @@ module Imagekit public_key: nil, # Array of response field keys to include in the API response body. response_fields: nil, - # This field is included in the response only if the Path policy feature is - # available in the plan. It contains schema definitions for the custom metadata - # fields selected for the specified file path. Field selection can only be done - # when the Path policy feature is enabled. - # - # Keys are the names of the custom metadata fields; the value object has details - # about the custom metadata schema. - selected_fields_schema: nil, # 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. @@ -528,8 +488,6 @@ module Imagekit public_key: String, response_fields: T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], - selected_fields_schema: - T::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], signature: String, tags: T::Array[String], transformation: Imagekit::FileUploadParams::Transformation, @@ -598,389 +556,6 @@ module Imagekit end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Imagekit::FileUploadParams::SelectedFieldsSchema, - Imagekit::Internal::AnyHash - ) - end - - # Type of the custom metadata field. - sig do - returns( - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol - ) - end - attr_accessor :type - - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - sig do - returns( - T.nilable( - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants - ) - ) - end - attr_reader :default_value - - sig do - params( - default_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants - ).void - end - attr_writer :default_value - - # Specifies if the custom metadata field is required or not. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :is_value_required - - sig { params(is_value_required: T::Boolean).void } - attr_writer :is_value_required - - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - sig { returns(T.nilable(Float)) } - attr_reader :max_length - - sig { params(max_length: Float).void } - attr_writer :max_length - - # 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. - sig do - returns( - T.nilable( - Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants - ) - ) - end - attr_reader :max_value - - sig do - params( - max_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants - ).void - end - attr_writer :max_value - - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - sig { returns(T.nilable(Float)) } - attr_reader :min_length - - sig { params(min_length: Float).void } - attr_writer :min_length - - # 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. - sig do - returns( - T.nilable( - Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants - ) - ) - end - attr_reader :min_value - - sig do - params( - min_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants - ).void - end - attr_writer :min_value - - # Indicates whether the custom metadata field is read only. A read only field - # cannot be modified after being set. This field is configurable only via the - # **Path policy** feature. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :read_only - - sig { params(read_only: T::Boolean).void } - attr_writer :read_only - - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - sig do - returns( - T.nilable( - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ] - ) - ) - end - attr_reader :select_options - - sig do - params( - select_options: - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ] - ).void - end - attr_writer :select_options - - # Specifies if the selectOptions array is truncated. It is truncated when number - # of options are > 100. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :select_options_truncated - - sig { params(select_options_truncated: T::Boolean).void } - attr_writer :select_options_truncated - - sig do - params( - type: - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol, - default_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants, - is_value_required: T::Boolean, - max_length: Float, - max_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants, - min_length: Float, - min_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants, - read_only: T::Boolean, - select_options: - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ], - select_options_truncated: T::Boolean - ).returns(T.attached_class) - end - def self.new( - # Type of the custom metadata field. - type:, - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - default_value: nil, - # Specifies if the custom metadata field is required or not. - is_value_required: nil, - # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. - max_length: nil, - # 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. - max_value: nil, - # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. - min_length: nil, - # 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. - min_value: nil, - # Indicates whether the custom metadata field is read only. A read only field - # cannot be modified after being set. This field is configurable only via the - # **Path policy** feature. - read_only: nil, - # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. - select_options: nil, - # Specifies if the selectOptions array is truncated. It is truncated when number - # of options are > 100. - select_options_truncated: nil - ) - end - - sig do - override.returns( - { - type: - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::OrSymbol, - default_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants, - is_value_required: T::Boolean, - max_length: Float, - max_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants, - min_length: Float, - min_value: - Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants, - read_only: T::Boolean, - select_options: - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ], - select_options_truncated: T::Boolean - } - ) - end - def to_hash - end - - # Type of the custom metadata field. - module Type - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Imagekit::FileUploadParams::SelectedFieldsSchema::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TEXT = - T.let( - :Text, - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - TEXTAREA = - T.let( - :Textarea, - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - NUMBER = - T.let( - :Number, - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - DATE = - T.let( - :Date, - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - BOOLEAN = - T.let( - :Boolean, - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - SINGLE_SELECT = - T.let( - :SingleSelect, - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - MULTI_SELECT = - T.let( - :MultiSelect, - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - - # The default value for this custom metadata field. The value should match the - # `type` of custom metadata field. - module DefaultValue - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - String, - Float, - T::Boolean, - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed::Variants - ] - ) - end - - module Mixed - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed::Variants - ] - ) - end - def self.variants - end - end - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Variants - ] - ) - end - def self.variants - end - - MixedArray = - T.let( - Imagekit::Internal::Type::ArrayOf[ - union: - Imagekit::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed - ], - Imagekit::Internal::Type::Converter - ) - end - - # 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. - module MaxValue - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::MaxValue::Variants - ] - ) - end - def self.variants - end - end - - # 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. - module MinValue - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float) } - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::MinValue::Variants - ] - ) - end - def self.variants - end - end - - module SelectOption - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Float, T::Boolean) } - - sig do - override.returns( - T::Array[ - Imagekit::FileUploadParams::SelectedFieldsSchema::SelectOption::Variants - ] - ) - end - def self.variants - end - end - end - class Transformation < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekit/models/file_upload_response.rbi index aa46ceb4..c695efee 100644 --- a/rbi/imagekit/models/file_upload_response.rbi +++ b/rbi/imagekit/models/file_upload_response.rbi @@ -162,6 +162,36 @@ module Imagekit sig { params(name: String).void } attr_writer :name + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema + ] + ) + ) + end + attr_reader :selected_fields_schema + + sig do + params( + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::OrHash + ] + ).void + end + attr_writer :selected_fields_schema + # Size of the image file in Bytes. sig { returns(T.nilable(Float)) } attr_reader :size @@ -241,6 +271,11 @@ module Imagekit is_published: T::Boolean, metadata: Imagekit::Metadata::OrHash, name: String, + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::OrHash + ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, @@ -311,6 +346,14 @@ module Imagekit metadata: nil, # Name of the asset. name: nil, + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + selected_fields_schema: nil, # Size of the image file in Bytes. size: nil, # The array of tags associated with the asset. If no tags are set, it will be @@ -352,6 +395,11 @@ module Imagekit is_published: T::Boolean, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema + ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, @@ -701,6 +749,389 @@ module Imagekit end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + end + attr_accessor :type + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + ).void + end + attr_writer :min_value + + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :read_only + + sig { params(read_only: T::Boolean).void } + attr_writer :read_only + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :select_options_truncated + + sig { params(select_options_truncated: T::Boolean).void } + attr_writer :select_options_truncated + + sig do + params( + type: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::OrSymbol, + default_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + default_value: nil, + # Specifies if the custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + read_only: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil, + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + select_options_truncated: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol, + default_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + TEXTAREA = + T.let( + :Textarea, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/models/upload_pre_transform_success_event.rbi b/rbi/imagekit/models/upload_pre_transform_success_event.rbi index b5d15c02..59103f76 100644 --- a/rbi/imagekit/models/upload_pre_transform_success_event.rbi +++ b/rbi/imagekit/models/upload_pre_transform_success_event.rbi @@ -237,6 +237,36 @@ module Imagekit sig { params(name: String).void } attr_writer :name + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema + ] + ) + ) + end + attr_reader :selected_fields_schema + + sig do + params( + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::OrHash + ] + ).void + end + attr_writer :selected_fields_schema + # Size of the image file in Bytes. sig { returns(T.nilable(Float)) } attr_reader :size @@ -322,6 +352,11 @@ module Imagekit is_published: T::Boolean, metadata: Imagekit::Metadata::OrHash, name: String, + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::OrHash + ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, @@ -392,6 +427,14 @@ module Imagekit metadata: nil, # Name of the asset. name: nil, + # This field is included in the response only if the Path policy feature is + # available in the plan. It contains schema definitions for the custom metadata + # fields selected for the specified file path. Field selection can only be done + # when the Path policy feature is enabled. + # + # Keys are the names of the custom metadata fields; the value object has details + # about the custom metadata schema. + selected_fields_schema: nil, # Size of the image file in Bytes. size: nil, # The array of tags associated with the asset. If no tags are set, it will be @@ -437,6 +480,11 @@ module Imagekit is_published: T::Boolean, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: + T::Hash[ + Symbol, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema + ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, @@ -789,6 +837,389 @@ module Imagekit end end + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema, + Imagekit::Internal::AnyHash + ) + end + + # Type of the custom metadata field. + sig do + returns( + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ) + end + attr_accessor :type + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants + ) + ) + end + attr_reader :default_value + + sig do + params( + default_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants + ).void + end + attr_writer :default_value + + # Specifies if the custom metadata field is required or not. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_value_required + + sig { params(is_value_required: T::Boolean).void } + attr_writer :is_value_required + + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :max_length + + sig { params(max_length: Float).void } + attr_writer :max_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants + ) + ) + end + attr_reader :max_value + + sig do + params( + max_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants + ).void + end + attr_writer :max_value + + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + sig { returns(T.nilable(Float)) } + attr_reader :min_length + + sig { params(min_length: Float).void } + attr_writer :min_length + + # 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. + sig do + returns( + T.nilable( + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants + ) + ) + end + attr_reader :min_value + + sig do + params( + min_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants + ).void + end + attr_writer :min_value + + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :read_only + + sig { params(read_only: T::Boolean).void } + attr_writer :read_only + + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + sig do + returns( + T.nilable( + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + ] + ) + ) + end + attr_reader :select_options + + sig do + params( + select_options: + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + ] + ).void + end + attr_writer :select_options + + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :select_options_truncated + + sig { params(select_options_truncated: T::Boolean).void } + attr_writer :select_options_truncated + + sig do + params( + type: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::OrSymbol, + default_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Type of the custom metadata field. + type:, + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + default_value: nil, + # Specifies if the custom metadata field is required or not. + is_value_required: nil, + # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + max_length: nil, + # 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. + max_value: nil, + # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + min_length: nil, + # 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. + min_value: nil, + # Indicates whether the custom metadata field is read only. A read only field + # cannot be modified after being set. This field is configurable only via the + # **Path policy** feature. + read_only: nil, + # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + select_options: nil, + # Specifies if the selectOptions array is truncated. It is truncated when number + # of options are > 100. + select_options_truncated: nil + ) + end + + sig do + override.returns( + { + type: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol, + default_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants, + is_value_required: T::Boolean, + max_length: Float, + max_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants, + min_length: Float, + min_value: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants, + read_only: T::Boolean, + select_options: + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + ], + select_options_truncated: T::Boolean + } + ) + end + def to_hash + end + + # Type of the custom metadata field. + module Type + extend Imagekit::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TEXT = + T.let( + :Text, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ) + TEXTAREA = + T.let( + :Textarea, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ) + NUMBER = + T.let( + :Number, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ) + DATE = + T.let( + :Date, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ) + BOOLEAN = + T.let( + :Boolean, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ) + SINGLE_SELECT = + T.let( + :SingleSelect, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ) + MULTI_SELECT = + T.let( + :MultiSelect, + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The default value for this custom metadata field. The value should match the + # `type` of custom metadata field. + module DefaultValue + extend Imagekit::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekit::Internal::Type::ArrayOf[ + union: + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed + ], + Imagekit::Internal::Type::Converter + ) + end + + # 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. + module MaxValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants + ] + ) + end + def self.variants + end + end + + # 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. + module MinValue + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float) } + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants + ] + ) + end + def self.variants + end + end + + module SelectOption + extend Imagekit::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + ] + ) + end + def self.variants + end + end + end + class VersionInfo < Imagekit::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekit/resources/beta/v2/files.rbi index 5cfc8118..b78dc1c3 100644 --- a/rbi/imagekit/resources/beta/v2/files.rbi +++ b/rbi/imagekit/resources/beta/v2/files.rbi @@ -60,11 +60,6 @@ module Imagekit T::Array[ Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], - selected_fields_schema: - T::Hash[ - Symbol, - Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::OrHash - ], tags: T::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash, @@ -153,14 +148,6 @@ module Imagekit overwrite_tags: nil, # Array of response field keys to include in the API response body. response_fields: nil, - # This field is included in the response only if the Path policy feature is - # available in the plan. It contains schema definitions for the custom metadata - # fields selected for the specified file path. Field selection can only be done - # when the Path policy feature is enabled. - # - # Keys are the names of the custom metadata fields; the value object has details - # about the custom metadata schema. - selected_fields_schema: nil, # 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 diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekit/resources/files.rbi index a7e102d8..cec1cf6e 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekit/resources/files.rbi @@ -212,11 +212,6 @@ module Imagekit public_key: String, response_fields: T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], - selected_fields_schema: - T::Hash[ - Symbol, - Imagekit::FileUploadParams::SelectedFieldsSchema::OrHash - ], signature: String, tags: T::Array[String], transformation: Imagekit::FileUploadParams::Transformation::OrHash, @@ -319,14 +314,6 @@ module Imagekit public_key: nil, # Array of response field keys to include in the API response body. response_fields: nil, - # This field is included in the response only if the Path policy feature is - # available in the plan. It contains schema definitions for the custom metadata - # fields selected for the specified file path. Field selection can only be done - # when the Path policy feature is enabled. - # - # Keys are the names of the custom metadata fields; the value object has details - # about the custom metadata schema. - selected_fields_schema: nil, # 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. diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekit/models/beta/v2/file_upload_params.rbs index ba890cfd..9ae50878 100644 --- a/sig/imagekit/models/beta/v2/file_upload_params.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_params.rbs @@ -20,7 +20,6 @@ module Imagekit overwrite_file: bool, overwrite_tags: bool, response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], - selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema], tags: ::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, use_unique_file_name: bool, @@ -96,12 +95,6 @@ module Imagekit ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] - attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema]? - - def selected_fields_schema=: ( - ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema] - ) -> ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema] - attr_reader tags: ::Array[String]? def tags=: (::Array[String]) -> ::Array[String] @@ -137,7 +130,6 @@ module Imagekit ?overwrite_file: bool, ?overwrite_tags: bool, ?response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], - ?selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema], ?tags: ::Array[String], ?transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, ?use_unique_file_name: bool, @@ -162,7 +154,6 @@ module Imagekit overwrite_file: bool, overwrite_tags: bool, response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], - selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema], tags: ::Array[String], transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, use_unique_file_name: bool, @@ -195,163 +186,6 @@ module Imagekit def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] end - type selected_fields_schema = - { - type: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_ - - attr_reader default_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value? - - def default_value=: ( - Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value - ) -> Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value? - - def max_value=: ( - Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value - ) -> Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value? - - def min_value=: ( - Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value - ) -> Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value - - attr_reader read_only: bool? - - def read_only=: (bool) -> bool - - attr_reader select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option] - ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option] - - attr_reader select_options_truncated: bool? - - def select_options_truncated=: (bool) -> bool - - def initialize: ( - type: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_, - ?default_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value, - ?read_only: bool, - ?select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option], - ?select_options_truncated: bool - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::select_option] - end - end - type transformation = { post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post], diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs index 3955ca0d..b476afd8 100644 --- a/sig/imagekit/models/beta/v2/file_upload_response.rbs +++ b/sig/imagekit/models/beta/v2/file_upload_response.rbs @@ -21,6 +21,7 @@ module Imagekit is_published: bool, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail_url: String, @@ -97,6 +98,12 @@ module Imagekit def name=: (String) -> String + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] + attr_reader size: Float? def size=: (Float) -> Float @@ -143,6 +150,7 @@ module Imagekit ?is_published: bool, ?metadata: Imagekit::Metadata, ?name: String, + ?selected_fields_schema: ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], ?size: Float, ?tags: ::Array[String]?, ?thumbnail_url: String, @@ -170,6 +178,7 @@ module Imagekit is_published: bool, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail_url: String, @@ -299,6 +308,163 @@ module Imagekit end end + type selected_fields_schema = + { + type: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value + ) -> Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, + ?default_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value] + + MixedArray: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] + end + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekit/models/file_upload_params.rbs index baa5baa9..4a819dc1 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekit/models/file_upload_params.rbs @@ -20,7 +20,6 @@ module Imagekit overwrite_tags: bool, public_key: String, response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], - selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], signature: String, tags: ::Array[String], transformation: Imagekit::FileUploadParams::Transformation, @@ -105,12 +104,6 @@ module Imagekit ::Array[Imagekit::Models::FileUploadParams::response_field] ) -> ::Array[Imagekit::Models::FileUploadParams::response_field] - attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema]? - - def selected_fields_schema=: ( - ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema] - ) -> ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema] - attr_reader signature: String? def signature=: (String) -> String @@ -152,7 +145,6 @@ module Imagekit ?overwrite_tags: bool, ?public_key: String, ?response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], - ?selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], ?signature: String, ?tags: ::Array[String], ?transformation: Imagekit::FileUploadParams::Transformation, @@ -180,7 +172,6 @@ module Imagekit overwrite_tags: bool, public_key: String, response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], - selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], signature: String, tags: ::Array[String], transformation: Imagekit::FileUploadParams::Transformation, @@ -214,163 +205,6 @@ module Imagekit def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::response_field] end - type selected_fields_schema = - { - type: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_ - - attr_reader default_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value? - - def default_value=: ( - Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value - ) -> Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value? - - def max_value=: ( - Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value - ) -> Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value? - - def min_value=: ( - Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value - ) -> Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value - - attr_reader read_only: bool? - - def read_only=: (bool) -> bool - - attr_reader select_options: ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option] - ) -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option] - - attr_reader select_options_truncated: bool? - - def select_options_truncated=: (bool) -> bool - - def initialize: ( - type: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_, - ?default_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value, - ?read_only: bool, - ?select_options: ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option], - ?select_options_truncated: bool - ) -> void - - def to_hash: -> { - type: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::SelectedFieldsSchema::select_option] - end - end - type transformation = { post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post], diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs index 10348f34..7926370e 100644 --- a/sig/imagekit/models/file_upload_response.rbs +++ b/sig/imagekit/models/file_upload_response.rbs @@ -19,6 +19,7 @@ module Imagekit is_published: bool, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail_url: String, @@ -95,6 +96,12 @@ module Imagekit def name=: (String) -> String + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema] + attr_reader size: Float? def size=: (Float) -> Float @@ -141,6 +148,7 @@ module Imagekit ?is_published: bool, ?metadata: Imagekit::Metadata, ?name: String, + ?selected_fields_schema: ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema], ?size: Float, ?tags: ::Array[String]?, ?thumbnail_url: String, @@ -168,6 +176,7 @@ module Imagekit is_published: bool, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail_url: String, @@ -297,6 +306,163 @@ module Imagekit end end + type selected_fields_schema = + { + type: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value + ) -> Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value + ) -> Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value + ) -> Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_, + ?default_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value] + + MixedArray: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option] + end + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/models/upload_pre_transform_success_event.rbs b/sig/imagekit/models/upload_pre_transform_success_event.rbs index 1efc8382..1d718a37 100644 --- a/sig/imagekit/models/upload_pre_transform_success_event.rbs +++ b/sig/imagekit/models/upload_pre_transform_success_event.rbs @@ -64,6 +64,7 @@ module Imagekit is_published: bool, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail_url: String, @@ -140,6 +141,12 @@ module Imagekit def name=: (String) -> String + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] + attr_reader size: Float? def size=: (Float) -> Float @@ -186,6 +193,7 @@ module Imagekit ?is_published: bool, ?metadata: Imagekit::Metadata, ?name: String, + ?selected_fields_schema: ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], ?size: Float, ?tags: ::Array[String]?, ?thumbnail_url: String, @@ -213,6 +221,7 @@ module Imagekit is_published: bool, metadata: Imagekit::Metadata, name: String, + selected_fields_schema: ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail_url: String, @@ -342,6 +351,163 @@ module Imagekit end end + type selected_fields_schema = + { + type: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + attr_accessor type: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value + ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value + ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value + ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, + ?default_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, + default_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekit::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekit::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value] + + MixedArray: Imagekit::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekit::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] + end + end + type version_info = { id: String, name: String } class VersionInfo < Imagekit::Internal::Type::BaseModel diff --git a/sig/imagekit/resources/beta/v2/files.rbs b/sig/imagekit/resources/beta/v2/files.rbs index 0519cf69..a2d266ae 100644 --- a/sig/imagekit/resources/beta/v2/files.rbs +++ b/sig/imagekit/resources/beta/v2/files.rbs @@ -20,7 +20,6 @@ module Imagekit ?overwrite_file: bool, ?overwrite_tags: bool, ?response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], - ?selected_fields_schema: ::Hash[Symbol, Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema], ?tags: ::Array[String], ?transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, ?use_unique_file_name: bool, diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs index 1a68270a..e2c281c0 100644 --- a/sig/imagekit/resources/files.rbs +++ b/sig/imagekit/resources/files.rbs @@ -62,7 +62,6 @@ module Imagekit ?overwrite_tags: bool, ?public_key: String, ?response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], - ?selected_fields_schema: ::Hash[Symbol, Imagekit::FileUploadParams::SelectedFieldsSchema], ?signature: String, ?tags: ::Array[String], ?transformation: Imagekit::FileUploadParams::Transformation, diff --git a/test/imagekit/resources/beta/v2/files_test.rb b/test/imagekit/resources/beta/v2/files_test.rb index c664cb10..7600203a 100644 --- a/test/imagekit/resources/beta/v2/files_test.rb +++ b/test/imagekit/resources/beta/v2/files_test.rb @@ -31,6 +31,7 @@ def test_upload_required_params is_published: Imagekit::Internal::Type::Boolean | nil, metadata: Imagekit::Metadata | nil, name: String | nil, + selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema]) | nil, size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail_url: String | nil, diff --git a/test/imagekit/resources/files_test.rb b/test/imagekit/resources/files_test.rb index 87d26254..427b54ff 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekit/resources/files_test.rb @@ -139,6 +139,7 @@ def test_upload_required_params is_published: Imagekit::Internal::Type::Boolean | nil, metadata: Imagekit::Metadata | nil, name: String | nil, + selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema]) | nil, size: Float | nil, tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, thumbnail_url: String | nil, From 7a7c9612cf5fbbfbbbd56efa98b33191559c4a92 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 1 Oct 2025 02:30:18 +0000 Subject: [PATCH 128/178] fix: coroutine leaks from connection pool --- .../transport/pooled_net_requester.rb | 17 ++++++------- test/imagekit/internal/util_test.rb | 25 +++++++++++++++++++ 2 files changed, 32 insertions(+), 10 deletions(-) diff --git a/lib/imagekit/internal/transport/pooled_net_requester.rb b/lib/imagekit/internal/transport/pooled_net_requester.rb index 365d5689..45f011a3 100644 --- a/lib/imagekit/internal/transport/pooled_net_requester.rb +++ b/lib/imagekit/internal/transport/pooled_net_requester.rb @@ -134,9 +134,9 @@ def execute(request) # rubocop:disable Metrics/BlockLength enum = Enumerator.new do |y| - with_pool(url, deadline: deadline) do |conn| - next if finished + next if finished + with_pool(url, deadline: deadline) do |conn| req, closing = self.class.build_request(request) do self.class.calibrate_socket_timeout(conn, deadline) end @@ -149,7 +149,7 @@ def execute(request) self.class.calibrate_socket_timeout(conn, deadline) conn.request(req) do |rsp| - y << [conn, req, rsp] + y << [req, rsp] break if finished rsp.read_body do |bytes| @@ -160,6 +160,8 @@ def execute(request) end eof = true end + ensure + conn.finish if !eof && conn&.started? end rescue Timeout::Error raise Imagekit::Errors::APITimeoutError.new(url: url, request: req) @@ -168,16 +170,11 @@ def execute(request) end # rubocop:enable Metrics/BlockLength - conn, _, response = enum.next + _, response = enum.next body = Imagekit::Internal::Util.fused_enum(enum, external: true) do finished = true - tap do - enum.next - rescue StopIteration - nil - end + loop { enum.next } ensure - conn.finish if !eof && conn&.started? closing&.call end [Integer(response.code), response, body] diff --git a/test/imagekit/internal/util_test.rb b/test/imagekit/internal/util_test.rb index 22bb128f..61865588 100644 --- a/test/imagekit/internal/util_test.rb +++ b/test/imagekit/internal/util_test.rb @@ -310,6 +310,31 @@ def test_copy_write end class Imagekit::Test::UtilFusedEnumTest < Minitest::Test + def test_rewind_closing + touched = false + once = 0 + steps = 0 + enum = Enumerator.new do |y| + next if touched + + 10.times do + steps = _1 + y << _1 + end + ensure + once = once.succ + end + + fused = Imagekit::Internal::Util.fused_enum(enum, external: true) do + touched = true + loop { enum.next } + end + Imagekit::Internal::Util.close_fused!(fused) + + assert_equal(1, once) + assert_equal(0, steps) + end + def test_closing arr = [1, 2, 3] once = 0 From 82e491a46bc8d9a0de136d592d11e84a841f48ae Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 07:36:09 +0000 Subject: [PATCH 129/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 0c9c486c..90e53979 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-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa -config_hash: e42d7fc3a8c92c35099cc283f9a4467a +config_hash: 371b1694848e02828dd8db3265557ddf From baa89e7a3cee6f3914cbc2097fb3c5d3fe308272 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 07:36:20 +0000 Subject: [PATCH 130/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 90e53979..bb92027a 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-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa -config_hash: 371b1694848e02828dd8db3265557ddf +config_hash: 719e92ff078b4a030a1480b546be0b7a From 43ac363338e8bc09402538fc85ff2d63f6c7d613 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 07:48:02 +0000 Subject: [PATCH 131/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index bb92027a..88337313 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-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa -config_hash: 719e92ff078b4a030a1480b546be0b7a +config_hash: cb0b86a64fed7f839bb0ef6568a8ba37 From 48e099dc7314cf54bb6d16df3cefb5915ca83beb Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 07:50:20 +0000 Subject: [PATCH 132/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 88337313..b346bb7b 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-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa -config_hash: cb0b86a64fed7f839bb0ef6568a8ba37 +config_hash: f351b784e512ad36eafbc0641ad61183 From 8fba80c30bd5e8696c139270a13d515d60357f8b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 09:21:17 +0000 Subject: [PATCH 133/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index b346bb7b..3d1832c1 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-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa -config_hash: f351b784e512ad36eafbc0641ad61183 +config_hash: 8d97605bd07a42f98d8142059b56522c From 4aa71de59ce759ddc5cebb988dc4175fa1b0f873 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:02:11 +0000 Subject: [PATCH 134/178] codegen metadata --- .stats.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index 3d1832c1..ad4cfbf9 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-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml -openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa -config_hash: 8d97605bd07a42f98d8142059b56522c +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-c7ad6f552b38f2145781847f8b390fa1ec43068d64e45a33012a97a9299edc10.yml +openapi_spec_hash: 50f281e91210ad5018ac7e4eee216f56 +config_hash: 6d15773e29070b9c1d4820e4897f17a5 From ff7db239d1f8a24d80b18b223b6c5d5eeea5be79 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 5 Oct 2025 13:50:10 +0000 Subject: [PATCH 135/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index ad4cfbf9..f035d349 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-c7ad6f552b38f2145781847f8b390fa1ec43068d64e45a33012a97a9299edc10.yml openapi_spec_hash: 50f281e91210ad5018ac7e4eee216f56 -config_hash: 6d15773e29070b9c1d4820e4897f17a5 +config_hash: 74a8263b80c732a2b016177e7d56bb9c From d8ac84698002bfc56befcb549f68de3e609fb698 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 8 Oct 2025 14:56:00 +0000 Subject: [PATCH 136/178] chore: ignore linter error for tests having large collections --- .rubocop.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.rubocop.yml b/.rubocop.yml index f79bc9ed..271f487d 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -121,6 +121,10 @@ Metrics/BlockLength: Metrics/ClassLength: Enabled: false +Metrics/CollectionLiteralLength: + Exclude: + - "test/**/*" + Metrics/CyclomaticComplexity: Enabled: false From 8ada019219ee04a5069a109a0eda1aeaf7a092f1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 14 Oct 2025 14:16:21 +0000 Subject: [PATCH 137/178] fix: should not reuse buffers for `IO.copy_stream` interop --- lib/imagekit/internal/util.rb | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/lib/imagekit/internal/util.rb b/lib/imagekit/internal/util.rb index c5b3aa74..4b70a7e6 100644 --- a/lib/imagekit/internal/util.rb +++ b/lib/imagekit/internal/util.rb @@ -473,10 +473,9 @@ class << self # @return [Enumerable] def writable_enum(&blk) Enumerator.new do |y| - buf = String.new y.define_singleton_method(:write) do - self << buf.replace(_1) - buf.bytesize + self << _1.dup + _1.bytesize end blk.call(y) From daea80d62574d3dd7d35898b1e21bb122fa0d4d3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 15 Oct 2025 15:46:37 +0000 Subject: [PATCH 138/178] fix: absolutely qualified uris should always override the default --- lib/imagekit/internal/util.rb | 5 +++-- test/imagekit/internal/util_test.rb | 8 ++++++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/lib/imagekit/internal/util.rb b/lib/imagekit/internal/util.rb index 4b70a7e6..77725027 100644 --- a/lib/imagekit/internal/util.rb +++ b/lib/imagekit/internal/util.rb @@ -346,8 +346,9 @@ def join_parsed_uri(lhs, rhs) base_path, base_query = lhs.fetch_values(:path, :query) slashed = base_path.end_with?("/") ? base_path : "#{base_path}/" - parsed_path, parsed_query = parse_uri(rhs.fetch(:path)).fetch_values(:path, :query) - override = URI::Generic.build(**rhs.slice(:scheme, :host, :port), path: parsed_path) + merged = {**parse_uri(rhs.fetch(:path)), **rhs.except(:path, :query)} + parsed_path, parsed_query = merged.fetch_values(:path, :query) + override = URI::Generic.build(**merged.slice(:scheme, :host, :port), path: parsed_path) joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override) query = deep_merge( diff --git a/test/imagekit/internal/util_test.rb b/test/imagekit/internal/util_test.rb index 61865588..5915b2df 100644 --- a/test/imagekit/internal/util_test.rb +++ b/test/imagekit/internal/util_test.rb @@ -124,6 +124,14 @@ def test_joining path: "/c", query: {"d" => ["e"]} } + ], + [ + "h://a.b/c?d=e", + "h://nope", + { + path: "h://a.b/c", + query: {"d" => ["e"]} + } ] ] From 5e527bebde917bd2b732a1a3826b583938dadf73 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 21 Oct 2025 09:46:04 +0000 Subject: [PATCH 139/178] feat(api): add GetImageAttributesOptions and ResponsiveImageAttributes schemas; update resource references in main.yaml; remove dummy endpoint --- .stats.yml | 6 +- lib/imagekit.rb | 4 +- lib/imagekit/models.rb | 4 + .../models/get_image_attributes_options.rb | 68 ++++++++++ .../models/responsive_image_attributes.rb | 48 +++++++ rbi/imagekit/models.rbi | 4 + .../models/get_image_attributes_options.rbi | 121 ++++++++++++++++++ rbi/imagekit/models/image_overlay.rbi | 4 +- rbi/imagekit/models/overlay_position.rbi | 4 +- .../models/responsive_image_attributes.rbi | 74 +++++++++++ .../solid_color_overlay_transformation.rbi | 19 ++- rbi/imagekit/models/src_options.rbi | 5 +- rbi/imagekit/models/subtitle_overlay.rbi | 6 +- .../subtitle_overlay_transformation.rbi | 4 +- rbi/imagekit/models/text_overlay.rbi | 4 +- .../models/text_overlay_transformation.rbi | 18 ++- rbi/imagekit/models/transformation.rbi | 104 +++++++++------ rbi/imagekit/models/video_overlay.rbi | 4 +- sig/imagekit/models.rbs | 4 + .../models/get_image_attributes_options.rbs | 43 +++++++ .../models/responsive_image_attributes.rbs | 36 ++++++ 21 files changed, 514 insertions(+), 70 deletions(-) create mode 100644 lib/imagekit/models/get_image_attributes_options.rb create mode 100644 lib/imagekit/models/responsive_image_attributes.rb create mode 100644 rbi/imagekit/models/get_image_attributes_options.rbi create mode 100644 rbi/imagekit/models/responsive_image_attributes.rbi create mode 100644 sig/imagekit/models/get_image_attributes_options.rbs create mode 100644 sig/imagekit/models/responsive_image_attributes.rbs diff --git a/.stats.yml b/.stats.yml index f035d349..27ad9e7e 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-c7ad6f552b38f2145781847f8b390fa1ec43068d64e45a33012a97a9299edc10.yml -openapi_spec_hash: 50f281e91210ad5018ac7e4eee216f56 -config_hash: 74a8263b80c732a2b016177e7d56bb9c +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0e4fa3c1f9d8cafecb9671fa76c0ff9156c643e05837804679e5e336bad8f4c1.yml +openapi_spec_hash: 4544b950730b721c252eb519358b8609 +config_hash: 3d7a0bc2844e9fb4797149b233e85770 diff --git a/lib/imagekit.rb b/lib/imagekit.rb index a6f92b0c..bf2fac04 100644 --- a/lib/imagekit.rb +++ b/lib/imagekit.rb @@ -54,6 +54,7 @@ require_relative "imagekit/models/accounts/url_endpoint_request" require_relative "imagekit/models/update_file_request" require_relative "imagekit/models/file" +require_relative "imagekit/models/src_options" require_relative "imagekit/models/base_overlay" require_relative "imagekit/models/base_webhook_event" require_relative "imagekit/models/accounts/origin_create_params" @@ -129,14 +130,15 @@ require_relative "imagekit/models/folder_rename_response" require_relative "imagekit/models/folders/job_get_params" require_relative "imagekit/models/folders/job_get_response" +require_relative "imagekit/models/get_image_attributes_options" require_relative "imagekit/models/image_overlay" require_relative "imagekit/models/metadata" require_relative "imagekit/models/overlay" require_relative "imagekit/models/overlay_position" require_relative "imagekit/models/overlay_timing" +require_relative "imagekit/models/responsive_image_attributes" require_relative "imagekit/models/solid_color_overlay" require_relative "imagekit/models/solid_color_overlay_transformation" -require_relative "imagekit/models/src_options" require_relative "imagekit/models/streaming_resolution" require_relative "imagekit/models/subtitle_overlay" require_relative "imagekit/models/subtitle_overlay_transformation" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb index 03ac79a0..8b87361a 100644 --- a/lib/imagekit/models.rb +++ b/lib/imagekit/models.rb @@ -98,6 +98,8 @@ module Imagekit Folders = Imagekit::Models::Folders + GetImageAttributesOptions = Imagekit::Models::GetImageAttributesOptions + ImageOverlay = Imagekit::Models::ImageOverlay Metadata = Imagekit::Models::Metadata @@ -108,6 +110,8 @@ module Imagekit OverlayTiming = Imagekit::Models::OverlayTiming + ResponsiveImageAttributes = Imagekit::Models::ResponsiveImageAttributes + SolidColorOverlay = Imagekit::Models::SolidColorOverlay SolidColorOverlayTransformation = Imagekit::Models::SolidColorOverlayTransformation diff --git a/lib/imagekit/models/get_image_attributes_options.rb b/lib/imagekit/models/get_image_attributes_options.rb new file mode 100644 index 00000000..29f8bae5 --- /dev/null +++ b/lib/imagekit/models/get_image_attributes_options.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class GetImageAttributesOptions < Imagekit::Models::SrcOptions + # @!attribute device_breakpoints + # Custom list of **device-width breakpoints** in pixels. These define common + # screen widths for responsive image generation. + # + # Defaults to `[640, 750, 828, 1080, 1200, 1920, 2048, 3840]`. Sorted + # automatically. + # + # @return [Array, nil] + optional :device_breakpoints, Imagekit::Internal::Type::ArrayOf[Float], api_name: :deviceBreakpoints + + # @!attribute image_breakpoints + # Custom list of **image-specific breakpoints** in pixels. Useful for generating + # small variants (e.g., placeholders or thumbnails). + # + # Merged with `deviceBreakpoints` before calculating `srcSet`. Defaults to + # `[16, 32, 48, 64, 96, 128, 256, 384]`. Sorted automatically. + # + # @return [Array, nil] + optional :image_breakpoints, Imagekit::Internal::Type::ArrayOf[Float], api_name: :imageBreakpoints + + # @!attribute sizes + # The value for the HTML `sizes` attribute (e.g., `"100vw"` or + # `"(min-width:768px) 50vw, 100vw"`). + # + # - If it includes one or more `vw` units, breakpoints smaller than the + # corresponding percentage of the smallest device width are excluded. + # - If it contains no `vw` units, the full breakpoint list is used. + # + # Enables a width-based strategy and generates `w` descriptors in `srcSet`. + # + # @return [String, nil] + optional :sizes, String + + # @!attribute width + # The intended display width of the image in pixels, used **only when the `sizes` + # attribute is not provided**. + # + # Triggers a DPR-based strategy (1x and 2x variants) and generates `x` descriptors + # in `srcSet`. + # + # Ignored if `sizes` is present. + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(device_breakpoints: nil, image_breakpoints: nil, sizes: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::GetImageAttributesOptions} for more details. + # + # Options for generating responsive image attributes including `src`, `srcSet`, + # and `sizes` for HTML `` elements. This schema extends `SrcOptions` to add + # support for responsive image generation with breakpoints. + # + # @param device_breakpoints [Array] Custom list of **device-width breakpoints** in pixels. + # + # @param image_breakpoints [Array] Custom list of **image-specific breakpoints** in pixels. + # + # @param sizes [String] The value for the HTML `sizes` attribute + # + # @param width [Float] The intended display width of the image in pixels, + end + end +end diff --git a/lib/imagekit/models/responsive_image_attributes.rb b/lib/imagekit/models/responsive_image_attributes.rb new file mode 100644 index 00000000..d3b94580 --- /dev/null +++ b/lib/imagekit/models/responsive_image_attributes.rb @@ -0,0 +1,48 @@ +# frozen_string_literal: true + +module Imagekit + module Models + class ResponsiveImageAttributes < Imagekit::Internal::Type::BaseModel + # @!attribute src + # URL for the _largest_ candidate (assigned to plain `src`). + # + # @return [String] + required :src, String + + # @!attribute sizes + # `sizes` returned (or synthesised as `100vw`). The value for the HTML `sizes` + # attribute. + # + # @return [String, nil] + optional :sizes, String + + # @!attribute src_set + # Candidate set with `w` or `x` descriptors. Multiple image URLs separated by + # commas, each with a descriptor. + # + # @return [String, nil] + optional :src_set, String, api_name: :srcSet + + # @!attribute width + # Width as a number (if `width` was provided in the input options). + # + # @return [Float, nil] + optional :width, Float + + # @!method initialize(src:, sizes: nil, src_set: nil, width: nil) + # Some parameter documentations has been truncated, see + # {Imagekit::Models::ResponsiveImageAttributes} for more details. + # + # Resulting set of attributes suitable for an HTML `` element. Useful for + # enabling responsive image loading with `srcSet` and `sizes`. + # + # @param src [String] URL for the _largest_ candidate (assigned to plain `src`). + # + # @param sizes [String] `sizes` returned (or synthesised as `100vw`). + # + # @param src_set [String] Candidate set with `w` or `x` descriptors. + # + # @param width [Float] Width as a number (if `width` was provided in the input options). + end + end +end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi index e8fe39e0..adedf849 100644 --- a/rbi/imagekit/models.rbi +++ b/rbi/imagekit/models.rbi @@ -64,6 +64,8 @@ module Imagekit Folders = Imagekit::Models::Folders + GetImageAttributesOptions = Imagekit::Models::GetImageAttributesOptions + ImageOverlay = Imagekit::Models::ImageOverlay Metadata = Imagekit::Models::Metadata @@ -74,6 +76,8 @@ module Imagekit OverlayTiming = Imagekit::Models::OverlayTiming + ResponsiveImageAttributes = Imagekit::Models::ResponsiveImageAttributes + SolidColorOverlay = Imagekit::Models::SolidColorOverlay SolidColorOverlayTransformation = diff --git a/rbi/imagekit/models/get_image_attributes_options.rbi b/rbi/imagekit/models/get_image_attributes_options.rbi new file mode 100644 index 00000000..dd13f060 --- /dev/null +++ b/rbi/imagekit/models/get_image_attributes_options.rbi @@ -0,0 +1,121 @@ +# typed: strong + +module Imagekit + module Models + class GetImageAttributesOptions < Imagekit::Models::SrcOptions + OrHash = + T.type_alias do + T.any( + Imagekit::GetImageAttributesOptions, + Imagekit::Internal::AnyHash + ) + end + + # Custom list of **device-width breakpoints** in pixels. These define common + # screen widths for responsive image generation. + # + # Defaults to `[640, 750, 828, 1080, 1200, 1920, 2048, 3840]`. Sorted + # automatically. + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :device_breakpoints + + sig { params(device_breakpoints: T::Array[Float]).void } + attr_writer :device_breakpoints + + # Custom list of **image-specific breakpoints** in pixels. Useful for generating + # small variants (e.g., placeholders or thumbnails). + # + # Merged with `deviceBreakpoints` before calculating `srcSet`. Defaults to + # `[16, 32, 48, 64, 96, 128, 256, 384]`. Sorted automatically. + sig { returns(T.nilable(T::Array[Float])) } + attr_reader :image_breakpoints + + sig { params(image_breakpoints: T::Array[Float]).void } + attr_writer :image_breakpoints + + # The value for the HTML `sizes` attribute (e.g., `"100vw"` or + # `"(min-width:768px) 50vw, 100vw"`). + # + # - If it includes one or more `vw` units, breakpoints smaller than the + # corresponding percentage of the smallest device width are excluded. + # - If it contains no `vw` units, the full breakpoint list is used. + # + # Enables a width-based strategy and generates `w` descriptors in `srcSet`. + sig { returns(T.nilable(String)) } + attr_reader :sizes + + sig { params(sizes: String).void } + attr_writer :sizes + + # The intended display width of the image in pixels, used **only when the `sizes` + # attribute is not provided**. + # + # Triggers a DPR-based strategy (1x and 2x variants) and generates `x` descriptors + # in `srcSet`. + # + # Ignored if `sizes` is present. + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Options for generating responsive image attributes including `src`, `srcSet`, + # and `sizes` for HTML `` elements. This schema extends `SrcOptions` to add + # support for responsive image generation with breakpoints. + sig do + params( + device_breakpoints: T::Array[Float], + image_breakpoints: T::Array[Float], + sizes: String, + width: Float + ).returns(T.attached_class) + end + def self.new( + # Custom list of **device-width breakpoints** in pixels. These define common + # screen widths for responsive image generation. + # + # Defaults to `[640, 750, 828, 1080, 1200, 1920, 2048, 3840]`. Sorted + # automatically. + device_breakpoints: nil, + # Custom list of **image-specific breakpoints** in pixels. Useful for generating + # small variants (e.g., placeholders or thumbnails). + # + # Merged with `deviceBreakpoints` before calculating `srcSet`. Defaults to + # `[16, 32, 48, 64, 96, 128, 256, 384]`. Sorted automatically. + image_breakpoints: nil, + # The value for the HTML `sizes` attribute (e.g., `"100vw"` or + # `"(min-width:768px) 50vw, 100vw"`). + # + # - If it includes one or more `vw` units, breakpoints smaller than the + # corresponding percentage of the smallest device width are excluded. + # - If it contains no `vw` units, the full breakpoint list is used. + # + # Enables a width-based strategy and generates `w` descriptors in `srcSet`. + sizes: nil, + # The intended display width of the image in pixels, used **only when the `sizes` + # attribute is not provided**. + # + # Triggers a DPR-based strategy (1x and 2x variants) and generates `x` descriptors + # in `srcSet`. + # + # Ignored if `sizes` is present. + width: nil + ) + end + + sig do + override.returns( + { + device_breakpoints: T::Array[Float], + image_breakpoints: T::Array[Float], + sizes: String, + width: Float + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/image_overlay.rbi b/rbi/imagekit/models/image_overlay.rbi index 409aa105..0fc3abd2 100644 --- a/rbi/imagekit/models/image_overlay.rbi +++ b/rbi/imagekit/models/image_overlay.rbi @@ -20,7 +20,7 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::ImageOverlay::Encoding::OrSymbol)) } + sig { returns(T.nilable(Imagekit::ImageOverlay::Encoding::TaggedSymbol)) } attr_reader :encoding sig { params(encoding: Imagekit::ImageOverlay::Encoding::OrSymbol).void } @@ -69,7 +69,7 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::ImageOverlay::Encoding::OrSymbol, + encoding: Imagekit::ImageOverlay::Encoding::TaggedSymbol, transformation: T::Array[Imagekit::Transformation] } ) diff --git a/rbi/imagekit/models/overlay_position.rbi b/rbi/imagekit/models/overlay_position.rbi index 96202b12..11d6a385 100644 --- a/rbi/imagekit/models/overlay_position.rbi +++ b/rbi/imagekit/models/overlay_position.rbi @@ -10,7 +10,7 @@ module Imagekit # Specifies the position of the overlay relative to the parent image or video. # Maps to `lfo` in the URL. - sig { returns(T.nilable(Imagekit::OverlayPosition::Focus::OrSymbol)) } + sig { returns(T.nilable(Imagekit::OverlayPosition::Focus::TaggedSymbol)) } attr_reader :focus sig { params(focus: Imagekit::OverlayPosition::Focus::OrSymbol).void } @@ -67,7 +67,7 @@ module Imagekit sig do override.returns( { - focus: Imagekit::OverlayPosition::Focus::OrSymbol, + focus: Imagekit::OverlayPosition::Focus::TaggedSymbol, x: Imagekit::OverlayPosition::X::Variants, y_: Imagekit::OverlayPosition::Y::Variants } diff --git a/rbi/imagekit/models/responsive_image_attributes.rbi b/rbi/imagekit/models/responsive_image_attributes.rbi new file mode 100644 index 00000000..bb3fb6f3 --- /dev/null +++ b/rbi/imagekit/models/responsive_image_attributes.rbi @@ -0,0 +1,74 @@ +# typed: strong + +module Imagekit + module Models + class ResponsiveImageAttributes < Imagekit::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekit::ResponsiveImageAttributes, + Imagekit::Internal::AnyHash + ) + end + + # URL for the _largest_ candidate (assigned to plain `src`). + sig { returns(String) } + attr_accessor :src + + # `sizes` returned (or synthesised as `100vw`). The value for the HTML `sizes` + # attribute. + sig { returns(T.nilable(String)) } + attr_reader :sizes + + sig { params(sizes: String).void } + attr_writer :sizes + + # Candidate set with `w` or `x` descriptors. Multiple image URLs separated by + # commas, each with a descriptor. + sig { returns(T.nilable(String)) } + attr_reader :src_set + + sig { params(src_set: String).void } + attr_writer :src_set + + # Width as a number (if `width` was provided in the input options). + sig { returns(T.nilable(Float)) } + attr_reader :width + + sig { params(width: Float).void } + attr_writer :width + + # Resulting set of attributes suitable for an HTML `` element. Useful for + # enabling responsive image loading with `srcSet` and `sizes`. + sig do + params( + src: String, + sizes: String, + src_set: String, + width: Float + ).returns(T.attached_class) + end + def self.new( + # URL for the _largest_ candidate (assigned to plain `src`). + src:, + # `sizes` returned (or synthesised as `100vw`). The value for the HTML `sizes` + # attribute. + sizes: nil, + # Candidate set with `w` or `x` descriptors. Multiple image URLs separated by + # commas, each with a descriptor. + src_set: nil, + # Width as a number (if `width` was provided in the input options). + width: nil + ) + end + + sig do + override.returns( + { src: String, sizes: String, src_set: String, width: Float } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/solid_color_overlay_transformation.rbi b/rbi/imagekit/models/solid_color_overlay_transformation.rbi index 698a29f6..27b96d12 100644 --- a/rbi/imagekit/models/solid_color_overlay_transformation.rbi +++ b/rbi/imagekit/models/solid_color_overlay_transformation.rbi @@ -31,7 +31,13 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(T::Boolean, String))) } + sig do + returns( + T.nilable( + Imagekit::SolidColorOverlayTransformation::Gradient::Variants + ) + ) + end attr_reader :gradient sig { params(gradient: T.any(T::Boolean, String)).void } @@ -57,7 +63,11 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(Float, Symbol))) } + sig do + returns( + T.nilable(Imagekit::SolidColorOverlayTransformation::Radius::Variants) + ) + end attr_reader :radius sig { params(radius: T.any(Float, Symbol)).void } @@ -122,9 +132,10 @@ module Imagekit { alpha: Float, background: String, - gradient: T.any(T::Boolean, String), + gradient: + Imagekit::SolidColorOverlayTransformation::Gradient::Variants, height: Imagekit::SolidColorOverlayTransformation::Height::Variants, - radius: T.any(Float, Symbol), + radius: Imagekit::SolidColorOverlayTransformation::Radius::Variants, width: Imagekit::SolidColorOverlayTransformation::Width::Variants } ) diff --git a/rbi/imagekit/models/src_options.rbi b/rbi/imagekit/models/src_options.rbi index 30c5cdaf..cd67ed29 100644 --- a/rbi/imagekit/models/src_options.rbi +++ b/rbi/imagekit/models/src_options.rbi @@ -71,7 +71,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::TransformationPosition::OrSymbol)) } + sig { returns(T.nilable(Imagekit::TransformationPosition::TaggedSymbol)) } attr_reader :transformation_position sig do @@ -145,7 +145,8 @@ module Imagekit query_parameters: T::Hash[Symbol, String], signed: T::Boolean, transformation: T::Array[Imagekit::Transformation], - transformation_position: Imagekit::TransformationPosition::OrSymbol + transformation_position: + Imagekit::TransformationPosition::TaggedSymbol } ) end diff --git a/rbi/imagekit/models/subtitle_overlay.rbi b/rbi/imagekit/models/subtitle_overlay.rbi index baa166f0..5afa9dc5 100644 --- a/rbi/imagekit/models/subtitle_overlay.rbi +++ b/rbi/imagekit/models/subtitle_overlay.rbi @@ -20,7 +20,9 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::SubtitleOverlay::Encoding::OrSymbol)) } + sig do + returns(T.nilable(Imagekit::SubtitleOverlay::Encoding::TaggedSymbol)) + end attr_reader :encoding sig do @@ -73,7 +75,7 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol, + encoding: Imagekit::SubtitleOverlay::Encoding::TaggedSymbol, transformation: T::Array[Imagekit::SubtitleOverlayTransformation] } ) diff --git a/rbi/imagekit/models/subtitle_overlay_transformation.rbi b/rbi/imagekit/models/subtitle_overlay_transformation.rbi index 3ad34a2b..797c15a3 100644 --- a/rbi/imagekit/models/subtitle_overlay_transformation.rbi +++ b/rbi/imagekit/models/subtitle_overlay_transformation.rbi @@ -82,7 +82,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol ) ) end @@ -164,7 +164,7 @@ module Imagekit font_shadow: String, font_size: Float, typography: - Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol } ) end diff --git a/rbi/imagekit/models/text_overlay.rbi b/rbi/imagekit/models/text_overlay.rbi index 9ee9cb98..acb5e580 100644 --- a/rbi/imagekit/models/text_overlay.rbi +++ b/rbi/imagekit/models/text_overlay.rbi @@ -21,7 +21,7 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::TextOverlay::Encoding::OrSymbol)) } + sig { returns(T.nilable(Imagekit::TextOverlay::Encoding::TaggedSymbol)) } attr_reader :encoding sig { params(encoding: Imagekit::TextOverlay::Encoding::OrSymbol).void } @@ -69,7 +69,7 @@ module Imagekit { text: String, type: Symbol, - encoding: Imagekit::TextOverlay::Encoding::OrSymbol, + encoding: Imagekit::TextOverlay::Encoding::TaggedSymbol, transformation: T::Array[Imagekit::TextOverlayTransformation] } ) diff --git a/rbi/imagekit/models/text_overlay_transformation.rbi b/rbi/imagekit/models/text_overlay_transformation.rbi index a2ea165d..a7755264 100644 --- a/rbi/imagekit/models/text_overlay_transformation.rbi +++ b/rbi/imagekit/models/text_overlay_transformation.rbi @@ -29,7 +29,9 @@ module Imagekit # Flip the text overlay horizontally, vertically, or both. sig do - returns(T.nilable(Imagekit::TextOverlayTransformation::Flip::OrSymbol)) + returns( + T.nilable(Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) + ) end attr_reader :flip @@ -78,7 +80,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol + Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol ) ) end @@ -129,7 +131,11 @@ module Imagekit # Specifies the corner radius of the text overlay. Set to `max` to achieve a # circular or oval shape. - sig { returns(T.nilable(T.any(Float, Symbol))) } + sig do + returns( + T.nilable(Imagekit::TextOverlayTransformation::Radius::Variants) + ) + end attr_reader :radius sig { params(radius: T.any(Float, Symbol)).void } @@ -253,16 +259,16 @@ module Imagekit { alpha: Float, background: String, - flip: Imagekit::TextOverlayTransformation::Flip::OrSymbol, + flip: Imagekit::TextOverlayTransformation::Flip::TaggedSymbol, font_color: String, font_family: String, font_size: Imagekit::TextOverlayTransformation::FontSize::Variants, inner_alignment: - Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol, + Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol, line_height: Imagekit::TextOverlayTransformation::LineHeight::Variants, padding: Imagekit::TextOverlayTransformation::Padding::Variants, - radius: T.any(Float, Symbol), + radius: Imagekit::TextOverlayTransformation::Radius::Variants, rotation: Imagekit::TextOverlayTransformation::Rotation::Variants, typography: String, width: Imagekit::TextOverlayTransformation::Width::Variants diff --git a/rbi/imagekit/models/transformation.rbi b/rbi/imagekit/models/transformation.rbi index 2c0f7137..0bf6510c 100644 --- a/rbi/imagekit/models/transformation.rbi +++ b/rbi/imagekit/models/transformation.rbi @@ -24,7 +24,9 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(T::Boolean, String))) } + sig do + returns(T.nilable(Imagekit::Transformation::AIDropShadow::Variants)) + end attr_reader :ai_drop_shadow sig { params(ai_drop_shadow: T.any(T::Boolean, String)).void } @@ -44,7 +46,7 @@ module Imagekit # [AI Background Removal](https://imagekit.io/docs/ai-transformations#imagekit-background-removal-e-bgremove). sig do returns( - T.nilable(Imagekit::Transformation::AIRemoveBackground::OrBoolean) + T.nilable(Imagekit::Transformation::AIRemoveBackground::TaggedBoolean) ) end attr_reader :ai_remove_background @@ -64,7 +66,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean + Imagekit::Transformation::AIRemoveBackgroundExternal::TaggedBoolean ) ) end @@ -81,7 +83,9 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::AIRetouch::OrBoolean)) } + sig do + returns(T.nilable(Imagekit::Transformation::AIRetouch::TaggedBoolean)) + end attr_reader :ai_retouch sig do @@ -92,7 +96,9 @@ module Imagekit # Upscales images beyond their original dimensions using AI. Not supported inside # overlay. See # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). - sig { returns(T.nilable(Imagekit::Transformation::AIUpscale::OrBoolean)) } + sig do + returns(T.nilable(Imagekit::Transformation::AIUpscale::TaggedBoolean)) + end attr_reader :ai_upscale sig do @@ -106,7 +112,7 @@ module Imagekit # original image. Not supported inside overlay. See # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). sig do - returns(T.nilable(Imagekit::Transformation::AIVariation::OrBoolean)) + returns(T.nilable(Imagekit::Transformation::AIVariation::TaggedBoolean)) end attr_reader :ai_variation @@ -135,7 +141,9 @@ module Imagekit # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). - sig { returns(T.nilable(Imagekit::Transformation::AudioCodec::OrSymbol)) } + sig do + returns(T.nilable(Imagekit::Transformation::AudioCodec::TaggedSymbol)) + end attr_reader :audio_codec sig do @@ -191,7 +199,9 @@ module Imagekit # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). sig do - returns(T.nilable(Imagekit::Transformation::ContrastStretch::OrBoolean)) + returns( + T.nilable(Imagekit::Transformation::ContrastStretch::TaggedBoolean) + ) end attr_reader :contrast_stretch @@ -204,7 +214,7 @@ module Imagekit # Crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). - sig { returns(T.nilable(Imagekit::Transformation::Crop::OrSymbol)) } + sig { returns(T.nilable(Imagekit::Transformation::Crop::TaggedSymbol)) } attr_reader :crop sig { params(crop: Imagekit::Transformation::Crop::OrSymbol).void } @@ -212,7 +222,9 @@ module Imagekit # Additional crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). - sig { returns(T.nilable(Imagekit::Transformation::CropMode::OrSymbol)) } + sig do + returns(T.nilable(Imagekit::Transformation::CropMode::TaggedSymbol)) + end attr_reader :crop_mode sig do @@ -265,7 +277,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::Flip::OrSymbol)) } + sig { returns(T.nilable(Imagekit::Transformation::Flip::TaggedSymbol)) } attr_reader :flip sig { params(flip: Imagekit::Transformation::Flip::OrSymbol).void } @@ -292,7 +304,7 @@ module Imagekit # format parameter. See # [Image format](https://imagekit.io/docs/image-optimization#format---f) and # [Video format](https://imagekit.io/docs/video-optimization#format---f). - sig { returns(T.nilable(Imagekit::Transformation::Format::OrSymbol)) } + sig { returns(T.nilable(Imagekit::Transformation::Format::TaggedSymbol)) } attr_reader :format_ sig { params(format_: Imagekit::Transformation::Format::OrSymbol).void } @@ -301,7 +313,7 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(T::Boolean, String))) } + sig { returns(T.nilable(Imagekit::Transformation::Gradient::Variants)) } attr_reader :gradient sig { params(gradient: T.any(T::Boolean, String)).void } @@ -309,7 +321,9 @@ module Imagekit # Enables a grayscale effect for images. See # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). - sig { returns(T.nilable(Imagekit::Transformation::Grayscale::OrBoolean)) } + sig do + returns(T.nilable(Imagekit::Transformation::Grayscale::TaggedBoolean)) + end attr_reader :grayscale sig do @@ -415,7 +429,7 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(Float, Symbol))) } + sig { returns(T.nilable(Imagekit::Transformation::Radius::Variants)) } attr_reader :radius sig { params(radius: T.any(Float, Symbol)).void } @@ -446,7 +460,7 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(T::Boolean, String))) } + sig { returns(T.nilable(Imagekit::Transformation::Shadow::Variants)) } attr_reader :shadow sig { params(shadow: T.any(T::Boolean, String)).void } @@ -455,7 +469,7 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(T::Boolean, Float))) } + sig { returns(T.nilable(Imagekit::Transformation::Sharpen::Variants)) } attr_reader :sharpen sig { params(sharpen: T.any(T::Boolean, Float)).void } @@ -480,7 +494,9 @@ module Imagekit # `480`, `720`, `1080`]. See # [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). sig do - returns(T.nilable(T::Array[Imagekit::StreamingResolution::OrSymbol])) + returns( + T.nilable(T::Array[Imagekit::StreamingResolution::TaggedSymbol]) + ) end attr_reader :streaming_resolutions @@ -496,7 +512,7 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(T::Boolean, Float))) } + sig { returns(T.nilable(Imagekit::Transformation::Trim::Variants)) } attr_reader :trim sig { params(trim: T.any(T::Boolean, Float)).void } @@ -505,7 +521,9 @@ module Imagekit # 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). - sig { returns(T.nilable(T.any(T::Boolean, String))) } + sig do + returns(T.nilable(Imagekit::Transformation::UnsharpMask::Variants)) + end attr_reader :unsharp_mask sig { params(unsharp_mask: T.any(T::Boolean, String)).void } @@ -513,7 +531,9 @@ module Imagekit # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). - sig { returns(T.nilable(Imagekit::Transformation::VideoCodec::OrSymbol)) } + sig do + returns(T.nilable(Imagekit::Transformation::VideoCodec::TaggedSymbol)) + end attr_reader :video_codec sig do @@ -883,34 +903,34 @@ module Imagekit override.returns( { ai_change_background: String, - ai_drop_shadow: T.any(T::Boolean, String), + ai_drop_shadow: Imagekit::Transformation::AIDropShadow::Variants, ai_edit: String, ai_remove_background: - Imagekit::Transformation::AIRemoveBackground::OrBoolean, + Imagekit::Transformation::AIRemoveBackground::TaggedBoolean, ai_remove_background_external: - Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean, - ai_retouch: Imagekit::Transformation::AIRetouch::OrBoolean, - ai_upscale: Imagekit::Transformation::AIUpscale::OrBoolean, - ai_variation: Imagekit::Transformation::AIVariation::OrBoolean, + Imagekit::Transformation::AIRemoveBackgroundExternal::TaggedBoolean, + ai_retouch: Imagekit::Transformation::AIRetouch::TaggedBoolean, + ai_upscale: Imagekit::Transformation::AIUpscale::TaggedBoolean, + ai_variation: Imagekit::Transformation::AIVariation::TaggedBoolean, aspect_ratio: Imagekit::Transformation::AspectRatio::Variants, - audio_codec: Imagekit::Transformation::AudioCodec::OrSymbol, + audio_codec: Imagekit::Transformation::AudioCodec::TaggedSymbol, background: String, blur: Float, border: String, color_profile: T::Boolean, contrast_stretch: - Imagekit::Transformation::ContrastStretch::OrBoolean, - crop: Imagekit::Transformation::Crop::OrSymbol, - crop_mode: Imagekit::Transformation::CropMode::OrSymbol, + Imagekit::Transformation::ContrastStretch::TaggedBoolean, + crop: Imagekit::Transformation::Crop::TaggedSymbol, + crop_mode: Imagekit::Transformation::CropMode::TaggedSymbol, default_image: String, dpr: Float, duration: Imagekit::Transformation::Duration::Variants, end_offset: Imagekit::Transformation::EndOffset::Variants, - flip: Imagekit::Transformation::Flip::OrSymbol, + flip: Imagekit::Transformation::Flip::TaggedSymbol, focus: String, - format_: Imagekit::Transformation::Format::OrSymbol, - gradient: T.any(T::Boolean, String), - grayscale: Imagekit::Transformation::Grayscale::OrBoolean, + format_: Imagekit::Transformation::Format::TaggedSymbol, + gradient: Imagekit::Transformation::Gradient::Variants, + grayscale: Imagekit::Transformation::Grayscale::TaggedBoolean, height: Imagekit::Transformation::Height::Variants, lossless: T::Boolean, metadata: T::Boolean, @@ -921,17 +941,17 @@ module Imagekit page: Imagekit::Transformation::Page::Variants, progressive: T::Boolean, quality: Float, - radius: T.any(Float, Symbol), + radius: Imagekit::Transformation::Radius::Variants, raw: String, rotation: Imagekit::Transformation::Rotation::Variants, - shadow: T.any(T::Boolean, String), - sharpen: T.any(T::Boolean, Float), + shadow: Imagekit::Transformation::Shadow::Variants, + sharpen: Imagekit::Transformation::Sharpen::Variants, start_offset: Imagekit::Transformation::StartOffset::Variants, streaming_resolutions: - T::Array[Imagekit::StreamingResolution::OrSymbol], - trim: T.any(T::Boolean, Float), - unsharp_mask: T.any(T::Boolean, String), - video_codec: Imagekit::Transformation::VideoCodec::OrSymbol, + T::Array[Imagekit::StreamingResolution::TaggedSymbol], + trim: Imagekit::Transformation::Trim::Variants, + unsharp_mask: Imagekit::Transformation::UnsharpMask::Variants, + video_codec: Imagekit::Transformation::VideoCodec::TaggedSymbol, width: Imagekit::Transformation::Width::Variants, x: Imagekit::Transformation::X::Variants, x_center: Imagekit::Transformation::XCenter::Variants, diff --git a/rbi/imagekit/models/video_overlay.rbi b/rbi/imagekit/models/video_overlay.rbi index 84c9aaed..b88e76ef 100644 --- a/rbi/imagekit/models/video_overlay.rbi +++ b/rbi/imagekit/models/video_overlay.rbi @@ -20,7 +20,7 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::VideoOverlay::Encoding::OrSymbol)) } + sig { returns(T.nilable(Imagekit::VideoOverlay::Encoding::TaggedSymbol)) } attr_reader :encoding sig { params(encoding: Imagekit::VideoOverlay::Encoding::OrSymbol).void } @@ -65,7 +65,7 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::VideoOverlay::Encoding::OrSymbol, + encoding: Imagekit::VideoOverlay::Encoding::TaggedSymbol, transformation: T::Array[Imagekit::Transformation] } ) diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs index bd520b8e..53e1009d 100644 --- a/sig/imagekit/models.rbs +++ b/sig/imagekit/models.rbs @@ -57,6 +57,8 @@ module Imagekit module Folders = Imagekit::Models::Folders + class GetImageAttributesOptions = Imagekit::Models::GetImageAttributesOptions + class ImageOverlay = Imagekit::Models::ImageOverlay class Metadata = Imagekit::Models::Metadata @@ -67,6 +69,8 @@ module Imagekit class OverlayTiming = Imagekit::Models::OverlayTiming + class ResponsiveImageAttributes = Imagekit::Models::ResponsiveImageAttributes + class SolidColorOverlay = Imagekit::Models::SolidColorOverlay class SolidColorOverlayTransformation = Imagekit::Models::SolidColorOverlayTransformation diff --git a/sig/imagekit/models/get_image_attributes_options.rbs b/sig/imagekit/models/get_image_attributes_options.rbs new file mode 100644 index 00000000..9eb6c071 --- /dev/null +++ b/sig/imagekit/models/get_image_attributes_options.rbs @@ -0,0 +1,43 @@ +module Imagekit + module Models + type get_image_attributes_options = + { + device_breakpoints: ::Array[Float], + image_breakpoints: ::Array[Float], + sizes: String, + width: Float + } + + class GetImageAttributesOptions < Imagekit::Models::SrcOptions + def device_breakpoints: -> ::Array[Float]? + + def device_breakpoints=: (::Array[Float] _) -> ::Array[Float] + + def image_breakpoints: -> ::Array[Float]? + + def image_breakpoints=: (::Array[Float] _) -> ::Array[Float] + + def sizes: -> String? + + def sizes=: (String _) -> String + + def width: -> Float? + + def width=: (Float _) -> Float + + def initialize: ( + ?device_breakpoints: ::Array[Float], + ?image_breakpoints: ::Array[Float], + ?sizes: String, + ?width: Float + ) -> void + + def to_hash: -> { + device_breakpoints: ::Array[Float], + image_breakpoints: ::Array[Float], + sizes: String, + width: Float + } + end + end +end diff --git a/sig/imagekit/models/responsive_image_attributes.rbs b/sig/imagekit/models/responsive_image_attributes.rbs new file mode 100644 index 00000000..45b45e85 --- /dev/null +++ b/sig/imagekit/models/responsive_image_attributes.rbs @@ -0,0 +1,36 @@ +module Imagekit + module Models + type responsive_image_attributes = + { src: String, sizes: String, src_set: String, width: Float } + + class ResponsiveImageAttributes < Imagekit::Internal::Type::BaseModel + attr_accessor src: String + + attr_reader sizes: String? + + def sizes=: (String) -> String + + attr_reader src_set: String? + + def src_set=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + src: String, + ?sizes: String, + ?src_set: String, + ?width: Float + ) -> void + + def to_hash: -> { + src: String, + sizes: String, + src_set: String, + width: Float + } + end + end +end From 766e01dd267da21aefb3da7b935c2416afcb395b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 21 Oct 2025 10:14:10 +0000 Subject: [PATCH 140/178] feat(api): fix go sdk breaking changes --- .stats.yml | 6 +- rbi/imagekit/models/image_overlay.rbi | 4 +- rbi/imagekit/models/overlay_position.rbi | 4 +- .../solid_color_overlay_transformation.rbi | 19 +--- rbi/imagekit/models/src_options.rbi | 5 +- rbi/imagekit/models/subtitle_overlay.rbi | 6 +- .../subtitle_overlay_transformation.rbi | 4 +- rbi/imagekit/models/text_overlay.rbi | 4 +- .../models/text_overlay_transformation.rbi | 18 +-- rbi/imagekit/models/transformation.rbi | 104 +++++++----------- rbi/imagekit/models/video_overlay.rbi | 4 +- 11 files changed, 69 insertions(+), 109 deletions(-) diff --git a/.stats.yml b/.stats.yml index 27ad9e7e..e27f9d4f 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-0e4fa3c1f9d8cafecb9671fa76c0ff9156c643e05837804679e5e336bad8f4c1.yml -openapi_spec_hash: 4544b950730b721c252eb519358b8609 -config_hash: 3d7a0bc2844e9fb4797149b233e85770 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml +openapi_spec_hash: a9aa620376fce66532c84f9364209b0b +config_hash: bb7229ef61cee50cd6c1ac02a5a74e81 diff --git a/rbi/imagekit/models/image_overlay.rbi b/rbi/imagekit/models/image_overlay.rbi index 0fc3abd2..409aa105 100644 --- a/rbi/imagekit/models/image_overlay.rbi +++ b/rbi/imagekit/models/image_overlay.rbi @@ -20,7 +20,7 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::ImageOverlay::Encoding::TaggedSymbol)) } + sig { returns(T.nilable(Imagekit::ImageOverlay::Encoding::OrSymbol)) } attr_reader :encoding sig { params(encoding: Imagekit::ImageOverlay::Encoding::OrSymbol).void } @@ -69,7 +69,7 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::ImageOverlay::Encoding::TaggedSymbol, + encoding: Imagekit::ImageOverlay::Encoding::OrSymbol, transformation: T::Array[Imagekit::Transformation] } ) diff --git a/rbi/imagekit/models/overlay_position.rbi b/rbi/imagekit/models/overlay_position.rbi index 11d6a385..96202b12 100644 --- a/rbi/imagekit/models/overlay_position.rbi +++ b/rbi/imagekit/models/overlay_position.rbi @@ -10,7 +10,7 @@ module Imagekit # Specifies the position of the overlay relative to the parent image or video. # Maps to `lfo` in the URL. - sig { returns(T.nilable(Imagekit::OverlayPosition::Focus::TaggedSymbol)) } + sig { returns(T.nilable(Imagekit::OverlayPosition::Focus::OrSymbol)) } attr_reader :focus sig { params(focus: Imagekit::OverlayPosition::Focus::OrSymbol).void } @@ -67,7 +67,7 @@ module Imagekit sig do override.returns( { - focus: Imagekit::OverlayPosition::Focus::TaggedSymbol, + focus: Imagekit::OverlayPosition::Focus::OrSymbol, x: Imagekit::OverlayPosition::X::Variants, y_: Imagekit::OverlayPosition::Y::Variants } diff --git a/rbi/imagekit/models/solid_color_overlay_transformation.rbi b/rbi/imagekit/models/solid_color_overlay_transformation.rbi index 27b96d12..698a29f6 100644 --- a/rbi/imagekit/models/solid_color_overlay_transformation.rbi +++ b/rbi/imagekit/models/solid_color_overlay_transformation.rbi @@ -31,13 +31,7 @@ module Imagekit # 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). - sig do - returns( - T.nilable( - Imagekit::SolidColorOverlayTransformation::Gradient::Variants - ) - ) - end + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :gradient sig { params(gradient: T.any(T::Boolean, String)).void } @@ -63,11 +57,7 @@ module Imagekit # 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). - sig do - returns( - T.nilable(Imagekit::SolidColorOverlayTransformation::Radius::Variants) - ) - end + sig { returns(T.nilable(T.any(Float, Symbol))) } attr_reader :radius sig { params(radius: T.any(Float, Symbol)).void } @@ -132,10 +122,9 @@ module Imagekit { alpha: Float, background: String, - gradient: - Imagekit::SolidColorOverlayTransformation::Gradient::Variants, + gradient: T.any(T::Boolean, String), height: Imagekit::SolidColorOverlayTransformation::Height::Variants, - radius: Imagekit::SolidColorOverlayTransformation::Radius::Variants, + radius: T.any(Float, Symbol), width: Imagekit::SolidColorOverlayTransformation::Width::Variants } ) diff --git a/rbi/imagekit/models/src_options.rbi b/rbi/imagekit/models/src_options.rbi index cd67ed29..30c5cdaf 100644 --- a/rbi/imagekit/models/src_options.rbi +++ b/rbi/imagekit/models/src_options.rbi @@ -71,7 +71,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::TransformationPosition::TaggedSymbol)) } + sig { returns(T.nilable(Imagekit::TransformationPosition::OrSymbol)) } attr_reader :transformation_position sig do @@ -145,8 +145,7 @@ module Imagekit query_parameters: T::Hash[Symbol, String], signed: T::Boolean, transformation: T::Array[Imagekit::Transformation], - transformation_position: - Imagekit::TransformationPosition::TaggedSymbol + transformation_position: Imagekit::TransformationPosition::OrSymbol } ) end diff --git a/rbi/imagekit/models/subtitle_overlay.rbi b/rbi/imagekit/models/subtitle_overlay.rbi index 5afa9dc5..baa166f0 100644 --- a/rbi/imagekit/models/subtitle_overlay.rbi +++ b/rbi/imagekit/models/subtitle_overlay.rbi @@ -20,9 +20,7 @@ module Imagekit # 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`. - sig do - returns(T.nilable(Imagekit::SubtitleOverlay::Encoding::TaggedSymbol)) - end + sig { returns(T.nilable(Imagekit::SubtitleOverlay::Encoding::OrSymbol)) } attr_reader :encoding sig do @@ -75,7 +73,7 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::SubtitleOverlay::Encoding::TaggedSymbol, + encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol, transformation: T::Array[Imagekit::SubtitleOverlayTransformation] } ) diff --git a/rbi/imagekit/models/subtitle_overlay_transformation.rbi b/rbi/imagekit/models/subtitle_overlay_transformation.rbi index 797c15a3..3ad34a2b 100644 --- a/rbi/imagekit/models/subtitle_overlay_transformation.rbi +++ b/rbi/imagekit/models/subtitle_overlay_transformation.rbi @@ -82,7 +82,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol ) ) end @@ -164,7 +164,7 @@ module Imagekit font_shadow: String, font_size: Float, typography: - Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol } ) end diff --git a/rbi/imagekit/models/text_overlay.rbi b/rbi/imagekit/models/text_overlay.rbi index acb5e580..9ee9cb98 100644 --- a/rbi/imagekit/models/text_overlay.rbi +++ b/rbi/imagekit/models/text_overlay.rbi @@ -21,7 +21,7 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::TextOverlay::Encoding::TaggedSymbol)) } + sig { returns(T.nilable(Imagekit::TextOverlay::Encoding::OrSymbol)) } attr_reader :encoding sig { params(encoding: Imagekit::TextOverlay::Encoding::OrSymbol).void } @@ -69,7 +69,7 @@ module Imagekit { text: String, type: Symbol, - encoding: Imagekit::TextOverlay::Encoding::TaggedSymbol, + encoding: Imagekit::TextOverlay::Encoding::OrSymbol, transformation: T::Array[Imagekit::TextOverlayTransformation] } ) diff --git a/rbi/imagekit/models/text_overlay_transformation.rbi b/rbi/imagekit/models/text_overlay_transformation.rbi index a7755264..a2ea165d 100644 --- a/rbi/imagekit/models/text_overlay_transformation.rbi +++ b/rbi/imagekit/models/text_overlay_transformation.rbi @@ -29,9 +29,7 @@ module Imagekit # Flip the text overlay horizontally, vertically, or both. sig do - returns( - T.nilable(Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) - ) + returns(T.nilable(Imagekit::TextOverlayTransformation::Flip::OrSymbol)) end attr_reader :flip @@ -80,7 +78,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol ) ) end @@ -131,11 +129,7 @@ module Imagekit # Specifies the corner radius of the text overlay. Set to `max` to achieve a # circular or oval shape. - sig do - returns( - T.nilable(Imagekit::TextOverlayTransformation::Radius::Variants) - ) - end + sig { returns(T.nilable(T.any(Float, Symbol))) } attr_reader :radius sig { params(radius: T.any(Float, Symbol)).void } @@ -259,16 +253,16 @@ module Imagekit { alpha: Float, background: String, - flip: Imagekit::TextOverlayTransformation::Flip::TaggedSymbol, + flip: Imagekit::TextOverlayTransformation::Flip::OrSymbol, font_color: String, font_family: String, font_size: Imagekit::TextOverlayTransformation::FontSize::Variants, inner_alignment: - Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol, + Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol, line_height: Imagekit::TextOverlayTransformation::LineHeight::Variants, padding: Imagekit::TextOverlayTransformation::Padding::Variants, - radius: Imagekit::TextOverlayTransformation::Radius::Variants, + radius: T.any(Float, Symbol), rotation: Imagekit::TextOverlayTransformation::Rotation::Variants, typography: String, width: Imagekit::TextOverlayTransformation::Width::Variants diff --git a/rbi/imagekit/models/transformation.rbi b/rbi/imagekit/models/transformation.rbi index 0bf6510c..2c0f7137 100644 --- a/rbi/imagekit/models/transformation.rbi +++ b/rbi/imagekit/models/transformation.rbi @@ -24,9 +24,7 @@ module Imagekit # 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). - sig do - returns(T.nilable(Imagekit::Transformation::AIDropShadow::Variants)) - end + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :ai_drop_shadow sig { params(ai_drop_shadow: T.any(T::Boolean, String)).void } @@ -46,7 +44,7 @@ module Imagekit # [AI Background Removal](https://imagekit.io/docs/ai-transformations#imagekit-background-removal-e-bgremove). sig do returns( - T.nilable(Imagekit::Transformation::AIRemoveBackground::TaggedBoolean) + T.nilable(Imagekit::Transformation::AIRemoveBackground::OrBoolean) ) end attr_reader :ai_remove_background @@ -66,7 +64,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Transformation::AIRemoveBackgroundExternal::TaggedBoolean + Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean ) ) end @@ -83,9 +81,7 @@ module Imagekit # 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). - sig do - returns(T.nilable(Imagekit::Transformation::AIRetouch::TaggedBoolean)) - end + sig { returns(T.nilable(Imagekit::Transformation::AIRetouch::OrBoolean)) } attr_reader :ai_retouch sig do @@ -96,9 +92,7 @@ module Imagekit # Upscales images beyond their original dimensions using AI. Not supported inside # overlay. See # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). - sig do - returns(T.nilable(Imagekit::Transformation::AIUpscale::TaggedBoolean)) - end + sig { returns(T.nilable(Imagekit::Transformation::AIUpscale::OrBoolean)) } attr_reader :ai_upscale sig do @@ -112,7 +106,7 @@ module Imagekit # original image. Not supported inside overlay. See # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). sig do - returns(T.nilable(Imagekit::Transformation::AIVariation::TaggedBoolean)) + returns(T.nilable(Imagekit::Transformation::AIVariation::OrBoolean)) end attr_reader :ai_variation @@ -141,9 +135,7 @@ module Imagekit # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). - sig do - returns(T.nilable(Imagekit::Transformation::AudioCodec::TaggedSymbol)) - end + sig { returns(T.nilable(Imagekit::Transformation::AudioCodec::OrSymbol)) } attr_reader :audio_codec sig do @@ -199,9 +191,7 @@ module Imagekit # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). sig do - returns( - T.nilable(Imagekit::Transformation::ContrastStretch::TaggedBoolean) - ) + returns(T.nilable(Imagekit::Transformation::ContrastStretch::OrBoolean)) end attr_reader :contrast_stretch @@ -214,7 +204,7 @@ module Imagekit # Crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). - sig { returns(T.nilable(Imagekit::Transformation::Crop::TaggedSymbol)) } + sig { returns(T.nilable(Imagekit::Transformation::Crop::OrSymbol)) } attr_reader :crop sig { params(crop: Imagekit::Transformation::Crop::OrSymbol).void } @@ -222,9 +212,7 @@ module Imagekit # Additional crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). - sig do - returns(T.nilable(Imagekit::Transformation::CropMode::TaggedSymbol)) - end + sig { returns(T.nilable(Imagekit::Transformation::CropMode::OrSymbol)) } attr_reader :crop_mode sig do @@ -277,7 +265,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::Flip::TaggedSymbol)) } + sig { returns(T.nilable(Imagekit::Transformation::Flip::OrSymbol)) } attr_reader :flip sig { params(flip: Imagekit::Transformation::Flip::OrSymbol).void } @@ -304,7 +292,7 @@ module Imagekit # format parameter. See # [Image format](https://imagekit.io/docs/image-optimization#format---f) and # [Video format](https://imagekit.io/docs/video-optimization#format---f). - sig { returns(T.nilable(Imagekit::Transformation::Format::TaggedSymbol)) } + sig { returns(T.nilable(Imagekit::Transformation::Format::OrSymbol)) } attr_reader :format_ sig { params(format_: Imagekit::Transformation::Format::OrSymbol).void } @@ -313,7 +301,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::Gradient::Variants)) } + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :gradient sig { params(gradient: T.any(T::Boolean, String)).void } @@ -321,9 +309,7 @@ module Imagekit # Enables a grayscale effect for images. See # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). - sig do - returns(T.nilable(Imagekit::Transformation::Grayscale::TaggedBoolean)) - end + sig { returns(T.nilable(Imagekit::Transformation::Grayscale::OrBoolean)) } attr_reader :grayscale sig do @@ -429,7 +415,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::Radius::Variants)) } + sig { returns(T.nilable(T.any(Float, Symbol))) } attr_reader :radius sig { params(radius: T.any(Float, Symbol)).void } @@ -460,7 +446,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::Shadow::Variants)) } + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :shadow sig { params(shadow: T.any(T::Boolean, String)).void } @@ -469,7 +455,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::Sharpen::Variants)) } + sig { returns(T.nilable(T.any(T::Boolean, Float))) } attr_reader :sharpen sig { params(sharpen: T.any(T::Boolean, Float)).void } @@ -494,9 +480,7 @@ module Imagekit # `480`, `720`, `1080`]. See # [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). sig do - returns( - T.nilable(T::Array[Imagekit::StreamingResolution::TaggedSymbol]) - ) + returns(T.nilable(T::Array[Imagekit::StreamingResolution::OrSymbol])) end attr_reader :streaming_resolutions @@ -512,7 +496,7 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::Trim::Variants)) } + sig { returns(T.nilable(T.any(T::Boolean, Float))) } attr_reader :trim sig { params(trim: T.any(T::Boolean, Float)).void } @@ -521,9 +505,7 @@ module Imagekit # 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). - sig do - returns(T.nilable(Imagekit::Transformation::UnsharpMask::Variants)) - end + sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_reader :unsharp_mask sig { params(unsharp_mask: T.any(T::Boolean, String)).void } @@ -531,9 +513,7 @@ module Imagekit # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). - sig do - returns(T.nilable(Imagekit::Transformation::VideoCodec::TaggedSymbol)) - end + sig { returns(T.nilable(Imagekit::Transformation::VideoCodec::OrSymbol)) } attr_reader :video_codec sig do @@ -903,34 +883,34 @@ module Imagekit override.returns( { ai_change_background: String, - ai_drop_shadow: Imagekit::Transformation::AIDropShadow::Variants, + ai_drop_shadow: T.any(T::Boolean, String), ai_edit: String, ai_remove_background: - Imagekit::Transformation::AIRemoveBackground::TaggedBoolean, + Imagekit::Transformation::AIRemoveBackground::OrBoolean, ai_remove_background_external: - Imagekit::Transformation::AIRemoveBackgroundExternal::TaggedBoolean, - ai_retouch: Imagekit::Transformation::AIRetouch::TaggedBoolean, - ai_upscale: Imagekit::Transformation::AIUpscale::TaggedBoolean, - ai_variation: Imagekit::Transformation::AIVariation::TaggedBoolean, + Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean, + ai_retouch: Imagekit::Transformation::AIRetouch::OrBoolean, + ai_upscale: Imagekit::Transformation::AIUpscale::OrBoolean, + ai_variation: Imagekit::Transformation::AIVariation::OrBoolean, aspect_ratio: Imagekit::Transformation::AspectRatio::Variants, - audio_codec: Imagekit::Transformation::AudioCodec::TaggedSymbol, + audio_codec: Imagekit::Transformation::AudioCodec::OrSymbol, background: String, blur: Float, border: String, color_profile: T::Boolean, contrast_stretch: - Imagekit::Transformation::ContrastStretch::TaggedBoolean, - crop: Imagekit::Transformation::Crop::TaggedSymbol, - crop_mode: Imagekit::Transformation::CropMode::TaggedSymbol, + Imagekit::Transformation::ContrastStretch::OrBoolean, + crop: Imagekit::Transformation::Crop::OrSymbol, + crop_mode: Imagekit::Transformation::CropMode::OrSymbol, default_image: String, dpr: Float, duration: Imagekit::Transformation::Duration::Variants, end_offset: Imagekit::Transformation::EndOffset::Variants, - flip: Imagekit::Transformation::Flip::TaggedSymbol, + flip: Imagekit::Transformation::Flip::OrSymbol, focus: String, - format_: Imagekit::Transformation::Format::TaggedSymbol, - gradient: Imagekit::Transformation::Gradient::Variants, - grayscale: Imagekit::Transformation::Grayscale::TaggedBoolean, + format_: Imagekit::Transformation::Format::OrSymbol, + gradient: T.any(T::Boolean, String), + grayscale: Imagekit::Transformation::Grayscale::OrBoolean, height: Imagekit::Transformation::Height::Variants, lossless: T::Boolean, metadata: T::Boolean, @@ -941,17 +921,17 @@ module Imagekit page: Imagekit::Transformation::Page::Variants, progressive: T::Boolean, quality: Float, - radius: Imagekit::Transformation::Radius::Variants, + radius: T.any(Float, Symbol), raw: String, rotation: Imagekit::Transformation::Rotation::Variants, - shadow: Imagekit::Transformation::Shadow::Variants, - sharpen: Imagekit::Transformation::Sharpen::Variants, + shadow: T.any(T::Boolean, String), + sharpen: T.any(T::Boolean, Float), start_offset: Imagekit::Transformation::StartOffset::Variants, streaming_resolutions: - T::Array[Imagekit::StreamingResolution::TaggedSymbol], - trim: Imagekit::Transformation::Trim::Variants, - unsharp_mask: Imagekit::Transformation::UnsharpMask::Variants, - video_codec: Imagekit::Transformation::VideoCodec::TaggedSymbol, + T::Array[Imagekit::StreamingResolution::OrSymbol], + trim: T.any(T::Boolean, Float), + unsharp_mask: T.any(T::Boolean, String), + video_codec: Imagekit::Transformation::VideoCodec::OrSymbol, width: Imagekit::Transformation::Width::Variants, x: Imagekit::Transformation::X::Variants, x_center: Imagekit::Transformation::XCenter::Variants, diff --git a/rbi/imagekit/models/video_overlay.rbi b/rbi/imagekit/models/video_overlay.rbi index b88e76ef..84c9aaed 100644 --- a/rbi/imagekit/models/video_overlay.rbi +++ b/rbi/imagekit/models/video_overlay.rbi @@ -20,7 +20,7 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::VideoOverlay::Encoding::TaggedSymbol)) } + sig { returns(T.nilable(Imagekit::VideoOverlay::Encoding::OrSymbol)) } attr_reader :encoding sig { params(encoding: Imagekit::VideoOverlay::Encoding::OrSymbol).void } @@ -65,7 +65,7 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::VideoOverlay::Encoding::TaggedSymbol, + encoding: Imagekit::VideoOverlay::Encoding::OrSymbol, transformation: T::Array[Imagekit::Transformation] } ) From a04e0fb1c1cf319e2396d8ed8337a319d74e58cc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 23 Oct 2025 14:36:09 +0000 Subject: [PATCH 141/178] feat: handle thread interrupts in the core HTTP client --- .../transport/pooled_net_requester.rb | 54 ++++++++++--------- test/imagekit/internal/util_test.rb | 23 ++++++++ 2 files changed, 53 insertions(+), 24 deletions(-) diff --git a/lib/imagekit/internal/transport/pooled_net_requester.rb b/lib/imagekit/internal/transport/pooled_net_requester.rb index 45f011a3..97f8a482 100644 --- a/lib/imagekit/internal/transport/pooled_net_requester.rb +++ b/lib/imagekit/internal/transport/pooled_net_requester.rb @@ -128,40 +128,48 @@ def execute(request) url, deadline = request.fetch_values(:url, :deadline) req = nil - eof = false finished = false - closing = nil # rubocop:disable Metrics/BlockLength enum = Enumerator.new do |y| next if finished with_pool(url, deadline: deadline) do |conn| - req, closing = self.class.build_request(request) do - self.class.calibrate_socket_timeout(conn, deadline) - end - - self.class.calibrate_socket_timeout(conn, deadline) - unless conn.started? - conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT - conn.start - end + eof = false + closing = nil + ::Thread.handle_interrupt(Object => :never) do + ::Thread.handle_interrupt(Object => :immediate) do + req, closing = self.class.build_request(request) do + self.class.calibrate_socket_timeout(conn, deadline) + end - self.class.calibrate_socket_timeout(conn, deadline) - conn.request(req) do |rsp| - y << [req, rsp] - break if finished - - rsp.read_body do |bytes| - y << bytes.force_encoding(Encoding::BINARY) - break if finished + self.class.calibrate_socket_timeout(conn, deadline) + unless conn.started? + conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT + conn.start + end self.class.calibrate_socket_timeout(conn, deadline) + conn.request(req) do |rsp| + y << [req, rsp] + break if finished + + rsp.read_body do |bytes| + y << bytes.force_encoding(Encoding::BINARY) + break if finished + + self.class.calibrate_socket_timeout(conn, deadline) + end + eof = true + end + end + ensure + begin + conn.finish if !eof && conn&.started? + ensure + closing&.call end - eof = true end - ensure - conn.finish if !eof && conn&.started? end rescue Timeout::Error raise Imagekit::Errors::APITimeoutError.new(url: url, request: req) @@ -174,8 +182,6 @@ def execute(request) body = Imagekit::Internal::Util.fused_enum(enum, external: true) do finished = true loop { enum.next } - ensure - closing&.call end [Integer(response.code), response, body] end diff --git a/test/imagekit/internal/util_test.rb b/test/imagekit/internal/util_test.rb index 5915b2df..0f466ef0 100644 --- a/test/imagekit/internal/util_test.rb +++ b/test/imagekit/internal/util_test.rb @@ -343,6 +343,29 @@ def test_rewind_closing assert_equal(0, steps) end + def test_thread_interrupts + once = 0 + que = Queue.new + enum = Enumerator.new do |y| + 10.times { y << _1 } + ensure + once = once.succ + end + + fused_1 = Imagekit::Internal::Util.fused_enum(enum, external: true) { loop { enum.next } } + fused_2 = Imagekit::Internal::Util.chain_fused(fused_1) { fused_1.each(&_1) } + fused_3 = Imagekit::Internal::Util.chain_fused(fused_2) { fused_2.each(&_1) } + + th = ::Thread.new do + que << "🐶" + fused_3.each { sleep(10) } + end + + assert_equal("🐶", que.pop) + th.kill.join + assert_equal(1, once) + end + def test_closing arr = [1, 2, 3] once = 0 From 5e7166d8d523fed9055818f4f278837cef7a7f3c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 05:32:01 +0000 Subject: [PATCH 142/178] chore: update SDK settings --- .github/workflows/publish-gem.yml | 31 ++++++++++++ .github/workflows/release-doctor.yml | 22 +++++++++ .release-please-manifest.json | 3 ++ .stats.yml | 2 +- CONTRIBUTING.md | 4 +- README.md | 8 +++- bin/check-release-environment | 21 +++++++++ imagekit.gemspec | 2 +- release-please-config.json | 70 ++++++++++++++++++++++++++++ 9 files changed, 157 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/publish-gem.yml create mode 100644 .github/workflows/release-doctor.yml create mode 100644 .release-please-manifest.json create mode 100644 bin/check-release-environment create mode 100644 release-please-config.json diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml new file mode 100644 index 00000000..a3de9dee --- /dev/null +++ b/.github/workflows/publish-gem.yml @@ -0,0 +1,31 @@ +# This workflow is triggered when a GitHub release is created. +# It can also be run manually to re-publish to rubygems.org in case it failed for some reason. +# You can run this workflow by navigating to https://www.github.com/imagekit-developer/imagekit-ruby/actions/workflows/publish-gem.yml +name: Publish Gem +on: + workflow_dispatch: + + release: + types: [published] + +jobs: + publish: + name: publish + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: false + - run: |- + bundle install + + - name: Publish to RubyGems.org + run: | + bash ./bin/publish-gem + env: + # `RUBYGEMS_HOST` is only required for private gem repositories, not https://rubygems.org + RUBYGEMS_HOST: ${{ secrets.IMAGE_KIT_RUBYGEMS_HOST || secrets.RUBYGEMS_HOST }} + GEM_HOST_API_KEY: ${{ secrets.IMAGE_KIT_GEM_HOST_API_KEY || secrets.GEM_HOST_API_KEY }} diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml new file mode 100644 index 00000000..9d9c1e66 --- /dev/null +++ b/.github/workflows/release-doctor.yml @@ -0,0 +1,22 @@ +name: Release Doctor +on: + pull_request: + branches: + - master + workflow_dispatch: + +jobs: + release_doctor: + name: release doctor + runs-on: ubuntu-latest + if: github.repository == 'imagekit-developer/imagekit-ruby' && (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: + RUBYGEMS_HOST: ${{ secrets.IMAGE_KIT_RUBYGEMS_HOST || secrets.RUBYGEMS_HOST }} + GEM_HOST_API_KEY: ${{ secrets.IMAGE_KIT_GEM_HOST_API_KEY || secrets.GEM_HOST_API_KEY }} 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 index e27f9d4f..df4337df 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: bb7229ef61cee50cd6c1ac02a5a74e81 +config_hash: d7961ccc7e3cafdf8f56d6c89c3c7d62 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff57412c..15b2dbaa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,13 +43,13 @@ If you’d like to use the repository from source, you can either install from g To install via git in your `Gemfile`: ```ruby -gem "imagekit", git: "https://www.github.com/stainless-sdks/imagekit-ruby" +gem "imagekit", git: "https://www.github.com/imagekit-developer/imagekit-ruby" ``` Alternatively, reference local copy of the repo: ```bash -$ git clone -- 'https://www.github.com/stainless-sdks/imagekit-ruby' '' +$ git clone -- 'https://www.github.com/imagekit-developer/imagekit-ruby' '' ``` ```ruby diff --git a/README.md b/README.md index dbc5335f..6f4f19f8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Image Kit Ruby API library -The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/stainless-sdks/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. +The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/imagekit-developer/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. ## Documentation @@ -12,10 +12,14 @@ The REST API documentation can be found on [imagekit.io](https://imagekit.io/doc To use this gem, install via Bundler by adding the following to your application's `Gemfile`: + + ```ruby gem "imagekit", "~> 0.0.1" ``` + + ## Usage ```ruby @@ -273,4 +277,4 @@ Ruby 3.2.0 or higher. ## Contributing -See [the contributing documentation](https://github.com/stainless-sdks/imagekit-ruby/tree/main/CONTRIBUTING.md). +See [the contributing documentation](https://github.com/imagekit-developer/imagekit-ruby/tree/master/CONTRIBUTING.md). diff --git a/bin/check-release-environment b/bin/check-release-environment new file mode 100644 index 00000000..c05436e8 --- /dev/null +++ b/bin/check-release-environment @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +errors=() + +if [ -z "${GEM_HOST_API_KEY}" ]; then + errors+=("The GEM_HOST_API_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/imagekit.gemspec b/imagekit.gemspec index a29c6731..f094efa0 100644 --- a/imagekit.gemspec +++ b/imagekit.gemspec @@ -10,7 +10,7 @@ Gem::Specification.new do |s| s.email = "developer@imagekit.io" s.homepage = "https://gemdocs.org/gems/imagekit" s.metadata["homepage_uri"] = s.homepage - s.metadata["source_code_uri"] = "https://github.com/stainless-sdks/imagekit-ruby" + s.metadata["source_code_uri"] = "https://github.com/imagekit-developer/imagekit-ruby" s.metadata["rubygems_mfa_required"] = false.to_s s.required_ruby_version = ">= 3.2.0" diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 00000000..32536019 --- /dev/null +++ b/release-please-config.json @@ -0,0 +1,70 @@ +{ + "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": "ruby", + "version-file": "lib/imagekit/version.rb", + "extra-files": [ + { + "type": "ruby-readme", + "path": "README.md" + } + ] +} \ No newline at end of file From 976d527832ecad22dc736db720c21a314635c01c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 05:32:49 +0000 Subject: [PATCH 143/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index df4337df..43d92ddb 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: d7961ccc7e3cafdf8f56d6c89c3c7d62 +config_hash: c2c1c0a5c85d678e5aa8996f3637b616 From 3457c77f072c5cc2c1a642d3fd0aae15ecc47360 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 05:45:35 +0000 Subject: [PATCH 144/178] feat(api): update gem name --- .rubocop.yml | 4 +- .solargraph.yml | 4 +- .stats.yml | 2 +- CONTRIBUTING.md | 8 +- Gemfile.lock | 4 +- README.md | 40 +- Rakefile | 2 +- imagekit.gemspec => imagekitio.gemspec | 8 +- lib/imagekit.rb | 179 ---- lib/imagekit/models.rb | 160 ---- .../models/accounts/origin_create_params.rb | 24 - .../models/accounts/origin_delete_params.rb | 16 - .../models/accounts/origin_get_params.rb | 16 - .../models/accounts/origin_list_params.rb | 16 - .../models/accounts/origin_list_response.rb | 10 - .../models/accounts/origin_update_params.rb | 24 - .../accounts/url_endpoint_create_params.rb | 16 - .../accounts/url_endpoint_delete_params.rb | 16 - .../accounts/url_endpoint_get_params.rb | 16 - .../accounts/url_endpoint_list_params.rb | 16 - .../accounts/url_endpoint_list_response.rb | 11 - .../accounts/url_endpoint_update_params.rb | 16 - lib/imagekit/models/asset_list_response.rb | 24 - lib/imagekit/models/base_overlay.rb | 21 - .../cache/invalidation_create_params.rb | 27 - .../models/cache/invalidation_get_params.rb | 16 - .../models/cache/invalidation_get_response.rb | 35 - .../custom_metadata_field_delete_params.rb | 14 - .../custom_metadata_field_delete_response.rb | 10 - .../custom_metadata_field_list_response.rb | 8 - lib/imagekit/models/file_copy_response.rb | 10 - lib/imagekit/models/file_delete_params.rb | 14 - lib/imagekit/models/file_get_params.rb | 14 - lib/imagekit/models/file_move_response.rb | 10 - lib/imagekit/models/file_update_params.rb | 22 - lib/imagekit/models/file_update_response.rb | 104 --- .../models/files/bulk_delete_params.rb | 27 - .../models/files/metadata_get_params.rb | 16 - .../models/files/version_delete_params.rb | 22 - .../models/files/version_delete_response.rb | 12 - .../models/files/version_get_params.rb | 22 - .../models/files/version_list_params.rb | 16 - .../models/files/version_list_response.rb | 10 - .../models/files/version_restore_params.rb | 22 - lib/imagekit/models/folder_create_response.rb | 10 - lib/imagekit/models/folder_delete_response.rb | 10 - lib/imagekit/models/folders/job_get_params.rb | 16 - lib/imagekit/models/overlay.rb | 28 - .../models/webhook_unsafe_unwrap_params.rb | 14 - lib/imagekit/models/webhook_unwrap_params.rb | 14 - lib/imagekit/resources/accounts.rb | 26 - lib/imagekit/resources/accounts/origins.rb | 145 ---- lib/imagekit/resources/webhooks.rb | 30 - lib/imagekitio.rb | 179 ++++ lib/{imagekit => imagekitio}/client.rb | 36 +- lib/{imagekit => imagekitio}/errors.rb | 46 +- lib/{imagekit => imagekitio}/file_part.rb | 2 +- lib/{imagekit => imagekitio}/internal.rb | 8 +- .../internal/transport/base_client.rb | 100 +-- .../transport/pooled_net_requester.rb | 22 +- .../internal/type/array_of.rb | 24 +- .../internal/type/base_model.rb | 76 +- .../internal/type/base_page.rb | 6 +- .../internal/type/boolean.rb | 8 +- .../internal/type/converter.rb | 40 +- .../internal/type/enum.rb | 20 +- .../internal/type/file_input.rb | 18 +- .../internal/type/hash_of.rb | 24 +- .../internal/type/request_parameters.rb | 10 +- .../internal/type/union.rb | 48 +- .../internal/type/unknown.rb | 8 +- lib/{imagekit => imagekitio}/internal/util.rb | 28 +- lib/imagekitio/models.rb | 160 ++++ .../models/accounts/origin_create_params.rb | 24 + .../models/accounts/origin_delete_params.rb | 16 + .../models/accounts/origin_get_params.rb | 16 + .../models/accounts/origin_list_params.rb | 16 + .../models/accounts/origin_list_response.rb | 11 + .../models/accounts/origin_request.rb | 58 +- .../models/accounts/origin_response.rb | 77 +- .../models/accounts/origin_update_params.rb | 24 + .../accounts/url_endpoint_create_params.rb | 16 + .../accounts/url_endpoint_delete_params.rb | 16 + .../accounts/url_endpoint_get_params.rb | 16 + .../accounts/url_endpoint_list_params.rb | 16 + .../accounts/url_endpoint_list_response.rb | 11 + .../models/accounts/url_endpoint_request.rb | 34 +- .../models/accounts/url_endpoint_response.rb | 36 +- .../accounts/url_endpoint_update_params.rb | 16 + .../models/accounts/usage_get_params.rb | 14 +- .../models/accounts/usage_get_response.rb | 6 +- .../models/asset_list_params.rb | 38 +- lib/imagekitio/models/asset_list_response.rb | 24 + lib/imagekitio/models/base_overlay.rb | 21 + .../models/base_webhook_event.rb | 4 +- .../models/beta/v2/file_upload_params.rb | 109 +-- .../models/beta/v2/file_upload_response.rb | 158 ++-- .../cache/invalidation_create_params.rb | 27 + .../cache/invalidation_create_response.rb | 8 +- .../models/cache/invalidation_get_params.rb | 16 + .../models/cache/invalidation_get_response.rb | 35 + .../models/custom_metadata_field.rb | 70 +- .../custom_metadata_field_create_params.rb | 74 +- .../custom_metadata_field_delete_params.rb | 14 + .../custom_metadata_field_delete_response.rb | 10 + .../custom_metadata_field_list_params.rb | 16 +- .../custom_metadata_field_list_response.rb | 9 + .../custom_metadata_field_update_params.rb | 64 +- .../models/extensions.rb | 48 +- lib/{imagekit => imagekitio}/models/file.rb | 120 +-- .../models/file_copy_params.rb | 16 +- lib/imagekitio/models/file_copy_response.rb | 10 + lib/imagekitio/models/file_delete_params.rb | 14 + lib/imagekitio/models/file_get_params.rb | 14 + .../models/file_move_params.rb | 14 +- lib/imagekitio/models/file_move_response.rb | 10 + .../models/file_rename_params.rb | 16 +- .../models/file_rename_response.rb | 8 +- lib/imagekitio/models/file_update_params.rb | 22 + lib/imagekitio/models/file_update_response.rb | 104 +++ .../models/file_upload_params.rb | 108 +-- .../models/file_upload_response.rb | 156 ++-- .../models/files/bulk_add_tags_params.rb | 18 +- .../models/files/bulk_add_tags_response.rb | 10 +- .../models/files/bulk_delete_params.rb | 27 + .../models/files/bulk_delete_response.rb | 10 +- .../files/bulk_remove_ai_tags_params.rb | 18 +- .../files/bulk_remove_ai_tags_response.rb | 10 +- .../models/files/bulk_remove_tags_params.rb | 18 +- .../models/files/bulk_remove_tags_response.rb | 10 +- .../files/metadata_get_from_url_params.rb | 14 +- .../models/files/metadata_get_params.rb | 16 + .../models/files/version_delete_params.rb | 22 + .../models/files/version_delete_response.rb | 12 + .../models/files/version_get_params.rb | 22 + .../models/files/version_list_params.rb | 16 + .../models/files/version_list_response.rb | 10 + .../models/files/version_restore_params.rb | 22 + lib/{imagekit => imagekitio}/models/folder.rb | 18 +- .../models/folder_copy_params.rb | 16 +- .../models/folder_copy_response.rb} | 8 +- .../models/folder_create_params.rb | 14 +- .../models/folder_create_response.rb | 10 + .../models/folder_delete_params.rb | 14 +- .../models/folder_delete_response.rb | 10 + .../models/folder_move_params.rb | 14 +- .../models/folder_move_response.rb | 8 +- .../models/folder_rename_params.rb | 16 +- .../models/folder_rename_response.rb} | 8 +- .../models/folders/job_get_params.rb | 16 + .../models/folders/job_get_response.rb | 28 +- .../models/get_image_attributes_options.rb | 10 +- .../models/image_overlay.rb | 20 +- .../models/metadata.rb | 72 +- lib/imagekitio/models/overlay.rb | 28 + .../models/overlay_position.rb | 28 +- .../models/overlay_timing.rb | 24 +- .../models/responsive_image_attributes.rb | 6 +- .../models/solid_color_overlay.rb | 12 +- .../solid_color_overlay_transformation.rb | 30 +- .../models/src_options.rb | 22 +- .../models/streaming_resolution.rb | 4 +- .../models/subtitle_overlay.rb | 20 +- .../models/subtitle_overlay_transformation.rb | 16 +- .../models/text_overlay.rb | 21 +- .../models/text_overlay_transformation.rb | 62 +- .../models/transformation.rb | 276 +++---- .../models/transformation_position.rb | 4 +- .../models/unsafe_unwrap_webhook_event.rb | 20 +- .../models/unwrap_webhook_event.rb | 20 +- .../models/update_file_request.rb | 59 +- .../upload_post_transform_error_event.rb | 70 +- .../upload_post_transform_success_event.rb | 50 +- .../upload_pre_transform_error_event.rb | 40 +- .../upload_pre_transform_success_event.rb | 172 ++-- .../models/video_overlay.rb | 20 +- .../video_transformation_accepted_event.rb | 106 +-- .../video_transformation_error_event.rb | 130 +-- .../video_transformation_ready_event.rb | 138 ++-- .../models/webhook_unsafe_unwrap_params.rb | 14 + .../models/webhook_unwrap_params.rb | 14 + .../request_options.rb | 16 +- lib/imagekitio/resources/accounts.rb | 26 + lib/imagekitio/resources/accounts/origins.rb | 145 ++++ .../resources/accounts/url_endpoints.rb | 56 +- .../resources/accounts/usage.rb | 16 +- .../resources/assets.rb | 22 +- .../resources/beta.rb | 8 +- .../resources/beta/v2.rb | 8 +- .../resources/beta/v2/files.rb | 24 +- .../resources/cache.rb | 8 +- .../resources/cache/invalidation.rb | 26 +- .../resources/custom_metadata_fields.rb | 54 +- .../resources/files.rb | 102 +-- .../resources/files/bulk.rb | 52 +- .../resources/files/metadata.rb | 26 +- .../resources/files/versions.rb | 50 +- .../resources/folders.rb | 68 +- .../resources/folders/job.rb | 14 +- lib/imagekitio/resources/webhooks.rb | 30 + lib/{imagekit => imagekitio}/version.rb | 2 +- rbi/imagekit/models.rbi | 134 --- .../models/accounts/origin_create_params.rbi | 81 -- .../models/accounts/origin_delete_params.rbi | 32 - .../models/accounts/origin_get_params.rbi | 32 - .../models/accounts/origin_list_params.rbi | 32 - .../models/accounts/origin_list_response.rbi | 15 - .../models/accounts/origin_update_params.rbi | 81 -- .../accounts/url_endpoint_create_params.rbi | 32 - .../accounts/url_endpoint_delete_params.rbi | 32 - .../accounts/url_endpoint_get_params.rbi | 32 - .../accounts/url_endpoint_list_params.rbi | 32 - .../accounts/url_endpoint_list_response.rbi | 15 - .../accounts/url_endpoint_update_params.rbi | 32 - rbi/imagekit/models/asset_list_response.rbi | 28 - rbi/imagekit/models/base_overlay.rbi | 44 - .../models/cache/invalidation_get_params.rbi | 32 - .../custom_metadata_field_delete_params.rbi | 30 - .../custom_metadata_field_list_response.rbi | 11 - rbi/imagekit/models/file_delete_params.rbi | 27 - rbi/imagekit/models/file_get_params.rbi | 27 - rbi/imagekit/models/file_move_response.rbi | 20 - rbi/imagekit/models/file_update_params.rbi | 58 -- .../models/files/metadata_get_params.rbi | 32 - .../models/files/version_list_params.rbi | 32 - .../models/files/version_list_response.rbi | 13 - .../models/folders/job_get_params.rbi | 29 - rbi/imagekit/models/streaming_resolution.rbi | 36 - .../models/unsafe_unwrap_webhook_event.rbi | 31 - rbi/imagekit/models/unwrap_webhook_event.rbi | 29 - .../models/webhook_unsafe_unwrap_params.rbi | 30 - rbi/imagekit/models/webhook_unwrap_params.rbi | 27 - rbi/imagekit/resources/accounts.rbi | 21 - rbi/imagekit/resources/webhooks.rbi | 50 -- rbi/{imagekit => imagekitio}/client.rbi | 28 +- rbi/{imagekit => imagekitio}/errors.rbi | 28 +- rbi/{imagekit => imagekitio}/file_part.rbi | 2 +- rbi/{imagekit => imagekitio}/internal.rbi | 8 +- .../internal/transport/base_client.rbi | 45 +- .../transport/pooled_net_requester.rbi | 11 +- .../internal/type/array_of.rbi | 26 +- .../internal/type/base_model.rbi | 64 +- .../internal/type/base_page.rbi | 6 +- .../internal/type/boolean.rbi | 10 +- .../internal/type/converter.rbi | 48 +- .../internal/type/enum.rbi | 10 +- .../internal/type/file_input.rbi | 10 +- .../internal/type/hash_of.rbi | 30 +- .../internal/type/request_parameters.rbi | 8 +- .../internal/type/union.rbi | 20 +- .../internal/type/unknown.rbi | 10 +- .../internal/util.rbi | 18 +- rbi/imagekitio/models.rbi | 135 ++++ .../models/accounts/origin_create_params.rbi | 81 ++ .../models/accounts/origin_delete_params.rbi | 34 + .../models/accounts/origin_get_params.rbi | 34 + .../models/accounts/origin_list_params.rbi | 34 + .../models/accounts/origin_list_response.rbi | 15 + .../models/accounts/origin_request.rbi | 70 +- .../models/accounts/origin_response.rbi | 70 +- .../models/accounts/origin_update_params.rbi | 81 ++ .../accounts/url_endpoint_create_params.rbi | 34 + .../accounts/url_endpoint_delete_params.rbi | 34 + .../accounts/url_endpoint_get_params.rbi | 34 + .../accounts/url_endpoint_list_params.rbi | 34 + .../accounts/url_endpoint_list_response.rbi | 15 + .../models/accounts/url_endpoint_request.rbi | 60 +- .../models/accounts/url_endpoint_response.rbi | 52 +- .../accounts/url_endpoint_update_params.rbi | 34 + .../models/accounts/usage_get_params.rbi | 16 +- .../models/accounts/usage_get_response.rbi | 8 +- .../models/asset_list_params.rbi | 110 +-- rbi/imagekitio/models/asset_list_response.rbi | 28 + rbi/imagekitio/models/base_overlay.rbi | 44 + .../models/base_webhook_event.rbi | 6 +- .../models/beta/v2/file_upload_params.rbi | 174 ++-- .../models/beta/v2/file_upload_response.rbi | 238 +++--- .../cache/invalidation_create_params.rbi | 16 +- .../cache/invalidation_create_response.rbi | 8 +- .../models/cache/invalidation_get_params.rbi | 34 + .../cache/invalidation_get_response.rbi | 26 +- .../models/custom_metadata_field.rbi | 114 +-- .../custom_metadata_field_create_params.rbi | 116 +-- .../custom_metadata_field_delete_params.rbi | 30 + .../custom_metadata_field_delete_response.rbi | 23 + .../custom_metadata_field_list_params.rbi | 16 +- .../custom_metadata_field_list_response.rbi | 11 + .../custom_metadata_field_update_params.rbi | 90 +-- .../models/extensions.rbi | 70 +- rbi/{imagekit => imagekitio}/models/file.rbi | 161 ++-- .../models/file_copy_params.rbi | 14 +- .../models/file_copy_response.rbi} | 8 +- rbi/imagekitio/models/file_delete_params.rbi | 27 + rbi/imagekitio/models/file_get_params.rbi | 27 + .../models/file_move_params.rbi | 14 +- .../models/file_move_response.rbi} | 8 +- .../models/file_rename_params.rbi | 14 +- .../models/file_rename_response.rbi | 8 +- rbi/imagekitio/models/file_update_params.rbi | 58 ++ .../models/file_update_response.rbi | 102 +-- .../models/file_upload_params.rbi | 175 ++-- .../models/file_upload_response.rbi | 238 +++--- .../models/files/bulk_add_tags_params.rbi | 16 +- .../models/files/bulk_add_tags_response.rbi | 8 +- .../models/files/bulk_delete_params.rbi | 16 +- .../models/files/bulk_delete_response.rbi | 8 +- .../files/bulk_remove_ai_tags_params.rbi | 16 +- .../files/bulk_remove_ai_tags_response.rbi | 8 +- .../models/files/bulk_remove_tags_params.rbi | 16 +- .../files/bulk_remove_tags_response.rbi | 8 +- .../files/metadata_get_from_url_params.rbi | 16 +- .../models/files/metadata_get_params.rbi | 34 + .../models/files/version_delete_params.rbi | 16 +- .../models/files/version_delete_response.rbi | 8 +- .../models/files/version_get_params.rbi | 16 +- .../models/files/version_list_params.rbi | 34 + .../models/files/version_list_response.rbi | 13 + .../models/files/version_restore_params.rbi | 16 +- .../models/folder.rbi | 26 +- .../models/folder_copy_params.rbi | 14 +- .../models/folder_copy_response.rbi | 8 +- .../models/folder_create_params.rbi | 14 +- .../models/folder_create_response.rbi} | 8 +- .../models/folder_delete_params.rbi | 14 +- .../models/folder_delete_response.rbi} | 9 +- .../models/folder_move_params.rbi | 14 +- .../models/folder_move_response.rbi | 8 +- .../models/folder_rename_params.rbi | 14 +- .../models/folder_rename_response.rbi | 8 +- .../models/folders/job_get_params.rbi | 34 + .../models/folders/job_get_response.rbi | 48 +- .../models/get_image_attributes_options.rbi | 8 +- .../models/image_overlay.rbi | 37 +- .../models/metadata.rbi | 93 ++- .../models/overlay.rbi | 16 +- .../models/overlay_position.rbi | 64 +- .../models/overlay_timing.rbi | 44 +- .../models/responsive_image_attributes.rbi | 8 +- .../models/solid_color_overlay.rbi | 17 +- .../solid_color_overlay_transformation.rbi | 47 +- .../models/src_options.rbi | 25 +- .../models/streaming_resolution.rbi | 38 + .../models/subtitle_overlay.rbi | 37 +- .../subtitle_overlay_transformation.rbi | 28 +- .../models/text_overlay.rbi | 38 +- .../models/text_overlay_transformation.rbi | 124 +-- .../models/transformation.rbi | 496 ++++++------ .../models/transformation_position.rbi | 12 +- .../models/unsafe_unwrap_webhook_event.rbi | 33 + .../models/unwrap_webhook_event.rbi | 31 + .../models/update_file_request.rbi | 70 +- .../upload_post_transform_error_event.rbi | 120 +-- .../upload_post_transform_success_event.rbi | 88 +- .../upload_pre_transform_error_event.rbi | 68 +- .../upload_pre_transform_success_event.rbi | 264 +++--- .../models/video_overlay.rbi | 37 +- .../video_transformation_accepted_event.rbi | 179 ++-- .../video_transformation_error_event.rbi | 214 ++--- .../video_transformation_ready_event.rbi | 224 ++--- .../models/webhook_unsafe_unwrap_params.rbi | 30 + .../models/webhook_unwrap_params.rbi | 27 + .../request_options.rbi | 10 +- rbi/imagekitio/resources/accounts.rbi | 21 + .../resources/accounts/origins.rbi | 26 +- .../resources/accounts/url_endpoints.rbi | 34 +- .../resources/accounts/usage.rbi | 8 +- .../resources/assets.rbi | 14 +- .../resources/beta.rbi | 6 +- .../resources/beta/v2.rbi | 6 +- .../resources/beta/v2/files.rbi | 20 +- .../resources/cache.rbi | 6 +- .../resources/cache/invalidation.rbi | 12 +- .../resources/custom_metadata_fields.rbi | 24 +- .../resources/files.rbi | 50 +- .../resources/files/bulk.rbi | 20 +- .../resources/files/metadata.rbi | 12 +- .../resources/files/versions.rbi | 20 +- .../resources/folders.rbi | 26 +- .../resources/folders/job.rbi | 8 +- rbi/imagekitio/resources/webhooks.rbi | 50 ++ rbi/{imagekit => imagekitio}/version.rbi | 2 +- release-please-config.json | 2 +- sig/imagekit/internal/type/converter.rbs | 79 -- .../internal/type/request_parameters.rbs | 17 - sig/imagekit/models.rbs | 119 --- .../models/accounts/origin_create_params.rbs | 30 - .../models/accounts/origin_delete_params.rbs | 17 - .../models/accounts/origin_get_params.rbs | 17 - .../models/accounts/origin_list_params.rbs | 17 - .../models/accounts/origin_list_response.rbs | 10 - .../models/accounts/origin_update_params.rbs | 30 - .../accounts/url_endpoint_create_params.rbs | 17 - .../accounts/url_endpoint_delete_params.rbs | 17 - .../accounts/url_endpoint_get_params.rbs | 17 - .../accounts/url_endpoint_list_params.rbs | 17 - .../accounts/url_endpoint_list_response.rbs | 10 - .../accounts/url_endpoint_update_params.rbs | 17 - sig/imagekit/models/asset_list_response.rbs | 16 - sig/imagekit/models/base_overlay.rbs | 26 - .../models/beta/v2/file_upload_response.rbs | 487 ----------- .../cache/invalidation_create_params.rbs | 25 - .../models/cache/invalidation_get_params.rbs | 17 - .../cache/invalidation_get_response.rbs | 35 - sig/imagekit/models/custom_metadata_field.rbs | 178 ---- .../custom_metadata_field_create_params.rbs | 179 ---- .../custom_metadata_field_delete_params.rbs | 15 - .../custom_metadata_field_list_response.rbs | 8 - .../custom_metadata_field_update_params.rbs | 152 ---- sig/imagekit/models/file_delete_params.rbs | 15 - sig/imagekit/models/file_get_params.rbs | 14 - sig/imagekit/models/file_update_params.rbs | 28 - sig/imagekit/models/file_update_response.rbs | 120 --- sig/imagekit/models/file_upload_response.rbs | 483 ----------- .../models/files/bulk_delete_params.rbs | 26 - .../files/metadata_get_from_url_params.rbs | 25 - .../models/files/metadata_get_params.rbs | 17 - .../models/files/version_delete_params.rbs | 25 - .../models/files/version_get_params.rbs | 25 - .../models/files/version_list_params.rbs | 17 - .../models/files/version_list_response.rbs | 9 - .../models/files/version_restore_params.rbs | 25 - sig/imagekit/models/folder_delete_params.rbs | 23 - .../models/folders/job_get_params.rbs | 16 - .../models/folders/job_get_response.rbs | 72 -- sig/imagekit/models/image_overlay.rbs | 59 -- sig/imagekit/models/overlay.rbs | 16 - sig/imagekit/models/overlay_position.rbs | 85 -- sig/imagekit/models/overlay_timing.rbs | 66 -- sig/imagekit/models/solid_color_overlay.rbs | 38 - .../solid_color_overlay_transformation.rbs | 97 --- sig/imagekit/models/subtitle_overlay.rbs | 59 -- sig/imagekit/models/text_overlay.rbs | 59 -- .../models/text_overlay_transformation.rbs | 195 ----- sig/imagekit/models/transformation.rbs | 763 ------------------ .../models/unsafe_unwrap_webhook_event.rbs | 18 - sig/imagekit/models/unwrap_webhook_event.rbs | 18 - sig/imagekit/models/update_file_request.rbs | 122 --- .../upload_post_transform_error_event.rbs | 192 ----- .../upload_post_transform_success_event.rbs | 142 ---- .../upload_pre_transform_error_event.rbs | 115 --- .../upload_pre_transform_success_event.rbs | 541 ------------- sig/imagekit/models/video_overlay.rbs | 59 -- .../video_transformation_accepted_event.rbs | 261 ------ .../video_transformation_error_event.rbs | 300 ------- .../video_transformation_ready_event.rbs | 359 -------- .../models/webhook_unsafe_unwrap_params.rbs | 15 - sig/imagekit/models/webhook_unwrap_params.rbs | 15 - sig/imagekit/resources/accounts.rbs | 13 - sig/imagekit/resources/accounts/origins.rbs | 31 - .../resources/accounts/url_endpoints.rbs | 37 - sig/imagekit/resources/accounts/usage.rbs | 15 - sig/imagekit/resources/assets.rbs | 18 - sig/imagekit/resources/beta.rbs | 9 - sig/imagekit/resources/beta/v2.rbs | 11 - sig/imagekit/resources/cache.rbs | 9 - sig/imagekit/resources/cache/invalidation.rbs | 19 - .../resources/custom_metadata_fields.rbs | 32 - sig/imagekit/resources/files.rbs | 76 -- sig/imagekit/resources/files/bulk.rbs | 32 - sig/imagekit/resources/files/metadata.rbs | 19 - sig/imagekit/resources/files/versions.rbs | 32 - sig/imagekit/resources/folders.rbs | 40 - sig/imagekit/resources/folders/job.rbs | 14 - sig/imagekit/resources/webhooks.rbs | 27 - sig/{imagekit => imagekitio}/client.rbs | 20 +- sig/{imagekit => imagekitio}/errors.rbs | 28 +- sig/{imagekit => imagekitio}/file_part.rbs | 2 +- sig/{imagekit => imagekitio}/internal.rbs | 6 +- .../internal/transport/base_client.rbs | 30 +- .../transport/pooled_net_requester.rbs | 8 +- .../internal/type/array_of.rbs | 18 +- .../internal/type/base_model.rbs | 38 +- .../internal/type/base_page.rbs | 6 +- .../internal/type/boolean.rbs | 10 +- sig/imagekitio/internal/type/converter.rbs | 79 ++ .../internal/type/enum.rbs | 10 +- .../internal/type/file_input.rbs | 8 +- .../internal/type/hash_of.rbs | 18 +- .../internal/type/request_parameters.rbs | 19 + .../internal/type/union.rbs | 22 +- .../internal/type/unknown.rbs | 10 +- .../internal/util.rbs | 16 +- sig/imagekitio/models.rbs | 119 +++ .../models/accounts/origin_create_params.rbs | 30 + .../models/accounts/origin_delete_params.rbs | 17 + .../models/accounts/origin_get_params.rbs | 17 + .../models/accounts/origin_list_params.rbs | 17 + .../models/accounts/origin_list_response.rbs | 10 + .../models/accounts/origin_request.rbs | 38 +- .../models/accounts/origin_response.rbs | 38 +- .../models/accounts/origin_update_params.rbs | 30 + .../accounts/url_endpoint_create_params.rbs | 17 + .../accounts/url_endpoint_delete_params.rbs | 17 + .../accounts/url_endpoint_get_params.rbs | 17 + .../accounts/url_endpoint_list_params.rbs | 17 + .../accounts/url_endpoint_list_response.rbs | 10 + .../models/accounts/url_endpoint_request.rbs | 32 +- .../models/accounts/url_endpoint_response.rbs | 32 +- .../accounts/url_endpoint_update_params.rbs | 17 + .../models/accounts/usage_get_params.rbs | 14 +- .../models/accounts/usage_get_response.rbs | 4 +- .../models/asset_list_params.rbs | 62 +- sig/imagekitio/models/asset_list_response.rbs | 16 + sig/imagekitio/models/base_overlay.rbs | 31 + .../models/base_webhook_event.rbs | 4 +- .../models/beta/v2/file_upload_params.rbs | 108 +-- .../models/beta/v2/file_upload_response.rbs | 487 +++++++++++ .../cache/invalidation_create_params.rbs | 25 + .../cache/invalidation_create_response.rbs | 4 +- .../models/cache/invalidation_get_params.rbs | 17 + .../cache/invalidation_get_response.rbs | 35 + .../models/custom_metadata_field.rbs | 178 ++++ .../custom_metadata_field_create_params.rbs | 179 ++++ .../custom_metadata_field_delete_params.rbs | 15 + .../custom_metadata_field_delete_response.rbs | 4 +- .../custom_metadata_field_list_params.rbs | 14 +- .../custom_metadata_field_list_response.rbs | 8 + .../custom_metadata_field_update_params.rbs | 152 ++++ .../models/extensions.rbs | 48 +- sig/{imagekit => imagekitio}/models/file.rbs | 142 ++-- .../models/file_copy_params.rbs | 14 +- .../models/file_copy_response.rbs | 4 +- sig/imagekitio/models/file_delete_params.rbs | 15 + sig/imagekitio/models/file_get_params.rbs | 14 + .../models/file_move_params.rbs | 14 +- .../models/file_move_response.rbs | 4 +- .../models/file_rename_params.rbs | 14 +- .../models/file_rename_response.rbs | 4 +- sig/imagekitio/models/file_update_params.rbs | 28 + .../models/file_update_response.rbs | 120 +++ .../models/file_upload_params.rbs | 108 +-- .../models/file_upload_response.rbs | 483 +++++++++++ .../models/files/bulk_add_tags_params.rbs | 14 +- .../models/files/bulk_add_tags_response.rbs | 4 +- .../models/files/bulk_delete_params.rbs | 26 + .../models/files/bulk_delete_response.rbs | 4 +- .../files/bulk_remove_ai_tags_params.rbs | 14 +- .../files/bulk_remove_ai_tags_response.rbs | 4 +- .../models/files/bulk_remove_tags_params.rbs | 14 +- .../files/bulk_remove_tags_response.rbs | 4 +- .../files/metadata_get_from_url_params.rbs | 25 + .../models/files/metadata_get_params.rbs | 17 + .../models/files/version_delete_params.rbs | 25 + .../models/files/version_delete_response.rbs | 4 +- .../models/files/version_get_params.rbs | 25 + .../models/files/version_list_params.rbs | 17 + .../models/files/version_list_response.rbs | 9 + .../models/files/version_restore_params.rbs | 25 + .../models/folder.rbs | 20 +- .../models/folder_copy_params.rbs | 14 +- .../models/folder_copy_response.rbs | 4 +- .../models/folder_create_params.rbs | 14 +- .../models/folder_create_response.rbs | 4 +- .../models/folder_delete_params.rbs | 23 + .../models/folder_delete_response.rbs | 4 +- .../models/folder_move_params.rbs | 14 +- .../models/folder_move_response.rbs | 4 +- .../models/folder_rename_params.rbs | 14 +- .../models/folder_rename_response.rbs | 4 +- .../models/folders/job_get_params.rbs | 17 + .../models/folders/job_get_response.rbs | 72 ++ .../models/get_image_attributes_options.rbs | 4 +- sig/imagekitio/models/image_overlay.rbs | 59 ++ .../models/metadata.rbs | 86 +- sig/imagekitio/models/overlay.rbs | 16 + sig/imagekitio/models/overlay_position.rbs | 85 ++ sig/imagekitio/models/overlay_timing.rbs | 66 ++ .../models/responsive_image_attributes.rbs | 4 +- sig/imagekitio/models/solid_color_overlay.rbs | 38 + .../solid_color_overlay_transformation.rbs | 97 +++ .../models/src_options.rbs | 28 +- .../models/streaming_resolution.rbs | 6 +- sig/imagekitio/models/subtitle_overlay.rbs | 59 ++ .../subtitle_overlay_transformation.rbs | 20 +- sig/imagekitio/models/text_overlay.rbs | 59 ++ .../models/text_overlay_transformation.rbs | 195 +++++ sig/imagekitio/models/transformation.rbs | 763 ++++++++++++++++++ .../models/transformation_position.rbs | 6 +- .../models/unsafe_unwrap_webhook_event.rbs | 18 + .../models/unwrap_webhook_event.rbs | 18 + sig/imagekitio/models/update_file_request.rbs | 122 +++ .../upload_post_transform_error_event.rbs | 192 +++++ .../upload_post_transform_success_event.rbs | 142 ++++ .../upload_pre_transform_error_event.rbs | 115 +++ .../upload_pre_transform_success_event.rbs | 541 +++++++++++++ sig/imagekitio/models/video_overlay.rbs | 59 ++ .../video_transformation_accepted_event.rbs | 261 ++++++ .../video_transformation_error_event.rbs | 300 +++++++ .../video_transformation_ready_event.rbs | 359 ++++++++ .../models/webhook_unsafe_unwrap_params.rbs | 15 + .../models/webhook_unwrap_params.rbs | 15 + .../request_options.rbs | 12 +- sig/imagekitio/resources/accounts.rbs | 13 + sig/imagekitio/resources/accounts/origins.rbs | 34 + .../resources/accounts/url_endpoints.rbs | 40 + sig/imagekitio/resources/accounts/usage.rbs | 15 + sig/imagekitio/resources/assets.rbs | 18 + sig/imagekitio/resources/beta.rbs | 9 + sig/imagekitio/resources/beta/v2.rbs | 11 + .../resources/beta/v2/files.rbs | 16 +- sig/imagekitio/resources/cache.rbs | 9 + .../resources/cache/invalidation.rbs | 19 + .../resources/custom_metadata_fields.rbs | 32 + sig/imagekitio/resources/files.rbs | 76 ++ sig/imagekitio/resources/files/bulk.rbs | 32 + sig/imagekitio/resources/files/metadata.rbs | 19 + sig/imagekitio/resources/files/versions.rbs | 32 + sig/imagekitio/resources/folders.rbs | 40 + sig/imagekitio/resources/folders/job.rbs | 14 + sig/imagekitio/resources/webhooks.rbs | 27 + sig/{imagekit => imagekitio}/version.rbs | 2 +- .../internal/sorbet_runtime_support_test.rb | 52 -- test/imagekit/resources/accounts_test.rb | 6 - test/imagekit/resources/beta/v2/files_test.rb | 45 -- test/imagekit/resources/beta/v2_test.rb | 6 - test/imagekit/resources/beta_test.rb | 6 - test/imagekit/resources/cache_test.rb | 6 - test/imagekit/resources/shared_test.rb | 6 - test/{imagekit => imagekitio}/client_test.rb | 70 +- .../file_part_test.rb | 4 +- .../internal/sorbet_runtime_support_test.rb | 52 ++ .../internal/type/base_model_test.rb | 178 ++-- .../internal/util_test.rb | 154 ++-- .../resource_namespaces.rb | 2 +- .../resources/accounts/origins_test.rb | 118 +-- .../resources/accounts/url_endpoints_test.rb | 22 +- .../resources/accounts/usage_test.rb | 4 +- test/imagekitio/resources/accounts_test.rb | 6 + .../resources/assets_test.rb | 4 +- .../resources/beta/v2/files_test.rb | 45 ++ test/imagekitio/resources/beta/v2_test.rb | 6 + .../resources/beta_test.rb} | 2 +- .../resources/cache/invalidation_test.rb | 8 +- test/imagekitio/resources/cache_test.rb | 6 + .../resources/custom_metadata_fields_test.rb | 14 +- .../resources/files/bulk_test.rb | 18 +- .../resources/files/metadata_test.rb | 18 +- .../resources/files/versions_test.rb | 46 +- .../resources/files_test.rb | 52 +- .../resources/folders/job_test.rb | 8 +- .../resources/folders_test.rb | 12 +- test/imagekitio/resources/shared_test.rb | 6 + test/imagekitio/resources/webhooks_test.rb | 6 + test/{imagekit => imagekitio}/test_helper.rb | 10 +- 644 files changed, 15087 insertions(+), 14829 deletions(-) rename imagekit.gemspec => imagekitio.gemspec (80%) delete mode 100644 lib/imagekit.rb delete mode 100644 lib/imagekit/models.rb delete mode 100644 lib/imagekit/models/accounts/origin_create_params.rb delete mode 100644 lib/imagekit/models/accounts/origin_delete_params.rb delete mode 100644 lib/imagekit/models/accounts/origin_get_params.rb delete mode 100644 lib/imagekit/models/accounts/origin_list_params.rb delete mode 100644 lib/imagekit/models/accounts/origin_list_response.rb delete mode 100644 lib/imagekit/models/accounts/origin_update_params.rb delete mode 100644 lib/imagekit/models/accounts/url_endpoint_create_params.rb delete mode 100644 lib/imagekit/models/accounts/url_endpoint_delete_params.rb delete mode 100644 lib/imagekit/models/accounts/url_endpoint_get_params.rb delete mode 100644 lib/imagekit/models/accounts/url_endpoint_list_params.rb delete mode 100644 lib/imagekit/models/accounts/url_endpoint_list_response.rb delete mode 100644 lib/imagekit/models/accounts/url_endpoint_update_params.rb delete mode 100644 lib/imagekit/models/asset_list_response.rb delete mode 100644 lib/imagekit/models/base_overlay.rb delete mode 100644 lib/imagekit/models/cache/invalidation_create_params.rb delete mode 100644 lib/imagekit/models/cache/invalidation_get_params.rb delete mode 100644 lib/imagekit/models/cache/invalidation_get_response.rb delete mode 100644 lib/imagekit/models/custom_metadata_field_delete_params.rb delete mode 100644 lib/imagekit/models/custom_metadata_field_delete_response.rb delete mode 100644 lib/imagekit/models/custom_metadata_field_list_response.rb delete mode 100644 lib/imagekit/models/file_copy_response.rb delete mode 100644 lib/imagekit/models/file_delete_params.rb delete mode 100644 lib/imagekit/models/file_get_params.rb delete mode 100644 lib/imagekit/models/file_move_response.rb delete mode 100644 lib/imagekit/models/file_update_params.rb delete mode 100644 lib/imagekit/models/file_update_response.rb delete mode 100644 lib/imagekit/models/files/bulk_delete_params.rb delete mode 100644 lib/imagekit/models/files/metadata_get_params.rb delete mode 100644 lib/imagekit/models/files/version_delete_params.rb delete mode 100644 lib/imagekit/models/files/version_delete_response.rb delete mode 100644 lib/imagekit/models/files/version_get_params.rb delete mode 100644 lib/imagekit/models/files/version_list_params.rb delete mode 100644 lib/imagekit/models/files/version_list_response.rb delete mode 100644 lib/imagekit/models/files/version_restore_params.rb delete mode 100644 lib/imagekit/models/folder_create_response.rb delete mode 100644 lib/imagekit/models/folder_delete_response.rb delete mode 100644 lib/imagekit/models/folders/job_get_params.rb delete mode 100644 lib/imagekit/models/overlay.rb delete mode 100644 lib/imagekit/models/webhook_unsafe_unwrap_params.rb delete mode 100644 lib/imagekit/models/webhook_unwrap_params.rb delete mode 100644 lib/imagekit/resources/accounts.rb delete mode 100644 lib/imagekit/resources/accounts/origins.rb delete mode 100644 lib/imagekit/resources/webhooks.rb create mode 100644 lib/imagekitio.rb rename lib/{imagekit => imagekitio}/client.rb (77%) rename lib/{imagekit => imagekitio}/errors.rb (77%) rename lib/{imagekit => imagekitio}/file_part.rb (98%) rename lib/{imagekit => imagekitio}/internal.rb (65%) rename lib/{imagekit => imagekitio}/internal/transport/base_client.rb (81%) rename lib/{imagekit => imagekitio}/internal/transport/pooled_net_requester.rb (88%) rename lib/{imagekit => imagekitio}/internal/type/array_of.rb (81%) rename lib/{imagekit => imagekitio}/internal/type/base_model.rb (84%) rename lib/{imagekit => imagekitio}/internal/type/base_page.rb (90%) rename lib/{imagekit => imagekitio}/internal/type/boolean.rb (91%) rename lib/{imagekit => imagekitio}/internal/type/converter.rb (87%) rename lib/{imagekit => imagekitio}/internal/type/enum.rb (83%) rename lib/{imagekit => imagekitio}/internal/type/file_input.rb (83%) rename lib/{imagekit => imagekitio}/internal/type/hash_of.rb (83%) rename lib/{imagekit => imagekitio}/internal/type/request_parameters.rb (72%) rename lib/{imagekit => imagekitio}/internal/type/union.rb (77%) rename lib/{imagekit => imagekitio}/internal/type/unknown.rb (91%) rename lib/{imagekit => imagekitio}/internal/util.rb (96%) create mode 100644 lib/imagekitio/models.rb create mode 100644 lib/imagekitio/models/accounts/origin_create_params.rb create mode 100644 lib/imagekitio/models/accounts/origin_delete_params.rb create mode 100644 lib/imagekitio/models/accounts/origin_get_params.rb create mode 100644 lib/imagekitio/models/accounts/origin_list_params.rb create mode 100644 lib/imagekitio/models/accounts/origin_list_response.rb rename lib/{imagekit => imagekitio}/models/accounts/origin_request.rb (88%) rename lib/{imagekit => imagekitio}/models/accounts/origin_response.rb (85%) create mode 100644 lib/imagekitio/models/accounts/origin_update_params.rb create mode 100644 lib/imagekitio/models/accounts/url_endpoint_create_params.rb create mode 100644 lib/imagekitio/models/accounts/url_endpoint_delete_params.rb create mode 100644 lib/imagekitio/models/accounts/url_endpoint_get_params.rb create mode 100644 lib/imagekitio/models/accounts/url_endpoint_list_params.rb create mode 100644 lib/imagekitio/models/accounts/url_endpoint_list_response.rb rename lib/{imagekit => imagekitio}/models/accounts/url_endpoint_request.rb (62%) rename lib/{imagekit => imagekitio}/models/accounts/url_endpoint_response.rb (65%) create mode 100644 lib/imagekitio/models/accounts/url_endpoint_update_params.rb rename lib/{imagekit => imagekitio}/models/accounts/usage_get_params.rb (71%) rename lib/{imagekit => imagekitio}/models/accounts/usage_get_response.rb (93%) rename lib/{imagekit => imagekitio}/models/asset_list_params.rb (76%) create mode 100644 lib/imagekitio/models/asset_list_response.rb create mode 100644 lib/imagekitio/models/base_overlay.rb rename lib/{imagekit => imagekitio}/models/base_webhook_event.rb (85%) rename lib/{imagekit => imagekitio}/models/beta/v2/file_upload_params.rb (73%) rename lib/{imagekit => imagekitio}/models/beta/v2/file_upload_response.rb (73%) create mode 100644 lib/imagekitio/models/cache/invalidation_create_params.rb rename lib/{imagekit => imagekitio}/models/cache/invalidation_create_response.rb (70%) create mode 100644 lib/imagekitio/models/cache/invalidation_get_params.rb create mode 100644 lib/imagekitio/models/cache/invalidation_get_response.rb rename lib/{imagekit => imagekitio}/models/custom_metadata_field.rb (73%) rename lib/{imagekit => imagekitio}/models/custom_metadata_field_create_params.rb (71%) create mode 100644 lib/imagekitio/models/custom_metadata_field_delete_params.rb create mode 100644 lib/imagekitio/models/custom_metadata_field_delete_response.rb rename lib/{imagekit => imagekitio}/models/custom_metadata_field_list_params.rb (66%) create mode 100644 lib/imagekitio/models/custom_metadata_field_list_response.rb rename lib/{imagekit => imagekitio}/models/custom_metadata_field_update_params.rb (73%) rename lib/{imagekit => imagekitio}/models/extensions.rb (66%) rename lib/{imagekit => imagekitio}/models/file.rb (77%) rename lib/{imagekit => imagekitio}/models/file_copy_params.rb (71%) create mode 100644 lib/imagekitio/models/file_copy_response.rb create mode 100644 lib/imagekitio/models/file_delete_params.rb create mode 100644 lib/imagekitio/models/file_get_params.rb rename lib/{imagekit => imagekitio}/models/file_move_params.rb (67%) create mode 100644 lib/imagekitio/models/file_move_response.rb rename lib/{imagekit => imagekitio}/models/file_rename_params.rb (81%) rename lib/{imagekit => imagekitio}/models/file_rename_response.rb (73%) create mode 100644 lib/imagekitio/models/file_update_params.rb create mode 100644 lib/imagekitio/models/file_update_response.rb rename lib/{imagekit => imagekitio}/models/file_upload_params.rb (74%) rename lib/{imagekit => imagekitio}/models/file_upload_response.rb (73%) rename lib/{imagekit => imagekitio}/models/files/bulk_add_tags_params.rb (54%) rename lib/{imagekit => imagekitio}/models/files/bulk_add_tags_response.rb (69%) create mode 100644 lib/imagekitio/models/files/bulk_delete_params.rb rename lib/{imagekit => imagekitio}/models/files/bulk_delete_response.rb (68%) rename lib/{imagekit => imagekitio}/models/files/bulk_remove_ai_tags_params.rb (54%) rename lib/{imagekit => imagekitio}/models/files/bulk_remove_ai_tags_response.rb (68%) rename lib/{imagekit => imagekitio}/models/files/bulk_remove_tags_params.rb (54%) rename lib/{imagekit => imagekitio}/models/files/bulk_remove_tags_response.rb (68%) rename lib/{imagekit => imagekitio}/models/files/metadata_get_from_url_params.rb (54%) create mode 100644 lib/imagekitio/models/files/metadata_get_params.rb create mode 100644 lib/imagekitio/models/files/version_delete_params.rb create mode 100644 lib/imagekitio/models/files/version_delete_response.rb create mode 100644 lib/imagekitio/models/files/version_get_params.rb create mode 100644 lib/imagekitio/models/files/version_list_params.rb create mode 100644 lib/imagekitio/models/files/version_list_response.rb create mode 100644 lib/imagekitio/models/files/version_restore_params.rb rename lib/{imagekit => imagekitio}/models/folder.rb (80%) rename lib/{imagekit => imagekitio}/models/folder_copy_params.rb (73%) rename lib/{imagekit/models/folder_rename_response.rb => imagekitio/models/folder_copy_response.rb} (75%) rename lib/{imagekit => imagekitio}/models/folder_create_params.rb (76%) create mode 100644 lib/imagekitio/models/folder_create_response.rb rename lib/{imagekit => imagekitio}/models/folder_delete_params.rb (56%) create mode 100644 lib/imagekitio/models/folder_delete_response.rb rename lib/{imagekit => imagekitio}/models/folder_move_params.rb (69%) rename lib/{imagekit => imagekitio}/models/folder_move_response.rb (74%) rename lib/{imagekit => imagekitio}/models/folder_rename_params.rb (80%) rename lib/{imagekit/models/folder_copy_response.rb => imagekitio/models/folder_rename_response.rb} (73%) create mode 100644 lib/imagekitio/models/folders/job_get_params.rb rename lib/{imagekit => imagekitio}/models/folders/job_get_response.rb (61%) rename lib/{imagekit => imagekitio}/models/get_image_attributes_options.rb (87%) rename lib/{imagekit => imagekitio}/models/image_overlay.rb (71%) rename lib/{imagekit => imagekitio}/models/metadata.rb (85%) create mode 100644 lib/imagekitio/models/overlay.rb rename lib/{imagekit => imagekitio}/models/overlay_position.rb (77%) rename lib/{imagekit => imagekitio}/models/overlay_timing.rb (83%) rename lib/{imagekit => imagekitio}/models/responsive_image_attributes.rb (89%) rename lib/{imagekit => imagekitio}/models/solid_color_overlay.rb (72%) rename lib/{imagekit => imagekitio}/models/solid_color_overlay_transformation.rb (81%) rename lib/{imagekit => imagekitio}/models/src_options.rb (81%) rename lib/{imagekit => imagekitio}/models/streaming_resolution.rb (90%) rename lib/{imagekit => imagekitio}/models/subtitle_overlay.rb (67%) rename lib/{imagekit => imagekitio}/models/subtitle_overlay_transformation.rb (87%) rename lib/{imagekit => imagekitio}/models/text_overlay.rb (67%) rename lib/{imagekit => imagekitio}/models/text_overlay_transformation.rb (78%) rename lib/{imagekit => imagekitio}/models/transformation.rb (79%) rename lib/{imagekit => imagekitio}/models/transformation_position.rb (88%) rename lib/{imagekit => imagekitio}/models/unsafe_unwrap_webhook_event.rb (67%) rename lib/{imagekit => imagekitio}/models/unwrap_webhook_event.rb (67%) rename lib/{imagekit => imagekitio}/models/update_file_request.rb (66%) rename lib/{imagekit => imagekitio}/models/upload_post_transform_error_event.rb (55%) rename lib/{imagekit => imagekitio}/models/upload_post_transform_success_event.rb (59%) rename lib/{imagekit => imagekitio}/models/upload_pre_transform_error_event.rb (59%) rename lib/{imagekit => imagekitio}/models/upload_pre_transform_success_event.rb (73%) rename lib/{imagekit => imagekitio}/models/video_overlay.rb (69%) rename lib/{imagekit => imagekitio}/models/video_transformation_accepted_event.rb (56%) rename lib/{imagekit => imagekitio}/models/video_transformation_error_event.rb (55%) rename lib/{imagekit => imagekitio}/models/video_transformation_ready_event.rb (58%) create mode 100644 lib/imagekitio/models/webhook_unsafe_unwrap_params.rb create mode 100644 lib/imagekitio/models/webhook_unwrap_params.rb rename lib/{imagekit => imagekitio}/request_options.rb (79%) create mode 100644 lib/imagekitio/resources/accounts.rb create mode 100644 lib/imagekitio/resources/accounts/origins.rb rename lib/{imagekit => imagekitio}/resources/accounts/url_endpoints.rb (61%) rename lib/{imagekit => imagekitio}/resources/accounts/usage.rb (70%) rename lib/{imagekit => imagekitio}/resources/assets.rb (61%) rename lib/{imagekit => imagekitio}/resources/beta.rb (53%) rename lib/{imagekit => imagekitio}/resources/beta/v2.rb (54%) rename lib/{imagekit => imagekitio}/resources/beta/v2/files.rb (79%) rename lib/{imagekit => imagekitio}/resources/cache.rb (50%) rename lib/{imagekit => imagekitio}/resources/cache/invalidation.rb (60%) rename lib/{imagekit => imagekitio}/resources/custom_metadata_fields.rb (65%) rename lib/{imagekit => imagekitio}/resources/files.rb (73%) rename lib/{imagekit => imagekitio}/resources/files/bulk.rb (64%) rename lib/{imagekit => imagekitio}/resources/files/metadata.rb (67%) rename lib/{imagekit => imagekitio}/resources/files/versions.rb (68%) rename lib/{imagekit => imagekitio}/resources/folders.rb (67%) rename lib/{imagekit => imagekitio}/resources/folders/job.rb (66%) create mode 100644 lib/imagekitio/resources/webhooks.rb rename lib/{imagekit => imagekitio}/version.rb (75%) delete mode 100644 rbi/imagekit/models.rbi delete mode 100644 rbi/imagekit/models/accounts/origin_create_params.rbi delete mode 100644 rbi/imagekit/models/accounts/origin_delete_params.rbi delete mode 100644 rbi/imagekit/models/accounts/origin_get_params.rbi delete mode 100644 rbi/imagekit/models/accounts/origin_list_params.rbi delete mode 100644 rbi/imagekit/models/accounts/origin_list_response.rbi delete mode 100644 rbi/imagekit/models/accounts/origin_update_params.rbi delete mode 100644 rbi/imagekit/models/accounts/url_endpoint_create_params.rbi delete mode 100644 rbi/imagekit/models/accounts/url_endpoint_delete_params.rbi delete mode 100644 rbi/imagekit/models/accounts/url_endpoint_get_params.rbi delete mode 100644 rbi/imagekit/models/accounts/url_endpoint_list_params.rbi delete mode 100644 rbi/imagekit/models/accounts/url_endpoint_list_response.rbi delete mode 100644 rbi/imagekit/models/accounts/url_endpoint_update_params.rbi delete mode 100644 rbi/imagekit/models/asset_list_response.rbi delete mode 100644 rbi/imagekit/models/base_overlay.rbi delete mode 100644 rbi/imagekit/models/cache/invalidation_get_params.rbi delete mode 100644 rbi/imagekit/models/custom_metadata_field_delete_params.rbi delete mode 100644 rbi/imagekit/models/custom_metadata_field_list_response.rbi delete mode 100644 rbi/imagekit/models/file_delete_params.rbi delete mode 100644 rbi/imagekit/models/file_get_params.rbi delete mode 100644 rbi/imagekit/models/file_move_response.rbi delete mode 100644 rbi/imagekit/models/file_update_params.rbi delete mode 100644 rbi/imagekit/models/files/metadata_get_params.rbi delete mode 100644 rbi/imagekit/models/files/version_list_params.rbi delete mode 100644 rbi/imagekit/models/files/version_list_response.rbi delete mode 100644 rbi/imagekit/models/folders/job_get_params.rbi delete mode 100644 rbi/imagekit/models/streaming_resolution.rbi delete mode 100644 rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi delete mode 100644 rbi/imagekit/models/unwrap_webhook_event.rbi delete mode 100644 rbi/imagekit/models/webhook_unsafe_unwrap_params.rbi delete mode 100644 rbi/imagekit/models/webhook_unwrap_params.rbi delete mode 100644 rbi/imagekit/resources/accounts.rbi delete mode 100644 rbi/imagekit/resources/webhooks.rbi rename rbi/{imagekit => imagekitio}/client.rbi (74%) rename rbi/{imagekit => imagekitio}/errors.rbi (82%) rename rbi/{imagekit => imagekitio}/file_part.rbi (97%) rename rbi/{imagekit => imagekitio}/internal.rbi (62%) rename rbi/{imagekit => imagekitio}/internal/transport/base_client.rbi (82%) rename rbi/{imagekit => imagekitio}/internal/transport/pooled_net_requester.rbi (83%) rename rbi/{imagekit => imagekitio}/internal/type/array_of.rbi (71%) rename rbi/{imagekit => imagekitio}/internal/type/base_model.rbi (78%) rename rbi/{imagekit => imagekitio}/internal/type/base_page.rbi (83%) rename rbi/{imagekit => imagekitio}/internal/type/boolean.rbi (81%) rename rbi/{imagekit => imagekitio}/internal/type/converter.rbi (77%) rename rbi/{imagekit => imagekitio}/internal/type/enum.rbi (87%) rename rbi/{imagekit => imagekitio}/internal/type/file_input.rbi (82%) rename rbi/{imagekit => imagekitio}/internal/type/hash_of.rbi (66%) rename rbi/{imagekit => imagekitio}/internal/type/request_parameters.rbi (70%) rename rbi/{imagekit => imagekitio}/internal/type/union.rbi (82%) rename rbi/{imagekit => imagekitio}/internal/type/unknown.rbi (79%) rename rbi/{imagekit => imagekitio}/internal/util.rbi (95%) create mode 100644 rbi/imagekitio/models.rbi create mode 100644 rbi/imagekitio/models/accounts/origin_create_params.rbi create mode 100644 rbi/imagekitio/models/accounts/origin_delete_params.rbi create mode 100644 rbi/imagekitio/models/accounts/origin_get_params.rbi create mode 100644 rbi/imagekitio/models/accounts/origin_list_params.rbi create mode 100644 rbi/imagekitio/models/accounts/origin_list_response.rbi rename rbi/{imagekit => imagekitio}/models/accounts/origin_request.rbi (91%) rename rbi/{imagekit => imagekitio}/models/accounts/origin_response.rbi (90%) create mode 100644 rbi/imagekitio/models/accounts/origin_update_params.rbi create mode 100644 rbi/imagekitio/models/accounts/url_endpoint_create_params.rbi create mode 100644 rbi/imagekitio/models/accounts/url_endpoint_delete_params.rbi create mode 100644 rbi/imagekitio/models/accounts/url_endpoint_get_params.rbi create mode 100644 rbi/imagekitio/models/accounts/url_endpoint_list_params.rbi create mode 100644 rbi/imagekitio/models/accounts/url_endpoint_list_response.rbi rename rbi/{imagekit => imagekitio}/models/accounts/url_endpoint_request.rbi (70%) rename rbi/{imagekit => imagekitio}/models/accounts/url_endpoint_response.rbi (73%) create mode 100644 rbi/imagekitio/models/accounts/url_endpoint_update_params.rbi rename rbi/{imagekit => imagekitio}/models/accounts/usage_get_params.rbi (77%) rename rbi/{imagekit => imagekitio}/models/accounts/usage_get_response.rbi (93%) rename rbi/{imagekit => imagekitio}/models/asset_list_params.rbi (65%) create mode 100644 rbi/imagekitio/models/asset_list_response.rbi create mode 100644 rbi/imagekitio/models/base_overlay.rbi rename rbi/{imagekit => imagekitio}/models/base_webhook_event.rbi (78%) rename rbi/{imagekit => imagekitio}/models/beta/v2/file_upload_params.rbi (81%) rename rbi/{imagekit => imagekitio}/models/beta/v2/file_upload_response.rbi (77%) rename rbi/{imagekit => imagekitio}/models/cache/invalidation_create_params.rbi (57%) rename rbi/{imagekit => imagekitio}/models/cache/invalidation_create_response.rbi (79%) create mode 100644 rbi/imagekitio/models/cache/invalidation_get_params.rbi rename rbi/{imagekit => imagekitio}/models/cache/invalidation_get_response.rbi (61%) rename rbi/{imagekit => imagekitio}/models/custom_metadata_field.rbi (72%) rename rbi/{imagekit => imagekitio}/models/custom_metadata_field_create_params.rbi (71%) create mode 100644 rbi/imagekitio/models/custom_metadata_field_delete_params.rbi create mode 100644 rbi/imagekitio/models/custom_metadata_field_delete_response.rbi rename rbi/{imagekit => imagekitio}/models/custom_metadata_field_list_params.rbi (78%) create mode 100644 rbi/imagekitio/models/custom_metadata_field_list_response.rbi rename rbi/{imagekit => imagekitio}/models/custom_metadata_field_update_params.rbi (75%) rename rbi/{imagekit => imagekitio}/models/extensions.rbi (74%) rename rbi/{imagekit => imagekitio}/models/file.rbi (79%) rename rbi/{imagekit => imagekitio}/models/file_copy_params.rbi (80%) rename rbi/{imagekit/models/folder_create_response.rbi => imagekitio/models/file_copy_response.rbi} (59%) create mode 100644 rbi/imagekitio/models/file_delete_params.rbi create mode 100644 rbi/imagekitio/models/file_get_params.rbi rename rbi/{imagekit => imagekitio}/models/file_move_params.rbi (69%) rename rbi/{imagekit/models/folder_delete_response.rbi => imagekitio/models/file_move_response.rbi} (59%) rename rbi/{imagekit => imagekitio}/models/file_rename_params.rbi (89%) rename rbi/{imagekit => imagekitio}/models/file_rename_response.rbi (80%) create mode 100644 rbi/imagekitio/models/file_update_params.rbi rename rbi/{imagekit => imagekitio}/models/file_update_response.rbi (54%) rename rbi/{imagekit => imagekitio}/models/file_upload_params.rbi (82%) rename rbi/{imagekit => imagekitio}/models/file_upload_response.rbi (76%) rename rbi/{imagekit => imagekitio}/models/files/bulk_add_tags_params.rbi (70%) rename rbi/{imagekit => imagekitio}/models/files/bulk_add_tags_response.rbi (82%) rename rbi/{imagekit => imagekitio}/models/files/bulk_delete_params.rbi (63%) rename rbi/{imagekit => imagekitio}/models/files/bulk_delete_response.rbi (82%) rename rbi/{imagekit => imagekitio}/models/files/bulk_remove_ai_tags_params.rbi (70%) rename rbi/{imagekit => imagekitio}/models/files/bulk_remove_ai_tags_response.rbi (81%) rename rbi/{imagekit => imagekitio}/models/files/bulk_remove_tags_params.rbi (70%) rename rbi/{imagekit => imagekitio}/models/files/bulk_remove_tags_response.rbi (82%) rename rbi/{imagekit => imagekitio}/models/files/metadata_get_from_url_params.rbi (61%) create mode 100644 rbi/imagekitio/models/files/metadata_get_params.rbi rename rbi/{imagekit => imagekitio}/models/files/version_delete_params.rbi (52%) rename rbi/{imagekit => imagekitio}/models/files/version_delete_response.rbi (61%) rename rbi/{imagekit => imagekitio}/models/files/version_get_params.rbi (52%) create mode 100644 rbi/imagekitio/models/files/version_list_params.rbi create mode 100644 rbi/imagekitio/models/files/version_list_response.rbi rename rbi/{imagekit => imagekitio}/models/files/version_restore_params.rbi (52%) rename rbi/{imagekit => imagekitio}/models/folder.rbi (79%) rename rbi/{imagekit => imagekitio}/models/folder_copy_params.rbi (81%) rename rbi/{imagekit => imagekitio}/models/folder_copy_response.rbi (78%) rename rbi/{imagekit => imagekitio}/models/folder_create_params.rbi (83%) rename rbi/{imagekit/models/custom_metadata_field_delete_response.rbi => imagekitio/models/folder_create_response.rbi} (56%) rename rbi/{imagekit => imagekitio}/models/folder_delete_params.rbi (58%) rename rbi/{imagekit/models/file_copy_response.rbi => imagekitio/models/folder_delete_response.rbi} (52%) rename rbi/{imagekit => imagekitio}/models/folder_move_params.rbi (71%) rename rbi/{imagekit => imagekitio}/models/folder_move_response.rbi (78%) rename rbi/{imagekit => imagekitio}/models/folder_rename_params.rbi (89%) rename rbi/{imagekit => imagekitio}/models/folder_rename_response.rbi (78%) create mode 100644 rbi/imagekitio/models/folders/job_get_params.rbi rename rbi/{imagekit => imagekitio}/models/folders/job_get_response.rbi (66%) rename rbi/{imagekit => imagekitio}/models/get_image_attributes_options.rbi (95%) rename rbi/{imagekit => imagekitio}/models/image_overlay.rbi (72%) rename rbi/{imagekit => imagekitio}/models/metadata.rbi (88%) rename rbi/{imagekit => imagekitio}/models/overlay.rbi (57%) rename rbi/{imagekit => imagekitio}/models/overlay_position.rbi (64%) rename rbi/{imagekit => imagekitio}/models/overlay_timing.rbi (75%) rename rbi/{imagekit => imagekitio}/models/responsive_image_attributes.rbi (91%) rename rbi/{imagekit => imagekitio}/models/solid_color_overlay.rbi (81%) rename rbi/{imagekit => imagekitio}/models/solid_color_overlay_transformation.rbi (81%) rename rbi/{imagekit => imagekitio}/models/src_options.rbi (89%) create mode 100644 rbi/imagekitio/models/streaming_resolution.rbi rename rbi/{imagekit => imagekitio}/models/subtitle_overlay.rbi (69%) rename rbi/{imagekit => imagekitio}/models/subtitle_overlay_transformation.rbi (89%) rename rbi/{imagekit => imagekitio}/models/text_overlay.rbi (68%) rename rbi/{imagekit => imagekitio}/models/text_overlay_transformation.rbi (73%) rename rbi/{imagekit => imagekitio}/models/transformation.rbi (78%) rename rbi/{imagekit => imagekitio}/models/transformation_position.rbi (61%) create mode 100644 rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi create mode 100644 rbi/imagekitio/models/unwrap_webhook_event.rbi rename rbi/{imagekit => imagekitio}/models/update_file_request.rbi (79%) rename rbi/{imagekit => imagekitio}/models/upload_post_transform_error_event.rbi (63%) rename rbi/{imagekit => imagekitio}/models/upload_post_transform_success_event.rbi (64%) rename rbi/{imagekit => imagekitio}/models/upload_pre_transform_error_event.rbi (65%) rename rbi/{imagekit => imagekitio}/models/upload_pre_transform_success_event.rbi (75%) rename rbi/{imagekit => imagekitio}/models/video_overlay.rbi (69%) rename rbi/{imagekit => imagekitio}/models/video_transformation_accepted_event.rbi (65%) rename rbi/{imagekit => imagekitio}/models/video_transformation_error_event.rbi (65%) rename rbi/{imagekit => imagekitio}/models/video_transformation_ready_event.rbi (67%) create mode 100644 rbi/imagekitio/models/webhook_unsafe_unwrap_params.rbi create mode 100644 rbi/imagekitio/models/webhook_unwrap_params.rbi rename rbi/{imagekit => imagekitio}/request_options.rbi (84%) create mode 100644 rbi/imagekitio/resources/accounts.rbi rename rbi/{imagekit => imagekitio}/resources/accounts/origins.rbi (71%) rename rbi/{imagekit => imagekitio}/resources/accounts/url_endpoints.rbi (75%) rename rbi/{imagekit => imagekitio}/resources/accounts/usage.rbi (82%) rename rbi/{imagekit => imagekitio}/resources/assets.rbi (85%) rename rbi/{imagekit => imagekitio}/resources/beta.rbi (50%) rename rbi/{imagekit => imagekitio}/resources/beta/v2.rbi (54%) rename rbi/{imagekit => imagekitio}/resources/beta/v2/files.rbi (93%) rename rbi/{imagekit => imagekitio}/resources/cache.rbi (50%) rename rbi/{imagekit => imagekitio}/resources/cache/invalidation.rbi (69%) rename rbi/{imagekit => imagekitio}/resources/custom_metadata_fields.rbi (82%) rename rbi/{imagekit => imagekitio}/resources/files.rbi (90%) rename rbi/{imagekit => imagekitio}/resources/files/bulk.rbi (78%) rename rbi/{imagekit => imagekitio}/resources/files/metadata.rbi (78%) rename rbi/{imagekit => imagekitio}/resources/files/versions.rbi (81%) rename rbi/{imagekit => imagekitio}/resources/folders.rbi (87%) rename rbi/{imagekit => imagekitio}/resources/folders/job.rbi (70%) create mode 100644 rbi/imagekitio/resources/webhooks.rbi rename rbi/{imagekit => imagekitio}/version.rbi (77%) delete mode 100644 sig/imagekit/internal/type/converter.rbs delete mode 100644 sig/imagekit/internal/type/request_parameters.rbs delete mode 100644 sig/imagekit/models.rbs delete mode 100644 sig/imagekit/models/accounts/origin_create_params.rbs delete mode 100644 sig/imagekit/models/accounts/origin_delete_params.rbs delete mode 100644 sig/imagekit/models/accounts/origin_get_params.rbs delete mode 100644 sig/imagekit/models/accounts/origin_list_params.rbs delete mode 100644 sig/imagekit/models/accounts/origin_list_response.rbs delete mode 100644 sig/imagekit/models/accounts/origin_update_params.rbs delete mode 100644 sig/imagekit/models/accounts/url_endpoint_create_params.rbs delete mode 100644 sig/imagekit/models/accounts/url_endpoint_delete_params.rbs delete mode 100644 sig/imagekit/models/accounts/url_endpoint_get_params.rbs delete mode 100644 sig/imagekit/models/accounts/url_endpoint_list_params.rbs delete mode 100644 sig/imagekit/models/accounts/url_endpoint_list_response.rbs delete mode 100644 sig/imagekit/models/accounts/url_endpoint_update_params.rbs delete mode 100644 sig/imagekit/models/asset_list_response.rbs delete mode 100644 sig/imagekit/models/base_overlay.rbs delete mode 100644 sig/imagekit/models/beta/v2/file_upload_response.rbs delete mode 100644 sig/imagekit/models/cache/invalidation_create_params.rbs delete mode 100644 sig/imagekit/models/cache/invalidation_get_params.rbs delete mode 100644 sig/imagekit/models/cache/invalidation_get_response.rbs delete mode 100644 sig/imagekit/models/custom_metadata_field.rbs delete mode 100644 sig/imagekit/models/custom_metadata_field_create_params.rbs delete mode 100644 sig/imagekit/models/custom_metadata_field_delete_params.rbs delete mode 100644 sig/imagekit/models/custom_metadata_field_list_response.rbs delete mode 100644 sig/imagekit/models/custom_metadata_field_update_params.rbs delete mode 100644 sig/imagekit/models/file_delete_params.rbs delete mode 100644 sig/imagekit/models/file_get_params.rbs delete mode 100644 sig/imagekit/models/file_update_params.rbs delete mode 100644 sig/imagekit/models/file_update_response.rbs delete mode 100644 sig/imagekit/models/file_upload_response.rbs delete mode 100644 sig/imagekit/models/files/bulk_delete_params.rbs delete mode 100644 sig/imagekit/models/files/metadata_get_from_url_params.rbs delete mode 100644 sig/imagekit/models/files/metadata_get_params.rbs delete mode 100644 sig/imagekit/models/files/version_delete_params.rbs delete mode 100644 sig/imagekit/models/files/version_get_params.rbs delete mode 100644 sig/imagekit/models/files/version_list_params.rbs delete mode 100644 sig/imagekit/models/files/version_list_response.rbs delete mode 100644 sig/imagekit/models/files/version_restore_params.rbs delete mode 100644 sig/imagekit/models/folder_delete_params.rbs delete mode 100644 sig/imagekit/models/folders/job_get_params.rbs delete mode 100644 sig/imagekit/models/folders/job_get_response.rbs delete mode 100644 sig/imagekit/models/image_overlay.rbs delete mode 100644 sig/imagekit/models/overlay.rbs delete mode 100644 sig/imagekit/models/overlay_position.rbs delete mode 100644 sig/imagekit/models/overlay_timing.rbs delete mode 100644 sig/imagekit/models/solid_color_overlay.rbs delete mode 100644 sig/imagekit/models/solid_color_overlay_transformation.rbs delete mode 100644 sig/imagekit/models/subtitle_overlay.rbs delete mode 100644 sig/imagekit/models/text_overlay.rbs delete mode 100644 sig/imagekit/models/text_overlay_transformation.rbs delete mode 100644 sig/imagekit/models/transformation.rbs delete mode 100644 sig/imagekit/models/unsafe_unwrap_webhook_event.rbs delete mode 100644 sig/imagekit/models/unwrap_webhook_event.rbs delete mode 100644 sig/imagekit/models/update_file_request.rbs delete mode 100644 sig/imagekit/models/upload_post_transform_error_event.rbs delete mode 100644 sig/imagekit/models/upload_post_transform_success_event.rbs delete mode 100644 sig/imagekit/models/upload_pre_transform_error_event.rbs delete mode 100644 sig/imagekit/models/upload_pre_transform_success_event.rbs delete mode 100644 sig/imagekit/models/video_overlay.rbs delete mode 100644 sig/imagekit/models/video_transformation_accepted_event.rbs delete mode 100644 sig/imagekit/models/video_transformation_error_event.rbs delete mode 100644 sig/imagekit/models/video_transformation_ready_event.rbs delete mode 100644 sig/imagekit/models/webhook_unsafe_unwrap_params.rbs delete mode 100644 sig/imagekit/models/webhook_unwrap_params.rbs delete mode 100644 sig/imagekit/resources/accounts.rbs delete mode 100644 sig/imagekit/resources/accounts/origins.rbs delete mode 100644 sig/imagekit/resources/accounts/url_endpoints.rbs delete mode 100644 sig/imagekit/resources/accounts/usage.rbs delete mode 100644 sig/imagekit/resources/assets.rbs delete mode 100644 sig/imagekit/resources/beta.rbs delete mode 100644 sig/imagekit/resources/beta/v2.rbs delete mode 100644 sig/imagekit/resources/cache.rbs delete mode 100644 sig/imagekit/resources/cache/invalidation.rbs delete mode 100644 sig/imagekit/resources/custom_metadata_fields.rbs delete mode 100644 sig/imagekit/resources/files.rbs delete mode 100644 sig/imagekit/resources/files/bulk.rbs delete mode 100644 sig/imagekit/resources/files/metadata.rbs delete mode 100644 sig/imagekit/resources/files/versions.rbs delete mode 100644 sig/imagekit/resources/folders.rbs delete mode 100644 sig/imagekit/resources/folders/job.rbs delete mode 100644 sig/imagekit/resources/webhooks.rbs rename sig/{imagekit => imagekitio}/client.rbs (50%) rename sig/{imagekit => imagekitio}/errors.rbs (70%) rename sig/{imagekit => imagekitio}/file_part.rbs (95%) rename sig/{imagekit => imagekitio}/internal.rbs (54%) rename sig/{imagekit => imagekitio}/internal/transport/base_client.rbs (75%) rename sig/{imagekit => imagekitio}/internal/transport/pooled_net_requester.rbs (78%) rename sig/{imagekit => imagekitio}/internal/type/array_of.rbs (58%) rename sig/{imagekit => imagekitio}/internal/type/base_model.rbs (59%) rename sig/{imagekit => imagekitio}/internal/type/base_page.rbs (71%) rename sig/{imagekit => imagekitio}/internal/type/boolean.rbs (58%) create mode 100644 sig/imagekitio/internal/type/converter.rbs rename sig/{imagekit => imagekitio}/internal/type/enum.rbs (65%) rename sig/{imagekit => imagekitio}/internal/type/file_input.rbs (68%) rename sig/{imagekit => imagekitio}/internal/type/hash_of.rbs (59%) create mode 100644 sig/imagekitio/internal/type/request_parameters.rbs rename sig/{imagekit => imagekitio}/internal/type/union.rbs (56%) rename sig/{imagekit => imagekitio}/internal/type/unknown.rbs (55%) rename sig/{imagekit => imagekitio}/internal/util.rbs (91%) create mode 100644 sig/imagekitio/models.rbs create mode 100644 sig/imagekitio/models/accounts/origin_create_params.rbs create mode 100644 sig/imagekitio/models/accounts/origin_delete_params.rbs create mode 100644 sig/imagekitio/models/accounts/origin_get_params.rbs create mode 100644 sig/imagekitio/models/accounts/origin_list_params.rbs create mode 100644 sig/imagekitio/models/accounts/origin_list_response.rbs rename sig/{imagekit => imagekitio}/models/accounts/origin_request.rbs (91%) rename sig/{imagekit => imagekitio}/models/accounts/origin_response.rbs (90%) create mode 100644 sig/imagekitio/models/accounts/origin_update_params.rbs create mode 100644 sig/imagekitio/models/accounts/url_endpoint_create_params.rbs create mode 100644 sig/imagekitio/models/accounts/url_endpoint_delete_params.rbs create mode 100644 sig/imagekitio/models/accounts/url_endpoint_get_params.rbs create mode 100644 sig/imagekitio/models/accounts/url_endpoint_list_params.rbs create mode 100644 sig/imagekitio/models/accounts/url_endpoint_list_response.rbs rename sig/{imagekit => imagekitio}/models/accounts/url_endpoint_request.rbs (60%) rename sig/{imagekit => imagekitio}/models/accounts/url_endpoint_response.rbs (59%) create mode 100644 sig/imagekitio/models/accounts/url_endpoint_update_params.rbs rename sig/{imagekit => imagekitio}/models/accounts/usage_get_params.rbs (51%) rename sig/{imagekit => imagekitio}/models/accounts/usage_get_response.rbs (94%) rename sig/{imagekit => imagekitio}/models/asset_list_params.rbs (52%) create mode 100644 sig/imagekitio/models/asset_list_response.rbs create mode 100644 sig/imagekitio/models/base_overlay.rbs rename sig/{imagekit => imagekitio}/models/base_webhook_event.rbs (75%) rename sig/{imagekit => imagekitio}/models/beta/v2/file_upload_params.rbs (59%) create mode 100644 sig/imagekitio/models/beta/v2/file_upload_response.rbs create mode 100644 sig/imagekitio/models/cache/invalidation_create_params.rbs rename sig/{imagekit => imagekitio}/models/cache/invalidation_create_response.rbs (76%) create mode 100644 sig/imagekitio/models/cache/invalidation_get_params.rbs create mode 100644 sig/imagekitio/models/cache/invalidation_get_response.rbs create mode 100644 sig/imagekitio/models/custom_metadata_field.rbs create mode 100644 sig/imagekitio/models/custom_metadata_field_create_params.rbs create mode 100644 sig/imagekitio/models/custom_metadata_field_delete_params.rbs rename sig/{imagekit => imagekitio}/models/custom_metadata_field_delete_response.rbs (59%) rename sig/{imagekit => imagekitio}/models/custom_metadata_field_list_params.rbs (56%) create mode 100644 sig/imagekitio/models/custom_metadata_field_list_response.rbs create mode 100644 sig/imagekitio/models/custom_metadata_field_update_params.rbs rename sig/{imagekit => imagekitio}/models/extensions.rbs (58%) rename sig/{imagekit => imagekitio}/models/file.rbs (55%) rename sig/{imagekit => imagekitio}/models/file_copy_params.rbs (63%) rename sig/{imagekit => imagekitio}/models/file_copy_response.rbs (60%) create mode 100644 sig/imagekitio/models/file_delete_params.rbs create mode 100644 sig/imagekitio/models/file_get_params.rbs rename sig/{imagekit => imagekitio}/models/file_move_params.rbs (53%) rename sig/{imagekit => imagekitio}/models/file_move_response.rbs (60%) rename sig/{imagekit => imagekitio}/models/file_rename_params.rbs (59%) rename sig/{imagekit => imagekitio}/models/file_rename_response.rbs (77%) create mode 100644 sig/imagekitio/models/file_update_params.rbs create mode 100644 sig/imagekitio/models/file_update_response.rbs rename sig/{imagekit => imagekitio}/models/file_upload_params.rbs (61%) create mode 100644 sig/imagekitio/models/file_upload_response.rbs rename sig/{imagekit => imagekitio}/models/files/bulk_add_tags_params.rbs (55%) rename sig/{imagekit => imagekitio}/models/files/bulk_add_tags_response.rbs (84%) create mode 100644 sig/imagekitio/models/files/bulk_delete_params.rbs rename sig/{imagekit => imagekitio}/models/files/bulk_delete_response.rbs (84%) rename sig/{imagekit => imagekitio}/models/files/bulk_remove_ai_tags_params.rbs (55%) rename sig/{imagekit => imagekitio}/models/files/bulk_remove_ai_tags_response.rbs (83%) rename sig/{imagekit => imagekitio}/models/files/bulk_remove_tags_params.rbs (55%) rename sig/{imagekit => imagekitio}/models/files/bulk_remove_tags_response.rbs (84%) create mode 100644 sig/imagekitio/models/files/metadata_get_from_url_params.rbs create mode 100644 sig/imagekitio/models/files/metadata_get_params.rbs create mode 100644 sig/imagekitio/models/files/version_delete_params.rbs rename sig/{imagekit => imagekitio}/models/files/version_delete_response.rbs (64%) create mode 100644 sig/imagekitio/models/files/version_get_params.rbs create mode 100644 sig/imagekitio/models/files/version_list_params.rbs create mode 100644 sig/imagekitio/models/files/version_list_response.rbs create mode 100644 sig/imagekitio/models/files/version_restore_params.rbs rename sig/{imagekit => imagekitio}/models/folder.rbs (67%) rename sig/{imagekit => imagekitio}/models/folder_copy_params.rbs (63%) rename sig/{imagekit => imagekitio}/models/folder_copy_response.rbs (70%) rename sig/{imagekit => imagekitio}/models/folder_create_params.rbs (52%) rename sig/{imagekit => imagekitio}/models/folder_create_response.rbs (59%) create mode 100644 sig/imagekitio/models/folder_delete_params.rbs rename sig/{imagekit => imagekitio}/models/folder_delete_response.rbs (59%) rename sig/{imagekit => imagekitio}/models/folder_move_params.rbs (53%) rename sig/{imagekit => imagekitio}/models/folder_move_response.rbs (70%) rename sig/{imagekit => imagekitio}/models/folder_rename_params.rbs (59%) rename sig/{imagekit => imagekitio}/models/folder_rename_response.rbs (70%) create mode 100644 sig/imagekitio/models/folders/job_get_params.rbs create mode 100644 sig/imagekitio/models/folders/job_get_response.rbs rename sig/{imagekit => imagekitio}/models/get_image_attributes_options.rbs (91%) create mode 100644 sig/imagekitio/models/image_overlay.rbs rename sig/{imagekit => imagekitio}/models/metadata.rbs (84%) create mode 100644 sig/imagekitio/models/overlay.rbs create mode 100644 sig/imagekitio/models/overlay_position.rbs create mode 100644 sig/imagekitio/models/overlay_timing.rbs rename sig/{imagekit => imagekitio}/models/responsive_image_attributes.rbs (87%) create mode 100644 sig/imagekitio/models/solid_color_overlay.rbs create mode 100644 sig/imagekitio/models/solid_color_overlay_transformation.rbs rename sig/{imagekit => imagekitio}/models/src_options.rbs (54%) rename sig/{imagekit => imagekitio}/models/streaming_resolution.rbs (76%) create mode 100644 sig/imagekitio/models/subtitle_overlay.rbs rename sig/{imagekit => imagekitio}/models/subtitle_overlay_transformation.rbs (64%) create mode 100644 sig/imagekitio/models/text_overlay.rbs create mode 100644 sig/imagekitio/models/text_overlay_transformation.rbs create mode 100644 sig/imagekitio/models/transformation.rbs rename sig/{imagekit => imagekitio}/models/transformation_position.rbs (52%) create mode 100644 sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs create mode 100644 sig/imagekitio/models/unwrap_webhook_event.rbs create mode 100644 sig/imagekitio/models/update_file_request.rbs create mode 100644 sig/imagekitio/models/upload_post_transform_error_event.rbs create mode 100644 sig/imagekitio/models/upload_post_transform_success_event.rbs create mode 100644 sig/imagekitio/models/upload_pre_transform_error_event.rbs create mode 100644 sig/imagekitio/models/upload_pre_transform_success_event.rbs create mode 100644 sig/imagekitio/models/video_overlay.rbs create mode 100644 sig/imagekitio/models/video_transformation_accepted_event.rbs create mode 100644 sig/imagekitio/models/video_transformation_error_event.rbs create mode 100644 sig/imagekitio/models/video_transformation_ready_event.rbs create mode 100644 sig/imagekitio/models/webhook_unsafe_unwrap_params.rbs create mode 100644 sig/imagekitio/models/webhook_unwrap_params.rbs rename sig/{imagekit => imagekitio}/request_options.rbs (67%) create mode 100644 sig/imagekitio/resources/accounts.rbs create mode 100644 sig/imagekitio/resources/accounts/origins.rbs create mode 100644 sig/imagekitio/resources/accounts/url_endpoints.rbs create mode 100644 sig/imagekitio/resources/accounts/usage.rbs create mode 100644 sig/imagekitio/resources/assets.rbs create mode 100644 sig/imagekitio/resources/beta.rbs create mode 100644 sig/imagekitio/resources/beta/v2.rbs rename sig/{imagekit => imagekitio}/resources/beta/v2/files.rbs (58%) create mode 100644 sig/imagekitio/resources/cache.rbs create mode 100644 sig/imagekitio/resources/cache/invalidation.rbs create mode 100644 sig/imagekitio/resources/custom_metadata_fields.rbs create mode 100644 sig/imagekitio/resources/files.rbs create mode 100644 sig/imagekitio/resources/files/bulk.rbs create mode 100644 sig/imagekitio/resources/files/metadata.rbs create mode 100644 sig/imagekitio/resources/files/versions.rbs create mode 100644 sig/imagekitio/resources/folders.rbs create mode 100644 sig/imagekitio/resources/folders/job.rbs create mode 100644 sig/imagekitio/resources/webhooks.rbs rename sig/{imagekit => imagekitio}/version.rbs (55%) delete mode 100644 test/imagekit/internal/sorbet_runtime_support_test.rb delete mode 100644 test/imagekit/resources/accounts_test.rb delete mode 100644 test/imagekit/resources/beta/v2/files_test.rb delete mode 100644 test/imagekit/resources/beta/v2_test.rb delete mode 100644 test/imagekit/resources/beta_test.rb delete mode 100644 test/imagekit/resources/cache_test.rb delete mode 100644 test/imagekit/resources/shared_test.rb rename test/{imagekit => imagekitio}/client_test.rb (87%) rename test/{imagekit => imagekitio}/file_part_test.rb (64%) create mode 100644 test/imagekitio/internal/sorbet_runtime_support_test.rb rename test/{imagekit => imagekitio}/internal/type/base_model_test.rb (72%) rename test/{imagekit => imagekitio}/internal/util_test.rb (70%) rename test/{imagekit => imagekitio}/resource_namespaces.rb (94%) rename test/{imagekit => imagekitio}/resources/accounts/origins_test.rb (62%) rename test/{imagekit => imagekitio}/resources/accounts/url_endpoints_test.rb (62%) rename test/{imagekit => imagekitio}/resources/accounts/usage_test.rb (79%) create mode 100644 test/imagekitio/resources/accounts_test.rb rename test/{imagekit => imagekitio}/resources/assets_test.rb (51%) create mode 100644 test/imagekitio/resources/beta/v2/files_test.rb create mode 100644 test/imagekitio/resources/beta/v2_test.rb rename test/{imagekit/resources/webhooks_test.rb => imagekitio/resources/beta_test.rb} (56%) rename test/{imagekit => imagekitio}/resources/cache/invalidation_test.rb (66%) create mode 100644 test/imagekitio/resources/cache_test.rb rename test/{imagekit => imagekitio}/resources/custom_metadata_fields_test.rb (69%) rename test/{imagekit => imagekitio}/resources/files/bulk_test.rb (66%) rename test/{imagekit => imagekitio}/resources/files/metadata_test.rb (69%) rename test/{imagekit => imagekitio}/resources/files/versions_test.rb (52%) rename test/{imagekit => imagekitio}/resources/files_test.rb (57%) rename test/{imagekit => imagekitio}/resources/folders/job_test.rb (54%) rename test/{imagekit => imagekitio}/resources/folders_test.rb (81%) create mode 100644 test/imagekitio/resources/shared_test.rb create mode 100644 test/imagekitio/resources/webhooks_test.rb rename test/{imagekit => imagekitio}/test_helper.rb (85%) diff --git a/.rubocop.yml b/.rubocop.yml index 271f487d..65ce11cc 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -40,9 +40,9 @@ Layout/LineLength: AllowedPatterns: - "^\\s*#.*$" - ^require(_relative)? - - "Imagekit::Internal::Type::BaseModel$" + - "Imagekitio::Internal::Type::BaseModel$" - "^\\s*[A-Z0-9_]+ = :" - - "Imagekit::(Models|Resources|Test)::" + - "Imagekitio::(Models|Resources|Test)::" Max: 110 Layout/MultilineArrayLineBreaks: diff --git a/.solargraph.yml b/.solargraph.yml index b100d90f..6110683d 100644 --- a/.solargraph.yml +++ b/.solargraph.yml @@ -5,7 +5,7 @@ include: - 'Rakefile' - 'examples/**/*.rb' - 'lib/**/*.rb' - - 'test/imagekit/resource_namespaces.rb' - - 'test/imagekit/test_helper.rb' + - 'test/imagekitio/resource_namespaces.rb' + - 'test/imagekitio/test_helper.rb' exclude: - 'rbi/**/*' diff --git a/.stats.yml b/.stats.yml index 43d92ddb..ae3aead6 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: c2c1c0a5c85d678e5aa8996f3637b616 +config_hash: eb4cf65a4c6b26a2901076eff5810d5d diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15b2dbaa..a225d784 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ This will install all the required dependencies. ## Modifying/Adding code -Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of `lib/imagekit/helpers/` and `examples/` directory. +Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of `lib/imagekitio/helpers/` and `examples/` directory. ## Adding and running examples @@ -24,7 +24,7 @@ All files in the `examples/` directory are not modified by the generator and can #!/usr/bin/env ruby # frozen_string_literal: true -require_relative "../lib/imagekit" +require_relative "../lib/imagekitio" # ... ``` @@ -43,7 +43,7 @@ If you’d like to use the repository from source, you can either install from g To install via git in your `Gemfile`: ```ruby -gem "imagekit", git: "https://www.github.com/imagekit-developer/imagekit-ruby" +gem "imagekitio", git: "https://www.github.com/imagekit-developer/imagekit-ruby" ``` Alternatively, reference local copy of the repo: @@ -53,7 +53,7 @@ $ git clone -- 'https://www.github.com/imagekit-developer/imagekit-ruby' '" +gem "imagekitio", path: "" ``` ## Running commands diff --git a/Gemfile.lock b/Gemfile.lock index 2c4ef551..133cd37e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - imagekit (0.0.1) + imagekitio (0.0.1) connection_pool GEM @@ -203,7 +203,7 @@ PLATFORMS DEPENDENCIES async - imagekit! + imagekitio! minitest minitest-focus minitest-hooks diff --git a/README.md b/README.md index 6f4f19f8..60d276f7 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The Image Kit Ruby library provides convenient access to the Image Kit REST API ## Documentation -Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/imagekit). +Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/imagekitio). The REST API documentation can be found on [imagekit.io](https://imagekit.io/docs/api-reference). @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "imagekit", "~> 0.0.1" +gem "imagekitio", "~> 0.0.1" ``` @@ -24,9 +24,9 @@ gem "imagekit", "~> 0.0.1" ```ruby require "bundler/setup" -require "imagekit" +require "imagekitio" -image_kit = Imagekit::Client.new( +image_kit = Imagekitio::Client.new( private_key: ENV["IMAGEKIT_PRIVATE_KEY"], # This is the default and can be omitted password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted ) @@ -53,7 +53,7 @@ response = image_kit.files.upload(file: Pathname("/path/to/file")) response = image_kit.files.upload(file: File.read("/path/to/file")) # Or, to control the filename and/or content type: -file = Imagekit::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…") +file = Imagekitio::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…") response = image_kit.files.upload(file: file) puts(response.videoCodec) @@ -63,7 +63,7 @@ Note that you can also pass a raw `IO` descriptor, but this disables retries, as ### Handling errors -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::Errors::APIError` will be thrown: +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 `Imagekitio::Errors::APIError` will be thrown: ```ruby begin @@ -71,12 +71,12 @@ begin file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg" ) -rescue Imagekit::Errors::APIConnectionError => e +rescue Imagekitio::Errors::APIConnectionError => e puts("The server could not be reached") puts(e.cause) # an underlying Exception, likely raised within `net/http` -rescue Imagekit::Errors::RateLimitError => e +rescue Imagekitio::Errors::RateLimitError => e puts("A 429 status code was received; we should back off a bit.") -rescue Imagekit::Errors::APIStatusError => e +rescue Imagekitio::Errors::APIStatusError => e puts("Another non-200-range status code was received") puts(e.status) end @@ -108,7 +108,7 @@ You can use the `max_retries` option to configure or disable this: ```ruby # Configure the default for all requests: -image_kit = Imagekit::Client.new( +image_kit = Imagekitio::Client.new( max_retries: 0 # default is 2 ) @@ -126,7 +126,7 @@ By default, requests will time out after 60 seconds. You can use the timeout opt ```ruby # Configure the default for all requests: -image_kit = Imagekit::Client.new( +image_kit = Imagekitio::Client.new( timeout: nil # default is 60 ) @@ -138,7 +138,7 @@ image_kit.files.upload( ) ``` -On timeout, `Imagekit::Errors::APITimeoutError` is raised. +On timeout, `Imagekitio::Errors::APITimeoutError` is raised. Note that requests that time out are retried by default. @@ -146,7 +146,7 @@ Note that requests that time out are retried by default. ### BaseModel -All parameter and response objects inherit from `Imagekit::Internal::Type::BaseModel`, which provides several conveniences, including: +All parameter and response objects inherit from `Imagekitio::Internal::Type::BaseModel`, which provides several conveniences, including: 1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax. @@ -199,9 +199,9 @@ response = client.request( ### Concurrency & connection pooling -The `Imagekit::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests. +The `Imagekitio::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests. -Each instance of `Imagekit::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings. +Each instance of `Imagekitio::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings. When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout. @@ -230,7 +230,7 @@ image_kit.files.upload( ) # You can also splat a full Params class: -params = Imagekit::FileUploadParams.new( +params = Imagekitio::FileUploadParams.new( file: StringIO.new("https://www.example.com/public-url.jpg"), file_name: "file-name.jpg" ) @@ -243,10 +243,10 @@ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::E ```ruby # :all -puts(Imagekit::AssetListParams::FileType::ALL) +puts(Imagekitio::AssetListParams::FileType::ALL) -# Revealed type: `T.all(Imagekit::AssetListParams::FileType, Symbol)` -T.reveal_type(Imagekit::AssetListParams::FileType::ALL) +# Revealed type: `T.all(Imagekitio::AssetListParams::FileType, Symbol)` +T.reveal_type(Imagekitio::AssetListParams::FileType::ALL) ``` Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value: @@ -254,7 +254,7 @@ Enum parameters have a "relaxed" type, so you can either pass in enum constants ```ruby # Using the enum constants preserves the tagged type information: image_kit.assets.list( - file_type: Imagekit::AssetListParams::FileType::ALL, + file_type: Imagekitio::AssetListParams::FileType::ALL, # … ) diff --git a/Rakefile b/Rakefile index 6712d7f1..a0c9e54e 100644 --- a/Rakefile +++ b/Rakefile @@ -162,7 +162,7 @@ multitask(:"build:gem") do sig/* GLOB - sh(*%w[gem build -- imagekit.gemspec]) + sh(*%w[gem build -- imagekitio.gemspec]) rm_rf(ignore_file) end diff --git a/imagekit.gemspec b/imagekitio.gemspec similarity index 80% rename from imagekit.gemspec rename to imagekitio.gemspec index f094efa0..19e0fcef 100644 --- a/imagekit.gemspec +++ b/imagekitio.gemspec @@ -1,14 +1,14 @@ # frozen_string_literal: true -require_relative "lib/imagekit/version" +require_relative "lib/imagekitio/version" Gem::Specification.new do |s| - s.name = "imagekit" - s.version = Imagekit::VERSION + s.name = "imagekitio" + s.version = Imagekitio::VERSION s.summary = "Ruby library to access the Image Kit API" s.authors = ["Image Kit"] s.email = "developer@imagekit.io" - s.homepage = "https://gemdocs.org/gems/imagekit" + s.homepage = "https://gemdocs.org/gems/imagekitio" s.metadata["homepage_uri"] = s.homepage s.metadata["source_code_uri"] = "https://github.com/imagekit-developer/imagekit-ruby" s.metadata["rubygems_mfa_required"] = false.to_s diff --git a/lib/imagekit.rb b/lib/imagekit.rb deleted file mode 100644 index bf2fac04..00000000 --- a/lib/imagekit.rb +++ /dev/null @@ -1,179 +0,0 @@ -# frozen_string_literal: true - -# Standard libraries. -# rubocop:disable Lint/RedundantRequireStatement -require "English" -require "cgi" -require "date" -require "erb" -require "etc" -require "json" -require "net/http" -require "pathname" -require "rbconfig" -require "securerandom" -require "set" -require "stringio" -require "time" -require "uri" -# rubocop:enable Lint/RedundantRequireStatement - -# We already ship the preferred sorbet manifests in the package itself. -# `tapioca` currently does not offer us a way to opt out of unnecessary compilation. -if Object.const_defined?(:Tapioca) && - caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) && - ARGV.none?(/dsl/) - return -end - -# Gems. -require "connection_pool" - -# Package files. -require_relative "imagekit/version" -require_relative "imagekit/internal/util" -require_relative "imagekit/internal/type/converter" -require_relative "imagekit/internal/type/unknown" -require_relative "imagekit/internal/type/boolean" -require_relative "imagekit/internal/type/file_input" -require_relative "imagekit/internal/type/enum" -require_relative "imagekit/internal/type/union" -require_relative "imagekit/internal/type/array_of" -require_relative "imagekit/internal/type/hash_of" -require_relative "imagekit/internal/type/base_model" -require_relative "imagekit/internal/type/base_page" -require_relative "imagekit/internal/type/request_parameters" -require_relative "imagekit/internal" -require_relative "imagekit/request_options" -require_relative "imagekit/file_part" -require_relative "imagekit/errors" -require_relative "imagekit/internal/transport/base_client" -require_relative "imagekit/internal/transport/pooled_net_requester" -require_relative "imagekit/client" -require_relative "imagekit/models/accounts/origin_request" -require_relative "imagekit/models/accounts/url_endpoint_request" -require_relative "imagekit/models/update_file_request" -require_relative "imagekit/models/file" -require_relative "imagekit/models/src_options" -require_relative "imagekit/models/base_overlay" -require_relative "imagekit/models/base_webhook_event" -require_relative "imagekit/models/accounts/origin_create_params" -require_relative "imagekit/models/accounts/origin_delete_params" -require_relative "imagekit/models/accounts/origin_get_params" -require_relative "imagekit/models/accounts/origin_list_params" -require_relative "imagekit/models/accounts/origin_list_response" -require_relative "imagekit/models/accounts/origin_response" -require_relative "imagekit/models/accounts/origin_update_params" -require_relative "imagekit/models/accounts/url_endpoint_create_params" -require_relative "imagekit/models/accounts/url_endpoint_delete_params" -require_relative "imagekit/models/accounts/url_endpoint_get_params" -require_relative "imagekit/models/accounts/url_endpoint_list_params" -require_relative "imagekit/models/accounts/url_endpoint_list_response" -require_relative "imagekit/models/accounts/url_endpoint_response" -require_relative "imagekit/models/accounts/url_endpoint_update_params" -require_relative "imagekit/models/accounts/usage_get_params" -require_relative "imagekit/models/accounts/usage_get_response" -require_relative "imagekit/models/asset_list_params" -require_relative "imagekit/models/asset_list_response" -require_relative "imagekit/models/beta/v2/file_upload_params" -require_relative "imagekit/models/beta/v2/file_upload_response" -require_relative "imagekit/models/cache/invalidation_create_params" -require_relative "imagekit/models/cache/invalidation_create_response" -require_relative "imagekit/models/cache/invalidation_get_params" -require_relative "imagekit/models/cache/invalidation_get_response" -require_relative "imagekit/models/custom_metadata_field" -require_relative "imagekit/models/custom_metadata_field_create_params" -require_relative "imagekit/models/custom_metadata_field_delete_params" -require_relative "imagekit/models/custom_metadata_field_delete_response" -require_relative "imagekit/models/custom_metadata_field_list_params" -require_relative "imagekit/models/custom_metadata_field_list_response" -require_relative "imagekit/models/custom_metadata_field_update_params" -require_relative "imagekit/models/extensions" -require_relative "imagekit/models/file_copy_params" -require_relative "imagekit/models/file_copy_response" -require_relative "imagekit/models/file_delete_params" -require_relative "imagekit/models/file_get_params" -require_relative "imagekit/models/file_move_params" -require_relative "imagekit/models/file_move_response" -require_relative "imagekit/models/file_rename_params" -require_relative "imagekit/models/file_rename_response" -require_relative "imagekit/models/files/bulk_add_tags_params" -require_relative "imagekit/models/files/bulk_add_tags_response" -require_relative "imagekit/models/files/bulk_delete_params" -require_relative "imagekit/models/files/bulk_delete_response" -require_relative "imagekit/models/files/bulk_remove_ai_tags_params" -require_relative "imagekit/models/files/bulk_remove_ai_tags_response" -require_relative "imagekit/models/files/bulk_remove_tags_params" -require_relative "imagekit/models/files/bulk_remove_tags_response" -require_relative "imagekit/models/files/metadata_get_from_url_params" -require_relative "imagekit/models/files/metadata_get_params" -require_relative "imagekit/models/files/version_delete_params" -require_relative "imagekit/models/files/version_delete_response" -require_relative "imagekit/models/files/version_get_params" -require_relative "imagekit/models/files/version_list_params" -require_relative "imagekit/models/files/version_list_response" -require_relative "imagekit/models/files/version_restore_params" -require_relative "imagekit/models/file_update_params" -require_relative "imagekit/models/file_update_response" -require_relative "imagekit/models/file_upload_params" -require_relative "imagekit/models/file_upload_response" -require_relative "imagekit/models/folder" -require_relative "imagekit/models/folder_copy_params" -require_relative "imagekit/models/folder_copy_response" -require_relative "imagekit/models/folder_create_params" -require_relative "imagekit/models/folder_create_response" -require_relative "imagekit/models/folder_delete_params" -require_relative "imagekit/models/folder_delete_response" -require_relative "imagekit/models/folder_move_params" -require_relative "imagekit/models/folder_move_response" -require_relative "imagekit/models/folder_rename_params" -require_relative "imagekit/models/folder_rename_response" -require_relative "imagekit/models/folders/job_get_params" -require_relative "imagekit/models/folders/job_get_response" -require_relative "imagekit/models/get_image_attributes_options" -require_relative "imagekit/models/image_overlay" -require_relative "imagekit/models/metadata" -require_relative "imagekit/models/overlay" -require_relative "imagekit/models/overlay_position" -require_relative "imagekit/models/overlay_timing" -require_relative "imagekit/models/responsive_image_attributes" -require_relative "imagekit/models/solid_color_overlay" -require_relative "imagekit/models/solid_color_overlay_transformation" -require_relative "imagekit/models/streaming_resolution" -require_relative "imagekit/models/subtitle_overlay" -require_relative "imagekit/models/subtitle_overlay_transformation" -require_relative "imagekit/models/text_overlay" -require_relative "imagekit/models/text_overlay_transformation" -require_relative "imagekit/models/transformation" -require_relative "imagekit/models/transformation_position" -require_relative "imagekit/models/unsafe_unwrap_webhook_event" -require_relative "imagekit/models/unwrap_webhook_event" -require_relative "imagekit/models/upload_post_transform_error_event" -require_relative "imagekit/models/upload_post_transform_success_event" -require_relative "imagekit/models/upload_pre_transform_error_event" -require_relative "imagekit/models/upload_pre_transform_success_event" -require_relative "imagekit/models/video_overlay" -require_relative "imagekit/models/video_transformation_accepted_event" -require_relative "imagekit/models/video_transformation_error_event" -require_relative "imagekit/models/video_transformation_ready_event" -require_relative "imagekit/models/webhook_unsafe_unwrap_params" -require_relative "imagekit/models/webhook_unwrap_params" -require_relative "imagekit/models" -require_relative "imagekit/resources/accounts" -require_relative "imagekit/resources/accounts/origins" -require_relative "imagekit/resources/accounts/url_endpoints" -require_relative "imagekit/resources/accounts/usage" -require_relative "imagekit/resources/assets" -require_relative "imagekit/resources/beta" -require_relative "imagekit/resources/beta/v2" -require_relative "imagekit/resources/beta/v2/files" -require_relative "imagekit/resources/cache" -require_relative "imagekit/resources/cache/invalidation" -require_relative "imagekit/resources/custom_metadata_fields" -require_relative "imagekit/resources/files" -require_relative "imagekit/resources/files/bulk" -require_relative "imagekit/resources/files/metadata" -require_relative "imagekit/resources/files/versions" -require_relative "imagekit/resources/folders" -require_relative "imagekit/resources/folders/job" -require_relative "imagekit/resources/webhooks" diff --git a/lib/imagekit/models.rb b/lib/imagekit/models.rb deleted file mode 100644 index 8b87361a..00000000 --- a/lib/imagekit/models.rb +++ /dev/null @@ -1,160 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - [Imagekit::Internal::Type::BaseModel, *Imagekit::Internal::Type::BaseModel.subclasses].each do |cls| - cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Imagekit::Internal::AnyHash) } } - end - - Imagekit::Internal::Util.walk_namespaces(Imagekit::Models).each do |mod| - case mod - in Imagekit::Internal::Type::Enum | Imagekit::Internal::Type::Union - mod.constants.each do |name| - case mod.const_get(name) - in true | false - mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } } - mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } } - in Integer - mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } } - mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } } - in Float - mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } } - mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } } - in Symbol - mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } } - mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } } - else - end - end - else - end - end - - Imagekit::Internal::Util.walk_namespaces(Imagekit::Models) - .lazy - .grep(Imagekit::Internal::Type::Union) - .each do |mod| - const = :Variants - next if mod.sorbet_constant_defined?(const) - - mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } } - end - - Accounts = Imagekit::Models::Accounts - - AssetListParams = Imagekit::Models::AssetListParams - - BaseOverlay = Imagekit::Models::BaseOverlay - - BaseWebhookEvent = Imagekit::Models::BaseWebhookEvent - - Beta = Imagekit::Models::Beta - - Cache = Imagekit::Models::Cache - - CustomMetadataField = Imagekit::Models::CustomMetadataField - - CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams - - CustomMetadataFieldDeleteParams = Imagekit::Models::CustomMetadataFieldDeleteParams - - CustomMetadataFieldListParams = Imagekit::Models::CustomMetadataFieldListParams - - CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams - - ExtensionItem = Imagekit::Models::ExtensionItem - - # @type [Imagekit::Internal::Type::Converter] - Extensions = Imagekit::Models::Extensions - - File = Imagekit::Models::File - - FileCopyParams = Imagekit::Models::FileCopyParams - - FileDeleteParams = Imagekit::Models::FileDeleteParams - - FileGetParams = Imagekit::Models::FileGetParams - - FileMoveParams = Imagekit::Models::FileMoveParams - - FileRenameParams = Imagekit::Models::FileRenameParams - - Files = Imagekit::Models::Files - - FileUpdateParams = Imagekit::Models::FileUpdateParams - - FileUploadParams = Imagekit::Models::FileUploadParams - - Folder = Imagekit::Models::Folder - - FolderCopyParams = Imagekit::Models::FolderCopyParams - - FolderCreateParams = Imagekit::Models::FolderCreateParams - - FolderDeleteParams = Imagekit::Models::FolderDeleteParams - - FolderMoveParams = Imagekit::Models::FolderMoveParams - - FolderRenameParams = Imagekit::Models::FolderRenameParams - - Folders = Imagekit::Models::Folders - - GetImageAttributesOptions = Imagekit::Models::GetImageAttributesOptions - - ImageOverlay = Imagekit::Models::ImageOverlay - - Metadata = Imagekit::Models::Metadata - - Overlay = Imagekit::Models::Overlay - - OverlayPosition = Imagekit::Models::OverlayPosition - - OverlayTiming = Imagekit::Models::OverlayTiming - - ResponsiveImageAttributes = Imagekit::Models::ResponsiveImageAttributes - - SolidColorOverlay = Imagekit::Models::SolidColorOverlay - - SolidColorOverlayTransformation = Imagekit::Models::SolidColorOverlayTransformation - - SrcOptions = Imagekit::Models::SrcOptions - - StreamingResolution = Imagekit::Models::StreamingResolution - - SubtitleOverlay = Imagekit::Models::SubtitleOverlay - - SubtitleOverlayTransformation = Imagekit::Models::SubtitleOverlayTransformation - - TextOverlay = Imagekit::Models::TextOverlay - - TextOverlayTransformation = Imagekit::Models::TextOverlayTransformation - - Transformation = Imagekit::Models::Transformation - - TransformationPosition = Imagekit::Models::TransformationPosition - - UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent - - UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - - UpdateFileRequest = Imagekit::Models::UpdateFileRequest - - UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent - - UploadPostTransformSuccessEvent = Imagekit::Models::UploadPostTransformSuccessEvent - - UploadPreTransformErrorEvent = Imagekit::Models::UploadPreTransformErrorEvent - - UploadPreTransformSuccessEvent = Imagekit::Models::UploadPreTransformSuccessEvent - - VideoOverlay = Imagekit::Models::VideoOverlay - - VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent - - VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent - - VideoTransformationReadyEvent = Imagekit::Models::VideoTransformationReadyEvent - - WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams - - WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams -end diff --git a/lib/imagekit/models/accounts/origin_create_params.rb b/lib/imagekit/models/accounts/origin_create_params.rb deleted file mode 100644 index 120fed5d..00000000 --- a/lib/imagekit/models/accounts/origin_create_params.rb +++ /dev/null @@ -1,24 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::Origins#create - class OriginCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute origin_request - # Schema for origin request resources. - # - # @return [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] - required :origin_request, union: -> { Imagekit::Accounts::OriginRequest } - - # @!method initialize(origin_request:, request_options: {}) - # @param origin_request [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/origin_delete_params.rb b/lib/imagekit/models/accounts/origin_delete_params.rb deleted file mode 100644 index 013eedd5..00000000 --- a/lib/imagekit/models/accounts/origin_delete_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::Origins#delete - class OriginDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/origin_get_params.rb b/lib/imagekit/models/accounts/origin_get_params.rb deleted file mode 100644 index 97a63638..00000000 --- a/lib/imagekit/models/accounts/origin_get_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::Origins#get - class OriginGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/origin_list_params.rb b/lib/imagekit/models/accounts/origin_list_params.rb deleted file mode 100644 index 8435e2f8..00000000 --- a/lib/imagekit/models/accounts/origin_list_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::Origins#list - class OriginListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/origin_list_response.rb b/lib/imagekit/models/accounts/origin_list_response.rb deleted file mode 100644 index 8f9e9da8..00000000 --- a/lib/imagekit/models/accounts/origin_list_response.rb +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @type [Imagekit::Internal::Type::Converter] - OriginListResponse = Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Accounts::OriginResponse }] - end - end -end diff --git a/lib/imagekit/models/accounts/origin_update_params.rb b/lib/imagekit/models/accounts/origin_update_params.rb deleted file mode 100644 index 2cbe03a7..00000000 --- a/lib/imagekit/models/accounts/origin_update_params.rb +++ /dev/null @@ -1,24 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::Origins#update - class OriginUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute origin_request - # Schema for origin request resources. - # - # @return [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] - required :origin_request, union: -> { Imagekit::Accounts::OriginRequest } - - # @!method initialize(origin_request:, request_options: {}) - # @param origin_request [Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/url_endpoint_create_params.rb b/lib/imagekit/models/accounts/url_endpoint_create_params.rb deleted file mode 100644 index 5a065839..00000000 --- a/lib/imagekit/models/accounts/url_endpoint_create_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::URLEndpoints#create - class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpointRequest - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/url_endpoint_delete_params.rb b/lib/imagekit/models/accounts/url_endpoint_delete_params.rb deleted file mode 100644 index 484bea81..00000000 --- a/lib/imagekit/models/accounts/url_endpoint_delete_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::URLEndpoints#delete - class URLEndpointDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/url_endpoint_get_params.rb b/lib/imagekit/models/accounts/url_endpoint_get_params.rb deleted file mode 100644 index d5d4461b..00000000 --- a/lib/imagekit/models/accounts/url_endpoint_get_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::URLEndpoints#get - class URLEndpointGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/url_endpoint_list_params.rb b/lib/imagekit/models/accounts/url_endpoint_list_params.rb deleted file mode 100644 index ec77107c..00000000 --- a/lib/imagekit/models/accounts/url_endpoint_list_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::URLEndpoints#list - class URLEndpointListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/accounts/url_endpoint_list_response.rb b/lib/imagekit/models/accounts/url_endpoint_list_response.rb deleted file mode 100644 index 054376a9..00000000 --- a/lib/imagekit/models/accounts/url_endpoint_list_response.rb +++ /dev/null @@ -1,11 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @type [Imagekit::Internal::Type::Converter] - URLEndpointListResponse = - Imagekit::Internal::Type::ArrayOf[-> { Imagekit::Accounts::URLEndpointResponse }] - end - end -end diff --git a/lib/imagekit/models/accounts/url_endpoint_update_params.rb b/lib/imagekit/models/accounts/url_endpoint_update_params.rb deleted file mode 100644 index cb1bca4f..00000000 --- a/lib/imagekit/models/accounts/url_endpoint_update_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Accounts - # @see Imagekit::Resources::Accounts::URLEndpoints#update - class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpointRequest - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/asset_list_response.rb b/lib/imagekit/models/asset_list_response.rb deleted file mode 100644 index 6477fc20..00000000 --- a/lib/imagekit/models/asset_list_response.rb +++ /dev/null @@ -1,24 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # Object containing details of a file or file version. - module AssetListResponseItem - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :folder, -> { Imagekit::Folder } - - # Object containing details of a file or file version. - variant -> { Imagekit::File } - - # @!method self.variants - # @return [Array(Imagekit::Models::Folder, Imagekit::Models::File)] - end - - # @type [Imagekit::Internal::Type::Converter] - AssetListResponse = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::AssetListResponseItem }] - end -end diff --git a/lib/imagekit/models/base_overlay.rb b/lib/imagekit/models/base_overlay.rb deleted file mode 100644 index 44a3c8a8..00000000 --- a/lib/imagekit/models/base_overlay.rb +++ /dev/null @@ -1,21 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - class BaseOverlay < Imagekit::Internal::Type::BaseModel - # @!attribute position - # - # @return [Imagekit::Models::OverlayPosition, nil] - optional :position, -> { Imagekit::OverlayPosition } - - # @!attribute timing - # - # @return [Imagekit::Models::OverlayTiming, nil] - optional :timing, -> { Imagekit::OverlayTiming } - - # @!method initialize(position: nil, timing: nil) - # @param position [Imagekit::Models::OverlayPosition] - # @param timing [Imagekit::Models::OverlayTiming] - end - end -end diff --git a/lib/imagekit/models/cache/invalidation_create_params.rb b/lib/imagekit/models/cache/invalidation_create_params.rb deleted file mode 100644 index 47e252a8..00000000 --- a/lib/imagekit/models/cache/invalidation_create_params.rb +++ /dev/null @@ -1,27 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Cache - # @see Imagekit::Resources::Cache::Invalidation#create - class InvalidationCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute url - # The full URL of the file to be purged. - # - # @return [String] - required :url, String - - # @!method initialize(url:, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Cache::InvalidationCreateParams} for more details. - # - # @param url [String] The full URL of the file to be purged. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/cache/invalidation_get_params.rb b/lib/imagekit/models/cache/invalidation_get_params.rb deleted file mode 100644 index d25ae6f5..00000000 --- a/lib/imagekit/models/cache/invalidation_get_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Cache - # @see Imagekit::Resources::Cache::Invalidation#get - class InvalidationGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/cache/invalidation_get_response.rb b/lib/imagekit/models/cache/invalidation_get_response.rb deleted file mode 100644 index 0a5d99c0..00000000 --- a/lib/imagekit/models/cache/invalidation_get_response.rb +++ /dev/null @@ -1,35 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Cache - # @see Imagekit::Resources::Cache::Invalidation#get - class InvalidationGetResponse < Imagekit::Internal::Type::BaseModel - # @!attribute status - # Status of the purge request. - # - # @return [Symbol, Imagekit::Models::Cache::InvalidationGetResponse::Status, nil] - optional :status, enum: -> { Imagekit::Models::Cache::InvalidationGetResponse::Status } - - # @!method initialize(status: nil) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Cache::InvalidationGetResponse} for more details. - # - # @param status [Symbol, Imagekit::Models::Cache::InvalidationGetResponse::Status] Status of the purge request. - - # Status of the purge request. - # - # @see Imagekit::Models::Cache::InvalidationGetResponse#status - module Status - extend Imagekit::Internal::Type::Enum - - PENDING = :Pending - COMPLETED = :Completed - - # @!method self.values - # @return [Array] - end - end - end - end -end diff --git a/lib/imagekit/models/custom_metadata_field_delete_params.rb b/lib/imagekit/models/custom_metadata_field_delete_params.rb deleted file mode 100644 index 21af3d9c..00000000 --- a/lib/imagekit/models/custom_metadata_field_delete_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::CustomMetadataFields#delete - class CustomMetadataFieldDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/custom_metadata_field_delete_response.rb b/lib/imagekit/models/custom_metadata_field_delete_response.rb deleted file mode 100644 index ec5f93b1..00000000 --- a/lib/imagekit/models/custom_metadata_field_delete_response.rb +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::CustomMetadataFields#delete - class CustomMetadataFieldDeleteResponse < Imagekit::Internal::Type::BaseModel - # @!method initialize - end - end -end diff --git a/lib/imagekit/models/custom_metadata_field_list_response.rb b/lib/imagekit/models/custom_metadata_field_list_response.rb deleted file mode 100644 index 78a32292..00000000 --- a/lib/imagekit/models/custom_metadata_field_list_response.rb +++ /dev/null @@ -1,8 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @type [Imagekit::Internal::Type::Converter] - CustomMetadataFieldListResponse = Imagekit::Internal::Type::ArrayOf[-> { Imagekit::CustomMetadataField }] - end -end diff --git a/lib/imagekit/models/file_copy_response.rb b/lib/imagekit/models/file_copy_response.rb deleted file mode 100644 index b783f78a..00000000 --- a/lib/imagekit/models/file_copy_response.rb +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#copy - class FileCopyResponse < Imagekit::Internal::Type::BaseModel - # @!method initialize - end - end -end diff --git a/lib/imagekit/models/file_delete_params.rb b/lib/imagekit/models/file_delete_params.rb deleted file mode 100644 index 7de513c4..00000000 --- a/lib/imagekit/models/file_delete_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#delete - class FileDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/file_get_params.rb b/lib/imagekit/models/file_get_params.rb deleted file mode 100644 index 65525d6b..00000000 --- a/lib/imagekit/models/file_get_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#get - class FileGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/file_move_response.rb b/lib/imagekit/models/file_move_response.rb deleted file mode 100644 index 69bb18b1..00000000 --- a/lib/imagekit/models/file_move_response.rb +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#move - class FileMoveResponse < Imagekit::Internal::Type::BaseModel - # @!method initialize - end - end -end diff --git a/lib/imagekit/models/file_update_params.rb b/lib/imagekit/models/file_update_params.rb deleted file mode 100644 index 1685dfad..00000000 --- a/lib/imagekit/models/file_update_params.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#update - class FileUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute update_file_request - # Schema for update file update request. - # - # @return [Imagekit::Models::UpdateFileRequest::UpdateFileDetails, Imagekit::Models::UpdateFileRequest::ChangePublicationStatus] - required :update_file_request, union: -> { Imagekit::UpdateFileRequest } - - # @!method initialize(update_file_request:, request_options: {}) - # @param update_file_request [Imagekit::Models::UpdateFileRequest::UpdateFileDetails, Imagekit::Models::UpdateFileRequest::ChangePublicationStatus] Schema for update file update request. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/file_update_response.rb b/lib/imagekit/models/file_update_response.rb deleted file mode 100644 index 916adbcf..00000000 --- a/lib/imagekit/models/file_update_response.rb +++ /dev/null @@ -1,104 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Files#update - class FileUpdateResponse < Imagekit::Models::File - # @!attribute extension_status - # - # @return [Imagekit::Models::FileUpdateResponse::ExtensionStatus, nil] - optional :extension_status, - -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus }, - api_name: :extensionStatus - - # @!method initialize(extension_status: nil) - # Object containing details of a file or file version. - # - # @param extension_status [Imagekit::Models::FileUpdateResponse::ExtensionStatus] - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - # @!attribute ai_auto_description - # - # @return [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription, nil] - optional :ai_auto_description, - enum: -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription }, - api_name: :"ai-auto-description" - - # @!attribute aws_auto_tagging - # - # @return [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging, nil] - optional :aws_auto_tagging, - enum: -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging }, - api_name: :"aws-auto-tagging" - - # @!attribute google_auto_tagging - # - # @return [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging, nil] - optional :google_auto_tagging, - enum: -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging }, - api_name: :"google-auto-tagging" - - # @!attribute remove_bg - # - # @return [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg, nil] - optional :remove_bg, - enum: -> { Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg }, - api_name: :"remove-bg" - - # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) - # @param ai_auto_description [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription] - # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging] - # @param google_auto_tagging [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging] - # @param remove_bg [Symbol, Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg] - - # @see Imagekit::Models::FileUpdateResponse::ExtensionStatus#ai_auto_description - module AIAutoDescription - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUpdateResponse::ExtensionStatus#aws_auto_tagging - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUpdateResponse::ExtensionStatus#google_auto_tagging - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - - # @see Imagekit::Models::FileUpdateResponse::ExtensionStatus#remove_bg - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS = :success - PENDING = :pending - FAILED = :failed - - # @!method self.values - # @return [Array] - end - end - end - end -end diff --git a/lib/imagekit/models/files/bulk_delete_params.rb b/lib/imagekit/models/files/bulk_delete_params.rb deleted file mode 100644 index 02bffc69..00000000 --- a/lib/imagekit/models/files/bulk_delete_params.rb +++ /dev/null @@ -1,27 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Bulk#delete - class BulkDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file_ids - # An array of fileIds which you want to delete. - # - # @return [Array] - required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds - - # @!method initialize(file_ids:, request_options: {}) - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkDeleteParams} for more details. - # - # @param file_ids [Array] An array of fileIds which you want to delete. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/files/metadata_get_params.rb b/lib/imagekit/models/files/metadata_get_params.rb deleted file mode 100644 index c95a81e5..00000000 --- a/lib/imagekit/models/files/metadata_get_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Metadata#get - class MetadataGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/files/version_delete_params.rb b/lib/imagekit/models/files/version_delete_params.rb deleted file mode 100644 index e17425f1..00000000 --- a/lib/imagekit/models/files/version_delete_params.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Versions#delete - class VersionDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file_id - # - # @return [String] - required :file_id, String - - # @!method initialize(file_id:, request_options: {}) - # @param file_id [String] - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/files/version_delete_response.rb b/lib/imagekit/models/files/version_delete_response.rb deleted file mode 100644 index 7f044266..00000000 --- a/lib/imagekit/models/files/version_delete_response.rb +++ /dev/null @@ -1,12 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Versions#delete - class VersionDeleteResponse < Imagekit::Internal::Type::BaseModel - # @!method initialize - end - end - end -end diff --git a/lib/imagekit/models/files/version_get_params.rb b/lib/imagekit/models/files/version_get_params.rb deleted file mode 100644 index b4c7ae98..00000000 --- a/lib/imagekit/models/files/version_get_params.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Versions#get - class VersionGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file_id - # - # @return [String] - required :file_id, String - - # @!method initialize(file_id:, request_options: {}) - # @param file_id [String] - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/files/version_list_params.rb b/lib/imagekit/models/files/version_list_params.rb deleted file mode 100644 index 82bf2cc3..00000000 --- a/lib/imagekit/models/files/version_list_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Versions#list - class VersionListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/files/version_list_response.rb b/lib/imagekit/models/files/version_list_response.rb deleted file mode 100644 index b74454e4..00000000 --- a/lib/imagekit/models/files/version_list_response.rb +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @type [Imagekit::Internal::Type::Converter] - VersionListResponse = Imagekit::Internal::Type::ArrayOf[-> { Imagekit::File }] - end - end -end diff --git a/lib/imagekit/models/files/version_restore_params.rb b/lib/imagekit/models/files/version_restore_params.rb deleted file mode 100644 index bf1e8c63..00000000 --- a/lib/imagekit/models/files/version_restore_params.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Files - # @see Imagekit::Resources::Files::Versions#restore - class VersionRestoreParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!attribute file_id - # - # @return [String] - required :file_id, String - - # @!method initialize(file_id:, request_options: {}) - # @param file_id [String] - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/folder_create_response.rb b/lib/imagekit/models/folder_create_response.rb deleted file mode 100644 index 6dab708e..00000000 --- a/lib/imagekit/models/folder_create_response.rb +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Folders#create - class FolderCreateResponse < Imagekit::Internal::Type::BaseModel - # @!method initialize - end - end -end diff --git a/lib/imagekit/models/folder_delete_response.rb b/lib/imagekit/models/folder_delete_response.rb deleted file mode 100644 index c92e4aa9..00000000 --- a/lib/imagekit/models/folder_delete_response.rb +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Folders#delete - class FolderDeleteResponse < Imagekit::Internal::Type::BaseModel - # @!method initialize - end - end -end diff --git a/lib/imagekit/models/folders/job_get_params.rb b/lib/imagekit/models/folders/job_get_params.rb deleted file mode 100644 index 916f9213..00000000 --- a/lib/imagekit/models/folders/job_get_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - module Folders - # @see Imagekit::Resources::Folders::Job#get - class JobGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end - end -end diff --git a/lib/imagekit/models/overlay.rb b/lib/imagekit/models/overlay.rb deleted file mode 100644 index 3c1873ca..00000000 --- a/lib/imagekit/models/overlay.rb +++ /dev/null @@ -1,28 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # 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). - module Overlay - extend Imagekit::Internal::Type::Union - - discriminator :type - - variant :text, -> { Imagekit::TextOverlay } - - variant :image, -> { Imagekit::ImageOverlay } - - variant :video, -> { Imagekit::VideoOverlay } - - variant :subtitle, -> { Imagekit::SubtitleOverlay } - - variant :solidColor, -> { Imagekit::SolidColorOverlay } - - # @!method self.variants - # @return [Array(Imagekit::Models::TextOverlay, Imagekit::Models::ImageOverlay, Imagekit::Models::VideoOverlay, Imagekit::Models::SubtitleOverlay, Imagekit::Models::SolidColorOverlay)] - end - end -end diff --git a/lib/imagekit/models/webhook_unsafe_unwrap_params.rb b/lib/imagekit/models/webhook_unsafe_unwrap_params.rb deleted file mode 100644 index 15530402..00000000 --- a/lib/imagekit/models/webhook_unsafe_unwrap_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Webhooks#unsafe_unwrap - class WebhookUnsafeUnwrapParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/models/webhook_unwrap_params.rb b/lib/imagekit/models/webhook_unwrap_params.rb deleted file mode 100644 index d93a86a9..00000000 --- a/lib/imagekit/models/webhook_unwrap_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Models - # @see Imagekit::Resources::Webhooks#unwrap - class WebhookUnwrapParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/imagekit/resources/accounts.rb b/lib/imagekit/resources/accounts.rb deleted file mode 100644 index 5946d26e..00000000 --- a/lib/imagekit/resources/accounts.rb +++ /dev/null @@ -1,26 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Resources - class Accounts - # @return [Imagekit::Resources::Accounts::Usage] - attr_reader :usage - - # @return [Imagekit::Resources::Accounts::Origins] - attr_reader :origins - - # @return [Imagekit::Resources::Accounts::URLEndpoints] - attr_reader :url_endpoints - - # @api private - # - # @param client [Imagekit::Client] - def initialize(client:) - @client = client - @usage = Imagekit::Resources::Accounts::Usage.new(client: client) - @origins = Imagekit::Resources::Accounts::Origins.new(client: client) - @url_endpoints = Imagekit::Resources::Accounts::URLEndpoints.new(client: client) - end - end - end -end diff --git a/lib/imagekit/resources/accounts/origins.rb b/lib/imagekit/resources/accounts/origins.rb deleted file mode 100644 index 5ae00800..00000000 --- a/lib/imagekit/resources/accounts/origins.rb +++ /dev/null @@ -1,145 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Resources - class Accounts - class Origins - # **Note:** This API is currently in beta. - # Creates a new origin and returns the origin object. - # - # @overload create(origin_request:, request_options: {}) - # - # @param origin_request [Imagekit::Accounts::OriginRequest] Schema for origin request resources. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] - # - # @see Imagekit::Models::Accounts::OriginCreateParams - def create(params) - parsed, options = Imagekit::Accounts::OriginCreateParams.dump_request(params) - case parsed - in {origin_request: Hash => union, **rest} - parsed = {**rest, **union} - else - end - @client.request( - method: :post, - path: "v1/accounts/origins", - body: parsed, - model: Imagekit::Accounts::OriginResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginUpdateParams} for more details. - # - # **Note:** This API is currently in beta. - # Updates the origin identified by `id` and returns the updated origin object. - # - # @overload update(id, origin_request:, request_options: {}) - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param origin_request [Imagekit::Accounts::OriginRequest] Schema for origin request resources. - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] - # - # @see Imagekit::Models::Accounts::OriginUpdateParams - def update(id, params) - parsed, options = Imagekit::Accounts::OriginUpdateParams.dump_request(params) - case parsed - in {origin_request: Hash => union, **rest} - parsed = {**rest, **union} - else - end - @client.request( - method: :put, - path: ["v1/accounts/origins/%1$s", id], - body: parsed, - model: Imagekit::Accounts::OriginResponse, - options: options - ) - end - - # **Note:** This API is currently in beta. - # Returns an array of all configured origins for the current account. - # - # @overload list(request_options: {}) - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Array] - # - # @see Imagekit::Models::Accounts::OriginListParams - def list(params = {}) - @client.request( - method: :get, - path: "v1/accounts/origins", - model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::OriginResponse], - options: params[:request_options] - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginDeleteParams} for more details. - # - # **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. - # - # @overload delete(id, request_options: {}) - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [nil] - # - # @see Imagekit::Models::Accounts::OriginDeleteParams - def delete(id, params = {}) - @client.request( - method: :delete, - path: ["v1/accounts/origins/%1$s", id], - model: NilClass, - options: params[:request_options] - ) - end - - # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginGetParams} for more details. - # - # **Note:** This API is currently in beta. - # Retrieves the origin identified by `id`. - # - # @overload get(id, request_options: {}) - # - # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create - # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim] - # - # @see Imagekit::Models::Accounts::OriginGetParams - def get(id, params = {}) - @client.request( - method: :get, - path: ["v1/accounts/origins/%1$s", id], - model: Imagekit::Accounts::OriginResponse, - options: params[:request_options] - ) - end - - # @api private - # - # @param client [Imagekit::Client] - def initialize(client:) - @client = client - end - end - end - end -end diff --git a/lib/imagekit/resources/webhooks.rb b/lib/imagekit/resources/webhooks.rb deleted file mode 100644 index 067574cf..00000000 --- a/lib/imagekit/resources/webhooks.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -module Imagekit - module Resources - class Webhooks - # @param payload [String] The raw webhook payload as a string - # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessEvent, Imagekit::Models::UploadPreTransformErrorEvent, Imagekit::Models::UploadPostTransformSuccessEvent, Imagekit::Models::UploadPostTransformErrorEvent] - def unsafe_unwrap(payload) - parsed = JSON.parse(payload, symbolize_names: true) - Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnsafeUnwrapWebhookEvent, parsed) - end - - # @param payload [String] The raw webhook payload as a string - # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessEvent, Imagekit::Models::UploadPreTransformErrorEvent, Imagekit::Models::UploadPostTransformSuccessEvent, Imagekit::Models::UploadPostTransformErrorEvent] - def unwrap(payload) - parsed = JSON.parse(payload, symbolize_names: true) - Imagekit::Internal::Type::Converter.coerce(Imagekit::Models::UnwrapWebhookEvent, parsed) - end - - # @api private - # - # @param client [Imagekit::Client] - def initialize(client:) - @client = client - end - end - end -end diff --git a/lib/imagekitio.rb b/lib/imagekitio.rb new file mode 100644 index 00000000..ea9130ba --- /dev/null +++ b/lib/imagekitio.rb @@ -0,0 +1,179 @@ +# frozen_string_literal: true + +# Standard libraries. +# rubocop:disable Lint/RedundantRequireStatement +require "English" +require "cgi" +require "date" +require "erb" +require "etc" +require "json" +require "net/http" +require "pathname" +require "rbconfig" +require "securerandom" +require "set" +require "stringio" +require "time" +require "uri" +# rubocop:enable Lint/RedundantRequireStatement + +# We already ship the preferred sorbet manifests in the package itself. +# `tapioca` currently does not offer us a way to opt out of unnecessary compilation. +if Object.const_defined?(:Tapioca) && + caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) && + ARGV.none?(/dsl/) + return +end + +# Gems. +require "connection_pool" + +# Package files. +require_relative "imagekitio/version" +require_relative "imagekitio/internal/util" +require_relative "imagekitio/internal/type/converter" +require_relative "imagekitio/internal/type/unknown" +require_relative "imagekitio/internal/type/boolean" +require_relative "imagekitio/internal/type/file_input" +require_relative "imagekitio/internal/type/enum" +require_relative "imagekitio/internal/type/union" +require_relative "imagekitio/internal/type/array_of" +require_relative "imagekitio/internal/type/hash_of" +require_relative "imagekitio/internal/type/base_model" +require_relative "imagekitio/internal/type/base_page" +require_relative "imagekitio/internal/type/request_parameters" +require_relative "imagekitio/internal" +require_relative "imagekitio/request_options" +require_relative "imagekitio/file_part" +require_relative "imagekitio/errors" +require_relative "imagekitio/internal/transport/base_client" +require_relative "imagekitio/internal/transport/pooled_net_requester" +require_relative "imagekitio/client" +require_relative "imagekitio/models/accounts/origin_request" +require_relative "imagekitio/models/accounts/url_endpoint_request" +require_relative "imagekitio/models/update_file_request" +require_relative "imagekitio/models/file" +require_relative "imagekitio/models/src_options" +require_relative "imagekitio/models/base_overlay" +require_relative "imagekitio/models/base_webhook_event" +require_relative "imagekitio/models/accounts/origin_create_params" +require_relative "imagekitio/models/accounts/origin_delete_params" +require_relative "imagekitio/models/accounts/origin_get_params" +require_relative "imagekitio/models/accounts/origin_list_params" +require_relative "imagekitio/models/accounts/origin_list_response" +require_relative "imagekitio/models/accounts/origin_response" +require_relative "imagekitio/models/accounts/origin_update_params" +require_relative "imagekitio/models/accounts/url_endpoint_create_params" +require_relative "imagekitio/models/accounts/url_endpoint_delete_params" +require_relative "imagekitio/models/accounts/url_endpoint_get_params" +require_relative "imagekitio/models/accounts/url_endpoint_list_params" +require_relative "imagekitio/models/accounts/url_endpoint_list_response" +require_relative "imagekitio/models/accounts/url_endpoint_response" +require_relative "imagekitio/models/accounts/url_endpoint_update_params" +require_relative "imagekitio/models/accounts/usage_get_params" +require_relative "imagekitio/models/accounts/usage_get_response" +require_relative "imagekitio/models/asset_list_params" +require_relative "imagekitio/models/asset_list_response" +require_relative "imagekitio/models/beta/v2/file_upload_params" +require_relative "imagekitio/models/beta/v2/file_upload_response" +require_relative "imagekitio/models/cache/invalidation_create_params" +require_relative "imagekitio/models/cache/invalidation_create_response" +require_relative "imagekitio/models/cache/invalidation_get_params" +require_relative "imagekitio/models/cache/invalidation_get_response" +require_relative "imagekitio/models/custom_metadata_field" +require_relative "imagekitio/models/custom_metadata_field_create_params" +require_relative "imagekitio/models/custom_metadata_field_delete_params" +require_relative "imagekitio/models/custom_metadata_field_delete_response" +require_relative "imagekitio/models/custom_metadata_field_list_params" +require_relative "imagekitio/models/custom_metadata_field_list_response" +require_relative "imagekitio/models/custom_metadata_field_update_params" +require_relative "imagekitio/models/extensions" +require_relative "imagekitio/models/file_copy_params" +require_relative "imagekitio/models/file_copy_response" +require_relative "imagekitio/models/file_delete_params" +require_relative "imagekitio/models/file_get_params" +require_relative "imagekitio/models/file_move_params" +require_relative "imagekitio/models/file_move_response" +require_relative "imagekitio/models/file_rename_params" +require_relative "imagekitio/models/file_rename_response" +require_relative "imagekitio/models/files/bulk_add_tags_params" +require_relative "imagekitio/models/files/bulk_add_tags_response" +require_relative "imagekitio/models/files/bulk_delete_params" +require_relative "imagekitio/models/files/bulk_delete_response" +require_relative "imagekitio/models/files/bulk_remove_ai_tags_params" +require_relative "imagekitio/models/files/bulk_remove_ai_tags_response" +require_relative "imagekitio/models/files/bulk_remove_tags_params" +require_relative "imagekitio/models/files/bulk_remove_tags_response" +require_relative "imagekitio/models/files/metadata_get_from_url_params" +require_relative "imagekitio/models/files/metadata_get_params" +require_relative "imagekitio/models/files/version_delete_params" +require_relative "imagekitio/models/files/version_delete_response" +require_relative "imagekitio/models/files/version_get_params" +require_relative "imagekitio/models/files/version_list_params" +require_relative "imagekitio/models/files/version_list_response" +require_relative "imagekitio/models/files/version_restore_params" +require_relative "imagekitio/models/file_update_params" +require_relative "imagekitio/models/file_update_response" +require_relative "imagekitio/models/file_upload_params" +require_relative "imagekitio/models/file_upload_response" +require_relative "imagekitio/models/folder" +require_relative "imagekitio/models/folder_copy_params" +require_relative "imagekitio/models/folder_copy_response" +require_relative "imagekitio/models/folder_create_params" +require_relative "imagekitio/models/folder_create_response" +require_relative "imagekitio/models/folder_delete_params" +require_relative "imagekitio/models/folder_delete_response" +require_relative "imagekitio/models/folder_move_params" +require_relative "imagekitio/models/folder_move_response" +require_relative "imagekitio/models/folder_rename_params" +require_relative "imagekitio/models/folder_rename_response" +require_relative "imagekitio/models/folders/job_get_params" +require_relative "imagekitio/models/folders/job_get_response" +require_relative "imagekitio/models/get_image_attributes_options" +require_relative "imagekitio/models/image_overlay" +require_relative "imagekitio/models/metadata" +require_relative "imagekitio/models/overlay" +require_relative "imagekitio/models/overlay_position" +require_relative "imagekitio/models/overlay_timing" +require_relative "imagekitio/models/responsive_image_attributes" +require_relative "imagekitio/models/solid_color_overlay" +require_relative "imagekitio/models/solid_color_overlay_transformation" +require_relative "imagekitio/models/streaming_resolution" +require_relative "imagekitio/models/subtitle_overlay" +require_relative "imagekitio/models/subtitle_overlay_transformation" +require_relative "imagekitio/models/text_overlay" +require_relative "imagekitio/models/text_overlay_transformation" +require_relative "imagekitio/models/transformation" +require_relative "imagekitio/models/transformation_position" +require_relative "imagekitio/models/unsafe_unwrap_webhook_event" +require_relative "imagekitio/models/unwrap_webhook_event" +require_relative "imagekitio/models/upload_post_transform_error_event" +require_relative "imagekitio/models/upload_post_transform_success_event" +require_relative "imagekitio/models/upload_pre_transform_error_event" +require_relative "imagekitio/models/upload_pre_transform_success_event" +require_relative "imagekitio/models/video_overlay" +require_relative "imagekitio/models/video_transformation_accepted_event" +require_relative "imagekitio/models/video_transformation_error_event" +require_relative "imagekitio/models/video_transformation_ready_event" +require_relative "imagekitio/models/webhook_unsafe_unwrap_params" +require_relative "imagekitio/models/webhook_unwrap_params" +require_relative "imagekitio/models" +require_relative "imagekitio/resources/accounts" +require_relative "imagekitio/resources/accounts/origins" +require_relative "imagekitio/resources/accounts/url_endpoints" +require_relative "imagekitio/resources/accounts/usage" +require_relative "imagekitio/resources/assets" +require_relative "imagekitio/resources/beta" +require_relative "imagekitio/resources/beta/v2" +require_relative "imagekitio/resources/beta/v2/files" +require_relative "imagekitio/resources/cache" +require_relative "imagekitio/resources/cache/invalidation" +require_relative "imagekitio/resources/custom_metadata_fields" +require_relative "imagekitio/resources/files" +require_relative "imagekitio/resources/files/bulk" +require_relative "imagekitio/resources/files/metadata" +require_relative "imagekitio/resources/files/versions" +require_relative "imagekitio/resources/folders" +require_relative "imagekitio/resources/folders/job" +require_relative "imagekitio/resources/webhooks" diff --git a/lib/imagekit/client.rb b/lib/imagekitio/client.rb similarity index 77% rename from lib/imagekit/client.rb rename to lib/imagekitio/client.rb index e3f5f7c3..3c779088 100644 --- a/lib/imagekit/client.rb +++ b/lib/imagekitio/client.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true -module Imagekit - class Client < Imagekit::Internal::Transport::BaseClient +module Imagekitio + class Client < Imagekitio::Internal::Transport::BaseClient # Default max number of retries to attempt after a failed retryable request. DEFAULT_MAX_RETRIES = 2 @@ -25,28 +25,28 @@ class Client < Imagekit::Internal::Transport::BaseClient # @return [String, nil] attr_reader :password - # @return [Imagekit::Resources::CustomMetadataFields] + # @return [Imagekitio::Resources::CustomMetadataFields] attr_reader :custom_metadata_fields - # @return [Imagekit::Resources::Files] + # @return [Imagekitio::Resources::Files] attr_reader :files - # @return [Imagekit::Resources::Assets] + # @return [Imagekitio::Resources::Assets] attr_reader :assets - # @return [Imagekit::Resources::Cache] + # @return [Imagekitio::Resources::Cache] attr_reader :cache - # @return [Imagekit::Resources::Folders] + # @return [Imagekitio::Resources::Folders] attr_reader :folders - # @return [Imagekit::Resources::Accounts] + # @return [Imagekitio::Resources::Accounts] attr_reader :accounts - # @return [Imagekit::Resources::Beta] + # @return [Imagekitio::Resources::Beta] attr_reader :beta - # @return [Imagekit::Resources::Webhooks] + # @return [Imagekitio::Resources::Webhooks] attr_reader :webhooks # @api private @@ -112,14 +112,14 @@ def initialize( max_retry_delay: max_retry_delay ) - @custom_metadata_fields = Imagekit::Resources::CustomMetadataFields.new(client: self) - @files = Imagekit::Resources::Files.new(client: self) - @assets = Imagekit::Resources::Assets.new(client: self) - @cache = Imagekit::Resources::Cache.new(client: self) - @folders = Imagekit::Resources::Folders.new(client: self) - @accounts = Imagekit::Resources::Accounts.new(client: self) - @beta = Imagekit::Resources::Beta.new(client: self) - @webhooks = Imagekit::Resources::Webhooks.new(client: self) + @custom_metadata_fields = Imagekitio::Resources::CustomMetadataFields.new(client: self) + @files = Imagekitio::Resources::Files.new(client: self) + @assets = Imagekitio::Resources::Assets.new(client: self) + @cache = Imagekitio::Resources::Cache.new(client: self) + @folders = Imagekitio::Resources::Folders.new(client: self) + @accounts = Imagekitio::Resources::Accounts.new(client: self) + @beta = Imagekitio::Resources::Beta.new(client: self) + @webhooks = Imagekitio::Resources::Webhooks.new(client: self) end end end diff --git a/lib/imagekit/errors.rb b/lib/imagekitio/errors.rb similarity index 77% rename from lib/imagekit/errors.rb rename to lib/imagekitio/errors.rb index 354509a3..ae3d200b 100644 --- a/lib/imagekit/errors.rb +++ b/lib/imagekitio/errors.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Errors class Error < StandardError # @!attribute cause @@ -8,7 +8,7 @@ class Error < StandardError # @return [StandardError, nil] end - class ConversionError < Imagekit::Errors::Error + class ConversionError < Imagekitio::Errors::Error # @return [StandardError, nil] def cause = @cause.nil? ? super : @cause @@ -33,7 +33,7 @@ def initialize(on:, method:, target:, value:, cause: nil) end end - class APIError < Imagekit::Errors::Error + class APIError < Imagekitio::Errors::Error # @return [URI::Generic] attr_accessor :url @@ -66,7 +66,7 @@ def initialize(url:, status: nil, headers: nil, body: nil, request: nil, respons end end - class APIConnectionError < Imagekit::Errors::APIError + class APIConnectionError < Imagekitio::Errors::APIError # @!attribute status # # @return [nil] @@ -97,7 +97,7 @@ def initialize( end end - class APITimeoutError < Imagekit::Errors::APIConnectionError + class APITimeoutError < Imagekitio::Errors::APIConnectionError # @api private # # @param url [URI::Generic] @@ -120,7 +120,7 @@ def initialize( end end - class APIStatusError < Imagekit::Errors::APIError + class APIStatusError < Imagekitio::Errors::APIError # @api private # # @param url [URI::Generic] @@ -146,23 +146,23 @@ def self.for(url:, status:, headers:, body:, request:, response:, message: nil) case status in 400 - Imagekit::Errors::BadRequestError.new(**kwargs) + Imagekitio::Errors::BadRequestError.new(**kwargs) in 401 - Imagekit::Errors::AuthenticationError.new(**kwargs) + Imagekitio::Errors::AuthenticationError.new(**kwargs) in 403 - Imagekit::Errors::PermissionDeniedError.new(**kwargs) + Imagekitio::Errors::PermissionDeniedError.new(**kwargs) in 404 - Imagekit::Errors::NotFoundError.new(**kwargs) + Imagekitio::Errors::NotFoundError.new(**kwargs) in 409 - Imagekit::Errors::ConflictError.new(**kwargs) + Imagekitio::Errors::ConflictError.new(**kwargs) in 422 - Imagekit::Errors::UnprocessableEntityError.new(**kwargs) + Imagekitio::Errors::UnprocessableEntityError.new(**kwargs) in 429 - Imagekit::Errors::RateLimitError.new(**kwargs) + Imagekitio::Errors::RateLimitError.new(**kwargs) in (500..) - Imagekit::Errors::InternalServerError.new(**kwargs) + Imagekitio::Errors::InternalServerError.new(**kwargs) else - Imagekit::Errors::APIStatusError.new(**kwargs) + Imagekitio::Errors::APIStatusError.new(**kwargs) end end @@ -193,35 +193,35 @@ def initialize(url:, status:, headers:, body:, request:, response:, message: nil end end - class BadRequestError < Imagekit::Errors::APIStatusError + class BadRequestError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 400 end - class AuthenticationError < Imagekit::Errors::APIStatusError + class AuthenticationError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 401 end - class PermissionDeniedError < Imagekit::Errors::APIStatusError + class PermissionDeniedError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 403 end - class NotFoundError < Imagekit::Errors::APIStatusError + class NotFoundError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 404 end - class ConflictError < Imagekit::Errors::APIStatusError + class ConflictError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 409 end - class UnprocessableEntityError < Imagekit::Errors::APIStatusError + class UnprocessableEntityError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 422 end - class RateLimitError < Imagekit::Errors::APIStatusError + class RateLimitError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 429 end - class InternalServerError < Imagekit::Errors::APIStatusError + class InternalServerError < Imagekitio::Errors::APIStatusError HTTP_STATUS = (500..) end end diff --git a/lib/imagekit/file_part.rb b/lib/imagekitio/file_part.rb similarity index 98% rename from lib/imagekit/file_part.rb rename to lib/imagekitio/file_part.rb index 2fbbc110..2856bd88 100644 --- a/lib/imagekit/file_part.rb +++ b/lib/imagekitio/file_part.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio class FilePart # @return [Pathname, StringIO, IO, String] attr_reader :content diff --git a/lib/imagekit/internal.rb b/lib/imagekitio/internal.rb similarity index 65% rename from lib/imagekit/internal.rb rename to lib/imagekitio/internal.rb index 450d18b1..129495a2 100644 --- a/lib/imagekit/internal.rb +++ b/lib/imagekitio/internal.rb @@ -1,12 +1,12 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport OMIT = Object.new.tap do - _1.define_singleton_method(:inspect) { "#<#{Imagekit::Internal}::OMIT>" } + _1.define_singleton_method(:inspect) { "#<#{Imagekitio::Internal}::OMIT>" } end .freeze @@ -14,7 +14,7 @@ module Internal T.type_alias { T::Hash[Symbol, T.anything] } end define_sorbet_constant!(:FileInput) do - T.type_alias { T.any(Pathname, StringIO, IO, String, Imagekit::FilePart) } + T.type_alias { T.any(Pathname, StringIO, IO, String, Imagekitio::FilePart) } end end end diff --git a/lib/imagekit/internal/transport/base_client.rb b/lib/imagekitio/internal/transport/base_client.rb similarity index 81% rename from lib/imagekit/internal/transport/base_client.rb rename to lib/imagekitio/internal/transport/base_client.rb index 222a48cf..6e613d49 100644 --- a/lib/imagekit/internal/transport/base_client.rb +++ b/lib/imagekitio/internal/transport/base_client.rb @@ -1,13 +1,13 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Transport # @api private # # @abstract class BaseClient - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport # from whatwg fetch spec MAX_REDIRECTS = 20 @@ -15,10 +15,10 @@ class BaseClient # rubocop:disable Style/MutableConstant PLATFORM_HEADERS = { - "x-stainless-arch" => Imagekit::Internal::Util.arch, + "x-stainless-arch" => Imagekitio::Internal::Util.arch, "x-stainless-lang" => "ruby", - "x-stainless-os" => Imagekit::Internal::Util.os, - "x-stainless-package-version" => Imagekit::VERSION, + "x-stainless-os" => Imagekitio::Internal::Util.os, + "x-stainless-package-version" => Imagekitio::VERSION, "x-stainless-runtime" => ::RUBY_ENGINE, "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION } @@ -51,7 +51,7 @@ def validate!(req) # # @return [Boolean] def should_retry?(status, headers:) - coerced = Imagekit::Internal::Util.coerce_boolean(headers["x-should-retry"]) + coerced = Imagekitio::Internal::Util.coerce_boolean(headers["x-should-retry"]) case [coerced, status] in [true | false, _] coerced @@ -95,7 +95,7 @@ def follow_redirect(request, status:, response_headers:) URI.join(url, response_headers["location"]) rescue ArgumentError message = "Server responded with status #{status} but no valid location header." - raise Imagekit::Errors::APIConnectionError.new( + raise Imagekitio::Errors::APIConnectionError.new( url: url, response: response_headers, message: message @@ -107,7 +107,7 @@ def follow_redirect(request, status:, response_headers:) case [url.scheme, location.scheme] in ["https", "http"] message = "Tried to redirect to a insecure URL" - raise Imagekit::Errors::APIConnectionError.new( + raise Imagekitio::Errors::APIConnectionError.new( url: url, response: response_headers, message: message @@ -130,7 +130,7 @@ def follow_redirect(request, status:, response_headers:) end # from undici - if Imagekit::Internal::Util.uri_origin(url) != Imagekit::Internal::Util.uri_origin(location) + if Imagekitio::Internal::Util.uri_origin(url) != Imagekitio::Internal::Util.uri_origin(location) drop = %w[authorization cookie host proxy-authorization] request = {**request, headers: request.fetch(:headers).except(*drop)} end @@ -140,14 +140,14 @@ def follow_redirect(request, status:, response_headers:) # @api private # - # @param status [Integer, Imagekit::Errors::APIConnectionError] + # @param status [Integer, Imagekitio::Errors::APIConnectionError] # @param stream [Enumerable, nil] def reap_connection!(status, stream:) case status in (..199) | (300..499) stream&.each { next } - in Imagekit::Errors::APIConnectionError | (500..) - Imagekit::Internal::Util.close_fused!(stream) + in Imagekitio::Errors::APIConnectionError | (500..) + Imagekitio::Internal::Util.close_fused!(stream) else end end @@ -175,7 +175,7 @@ def reap_connection!(status, stream:) attr_reader :idempotency_header # @api private - # @return [Imagekit::Internal::Transport::PooledNetRequester] + # @return [Imagekitio::Internal::Transport::PooledNetRequester] attr_reader :requester # @api private @@ -196,8 +196,8 @@ def initialize( headers: {}, idempotency_header: nil ) - @requester = Imagekit::Internal::Transport::PooledNetRequester.new - @headers = Imagekit::Internal::Util.normalized_headers( + @requester = Imagekitio::Internal::Transport::PooledNetRequester.new + @headers = Imagekitio::Internal::Util.normalized_headers( self.class::PLATFORM_HEADERS, { "accept" => "application/json", @@ -205,8 +205,8 @@ def initialize( }, headers ) - @base_url_components = Imagekit::Internal::Util.parse_uri(base_url) - @base_url = Imagekit::Internal::Util.unparse_uri(@base_url_components) + @base_url_components = Imagekitio::Internal::Util.parse_uri(base_url) + @base_url = Imagekitio::Internal::Util.unparse_uri(@base_url_components) @idempotency_header = idempotency_header&.to_s&.downcase @timeout = timeout @max_retries = max_retries @@ -240,11 +240,11 @@ def initialize( # # @option req [Symbol, Integer, Array, Proc, nil] :unwrap # - # @option req [Class, nil] :page + # @option req [Class, nil] :page # - # @option req [Class, nil] :stream + # @option req [Class, nil] :stream # - # @option req [Imagekit::Internal::Type::Converter, Class, nil] :model + # @option req [Imagekitio::Internal::Type::Converter, Class, nil] :model # # @param opts [Hash{Symbol=>Object}] . # @@ -264,11 +264,11 @@ def initialize( private def build_request(req, opts) method, uninterpolated_path = req.fetch_values(:method, :path) - path = Imagekit::Internal::Util.interpolate_path(uninterpolated_path) + path = Imagekitio::Internal::Util.interpolate_path(uninterpolated_path) - query = Imagekit::Internal::Util.deep_merge(req[:query].to_h, opts[:extra_query].to_h) + query = Imagekitio::Internal::Util.deep_merge(req[:query].to_h, opts[:extra_query].to_h) - headers = Imagekit::Internal::Util.normalized_headers( + headers = Imagekitio::Internal::Util.normalized_headers( @headers, auth_headers, req[:headers].to_h, @@ -297,14 +297,14 @@ def initialize( in :get | :head | :options | :trace nil else - Imagekit::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact) + Imagekitio::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact) end - url = Imagekit::Internal::Util.join_parsed_uri( + url = Imagekitio::Internal::Util.join_parsed_uri( @base_url_components, {**req, path: path, query: query} ) - headers, encoded = Imagekit::Internal::Util.encode_content(headers, body) + headers, encoded = Imagekitio::Internal::Util.encode_content(headers, body) { method: method, url: url, @@ -363,11 +363,11 @@ def initialize( # # @param send_retry_header [Boolean] # - # @raise [Imagekit::Errors::APIError] + # @raise [Imagekitio::Errors::APIError] # @return [Array(Integer, Net::HTTPResponse, Enumerable)] def send_request(request, redirect_count:, retry_count:, send_retry_header:) url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout) - input = {**request.except(:timeout), deadline: Imagekit::Internal::Util.monotonic_secs + timeout} + input = {**request.except(:timeout), deadline: Imagekitio::Internal::Util.monotonic_secs + timeout} if send_retry_header headers["x-stainless-retry-count"] = retry_count.to_s @@ -375,10 +375,10 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) begin status, response, stream = @requester.execute(input) - rescue Imagekit::Errors::APIConnectionError => e + rescue Imagekitio::Errors::APIConnectionError => e status = e end - headers = Imagekit::Internal::Util.normalized_headers(response&.each_header&.to_h) + headers = Imagekitio::Internal::Util.normalized_headers(response&.each_header&.to_h) case status in ..299 @@ -387,7 +387,7 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) self.class.reap_connection!(status, stream: stream) message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects." - raise Imagekit::Errors::APIConnectionError.new(url: url, response: response, message: message) + raise Imagekitio::Errors::APIConnectionError.new(url: url, response: response, message: message) in 300..399 self.class.reap_connection!(status, stream: stream) @@ -398,16 +398,16 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) retry_count: retry_count, send_retry_header: send_retry_header ) - in Imagekit::Errors::APIConnectionError if retry_count >= max_retries + in Imagekitio::Errors::APIConnectionError if retry_count >= max_retries raise status in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers) decoded = Kernel.then do - Imagekit::Internal::Util.decode_content(headers, stream: stream, suppress_error: true) + Imagekitio::Internal::Util.decode_content(headers, stream: stream, suppress_error: true) ensure self.class.reap_connection!(status, stream: stream) end - raise Imagekit::Errors::APIStatusError.for( + raise Imagekitio::Errors::APIStatusError.for( url: url, status: status, headers: headers, @@ -415,7 +415,7 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) request: nil, response: response ) - in (400..) | Imagekit::Errors::APIConnectionError + in (400..) | Imagekitio::Errors::APIConnectionError self.class.reap_connection!(status, stream: stream) delay = retry_delay(response || {}, retry_count: retry_count) @@ -433,7 +433,7 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) # Execute the request specified by `req`. This is the method that all resource # methods call into. # - # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Imagekit::Internal::Type::Unknown, options: {}) + # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Imagekitio::Internal::Type::Unknown, options: {}) # # @param method [Symbol] # @@ -447,13 +447,13 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) # # @param unwrap [Symbol, Integer, Array, Proc, nil] # - # @param page [Class, nil] + # @param page [Class, nil] # - # @param stream [Class, nil] + # @param stream [Class, nil] # - # @param model [Imagekit::Internal::Type::Converter, Class, nil] + # @param model [Imagekitio::Internal::Type::Converter, Class, nil] # - # @param options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] . + # @param options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] . # # @option options [String, nil] :idempotency_key # @@ -467,14 +467,14 @@ def send_request(request, redirect_count:, retry_count:, send_retry_header:) # # @option options [Float, nil] :timeout # - # @raise [Imagekit::Errors::APIError] + # @raise [Imagekitio::Errors::APIError] # @return [Object] def request(req) self.class.validate!(req) - model = req.fetch(:model) { Imagekit::Internal::Type::Unknown } + model = req.fetch(:model) { Imagekitio::Internal::Type::Unknown } opts = req[:options].to_h unwrap = req[:unwrap] - Imagekit::RequestOptions.validate!(opts) + Imagekitio::RequestOptions.validate!(opts) request = build_request(req.except(:options), opts) url = request.fetch(:url) @@ -487,8 +487,8 @@ def request(req) send_retry_header: send_retry_header ) - headers = Imagekit::Internal::Util.normalized_headers(response.each_header.to_h) - decoded = Imagekit::Internal::Util.decode_content(headers, stream: stream) + headers = Imagekitio::Internal::Util.normalized_headers(response.each_header.to_h) + decoded = Imagekitio::Internal::Util.decode_content(headers, stream: stream) case req in {stream: Class => st} st.new( @@ -503,8 +503,8 @@ def request(req) in {page: Class => page} page.new(client: self, req: req, headers: headers, page_data: decoded) else - unwrapped = Imagekit::Internal::Util.dig(decoded, unwrap) - Imagekit::Internal::Type::Converter.coerce(model, unwrapped) + unwrapped = Imagekitio::Internal::Util.dig(decoded, unwrap) + Imagekitio::Internal::Type::Converter.coerce(model, unwrapped) end end @@ -542,10 +542,10 @@ def inspect T.proc.params(arg0: T.anything).returns(T.anything) ) ), - page: T.nilable(T::Class[Imagekit::Internal::Type::BasePage[Imagekit::Internal::Type::BaseModel]]), + page: T.nilable(T::Class[Imagekitio::Internal::Type::BasePage[Imagekitio::Internal::Type::BaseModel]]), stream: T.nilable(T::Class[T.anything]), - model: T.nilable(Imagekit::Internal::Type::Converter::Input), - options: T.nilable(Imagekit::RequestOptions::OrHash) + model: T.nilable(Imagekitio::Internal::Type::Converter::Input), + options: T.nilable(Imagekitio::RequestOptions::OrHash) } end end diff --git a/lib/imagekit/internal/transport/pooled_net_requester.rb b/lib/imagekitio/internal/transport/pooled_net_requester.rb similarity index 88% rename from lib/imagekit/internal/transport/pooled_net_requester.rb rename to lib/imagekitio/internal/transport/pooled_net_requester.rb index 97f8a482..11f8ed7b 100644 --- a/lib/imagekit/internal/transport/pooled_net_requester.rb +++ b/lib/imagekitio/internal/transport/pooled_net_requester.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Transport # @api private class PooledNetRequester - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport # from the golang stdlib # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 @@ -41,7 +41,7 @@ def connect(url) # @param conn [Net::HTTP] # @param deadline [Float] def calibrate_socket_timeout(conn, deadline) - timeout = deadline - Imagekit::Internal::Util.monotonic_secs + timeout = deadline - Imagekitio::Internal::Util.monotonic_secs conn.open_timeout = conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout end @@ -75,13 +75,13 @@ def build_request(request, &blk) nil in String req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"] - req.body_stream = Imagekit::Internal::Util::ReadIOAdapter.new(body, &blk) + req.body_stream = Imagekitio::Internal::Util::ReadIOAdapter.new(body, &blk) in StringIO req["content-length"] ||= body.size.to_s unless req["transfer-encoding"] - req.body_stream = Imagekit::Internal::Util::ReadIOAdapter.new(body, &blk) + req.body_stream = Imagekitio::Internal::Util::ReadIOAdapter.new(body, &blk) in Pathname | IO | Enumerator req["transfer-encoding"] ||= "chunked" unless req["content-length"] - req.body_stream = Imagekit::Internal::Util::ReadIOAdapter.new(body, &blk) + req.body_stream = Imagekitio::Internal::Util::ReadIOAdapter.new(body, &blk) end [req, req.body_stream&.method(:close)] @@ -97,8 +97,8 @@ def build_request(request, &blk) # @raise [Timeout::Error] # @yieldparam [Net::HTTP] private def with_pool(url, deadline:, &blk) - origin = Imagekit::Internal::Util.uri_origin(url) - timeout = deadline - Imagekit::Internal::Util.monotonic_secs + origin = Imagekitio::Internal::Util.uri_origin(url) + timeout = deadline - Imagekitio::Internal::Util.monotonic_secs pool = @mutex.synchronize do @pools[origin] ||= ConnectionPool.new(size: @size) do @@ -172,14 +172,14 @@ def execute(request) end end rescue Timeout::Error - raise Imagekit::Errors::APITimeoutError.new(url: url, request: req) + raise Imagekitio::Errors::APITimeoutError.new(url: url, request: req) rescue StandardError - raise Imagekit::Errors::APIConnectionError.new(url: url, request: req) + raise Imagekitio::Errors::APIConnectionError.new(url: url, request: req) end # rubocop:enable Metrics/BlockLength _, response = enum.next - body = Imagekit::Internal::Util.fused_enum(enum, external: true) do + body = Imagekitio::Internal::Util.fused_enum(enum, external: true) do finished = true loop { enum.next } end diff --git a/lib/imagekit/internal/type/array_of.rb b/lib/imagekitio/internal/type/array_of.rb similarity index 81% rename from lib/imagekit/internal/type/array_of.rb rename to lib/imagekitio/internal/type/array_of.rb index 7e21f934..717f4aeb 100644 --- a/lib/imagekit/internal/type/array_of.rb +++ b/lib/imagekitio/internal/type/array_of.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -11,14 +11,14 @@ module Type # # Array of items of a given type. class ArrayOf - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport private_class_method :new # @overload [](type_info, spec = {}) # - # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] # # @param spec [Hash{Symbol=>Object}] . # @@ -47,7 +47,7 @@ def ===(other) = other.is_a?(Array) && other.all?(item_type) # @return [Boolean] def ==(other) # rubocop:disable Layout/LineLength - other.is_a?(Imagekit::Internal::Type::ArrayOf) && other.nilable? == nilable? && other.item_type == item_type + other.is_a?(Imagekitio::Internal::Type::ArrayOf) && other.nilable? == nilable? && other.item_type == item_type # rubocop:enable Layout/LineLength end @@ -91,7 +91,7 @@ def coerce(value, state:) exactness[:yes] += 1 nil else - Imagekit::Internal::Type::Converter.coerce(target, item, state: state) + Imagekitio::Internal::Type::Converter.coerce(target, item, state: state) end end end @@ -109,7 +109,7 @@ def dump(value, state:) target = item_type if value.is_a?(Array) value.map do - Imagekit::Internal::Type::Converter.dump(target, _1, state: state) + Imagekitio::Internal::Type::Converter.dump(target, _1, state: state) end else super @@ -120,7 +120,7 @@ def dump(value, state:) # # @return [Object] def to_sorbet_type - T::Array[Imagekit::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)] + T::Array[Imagekitio::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)] end # @api private @@ -135,7 +135,7 @@ def to_sorbet_type # @api private # - # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] # # @param spec [Hash{Symbol=>Object}] . # @@ -147,8 +147,8 @@ def to_sorbet_type # # @option spec [Boolean] :"nil?" def initialize(type_info, spec = {}) - @item_type_fn = Imagekit::Internal::Type::Converter.type_info(type_info || spec) - @meta = Imagekit::Internal::Type::Converter.meta_info(type_info, spec) + @item_type_fn = Imagekitio::Internal::Type::Converter.type_info(type_info || spec) + @meta = Imagekitio::Internal::Type::Converter.meta_info(type_info, spec) @nilable = spec.fetch(:nil?, false) end @@ -158,7 +158,7 @@ def initialize(type_info, spec = {}) # # @return [String] def inspect(depth: 0) - items = Imagekit::Internal::Type::Converter.inspect(item_type, depth: depth.succ) + items = Imagekitio::Internal::Type::Converter.inspect(item_type, depth: depth.succ) "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]" end diff --git a/lib/imagekit/internal/type/base_model.rb b/lib/imagekitio/internal/type/base_model.rb similarity index 84% rename from lib/imagekit/internal/type/base_model.rb rename to lib/imagekitio/internal/type/base_model.rb index 10b423c5..a7dd52d9 100644 --- a/lib/imagekit/internal/type/base_model.rb +++ b/lib/imagekitio/internal/type/base_model.rb @@ -1,12 +1,12 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @abstract class BaseModel - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport class << self # @api private @@ -14,7 +14,7 @@ class << self # Assumes superclass fields are totally defined before fields are accessed / # defined on subclasses. # - # @param child [Class] + # @param child [Class] def inherited(child) super child.known_fields.replace(known_fields.dup) @@ -40,7 +40,7 @@ def fields # # @param required [Boolean] # - # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] # # @param spec [Hash{Symbol=>Object}] . # @@ -52,19 +52,19 @@ def fields # # @option spec [Boolean] :"nil?" private def add_field(name_sym, required:, type_info:, spec:) - meta = Imagekit::Internal::Type::Converter.meta_info(type_info, spec) + meta = Imagekitio::Internal::Type::Converter.meta_info(type_info, spec) type_fn, info = case type_info - in Proc | Imagekit::Internal::Type::Converter | Class - [Imagekit::Internal::Type::Converter.type_info({**spec, union: type_info}), spec] + in Proc | Imagekitio::Internal::Type::Converter | Class + [Imagekitio::Internal::Type::Converter.type_info({**spec, union: type_info}), spec] in Hash - [Imagekit::Internal::Type::Converter.type_info(type_info), type_info] + [Imagekitio::Internal::Type::Converter.type_info(type_info), type_info] end setter = :"#{name_sym}=" api_name = info.fetch(:api_name, name_sym) nilable = info.fetch(:nil?, false) - const = required && !nilable ? info.fetch(:const, Imagekit::Internal::OMIT) : Imagekit::Internal::OMIT + const = required && !nilable ? info.fetch(:const, Imagekitio::Internal::OMIT) : Imagekitio::Internal::OMIT [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym) @@ -81,12 +81,12 @@ def fields define_method(setter) do |value| target = type_fn.call - state = Imagekit::Internal::Type::Converter.new_coerce_state(translate_names: false) - coerced = Imagekit::Internal::Type::Converter.coerce(target, value, state: state) + state = Imagekitio::Internal::Type::Converter.new_coerce_state(translate_names: false) + coerced = Imagekitio::Internal::Type::Converter.coerce(target, value, state: state) status = @coerced.store(name_sym, state.fetch(:error) || true) stored = case [target, status] - in [Imagekit::Internal::Type::Converter | Symbol, true] + in [Imagekitio::Internal::Type::Converter | Symbol, true] coerced else value @@ -100,10 +100,10 @@ def fields target = type_fn.call case @coerced[name_sym] - in true | false if Imagekit::Internal::Type::Converter === target + in true | false if Imagekitio::Internal::Type::Converter === target @data.fetch(name_sym) in ::StandardError => e - raise Imagekit::Errors::ConversionError.new( + raise Imagekitio::Errors::ConversionError.new( on: self.class, method: __method__, target: target, @@ -112,17 +112,17 @@ def fields ) else Kernel.then do - value = @data.fetch(name_sym) { const == Imagekit::Internal::OMIT ? nil : const } - state = Imagekit::Internal::Type::Converter.new_coerce_state(translate_names: false) + value = @data.fetch(name_sym) { const == Imagekitio::Internal::OMIT ? nil : const } + state = Imagekitio::Internal::Type::Converter.new_coerce_state(translate_names: false) if (nilable || !required) && value.nil? nil else - Imagekit::Internal::Type::Converter.coerce( + Imagekitio::Internal::Type::Converter.coerce( target, value, state: state ) end rescue StandardError => e - raise Imagekit::Errors::ConversionError.new( + raise Imagekitio::Errors::ConversionError.new( on: self.class, method: __method__, target: target, @@ -140,7 +140,7 @@ def fields # # @param name_sym [Symbol] # - # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] # # @param spec [Hash{Symbol=>Object}] . # @@ -159,7 +159,7 @@ def required(name_sym, type_info, spec = {}) # # @param name_sym [Symbol] # - # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] # # @param spec [Hash{Symbol=>Object}] . # @@ -205,7 +205,7 @@ def optional(name_sym, type_info, spec = {}) # # @return [Boolean] def ==(other) - other.is_a?(Class) && other <= Imagekit::Internal::Type::BaseModel && other.fields == fields + other.is_a?(Class) && other <= Imagekitio::Internal::Type::BaseModel && other.fields == fields end # @api public @@ -229,7 +229,7 @@ def hash = [self.class, @data].hash class << self # @api private # - # @param value [Imagekit::Internal::Type::BaseModel, Hash{Object=>Object}, Object] + # @param value [Imagekitio::Internal::Type::BaseModel, Hash{Object=>Object}, Object] # # @param state [Hash{Symbol=>Object}] . # @@ -252,7 +252,7 @@ def coerce(value, state:) return value end - unless (val = Imagekit::Internal::Util.coerce_hash(value)).is_a?(Hash) + unless (val = Imagekitio::Internal::Util.coerce_hash(value)).is_a?(Hash) exactness[:no] += 1 state[:error] = TypeError.new("#{value.class} can't be coerced into #{Hash}") return value @@ -271,7 +271,7 @@ def coerce(value, state:) src_name = state.fetch(:translate_names) ? api_name : name unless val.key?(src_name) - if required && mode != :dump && const == Imagekit::Internal::OMIT + if required && mode != :dump && const == Imagekitio::Internal::OMIT exactness[nilable ? :maybe : :no] += 1 else exactness[:yes] += 1 @@ -288,9 +288,9 @@ def coerce(value, state:) exactness[nilable ? :yes : :maybe] += 1 nil else - coerced = Imagekit::Internal::Type::Converter.coerce(target, item, state: state) + coerced = Imagekitio::Internal::Type::Converter.coerce(target, item, state: state) case target - in Imagekit::Internal::Type::Converter | Symbol + in Imagekitio::Internal::Type::Converter | Symbol coerced else item @@ -316,7 +316,7 @@ def coerce(value, state:) # # @return [Hash{Object=>Object}, Object] def dump(value, state:) - unless (coerced = Imagekit::Internal::Util.coerce_hash(value)).is_a?(Hash) + unless (coerced = Imagekitio::Internal::Util.coerce_hash(value)).is_a?(Hash) return super end @@ -334,14 +334,14 @@ def dump(value, state:) next else target = type_fn.call - acc.store(api_name, Imagekit::Internal::Type::Converter.dump(target, val, state: state)) + acc.store(api_name, Imagekitio::Internal::Type::Converter.dump(target, val, state: state)) end end end known_fields.each_value do |field| api_name, mode, const = field.fetch_values(:api_name, :mode, :const) - next if mode == :coerce || acc.key?(api_name) || const == Imagekit::Internal::OMIT + next if mode == :coerce || acc.key?(api_name) || const == Imagekitio::Internal::OMIT acc.store(api_name, const) end @@ -359,19 +359,19 @@ def to_sorbet_type class << self # @api private # - # @param model [Imagekit::Internal::Type::BaseModel] + # @param model [Imagekitio::Internal::Type::BaseModel] # @param convert [Boolean] # # @return [Hash{Symbol=>Object}] def recursively_to_h(model, convert:) rec = ->(x) do case x - in Imagekit::Internal::Type::BaseModel + in Imagekitio::Internal::Type::BaseModel if convert fields = x.class.known_fields x.to_h.to_h do |key, val| [key, rec.call(fields.key?(key) ? x.public_send(key) : val)] - rescue Imagekit::Errors::ConversionError + rescue Imagekitio::Errors::ConversionError [key, rec.call(val)] end else @@ -438,7 +438,7 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `base_overlay` is a `Imagekit::BaseOverlay` + # # `base_overlay` is a `Imagekitio::BaseOverlay` # base_overlay => { # position: position, # timing: timing @@ -460,14 +460,14 @@ def deconstruct_keys(keys) # @param a [Object] # # @return [String] - def to_json(*a) = Imagekit::Internal::Type::Converter.dump(self.class, self).to_json(*a) + def to_json(*a) = Imagekitio::Internal::Type::Converter.dump(self.class, self).to_json(*a) # @api public # # @param a [Object] # # @return [String] - def to_yaml(*a) = Imagekit::Internal::Type::Converter.dump(self.class, self).to_yaml(*a) + def to_yaml(*a) = Imagekitio::Internal::Type::Converter.dump(self.class, self).to_yaml(*a) # Create a new instance of a model. # @@ -475,7 +475,7 @@ def to_yaml(*a) = Imagekit::Internal::Type::Converter.dump(self.class, self).to_ def initialize(data = {}) @data = {} @coerced = {} - Imagekit::Internal::Util.coerce_hash!(data).each do + Imagekitio::Internal::Util.coerce_hash!(data).each do if self.class.known_fields.key?(_1) public_send(:"#{_1}=", _2) else @@ -498,7 +498,7 @@ def inspect(depth: 0) deferred = fields.transform_values do |field| type, required, nilable = field.fetch_values(:type, :required, :nilable) inspected = [ - Imagekit::Internal::Type::Converter.inspect(type, depth: depth), + Imagekitio::Internal::Type::Converter.inspect(type, depth: depth), !required || nilable ? "nil" : nil ].compact.join(" | ") -> { inspected }.tap { _1.define_singleton_method(:inspect) { call } } diff --git a/lib/imagekit/internal/type/base_page.rb b/lib/imagekitio/internal/type/base_page.rb similarity index 90% rename from lib/imagekit/internal/type/base_page.rb rename to lib/imagekitio/internal/type/base_page.rb index 37df829b..eb794d13 100644 --- a/lib/imagekit/internal/type/base_page.rb +++ b/lib/imagekitio/internal/type/base_page.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -18,7 +18,7 @@ def next_page? = (raise NotImplementedError) # @api public # - # @raise [Imagekit::Errors::APIError] + # @raise [Imagekitio::Errors::APIError] # @return [self] def next_page = (raise NotImplementedError) @@ -37,7 +37,7 @@ def to_enum = super(:auto_paging_each) # @api private # - # @param client [Imagekit::Internal::Transport::BaseClient] + # @param client [Imagekitio::Internal::Transport::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}] # @param page_data [Object] diff --git a/lib/imagekit/internal/type/boolean.rb b/lib/imagekitio/internal/type/boolean.rb similarity index 91% rename from lib/imagekit/internal/type/boolean.rb rename to lib/imagekitio/internal/type/boolean.rb index 52ecc971..6884a060 100644 --- a/lib/imagekit/internal/type/boolean.rb +++ b/lib/imagekitio/internal/type/boolean.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -9,8 +9,8 @@ module Type # # Ruby has no Boolean class; this is something for models to refer to. class Boolean - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport private_class_method :new @@ -26,7 +26,7 @@ def self.===(other) = other == true || other == false # @param other [Object] # # @return [Boolean] - def self.==(other) = other.is_a?(Class) && other <= Imagekit::Internal::Type::Boolean + def self.==(other) = other.is_a?(Class) && other <= Imagekitio::Internal::Type::Boolean class << self # @api private diff --git a/lib/imagekit/internal/type/converter.rb b/lib/imagekitio/internal/type/converter.rb similarity index 87% rename from lib/imagekit/internal/type/converter.rb rename to lib/imagekitio/internal/type/converter.rb index 90a839c6..486ce9bc 100644 --- a/lib/imagekit/internal/type/converter.rb +++ b/lib/imagekitio/internal/type/converter.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private module Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport # rubocop:disable Lint/UnusedMethodArgument @@ -40,17 +40,17 @@ def coerce(value, state:) = (raise NotImplementedError) def dump(value, state:) case value in Array - value.map { Imagekit::Internal::Type::Unknown.dump(_1, state: state) } + value.map { Imagekitio::Internal::Type::Unknown.dump(_1, state: state) } in Hash - value.transform_values { Imagekit::Internal::Type::Unknown.dump(_1, state: state) } - in Imagekit::Internal::Type::BaseModel + value.transform_values { Imagekitio::Internal::Type::Unknown.dump(_1, state: state) } + in Imagekitio::Internal::Type::BaseModel value.class.dump(value, state: state) in StringIO value.string in Pathname | IO state[:can_retry] = false if value.is_a?(IO) - Imagekit::FilePart.new(value) - in Imagekit::FilePart + Imagekitio::FilePart.new(value) + in Imagekitio::FilePart state[:can_retry] = false if value.content.is_a?(IO) value else @@ -72,7 +72,7 @@ def inspect(depth: 0) class << self # @api private # - # @param spec [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] . + # @param spec [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] . # # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const # @@ -90,8 +90,8 @@ def type_info(spec) in Hash type_info(spec.slice(:const, :enum, :union).first&.last) in true | false - -> { Imagekit::Internal::Type::Boolean } - in Imagekit::Internal::Type::Converter | Class | Symbol + -> { Imagekitio::Internal::Type::Boolean } + in Imagekitio::Internal::Type::Converter | Class | Symbol -> { spec } in NilClass | Integer | Float -> { spec.class } @@ -100,7 +100,7 @@ def type_info(spec) # @api private # - # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] . + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] . # # @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const # @@ -110,7 +110,7 @@ def type_info(spec) # # @option type_info [Boolean] :"nil?" # - # @param spec [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] . + # @param spec [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] . # # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const # @@ -152,7 +152,7 @@ def new_coerce_state(translate_names: true) # The coercion process is subject to improvement between minor release versions. # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode # - # @param target [Imagekit::Internal::Type::Converter, Class] + # @param target [Imagekitio::Internal::Type::Converter, Class] # # @param value [Object] # @@ -184,12 +184,12 @@ def new_coerce_state(translate_names: true) # @option state [Integer] :branched # # @return [Object] - def coerce(target, value, state: Imagekit::Internal::Type::Converter.new_coerce_state) + def coerce(target, value, state: Imagekitio::Internal::Type::Converter.new_coerce_state) # rubocop:disable Metrics/BlockNesting exactness = state.fetch(:exactness) case target - in Imagekit::Internal::Type::Converter + in Imagekitio::Internal::Type::Converter return target.coerce(value, state: state) in Class if value.is_a?(target) @@ -270,7 +270,7 @@ def coerce(target, value, state: Imagekit::Internal::Type::Converter.new_coerce_ # @api private # - # @param target [Imagekit::Internal::Type::Converter, Class] + # @param target [Imagekitio::Internal::Type::Converter, Class] # # @param value [Object] # @@ -281,10 +281,10 @@ def coerce(target, value, state: Imagekit::Internal::Type::Converter.new_coerce_ # @return [Object] def dump(target, value, state: {can_retry: true}) case target - in Imagekit::Internal::Type::Converter + in Imagekitio::Internal::Type::Converter target.dump(value, state: state) else - Imagekit::Internal::Type::Unknown.dump(value, state: state) + Imagekitio::Internal::Type::Unknown.dump(value, state: state) end end @@ -296,7 +296,7 @@ def dump(target, value, state: {can_retry: true}) # @return [String] def inspect(target, depth:) case target - in Imagekit::Internal::Type::Converter + in Imagekitio::Internal::Type::Converter target.inspect(depth: depth.succ) else target.inspect @@ -305,7 +305,7 @@ def inspect(target, depth:) end define_sorbet_constant!(:Input) do - T.type_alias { T.any(Imagekit::Internal::Type::Converter, T::Class[T.anything]) } + T.type_alias { T.any(Imagekitio::Internal::Type::Converter, T::Class[T.anything]) } end define_sorbet_constant!(:CoerceState) do T.type_alias do diff --git a/lib/imagekit/internal/type/enum.rb b/lib/imagekitio/internal/type/enum.rb similarity index 83% rename from lib/imagekit/internal/type/enum.rb rename to lib/imagekitio/internal/type/enum.rb index f8cfca79..8bc0591f 100644 --- a/lib/imagekit/internal/type/enum.rb +++ b/lib/imagekitio/internal/type/enum.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -17,13 +17,13 @@ module Type # values safely. # # @example - # # `streaming_resolution` is a `Imagekit::StreamingResolution` + # # `streaming_resolution` is a `Imagekitio::StreamingResolution` # case streaming_resolution - # when Imagekit::StreamingResolution::STREAMING_RESOLUTION_240 + # when Imagekitio::StreamingResolution::STREAMING_RESOLUTION_240 # # ... - # when Imagekit::StreamingResolution::STREAMING_RESOLUTION_360 + # when Imagekitio::StreamingResolution::STREAMING_RESOLUTION_360 # # ... - # when Imagekit::StreamingResolution::STREAMING_RESOLUTION_480 + # when Imagekitio::StreamingResolution::STREAMING_RESOLUTION_480 # # ... # else # puts(streaming_resolution) @@ -41,8 +41,8 @@ module Type # puts(streaming_resolution) # end module Enum - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport # All of the valid Symbol values for this enum. # @@ -63,7 +63,7 @@ def ===(other) = values.include?(other) # @return [Boolean] def ==(other) # rubocop:disable Style/CaseEquality - Imagekit::Internal::Type::Enum === other && other.values.to_set == values.to_set + Imagekitio::Internal::Type::Enum === other && other.values.to_set == values.to_set # rubocop:enable Style/CaseEquality end @@ -124,7 +124,7 @@ def coerce(value, state:) # # @return [Object] def to_sorbet_type - types = values.map { Imagekit::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq + types = values.map { Imagekitio::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq case types in [] T.noreturn @@ -145,7 +145,7 @@ def inspect(depth: 0) return is_a?(Module) ? super() : self.class.name end - members = values.map { Imagekit::Internal::Type::Converter.inspect(_1, depth: depth.succ) } + members = values.map { Imagekitio::Internal::Type::Converter.inspect(_1, depth: depth.succ) } prefix = is_a?(Module) ? name : self.class.name "#{prefix}[#{members.join(' | ')}]" diff --git a/lib/imagekit/internal/type/file_input.rb b/lib/imagekitio/internal/type/file_input.rb similarity index 83% rename from lib/imagekit/internal/type/file_input.rb rename to lib/imagekitio/internal/type/file_input.rb index 0a2dd463..ef9455d9 100644 --- a/lib/imagekit/internal/type/file_input.rb +++ b/lib/imagekitio/internal/type/file_input.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -8,12 +8,12 @@ module Type # @abstract # # Either `Pathname` or `StringIO`, or `IO`, or - # `Imagekit::Internal::Type::FileInput`. + # `Imagekitio::Internal::Type::FileInput`. # # Note: when `IO` is used, all retries are disabled, since many IO` streams are # not rewindable. class FileInput - extend Imagekit::Internal::Type::Converter + extend Imagekitio::Internal::Type::Converter private_class_method :new @@ -24,7 +24,7 @@ class FileInput # @return [Boolean] def self.===(other) case other - in Pathname | StringIO | IO | String | Imagekit::FilePart + in Pathname | StringIO | IO | String | Imagekitio::FilePart true else false @@ -36,7 +36,7 @@ def self.===(other) # @param other [Object] # # @return [Boolean] - def self.==(other) = other.is_a?(Class) && other <= Imagekit::Internal::Type::FileInput + def self.==(other) = other.is_a?(Class) && other <= Imagekitio::Internal::Type::FileInput class << self # @api private @@ -86,11 +86,11 @@ def dump(value, state:) in StringIO | String # https://datatracker.ietf.org/doc/html/rfc7578#section-4.2 # while not required, a filename is recommended, and in practice many servers do expect this - Imagekit::FilePart.new(value, filename: "upload") + Imagekitio::FilePart.new(value, filename: "upload") in IO state[:can_retry] = false - value.to_path.nil? ? Imagekit::FilePart.new(value, filename: "upload") : value - in Imagekit::FilePart if value.content.is_a?(IO) + value.to_path.nil? ? Imagekitio::FilePart.new(value, filename: "upload") : value + in Imagekitio::FilePart if value.content.is_a?(IO) state[:can_retry] = false value else @@ -102,7 +102,7 @@ def dump(value, state:) # # @return [Object] def to_sorbet_type - T.any(Pathname, StringIO, IO, String, Imagekit::FilePart) + T.any(Pathname, StringIO, IO, String, Imagekitio::FilePart) end end end diff --git a/lib/imagekit/internal/type/hash_of.rb b/lib/imagekitio/internal/type/hash_of.rb similarity index 83% rename from lib/imagekit/internal/type/hash_of.rb rename to lib/imagekitio/internal/type/hash_of.rb index 20a0aa22..aca1e07f 100644 --- a/lib/imagekit/internal/type/hash_of.rb +++ b/lib/imagekitio/internal/type/hash_of.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -11,14 +11,14 @@ module Type # # Hash of items of a given type. class HashOf - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport private_class_method :new # @overload [](type_info, spec = {}) # - # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] # # @param spec [Hash{Symbol=>Object}] . # @@ -62,7 +62,7 @@ def ===(other) # @return [Boolean] def ==(other) # rubocop:disable Layout/LineLength - other.is_a?(Imagekit::Internal::Type::HashOf) && other.nilable? == nilable? && other.item_type == item_type + other.is_a?(Imagekitio::Internal::Type::HashOf) && other.nilable? == nilable? && other.item_type == item_type # rubocop:enable Layout/LineLength end @@ -108,7 +108,7 @@ def coerce(value, state:) exactness[:yes] += 1 nil else - Imagekit::Internal::Type::Converter.coerce(target, val, state: state) + Imagekitio::Internal::Type::Converter.coerce(target, val, state: state) end exactness[:no] += 1 unless k.is_a?(Symbol) @@ -129,7 +129,7 @@ def dump(value, state:) target = item_type if value.is_a?(Hash) value.transform_values do - Imagekit::Internal::Type::Converter.dump(target, _1, state: state) + Imagekitio::Internal::Type::Converter.dump(target, _1, state: state) end else super @@ -140,7 +140,7 @@ def dump(value, state:) # # @return [Object] def to_sorbet_type - T::Hash[Imagekit::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)] + T::Hash[Imagekitio::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)] end # @api private @@ -155,7 +155,7 @@ def to_sorbet_type # @api private # - # @param type_info [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # @param type_info [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] # # @param spec [Hash{Symbol=>Object}] . # @@ -167,8 +167,8 @@ def to_sorbet_type # # @option spec [Boolean] :"nil?" def initialize(type_info, spec = {}) - @item_type_fn = Imagekit::Internal::Type::Converter.type_info(type_info || spec) - @meta = Imagekit::Internal::Type::Converter.meta_info(type_info, spec) + @item_type_fn = Imagekitio::Internal::Type::Converter.type_info(type_info || spec) + @meta = Imagekitio::Internal::Type::Converter.meta_info(type_info, spec) @nilable = spec.fetch(:nil?, false) end @@ -178,7 +178,7 @@ def initialize(type_info, spec = {}) # # @return [String] def inspect(depth: 0) - items = Imagekit::Internal::Type::Converter.inspect(item_type, depth: depth.succ) + items = Imagekitio::Internal::Type::Converter.inspect(item_type, depth: depth.succ) "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]" end diff --git a/lib/imagekit/internal/type/request_parameters.rb b/lib/imagekitio/internal/type/request_parameters.rb similarity index 72% rename from lib/imagekit/internal/type/request_parameters.rb rename to lib/imagekitio/internal/type/request_parameters.rb index 73dff299..f1df8941 100644 --- a/lib/imagekit/internal/type/request_parameters.rb +++ b/lib/imagekitio/internal/type/request_parameters.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -8,13 +8,13 @@ module RequestParameters # @!attribute request_options # Options to specify HTTP behaviour for this request. # - # @return [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @return [Imagekitio::RequestOptions, Hash{Symbol=>Object}] # @param mod [Module] def self.included(mod) - raise ArgumentError.new(mod) unless mod <= Imagekit::Internal::Type::BaseModel + raise ArgumentError.new(mod) unless mod <= Imagekitio::Internal::Type::BaseModel - mod.optional(:request_options, Imagekit::RequestOptions) + mod.optional(:request_options, Imagekitio::RequestOptions) end # @api private @@ -28,7 +28,7 @@ def dump_request(params) state = {can_retry: true} case (dumped = dump(params, state: state)) in Hash - options = Imagekit::Internal::Util.coerce_hash!(dumped[:request_options]).to_h + options = Imagekitio::Internal::Util.coerce_hash!(dumped[:request_options]).to_h request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0} [dumped.except(:request_options), request_options] else diff --git a/lib/imagekit/internal/type/union.rb b/lib/imagekitio/internal/type/union.rb similarity index 77% rename from lib/imagekit/internal/type/union.rb rename to lib/imagekitio/internal/type/union.rb index 56cb34b1..47fdfd0b 100644 --- a/lib/imagekit/internal/type/union.rb +++ b/lib/imagekitio/internal/type/union.rb @@ -1,25 +1,25 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private # # @example - # # `overlay` is a `Imagekit::Overlay` + # # `overlay` is a `Imagekitio::Overlay` # case overlay - # when Imagekit::TextOverlay + # when Imagekitio::TextOverlay # # ... - # when Imagekit::ImageOverlay + # when Imagekitio::ImageOverlay # # ... - # when Imagekit::VideoOverlay + # when Imagekitio::VideoOverlay # # ... # else # puts(overlay) # end module Union - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport # @api private # @@ -52,9 +52,9 @@ def variants = derefed_variants.map { _2 } # @api private # - # @param key [Symbol, Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] + # @param key [Symbol, Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] # - # @param spec [Hash{Symbol=>Object}, Proc, Imagekit::Internal::Type::Converter, Class] . + # @param spec [Hash{Symbol=>Object}, Proc, Imagekitio::Internal::Type::Converter, Class] . # # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const # @@ -64,13 +64,13 @@ def variants = derefed_variants.map { _2 } # # @option spec [Boolean] :"nil?" private def variant(key, spec = nil) - meta = Imagekit::Internal::Type::Converter.meta_info(nil, spec) + meta = Imagekitio::Internal::Type::Converter.meta_info(nil, spec) variant_info = case key in Symbol - [key, Imagekit::Internal::Type::Converter.type_info(spec), meta] - in Proc | Imagekit::Internal::Type::Converter | Class | Hash - [nil, Imagekit::Internal::Type::Converter.type_info(key), meta] + [key, Imagekitio::Internal::Type::Converter.type_info(spec), meta] + in Proc | Imagekitio::Internal::Type::Converter | Class | Hash + [nil, Imagekitio::Internal::Type::Converter.type_info(key), meta] end known_variants << variant_info @@ -80,17 +80,17 @@ def variants = derefed_variants.map { _2 } # # @param value [Object] # - # @return [Imagekit::Internal::Type::Converter, Class, nil] + # @return [Imagekitio::Internal::Type::Converter, Class, nil] private def resolve_variant(value) case [@discriminator, value] - in [_, Imagekit::Internal::Type::BaseModel] + in [_, Imagekitio::Internal::Type::BaseModel] value.class in [Symbol, Hash] key = value.fetch(@discriminator) do - value.fetch(@discriminator.to_s, Imagekit::Internal::OMIT) + value.fetch(@discriminator.to_s, Imagekitio::Internal::OMIT) end - return nil if key == Imagekit::Internal::OMIT + return nil if key == Imagekitio::Internal::OMIT key = key.to_sym if key.is_a?(String) _, found = known_variants.find { |k,| k == key } @@ -120,7 +120,7 @@ def ===(other) # # @return [Boolean] def ==(other) - Imagekit::Internal::Type::Union === other && other.derefed_variants == derefed_variants + Imagekitio::Internal::Type::Union === other && other.derefed_variants == derefed_variants end # @api public @@ -152,7 +152,7 @@ def hash = variants.hash # @return [Object] def coerce(value, state:) if (target = resolve_variant(value)) - return Imagekit::Internal::Type::Converter.coerce(target, value, state: state) + return Imagekitio::Internal::Type::Converter.coerce(target, value, state: state) end strictness = state.fetch(:strictness) @@ -164,7 +164,7 @@ def coerce(value, state:) exact = state[:exactness] = {yes: 0, no: 0, maybe: 0} state[:branched] += 1 - coerced = Imagekit::Internal::Type::Converter.coerce(target, value, state: state) + coerced = Imagekitio::Internal::Type::Converter.coerce(target, value, state: state) yes, no, maybe = exact.values if (no + maybe).zero? || (!strictness && yes.positive?) exact.each { exactness[_1] += _2 } @@ -200,12 +200,12 @@ def coerce(value, state:) # @return [Object] def dump(value, state:) if (target = resolve_variant(value)) - return Imagekit::Internal::Type::Converter.dump(target, value, state: state) + return Imagekitio::Internal::Type::Converter.dump(target, value, state: state) end known_variants.each do target = _2.call - return Imagekit::Internal::Type::Converter.dump(target, value, state: state) if target === value + return Imagekitio::Internal::Type::Converter.dump(target, value, state: state) if target === value end super @@ -215,7 +215,7 @@ def dump(value, state:) # # @return [Object] def to_sorbet_type - types = variants.map { Imagekit::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq + types = variants.map { Imagekitio::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq case types in [] T.noreturn @@ -239,7 +239,7 @@ def inspect(depth: 0) return is_a?(Module) ? super() : self.class.name end - members = variants.map { Imagekit::Internal::Type::Converter.inspect(_1, depth: depth.succ) } + members = variants.map { Imagekitio::Internal::Type::Converter.inspect(_1, depth: depth.succ) } prefix = is_a?(Module) ? name : self.class.name "#{prefix}[#{members.join(' | ')}]" diff --git a/lib/imagekit/internal/type/unknown.rb b/lib/imagekitio/internal/type/unknown.rb similarity index 91% rename from lib/imagekit/internal/type/unknown.rb rename to lib/imagekitio/internal/type/unknown.rb index 43a4573a..3dbe1d59 100644 --- a/lib/imagekit/internal/type/unknown.rb +++ b/lib/imagekitio/internal/type/unknown.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -9,8 +9,8 @@ module Type # # When we don't know what to expect for the value. class Unknown - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport # rubocop:disable Lint/UnusedMethodArgument @@ -28,7 +28,7 @@ def self.===(other) = true # @param other [Object] # # @return [Boolean] - def self.==(other) = other.is_a?(Class) && other <= Imagekit::Internal::Type::Unknown + def self.==(other) = other.is_a?(Class) && other <= Imagekitio::Internal::Type::Unknown class << self # @api private diff --git a/lib/imagekit/internal/util.rb b/lib/imagekitio/internal/util.rb similarity index 96% rename from lib/imagekit/internal/util.rb rename to lib/imagekitio/internal/util.rb index 77725027..77125eca 100644 --- a/lib/imagekit/internal/util.rb +++ b/lib/imagekitio/internal/util.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Internal # @api private module Util @@ -157,7 +157,7 @@ def coerce_hash!(input) in Hash | nil => coerced coerced else - message = "Expected a #{Hash} or #{Imagekit::Internal::Type::BaseModel}, got #{data.inspect}" + message = "Expected a #{Hash} or #{Imagekitio::Internal::Type::BaseModel}, got #{data.inspect}" raise ArgumentError.new(message) end end @@ -396,7 +396,7 @@ def close? = @closing def close case @stream in Enumerator - Imagekit::Internal::Util.close_fused!(@stream) + Imagekitio::Internal::Util.close_fused!(@stream) in IO if close? @stream.close else @@ -500,7 +500,7 @@ class << self content_line = "Content-Type: %s\r\n\r\n" case val - in Imagekit::FilePart + in Imagekitio::FilePart return write_multipart_content( y, val: val.content, @@ -545,7 +545,7 @@ class << self end case val - in Imagekit::FilePart unless val.filename.nil? + in Imagekitio::FilePart unless val.filename.nil? filename = ERB::Util.url_encode(val.filename) y << "; filename=\"#{filename}\"" in Pathname | IO @@ -604,11 +604,11 @@ def encode_content(headers, body) # rubocop:disable Layout/LineLength content_type = headers["content-type"] case [content_type, body] - in [Imagekit::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }] + in [Imagekitio::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }] [headers, JSON.generate(body)] - in [Imagekit::Internal::Util::JSONL_CONTENT, Enumerable] unless Imagekit::Internal::Type::FileInput === body + in [Imagekitio::Internal::Util::JSONL_CONTENT, Enumerable] unless Imagekitio::Internal::Type::FileInput === body [headers, body.lazy.map { JSON.generate(_1) }] - in [%r{^multipart/form-data}, Hash | Imagekit::Internal::Type::FileInput] + in [%r{^multipart/form-data}, Hash | Imagekitio::Internal::Type::FileInput] boundary, strio = encode_multipart_streaming(body) headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"} [headers, strio] @@ -616,7 +616,7 @@ def encode_content(headers, body) [headers, body.to_s] in [_, StringIO] [headers, body.string] - in [_, Imagekit::FilePart] + in [_, Imagekitio::FilePart] [headers, body.content] else [headers, body] @@ -656,7 +656,7 @@ def force_charset!(content_type, text:) # @return [Object] def decode_content(headers, stream:, suppress_error: false) case (content_type = headers["content-type"]) - in Imagekit::Internal::Util::JSON_CONTENT + in Imagekitio::Internal::Util::JSON_CONTENT json = stream.to_a.join begin JSON.parse(json, symbolize_names: true) @@ -664,7 +664,7 @@ def decode_content(headers, stream:, suppress_error: false) raise e unless suppress_error json end - in Imagekit::Internal::Util::JSONL_CONTENT + in Imagekitio::Internal::Util::JSONL_CONTENT lines = decode_lines(stream) chain_fused(lines) do |y| lines.each { y << JSON.parse(_1, symbolize_names: true) } @@ -868,12 +868,12 @@ def to_sorbet_type = raise NotImplementedError class << self # @api private # - # @param type [Imagekit::Internal::Util::SorbetRuntimeSupport, Object] + # @param type [Imagekitio::Internal::Util::SorbetRuntimeSupport, Object] # # @return [Object] def to_sorbet_type(type) case type - in Imagekit::Internal::Util::SorbetRuntimeSupport + in Imagekitio::Internal::Util::SorbetRuntimeSupport type.to_sorbet_type in Class | Module type @@ -886,7 +886,7 @@ def to_sorbet_type(type) end end - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport define_sorbet_constant!(:ParsedUri) do T.type_alias do diff --git a/lib/imagekitio/models.rb b/lib/imagekitio/models.rb new file mode 100644 index 00000000..06ffc0cf --- /dev/null +++ b/lib/imagekitio/models.rb @@ -0,0 +1,160 @@ +# frozen_string_literal: true + +module Imagekitio + [Imagekitio::Internal::Type::BaseModel, *Imagekitio::Internal::Type::BaseModel.subclasses].each do |cls| + cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Imagekitio::Internal::AnyHash) } } + end + + Imagekitio::Internal::Util.walk_namespaces(Imagekitio::Models).each do |mod| + case mod + in Imagekitio::Internal::Type::Enum | Imagekitio::Internal::Type::Union + mod.constants.each do |name| + case mod.const_get(name) + in true | false + mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } } + mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } } + in Integer + mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } } + mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } } + in Float + mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } } + mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } } + in Symbol + mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } } + mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } } + else + end + end + else + end + end + + Imagekitio::Internal::Util.walk_namespaces(Imagekitio::Models) + .lazy + .grep(Imagekitio::Internal::Type::Union) + .each do |mod| + const = :Variants + next if mod.sorbet_constant_defined?(const) + + mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } } + end + + Accounts = Imagekitio::Models::Accounts + + AssetListParams = Imagekitio::Models::AssetListParams + + BaseOverlay = Imagekitio::Models::BaseOverlay + + BaseWebhookEvent = Imagekitio::Models::BaseWebhookEvent + + Beta = Imagekitio::Models::Beta + + Cache = Imagekitio::Models::Cache + + CustomMetadataField = Imagekitio::Models::CustomMetadataField + + CustomMetadataFieldCreateParams = Imagekitio::Models::CustomMetadataFieldCreateParams + + CustomMetadataFieldDeleteParams = Imagekitio::Models::CustomMetadataFieldDeleteParams + + CustomMetadataFieldListParams = Imagekitio::Models::CustomMetadataFieldListParams + + CustomMetadataFieldUpdateParams = Imagekitio::Models::CustomMetadataFieldUpdateParams + + ExtensionItem = Imagekitio::Models::ExtensionItem + + # @type [Imagekitio::Internal::Type::Converter] + Extensions = Imagekitio::Models::Extensions + + File = Imagekitio::Models::File + + FileCopyParams = Imagekitio::Models::FileCopyParams + + FileDeleteParams = Imagekitio::Models::FileDeleteParams + + FileGetParams = Imagekitio::Models::FileGetParams + + FileMoveParams = Imagekitio::Models::FileMoveParams + + FileRenameParams = Imagekitio::Models::FileRenameParams + + Files = Imagekitio::Models::Files + + FileUpdateParams = Imagekitio::Models::FileUpdateParams + + FileUploadParams = Imagekitio::Models::FileUploadParams + + Folder = Imagekitio::Models::Folder + + FolderCopyParams = Imagekitio::Models::FolderCopyParams + + FolderCreateParams = Imagekitio::Models::FolderCreateParams + + FolderDeleteParams = Imagekitio::Models::FolderDeleteParams + + FolderMoveParams = Imagekitio::Models::FolderMoveParams + + FolderRenameParams = Imagekitio::Models::FolderRenameParams + + Folders = Imagekitio::Models::Folders + + GetImageAttributesOptions = Imagekitio::Models::GetImageAttributesOptions + + ImageOverlay = Imagekitio::Models::ImageOverlay + + Metadata = Imagekitio::Models::Metadata + + Overlay = Imagekitio::Models::Overlay + + OverlayPosition = Imagekitio::Models::OverlayPosition + + OverlayTiming = Imagekitio::Models::OverlayTiming + + ResponsiveImageAttributes = Imagekitio::Models::ResponsiveImageAttributes + + SolidColorOverlay = Imagekitio::Models::SolidColorOverlay + + SolidColorOverlayTransformation = Imagekitio::Models::SolidColorOverlayTransformation + + SrcOptions = Imagekitio::Models::SrcOptions + + StreamingResolution = Imagekitio::Models::StreamingResolution + + SubtitleOverlay = Imagekitio::Models::SubtitleOverlay + + SubtitleOverlayTransformation = Imagekitio::Models::SubtitleOverlayTransformation + + TextOverlay = Imagekitio::Models::TextOverlay + + TextOverlayTransformation = Imagekitio::Models::TextOverlayTransformation + + Transformation = Imagekitio::Models::Transformation + + TransformationPosition = Imagekitio::Models::TransformationPosition + + UnsafeUnwrapWebhookEvent = Imagekitio::Models::UnsafeUnwrapWebhookEvent + + UnwrapWebhookEvent = Imagekitio::Models::UnwrapWebhookEvent + + UpdateFileRequest = Imagekitio::Models::UpdateFileRequest + + UploadPostTransformErrorEvent = Imagekitio::Models::UploadPostTransformErrorEvent + + UploadPostTransformSuccessEvent = Imagekitio::Models::UploadPostTransformSuccessEvent + + UploadPreTransformErrorEvent = Imagekitio::Models::UploadPreTransformErrorEvent + + UploadPreTransformSuccessEvent = Imagekitio::Models::UploadPreTransformSuccessEvent + + VideoOverlay = Imagekitio::Models::VideoOverlay + + VideoTransformationAcceptedEvent = Imagekitio::Models::VideoTransformationAcceptedEvent + + VideoTransformationErrorEvent = Imagekitio::Models::VideoTransformationErrorEvent + + VideoTransformationReadyEvent = Imagekitio::Models::VideoTransformationReadyEvent + + WebhookUnsafeUnwrapParams = Imagekitio::Models::WebhookUnsafeUnwrapParams + + WebhookUnwrapParams = Imagekitio::Models::WebhookUnwrapParams +end diff --git a/lib/imagekitio/models/accounts/origin_create_params.rb b/lib/imagekitio/models/accounts/origin_create_params.rb new file mode 100644 index 00000000..f3ffaa1d --- /dev/null +++ b/lib/imagekitio/models/accounts/origin_create_params.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::Origins#create + class OriginCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute origin_request + # Schema for origin request resources. + # + # @return [Imagekitio::Models::Accounts::OriginRequest::S3, Imagekitio::Models::Accounts::OriginRequest::S3Compatible, Imagekitio::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekitio::Models::Accounts::OriginRequest::WebFolder, Imagekitio::Models::Accounts::OriginRequest::WebProxy, Imagekitio::Models::Accounts::OriginRequest::Gcs, Imagekitio::Models::Accounts::OriginRequest::AzureBlob, Imagekitio::Models::Accounts::OriginRequest::AkeneoPim] + required :origin_request, union: -> { Imagekitio::Accounts::OriginRequest } + + # @!method initialize(origin_request:, request_options: {}) + # @param origin_request [Imagekitio::Models::Accounts::OriginRequest::S3, Imagekitio::Models::Accounts::OriginRequest::S3Compatible, Imagekitio::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekitio::Models::Accounts::OriginRequest::WebFolder, Imagekitio::Models::Accounts::OriginRequest::WebProxy, Imagekitio::Models::Accounts::OriginRequest::Gcs, Imagekitio::Models::Accounts::OriginRequest::AzureBlob, Imagekitio::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/origin_delete_params.rb b/lib/imagekitio/models/accounts/origin_delete_params.rb new file mode 100644 index 00000000..d27dc434 --- /dev/null +++ b/lib/imagekitio/models/accounts/origin_delete_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::Origins#delete + class OriginDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/origin_get_params.rb b/lib/imagekitio/models/accounts/origin_get_params.rb new file mode 100644 index 00000000..70940dcf --- /dev/null +++ b/lib/imagekitio/models/accounts/origin_get_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::Origins#get + class OriginGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/origin_list_params.rb b/lib/imagekitio/models/accounts/origin_list_params.rb new file mode 100644 index 00000000..4c924a7e --- /dev/null +++ b/lib/imagekitio/models/accounts/origin_list_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::Origins#list + class OriginListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/origin_list_response.rb b/lib/imagekitio/models/accounts/origin_list_response.rb new file mode 100644 index 00000000..a7bba41b --- /dev/null +++ b/lib/imagekitio/models/accounts/origin_list_response.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @type [Imagekitio::Internal::Type::Converter] + OriginListResponse = + Imagekitio::Internal::Type::ArrayOf[union: -> { Imagekitio::Accounts::OriginResponse }] + end + end +end diff --git a/lib/imagekit/models/accounts/origin_request.rb b/lib/imagekitio/models/accounts/origin_request.rb similarity index 88% rename from lib/imagekit/models/accounts/origin_request.rb rename to lib/imagekitio/models/accounts/origin_request.rb index 88b7782f..091b669d 100644 --- a/lib/imagekit/models/accounts/origin_request.rb +++ b/lib/imagekitio/models/accounts/origin_request.rb @@ -1,31 +1,31 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Accounts # Schema for origin request resources. module OriginRequest - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type - variant :S3, -> { Imagekit::Accounts::OriginRequest::S3 } + variant :S3, -> { Imagekitio::Accounts::OriginRequest::S3 } - variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginRequest::S3Compatible } + variant :S3_COMPATIBLE, -> { Imagekitio::Accounts::OriginRequest::S3Compatible } - variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginRequest::CloudinaryBackup } + variant :CLOUDINARY_BACKUP, -> { Imagekitio::Accounts::OriginRequest::CloudinaryBackup } - variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginRequest::WebFolder } + variant :WEB_FOLDER, -> { Imagekitio::Accounts::OriginRequest::WebFolder } - variant :WEB_PROXY, -> { Imagekit::Accounts::OriginRequest::WebProxy } + variant :WEB_PROXY, -> { Imagekitio::Accounts::OriginRequest::WebProxy } - variant :GCS, -> { Imagekit::Accounts::OriginRequest::Gcs } + variant :GCS, -> { Imagekitio::Accounts::OriginRequest::Gcs } - variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginRequest::AzureBlob } + variant :AZURE_BLOB, -> { Imagekitio::Accounts::OriginRequest::AzureBlob } - variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginRequest::AkeneoPim } + variant :AKENEO_PIM, -> { Imagekitio::Accounts::OriginRequest::AkeneoPim } - class S3 < Imagekit::Internal::Type::BaseModel + class S3 < Imagekitio::Internal::Type::BaseModel # @!attribute access_key # Access key for the bucket. # @@ -66,7 +66,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute prefix @@ -93,7 +93,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :S3] end - class S3Compatible < Imagekit::Internal::Type::BaseModel + class S3Compatible < Imagekitio::Internal::Type::BaseModel # @!attribute access_key # Access key for the bucket. # @@ -140,7 +140,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute prefix @@ -153,7 +153,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # Use path-style S3 URLs? # # @return [Boolean, nil] - optional :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + optional :s3_force_path_style, Imagekitio::Internal::Type::Boolean, api_name: :s3ForcePathStyle # @!method initialize(access_key:, bucket:, endpoint:, name:, secret_key:, base_url_for_canonical_header: nil, include_canonical_header: nil, prefix: nil, s3_force_path_style: nil, type: :S3_COMPATIBLE) # @param access_key [String] Access key for the bucket. @@ -177,7 +177,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :S3_COMPATIBLE] end - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + class CloudinaryBackup < Imagekitio::Internal::Type::BaseModel # @!attribute access_key # Access key for the bucket. # @@ -218,7 +218,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute prefix @@ -245,7 +245,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :CLOUDINARY_BACKUP] end - class WebFolder < Imagekit::Internal::Type::BaseModel + class WebFolder < Imagekitio::Internal::Type::BaseModel # @!attribute base_url # Root URL for the web folder origin. # @@ -274,7 +274,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :forwardHostHeaderToOrigin # @!attribute include_canonical_header @@ -282,7 +282,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!method initialize(base_url:, name:, base_url_for_canonical_header: nil, forward_host_header_to_origin: nil, include_canonical_header: nil, type: :WEB_FOLDER) @@ -299,7 +299,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_FOLDER] end - class WebProxy < Imagekit::Internal::Type::BaseModel + class WebProxy < Imagekitio::Internal::Type::BaseModel # @!attribute name # Display name of the origin. # @@ -322,7 +322,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!method initialize(name:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :WEB_PROXY) @@ -335,7 +335,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_PROXY] end - class Gcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekitio::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -373,7 +373,7 @@ class Gcs < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute prefix @@ -399,7 +399,7 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :GCS] end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekitio::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -437,7 +437,7 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute prefix @@ -463,7 +463,7 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :AZURE_BLOB] end - class AkeneoPim < Imagekit::Internal::Type::BaseModel + class AkeneoPim < Imagekitio::Internal::Type::BaseModel # @!attribute base_url # Akeneo instance base URL. # @@ -516,7 +516,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!method initialize(base_url:, client_id:, client_secret:, name:, password:, username:, base_url_for_canonical_header: nil, include_canonical_header: nil, type: :AKENEO_PIM) @@ -540,7 +540,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginRequest::S3, Imagekit::Models::Accounts::OriginRequest::S3Compatible, Imagekit::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekit::Models::Accounts::OriginRequest::WebFolder, Imagekit::Models::Accounts::OriginRequest::WebProxy, Imagekit::Models::Accounts::OriginRequest::Gcs, Imagekit::Models::Accounts::OriginRequest::AzureBlob, Imagekit::Models::Accounts::OriginRequest::AkeneoPim)] + # @return [Array(Imagekitio::Models::Accounts::OriginRequest::S3, Imagekitio::Models::Accounts::OriginRequest::S3Compatible, Imagekitio::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekitio::Models::Accounts::OriginRequest::WebFolder, Imagekitio::Models::Accounts::OriginRequest::WebProxy, Imagekitio::Models::Accounts::OriginRequest::Gcs, Imagekitio::Models::Accounts::OriginRequest::AzureBlob, Imagekitio::Models::Accounts::OriginRequest::AkeneoPim)] end end end diff --git a/lib/imagekit/models/accounts/origin_response.rb b/lib/imagekitio/models/accounts/origin_response.rb similarity index 85% rename from lib/imagekit/models/accounts/origin_response.rb rename to lib/imagekitio/models/accounts/origin_response.rb index aa9aea71..71d255ad 100644 --- a/lib/imagekit/models/accounts/origin_response.rb +++ b/lib/imagekitio/models/accounts/origin_response.rb @@ -1,33 +1,33 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Accounts # Origin object as returned by the API (sensitive fields removed). # - # @see Imagekit::Resources::Accounts::Origins#create + # @see Imagekitio::Resources::Accounts::Origins#create module OriginResponse - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type - variant :S3, -> { Imagekit::Accounts::OriginResponse::S3 } + variant :S3, -> { Imagekitio::Accounts::OriginResponse::S3 } - variant :S3_COMPATIBLE, -> { Imagekit::Accounts::OriginResponse::S3Compatible } + variant :S3_COMPATIBLE, -> { Imagekitio::Accounts::OriginResponse::S3Compatible } - variant :CLOUDINARY_BACKUP, -> { Imagekit::Accounts::OriginResponse::CloudinaryBackup } + variant :CLOUDINARY_BACKUP, -> { Imagekitio::Accounts::OriginResponse::CloudinaryBackup } - variant :WEB_FOLDER, -> { Imagekit::Accounts::OriginResponse::WebFolder } + variant :WEB_FOLDER, -> { Imagekitio::Accounts::OriginResponse::WebFolder } - variant :WEB_PROXY, -> { Imagekit::Accounts::OriginResponse::WebProxy } + variant :WEB_PROXY, -> { Imagekitio::Accounts::OriginResponse::WebProxy } - variant :GCS, -> { Imagekit::Accounts::OriginResponse::Gcs } + variant :GCS, -> { Imagekitio::Accounts::OriginResponse::Gcs } - variant :AZURE_BLOB, -> { Imagekit::Accounts::OriginResponse::AzureBlob } + variant :AZURE_BLOB, -> { Imagekitio::Accounts::OriginResponse::AzureBlob } - variant :AKENEO_PIM, -> { Imagekit::Accounts::OriginResponse::AkeneoPim } + variant :AKENEO_PIM, -> { Imagekitio::Accounts::OriginResponse::AkeneoPim } - class S3 < Imagekit::Internal::Type::BaseModel + class S3 < Imagekitio::Internal::Type::BaseModel # @!attribute bucket # S3 bucket name. # @@ -39,7 +39,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # # @return [Boolean] required :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute name @@ -76,7 +76,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :S3) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::S3} for more details. + # {Imagekitio::Models::Accounts::OriginResponse::S3} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -93,7 +93,7 @@ class S3 < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :S3] end - class S3Compatible < Imagekit::Internal::Type::BaseModel + class S3Compatible < Imagekitio::Internal::Type::BaseModel # @!attribute bucket # S3 bucket name. # @@ -111,7 +111,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # # @return [Boolean] required :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute name @@ -130,7 +130,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # Use path-style S3 URLs? # # @return [Boolean] - required :s3_force_path_style, Imagekit::Internal::Type::Boolean, api_name: :s3ForcePathStyle + required :s3_force_path_style, Imagekitio::Internal::Type::Boolean, api_name: :s3ForcePathStyle # @!attribute type # @@ -154,7 +154,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, endpoint:, include_canonical_header:, name:, prefix:, s3_force_path_style:, base_url_for_canonical_header: nil, type: :S3_COMPATIBLE) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::S3Compatible} for more details. + # {Imagekitio::Models::Accounts::OriginResponse::S3Compatible} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -175,7 +175,7 @@ class S3Compatible < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :S3_COMPATIBLE] end - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + class CloudinaryBackup < Imagekitio::Internal::Type::BaseModel # @!attribute bucket # S3 bucket name. # @@ -187,7 +187,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # # @return [Boolean] required :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute name @@ -224,7 +224,8 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :CLOUDINARY_BACKUP) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup} for more details. + # {Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup} for more + # details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -241,7 +242,7 @@ class CloudinaryBackup < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :CLOUDINARY_BACKUP] end - class WebFolder < Imagekit::Internal::Type::BaseModel + class WebFolder < Imagekitio::Internal::Type::BaseModel # @!attribute base_url # Root URL for the web folder origin. # @@ -253,7 +254,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @return [Boolean] required :forward_host_header_to_origin, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :forwardHostHeaderToOrigin # @!attribute include_canonical_header @@ -261,7 +262,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # # @return [Boolean] required :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute name @@ -292,7 +293,7 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, base_url:, forward_host_header_to_origin:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_FOLDER) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::WebFolder} for more details. + # {Imagekitio::Models::Accounts::OriginResponse::WebFolder} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -309,13 +310,13 @@ class WebFolder < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_FOLDER] end - class WebProxy < Imagekit::Internal::Type::BaseModel + class WebProxy < Imagekitio::Internal::Type::BaseModel # @!attribute include_canonical_header # Whether to send a Canonical header. # # @return [Boolean] required :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute name @@ -346,7 +347,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :WEB_PROXY) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::WebProxy} for more details. + # {Imagekitio::Models::Accounts::OriginResponse::WebProxy} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -359,7 +360,7 @@ class WebProxy < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :WEB_PROXY] end - class Gcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekitio::Internal::Type::BaseModel # @!attribute bucket # # @return [String] @@ -375,7 +376,7 @@ class Gcs < Imagekit::Internal::Type::BaseModel # # @return [Boolean] required :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute name @@ -411,7 +412,7 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, bucket:, client_email:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :GCS) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::Gcs} for more details. + # {Imagekitio::Models::Accounts::OriginResponse::Gcs} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -430,7 +431,7 @@ class Gcs < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :GCS] end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekitio::Internal::Type::BaseModel # @!attribute account_name # # @return [String] @@ -446,7 +447,7 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # # @return [Boolean] required :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute name @@ -482,7 +483,7 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, account_name:, container:, include_canonical_header:, name:, prefix:, base_url_for_canonical_header: nil, type: :AZURE_BLOB) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::AzureBlob} for more details. + # {Imagekitio::Models::Accounts::OriginResponse::AzureBlob} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -501,7 +502,7 @@ class AzureBlob < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :AZURE_BLOB] end - class AkeneoPim < Imagekit::Internal::Type::BaseModel + class AkeneoPim < Imagekitio::Internal::Type::BaseModel # @!attribute base_url # Akeneo instance base URL. # @@ -513,7 +514,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # # @return [Boolean] required :include_canonical_header, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :includeCanonicalHeader # @!attribute name @@ -544,7 +545,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, base_url:, include_canonical_header:, name:, base_url_for_canonical_header: nil, type: :AKENEO_PIM) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::OriginResponse::AkeneoPim} for more details. + # {Imagekitio::Models::Accounts::OriginResponse::AkeneoPim} for more details. # # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create # @@ -560,7 +561,7 @@ class AkeneoPim < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::OriginResponse::S3, Imagekit::Models::Accounts::OriginResponse::S3Compatible, Imagekit::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekit::Models::Accounts::OriginResponse::WebFolder, Imagekit::Models::Accounts::OriginResponse::WebProxy, Imagekit::Models::Accounts::OriginResponse::Gcs, Imagekit::Models::Accounts::OriginResponse::AzureBlob, Imagekit::Models::Accounts::OriginResponse::AkeneoPim)] + # @return [Array(Imagekitio::Models::Accounts::OriginResponse::S3, Imagekitio::Models::Accounts::OriginResponse::S3Compatible, Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekitio::Models::Accounts::OriginResponse::WebFolder, Imagekitio::Models::Accounts::OriginResponse::WebProxy, Imagekitio::Models::Accounts::OriginResponse::Gcs, Imagekitio::Models::Accounts::OriginResponse::AzureBlob, Imagekitio::Models::Accounts::OriginResponse::AkeneoPim)] end end end diff --git a/lib/imagekitio/models/accounts/origin_update_params.rb b/lib/imagekitio/models/accounts/origin_update_params.rb new file mode 100644 index 00000000..8f4d15c4 --- /dev/null +++ b/lib/imagekitio/models/accounts/origin_update_params.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::Origins#update + class OriginUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute origin_request + # Schema for origin request resources. + # + # @return [Imagekitio::Models::Accounts::OriginRequest::S3, Imagekitio::Models::Accounts::OriginRequest::S3Compatible, Imagekitio::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekitio::Models::Accounts::OriginRequest::WebFolder, Imagekitio::Models::Accounts::OriginRequest::WebProxy, Imagekitio::Models::Accounts::OriginRequest::Gcs, Imagekitio::Models::Accounts::OriginRequest::AzureBlob, Imagekitio::Models::Accounts::OriginRequest::AkeneoPim] + required :origin_request, union: -> { Imagekitio::Accounts::OriginRequest } + + # @!method initialize(origin_request:, request_options: {}) + # @param origin_request [Imagekitio::Models::Accounts::OriginRequest::S3, Imagekitio::Models::Accounts::OriginRequest::S3Compatible, Imagekitio::Models::Accounts::OriginRequest::CloudinaryBackup, Imagekitio::Models::Accounts::OriginRequest::WebFolder, Imagekitio::Models::Accounts::OriginRequest::WebProxy, Imagekitio::Models::Accounts::OriginRequest::Gcs, Imagekitio::Models::Accounts::OriginRequest::AzureBlob, Imagekitio::Models::Accounts::OriginRequest::AkeneoPim] Schema for origin request resources. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/url_endpoint_create_params.rb b/lib/imagekitio/models/accounts/url_endpoint_create_params.rb new file mode 100644 index 00000000..bda512fe --- /dev/null +++ b/lib/imagekitio/models/accounts/url_endpoint_create_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::URLEndpoints#create + class URLEndpointCreateParams < Imagekitio::Models::Accounts::URLEndpointRequest + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/url_endpoint_delete_params.rb b/lib/imagekitio/models/accounts/url_endpoint_delete_params.rb new file mode 100644 index 00000000..45e557d2 --- /dev/null +++ b/lib/imagekitio/models/accounts/url_endpoint_delete_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::URLEndpoints#delete + class URLEndpointDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/url_endpoint_get_params.rb b/lib/imagekitio/models/accounts/url_endpoint_get_params.rb new file mode 100644 index 00000000..12a217a1 --- /dev/null +++ b/lib/imagekitio/models/accounts/url_endpoint_get_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::URLEndpoints#get + class URLEndpointGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/url_endpoint_list_params.rb b/lib/imagekitio/models/accounts/url_endpoint_list_params.rb new file mode 100644 index 00000000..66618368 --- /dev/null +++ b/lib/imagekitio/models/accounts/url_endpoint_list_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::URLEndpoints#list + class URLEndpointListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/accounts/url_endpoint_list_response.rb b/lib/imagekitio/models/accounts/url_endpoint_list_response.rb new file mode 100644 index 00000000..9ae3c934 --- /dev/null +++ b/lib/imagekitio/models/accounts/url_endpoint_list_response.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @type [Imagekitio::Internal::Type::Converter] + URLEndpointListResponse = + Imagekitio::Internal::Type::ArrayOf[-> { Imagekitio::Accounts::URLEndpointResponse }] + end + end +end diff --git a/lib/imagekit/models/accounts/url_endpoint_request.rb b/lib/imagekitio/models/accounts/url_endpoint_request.rb similarity index 62% rename from lib/imagekit/models/accounts/url_endpoint_request.rb rename to lib/imagekitio/models/accounts/url_endpoint_request.rb index 32c945fc..7400259c 100644 --- a/lib/imagekit/models/accounts/url_endpoint_request.rb +++ b/lib/imagekitio/models/accounts/url_endpoint_request.rb @@ -1,9 +1,9 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Accounts - class URLEndpointRequest < Imagekit::Internal::Type::BaseModel + class URLEndpointRequest < Imagekitio::Internal::Type::BaseModel # @!attribute description # Description of the URL endpoint. # @@ -16,7 +16,7 @@ class URLEndpointRequest < Imagekit::Internal::Type::BaseModel # can be used in a URL endpoint. # # @return [Array, nil] - optional :origins, Imagekit::Internal::Type::ArrayOf[String] + optional :origins, Imagekitio::Internal::Type::ArrayOf[String] # @!attribute url_prefix # Path segment appended to your base URL to form the endpoint (letters, digits, @@ -28,14 +28,14 @@ class URLEndpointRequest < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai, nil] + # @return [Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai, nil] optional :url_rewriter, - union: -> { Imagekit::Accounts::URLEndpointRequest::URLRewriter }, + union: -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter }, api_name: :urlRewriter # @!method initialize(description:, origins: nil, url_prefix: nil, url_rewriter: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointRequest} for more details. + # {Imagekitio::Models::Accounts::URLEndpointRequest} for more details. # # Schema for URL endpoint resource. # @@ -45,23 +45,23 @@ class URLEndpointRequest < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. # Configuration for third-party URL rewriting. # - # @see Imagekit::Models::Accounts::URLEndpointRequest#url_rewriter + # @see Imagekitio::Models::Accounts::URLEndpointRequest#url_rewriter module URLRewriter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type - variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary } + variant :CLOUDINARY, -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary } - variant :IMGIX, -> { Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix } + variant :IMGIX, -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix } - variant :AKAMAI, -> { Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai } + variant :AKAMAI, -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai } - class Cloudinary < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekitio::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :CLOUDINARY] @@ -72,7 +72,7 @@ class Cloudinary < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :preserve_asset_delivery_types, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :preserveAssetDeliveryTypes # @!method initialize(preserve_asset_delivery_types: nil, type: :CLOUDINARY) @@ -81,7 +81,7 @@ class Cloudinary < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :CLOUDINARY] end - class Imgix < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekitio::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :IMGIX] @@ -91,7 +91,7 @@ class Imgix < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :IMGIX] end - class Akamai < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekitio::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :AKAMAI] @@ -102,7 +102,7 @@ class Akamai < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai)] + # @return [Array(Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai)] end end end diff --git a/lib/imagekit/models/accounts/url_endpoint_response.rb b/lib/imagekitio/models/accounts/url_endpoint_response.rb similarity index 65% rename from lib/imagekit/models/accounts/url_endpoint_response.rb rename to lib/imagekitio/models/accounts/url_endpoint_response.rb index 3ea557dc..03669337 100644 --- a/lib/imagekit/models/accounts/url_endpoint_response.rb +++ b/lib/imagekitio/models/accounts/url_endpoint_response.rb @@ -1,10 +1,10 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Accounts - # @see Imagekit::Resources::Accounts::URLEndpoints#create - class URLEndpointResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Accounts::URLEndpoints#create + class URLEndpointResponse < Imagekitio::Internal::Type::BaseModel # @!attribute description # Description of the URL endpoint. # @@ -17,7 +17,7 @@ class URLEndpointResponse < Imagekit::Internal::Type::BaseModel # can be used in a URL endpoint. # # @return [Array] - required :origins, Imagekit::Internal::Type::ArrayOf[String] + required :origins, Imagekitio::Internal::Type::ArrayOf[String] # @!attribute url_prefix # Path segment appended to your base URL to form the endpoint (letters, digits, @@ -29,9 +29,9 @@ class URLEndpointResponse < Imagekit::Internal::Type::BaseModel # @!attribute url_rewriter # Configuration for third-party URL rewriting. # - # @return [Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai, nil] + # @return [Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai, nil] optional :url_rewriter, - union: -> { Imagekit::Accounts::URLEndpointResponse::URLRewriter }, + union: -> { Imagekitio::Accounts::URLEndpointResponse::URLRewriter }, api_name: :urlRewriter response_only do @@ -46,7 +46,7 @@ class URLEndpointResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointResponse} for more details. + # {Imagekitio::Models::Accounts::URLEndpointResponse} for more details. # # URL‑endpoint object as returned by the API. # @@ -58,29 +58,29 @@ class URLEndpointResponse < Imagekit::Internal::Type::BaseModel # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting. # Configuration for third-party URL rewriting. # - # @see Imagekit::Models::Accounts::URLEndpointResponse#url_rewriter + # @see Imagekitio::Models::Accounts::URLEndpointResponse#url_rewriter module URLRewriter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type - variant :CLOUDINARY, -> { Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary } + variant :CLOUDINARY, -> { Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary } - variant :IMGIX, -> { Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix } + variant :IMGIX, -> { Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix } - variant :AKAMAI, -> { Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai } + variant :AKAMAI, -> { Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai } - class Cloudinary < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekitio::Internal::Type::BaseModel # @!attribute preserve_asset_delivery_types # Whether to preserve `/` in the rewritten URL. # # @return [Boolean] required :preserve_asset_delivery_types, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :preserveAssetDeliveryTypes # @!attribute type @@ -94,7 +94,7 @@ class Cloudinary < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :CLOUDINARY] end - class Imgix < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekitio::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :IMGIX] @@ -104,7 +104,7 @@ class Imgix < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :IMGIX] end - class Akamai < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekitio::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, :AKAMAI] @@ -115,7 +115,7 @@ class Akamai < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai)] + # @return [Array(Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai)] end end end diff --git a/lib/imagekitio/models/accounts/url_endpoint_update_params.rb b/lib/imagekitio/models/accounts/url_endpoint_update_params.rb new file mode 100644 index 00000000..5d79eeae --- /dev/null +++ b/lib/imagekitio/models/accounts/url_endpoint_update_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Accounts + # @see Imagekitio::Resources::Accounts::URLEndpoints#update + class URLEndpointUpdateParams < Imagekitio::Models::Accounts::URLEndpointRequest + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/accounts/usage_get_params.rb b/lib/imagekitio/models/accounts/usage_get_params.rb similarity index 71% rename from lib/imagekit/models/accounts/usage_get_params.rb rename to lib/imagekitio/models/accounts/usage_get_params.rb index 61664b99..a87bc6f9 100644 --- a/lib/imagekit/models/accounts/usage_get_params.rb +++ b/lib/imagekitio/models/accounts/usage_get_params.rb @@ -1,12 +1,12 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Accounts - # @see Imagekit::Resources::Accounts::Usage#get - class UsageGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Accounts::Usage#get + class UsageGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute end_date # Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. @@ -24,13 +24,13 @@ class UsageGetParams < Imagekit::Internal::Type::BaseModel # @!method initialize(end_date:, start_date:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::UsageGetParams} for more details. + # {Imagekitio::Models::Accounts::UsageGetParams} for more details. # # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. # # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/models/accounts/usage_get_response.rb b/lib/imagekitio/models/accounts/usage_get_response.rb similarity index 93% rename from lib/imagekit/models/accounts/usage_get_response.rb rename to lib/imagekitio/models/accounts/usage_get_response.rb index 7ac95137..45ff657b 100644 --- a/lib/imagekit/models/accounts/usage_get_response.rb +++ b/lib/imagekitio/models/accounts/usage_get_response.rb @@ -1,10 +1,10 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Accounts - # @see Imagekit::Resources::Accounts::Usage#get - class UsageGetResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Accounts::Usage#get + class UsageGetResponse < Imagekitio::Internal::Type::BaseModel # @!attribute bandwidth_bytes # Amount of bandwidth used in bytes. # diff --git a/lib/imagekit/models/asset_list_params.rb b/lib/imagekitio/models/asset_list_params.rb similarity index 76% rename from lib/imagekit/models/asset_list_params.rb rename to lib/imagekitio/models/asset_list_params.rb index 11eb0ea3..287e488c 100644 --- a/lib/imagekit/models/asset_list_params.rb +++ b/lib/imagekitio/models/asset_list_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Assets#list - class AssetListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Assets#list + class AssetListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute file_type # Filter results by file type. @@ -14,8 +14,8 @@ class AssetListParams < Imagekit::Internal::Type::BaseModel # - `image` — include only image files # - `non-image` — include only non-image files (e.g., JS, CSS, video) # - # @return [Symbol, Imagekit::Models::AssetListParams::FileType, nil] - optional :file_type, enum: -> { Imagekit::AssetListParams::FileType } + # @return [Symbol, Imagekitio::Models::AssetListParams::FileType, nil] + optional :file_type, enum: -> { Imagekitio::AssetListParams::FileType } # @!attribute limit # The maximum number of results to return in response. @@ -62,8 +62,8 @@ class AssetListParams < Imagekit::Internal::Type::BaseModel # Sort the results by one of the supported fields in ascending or descending # order. # - # @return [Symbol, Imagekit::Models::AssetListParams::Sort, nil] - optional :sort, enum: -> { Imagekit::AssetListParams::Sort } + # @return [Symbol, Imagekitio::Models::AssetListParams::Sort, nil] + optional :sort, enum: -> { Imagekitio::AssetListParams::Sort } # @!attribute type # Filter results by asset type. @@ -73,14 +73,14 @@ class AssetListParams < Imagekit::Internal::Type::BaseModel # - `folder` — returns only folders # - `all` — returns both files and folders (excludes `file-version`) # - # @return [Symbol, Imagekit::Models::AssetListParams::Type, nil] - optional :type, enum: -> { Imagekit::AssetListParams::Type } + # @return [Symbol, Imagekitio::Models::AssetListParams::Type, nil] + optional :type, enum: -> { Imagekitio::AssetListParams::Type } # @!method initialize(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::AssetListParams} for more details. + # {Imagekitio::Models::AssetListParams} for more details. # - # @param file_type [Symbol, Imagekit::Models::AssetListParams::FileType] Filter results by file type. + # @param file_type [Symbol, Imagekitio::Models::AssetListParams::FileType] Filter results by file type. # # @param limit [Integer] The maximum number of results to return in response. # @@ -90,11 +90,11 @@ class AssetListParams < Imagekit::Internal::Type::BaseModel # # @param skip [Integer] The number of results to skip before returning results. # - # @param sort [Symbol, Imagekit::Models::AssetListParams::Sort] Sort the results by one of the supported fields in ascending or descending order + # @param sort [Symbol, Imagekitio::Models::AssetListParams::Sort] Sort the results by one of the supported fields in ascending or descending order # - # @param type [Symbol, Imagekit::Models::AssetListParams::Type] Filter results by asset type. + # @param type [Symbol, Imagekitio::Models::AssetListParams::Type] Filter results by asset type. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] # Filter results by file type. # @@ -102,7 +102,7 @@ class AssetListParams < Imagekit::Internal::Type::BaseModel # - `image` — include only image files # - `non-image` — include only non-image files (e.g., JS, CSS, video) module FileType - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum ALL = :all IMAGE = :image @@ -115,7 +115,7 @@ module FileType # Sort the results by one of the supported fields in ascending or descending # order. module Sort - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum ASC_NAME = :ASC_NAME DESC_NAME = :DESC_NAME @@ -143,7 +143,7 @@ module Sort # - `folder` — returns only folders # - `all` — returns both files and folders (excludes `file-version`) module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum FILE = :file FILE_VERSION = :"file-version" diff --git a/lib/imagekitio/models/asset_list_response.rb b/lib/imagekitio/models/asset_list_response.rb new file mode 100644 index 00000000..7c693fe8 --- /dev/null +++ b/lib/imagekitio/models/asset_list_response.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # Object containing details of a file or file version. + module AssetListResponseItem + extend Imagekitio::Internal::Type::Union + + discriminator :type + + variant :folder, -> { Imagekitio::Folder } + + # Object containing details of a file or file version. + variant -> { Imagekitio::File } + + # @!method self.variants + # @return [Array(Imagekitio::Models::Folder, Imagekitio::Models::File)] + end + + # @type [Imagekitio::Internal::Type::Converter] + AssetListResponse = + Imagekitio::Internal::Type::ArrayOf[union: -> { Imagekitio::Models::AssetListResponseItem }] + end +end diff --git a/lib/imagekitio/models/base_overlay.rb b/lib/imagekitio/models/base_overlay.rb new file mode 100644 index 00000000..d48136fb --- /dev/null +++ b/lib/imagekitio/models/base_overlay.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + class BaseOverlay < Imagekitio::Internal::Type::BaseModel + # @!attribute position + # + # @return [Imagekitio::Models::OverlayPosition, nil] + optional :position, -> { Imagekitio::OverlayPosition } + + # @!attribute timing + # + # @return [Imagekitio::Models::OverlayTiming, nil] + optional :timing, -> { Imagekitio::OverlayTiming } + + # @!method initialize(position: nil, timing: nil) + # @param position [Imagekitio::Models::OverlayPosition] + # @param timing [Imagekitio::Models::OverlayTiming] + end + end +end diff --git a/lib/imagekit/models/base_webhook_event.rb b/lib/imagekitio/models/base_webhook_event.rb similarity index 85% rename from lib/imagekit/models/base_webhook_event.rb rename to lib/imagekitio/models/base_webhook_event.rb index d34435b2..1c96fa1a 100644 --- a/lib/imagekit/models/base_webhook_event.rb +++ b/lib/imagekitio/models/base_webhook_event.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class BaseWebhookEvent < Imagekit::Internal::Type::BaseModel + class BaseWebhookEvent < Imagekitio::Internal::Type::BaseModel # @!attribute id # Unique identifier for the event. # diff --git a/lib/imagekit/models/beta/v2/file_upload_params.rb b/lib/imagekitio/models/beta/v2/file_upload_params.rb similarity index 73% rename from lib/imagekit/models/beta/v2/file_upload_params.rb rename to lib/imagekitio/models/beta/v2/file_upload_params.rb index 4117e1bf..b1f16527 100644 --- a/lib/imagekit/models/beta/v2/file_upload_params.rb +++ b/lib/imagekitio/models/beta/v2/file_upload_params.rb @@ -1,13 +1,13 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Beta module V2 - # @see Imagekit::Resources::Beta::V2::Files#upload - class FileUploadParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Beta::V2::Files#upload + class FileUploadParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute file # The API accepts any of the following: @@ -20,8 +20,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # When supplying a URL, the server must receive the response headers within 8 # seconds; otherwise the request fails with 400 Bad Request. # - # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] - required :file, Imagekit::Internal::Type::FileInput + # @return [Pathname, StringIO, IO, String, Imagekitio::FilePart] + required :file, Imagekitio::Internal::Type::FileInput # @!attribute file_name # The name with which the file has to be uploaded. @@ -74,7 +74,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :customMetadata # @!attribute description @@ -87,8 +87,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] - optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } + # @return [Array, nil] + optional :extensions, -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem] } # @!attribute folder # The folder path in which the image has to be uploaded. If the folder(s) didn't @@ -105,7 +105,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # transformation or signed URL. # # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + optional :is_private_file, Imagekitio::Internal::Type::Boolean, api_name: :isPrivateFile # @!attribute is_published # Whether to upload file as published or not. @@ -118,14 +118,14 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # pricing plans. # # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + optional :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished # @!attribute overwrite_ai_tags # 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. # # @return [Boolean, nil] - optional :overwrite_ai_tags, Imagekit::Internal::Type::Boolean, api_name: :overwriteAITags + optional :overwrite_ai_tags, Imagekitio::Internal::Type::Boolean, api_name: :overwriteAITags # @!attribute overwrite_custom_metadata # If the request does not have `customMetadata`, and a file already exists at the @@ -133,7 +133,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :overwrite_custom_metadata, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :overwriteCustomMetadata # @!attribute overwrite_file @@ -141,22 +141,22 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # the exact location, upload API will return an error immediately. # # @return [Boolean, nil] - optional :overwrite_file, Imagekit::Internal::Type::Boolean, api_name: :overwriteFile + optional :overwrite_file, Imagekitio::Internal::Type::Boolean, api_name: :overwriteFile # @!attribute overwrite_tags # If the request does not have `tags`, and a file already exists at the exact # location, existing tags will be removed. # # @return [Boolean, nil] - optional :overwrite_tags, Imagekit::Internal::Type::Boolean, api_name: :overwriteTags + optional :overwrite_tags, Imagekitio::Internal::Type::Boolean, api_name: :overwriteTags # @!attribute response_fields # Array of response field keys to include in the API response body. # - # @return [Array, nil] + # @return [Array, nil] optional :response_fields, -> { - Imagekit::Internal::Type::ArrayOf[enum: Imagekit::Beta::V2::FileUploadParams::ResponseField] + Imagekitio::Internal::Type::ArrayOf[enum: Imagekitio::Beta::V2::FileUploadParams::ResponseField] }, api_name: :responseFields @@ -167,7 +167,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # and the file is overwritten, the existing tags will be removed. # # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String] + optional :tags, Imagekitio::Internal::Type::ArrayOf[String] # @!attribute transformation # Configure pre-processing (`pre`) and post-processing (`post`) transformations. @@ -182,8 +182,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # You can mix and match any combination of post-processing types. # - # @return [Imagekit::Models::Beta::V2::FileUploadParams::Transformation, nil] - optional :transformation, -> { Imagekit::Beta::V2::FileUploadParams::Transformation } + # @return [Imagekitio::Models::Beta::V2::FileUploadParams::Transformation, nil] + optional :transformation, -> { Imagekitio::Beta::V2::FileUploadParams::Transformation } # @!attribute use_unique_file_name # Whether to use a unique filename for this file or not. @@ -195,7 +195,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # any existing file with the same name is replaced. # # @return [Boolean, nil] - optional :use_unique_file_name, Imagekit::Internal::Type::Boolean, api_name: :useUniqueFileName + optional :use_unique_file_name, Imagekitio::Internal::Type::Boolean, api_name: :useUniqueFileName # @!attribute webhook_url # The final status of extensions after they have completed execution will be @@ -208,9 +208,9 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams} for more details. + # {Imagekitio::Models::Beta::V2::FileUploadParams} for more details. # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [Pathname, StringIO, IO, String, Imagekitio::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # @@ -224,7 +224,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -240,20 +240,20 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param overwrite_tags [Boolean] If the request does not have `tags`, and a file already exists at the exact loca # - # @param response_fields [Array] Array of response field keys to include in the API response body. + # @param response_fields [Array] Array of response field keys to include in the API response body. # # @param tags [Array] Set the tags while uploading the file. # - # @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. + # @param transformation [Imagekitio::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. # # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not. # # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] module ResponseField - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TAGS = :tags CUSTOM_COORDINATES = :customCoordinates @@ -268,15 +268,15 @@ module ResponseField # @return [Array] end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute post # 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`. # - # @return [Array, nil] + # @return [Array, nil] optional :post, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::Transformation::Post] } + -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Beta::V2::FileUploadParams::Transformation::Post] } # @!attribute pre # Transformation string to apply before uploading the file to the Media Library. @@ -287,7 +287,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!method initialize(post: nil, pre: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation} for more details. + # {Imagekitio::Models::Beta::V2::FileUploadParams::Transformation} for more + # details. # # Configure pre-processing (`pre`) and post-processing (`post`) transformations. # @@ -301,24 +302,25 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # You can mix and match any combination of post-processing types. # - # @param post [Array] List of transformations to apply _after_ the file is uploaded. + # @param post [Array] List of transformations to apply _after_ the file is uploaded. # # @param pre [String] Transformation string to apply before uploading the file to the Media Library. U module Post - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type - variant :transformation, -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation } + variant :transformation, + -> { Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Transformation } - variant :"gif-to-video", -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo } + variant :"gif-to-video", -> { Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo } - variant :thumbnail, -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail } + variant :thumbnail, -> { Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail } - variant :abs, -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs } + variant :abs, -> { Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs } - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute type # Transformation type. # @@ -334,7 +336,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!method initialize(value:, type: :transformation) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Transformation} + # {Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Transformation} # for more details. # # @param value [String] Transformation string (e.g. `w-200,h-200`). @@ -342,7 +344,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :transformation] Transformation type. end - class GifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekitio::Internal::Type::BaseModel # @!attribute type # Converts an animated GIF into an MP4. # @@ -358,7 +360,7 @@ class GifToVideo < Imagekit::Internal::Type::BaseModel # @!method initialize(value: nil, type: :"gif-to-video") # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo} + # {Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo} # for more details. # # @param value [String] Optional transformation string to apply to the output video. @@ -366,7 +368,7 @@ class GifToVideo < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :"gif-to-video"] Converts an animated GIF into an MP4. end - class Thumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekitio::Internal::Type::BaseModel # @!attribute type # Generates a thumbnail image. # @@ -382,7 +384,7 @@ class Thumbnail < Imagekit::Internal::Type::BaseModel # @!method initialize(value: nil, type: :thumbnail) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail} + # {Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail} # for more details. # # @param value [String] Optional transformation string. @@ -390,12 +392,13 @@ class Thumbnail < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :thumbnail] Generates a thumbnail image. end - class Abs < Imagekit::Internal::Type::BaseModel + class Abs < Imagekitio::Internal::Type::BaseModel # @!attribute protocol # Streaming protocol to use (`hls` or `dash`). # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol] - required :protocol, enum: -> { Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol } + # @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol] + required :protocol, + enum: -> { Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol } # @!attribute type # Adaptive Bitrate Streaming (ABS) setup. @@ -411,10 +414,10 @@ class Abs < Imagekit::Internal::Type::BaseModel # @!method initialize(protocol:, value:, type: :abs) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs} for + # {Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs} for # more details. # - # @param protocol [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol] Streaming protocol to use (`hls` or `dash`). + # @param protocol [Symbol, Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol] Streaming protocol to use (`hls` or `dash`). # # @param value [String] List of different representations you want to create separated by an underscore. # @@ -422,9 +425,9 @@ class Abs < Imagekit::Internal::Type::BaseModel # Streaming protocol to use (`hls` or `dash`). # - # @see Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs#protocol + # @see Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs#protocol module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS = :hls DASH = :dash @@ -435,7 +438,7 @@ module Protocol end # @!method self.variants - # @return [Array(Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Transformation, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs)] + # @return [Array(Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Transformation, Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs)] end end end diff --git a/lib/imagekit/models/beta/v2/file_upload_response.rb b/lib/imagekitio/models/beta/v2/file_upload_response.rb similarity index 73% rename from lib/imagekit/models/beta/v2/file_upload_response.rb rename to lib/imagekitio/models/beta/v2/file_upload_response.rb index c00da403..e9e69068 100644 --- a/lib/imagekit/models/beta/v2/file_upload_response.rb +++ b/lib/imagekitio/models/beta/v2/file_upload_response.rb @@ -1,17 +1,17 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Beta module V2 - # @see Imagekit::Resources::Beta::V2::Files#upload - class FileUploadResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Beta::V2::Files#upload + class FileUploadResponse < Imagekitio::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the uploaded file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Beta::V2::FileUploadResponse::AITag] }, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Models::Beta::V2::FileUploadResponse::AITag] }, api_name: :AITags, nil?: true @@ -45,7 +45,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :customMetadata # @!attribute description @@ -68,7 +68,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :embedded_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :embeddedMetadata # @!attribute extension_status @@ -82,9 +82,9 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, nil] + # @return [Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus, nil] optional :extension_status, - -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus }, + -> { Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus }, api_name: :extensionStatus # @!attribute file_id @@ -119,7 +119,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # field. # # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + optional :is_private_file, Imagekitio::Internal::Type::Boolean, api_name: :isPrivateFile # @!attribute is_published # Is the file published or in draft state. It can be either `true` or `false`. @@ -127,14 +127,14 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # field. # # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + optional :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished # @!attribute metadata # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. # - # @return [Imagekit::Models::Metadata, nil] - optional :metadata, -> { Imagekit::Metadata } + # @return [Imagekitio::Models::Metadata, nil] + optional :metadata, -> { Imagekitio::Metadata } # @!attribute name # Name of the asset. @@ -151,9 +151,9 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # Keys are the names of the custom metadata fields; the value object has details # about the custom metadata schema. # - # @return [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}, nil] + # @return [Hash{Symbol=>Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}, nil] optional :selected_fields_schema, - -> { Imagekit::Internal::Type::HashOf[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] }, + -> { Imagekitio::Internal::Type::HashOf[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] }, api_name: :selectedFieldsSchema # @!attribute size @@ -168,7 +168,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # field. # # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + optional :tags, Imagekitio::Internal::Type::ArrayOf[String], nil?: true # @!attribute thumbnail_url # In the case of an image, a small thumbnail URL. @@ -185,9 +185,9 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object containing the file or file version's `id` (versionId) and `name`. # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, nil] + # @return [Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo, nil] optional :version_info, - -> { Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo }, + -> { Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo }, api_name: :versionInfo # @!attribute video_codec @@ -204,11 +204,11 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadResponse} for more details. + # {Imagekitio::Models::Beta::V2::FileUploadResponse} for more details. # # Object containing details of a successful upload. # - # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. # # @param audio_codec [String] The audio codec used in the video (only for video). # @@ -224,7 +224,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, # - # @param extension_status [Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # @param extension_status [Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus] Extension names with their processing status at the time of completion of the re # # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo # @@ -238,11 +238,11 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen # - # @param metadata [Imagekit::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # @param metadata [Imagekitio::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad # # @param name [String] Name of the asset. # - # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa # # @param size [Float] Size of the image file in Bytes. # @@ -252,13 +252,13 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param url [String] A publicly accessible URL of the file. # - # @param version_info [Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # @param version_info [Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. # # @param video_codec [String] The video codec used in the video (only for video). # # @param width [Float] Width of the image in pixels (Only for Images) - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel # @!attribute confidence # Confidence score of the tag. # @@ -281,7 +281,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadResponse::AITag} for more details. + # {Imagekitio::Models::Beta::V2::FileUploadResponse::AITag} for more details. # # @param confidence [Float] Confidence score of the tag. # @@ -290,34 +290,34 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be end - # @see Imagekit::Models::Beta::V2::FileUploadResponse#extension_status - class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::Beta::V2::FileUploadResponse#extension_status + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel # @!attribute ai_auto_description # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription, nil] + # @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription, nil] optional :ai_auto_description, - enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription }, + enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription }, api_name: :"ai-auto-description" # @!attribute aws_auto_tagging # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] + # @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] optional :aws_auto_tagging, - enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging }, + enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging }, api_name: :"aws-auto-tagging" # @!attribute google_auto_tagging # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging, nil] + # @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging, nil] optional :google_auto_tagging, - enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging }, + enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging }, api_name: :"google-auto-tagging" # @!attribute remove_bg # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg, nil] + # @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg, nil] optional :remove_bg, - enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg }, + enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) @@ -331,14 +331,14 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # - # @param ai_auto_description [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription] - # @param aws_auto_tagging [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging] - # @param google_auto_tagging [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] - # @param remove_bg [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg] + # @param ai_auto_description [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription] + # @param aws_auto_tagging [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg] - # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#ai_auto_description + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus#ai_auto_description module AIAutoDescription - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -348,9 +348,9 @@ module AIAutoDescription # @return [Array] end - # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#aws_auto_tagging + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus#aws_auto_tagging module AwsAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -360,9 +360,9 @@ module AwsAutoTagging # @return [Array] end - # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#google_auto_tagging + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus#google_auto_tagging module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -372,9 +372,9 @@ module GoogleAutoTagging # @return [Array] end - # @see Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus#remove_bg + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus#remove_bg module RemoveBg - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -385,12 +385,12 @@ module RemoveBg end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of the custom metadata field. # - # @return [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type] - required :type, enum: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type } + # @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type } # @!attribute default_value # The default value for this custom metadata field. The value should match the @@ -398,14 +398,14 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, Boolean, Array, nil] optional :default_value, - union: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue }, + union: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue }, api_name: :defaultValue # @!attribute is_value_required # Specifies if the custom metadata field is required or not. # # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired # @!attribute max_length # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. @@ -420,7 +420,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :max_value, - union: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue }, + union: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue }, api_name: :maxValue # @!attribute min_length @@ -436,7 +436,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :min_value, - union: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue }, + union: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue }, api_name: :minValue # @!attribute read_only @@ -445,14 +445,14 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # **Path policy** feature. # # @return [Boolean, nil] - optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + optional :read_only, Imagekitio::Internal::Type::Boolean, api_name: :readOnly # @!attribute select_options # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. # # @return [Array, nil] optional :select_options, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption] }, + -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption] }, api_name: :selectOptions # @!attribute select_options_truncated @@ -461,15 +461,15 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :select_options_truncated, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :selectOptionsTruncated # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema} for more - # details. + # {Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema} for + # more details. # - # @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type] Type of the custom metadata field. + # @param type [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type] Type of the custom metadata field. # # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty # @@ -491,9 +491,9 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # Type of the custom metadata field. # - # @see Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#type + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TEXT = :Text TEXTAREA = :Textarea @@ -510,27 +510,27 @@ module Type # The default value for this custom metadata field. The value should match the # `type` of custom metadata field. # - # @see Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#default_value + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#default_value module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::MixedArray } + variant -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::MixedArray } module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] @@ -539,18 +539,18 @@ module Mixed # @!method self.variants # @return [Array(String, Float, Boolean, Array)] - # @type [Imagekit::Internal::Type::Converter] + # @type [Imagekitio::Internal::Type::Converter] MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed }] + Imagekitio::Internal::Type::ArrayOf[union: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed }] end # 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. # - # @see Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#max_value + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#max_value module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -564,9 +564,9 @@ module MaxValue # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#min_value + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#min_value module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -577,21 +577,21 @@ module MinValue end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] end end - # @see Imagekit::Models::Beta::V2::FileUploadResponse#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::Beta::V2::FileUploadResponse#version_info + class VersionInfo < Imagekitio::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. # diff --git a/lib/imagekitio/models/cache/invalidation_create_params.rb b/lib/imagekitio/models/cache/invalidation_create_params.rb new file mode 100644 index 00000000..2e400739 --- /dev/null +++ b/lib/imagekitio/models/cache/invalidation_create_params.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Cache + # @see Imagekitio::Resources::Cache::Invalidation#create + class InvalidationCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute url + # The full URL of the file to be purged. + # + # @return [String] + required :url, String + + # @!method initialize(url:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::Cache::InvalidationCreateParams} for more details. + # + # @param url [String] The full URL of the file to be purged. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/cache/invalidation_create_response.rb b/lib/imagekitio/models/cache/invalidation_create_response.rb similarity index 70% rename from lib/imagekit/models/cache/invalidation_create_response.rb rename to lib/imagekitio/models/cache/invalidation_create_response.rb index ceb1f1d0..8739f659 100644 --- a/lib/imagekit/models/cache/invalidation_create_response.rb +++ b/lib/imagekitio/models/cache/invalidation_create_response.rb @@ -1,10 +1,10 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Cache - # @see Imagekit::Resources::Cache::Invalidation#create - class InvalidationCreateResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Cache::Invalidation#create + class InvalidationCreateResponse < Imagekitio::Internal::Type::BaseModel # @!attribute request_id # Unique identifier of the purge request. This can be used to check the status of # the purge request. @@ -14,7 +14,7 @@ class InvalidationCreateResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(request_id: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Cache::InvalidationCreateResponse} for more details. + # {Imagekitio::Models::Cache::InvalidationCreateResponse} for more details. # # @param request_id [String] Unique identifier of the purge request. This can be used to check the status of end diff --git a/lib/imagekitio/models/cache/invalidation_get_params.rb b/lib/imagekitio/models/cache/invalidation_get_params.rb new file mode 100644 index 00000000..850a1fa7 --- /dev/null +++ b/lib/imagekitio/models/cache/invalidation_get_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Cache + # @see Imagekitio::Resources::Cache::Invalidation#get + class InvalidationGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/cache/invalidation_get_response.rb b/lib/imagekitio/models/cache/invalidation_get_response.rb new file mode 100644 index 00000000..f9fc571e --- /dev/null +++ b/lib/imagekitio/models/cache/invalidation_get_response.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Cache + # @see Imagekitio::Resources::Cache::Invalidation#get + class InvalidationGetResponse < Imagekitio::Internal::Type::BaseModel + # @!attribute status + # Status of the purge request. + # + # @return [Symbol, Imagekitio::Models::Cache::InvalidationGetResponse::Status, nil] + optional :status, enum: -> { Imagekitio::Models::Cache::InvalidationGetResponse::Status } + + # @!method initialize(status: nil) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::Cache::InvalidationGetResponse} for more details. + # + # @param status [Symbol, Imagekitio::Models::Cache::InvalidationGetResponse::Status] Status of the purge request. + + # Status of the purge request. + # + # @see Imagekitio::Models::Cache::InvalidationGetResponse#status + module Status + extend Imagekitio::Internal::Type::Enum + + PENDING = :Pending + COMPLETED = :Completed + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field.rb b/lib/imagekitio/models/custom_metadata_field.rb similarity index 73% rename from lib/imagekit/models/custom_metadata_field.rb rename to lib/imagekitio/models/custom_metadata_field.rb index 42c30777..bf69f73f 100644 --- a/lib/imagekit/models/custom_metadata_field.rb +++ b/lib/imagekitio/models/custom_metadata_field.rb @@ -1,9 +1,9 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::CustomMetadataFields#create - class CustomMetadataField < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::CustomMetadataFields#create + class CustomMetadataField < Imagekitio::Internal::Type::BaseModel # @!attribute id # Unique identifier for the custom metadata field. Use this to update the field. # @@ -28,12 +28,12 @@ class CustomMetadataField < Imagekit::Internal::Type::BaseModel # @!attribute schema # An object that describes the rules for the custom metadata field value. # - # @return [Imagekit::Models::CustomMetadataField::Schema] - required :schema, -> { Imagekit::CustomMetadataField::Schema } + # @return [Imagekitio::Models::CustomMetadataField::Schema] + required :schema, -> { Imagekitio::CustomMetadataField::Schema } # @!method initialize(id:, label:, name:, schema:) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataField} for more details. + # {Imagekitio::Models::CustomMetadataField} for more details. # # Object containing details of a custom metadata field. # @@ -43,15 +43,15 @@ class CustomMetadataField < Imagekit::Internal::Type::BaseModel # # @param name [String] API name of the custom metadata field. This becomes the key while setting `custo # - # @param schema [Imagekit::Models::CustomMetadataField::Schema] An object that describes the rules for the custom metadata field value. + # @param schema [Imagekitio::Models::CustomMetadataField::Schema] An object that describes the rules for the custom metadata field value. - # @see Imagekit::Models::CustomMetadataField#schema - class Schema < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::CustomMetadataField#schema + class Schema < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of the custom metadata field. # - # @return [Symbol, Imagekit::Models::CustomMetadataField::Schema::Type] - required :type, enum: -> { Imagekit::CustomMetadataField::Schema::Type } + # @return [Symbol, Imagekitio::Models::CustomMetadataField::Schema::Type] + required :type, enum: -> { Imagekitio::CustomMetadataField::Schema::Type } # @!attribute default_value # The default value for this custom metadata field. Data type of default value @@ -59,14 +59,14 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, Boolean, Array, nil] optional :default_value, - union: -> { Imagekit::CustomMetadataField::Schema::DefaultValue }, + union: -> { Imagekitio::CustomMetadataField::Schema::DefaultValue }, api_name: :defaultValue # @!attribute is_value_required # Specifies if the this custom metadata field is required or not. # # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired # @!attribute max_length # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. @@ -82,7 +82,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # @return [String, Float, nil] optional :max_value, union: -> { - Imagekit::CustomMetadataField::Schema::MaxValue + Imagekitio::CustomMetadataField::Schema::MaxValue }, api_name: :maxValue @@ -100,7 +100,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # @return [String, Float, nil] optional :min_value, union: -> { - Imagekit::CustomMetadataField::Schema::MinValue + Imagekitio::CustomMetadataField::Schema::MinValue }, api_name: :minValue @@ -110,17 +110,17 @@ class Schema < Imagekit::Internal::Type::BaseModel # @return [Array, nil] optional :select_options, -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::CustomMetadataField::Schema::SelectOption] + Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::CustomMetadataField::Schema::SelectOption] }, api_name: :selectOptions # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataField::Schema} for more details. + # {Imagekitio::Models::CustomMetadataField::Schema} for more details. # # An object that describes the rules for the custom metadata field value. # - # @param type [Symbol, Imagekit::Models::CustomMetadataField::Schema::Type] Type of the custom metadata field. + # @param type [Symbol, Imagekitio::Models::CustomMetadataField::Schema::Type] Type of the custom metadata field. # # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. Data type of default value dep # @@ -138,9 +138,9 @@ class Schema < Imagekit::Internal::Type::BaseModel # Type of the custom metadata field. # - # @see Imagekit::Models::CustomMetadataField::Schema#type + # @see Imagekitio::Models::CustomMetadataField::Schema#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TEXT = :Text TEXTAREA = :Textarea @@ -157,27 +157,27 @@ module Type # The default value for this custom metadata field. Data type of default value # depends on the field type. # - # @see Imagekit::Models::CustomMetadataField::Schema#default_value + # @see Imagekitio::Models::CustomMetadataField::Schema#default_value module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataField::Schema::DefaultValue::MixedArray } + variant -> { Imagekitio::Models::CustomMetadataField::Schema::DefaultValue::MixedArray } module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] @@ -186,10 +186,10 @@ module Mixed # @!method self.variants # @return [Array(String, Float, Boolean, Array)] - # @type [Imagekit::Internal::Type::Converter] + # @type [Imagekitio::Internal::Type::Converter] MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataField::Schema::DefaultValue::Mixed + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::CustomMetadataField::Schema::DefaultValue::Mixed }] end @@ -197,9 +197,9 @@ module Mixed # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::CustomMetadataField::Schema#max_value + # @see Imagekitio::Models::CustomMetadataField::Schema#max_value module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -213,9 +213,9 @@ module MaxValue # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::CustomMetadataField::Schema#min_value + # @see Imagekitio::Models::CustomMetadataField::Schema#min_value module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -226,13 +226,13 @@ module MinValue end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] diff --git a/lib/imagekit/models/custom_metadata_field_create_params.rb b/lib/imagekitio/models/custom_metadata_field_create_params.rb similarity index 71% rename from lib/imagekit/models/custom_metadata_field_create_params.rb rename to lib/imagekitio/models/custom_metadata_field_create_params.rb index 58a2f328..570b94cb 100644 --- a/lib/imagekit/models/custom_metadata_field_create_params.rb +++ b/lib/imagekitio/models/custom_metadata_field_create_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::CustomMetadataFields#create - class CustomMetadataFieldCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::CustomMetadataFields#create + class CustomMetadataFieldCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute label # Human readable name of the custom metadata field. This should be unique across @@ -25,27 +25,27 @@ class CustomMetadataFieldCreateParams < Imagekit::Internal::Type::BaseModel # @!attribute schema # - # @return [Imagekit::Models::CustomMetadataFieldCreateParams::Schema] - required :schema, -> { Imagekit::CustomMetadataFieldCreateParams::Schema } + # @return [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema] + required :schema, -> { Imagekitio::CustomMetadataFieldCreateParams::Schema } # @!method initialize(label:, name:, schema:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldCreateParams} for more details. + # {Imagekitio::Models::CustomMetadataFieldCreateParams} for more details. # # @param label [String] Human readable name of the custom metadata field. This should be unique across a # # @param name [String] API name of the custom metadata field. This should be unique across all (includi # - # @param schema [Imagekit::Models::CustomMetadataFieldCreateParams::Schema] + # @param schema [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema] # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] - class Schema < Imagekit::Internal::Type::BaseModel + class Schema < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of the custom metadata field. # - # @return [Symbol, Imagekit::Models::CustomMetadataFieldCreateParams::Schema::Type] - required :type, enum: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::Type } + # @return [Symbol, Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::Type] + required :type, enum: -> { Imagekitio::CustomMetadataFieldCreateParams::Schema::Type } # @!attribute default_value # The default value for this custom metadata field. This property is only required @@ -54,7 +54,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, Boolean, Array, nil] optional :default_value, - union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue }, + union: -> { Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue }, api_name: :defaultValue # @!attribute is_value_required @@ -63,7 +63,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # in upload or update asset API request body. # # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired # @!attribute max_length # Maximum length of string. Only set this property if `type` is set to `Text` or @@ -79,7 +79,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :max_value, - union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue }, + union: -> { Imagekitio::CustomMetadataFieldCreateParams::Schema::MaxValue }, api_name: :maxValue # @!attribute min_length @@ -96,7 +96,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :min_value, - union: -> { Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue }, + union: -> { Imagekitio::CustomMetadataFieldCreateParams::Schema::MinValue }, api_name: :minValue # @!attribute select_options @@ -106,15 +106,15 @@ class Schema < Imagekit::Internal::Type::BaseModel # @return [Array, nil] optional :select_options, -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption] + Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::CustomMetadataFieldCreateParams::Schema::SelectOption] }, api_name: :selectOptions # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldCreateParams::Schema} for more details. + # {Imagekitio::Models::CustomMetadataFieldCreateParams::Schema} for more details. # - # @param type [Symbol, Imagekit::Models::CustomMetadataFieldCreateParams::Schema::Type] Type of the custom metadata field. + # @param type [Symbol, Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::Type] Type of the custom metadata field. # # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. This property is only required # @@ -132,9 +132,9 @@ class Schema < Imagekit::Internal::Type::BaseModel # Type of the custom metadata field. # - # @see Imagekit::Models::CustomMetadataFieldCreateParams::Schema#type + # @see Imagekitio::Models::CustomMetadataFieldCreateParams::Schema#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TEXT = :Text TEXTAREA = :Textarea @@ -152,27 +152,27 @@ module Type # if `isValueRequired` property is set to `true`. The value should match the # `type` of custom metadata field. # - # @see Imagekit::Models::CustomMetadataFieldCreateParams::Schema#default_value + # @see Imagekitio::Models::CustomMetadataFieldCreateParams::Schema#default_value module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::MixedArray } + variant -> { Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::MixedArray } module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] @@ -181,10 +181,10 @@ module Mixed # @!method self.variants # @return [Array(String, Float, Boolean, Array)] - # @type [Imagekit::Internal::Type::Converter] + # @type [Imagekitio::Internal::Type::Converter] MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed }] end @@ -192,9 +192,9 @@ module Mixed # `Number`. For `Date` type field, set the minimum date in ISO8601 string format. # For `Number` type field, set the minimum numeric value. # - # @see Imagekit::Models::CustomMetadataFieldCreateParams::Schema#max_value + # @see Imagekitio::Models::CustomMetadataFieldCreateParams::Schema#max_value module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -208,9 +208,9 @@ module MaxValue # `Number`. For `Date` type field, set the minimum date in ISO8601 string format. # For `Number` type field, set the minimum numeric value. # - # @see Imagekit::Models::CustomMetadataFieldCreateParams::Schema#min_value + # @see Imagekitio::Models::CustomMetadataFieldCreateParams::Schema#min_value module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -221,13 +221,13 @@ module MinValue end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] diff --git a/lib/imagekitio/models/custom_metadata_field_delete_params.rb b/lib/imagekitio/models/custom_metadata_field_delete_params.rb new file mode 100644 index 00000000..118fc7bc --- /dev/null +++ b/lib/imagekitio/models/custom_metadata_field_delete_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::CustomMetadataFields#delete + class CustomMetadataFieldDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/custom_metadata_field_delete_response.rb b/lib/imagekitio/models/custom_metadata_field_delete_response.rb new file mode 100644 index 00000000..11a49967 --- /dev/null +++ b/lib/imagekitio/models/custom_metadata_field_delete_response.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::CustomMetadataFields#delete + class CustomMetadataFieldDeleteResponse < Imagekitio::Internal::Type::BaseModel + # @!method initialize + end + end +end diff --git a/lib/imagekit/models/custom_metadata_field_list_params.rb b/lib/imagekitio/models/custom_metadata_field_list_params.rb similarity index 66% rename from lib/imagekit/models/custom_metadata_field_list_params.rb rename to lib/imagekitio/models/custom_metadata_field_list_params.rb index 37650f76..32e2e8b2 100644 --- a/lib/imagekit/models/custom_metadata_field_list_params.rb +++ b/lib/imagekitio/models/custom_metadata_field_list_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::CustomMetadataFields#list - class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::CustomMetadataFields#list + class CustomMetadataFieldListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute folder_path # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable @@ -20,17 +20,17 @@ class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel # Set it to `true` to include deleted field objects in the API response. # # @return [Boolean, nil] - optional :include_deleted, Imagekit::Internal::Type::Boolean + optional :include_deleted, Imagekitio::Internal::Type::Boolean # @!method initialize(folder_path: nil, include_deleted: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldListParams} for more details. + # {Imagekitio::Models::CustomMetadataFieldListParams} for more details. # # @param folder_path [String] The folder path (e.g., `/path/to/folder`) for which to retrieve applicable custo # # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekitio/models/custom_metadata_field_list_response.rb b/lib/imagekitio/models/custom_metadata_field_list_response.rb new file mode 100644 index 00000000..06e4f254 --- /dev/null +++ b/lib/imagekitio/models/custom_metadata_field_list_response.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @type [Imagekitio::Internal::Type::Converter] + CustomMetadataFieldListResponse = + Imagekitio::Internal::Type::ArrayOf[-> { Imagekitio::CustomMetadataField }] + end +end diff --git a/lib/imagekit/models/custom_metadata_field_update_params.rb b/lib/imagekitio/models/custom_metadata_field_update_params.rb similarity index 73% rename from lib/imagekit/models/custom_metadata_field_update_params.rb rename to lib/imagekitio/models/custom_metadata_field_update_params.rb index f991da44..bf648397 100644 --- a/lib/imagekit/models/custom_metadata_field_update_params.rb +++ b/lib/imagekitio/models/custom_metadata_field_update_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::CustomMetadataFields#update - class CustomMetadataFieldUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::CustomMetadataFields#update + class CustomMetadataFieldUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute label # Human readable name of the custom metadata field. This should be unique across @@ -22,20 +22,20 @@ class CustomMetadataFieldUpdateParams < Imagekit::Internal::Type::BaseModel # be ignored if sent with the `schema`. The schema will be validated as per the # existing `type`. # - # @return [Imagekit::Models::CustomMetadataFieldUpdateParams::Schema, nil] - optional :schema, -> { Imagekit::CustomMetadataFieldUpdateParams::Schema } + # @return [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema, nil] + optional :schema, -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema } # @!method initialize(label: nil, schema: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldUpdateParams} for more details. + # {Imagekitio::Models::CustomMetadataFieldUpdateParams} for more details. # # @param label [String] Human readable name of the custom metadata field. This should be unique across a # - # @param schema [Imagekit::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i + # @param schema [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] - class Schema < Imagekit::Internal::Type::BaseModel + class Schema < Imagekitio::Internal::Type::BaseModel # @!attribute default_value # 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 @@ -43,7 +43,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, Boolean, Array, nil] optional :default_value, - union: -> { Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue }, + union: -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue }, api_name: :defaultValue # @!attribute is_value_required @@ -52,7 +52,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # in upload or update asset API request body. # # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired # @!attribute max_length # Maximum length of string. Only set this property if `type` is set to `Text` or @@ -68,7 +68,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :max_value, - union: -> { Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue }, + union: -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue }, api_name: :maxValue # @!attribute min_length @@ -85,7 +85,7 @@ class Schema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :min_value, - union: -> { Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue }, + union: -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue }, api_name: :minValue # @!attribute select_options @@ -95,13 +95,13 @@ class Schema < Imagekit::Internal::Type::BaseModel # @return [Array, nil] optional :select_options, -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption] + Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption] }, api_name: :selectOptions # @!method initialize(default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldUpdateParams::Schema} for more details. + # {Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema} for more details. # # 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 @@ -126,27 +126,27 @@ class Schema < Imagekit::Internal::Type::BaseModel # if `isValueRequired` property is set to `true`. The value should match the # `type` of custom metadata field. # - # @see Imagekit::Models::CustomMetadataFieldUpdateParams::Schema#default_value + # @see Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema#default_value module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::MixedArray } + variant -> { Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::MixedArray } module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] @@ -155,10 +155,10 @@ module Mixed # @!method self.variants # @return [Array(String, Float, Boolean, Array)] - # @type [Imagekit::Internal::Type::Converter] + # @type [Imagekitio::Internal::Type::Converter] MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed }] end @@ -166,9 +166,9 @@ module Mixed # `Number`. For `Date` type field, set the minimum date in ISO8601 string format. # For `Number` type field, set the minimum numeric value. # - # @see Imagekit::Models::CustomMetadataFieldUpdateParams::Schema#max_value + # @see Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema#max_value module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -182,9 +182,9 @@ module MaxValue # `Number`. For `Date` type field, set the minimum date in ISO8601 string format. # For `Number` type field, set the minimum numeric value. # - # @see Imagekit::Models::CustomMetadataFieldUpdateParams::Schema#min_value + # @see Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema#min_value module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -195,13 +195,13 @@ module MinValue end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] diff --git a/lib/imagekit/models/extensions.rb b/lib/imagekitio/models/extensions.rb similarity index 66% rename from lib/imagekit/models/extensions.rb rename to lib/imagekitio/models/extensions.rb index d0b187c3..b71af518 100644 --- a/lib/imagekit/models/extensions.rb +++ b/lib/imagekitio/models/extensions.rb @@ -1,19 +1,19 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module ExtensionItem - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :name - variant :"remove-bg", -> { Imagekit::ExtensionItem::RemoveBg } + variant :"remove-bg", -> { Imagekitio::ExtensionItem::RemoveBg } - variant :"ai-auto-description", -> { Imagekit::ExtensionItem::AIAutoDescription } + variant :"ai-auto-description", -> { Imagekitio::ExtensionItem::AIAutoDescription } - variant -> { Imagekit::ExtensionItem::AutoTaggingExtension } + variant -> { Imagekitio::ExtensionItem::AutoTaggingExtension } - class RemoveBg < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekitio::Internal::Type::BaseModel # @!attribute name # Specifies the background removal extension. # @@ -22,22 +22,22 @@ class RemoveBg < Imagekit::Internal::Type::BaseModel # @!attribute options # - # @return [Imagekit::Models::ExtensionItem::RemoveBg::Options, nil] - optional :options, -> { Imagekit::ExtensionItem::RemoveBg::Options } + # @return [Imagekitio::Models::ExtensionItem::RemoveBg::Options, nil] + optional :options, -> { Imagekitio::ExtensionItem::RemoveBg::Options } # @!method initialize(options: nil, name: :"remove-bg") - # @param options [Imagekit::Models::ExtensionItem::RemoveBg::Options] + # @param options [Imagekitio::Models::ExtensionItem::RemoveBg::Options] # # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. - # @see Imagekit::Models::ExtensionItem::RemoveBg#options - class Options < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::ExtensionItem::RemoveBg#options + class Options < Imagekitio::Internal::Type::BaseModel # @!attribute add_shadow # Whether to add an artificial shadow to the result. Default is false. Note: # Adding shadows is currently only supported for car photos. # # @return [Boolean, nil] - optional :add_shadow, Imagekit::Internal::Type::Boolean + optional :add_shadow, Imagekitio::Internal::Type::Boolean # @!attribute bg_color # Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or @@ -59,11 +59,11 @@ class Options < Imagekit::Internal::Type::BaseModel # Semitransparency is currently only supported for car windows. # # @return [Boolean, nil] - optional :semitransparency, Imagekit::Internal::Type::Boolean + optional :semitransparency, Imagekitio::Internal::Type::Boolean # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::ExtensionItem::RemoveBg::Options} for more details. + # {Imagekitio::Models::ExtensionItem::RemoveBg::Options} for more details. # # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin # @@ -75,7 +75,7 @@ class Options < Imagekit::Internal::Type::BaseModel end end - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + class AutoTaggingExtension < Imagekitio::Internal::Type::BaseModel # @!attribute max_tags # Maximum number of tags to attach to the asset. # @@ -91,21 +91,21 @@ class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel # @!attribute name # Specifies the auto-tagging extension used. # - # @return [Symbol, Imagekit::Models::ExtensionItem::AutoTaggingExtension::Name] - required :name, enum: -> { Imagekit::ExtensionItem::AutoTaggingExtension::Name } + # @return [Symbol, Imagekitio::Models::ExtensionItem::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekitio::ExtensionItem::AutoTaggingExtension::Name } # @!method initialize(max_tags:, min_confidence:, name:) # @param max_tags [Integer] Maximum number of tags to attach to the asset. # # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. # - # @param name [Symbol, Imagekit::Models::ExtensionItem::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + # @param name [Symbol, Imagekitio::Models::ExtensionItem::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. # Specifies the auto-tagging extension used. # - # @see Imagekit::Models::ExtensionItem::AutoTaggingExtension#name + # @see Imagekitio::Models::ExtensionItem::AutoTaggingExtension#name module Name - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum GOOGLE_AUTO_TAGGING = :"google-auto-tagging" AWS_AUTO_TAGGING = :"aws-auto-tagging" @@ -115,7 +115,7 @@ module Name end end - class AIAutoDescription < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekitio::Internal::Type::BaseModel # @!attribute name # Specifies the auto description extension. # @@ -127,10 +127,10 @@ class AIAutoDescription < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::ExtensionItem::RemoveBg, Imagekit::Models::ExtensionItem::AIAutoDescription, Imagekit::Models::ExtensionItem::AutoTaggingExtension)] + # @return [Array(Imagekitio::Models::ExtensionItem::RemoveBg, Imagekitio::Models::ExtensionItem::AIAutoDescription, Imagekitio::Models::ExtensionItem::AutoTaggingExtension)] end - # @type [Imagekit::Internal::Type::Converter] - Extensions = Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::ExtensionItem }] + # @type [Imagekitio::Internal::Type::Converter] + Extensions = Imagekitio::Internal::Type::ArrayOf[union: -> { Imagekitio::ExtensionItem }] end end diff --git a/lib/imagekit/models/file.rb b/lib/imagekitio/models/file.rb similarity index 77% rename from lib/imagekit/models/file.rb rename to lib/imagekitio/models/file.rb index 7bc653cd..5145ba57 100644 --- a/lib/imagekit/models/file.rb +++ b/lib/imagekitio/models/file.rb @@ -1,15 +1,15 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Files#get - class File < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Files#get + class File < Imagekitio::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::File::AITag] }, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag] }, api_name: :AITags, nil?: true @@ -31,7 +31,7 @@ class File < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :customMetadata # @!attribute description @@ -66,7 +66,7 @@ class File < Imagekit::Internal::Type::BaseModel # Specifies if the image has an alpha channel. # # @return [Boolean, nil] - optional :has_alpha, Imagekit::Internal::Type::Boolean, api_name: :hasAlpha + optional :has_alpha, Imagekitio::Internal::Type::Boolean, api_name: :hasAlpha # @!attribute height # Height of the file. @@ -78,13 +78,13 @@ class File < Imagekit::Internal::Type::BaseModel # Specifies if the file is private or not. # # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + optional :is_private_file, Imagekitio::Internal::Type::Boolean, api_name: :isPrivateFile # @!attribute is_published # Specifies if the file is published or not. # # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + optional :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished # @!attribute mime # MIME type of the file. @@ -107,9 +107,9 @@ class File < Imagekit::Internal::Type::BaseModel # Keys are the names of the custom metadata fields; the value object has details # about the custom metadata schema. # - # @return [Hash{Symbol=>Imagekit::Models::File::SelectedFieldsSchema}, nil] + # @return [Hash{Symbol=>Imagekitio::Models::File::SelectedFieldsSchema}, nil] optional :selected_fields_schema, - -> { Imagekit::Internal::Type::HashOf[Imagekit::File::SelectedFieldsSchema] }, + -> { Imagekitio::Internal::Type::HashOf[Imagekitio::File::SelectedFieldsSchema] }, api_name: :selectedFieldsSchema # @!attribute size @@ -123,7 +123,7 @@ class File < Imagekit::Internal::Type::BaseModel # media library. # # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + optional :tags, Imagekitio::Internal::Type::ArrayOf[String], nil?: true # @!attribute thumbnail # URL of the thumbnail image. This URL is used to access the thumbnail image of @@ -135,8 +135,8 @@ class File < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [Symbol, Imagekit::Models::File::Type, nil] - optional :type, enum: -> { Imagekit::File::Type } + # @return [Symbol, Imagekitio::Models::File::Type, nil] + optional :type, enum: -> { Imagekitio::File::Type } # @!attribute updated_at # Date and time when the file was last updated. The date and time is in ISO8601 @@ -154,8 +154,8 @@ class File < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object with details of the file version. # - # @return [Imagekit::Models::File::VersionInfo, nil] - optional :version_info, -> { Imagekit::File::VersionInfo }, api_name: :versionInfo + # @return [Imagekitio::Models::File::VersionInfo, nil] + optional :version_info, -> { Imagekitio::File::VersionInfo }, api_name: :versionInfo # @!attribute width # Width of the file. @@ -164,12 +164,12 @@ class File < Imagekit::Internal::Type::BaseModel optional :width, Float # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) - # Some parameter documentations has been truncated, see {Imagekit::Models::File} + # Some parameter documentations has been truncated, see {Imagekitio::Models::File} # for more details. # # Object containing details of a file or file version. # - # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # @@ -197,7 +197,7 @@ class File < Imagekit::Internal::Type::BaseModel # # @param name [String] Name of the asset. # - # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::File::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::File::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa # # @param size [Float] Size of the file in bytes. # @@ -205,17 +205,17 @@ class File < Imagekit::Internal::Type::BaseModel # # @param thumbnail [String] URL of the thumbnail image. This URL is used to access the thumbnail image of th # - # @param type [Symbol, Imagekit::Models::File::Type] Type of the asset. + # @param type [Symbol, Imagekitio::Models::File::Type] Type of the asset. # # @param updated_at [Time] Date and time when the file was last updated. The date and time is in ISO8601 fo # # @param url [String] URL of the file. # - # @param version_info [Imagekit::Models::File::VersionInfo] An object with details of the file version. + # @param version_info [Imagekitio::Models::File::VersionInfo] An object with details of the file version. # # @param width [Float] Width of the file. - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel # @!attribute confidence # Confidence score of the tag. # @@ -237,7 +237,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::File::AITag} for more details. + # {Imagekitio::Models::File::AITag} for more details. # # @param confidence [Float] Confidence score of the tag. # @@ -246,12 +246,12 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of the custom metadata field. # - # @return [Symbol, Imagekit::Models::File::SelectedFieldsSchema::Type] - required :type, enum: -> { Imagekit::File::SelectedFieldsSchema::Type } + # @return [Symbol, Imagekitio::Models::File::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekitio::File::SelectedFieldsSchema::Type } # @!attribute default_value # The default value for this custom metadata field. The value should match the @@ -259,14 +259,14 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, Boolean, Array, nil] optional :default_value, - union: -> { Imagekit::File::SelectedFieldsSchema::DefaultValue }, + union: -> { Imagekitio::File::SelectedFieldsSchema::DefaultValue }, api_name: :defaultValue # @!attribute is_value_required # Specifies if the custom metadata field is required or not. # # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired # @!attribute max_length # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. @@ -280,7 +280,11 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # field, it will be a numeric value. # # @return [String, Float, nil] - optional :max_value, union: -> { Imagekit::File::SelectedFieldsSchema::MaxValue }, api_name: :maxValue + optional :max_value, + union: -> { + Imagekitio::File::SelectedFieldsSchema::MaxValue + }, + api_name: :maxValue # @!attribute min_length # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. @@ -294,7 +298,11 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # field, it will be a numeric value. # # @return [String, Float, nil] - optional :min_value, union: -> { Imagekit::File::SelectedFieldsSchema::MinValue }, api_name: :minValue + optional :min_value, + union: -> { + Imagekitio::File::SelectedFieldsSchema::MinValue + }, + api_name: :minValue # @!attribute read_only # Indicates whether the custom metadata field is read only. A read only field @@ -302,7 +310,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # **Path policy** feature. # # @return [Boolean, nil] - optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + optional :read_only, Imagekitio::Internal::Type::Boolean, api_name: :readOnly # @!attribute select_options # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. @@ -310,7 +318,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # @return [Array, nil] optional :select_options, -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::File::SelectedFieldsSchema::SelectOption] + Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::File::SelectedFieldsSchema::SelectOption] }, api_name: :selectOptions @@ -320,14 +328,14 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :select_options_truncated, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :selectOptionsTruncated # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::File::SelectedFieldsSchema} for more details. + # {Imagekitio::Models::File::SelectedFieldsSchema} for more details. # - # @param type [Symbol, Imagekit::Models::File::SelectedFieldsSchema::Type] Type of the custom metadata field. + # @param type [Symbol, Imagekitio::Models::File::SelectedFieldsSchema::Type] Type of the custom metadata field. # # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty # @@ -349,9 +357,9 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # Type of the custom metadata field. # - # @see Imagekit::Models::File::SelectedFieldsSchema#type + # @see Imagekitio::Models::File::SelectedFieldsSchema#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TEXT = :Text TEXTAREA = :Textarea @@ -368,27 +376,27 @@ module Type # The default value for this custom metadata field. The value should match the # `type` of custom metadata field. # - # @see Imagekit::Models::File::SelectedFieldsSchema#default_value + # @see Imagekitio::Models::File::SelectedFieldsSchema#default_value module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::File::SelectedFieldsSchema::DefaultValue::MixedArray } + variant -> { Imagekitio::Models::File::SelectedFieldsSchema::DefaultValue::MixedArray } module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] @@ -397,10 +405,10 @@ module Mixed # @!method self.variants # @return [Array(String, Float, Boolean, Array)] - # @type [Imagekit::Internal::Type::Converter] + # @type [Imagekitio::Internal::Type::Converter] MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::File::SelectedFieldsSchema::DefaultValue::Mixed + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Mixed }] end @@ -408,9 +416,9 @@ module Mixed # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::File::SelectedFieldsSchema#max_value + # @see Imagekitio::Models::File::SelectedFieldsSchema#max_value module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -424,9 +432,9 @@ module MaxValue # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::File::SelectedFieldsSchema#min_value + # @see Imagekitio::Models::File::SelectedFieldsSchema#min_value module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -437,13 +445,13 @@ module MinValue end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] @@ -452,9 +460,9 @@ module SelectOption # Type of the asset. # - # @see Imagekit::Models::File#type + # @see Imagekitio::Models::File#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum FILE = :file FILE_VERSION = :"file-version" @@ -463,8 +471,8 @@ module Type # @return [Array] end - # @see Imagekit::Models::File#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::File#version_info + class VersionInfo < Imagekitio::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. # diff --git a/lib/imagekit/models/file_copy_params.rb b/lib/imagekitio/models/file_copy_params.rb similarity index 71% rename from lib/imagekit/models/file_copy_params.rb rename to lib/imagekitio/models/file_copy_params.rb index 3a481b8d..a43c52e9 100644 --- a/lib/imagekit/models/file_copy_params.rb +++ b/lib/imagekitio/models/file_copy_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Files#copy - class FileCopyParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Files#copy + class FileCopyParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute destination_path # Full path to the folder you want to copy the above file into. @@ -25,11 +25,11 @@ class FileCopyParams < Imagekit::Internal::Type::BaseModel # Default value - `false`. # # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + optional :include_file_versions, Imagekitio::Internal::Type::Boolean, api_name: :includeFileVersions # @!method initialize(destination_path:, source_file_path:, include_file_versions: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileCopyParams} for more details. + # {Imagekitio::Models::FileCopyParams} for more details. # # @param destination_path [String] Full path to the folder you want to copy the above file into. # @@ -37,7 +37,7 @@ class FileCopyParams < Imagekit::Internal::Type::BaseModel # # @param include_file_versions [Boolean] Option to copy all versions of a file. By default, only the current version of t # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekitio/models/file_copy_response.rb b/lib/imagekitio/models/file_copy_response.rb new file mode 100644 index 00000000..4e826b81 --- /dev/null +++ b/lib/imagekitio/models/file_copy_response.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Files#copy + class FileCopyResponse < Imagekitio::Internal::Type::BaseModel + # @!method initialize + end + end +end diff --git a/lib/imagekitio/models/file_delete_params.rb b/lib/imagekitio/models/file_delete_params.rb new file mode 100644 index 00000000..20b3a153 --- /dev/null +++ b/lib/imagekitio/models/file_delete_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Files#delete + class FileDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/file_get_params.rb b/lib/imagekitio/models/file_get_params.rb new file mode 100644 index 00000000..5bd7a0bc --- /dev/null +++ b/lib/imagekitio/models/file_get_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Files#get + class FileGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/models/file_move_params.rb b/lib/imagekitio/models/file_move_params.rb similarity index 67% rename from lib/imagekit/models/file_move_params.rb rename to lib/imagekitio/models/file_move_params.rb index 7af578f1..4b0f3ba0 100644 --- a/lib/imagekit/models/file_move_params.rb +++ b/lib/imagekitio/models/file_move_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Files#move - class FileMoveParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Files#move + class FileMoveParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute destination_path # Full path to the folder you want to move the above file into. @@ -21,13 +21,13 @@ class FileMoveParams < Imagekit::Internal::Type::BaseModel # @!method initialize(destination_path:, source_file_path:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileMoveParams} for more details. + # {Imagekitio::Models::FileMoveParams} for more details. # # @param destination_path [String] Full path to the folder you want to move the above file into. # # @param source_file_path [String] The full path of the file you want to move. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekitio/models/file_move_response.rb b/lib/imagekitio/models/file_move_response.rb new file mode 100644 index 00000000..039c8774 --- /dev/null +++ b/lib/imagekitio/models/file_move_response.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Files#move + class FileMoveResponse < Imagekitio::Internal::Type::BaseModel + # @!method initialize + end + end +end diff --git a/lib/imagekit/models/file_rename_params.rb b/lib/imagekitio/models/file_rename_params.rb similarity index 81% rename from lib/imagekit/models/file_rename_params.rb rename to lib/imagekitio/models/file_rename_params.rb index 692440d6..0960eaef 100644 --- a/lib/imagekit/models/file_rename_params.rb +++ b/lib/imagekitio/models/file_rename_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Files#rename - class FileRenameParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Files#rename + class FileRenameParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute file_path # The full path of the file you want to rename. @@ -43,11 +43,11 @@ class FileRenameParams < Imagekit::Internal::Type::BaseModel # Default value - `false` # # @return [Boolean, nil] - optional :purge_cache, Imagekit::Internal::Type::Boolean, api_name: :purgeCache + optional :purge_cache, Imagekitio::Internal::Type::Boolean, api_name: :purgeCache # @!method initialize(file_path:, new_file_name:, purge_cache: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRenameParams} for more details. + # {Imagekitio::Models::FileRenameParams} for more details. # # @param file_path [String] The full path of the file you want to rename. # @@ -55,7 +55,7 @@ class FileRenameParams < Imagekit::Internal::Type::BaseModel # # @param purge_cache [Boolean] Option to purge cache for the old file and its versions' URLs. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/models/file_rename_response.rb b/lib/imagekitio/models/file_rename_response.rb similarity index 73% rename from lib/imagekit/models/file_rename_response.rb rename to lib/imagekitio/models/file_rename_response.rb index 96b9be0e..0e1c3607 100644 --- a/lib/imagekit/models/file_rename_response.rb +++ b/lib/imagekitio/models/file_rename_response.rb @@ -1,9 +1,9 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Files#rename - class FileRenameResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Files#rename + class FileRenameResponse < Imagekitio::Internal::Type::BaseModel # @!attribute purge_request_id # Unique identifier of the purge request. This can be used to check the status of # the purge request. @@ -13,7 +13,7 @@ class FileRenameResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(purge_request_id: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRenameResponse} for more details. + # {Imagekitio::Models::FileRenameResponse} for more details. # # @param purge_request_id [String] Unique identifier of the purge request. This can be used to check the status of end diff --git a/lib/imagekitio/models/file_update_params.rb b/lib/imagekitio/models/file_update_params.rb new file mode 100644 index 00000000..47ebe5ba --- /dev/null +++ b/lib/imagekitio/models/file_update_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Files#update + class FileUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute update_file_request + # Schema for update file update request. + # + # @return [Imagekitio::Models::UpdateFileRequest::UpdateFileDetails, Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus] + required :update_file_request, union: -> { Imagekitio::UpdateFileRequest } + + # @!method initialize(update_file_request:, request_options: {}) + # @param update_file_request [Imagekitio::Models::UpdateFileRequest::UpdateFileDetails, Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus] Schema for update file update request. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/file_update_response.rb b/lib/imagekitio/models/file_update_response.rb new file mode 100644 index 00000000..225df77b --- /dev/null +++ b/lib/imagekitio/models/file_update_response.rb @@ -0,0 +1,104 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Files#update + class FileUpdateResponse < Imagekitio::Models::File + # @!attribute extension_status + # + # @return [Imagekitio::Models::FileUpdateResponse::ExtensionStatus, nil] + optional :extension_status, + -> { Imagekitio::Models::FileUpdateResponse::ExtensionStatus }, + api_name: :extensionStatus + + # @!method initialize(extension_status: nil) + # Object containing details of a file or file version. + # + # @param extension_status [Imagekitio::Models::FileUpdateResponse::ExtensionStatus] + + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel + # @!attribute ai_auto_description + # + # @return [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription, nil] + optional :ai_auto_description, + enum: -> { Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription }, + api_name: :"ai-auto-description" + + # @!attribute aws_auto_tagging + # + # @return [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging, nil] + optional :aws_auto_tagging, + enum: -> { Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging }, + api_name: :"aws-auto-tagging" + + # @!attribute google_auto_tagging + # + # @return [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging, nil] + optional :google_auto_tagging, + enum: -> { Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging }, + api_name: :"google-auto-tagging" + + # @!attribute remove_bg + # + # @return [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg, nil] + optional :remove_bg, + enum: -> { Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg }, + api_name: :"remove-bg" + + # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @param ai_auto_description [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription] + # @param aws_auto_tagging [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg] + + # @see Imagekitio::Models::FileUpdateResponse::ExtensionStatus#ai_auto_description + module AIAutoDescription + extend Imagekitio::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekitio::Models::FileUpdateResponse::ExtensionStatus#aws_auto_tagging + module AwsAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekitio::Models::FileUpdateResponse::ExtensionStatus#google_auto_tagging + module GoogleAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + + # @see Imagekitio::Models::FileUpdateResponse::ExtensionStatus#remove_bg + module RemoveBg + extend Imagekitio::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/imagekit/models/file_upload_params.rb b/lib/imagekitio/models/file_upload_params.rb similarity index 74% rename from lib/imagekit/models/file_upload_params.rb rename to lib/imagekitio/models/file_upload_params.rb index 3d8df9b3..d9e6a855 100644 --- a/lib/imagekit/models/file_upload_params.rb +++ b/lib/imagekitio/models/file_upload_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Files#upload - class FileUploadParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Files#upload + class FileUploadParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute file # The API accepts any of the following: @@ -18,8 +18,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # When supplying a URL, the server must receive the response headers within 8 # seconds; otherwise the request fails with 400 Bad Request. # - # @return [Pathname, StringIO, IO, String, Imagekit::FilePart] - required :file, Imagekit::Internal::Type::FileInput + # @return [Pathname, StringIO, IO, String, Imagekitio::FilePart] + required :file, Imagekitio::Internal::Type::FileInput # @!attribute file_name # The name with which the file has to be uploaded. The file name can contain: @@ -72,7 +72,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :customMetadata # @!attribute description @@ -94,8 +94,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] - optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } + # @return [Array, nil] + optional :extensions, -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem] } # @!attribute folder # The folder path in which the image has to be uploaded. If the folder(s) didn't @@ -118,7 +118,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # transformation or signed URL. # # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + optional :is_private_file, Imagekitio::Internal::Type::Boolean, api_name: :isPrivateFile # @!attribute is_published # Whether to upload file as published or not. @@ -131,14 +131,14 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # pricing plans. # # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + optional :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished # @!attribute overwrite_ai_tags # 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. # # @return [Boolean, nil] - optional :overwrite_ai_tags, Imagekit::Internal::Type::Boolean, api_name: :overwriteAITags + optional :overwrite_ai_tags, Imagekitio::Internal::Type::Boolean, api_name: :overwriteAITags # @!attribute overwrite_custom_metadata # If the request does not have `customMetadata`, and a file already exists at the @@ -146,7 +146,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :overwrite_custom_metadata, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :overwriteCustomMetadata # @!attribute overwrite_file @@ -154,14 +154,14 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # the exact location, upload API will return an error immediately. # # @return [Boolean, nil] - optional :overwrite_file, Imagekit::Internal::Type::Boolean, api_name: :overwriteFile + optional :overwrite_file, Imagekitio::Internal::Type::Boolean, api_name: :overwriteFile # @!attribute overwrite_tags # If the request does not have `tags`, and a file already exists at the exact # location, existing tags will be removed. # # @return [Boolean, nil] - optional :overwrite_tags, Imagekit::Internal::Type::Boolean, api_name: :overwriteTags + optional :overwrite_tags, Imagekitio::Internal::Type::Boolean, api_name: :overwriteTags # @!attribute public_key # Your ImageKit.io public key. This field is only required for authentication when @@ -173,9 +173,9 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # @!attribute response_fields # Array of response field keys to include in the API response body. # - # @return [Array, nil] + # @return [Array, nil] optional :response_fields, - -> { Imagekit::Internal::Type::ArrayOf[enum: Imagekit::FileUploadParams::ResponseField] }, + -> { Imagekitio::Internal::Type::ArrayOf[enum: Imagekitio::FileUploadParams::ResponseField] }, api_name: :responseFields # @!attribute signature @@ -196,7 +196,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # and the file is overwritten, the existing tags will be removed. # # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String] + optional :tags, Imagekitio::Internal::Type::ArrayOf[String] # @!attribute transformation # Configure pre-processing (`pre`) and post-processing (`post`) transformations. @@ -211,8 +211,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # You can mix and match any combination of post-processing types. # - # @return [Imagekit::Models::FileUploadParams::Transformation, nil] - optional :transformation, -> { Imagekit::FileUploadParams::Transformation } + # @return [Imagekitio::Models::FileUploadParams::Transformation, nil] + optional :transformation, -> { Imagekitio::FileUploadParams::Transformation } # @!attribute use_unique_file_name # Whether to use a unique filename for this file or not. @@ -224,7 +224,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # any existing file with the same name is replaced. # # @return [Boolean, nil] - optional :use_unique_file_name, Imagekit::Internal::Type::Boolean, api_name: :useUniqueFileName + optional :use_unique_file_name, Imagekitio::Internal::Type::Boolean, api_name: :useUniqueFileName # @!attribute webhook_url # The final status of extensions after they have completed execution will be @@ -237,9 +237,9 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams} for more details. + # {Imagekitio::Models::FileUploadParams} for more details. # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [Pathname, StringIO, IO, String, Imagekitio::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # @@ -255,7 +255,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -273,22 +273,22 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel # # @param public_key [String] Your ImageKit.io public key. This field is only required for authentication when # - # @param response_fields [Array] Array of response field keys to include in the API response body. + # @param response_fields [Array] Array of response field keys to include in the API response body. # # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a # # @param tags [Array] Set the tags while uploading the file. # - # @param transformation [Imagekit::Models::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. + # @param transformation [Imagekitio::Models::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. # # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not. # # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] module ResponseField - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TAGS = :tags CUSTOM_COORDINATES = :customCoordinates @@ -303,15 +303,15 @@ module ResponseField # @return [Array] end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute post # 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`. # - # @return [Array, nil] + # @return [Array, nil] optional :post, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::FileUploadParams::Transformation::Post] } + -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::FileUploadParams::Transformation::Post] } # @!attribute pre # Transformation string to apply before uploading the file to the Media Library. @@ -322,7 +322,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!method initialize(post: nil, pre: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation} for more details. + # {Imagekitio::Models::FileUploadParams::Transformation} for more details. # # Configure pre-processing (`pre`) and post-processing (`post`) transformations. # @@ -336,24 +336,24 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # You can mix and match any combination of post-processing types. # - # @param post [Array] List of transformations to apply _after_ the file is uploaded. + # @param post [Array] List of transformations to apply _after_ the file is uploaded. # # @param pre [String] Transformation string to apply before uploading the file to the Media Library. U module Post - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type - variant :transformation, -> { Imagekit::FileUploadParams::Transformation::Post::Transformation } + variant :transformation, -> { Imagekitio::FileUploadParams::Transformation::Post::Transformation } - variant :"gif-to-video", -> { Imagekit::FileUploadParams::Transformation::Post::GifToVideo } + variant :"gif-to-video", -> { Imagekitio::FileUploadParams::Transformation::Post::GifToVideo } - variant :thumbnail, -> { Imagekit::FileUploadParams::Transformation::Post::Thumbnail } + variant :thumbnail, -> { Imagekitio::FileUploadParams::Transformation::Post::Thumbnail } - variant :abs, -> { Imagekit::FileUploadParams::Transformation::Post::Abs } + variant :abs, -> { Imagekitio::FileUploadParams::Transformation::Post::Abs } - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute type # Transformation type. # @@ -369,7 +369,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!method initialize(value:, type: :transformation) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation::Post::Transformation} for + # {Imagekitio::Models::FileUploadParams::Transformation::Post::Transformation} for # more details. # # @param value [String] Transformation string (e.g. `w-200,h-200`). @@ -377,7 +377,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :transformation] Transformation type. end - class GifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekitio::Internal::Type::BaseModel # @!attribute type # Converts an animated GIF into an MP4. # @@ -393,15 +393,15 @@ class GifToVideo < Imagekit::Internal::Type::BaseModel # @!method initialize(value: nil, type: :"gif-to-video") # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation::Post::GifToVideo} for more - # details. + # {Imagekitio::Models::FileUploadParams::Transformation::Post::GifToVideo} for + # more details. # # @param value [String] Optional transformation string to apply to the output video. # # @param type [Symbol, :"gif-to-video"] Converts an animated GIF into an MP4. end - class Thumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekitio::Internal::Type::BaseModel # @!attribute type # Generates a thumbnail image. # @@ -417,7 +417,7 @@ class Thumbnail < Imagekit::Internal::Type::BaseModel # @!method initialize(value: nil, type: :thumbnail) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation::Post::Thumbnail} for more + # {Imagekitio::Models::FileUploadParams::Transformation::Post::Thumbnail} for more # details. # # @param value [String] Optional transformation string. @@ -425,12 +425,12 @@ class Thumbnail < Imagekit::Internal::Type::BaseModel # @param type [Symbol, :thumbnail] Generates a thumbnail image. end - class Abs < Imagekit::Internal::Type::BaseModel + class Abs < Imagekitio::Internal::Type::BaseModel # @!attribute protocol # Streaming protocol to use (`hls` or `dash`). # - # @return [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::Abs::Protocol] - required :protocol, enum: -> { Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol } + # @return [Symbol, Imagekitio::Models::FileUploadParams::Transformation::Post::Abs::Protocol] + required :protocol, enum: -> { Imagekitio::FileUploadParams::Transformation::Post::Abs::Protocol } # @!attribute type # Adaptive Bitrate Streaming (ABS) setup. @@ -446,10 +446,10 @@ class Abs < Imagekit::Internal::Type::BaseModel # @!method initialize(protocol:, value:, type: :abs) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams::Transformation::Post::Abs} for more + # {Imagekitio::Models::FileUploadParams::Transformation::Post::Abs} for more # details. # - # @param protocol [Symbol, Imagekit::Models::FileUploadParams::Transformation::Post::Abs::Protocol] Streaming protocol to use (`hls` or `dash`). + # @param protocol [Symbol, Imagekitio::Models::FileUploadParams::Transformation::Post::Abs::Protocol] Streaming protocol to use (`hls` or `dash`). # # @param value [String] List of different representations you want to create separated by an underscore. # @@ -457,9 +457,9 @@ class Abs < Imagekit::Internal::Type::BaseModel # Streaming protocol to use (`hls` or `dash`). # - # @see Imagekit::Models::FileUploadParams::Transformation::Post::Abs#protocol + # @see Imagekitio::Models::FileUploadParams::Transformation::Post::Abs#protocol module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS = :hls DASH = :dash @@ -470,7 +470,7 @@ module Protocol end # @!method self.variants - # @return [Array(Imagekit::Models::FileUploadParams::Transformation::Post::Transformation, Imagekit::Models::FileUploadParams::Transformation::Post::GifToVideo, Imagekit::Models::FileUploadParams::Transformation::Post::Thumbnail, Imagekit::Models::FileUploadParams::Transformation::Post::Abs)] + # @return [Array(Imagekitio::Models::FileUploadParams::Transformation::Post::Transformation, Imagekitio::Models::FileUploadParams::Transformation::Post::GifToVideo, Imagekitio::Models::FileUploadParams::Transformation::Post::Thumbnail, Imagekitio::Models::FileUploadParams::Transformation::Post::Abs)] end end end diff --git a/lib/imagekit/models/file_upload_response.rb b/lib/imagekitio/models/file_upload_response.rb similarity index 73% rename from lib/imagekit/models/file_upload_response.rb rename to lib/imagekitio/models/file_upload_response.rb index abf623b1..d5a95f96 100644 --- a/lib/imagekit/models/file_upload_response.rb +++ b/lib/imagekitio/models/file_upload_response.rb @@ -1,15 +1,15 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Files#upload - class FileUploadResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Files#upload + class FileUploadResponse < Imagekitio::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the uploaded file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadResponse::AITag] }, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Models::FileUploadResponse::AITag] }, api_name: :AITags, nil?: true @@ -43,7 +43,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :customMetadata # @!attribute description @@ -66,7 +66,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :embedded_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :embeddedMetadata # @!attribute extension_status @@ -80,9 +80,9 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # - # @return [Imagekit::Models::FileUploadResponse::ExtensionStatus, nil] + # @return [Imagekitio::Models::FileUploadResponse::ExtensionStatus, nil] optional :extension_status, - -> { Imagekit::Models::FileUploadResponse::ExtensionStatus }, + -> { Imagekitio::Models::FileUploadResponse::ExtensionStatus }, api_name: :extensionStatus # @!attribute file_id @@ -117,7 +117,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # field. # # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + optional :is_private_file, Imagekitio::Internal::Type::Boolean, api_name: :isPrivateFile # @!attribute is_published # Is the file published or in draft state. It can be either `true` or `false`. @@ -125,14 +125,14 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # field. # # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + optional :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished # @!attribute metadata # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. # - # @return [Imagekit::Models::Metadata, nil] - optional :metadata, -> { Imagekit::Metadata } + # @return [Imagekitio::Models::Metadata, nil] + optional :metadata, -> { Imagekitio::Metadata } # @!attribute name # Name of the asset. @@ -149,9 +149,9 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # Keys are the names of the custom metadata fields; the value object has details # about the custom metadata schema. # - # @return [Hash{Symbol=>Imagekit::Models::FileUploadResponse::SelectedFieldsSchema}, nil] + # @return [Hash{Symbol=>Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema}, nil] optional :selected_fields_schema, - -> { Imagekit::Internal::Type::HashOf[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema] }, + -> { Imagekitio::Internal::Type::HashOf[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema] }, api_name: :selectedFieldsSchema # @!attribute size @@ -166,7 +166,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # field. # # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + optional :tags, Imagekitio::Internal::Type::ArrayOf[String], nil?: true # @!attribute thumbnail_url # In the case of an image, a small thumbnail URL. @@ -183,8 +183,8 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object containing the file or file version's `id` (versionId) and `name`. # - # @return [Imagekit::Models::FileUploadResponse::VersionInfo, nil] - optional :version_info, -> { Imagekit::Models::FileUploadResponse::VersionInfo }, api_name: :versionInfo + # @return [Imagekitio::Models::FileUploadResponse::VersionInfo, nil] + optional :version_info, -> { Imagekitio::Models::FileUploadResponse::VersionInfo }, api_name: :versionInfo # @!attribute video_codec # The video codec used in the video (only for video). @@ -200,11 +200,11 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadResponse} for more details. + # {Imagekitio::Models::FileUploadResponse} for more details. # # Object containing details of a successful upload. # - # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. # # @param audio_codec [String] The audio codec used in the video (only for video). # @@ -220,7 +220,7 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, # - # @param extension_status [Imagekit::Models::FileUploadResponse::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # @param extension_status [Imagekitio::Models::FileUploadResponse::ExtensionStatus] Extension names with their processing status at the time of completion of the re # # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo # @@ -234,11 +234,11 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen # - # @param metadata [Imagekit::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # @param metadata [Imagekitio::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad # # @param name [String] Name of the asset. # - # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::FileUploadResponse::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa # # @param size [Float] Size of the image file in Bytes. # @@ -248,13 +248,13 @@ class FileUploadResponse < Imagekit::Internal::Type::BaseModel # # @param url [String] A publicly accessible URL of the file. # - # @param version_info [Imagekit::Models::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # @param version_info [Imagekitio::Models::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. # # @param video_codec [String] The video codec used in the video (only for video). # # @param width [Float] Width of the image in pixels (Only for Images) - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel # @!attribute confidence # Confidence score of the tag. # @@ -277,7 +277,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadResponse::AITag} for more details. + # {Imagekitio::Models::FileUploadResponse::AITag} for more details. # # @param confidence [Float] Confidence score of the tag. # @@ -286,34 +286,34 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be end - # @see Imagekit::Models::FileUploadResponse#extension_status - class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::FileUploadResponse#extension_status + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel # @!attribute ai_auto_description # - # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription, nil] + # @return [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription, nil] optional :ai_auto_description, - enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription }, + enum: -> { Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription }, api_name: :"ai-auto-description" # @!attribute aws_auto_tagging # - # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] + # @return [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] optional :aws_auto_tagging, - enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging }, + enum: -> { Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging }, api_name: :"aws-auto-tagging" # @!attribute google_auto_tagging # - # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging, nil] + # @return [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging, nil] optional :google_auto_tagging, - enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging }, + enum: -> { Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging }, api_name: :"google-auto-tagging" # @!attribute remove_bg # - # @return [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg, nil] + # @return [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg, nil] optional :remove_bg, - enum: -> { Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg }, + enum: -> { Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) @@ -327,14 +327,14 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # - # @param ai_auto_description [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription] - # @param aws_auto_tagging [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging] - # @param google_auto_tagging [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] - # @param remove_bg [Symbol, Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg] + # @param ai_auto_description [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription] + # @param aws_auto_tagging [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg] - # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#ai_auto_description + # @see Imagekitio::Models::FileUploadResponse::ExtensionStatus#ai_auto_description module AIAutoDescription - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -344,9 +344,9 @@ module AIAutoDescription # @return [Array] end - # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#aws_auto_tagging + # @see Imagekitio::Models::FileUploadResponse::ExtensionStatus#aws_auto_tagging module AwsAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -356,9 +356,9 @@ module AwsAutoTagging # @return [Array] end - # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#google_auto_tagging + # @see Imagekitio::Models::FileUploadResponse::ExtensionStatus#google_auto_tagging module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -368,9 +368,9 @@ module GoogleAutoTagging # @return [Array] end - # @see Imagekit::Models::FileUploadResponse::ExtensionStatus#remove_bg + # @see Imagekitio::Models::FileUploadResponse::ExtensionStatus#remove_bg module RemoveBg - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -381,12 +381,12 @@ module RemoveBg end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of the custom metadata field. # - # @return [Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type] - required :type, enum: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type } + # @return [Symbol, Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type } # @!attribute default_value # The default value for this custom metadata field. The value should match the @@ -394,14 +394,14 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, Boolean, Array, nil] optional :default_value, - union: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue }, + union: -> { Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue }, api_name: :defaultValue # @!attribute is_value_required # Specifies if the custom metadata field is required or not. # # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired # @!attribute max_length # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. @@ -416,7 +416,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :max_value, - union: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue }, + union: -> { Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue }, api_name: :maxValue # @!attribute min_length @@ -432,7 +432,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [String, Float, nil] optional :min_value, - union: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue }, + union: -> { Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue }, api_name: :minValue # @!attribute read_only @@ -441,14 +441,14 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # **Path policy** feature. # # @return [Boolean, nil] - optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + optional :read_only, Imagekitio::Internal::Type::Boolean, api_name: :readOnly # @!attribute select_options # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. # # @return [Array, nil] optional :select_options, - -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption] }, + -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption] }, api_name: :selectOptions # @!attribute select_options_truncated @@ -457,14 +457,14 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :select_options_truncated, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :selectOptionsTruncated # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadResponse::SelectedFieldsSchema} for more details. + # {Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema} for more details. # - # @param type [Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type] Type of the custom metadata field. + # @param type [Symbol, Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type] Type of the custom metadata field. # # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty # @@ -486,9 +486,9 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # Type of the custom metadata field. # - # @see Imagekit::Models::FileUploadResponse::SelectedFieldsSchema#type + # @see Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TEXT = :Text TEXTAREA = :Textarea @@ -505,27 +505,27 @@ module Type # The default value for this custom metadata field. The value should match the # `type` of custom metadata field. # - # @see Imagekit::Models::FileUploadResponse::SelectedFieldsSchema#default_value + # @see Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema#default_value module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::MixedArray } + variant -> { Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::MixedArray } module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] @@ -534,18 +534,18 @@ module Mixed # @!method self.variants # @return [Array(String, Float, Boolean, Array)] - # @type [Imagekit::Internal::Type::Converter] + # @type [Imagekitio::Internal::Type::Converter] MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed }] + Imagekitio::Internal::Type::ArrayOf[union: -> { Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed }] end # 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. # - # @see Imagekit::Models::FileUploadResponse::SelectedFieldsSchema#max_value + # @see Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema#max_value module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -559,9 +559,9 @@ module MaxValue # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::FileUploadResponse::SelectedFieldsSchema#min_value + # @see Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema#min_value module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -572,21 +572,21 @@ module MinValue end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] end end - # @see Imagekit::Models::FileUploadResponse#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::FileUploadResponse#version_info + class VersionInfo < Imagekitio::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. # diff --git a/lib/imagekit/models/files/bulk_add_tags_params.rb b/lib/imagekitio/models/files/bulk_add_tags_params.rb similarity index 54% rename from lib/imagekit/models/files/bulk_add_tags_params.rb rename to lib/imagekitio/models/files/bulk_add_tags_params.rb index 9c85f747..51dbca35 100644 --- a/lib/imagekit/models/files/bulk_add_tags_params.rb +++ b/lib/imagekitio/models/files/bulk_add_tags_params.rb @@ -1,34 +1,34 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Files - # @see Imagekit::Resources::Files::Bulk#add_tags - class BulkAddTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Files::Bulk#add_tags + class BulkAddTagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute file_ids # An array of fileIds to which you want to add tags. # # @return [Array] - required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + required :file_ids, Imagekitio::Internal::Type::ArrayOf[String], api_name: :fileIds # @!attribute tags # An array of tags that you want to add to the files. # # @return [Array] - required :tags, Imagekit::Internal::Type::ArrayOf[String] + required :tags, Imagekitio::Internal::Type::ArrayOf[String] # @!method initialize(file_ids:, tags:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkAddTagsParams} for more details. + # {Imagekitio::Models::Files::BulkAddTagsParams} for more details. # # @param file_ids [Array] An array of fileIds to which you want to add tags. # # @param tags [Array] An array of tags that you want to add to the files. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/models/files/bulk_add_tags_response.rb b/lib/imagekitio/models/files/bulk_add_tags_response.rb similarity index 69% rename from lib/imagekit/models/files/bulk_add_tags_response.rb rename to lib/imagekitio/models/files/bulk_add_tags_response.rb index 6bd30f2c..f03f4985 100644 --- a/lib/imagekit/models/files/bulk_add_tags_response.rb +++ b/lib/imagekitio/models/files/bulk_add_tags_response.rb @@ -1,21 +1,21 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Files - # @see Imagekit::Resources::Files::Bulk#add_tags - class BulkAddTagsResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Files::Bulk#add_tags + class BulkAddTagsResponse < Imagekitio::Internal::Type::BaseModel # @!attribute successfully_updated_file_ids # An array of fileIds that in which tags were successfully added. # # @return [Array, nil] optional :successfully_updated_file_ids, - Imagekit::Internal::Type::ArrayOf[String], + Imagekitio::Internal::Type::ArrayOf[String], api_name: :successfullyUpdatedFileIds # @!method initialize(successfully_updated_file_ids: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkAddTagsResponse} for more details. + # {Imagekitio::Models::Files::BulkAddTagsResponse} for more details. # # @param successfully_updated_file_ids [Array] An array of fileIds that in which tags were successfully added. end diff --git a/lib/imagekitio/models/files/bulk_delete_params.rb b/lib/imagekitio/models/files/bulk_delete_params.rb new file mode 100644 index 00000000..951adcc7 --- /dev/null +++ b/lib/imagekitio/models/files/bulk_delete_params.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Files + # @see Imagekitio::Resources::Files::Bulk#delete + class BulkDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute file_ids + # An array of fileIds which you want to delete. + # + # @return [Array] + required :file_ids, Imagekitio::Internal::Type::ArrayOf[String], api_name: :fileIds + + # @!method initialize(file_ids:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::Files::BulkDeleteParams} for more details. + # + # @param file_ids [Array] An array of fileIds which you want to delete. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/files/bulk_delete_response.rb b/lib/imagekitio/models/files/bulk_delete_response.rb similarity index 68% rename from lib/imagekit/models/files/bulk_delete_response.rb rename to lib/imagekitio/models/files/bulk_delete_response.rb index e2fabbfc..da29543c 100644 --- a/lib/imagekit/models/files/bulk_delete_response.rb +++ b/lib/imagekitio/models/files/bulk_delete_response.rb @@ -1,21 +1,21 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Files - # @see Imagekit::Resources::Files::Bulk#delete - class BulkDeleteResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Files::Bulk#delete + class BulkDeleteResponse < Imagekitio::Internal::Type::BaseModel # @!attribute successfully_deleted_file_ids # An array of fileIds that were successfully deleted. # # @return [Array, nil] optional :successfully_deleted_file_ids, - Imagekit::Internal::Type::ArrayOf[String], + Imagekitio::Internal::Type::ArrayOf[String], api_name: :successfullyDeletedFileIds # @!method initialize(successfully_deleted_file_ids: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkDeleteResponse} for more details. + # {Imagekitio::Models::Files::BulkDeleteResponse} for more details. # # @param successfully_deleted_file_ids [Array] An array of fileIds that were successfully deleted. end diff --git a/lib/imagekit/models/files/bulk_remove_ai_tags_params.rb b/lib/imagekitio/models/files/bulk_remove_ai_tags_params.rb similarity index 54% rename from lib/imagekit/models/files/bulk_remove_ai_tags_params.rb rename to lib/imagekitio/models/files/bulk_remove_ai_tags_params.rb index b050162f..0f566d0b 100644 --- a/lib/imagekit/models/files/bulk_remove_ai_tags_params.rb +++ b/lib/imagekitio/models/files/bulk_remove_ai_tags_params.rb @@ -1,34 +1,34 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Files - # @see Imagekit::Resources::Files::Bulk#remove_ai_tags - class BulkRemoveAITagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Files::Bulk#remove_ai_tags + class BulkRemoveAITagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute ai_tags # An array of AITags that you want to remove from the files. # # @return [Array] - required :ai_tags, Imagekit::Internal::Type::ArrayOf[String], api_name: :AITags + required :ai_tags, Imagekitio::Internal::Type::ArrayOf[String], api_name: :AITags # @!attribute file_ids # An array of fileIds from which you want to remove AITags. # # @return [Array] - required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + required :file_ids, Imagekitio::Internal::Type::ArrayOf[String], api_name: :fileIds # @!method initialize(ai_tags:, file_ids:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkRemoveAITagsParams} for more details. + # {Imagekitio::Models::Files::BulkRemoveAITagsParams} for more details. # # @param ai_tags [Array] An array of AITags that you want to remove from the files. # # @param file_ids [Array] An array of fileIds from which you want to remove AITags. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/models/files/bulk_remove_ai_tags_response.rb b/lib/imagekitio/models/files/bulk_remove_ai_tags_response.rb similarity index 68% rename from lib/imagekit/models/files/bulk_remove_ai_tags_response.rb rename to lib/imagekitio/models/files/bulk_remove_ai_tags_response.rb index 49fb07de..314fbe8e 100644 --- a/lib/imagekit/models/files/bulk_remove_ai_tags_response.rb +++ b/lib/imagekitio/models/files/bulk_remove_ai_tags_response.rb @@ -1,21 +1,21 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Files - # @see Imagekit::Resources::Files::Bulk#remove_ai_tags - class BulkRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Files::Bulk#remove_ai_tags + class BulkRemoveAITagsResponse < Imagekitio::Internal::Type::BaseModel # @!attribute successfully_updated_file_ids # An array of fileIds that in which AITags were successfully removed. # # @return [Array, nil] optional :successfully_updated_file_ids, - Imagekit::Internal::Type::ArrayOf[String], + Imagekitio::Internal::Type::ArrayOf[String], api_name: :successfullyUpdatedFileIds # @!method initialize(successfully_updated_file_ids: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkRemoveAITagsResponse} for more details. + # {Imagekitio::Models::Files::BulkRemoveAITagsResponse} for more details. # # @param successfully_updated_file_ids [Array] An array of fileIds that in which AITags were successfully removed. end diff --git a/lib/imagekit/models/files/bulk_remove_tags_params.rb b/lib/imagekitio/models/files/bulk_remove_tags_params.rb similarity index 54% rename from lib/imagekit/models/files/bulk_remove_tags_params.rb rename to lib/imagekitio/models/files/bulk_remove_tags_params.rb index e5a2bbea..6f99862f 100644 --- a/lib/imagekit/models/files/bulk_remove_tags_params.rb +++ b/lib/imagekitio/models/files/bulk_remove_tags_params.rb @@ -1,34 +1,34 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Files - # @see Imagekit::Resources::Files::Bulk#remove_tags - class BulkRemoveTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Files::Bulk#remove_tags + class BulkRemoveTagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute file_ids # An array of fileIds from which you want to remove tags. # # @return [Array] - required :file_ids, Imagekit::Internal::Type::ArrayOf[String], api_name: :fileIds + required :file_ids, Imagekitio::Internal::Type::ArrayOf[String], api_name: :fileIds # @!attribute tags # An array of tags that you want to remove from the files. # # @return [Array] - required :tags, Imagekit::Internal::Type::ArrayOf[String] + required :tags, Imagekitio::Internal::Type::ArrayOf[String] # @!method initialize(file_ids:, tags:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkRemoveTagsParams} for more details. + # {Imagekitio::Models::Files::BulkRemoveTagsParams} for more details. # # @param file_ids [Array] An array of fileIds from which you want to remove tags. # # @param tags [Array] An array of tags that you want to remove from the files. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/models/files/bulk_remove_tags_response.rb b/lib/imagekitio/models/files/bulk_remove_tags_response.rb similarity index 68% rename from lib/imagekit/models/files/bulk_remove_tags_response.rb rename to lib/imagekitio/models/files/bulk_remove_tags_response.rb index a36571e3..19d44f90 100644 --- a/lib/imagekit/models/files/bulk_remove_tags_response.rb +++ b/lib/imagekitio/models/files/bulk_remove_tags_response.rb @@ -1,21 +1,21 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Files - # @see Imagekit::Resources::Files::Bulk#remove_tags - class BulkRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Files::Bulk#remove_tags + class BulkRemoveTagsResponse < Imagekitio::Internal::Type::BaseModel # @!attribute successfully_updated_file_ids # An array of fileIds that in which tags were successfully removed. # # @return [Array, nil] optional :successfully_updated_file_ids, - Imagekit::Internal::Type::ArrayOf[String], + Imagekitio::Internal::Type::ArrayOf[String], api_name: :successfullyUpdatedFileIds # @!method initialize(successfully_updated_file_ids: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkRemoveTagsResponse} for more details. + # {Imagekitio::Models::Files::BulkRemoveTagsResponse} for more details. # # @param successfully_updated_file_ids [Array] An array of fileIds that in which tags were successfully removed. end diff --git a/lib/imagekit/models/files/metadata_get_from_url_params.rb b/lib/imagekitio/models/files/metadata_get_from_url_params.rb similarity index 54% rename from lib/imagekit/models/files/metadata_get_from_url_params.rb rename to lib/imagekitio/models/files/metadata_get_from_url_params.rb index 805ec5b6..84e51262 100644 --- a/lib/imagekit/models/files/metadata_get_from_url_params.rb +++ b/lib/imagekitio/models/files/metadata_get_from_url_params.rb @@ -1,12 +1,12 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Files - # @see Imagekit::Resources::Files::Metadata#get_from_url - class MetadataGetFromURLParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Files::Metadata#get_from_url + class MetadataGetFromURLParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute url # Should be a valid file URL. It should be accessible using your ImageKit.io @@ -17,11 +17,11 @@ class MetadataGetFromURLParams < Imagekit::Internal::Type::BaseModel # @!method initialize(url:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::MetadataGetFromURLParams} for more details. + # {Imagekitio::Models::Files::MetadataGetFromURLParams} for more details. # # @param url [String] Should be a valid file URL. It should be accessible using your ImageKit.io accou # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekitio/models/files/metadata_get_params.rb b/lib/imagekitio/models/files/metadata_get_params.rb new file mode 100644 index 00000000..6b5f56d5 --- /dev/null +++ b/lib/imagekitio/models/files/metadata_get_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Files + # @see Imagekitio::Resources::Files::Metadata#get + class MetadataGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/files/version_delete_params.rb b/lib/imagekitio/models/files/version_delete_params.rb new file mode 100644 index 00000000..d38adabb --- /dev/null +++ b/lib/imagekitio/models/files/version_delete_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Files + # @see Imagekitio::Resources::Files::Versions#delete + class VersionDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute file_id + # + # @return [String] + required :file_id, String + + # @!method initialize(file_id:, request_options: {}) + # @param file_id [String] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/files/version_delete_response.rb b/lib/imagekitio/models/files/version_delete_response.rb new file mode 100644 index 00000000..b904f5f9 --- /dev/null +++ b/lib/imagekitio/models/files/version_delete_response.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Files + # @see Imagekitio::Resources::Files::Versions#delete + class VersionDeleteResponse < Imagekitio::Internal::Type::BaseModel + # @!method initialize + end + end + end +end diff --git a/lib/imagekitio/models/files/version_get_params.rb b/lib/imagekitio/models/files/version_get_params.rb new file mode 100644 index 00000000..53a1e15e --- /dev/null +++ b/lib/imagekitio/models/files/version_get_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Files + # @see Imagekitio::Resources::Files::Versions#get + class VersionGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute file_id + # + # @return [String] + required :file_id, String + + # @!method initialize(file_id:, request_options: {}) + # @param file_id [String] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/files/version_list_params.rb b/lib/imagekitio/models/files/version_list_params.rb new file mode 100644 index 00000000..71d6bae9 --- /dev/null +++ b/lib/imagekitio/models/files/version_list_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Files + # @see Imagekitio::Resources::Files::Versions#list + class VersionListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekitio/models/files/version_list_response.rb b/lib/imagekitio/models/files/version_list_response.rb new file mode 100644 index 00000000..58464ab5 --- /dev/null +++ b/lib/imagekitio/models/files/version_list_response.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Files + # @type [Imagekitio::Internal::Type::Converter] + VersionListResponse = Imagekitio::Internal::Type::ArrayOf[-> { Imagekitio::File }] + end + end +end diff --git a/lib/imagekitio/models/files/version_restore_params.rb b/lib/imagekitio/models/files/version_restore_params.rb new file mode 100644 index 00000000..d3c6b2ea --- /dev/null +++ b/lib/imagekitio/models/files/version_restore_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Files + # @see Imagekitio::Resources::Files::Versions#restore + class VersionRestoreParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute file_id + # + # @return [String] + required :file_id, String + + # @!method initialize(file_id:, request_options: {}) + # @param file_id [String] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/folder.rb b/lib/imagekitio/models/folder.rb similarity index 80% rename from lib/imagekit/models/folder.rb rename to lib/imagekitio/models/folder.rb index 832ae2a1..4494e3dc 100644 --- a/lib/imagekit/models/folder.rb +++ b/lib/imagekitio/models/folder.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class Folder < Imagekit::Internal::Type::BaseModel + class Folder < Imagekitio::Internal::Type::BaseModel # @!attribute created_at # Date and time when the folder was created. The date and time is in ISO8601 # format. @@ -34,8 +34,8 @@ class Folder < Imagekit::Internal::Type::BaseModel # @!attribute type # Type of the asset. # - # @return [Symbol, Imagekit::Models::Folder::Type, nil] - optional :type, enum: -> { Imagekit::Folder::Type } + # @return [Symbol, Imagekitio::Models::Folder::Type, nil] + optional :type, enum: -> { Imagekitio::Folder::Type } # @!attribute updated_at # Date and time when the folder was last updated. The date and time is in ISO8601 @@ -45,8 +45,8 @@ class Folder < Imagekit::Internal::Type::BaseModel optional :updated_at, Time, api_name: :updatedAt # @!method initialize(created_at: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil) - # Some parameter documentations has been truncated, see {Imagekit::Models::Folder} - # for more details. + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::Folder} for more details. # # @param created_at [Time] Date and time when the folder was created. The date and time is in ISO8601 forma # @@ -56,15 +56,15 @@ class Folder < Imagekit::Internal::Type::BaseModel # # @param name [String] Name of the asset. # - # @param type [Symbol, Imagekit::Models::Folder::Type] Type of the asset. + # @param type [Symbol, Imagekitio::Models::Folder::Type] Type of the asset. # # @param updated_at [Time] Date and time when the folder was last updated. The date and time is in ISO8601 # Type of the asset. # - # @see Imagekit::Models::Folder#type + # @see Imagekitio::Models::Folder#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum FOLDER = :folder diff --git a/lib/imagekit/models/folder_copy_params.rb b/lib/imagekitio/models/folder_copy_params.rb similarity index 73% rename from lib/imagekit/models/folder_copy_params.rb rename to lib/imagekitio/models/folder_copy_params.rb index fabc4272..695c8823 100644 --- a/lib/imagekit/models/folder_copy_params.rb +++ b/lib/imagekitio/models/folder_copy_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Folders#copy - class FolderCopyParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Folders#copy + class FolderCopyParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute destination_path # Full path to the destination folder where you want to copy the source folder @@ -26,11 +26,11 @@ class FolderCopyParams < Imagekit::Internal::Type::BaseModel # true, all versions of each file will be copied. Default value - `false`. # # @return [Boolean, nil] - optional :include_versions, Imagekit::Internal::Type::Boolean, api_name: :includeVersions + optional :include_versions, Imagekitio::Internal::Type::Boolean, api_name: :includeVersions # @!method initialize(destination_path:, source_folder_path:, include_versions: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderCopyParams} for more details. + # {Imagekitio::Models::FolderCopyParams} for more details. # # @param destination_path [String] Full path to the destination folder where you want to copy the source folder int # @@ -38,7 +38,7 @@ class FolderCopyParams < Imagekit::Internal::Type::BaseModel # # @param include_versions [Boolean] Option to copy all versions of files that are nested inside the selected folder. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/models/folder_rename_response.rb b/lib/imagekitio/models/folder_copy_response.rb similarity index 75% rename from lib/imagekit/models/folder_rename_response.rb rename to lib/imagekitio/models/folder_copy_response.rb index 0ac8984b..89e02099 100644 --- a/lib/imagekit/models/folder_rename_response.rb +++ b/lib/imagekitio/models/folder_copy_response.rb @@ -1,9 +1,9 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Folders#rename - class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Folders#copy + class FolderCopyResponse < Imagekitio::Internal::Type::BaseModel # @!attribute job_id # Unique identifier of the bulk job. This can be used to check the status of the # bulk job. @@ -13,7 +13,7 @@ class FolderRenameResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(job_id:) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderRenameResponse} for more details. + # {Imagekitio::Models::FolderCopyResponse} for more details. # # Job submitted successfully. A `jobId` will be returned. # diff --git a/lib/imagekit/models/folder_create_params.rb b/lib/imagekitio/models/folder_create_params.rb similarity index 76% rename from lib/imagekit/models/folder_create_params.rb rename to lib/imagekitio/models/folder_create_params.rb index 05138b5b..d5b3279b 100644 --- a/lib/imagekit/models/folder_create_params.rb +++ b/lib/imagekitio/models/folder_create_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Folders#create - class FolderCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Folders#create + class FolderCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute folder_name # The folder will be created with this name. @@ -31,13 +31,13 @@ class FolderCreateParams < Imagekit::Internal::Type::BaseModel # @!method initialize(folder_name:, parent_folder_path:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderCreateParams} for more details. + # {Imagekitio::Models::FolderCreateParams} for more details. # # @param folder_name [String] The folder will be created with this name. # # @param parent_folder_path [String] The folder where the new folder should be created, for root use `/` else the pat # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekitio/models/folder_create_response.rb b/lib/imagekitio/models/folder_create_response.rb new file mode 100644 index 00000000..082dd539 --- /dev/null +++ b/lib/imagekitio/models/folder_create_response.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Folders#create + class FolderCreateResponse < Imagekitio::Internal::Type::BaseModel + # @!method initialize + end + end +end diff --git a/lib/imagekit/models/folder_delete_params.rb b/lib/imagekitio/models/folder_delete_params.rb similarity index 56% rename from lib/imagekit/models/folder_delete_params.rb rename to lib/imagekitio/models/folder_delete_params.rb index 8f4480d7..addc894f 100644 --- a/lib/imagekit/models/folder_delete_params.rb +++ b/lib/imagekitio/models/folder_delete_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Folders#delete - class FolderDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Folders#delete + class FolderDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute folder_path # Full path to the folder you want to delete. For example `/folder/to/delete/`. @@ -15,11 +15,11 @@ class FolderDeleteParams < Imagekit::Internal::Type::BaseModel # @!method initialize(folder_path:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderDeleteParams} for more details. + # {Imagekitio::Models::FolderDeleteParams} for more details. # # @param folder_path [String] Full path to the folder you want to delete. For example `/folder/to/delete/`. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekitio/models/folder_delete_response.rb b/lib/imagekitio/models/folder_delete_response.rb new file mode 100644 index 00000000..ae8b5d3d --- /dev/null +++ b/lib/imagekitio/models/folder_delete_response.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Folders#delete + class FolderDeleteResponse < Imagekitio::Internal::Type::BaseModel + # @!method initialize + end + end +end diff --git a/lib/imagekit/models/folder_move_params.rb b/lib/imagekitio/models/folder_move_params.rb similarity index 69% rename from lib/imagekit/models/folder_move_params.rb rename to lib/imagekitio/models/folder_move_params.rb index 86d6ccc9..460ae217 100644 --- a/lib/imagekit/models/folder_move_params.rb +++ b/lib/imagekitio/models/folder_move_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Folders#move - class FolderMoveParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Folders#move + class FolderMoveParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute destination_path # Full path to the destination folder where you want to move the source folder @@ -22,13 +22,13 @@ class FolderMoveParams < Imagekit::Internal::Type::BaseModel # @!method initialize(destination_path:, source_folder_path:, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderMoveParams} for more details. + # {Imagekitio::Models::FolderMoveParams} for more details. # # @param destination_path [String] Full path to the destination folder where you want to move the source folder int # # @param source_folder_path [String] The full path to the source folder you want to move. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/models/folder_move_response.rb b/lib/imagekitio/models/folder_move_response.rb similarity index 74% rename from lib/imagekit/models/folder_move_response.rb rename to lib/imagekitio/models/folder_move_response.rb index 8fa4b3ef..3129d29c 100644 --- a/lib/imagekit/models/folder_move_response.rb +++ b/lib/imagekitio/models/folder_move_response.rb @@ -1,9 +1,9 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Folders#move - class FolderMoveResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Folders#move + class FolderMoveResponse < Imagekitio::Internal::Type::BaseModel # @!attribute job_id # Unique identifier of the bulk job. This can be used to check the status of the # bulk job. @@ -13,7 +13,7 @@ class FolderMoveResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(job_id:) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderMoveResponse} for more details. + # {Imagekitio::Models::FolderMoveResponse} for more details. # # Job submitted successfully. A `jobId` will be returned. # diff --git a/lib/imagekit/models/folder_rename_params.rb b/lib/imagekitio/models/folder_rename_params.rb similarity index 80% rename from lib/imagekit/models/folder_rename_params.rb rename to lib/imagekitio/models/folder_rename_params.rb index 071d74c4..e04b6810 100644 --- a/lib/imagekit/models/folder_rename_params.rb +++ b/lib/imagekitio/models/folder_rename_params.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Folders#rename - class FolderRenameParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + # @see Imagekitio::Resources::Folders#rename + class FolderRenameParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters # @!attribute folder_path # The full path to the folder you want to rename. @@ -41,11 +41,11 @@ class FolderRenameParams < Imagekit::Internal::Type::BaseModel # Default value - `false` # # @return [Boolean, nil] - optional :purge_cache, Imagekit::Internal::Type::Boolean, api_name: :purgeCache + optional :purge_cache, Imagekitio::Internal::Type::Boolean, api_name: :purgeCache # @!method initialize(folder_path:, new_folder_name:, purge_cache: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderRenameParams} for more details. + # {Imagekitio::Models::FolderRenameParams} for more details. # # @param folder_path [String] The full path to the folder you want to rename. # @@ -53,7 +53,7 @@ class FolderRenameParams < Imagekit::Internal::Type::BaseModel # # @param purge_cache [Boolean] Option to purge cache for the old nested files and their versions' URLs. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/imagekit/models/folder_copy_response.rb b/lib/imagekitio/models/folder_rename_response.rb similarity index 73% rename from lib/imagekit/models/folder_copy_response.rb rename to lib/imagekitio/models/folder_rename_response.rb index a9deadc1..752e8430 100644 --- a/lib/imagekit/models/folder_copy_response.rb +++ b/lib/imagekitio/models/folder_rename_response.rb @@ -1,9 +1,9 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - # @see Imagekit::Resources::Folders#copy - class FolderCopyResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Folders#rename + class FolderRenameResponse < Imagekitio::Internal::Type::BaseModel # @!attribute job_id # Unique identifier of the bulk job. This can be used to check the status of the # bulk job. @@ -13,7 +13,7 @@ class FolderCopyResponse < Imagekit::Internal::Type::BaseModel # @!method initialize(job_id:) # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderCopyResponse} for more details. + # {Imagekitio::Models::FolderRenameResponse} for more details. # # Job submitted successfully. A `jobId` will be returned. # diff --git a/lib/imagekitio/models/folders/job_get_params.rb b/lib/imagekitio/models/folders/job_get_params.rb new file mode 100644 index 00000000..2e98d751 --- /dev/null +++ b/lib/imagekitio/models/folders/job_get_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + module Folders + # @see Imagekitio::Resources::Folders::Job#get + class JobGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/imagekit/models/folders/job_get_response.rb b/lib/imagekitio/models/folders/job_get_response.rb similarity index 61% rename from lib/imagekit/models/folders/job_get_response.rb rename to lib/imagekitio/models/folders/job_get_response.rb index efd0d528..25334451 100644 --- a/lib/imagekit/models/folders/job_get_response.rb +++ b/lib/imagekitio/models/folders/job_get_response.rb @@ -1,10 +1,10 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models module Folders - # @see Imagekit::Resources::Folders::Job#get - class JobGetResponse < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Resources::Folders::Job#get + class JobGetResponse < Imagekitio::Internal::Type::BaseModel # @!attribute job_id # Unique identifier of the bulk job. # @@ -21,32 +21,32 @@ class JobGetResponse < Imagekit::Internal::Type::BaseModel # @!attribute status # Status of the bulk job. # - # @return [Symbol, Imagekit::Models::Folders::JobGetResponse::Status, nil] - optional :status, enum: -> { Imagekit::Models::Folders::JobGetResponse::Status } + # @return [Symbol, Imagekitio::Models::Folders::JobGetResponse::Status, nil] + optional :status, enum: -> { Imagekitio::Models::Folders::JobGetResponse::Status } # @!attribute type # Type of the bulk job. # - # @return [Symbol, Imagekit::Models::Folders::JobGetResponse::Type, nil] - optional :type, enum: -> { Imagekit::Models::Folders::JobGetResponse::Type } + # @return [Symbol, Imagekitio::Models::Folders::JobGetResponse::Type, nil] + optional :type, enum: -> { Imagekitio::Models::Folders::JobGetResponse::Type } # @!method initialize(job_id: nil, purge_request_id: nil, status: nil, type: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Folders::JobGetResponse} for more details. + # {Imagekitio::Models::Folders::JobGetResponse} for more details. # # @param job_id [String] Unique identifier of the bulk job. # # @param purge_request_id [String] Unique identifier of the purge request. This will be present only if `purgeCache # - # @param status [Symbol, Imagekit::Models::Folders::JobGetResponse::Status] Status of the bulk job. + # @param status [Symbol, Imagekitio::Models::Folders::JobGetResponse::Status] Status of the bulk job. # - # @param type [Symbol, Imagekit::Models::Folders::JobGetResponse::Type] Type of the bulk job. + # @param type [Symbol, Imagekitio::Models::Folders::JobGetResponse::Type] Type of the bulk job. # Status of the bulk job. # - # @see Imagekit::Models::Folders::JobGetResponse#status + # @see Imagekitio::Models::Folders::JobGetResponse#status module Status - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum PENDING = :Pending COMPLETED = :Completed @@ -57,9 +57,9 @@ module Status # Type of the bulk job. # - # @see Imagekit::Models::Folders::JobGetResponse#type + # @see Imagekitio::Models::Folders::JobGetResponse#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum COPY_FOLDER = :COPY_FOLDER MOVE_FOLDER = :MOVE_FOLDER diff --git a/lib/imagekit/models/get_image_attributes_options.rb b/lib/imagekitio/models/get_image_attributes_options.rb similarity index 87% rename from lib/imagekit/models/get_image_attributes_options.rb rename to lib/imagekitio/models/get_image_attributes_options.rb index 29f8bae5..a8ee50b1 100644 --- a/lib/imagekit/models/get_image_attributes_options.rb +++ b/lib/imagekitio/models/get_image_attributes_options.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class GetImageAttributesOptions < Imagekit::Models::SrcOptions + class GetImageAttributesOptions < Imagekitio::Models::SrcOptions # @!attribute device_breakpoints # Custom list of **device-width breakpoints** in pixels. These define common # screen widths for responsive image generation. @@ -11,7 +11,7 @@ class GetImageAttributesOptions < Imagekit::Models::SrcOptions # automatically. # # @return [Array, nil] - optional :device_breakpoints, Imagekit::Internal::Type::ArrayOf[Float], api_name: :deviceBreakpoints + optional :device_breakpoints, Imagekitio::Internal::Type::ArrayOf[Float], api_name: :deviceBreakpoints # @!attribute image_breakpoints # Custom list of **image-specific breakpoints** in pixels. Useful for generating @@ -21,7 +21,7 @@ class GetImageAttributesOptions < Imagekit::Models::SrcOptions # `[16, 32, 48, 64, 96, 128, 256, 384]`. Sorted automatically. # # @return [Array, nil] - optional :image_breakpoints, Imagekit::Internal::Type::ArrayOf[Float], api_name: :imageBreakpoints + optional :image_breakpoints, Imagekitio::Internal::Type::ArrayOf[Float], api_name: :imageBreakpoints # @!attribute sizes # The value for the HTML `sizes` attribute (e.g., `"100vw"` or @@ -50,7 +50,7 @@ class GetImageAttributesOptions < Imagekit::Models::SrcOptions # @!method initialize(device_breakpoints: nil, image_breakpoints: nil, sizes: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::GetImageAttributesOptions} for more details. + # {Imagekitio::Models::GetImageAttributesOptions} for more details. # # Options for generating responsive image attributes including `src`, `srcSet`, # and `sizes` for HTML `` elements. This schema extends `SrcOptions` to add diff --git a/lib/imagekit/models/image_overlay.rb b/lib/imagekitio/models/image_overlay.rb similarity index 71% rename from lib/imagekit/models/image_overlay.rb rename to lib/imagekitio/models/image_overlay.rb index acd5bca8..401b77e5 100644 --- a/lib/imagekit/models/image_overlay.rb +++ b/lib/imagekitio/models/image_overlay.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class ImageOverlay < Imagekit::Models::BaseOverlay + class ImageOverlay < Imagekitio::Models::BaseOverlay # @!attribute input # Specifies the relative path to the image used as an overlay. # @@ -21,8 +21,8 @@ class ImageOverlay < Imagekit::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. # - # @return [Symbol, Imagekit::Models::ImageOverlay::Encoding, nil] - optional :encoding, enum: -> { Imagekit::ImageOverlay::Encoding } + # @return [Symbol, Imagekitio::Models::ImageOverlay::Encoding, nil] + optional :encoding, enum: -> { Imagekitio::ImageOverlay::Encoding } # @!attribute transformation # Array of transformations to be applied to the overlay image. Supported @@ -31,18 +31,18 @@ class ImageOverlay < Imagekit::Models::BaseOverlay # and # [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay). # - # @return [Array, nil] - optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } + # @return [Array, nil] + optional :transformation, -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Transformation] } # @!method initialize(input:, encoding: nil, transformation: nil, type: :image) # Some parameter documentations has been truncated, see - # {Imagekit::Models::ImageOverlay} for more details. + # {Imagekitio::Models::ImageOverlay} for more details. # # @param input [String] Specifies the relative path to the image used as an overlay. # - # @param encoding [Symbol, Imagekit::Models::ImageOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 + # @param encoding [Symbol, Imagekitio::Models::ImageOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 # - # @param transformation [Array] Array of transformations to be applied to the overlay image. Supported transform + # @param transformation [Array] Array of transformations to be applied to the overlay image. Supported transform # # @param type [Symbol, :image] @@ -52,7 +52,7 @@ class ImageOverlay < Imagekit::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. module Encoding - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AUTO = :auto PLAIN = :plain diff --git a/lib/imagekit/models/metadata.rb b/lib/imagekitio/models/metadata.rb similarity index 85% rename from lib/imagekit/models/metadata.rb rename to lib/imagekitio/models/metadata.rb index c02910dd..371ebc3b 100644 --- a/lib/imagekit/models/metadata.rb +++ b/lib/imagekitio/models/metadata.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class Metadata < Imagekit::Internal::Type::BaseModel + class Metadata < Imagekitio::Internal::Type::BaseModel # @!attribute audio_codec # The audio codec used in the video (only for video). # @@ -29,8 +29,8 @@ class Metadata < Imagekit::Internal::Type::BaseModel # @!attribute exif # - # @return [Imagekit::Models::Metadata::Exif, nil] - optional :exif, -> { Imagekit::Metadata::Exif } + # @return [Imagekitio::Models::Metadata::Exif, nil] + optional :exif, -> { Imagekitio::Metadata::Exif } # @!attribute format_ # The format of the file (e.g., 'jpg', 'mp4'). @@ -42,13 +42,13 @@ class Metadata < Imagekit::Internal::Type::BaseModel # Indicates if the image has a color profile. # # @return [Boolean, nil] - optional :has_color_profile, Imagekit::Internal::Type::Boolean, api_name: :hasColorProfile + optional :has_color_profile, Imagekitio::Internal::Type::Boolean, api_name: :hasColorProfile # @!attribute has_transparency # Indicates if the image contains transparent areas. # # @return [Boolean, nil] - optional :has_transparency, Imagekit::Internal::Type::Boolean, api_name: :hasTransparency + optional :has_transparency, Imagekitio::Internal::Type::Boolean, api_name: :hasTransparency # @!attribute height # The height of the image or video in pixels. @@ -97,7 +97,7 @@ class Metadata < Imagekit::Internal::Type::BaseModel # # @param duration [Integer] The duration of the video in seconds (only for video). # - # @param exif [Imagekit::Models::Metadata::Exif] + # @param exif [Imagekitio::Models::Metadata::Exif] # # @param format_ [String] The format of the file (e.g., 'jpg', 'mp4'). # @@ -117,58 +117,58 @@ class Metadata < Imagekit::Internal::Type::BaseModel # # @param width [Integer] The width of the image or video in pixels. - # @see Imagekit::Models::Metadata#exif - class Exif < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::Metadata#exif + class Exif < Imagekitio::Internal::Type::BaseModel # @!attribute exif # Object containing Exif details. # - # @return [Imagekit::Models::Metadata::Exif::Exif, nil] - optional :exif, -> { Imagekit::Metadata::Exif::Exif } + # @return [Imagekitio::Models::Metadata::Exif::Exif, nil] + optional :exif, -> { Imagekitio::Metadata::Exif::Exif } # @!attribute gps # Object containing GPS information. # - # @return [Imagekit::Models::Metadata::Exif::Gps, nil] - optional :gps, -> { Imagekit::Metadata::Exif::Gps } + # @return [Imagekitio::Models::Metadata::Exif::Gps, nil] + optional :gps, -> { Imagekitio::Metadata::Exif::Gps } # @!attribute image # Object containing EXIF image information. # - # @return [Imagekit::Models::Metadata::Exif::Image, nil] - optional :image, -> { Imagekit::Metadata::Exif::Image } + # @return [Imagekitio::Models::Metadata::Exif::Image, nil] + optional :image, -> { Imagekitio::Metadata::Exif::Image } # @!attribute interoperability # JSON object. # - # @return [Imagekit::Models::Metadata::Exif::Interoperability, nil] - optional :interoperability, -> { Imagekit::Metadata::Exif::Interoperability } + # @return [Imagekitio::Models::Metadata::Exif::Interoperability, nil] + optional :interoperability, -> { Imagekitio::Metadata::Exif::Interoperability } # @!attribute makernote # # @return [Hash{Symbol=>Object}, nil] - optional :makernote, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + optional :makernote, Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown] # @!attribute thumbnail # Object containing Thumbnail information. # - # @return [Imagekit::Models::Metadata::Exif::Thumbnail, nil] - optional :thumbnail, -> { Imagekit::Metadata::Exif::Thumbnail } + # @return [Imagekitio::Models::Metadata::Exif::Thumbnail, nil] + optional :thumbnail, -> { Imagekitio::Metadata::Exif::Thumbnail } # @!method initialize(exif: nil, gps: nil, image: nil, interoperability: nil, makernote: nil, thumbnail: nil) - # @param exif [Imagekit::Models::Metadata::Exif::Exif] Object containing Exif details. + # @param exif [Imagekitio::Models::Metadata::Exif::Exif] Object containing Exif details. # - # @param gps [Imagekit::Models::Metadata::Exif::Gps] Object containing GPS information. + # @param gps [Imagekitio::Models::Metadata::Exif::Gps] Object containing GPS information. # - # @param image [Imagekit::Models::Metadata::Exif::Image] Object containing EXIF image information. + # @param image [Imagekitio::Models::Metadata::Exif::Image] Object containing EXIF image information. # - # @param interoperability [Imagekit::Models::Metadata::Exif::Interoperability] JSON object. + # @param interoperability [Imagekitio::Models::Metadata::Exif::Interoperability] JSON object. # # @param makernote [Hash{Symbol=>Object}] # - # @param thumbnail [Imagekit::Models::Metadata::Exif::Thumbnail] Object containing Thumbnail information. + # @param thumbnail [Imagekitio::Models::Metadata::Exif::Thumbnail] Object containing Thumbnail information. - # @see Imagekit::Models::Metadata::Exif#exif - class Exif < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::Metadata::Exif#exif + class Exif < Imagekitio::Internal::Type::BaseModel # @!attribute aperture_value # # @return [Float, nil] @@ -330,12 +330,12 @@ class Exif < Imagekit::Internal::Type::BaseModel # @param white_balance [Integer] end - # @see Imagekit::Models::Metadata::Exif#gps - class Gps < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::Metadata::Exif#gps + class Gps < Imagekitio::Internal::Type::BaseModel # @!attribute gps_version_id # # @return [Array, nil] - optional :gps_version_id, Imagekit::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID + optional :gps_version_id, Imagekitio::Internal::Type::ArrayOf[Integer], api_name: :GPSVersionID # @!method initialize(gps_version_id: nil) # Object containing GPS information. @@ -343,8 +343,8 @@ class Gps < Imagekit::Internal::Type::BaseModel # @param gps_version_id [Array] end - # @see Imagekit::Models::Metadata::Exif#image - class Image < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::Metadata::Exif#image + class Image < Imagekitio::Internal::Type::BaseModel # @!attribute exif_offset # # @return [Integer, nil] @@ -416,8 +416,8 @@ class Image < Imagekit::Internal::Type::BaseModel # @param y_resolution [Integer] end - # @see Imagekit::Models::Metadata::Exif#interoperability - class Interoperability < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::Metadata::Exif#interoperability + class Interoperability < Imagekitio::Internal::Type::BaseModel # @!attribute interop_index # # @return [String, nil] @@ -435,8 +435,8 @@ class Interoperability < Imagekit::Internal::Type::BaseModel # @param interop_version [String] end - # @see Imagekit::Models::Metadata::Exif#thumbnail - class Thumbnail < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::Metadata::Exif#thumbnail + class Thumbnail < Imagekitio::Internal::Type::BaseModel # @!attribute compression # # @return [Integer, nil] diff --git a/lib/imagekitio/models/overlay.rb b/lib/imagekitio/models/overlay.rb new file mode 100644 index 00000000..458c59b8 --- /dev/null +++ b/lib/imagekitio/models/overlay.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # 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). + module Overlay + extend Imagekitio::Internal::Type::Union + + discriminator :type + + variant :text, -> { Imagekitio::TextOverlay } + + variant :image, -> { Imagekitio::ImageOverlay } + + variant :video, -> { Imagekitio::VideoOverlay } + + variant :subtitle, -> { Imagekitio::SubtitleOverlay } + + variant :solidColor, -> { Imagekitio::SolidColorOverlay } + + # @!method self.variants + # @return [Array(Imagekitio::Models::TextOverlay, Imagekitio::Models::ImageOverlay, Imagekitio::Models::VideoOverlay, Imagekitio::Models::SubtitleOverlay, Imagekitio::Models::SolidColorOverlay)] + end + end +end diff --git a/lib/imagekit/models/overlay_position.rb b/lib/imagekitio/models/overlay_position.rb similarity index 77% rename from lib/imagekit/models/overlay_position.rb rename to lib/imagekitio/models/overlay_position.rb index 1613fe15..88dfd814 100644 --- a/lib/imagekit/models/overlay_position.rb +++ b/lib/imagekitio/models/overlay_position.rb @@ -1,14 +1,14 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class OverlayPosition < Imagekit::Internal::Type::BaseModel + class OverlayPosition < Imagekitio::Internal::Type::BaseModel # @!attribute focus # Specifies the position of the overlay relative to the parent image or video. # Maps to `lfo` in the URL. # - # @return [Symbol, Imagekit::Models::OverlayPosition::Focus, nil] - optional :focus, enum: -> { Imagekit::OverlayPosition::Focus } + # @return [Symbol, Imagekitio::Models::OverlayPosition::Focus, nil] + optional :focus, enum: -> { Imagekitio::OverlayPosition::Focus } # @!attribute x # Specifies the x-coordinate of the top-left corner of the base asset where the @@ -18,7 +18,7 @@ class OverlayPosition < Imagekit::Internal::Type::BaseModel # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # # @return [Float, String, nil] - optional :x, union: -> { Imagekit::OverlayPosition::X } + optional :x, union: -> { Imagekitio::OverlayPosition::X } # @!attribute y_ # Specifies the y-coordinate of the top-left corner of the base asset where the @@ -28,13 +28,13 @@ class OverlayPosition < Imagekit::Internal::Type::BaseModel # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # # @return [Float, String, nil] - optional :y_, union: -> { Imagekit::OverlayPosition::Y }, api_name: :y + optional :y_, union: -> { Imagekitio::OverlayPosition::Y }, api_name: :y # @!method initialize(focus: nil, x: nil, y_: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::OverlayPosition} for more details. + # {Imagekitio::Models::OverlayPosition} for more details. # - # @param focus [Symbol, Imagekit::Models::OverlayPosition::Focus] Specifies the position of the overlay relative to the parent image or video. + # @param focus [Symbol, Imagekitio::Models::OverlayPosition::Focus] Specifies the position of the overlay relative to the parent image or video. # # @param x [Float, String] Specifies the x-coordinate of the top-left corner of the base asset where the ov # @@ -43,9 +43,9 @@ class OverlayPosition < Imagekit::Internal::Type::BaseModel # Specifies the position of the overlay relative to the parent image or video. # Maps to `lfo` in the URL. # - # @see Imagekit::Models::OverlayPosition#focus + # @see Imagekitio::Models::OverlayPosition#focus module Focus - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum CENTER = :center TOP = :top @@ -67,9 +67,9 @@ module Focus # about # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # - # @see Imagekit::Models::OverlayPosition#x + # @see Imagekitio::Models::OverlayPosition#x module X - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -85,9 +85,9 @@ module X # about # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # - # @see Imagekit::Models::OverlayPosition#y_ + # @see Imagekitio::Models::OverlayPosition#y_ module Y - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float diff --git a/lib/imagekit/models/overlay_timing.rb b/lib/imagekitio/models/overlay_timing.rb similarity index 83% rename from lib/imagekit/models/overlay_timing.rb rename to lib/imagekitio/models/overlay_timing.rb index 7e399421..2e00e42e 100644 --- a/lib/imagekit/models/overlay_timing.rb +++ b/lib/imagekitio/models/overlay_timing.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class OverlayTiming < Imagekit::Internal::Type::BaseModel + class OverlayTiming < Imagekitio::Internal::Type::BaseModel # @!attribute duration # 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` @@ -10,7 +10,7 @@ class OverlayTiming < Imagekit::Internal::Type::BaseModel # Applies only if the base asset is a video. Maps to `ldu` in the URL. # # @return [Float, String, nil] - optional :duration, union: -> { Imagekit::OverlayTiming::Duration } + optional :duration, union: -> { Imagekitio::OverlayTiming::Duration } # @!attribute end_ # Specifies the end time (in seconds) for when the overlay should disappear from @@ -20,7 +20,7 @@ class OverlayTiming < Imagekit::Internal::Type::BaseModel # the base asset is a video. Maps to `leo` in the URL. # # @return [Float, String, nil] - optional :end_, union: -> { Imagekit::OverlayTiming::End }, api_name: :end + optional :end_, union: -> { Imagekitio::OverlayTiming::End }, api_name: :end # @!attribute start # Specifies the start time (in seconds) for when the overlay should appear on the @@ -29,11 +29,11 @@ class OverlayTiming < Imagekit::Internal::Type::BaseModel # Applies only if the base asset is a video. Maps to `lso` in the URL. # # @return [Float, String, nil] - optional :start, union: -> { Imagekit::OverlayTiming::Start } + optional :start, union: -> { Imagekitio::OverlayTiming::Start } # @!method initialize(duration: nil, end_: nil, start: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::OverlayTiming} for more details. + # {Imagekitio::Models::OverlayTiming} for more details. # # @param duration [Float, String] Specifies the duration (in seconds) during which the overlay should appear on th # @@ -46,9 +46,9 @@ class OverlayTiming < Imagekit::Internal::Type::BaseModel # 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. # - # @see Imagekit::Models::OverlayTiming#duration + # @see Imagekitio::Models::OverlayTiming#duration module Duration - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -64,9 +64,9 @@ module Duration # 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. # - # @see Imagekit::Models::OverlayTiming#end_ + # @see Imagekitio::Models::OverlayTiming#end_ module End - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -81,9 +81,9 @@ module End # `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. # - # @see Imagekit::Models::OverlayTiming#start + # @see Imagekitio::Models::OverlayTiming#start module Start - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float diff --git a/lib/imagekit/models/responsive_image_attributes.rb b/lib/imagekitio/models/responsive_image_attributes.rb similarity index 89% rename from lib/imagekit/models/responsive_image_attributes.rb rename to lib/imagekitio/models/responsive_image_attributes.rb index d3b94580..5c0dd103 100644 --- a/lib/imagekit/models/responsive_image_attributes.rb +++ b/lib/imagekitio/models/responsive_image_attributes.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class ResponsiveImageAttributes < Imagekit::Internal::Type::BaseModel + class ResponsiveImageAttributes < Imagekitio::Internal::Type::BaseModel # @!attribute src # URL for the _largest_ candidate (assigned to plain `src`). # @@ -31,7 +31,7 @@ class ResponsiveImageAttributes < Imagekit::Internal::Type::BaseModel # @!method initialize(src:, sizes: nil, src_set: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::ResponsiveImageAttributes} for more details. + # {Imagekitio::Models::ResponsiveImageAttributes} for more details. # # Resulting set of attributes suitable for an HTML `` element. Useful for # enabling responsive image loading with `srcSet` and `sizes`. diff --git a/lib/imagekit/models/solid_color_overlay.rb b/lib/imagekitio/models/solid_color_overlay.rb similarity index 72% rename from lib/imagekit/models/solid_color_overlay.rb rename to lib/imagekitio/models/solid_color_overlay.rb index e9851237..3d88d6ee 100644 --- a/lib/imagekit/models/solid_color_overlay.rb +++ b/lib/imagekitio/models/solid_color_overlay.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class SolidColorOverlay < Imagekit::Models::BaseOverlay + class SolidColorOverlay < Imagekitio::Models::BaseOverlay # @!attribute color # 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 @@ -24,17 +24,17 @@ class SolidColorOverlay < Imagekit::Models::BaseOverlay # and # [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay). # - # @return [Array, nil] + # @return [Array, nil] optional :transformation, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::SolidColorOverlayTransformation] } + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::SolidColorOverlayTransformation] } # @!method initialize(color:, transformation: nil, type: :solidColor) # Some parameter documentations has been truncated, see - # {Imagekit::Models::SolidColorOverlay} for more details. + # {Imagekitio::Models::SolidColorOverlay} for more details. # # @param color [String] Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA # - # @param transformation [Array] Control width and height of the solid color overlay. Supported transformations d + # @param transformation [Array] Control width and height of the solid color overlay. Supported transformations d # # @param type [Symbol, :solidColor] end diff --git a/lib/imagekit/models/solid_color_overlay_transformation.rb b/lib/imagekitio/models/solid_color_overlay_transformation.rb similarity index 81% rename from lib/imagekit/models/solid_color_overlay_transformation.rb rename to lib/imagekitio/models/solid_color_overlay_transformation.rb index dacca6bb..a68593b1 100644 --- a/lib/imagekit/models/solid_color_overlay_transformation.rb +++ b/lib/imagekitio/models/solid_color_overlay_transformation.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel + class SolidColorOverlayTransformation < Imagekitio::Internal::Type::BaseModel # @!attribute alpha # Specifies the transparency level of the solid color overlay. Accepts integers # from `1` to `9`. @@ -24,7 +24,7 @@ class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel # [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). # # @return [Boolean, true, String, nil] - optional :gradient, union: -> { Imagekit::SolidColorOverlayTransformation::Gradient } + optional :gradient, union: -> { Imagekitio::SolidColorOverlayTransformation::Gradient } # @!attribute height # Controls the height of the solid color overlay. Accepts a numeric value or an @@ -32,7 +32,7 @@ class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # # @return [Float, String, nil] - optional :height, union: -> { Imagekit::SolidColorOverlayTransformation::Height } + optional :height, union: -> { Imagekitio::SolidColorOverlayTransformation::Height } # @!attribute radius # Specifies the corner radius of the solid color overlay. Set to `max` for @@ -40,7 +40,7 @@ class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel # [radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). # # @return [Float, Symbol, :max, nil] - optional :radius, union: -> { Imagekit::SolidColorOverlayTransformation::Radius } + optional :radius, union: -> { Imagekitio::SolidColorOverlayTransformation::Radius } # @!attribute width # Controls the width of the solid color overlay. Accepts a numeric value or an @@ -48,11 +48,11 @@ class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # # @return [Float, String, nil] - optional :width, union: -> { Imagekit::SolidColorOverlayTransformation::Width } + optional :width, union: -> { Imagekitio::SolidColorOverlayTransformation::Width } # @!method initialize(alpha: nil, background: nil, gradient: nil, height: nil, radius: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::SolidColorOverlayTransformation} for more details. + # {Imagekitio::Models::SolidColorOverlayTransformation} for more details. # # @param alpha [Float] Specifies the transparency level of the solid color overlay. Accepts integers fr # @@ -71,9 +71,9 @@ class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel # image. See # [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). # - # @see Imagekit::Models::SolidColorOverlayTransformation#gradient + # @see Imagekitio::Models::SolidColorOverlayTransformation#gradient module Gradient - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant const: true @@ -87,9 +87,9 @@ module Gradient # arithmetic expression. Learn about # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # - # @see Imagekit::Models::SolidColorOverlayTransformation#height + # @see Imagekitio::Models::SolidColorOverlayTransformation#height module Height - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -103,9 +103,9 @@ module Height # circular or oval shape. See # [radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). # - # @see Imagekit::Models::SolidColorOverlayTransformation#radius + # @see Imagekitio::Models::SolidColorOverlayTransformation#radius module Radius - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -119,9 +119,9 @@ module Radius # arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # - # @see Imagekit::Models::SolidColorOverlayTransformation#width + # @see Imagekitio::Models::SolidColorOverlayTransformation#width module Width - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float diff --git a/lib/imagekit/models/src_options.rb b/lib/imagekitio/models/src_options.rb similarity index 81% rename from lib/imagekit/models/src_options.rb rename to lib/imagekitio/models/src_options.rb index ed73d6c7..880df17d 100644 --- a/lib/imagekit/models/src_options.rb +++ b/lib/imagekitio/models/src_options.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class SrcOptions < Imagekit::Internal::Type::BaseModel + class SrcOptions < Imagekitio::Internal::Type::BaseModel # @!attribute src # 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, @@ -39,7 +39,7 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # is especially useful if you want to add a versioning parameter to your URLs. # # @return [Hash{Symbol=>String}, nil] - optional :query_parameters, Imagekit::Internal::Type::HashOf[String], api_name: :queryParameters + optional :query_parameters, Imagekitio::Internal::Type::HashOf[String], api_name: :queryParameters # @!attribute signed # Whether to sign the URL or not. Set this to `true` if you want to generate a @@ -49,7 +49,7 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls). # # @return [Boolean, nil] - optional :signed, Imagekit::Internal::Type::Boolean + optional :signed, Imagekitio::Internal::Type::Boolean # @!attribute transformation # An array of objects specifying the transformations to be applied in the URL. If @@ -57,8 +57,8 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # are specified as chained transformations. See # [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations). # - # @return [Array, nil] - optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } + # @return [Array, nil] + optional :transformation, -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Transformation] } # @!attribute transformation_position # By default, the transformation string is added as a query parameter in the URL, @@ -66,14 +66,14 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # path of the URL, set this to `path`. Learn more in the # [Transformations guide](https://imagekit.io/docs/transformations). # - # @return [Symbol, Imagekit::Models::TransformationPosition, nil] + # @return [Symbol, Imagekitio::Models::TransformationPosition, nil] optional :transformation_position, - enum: -> { Imagekit::TransformationPosition }, + enum: -> { Imagekitio::TransformationPosition }, api_name: :transformationPosition # @!method initialize(src:, url_endpoint:, expires_in: nil, query_parameters: nil, signed: nil, transformation: nil, transformation_position: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::SrcOptions} for more details. + # {Imagekitio::Models::SrcOptions} for more details. # # Options for generating ImageKit URLs with transformations. See the # [Transformations guide](https://imagekit.io/docs/transformations). @@ -88,9 +88,9 @@ class SrcOptions < Imagekit::Internal::Type::BaseModel # # @param signed [Boolean] Whether to sign the URL or not. Set this to `true` if you want to generate a sig # - # @param transformation [Array] An array of objects specifying the transformations to be applied in the URL. If + # @param transformation [Array] An array of objects specifying the transformations to be applied in the URL. If # - # @param transformation_position [Symbol, Imagekit::Models::TransformationPosition] By default, the transformation string is added as a query parameter in the URL, + # @param transformation_position [Symbol, Imagekitio::Models::TransformationPosition] By default, the transformation string is added as a query parameter in the URL, end end end diff --git a/lib/imagekit/models/streaming_resolution.rb b/lib/imagekitio/models/streaming_resolution.rb similarity index 90% rename from lib/imagekit/models/streaming_resolution.rb rename to lib/imagekitio/models/streaming_resolution.rb index c30c25e1..abd52f78 100644 --- a/lib/imagekit/models/streaming_resolution.rb +++ b/lib/imagekitio/models/streaming_resolution.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models # Available streaming resolutions for # [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming) module StreamingResolution - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum STREAMING_RESOLUTION_240 = :"240" STREAMING_RESOLUTION_360 = :"360" diff --git a/lib/imagekit/models/subtitle_overlay.rb b/lib/imagekitio/models/subtitle_overlay.rb similarity index 67% rename from lib/imagekit/models/subtitle_overlay.rb rename to lib/imagekitio/models/subtitle_overlay.rb index 4fc0a96b..70694b9b 100644 --- a/lib/imagekit/models/subtitle_overlay.rb +++ b/lib/imagekitio/models/subtitle_overlay.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class SubtitleOverlay < Imagekit::Models::BaseOverlay + class SubtitleOverlay < Imagekitio::Models::BaseOverlay # @!attribute input # Specifies the relative path to the subtitle file used as an overlay. # @@ -21,26 +21,26 @@ class SubtitleOverlay < Imagekit::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. # - # @return [Symbol, Imagekit::Models::SubtitleOverlay::Encoding, nil] - optional :encoding, enum: -> { Imagekit::SubtitleOverlay::Encoding } + # @return [Symbol, Imagekitio::Models::SubtitleOverlay::Encoding, nil] + optional :encoding, enum: -> { Imagekitio::SubtitleOverlay::Encoding } # @!attribute transformation # Control styling of the subtitle. See # [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer). # - # @return [Array, nil] + # @return [Array, nil] optional :transformation, - -> { Imagekit::Internal::Type::ArrayOf[Imagekit::SubtitleOverlayTransformation] } + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::SubtitleOverlayTransformation] } # @!method initialize(input:, encoding: nil, transformation: nil, type: :subtitle) # Some parameter documentations has been truncated, see - # {Imagekit::Models::SubtitleOverlay} for more details. + # {Imagekitio::Models::SubtitleOverlay} for more details. # # @param input [String] Specifies the relative path to the subtitle file used as an overlay. # - # @param encoding [Symbol, Imagekit::Models::SubtitleOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 + # @param encoding [Symbol, Imagekitio::Models::SubtitleOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 # - # @param transformation [Array] Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/doc + # @param transformation [Array] Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/doc # # @param type [Symbol, :subtitle] @@ -50,7 +50,7 @@ class SubtitleOverlay < Imagekit::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. module Encoding - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AUTO = :auto PLAIN = :plain diff --git a/lib/imagekit/models/subtitle_overlay_transformation.rb b/lib/imagekitio/models/subtitle_overlay_transformation.rb similarity index 87% rename from lib/imagekit/models/subtitle_overlay_transformation.rb rename to lib/imagekitio/models/subtitle_overlay_transformation.rb index a2586ae2..1e06adb3 100644 --- a/lib/imagekit/models/subtitle_overlay_transformation.rb +++ b/lib/imagekitio/models/subtitle_overlay_transformation.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel + class SubtitleOverlayTransformation < Imagekitio::Internal::Type::BaseModel # @!attribute background # 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). @@ -67,12 +67,12 @@ class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel # # [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) # - # @return [Symbol, Imagekit::Models::SubtitleOverlayTransformation::Typography, nil] - optional :typography, enum: -> { Imagekit::SubtitleOverlayTransformation::Typography } + # @return [Symbol, Imagekitio::Models::SubtitleOverlayTransformation::Typography, nil] + optional :typography, enum: -> { Imagekitio::SubtitleOverlayTransformation::Typography } # @!method initialize(background: nil, color: nil, font_family: nil, font_outline: nil, font_shadow: nil, font_size: nil, typography: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::SubtitleOverlayTransformation} for more details. + # {Imagekitio::Models::SubtitleOverlayTransformation} for more details. # # Subtitle styling options. # [Learn more](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) @@ -90,16 +90,16 @@ class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel # # @param font_size [Float] Sets the font size of subtitle text. # - # @param typography [Symbol, Imagekit::Models::SubtitleOverlayTransformation::Typography] Sets the typography style of the subtitle text. Supports values are `b` for bold + # @param typography [Symbol, Imagekitio::Models::SubtitleOverlayTransformation::Typography] Sets the typography style of the subtitle text. Supports values are `b` for bold # 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) # - # @see Imagekit::Models::SubtitleOverlayTransformation#typography + # @see Imagekitio::Models::SubtitleOverlayTransformation#typography module Typography - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum B = :b I = :i diff --git a/lib/imagekit/models/text_overlay.rb b/lib/imagekitio/models/text_overlay.rb similarity index 67% rename from lib/imagekit/models/text_overlay.rb rename to lib/imagekitio/models/text_overlay.rb index 523cf4ff..3f022e8d 100644 --- a/lib/imagekit/models/text_overlay.rb +++ b/lib/imagekitio/models/text_overlay.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class TextOverlay < Imagekit::Models::BaseOverlay + class TextOverlay < Imagekitio::Models::BaseOverlay # @!attribute text # Specifies the text to be displayed in the overlay. The SDK automatically handles # special characters and encoding. @@ -22,25 +22,26 @@ class TextOverlay < Imagekit::Models::BaseOverlay # (`ie-{base64}`), set this parameter to `base64`. To always use plain text # (`i-{input}`), set it to `plain`. # - # @return [Symbol, Imagekit::Models::TextOverlay::Encoding, nil] - optional :encoding, enum: -> { Imagekit::TextOverlay::Encoding } + # @return [Symbol, Imagekitio::Models::TextOverlay::Encoding, nil] + optional :encoding, enum: -> { Imagekitio::TextOverlay::Encoding } # @!attribute transformation # Control styling of the text overlay. See # [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay). # - # @return [Array, nil] - optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::TextOverlayTransformation] } + # @return [Array, nil] + optional :transformation, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::TextOverlayTransformation] } # @!method initialize(text:, encoding: nil, transformation: nil, type: :text) # Some parameter documentations has been truncated, see - # {Imagekit::Models::TextOverlay} for more details. + # {Imagekitio::Models::TextOverlay} for more details. # # @param text [String] Specifies the text to be displayed in the overlay. The SDK automatically handles # - # @param encoding [Symbol, Imagekit::Models::TextOverlay::Encoding] Text can be included in the layer as either `i-{input}` (plain text) or `ie-{bas + # @param encoding [Symbol, Imagekitio::Models::TextOverlay::Encoding] Text can be included in the layer as either `i-{input}` (plain text) or `ie-{bas # - # @param transformation [Array] Control styling of the text overlay. See [Text overlays](https://imagekit.io/doc + # @param transformation [Array] Control styling of the text overlay. See [Text overlays](https://imagekit.io/doc # # @param type [Symbol, :text] @@ -50,7 +51,7 @@ class TextOverlay < Imagekit::Models::BaseOverlay # (`ie-{base64}`), set this parameter to `base64`. To always use plain text # (`i-{input}`), set it to `plain`. module Encoding - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AUTO = :auto PLAIN = :plain diff --git a/lib/imagekit/models/text_overlay_transformation.rb b/lib/imagekitio/models/text_overlay_transformation.rb similarity index 78% rename from lib/imagekit/models/text_overlay_transformation.rb rename to lib/imagekitio/models/text_overlay_transformation.rb index 710ad972..3a2f4d41 100644 --- a/lib/imagekit/models/text_overlay_transformation.rb +++ b/lib/imagekitio/models/text_overlay_transformation.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel + class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel # @!attribute alpha # Specifies the transparency level of the text overlay. Accepts integers from `1` # to `9`. @@ -20,8 +20,8 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # @!attribute flip # Flip the text overlay horizontally, vertically, or both. # - # @return [Symbol, Imagekit::Models::TextOverlayTransformation::Flip, nil] - optional :flip, enum: -> { Imagekit::TextOverlayTransformation::Flip } + # @return [Symbol, Imagekitio::Models::TextOverlayTransformation::Flip, nil] + optional :flip, enum: -> { Imagekitio::TextOverlayTransformation::Flip } # @!attribute font_color # Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., @@ -45,15 +45,15 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # arithmetic expression. # # @return [Float, String, nil] - optional :font_size, union: -> { Imagekit::TextOverlayTransformation::FontSize }, api_name: :fontSize + optional :font_size, union: -> { Imagekitio::TextOverlayTransformation::FontSize }, api_name: :fontSize # @!attribute inner_alignment # Specifies the inner alignment of the text when width is more than the text # length. # - # @return [Symbol, Imagekit::Models::TextOverlayTransformation::InnerAlignment, nil] + # @return [Symbol, Imagekitio::Models::TextOverlayTransformation::InnerAlignment, nil] optional :inner_alignment, - enum: -> { Imagekit::TextOverlayTransformation::InnerAlignment }, + enum: -> { Imagekitio::TextOverlayTransformation::InnerAlignment }, api_name: :innerAlignment # @!attribute line_height @@ -64,7 +64,7 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # # @return [Float, String, nil] optional :line_height, - union: -> { Imagekit::TextOverlayTransformation::LineHeight }, + union: -> { Imagekitio::TextOverlayTransformation::LineHeight }, api_name: :lineHeight # @!attribute padding @@ -73,21 +73,21 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # shorthand order). Arithmetic expressions are also accepted. # # @return [Float, String, nil] - optional :padding, union: -> { Imagekit::TextOverlayTransformation::Padding } + optional :padding, union: -> { Imagekitio::TextOverlayTransformation::Padding } # @!attribute radius # Specifies the corner radius of the text overlay. Set to `max` to achieve a # circular or oval shape. # # @return [Float, Symbol, :max, nil] - optional :radius, union: -> { Imagekit::TextOverlayTransformation::Radius } + optional :radius, union: -> { Imagekitio::TextOverlayTransformation::Radius } # @!attribute rotation # 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. # # @return [Float, String, nil] - optional :rotation, union: -> { Imagekit::TextOverlayTransformation::Rotation } + optional :rotation, union: -> { Imagekitio::TextOverlayTransformation::Rotation } # @!attribute typography # Specifies the typography style of the text. Supported values: @@ -106,17 +106,17 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # # @return [Float, String, nil] - optional :width, union: -> { Imagekit::TextOverlayTransformation::Width } + optional :width, union: -> { Imagekitio::TextOverlayTransformation::Width } # @!method initialize(alpha: nil, background: nil, flip: nil, font_color: nil, font_family: nil, font_size: nil, inner_alignment: nil, line_height: nil, padding: nil, radius: nil, rotation: nil, typography: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::TextOverlayTransformation} for more details. + # {Imagekitio::Models::TextOverlayTransformation} for more details. # # @param alpha [Float] Specifies the transparency level of the text overlay. Accepts integers from `1` # # @param background [String] Specifies the background color of the text overlay. # - # @param flip [Symbol, Imagekit::Models::TextOverlayTransformation::Flip] Flip the text overlay horizontally, vertically, or both. + # @param flip [Symbol, Imagekitio::Models::TextOverlayTransformation::Flip] Flip the text overlay horizontally, vertically, or both. # # @param font_color [String] Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `F # @@ -124,7 +124,7 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # # @param font_size [Float, String] Specifies the font size of the overlaid text. Accepts a numeric value or an arit # - # @param inner_alignment [Symbol, Imagekit::Models::TextOverlayTransformation::InnerAlignment] Specifies the inner alignment of the text when width is more than the text lengt + # @param inner_alignment [Symbol, Imagekitio::Models::TextOverlayTransformation::InnerAlignment] Specifies the inner alignment of the text when width is more than the text lengt # # @param line_height [Float, String] Specifies the line height of the text overlay. # @@ -140,9 +140,9 @@ class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel # Flip the text overlay horizontally, vertically, or both. # - # @see Imagekit::Models::TextOverlayTransformation#flip + # @see Imagekitio::Models::TextOverlayTransformation#flip module Flip - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum H = :h V = :v @@ -156,9 +156,9 @@ module Flip # Specifies the font size of the overlaid text. Accepts a numeric value or an # arithmetic expression. # - # @see Imagekit::Models::TextOverlayTransformation#font_size + # @see Imagekitio::Models::TextOverlayTransformation#font_size module FontSize - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -171,9 +171,9 @@ module FontSize # Specifies the inner alignment of the text when width is more than the text # length. # - # @see Imagekit::Models::TextOverlayTransformation#inner_alignment + # @see Imagekitio::Models::TextOverlayTransformation#inner_alignment module InnerAlignment - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum LEFT = :left RIGHT = :right @@ -188,9 +188,9 @@ module InnerAlignment # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations) # such as `bw_mul_0.2`, or `bh_div_20`. # - # @see Imagekit::Models::TextOverlayTransformation#line_height + # @see Imagekitio::Models::TextOverlayTransformation#line_height module LineHeight - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -204,9 +204,9 @@ module LineHeight # positive integer or multiple values separated by underscores (following CSS # shorthand order). Arithmetic expressions are also accepted. # - # @see Imagekit::Models::TextOverlayTransformation#padding + # @see Imagekitio::Models::TextOverlayTransformation#padding module Padding - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -219,9 +219,9 @@ module Padding # Specifies the corner radius of the text overlay. Set to `max` to achieve a # circular or oval shape. # - # @see Imagekit::Models::TextOverlayTransformation#radius + # @see Imagekitio::Models::TextOverlayTransformation#radius module Radius - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -234,9 +234,9 @@ module 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. # - # @see Imagekit::Models::TextOverlayTransformation#rotation + # @see Imagekitio::Models::TextOverlayTransformation#rotation module Rotation - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -251,9 +251,9 @@ module Rotation # supported. Useful when used in conjunction with the `background`. Learn about # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). # - # @see Imagekit::Models::TextOverlayTransformation#width + # @see Imagekitio::Models::TextOverlayTransformation#width module Width - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float diff --git a/lib/imagekit/models/transformation.rb b/lib/imagekitio/models/transformation.rb similarity index 79% rename from lib/imagekit/models/transformation.rb rename to lib/imagekitio/models/transformation.rb index cd72bdb1..7fe5deb9 100644 --- a/lib/imagekit/models/transformation.rb +++ b/lib/imagekitio/models/transformation.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute ai_change_background # 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]`. @@ -21,7 +21,11 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). # # @return [Boolean, true, String, nil] - optional :ai_drop_shadow, union: -> { Imagekit::Transformation::AIDropShadow }, api_name: :aiDropShadow + optional :ai_drop_shadow, + union: -> { + Imagekitio::Transformation::AIDropShadow + }, + api_name: :aiDropShadow # @!attribute ai_edit # Uses AI to edit images based on a text prompt. Provide a text prompt or a @@ -36,9 +40,9 @@ class Transformation < Imagekit::Internal::Type::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). # - # @return [Boolean, Imagekit::Models::Transformation::AIRemoveBackground, nil] + # @return [Boolean, Imagekitio::Models::Transformation::AIRemoveBackground, nil] optional :ai_remove_background, - enum: -> { Imagekit::Transformation::AIRemoveBackground }, + enum: -> { Imagekitio::Transformation::AIRemoveBackground }, api_name: :aiRemoveBackground # @!attribute ai_remove_background_external @@ -47,9 +51,9 @@ class Transformation < Imagekit::Internal::Type::BaseModel # Supported inside overlay. See # [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). # - # @return [Boolean, Imagekit::Models::Transformation::AIRemoveBackgroundExternal, nil] + # @return [Boolean, Imagekitio::Models::Transformation::AIRemoveBackgroundExternal, nil] optional :ai_remove_background_external, - enum: -> { Imagekit::Transformation::AIRemoveBackgroundExternal }, + enum: -> { Imagekitio::Transformation::AIRemoveBackgroundExternal }, api_name: :aiRemoveBackgroundExternal # @!attribute ai_retouch @@ -57,16 +61,16 @@ class Transformation < Imagekit::Internal::Type::BaseModel # inside overlay. See # [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). # - # @return [Boolean, Imagekit::Models::Transformation::AIRetouch, nil] - optional :ai_retouch, enum: -> { Imagekit::Transformation::AIRetouch }, api_name: :aiRetouch + # @return [Boolean, Imagekitio::Models::Transformation::AIRetouch, nil] + optional :ai_retouch, enum: -> { Imagekitio::Transformation::AIRetouch }, api_name: :aiRetouch # @!attribute ai_upscale # Upscales images beyond their original dimensions using AI. Not supported inside # overlay. See # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). # - # @return [Boolean, Imagekit::Models::Transformation::AIUpscale, nil] - optional :ai_upscale, enum: -> { Imagekit::Transformation::AIUpscale }, api_name: :aiUpscale + # @return [Boolean, Imagekitio::Models::Transformation::AIUpscale, nil] + optional :ai_upscale, enum: -> { Imagekitio::Transformation::AIUpscale }, api_name: :aiUpscale # @!attribute ai_variation # Generates a variation of an image using AI. This produces a new image with @@ -75,8 +79,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # original image. Not supported inside overlay. See # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). # - # @return [Boolean, Imagekit::Models::Transformation::AIVariation, nil] - optional :ai_variation, enum: -> { Imagekit::Transformation::AIVariation }, api_name: :aiVariation + # @return [Boolean, Imagekitio::Models::Transformation::AIVariation, nil] + optional :ai_variation, enum: -> { Imagekitio::Transformation::AIVariation }, api_name: :aiVariation # @!attribute aspect_ratio # Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with @@ -85,14 +89,14 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar). # # @return [Float, String, nil] - optional :aspect_ratio, union: -> { Imagekit::Transformation::AspectRatio }, api_name: :aspectRatio + optional :aspect_ratio, union: -> { Imagekitio::Transformation::AspectRatio }, api_name: :aspectRatio # @!attribute audio_codec # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). # - # @return [Symbol, Imagekit::Models::Transformation::AudioCodec, nil] - optional :audio_codec, enum: -> { Imagekit::Transformation::AudioCodec }, api_name: :audioCodec + # @return [Symbol, Imagekitio::Models::Transformation::AudioCodec, nil] + optional :audio_codec, enum: -> { Imagekitio::Transformation::AudioCodec }, api_name: :audioCodec # @!attribute background # Specifies the background to be used in conjunction with certain cropping @@ -133,30 +137,30 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp). # # @return [Boolean, nil] - optional :color_profile, Imagekit::Internal::Type::Boolean, api_name: :colorProfile + optional :color_profile, Imagekitio::Internal::Type::Boolean, api_name: :colorProfile # @!attribute contrast_stretch # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). # - # @return [Boolean, Imagekit::Models::Transformation::ContrastStretch, nil] + # @return [Boolean, Imagekitio::Models::Transformation::ContrastStretch, nil] optional :contrast_stretch, - enum: -> { Imagekit::Transformation::ContrastStretch }, + enum: -> { Imagekitio::Transformation::ContrastStretch }, api_name: :contrastStretch # @!attribute crop # Crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). # - # @return [Symbol, Imagekit::Models::Transformation::Crop, nil] - optional :crop, enum: -> { Imagekit::Transformation::Crop } + # @return [Symbol, Imagekitio::Models::Transformation::Crop, nil] + optional :crop, enum: -> { Imagekitio::Transformation::Crop } # @!attribute crop_mode # Additional crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). # - # @return [Symbol, Imagekit::Models::Transformation::CropMode, nil] - optional :crop_mode, enum: -> { Imagekit::Transformation::CropMode }, api_name: :cropMode + # @return [Symbol, Imagekitio::Models::Transformation::CropMode, nil] + optional :crop_mode, enum: -> { Imagekitio::Transformation::CropMode }, api_name: :cropMode # @!attribute default_image # Specifies a fallback image if the resource is not found, e.g., a URL or file @@ -181,7 +185,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). # # @return [Float, String, nil] - optional :duration, union: -> { Imagekit::Transformation::Duration } + optional :duration, union: -> { Imagekitio::Transformation::Duration } # @!attribute end_offset # Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. @@ -190,15 +194,15 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). # # @return [Float, String, nil] - optional :end_offset, union: -> { Imagekit::Transformation::EndOffset }, api_name: :endOffset + optional :end_offset, union: -> { Imagekitio::Transformation::EndOffset }, api_name: :endOffset # @!attribute flip # 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). # - # @return [Symbol, Imagekit::Models::Transformation::Flip, nil] - optional :flip, enum: -> { Imagekit::Transformation::Flip } + # @return [Symbol, Imagekitio::Models::Transformation::Flip, nil] + optional :flip, enum: -> { Imagekitio::Transformation::Flip } # @!attribute focus # Refines padding and cropping behavior for pad resize, maintain ratio, and @@ -222,8 +226,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Image format](https://imagekit.io/docs/image-optimization#format---f) and # [Video format](https://imagekit.io/docs/video-optimization#format---f). # - # @return [Symbol, Imagekit::Models::Transformation::Format, nil] - optional :format_, enum: -> { Imagekit::Transformation::Format }, api_name: :format + # @return [Symbol, Imagekitio::Models::Transformation::Format, nil] + optional :format_, enum: -> { Imagekitio::Transformation::Format }, api_name: :format # @!attribute gradient # Creates a linear gradient with two colors. Pass `true` for a default gradient, @@ -231,14 +235,14 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). # # @return [Boolean, true, String, nil] - optional :gradient, union: -> { Imagekit::Transformation::Gradient } + optional :gradient, union: -> { Imagekitio::Transformation::Gradient } # @!attribute grayscale # Enables a grayscale effect for images. See # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). # - # @return [Boolean, Imagekit::Models::Transformation::Grayscale, nil] - optional :grayscale, enum: -> { Imagekit::Transformation::Grayscale } + # @return [Boolean, Imagekitio::Models::Transformation::Grayscale, nil] + optional :grayscale, enum: -> { Imagekitio::Transformation::Grayscale } # @!attribute height # Specifies the height of the output. If a value between 0 and 1 is provided, it @@ -249,7 +253,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h) # # @return [Float, String, nil] - optional :height, union: -> { Imagekit::Transformation::Height } + optional :height, union: -> { Imagekitio::Transformation::Height } # @!attribute lossless # Specifies whether the output image (in JPEG or PNG) should be compressed @@ -257,7 +261,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo). # # @return [Boolean, nil] - optional :lossless, Imagekit::Internal::Type::Boolean + optional :lossless, Imagekitio::Internal::Type::Boolean # @!attribute metadata # By default, ImageKit removes all metadata during automatic image compression. @@ -265,7 +269,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md). # # @return [Boolean, nil] - optional :metadata, Imagekit::Internal::Type::Boolean + optional :metadata, Imagekitio::Internal::Type::Boolean # @!attribute named # Named transformation reference. See @@ -287,7 +291,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true). # # @return [Boolean, nil] - optional :original, Imagekit::Internal::Type::Boolean + optional :original, Imagekitio::Internal::Type::Boolean # @!attribute overlay # Specifies an overlay to be applied on the parent image or video. ImageKit @@ -295,8 +299,8 @@ class Transformation < Imagekit::Internal::Type::BaseModel # See # [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers). # - # @return [Imagekit::Models::Overlay, nil] - optional :overlay, union: -> { Imagekit::Overlay } + # @return [Imagekitio::Models::Overlay, nil] + optional :overlay, union: -> { Imagekitio::Overlay } # @!attribute page # Extracts a specific page or frame from multi-page or layered files (PDF, PSD, @@ -305,7 +309,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files). # # @return [Float, String, nil] - optional :page, union: -> { Imagekit::Transformation::Page } + optional :page, union: -> { Imagekitio::Transformation::Page } # @!attribute progressive # Specifies whether the output JPEG image should be rendered progressively. @@ -314,7 +318,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr). # # @return [Boolean, nil] - optional :progressive, Imagekit::Internal::Type::Boolean + optional :progressive, Imagekitio::Internal::Type::Boolean # @!attribute quality # Specifies the quality of the output image for lossy formats such as JPEG, WebP, @@ -331,7 +335,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). # # @return [Float, Symbol, :max, nil] - optional :radius, union: -> { Imagekit::Transformation::Radius } + optional :radius, union: -> { Imagekitio::Transformation::Radius } # @!attribute raw # Pass any transformation not directly supported by the SDK. This transformation @@ -348,7 +352,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). # # @return [Float, String, nil] - optional :rotation, union: -> { Imagekit::Transformation::Rotation } + optional :rotation, union: -> { Imagekitio::Transformation::Rotation } # @!attribute shadow # Adds a shadow beneath solid objects in an image with a transparent background. @@ -357,7 +361,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). # # @return [Boolean, true, String, nil] - optional :shadow, union: -> { Imagekit::Transformation::Shadow } + optional :shadow, union: -> { Imagekitio::Transformation::Shadow } # @!attribute sharpen # Sharpens the input image, highlighting edges and finer details. Pass `true` for @@ -365,7 +369,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). # # @return [Boolean, true, Float, nil] - optional :sharpen, union: -> { Imagekit::Transformation::Sharpen } + optional :sharpen, union: -> { Imagekitio::Transformation::Sharpen } # @!attribute start_offset # Specifies the start offset (in seconds) for trimming videos, e.g., `5` or @@ -373,16 +377,16 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). # # @return [Float, String, nil] - optional :start_offset, union: -> { Imagekit::Transformation::StartOffset }, api_name: :startOffset + optional :start_offset, union: -> { Imagekitio::Transformation::StartOffset }, api_name: :startOffset # @!attribute streaming_resolutions # 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). # - # @return [Array, nil] + # @return [Array, nil] optional :streaming_resolutions, - -> { Imagekit::Internal::Type::ArrayOf[enum: Imagekit::StreamingResolution] }, + -> { Imagekitio::Internal::Type::ArrayOf[enum: Imagekitio::StreamingResolution] }, api_name: :streamingResolutions # @!attribute trim @@ -392,7 +396,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). # # @return [Boolean, true, Float, nil] - optional :trim, union: -> { Imagekit::Transformation::Trim } + optional :trim, union: -> { Imagekitio::Transformation::Trim } # @!attribute unsharp_mask # Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a @@ -400,14 +404,14 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm). # # @return [Boolean, true, String, nil] - optional :unsharp_mask, union: -> { Imagekit::Transformation::UnsharpMask }, api_name: :unsharpMask + optional :unsharp_mask, union: -> { Imagekitio::Transformation::UnsharpMask }, api_name: :unsharpMask # @!attribute video_codec # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). # - # @return [Symbol, Imagekit::Models::Transformation::VideoCodec, nil] - optional :video_codec, enum: -> { Imagekit::Transformation::VideoCodec }, api_name: :videoCodec + # @return [Symbol, Imagekitio::Models::Transformation::VideoCodec, nil] + optional :video_codec, enum: -> { Imagekitio::Transformation::VideoCodec }, api_name: :videoCodec # @!attribute width # Specifies the width of the output. If a value between 0 and 1 is provided, it is @@ -417,35 +421,35 @@ class Transformation < Imagekit::Internal::Type::BaseModel # [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w) # # @return [Float, String, nil] - optional :width, union: -> { Imagekit::Transformation::Width } + optional :width, union: -> { Imagekitio::Transformation::Width } # @!attribute x # 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). # # @return [Float, String, nil] - optional :x, union: -> { Imagekit::Transformation::X } + optional :x, union: -> { Imagekitio::Transformation::X } # @!attribute x_center # 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). # # @return [Float, String, nil] - optional :x_center, union: -> { Imagekit::Transformation::XCenter }, api_name: :xCenter + optional :x_center, union: -> { Imagekitio::Transformation::XCenter }, api_name: :xCenter # @!attribute y_ # 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). # # @return [Float, String, nil] - optional :y_, union: -> { Imagekit::Transformation::Y }, api_name: :y + optional :y_, union: -> { Imagekitio::Transformation::Y }, api_name: :y # @!attribute y_center # 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). # # @return [Float, String, nil] - optional :y_center, union: -> { Imagekit::Transformation::YCenter }, api_name: :yCenter + optional :y_center, union: -> { Imagekitio::Transformation::YCenter }, api_name: :yCenter # @!attribute zoom # Accepts a numeric value that determines how much to zoom in or out of the @@ -457,7 +461,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # @!method initialize(ai_change_background: nil, ai_drop_shadow: nil, ai_edit: nil, ai_remove_background: nil, ai_remove_background_external: nil, ai_retouch: nil, ai_upscale: nil, ai_variation: nil, aspect_ratio: nil, audio_codec: nil, background: nil, blur: nil, border: nil, color_profile: nil, contrast_stretch: nil, crop: nil, crop_mode: nil, default_image: nil, dpr: nil, duration: nil, end_offset: nil, flip: nil, focus: nil, format_: nil, gradient: nil, grayscale: nil, height: nil, lossless: nil, metadata: nil, named: nil, opacity: nil, original: nil, overlay: nil, page: nil, progressive: nil, quality: nil, radius: nil, raw: nil, rotation: nil, shadow: nil, sharpen: nil, start_offset: nil, streaming_resolutions: nil, trim: nil, unsharp_mask: nil, video_codec: nil, width: nil, x: nil, x_center: nil, y_: nil, y_center: nil, zoom: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::Transformation} for more details. + # {Imagekitio::Models::Transformation} for more details. # # The SDK provides easy-to-use names for transformations. These names are # converted to the corresponding transformation string before being added to the @@ -472,19 +476,19 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param ai_edit [String] Uses AI to edit images based on a text prompt. Provide a text prompt or a base64 # - # @param ai_remove_background [Boolean, Imagekit::Models::Transformation::AIRemoveBackground] Applies ImageKit's in-house background removal. + # @param ai_remove_background [Boolean, Imagekitio::Models::Transformation::AIRemoveBackground] Applies ImageKit's in-house background removal. # - # @param ai_remove_background_external [Boolean, Imagekit::Models::Transformation::AIRemoveBackgroundExternal] Uses third-party background removal. + # @param ai_remove_background_external [Boolean, Imagekitio::Models::Transformation::AIRemoveBackgroundExternal] Uses third-party background removal. # - # @param ai_retouch [Boolean, Imagekit::Models::Transformation::AIRetouch] Performs AI-based retouching to improve faces or product shots. Not supported in + # @param ai_retouch [Boolean, Imagekitio::Models::Transformation::AIRetouch] Performs AI-based retouching to improve faces or product shots. Not supported in # - # @param ai_upscale [Boolean, Imagekit::Models::Transformation::AIUpscale] Upscales images beyond their original dimensions using AI. Not supported inside + # @param ai_upscale [Boolean, Imagekitio::Models::Transformation::AIUpscale] Upscales images beyond their original dimensions using AI. Not supported inside # - # @param ai_variation [Boolean, Imagekit::Models::Transformation::AIVariation] Generates a variation of an image using AI. This produces a new image with sligh + # @param ai_variation [Boolean, Imagekitio::Models::Transformation::AIVariation] Generates a variation of an image using AI. This produces a new image with sligh # # @param aspect_ratio [Float, String] Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with e # - # @param audio_codec [Symbol, Imagekit::Models::Transformation::AudioCodec] Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](htt + # @param audio_codec [Symbol, Imagekitio::Models::Transformation::AudioCodec] Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](htt # # @param background [String] Specifies the background to be used in conjunction with certain cropping strateg # @@ -494,11 +498,11 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param color_profile [Boolean] Indicates whether the output image should retain the original color profile. # - # @param contrast_stretch [Boolean, Imagekit::Models::Transformation::ContrastStretch] Automatically enhances the contrast of an image (contrast stretch). + # @param contrast_stretch [Boolean, Imagekitio::Models::Transformation::ContrastStretch] Automatically enhances the contrast of an image (contrast stretch). # - # @param crop [Symbol, Imagekit::Models::Transformation::Crop] Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs + # @param crop [Symbol, Imagekitio::Models::Transformation::Crop] Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs # - # @param crop_mode [Symbol, Imagekit::Models::Transformation::CropMode] Additional crop modes for image resizing. See [Crop modes & focus](https://image + # @param crop_mode [Symbol, Imagekitio::Models::Transformation::CropMode] Additional crop modes for image resizing. See [Crop modes & focus](https://image # # @param default_image [String] Specifies a fallback image if the resource is not found, e.g., a URL or file pat # @@ -508,15 +512,15 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param end_offset [Float, String] Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. # - # @param flip [Symbol, Imagekit::Models::Transformation::Flip] Flips or mirrors an image either horizontally, vertically, or both. + # @param flip [Symbol, Imagekitio::Models::Transformation::Flip] Flips or mirrors an image either horizontally, vertically, or both. # # @param focus [String] Refines padding and cropping behavior for pad resize, maintain ratio, and extrac # - # @param format_ [Symbol, Imagekit::Models::Transformation::Format] Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `m + # @param format_ [Symbol, Imagekitio::Models::Transformation::Format] Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `m # # @param gradient [Boolean, true, String] Creates a linear gradient with two colors. Pass `true` for a default gradient, o # - # @param grayscale [Boolean, Imagekit::Models::Transformation::Grayscale] Enables a grayscale effect for images. See [Grayscale](https://imagekit.io/docs/ + # @param grayscale [Boolean, Imagekitio::Models::Transformation::Grayscale] Enables a grayscale effect for images. See [Grayscale](https://imagekit.io/docs/ # # @param height [Float, String] Specifies the height of the output. If a value between 0 and 1 is provided, it i # @@ -530,7 +534,7 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param original [Boolean] If set to true, serves the original file without applying any transformations. # - # @param overlay [Imagekit::Models::Overlay] Specifies an overlay to be applied on the parent image or video. + # @param overlay [Imagekitio::Models::Overlay] Specifies an overlay to be applied on the parent image or video. # # @param page [Float, String] Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI # @@ -550,13 +554,13 @@ class Transformation < Imagekit::Internal::Type::BaseModel # # @param start_offset [Float, String] Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5` # - # @param streaming_resolutions [Array] An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `48 + # @param streaming_resolutions [Array] An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `48 # # @param trim [Boolean, true, Float] Useful for images with a solid or nearly solid background and a central object. # # @param unsharp_mask [Boolean, true, String] Applies Unsharp Masking (USM), an image sharpening technique. # - # @param video_codec [Symbol, Imagekit::Models::Transformation::VideoCodec] Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video cod + # @param video_codec [Symbol, Imagekitio::Models::Transformation::VideoCodec] Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video cod # # @param width [Float, String] Specifies the width of the output. If a value between 0 and 1 is provided, it is # @@ -577,9 +581,9 @@ class Transformation < Imagekit::Internal::Type::BaseModel # inside overlay. See # [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). # - # @see Imagekit::Models::Transformation#ai_drop_shadow + # @see Imagekitio::Models::Transformation#ai_drop_shadow module AIDropShadow - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant const: true @@ -592,9 +596,9 @@ module AIDropShadow # 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). # - # @see Imagekit::Models::Transformation#ai_remove_background + # @see Imagekitio::Models::Transformation#ai_remove_background module AIRemoveBackground - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRUE = true @@ -607,9 +611,9 @@ module AIRemoveBackground # Supported inside overlay. See # [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). # - # @see Imagekit::Models::Transformation#ai_remove_background_external + # @see Imagekitio::Models::Transformation#ai_remove_background_external module AIRemoveBackgroundExternal - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRUE = true @@ -621,9 +625,9 @@ module AIRemoveBackgroundExternal # inside overlay. See # [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). # - # @see Imagekit::Models::Transformation#ai_retouch + # @see Imagekitio::Models::Transformation#ai_retouch module AIRetouch - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRUE = true @@ -635,9 +639,9 @@ module AIRetouch # overlay. See # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). # - # @see Imagekit::Models::Transformation#ai_upscale + # @see Imagekitio::Models::Transformation#ai_upscale module AIUpscale - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRUE = true @@ -651,9 +655,9 @@ module AIUpscale # original image. Not supported inside overlay. See # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). # - # @see Imagekit::Models::Transformation#ai_variation + # @see Imagekitio::Models::Transformation#ai_variation module AIVariation - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRUE = true @@ -666,9 +670,9 @@ module AIVariation # 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). # - # @see Imagekit::Models::Transformation#aspect_ratio + # @see Imagekitio::Models::Transformation#aspect_ratio module AspectRatio - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -681,9 +685,9 @@ module AspectRatio # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). # - # @see Imagekit::Models::Transformation#audio_codec + # @see Imagekitio::Models::Transformation#audio_codec module AudioCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AAC = :aac OPUS = :opus @@ -696,9 +700,9 @@ module AudioCodec # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). # - # @see Imagekit::Models::Transformation#contrast_stretch + # @see Imagekitio::Models::Transformation#contrast_stretch module ContrastStretch - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRUE = true @@ -709,9 +713,9 @@ module ContrastStretch # Crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). # - # @see Imagekit::Models::Transformation#crop + # @see Imagekitio::Models::Transformation#crop module Crop - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum FORCE = :force AT_MAX = :at_max @@ -726,9 +730,9 @@ module Crop # Additional crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). # - # @see Imagekit::Models::Transformation#crop_mode + # @see Imagekitio::Models::Transformation#crop_mode module CropMode - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum PAD_RESIZE = :pad_resize EXTRACT = :extract @@ -743,9 +747,9 @@ module CropMode # Arithmetic expressions are supported. See # [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). # - # @see Imagekit::Models::Transformation#duration + # @see Imagekitio::Models::Transformation#duration module Duration - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -760,9 +764,9 @@ module Duration # are supported. See # [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). # - # @see Imagekit::Models::Transformation#end_offset + # @see Imagekitio::Models::Transformation#end_offset module EndOffset - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -776,9 +780,9 @@ module EndOffset # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or # `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). # - # @see Imagekit::Models::Transformation#flip + # @see Imagekitio::Models::Transformation#flip module Flip - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum H = :h V = :v @@ -797,9 +801,9 @@ module Flip # [Image format](https://imagekit.io/docs/image-optimization#format---f) and # [Video format](https://imagekit.io/docs/video-optimization#format---f). # - # @see Imagekit::Models::Transformation#format_ + # @see Imagekitio::Models::Transformation#format_ module Format - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AUTO = :auto WEBP = :webp @@ -821,9 +825,9 @@ module Format # or provide a string for a custom gradient. See # [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). # - # @see Imagekit::Models::Transformation#gradient + # @see Imagekitio::Models::Transformation#gradient module Gradient - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant const: true @@ -836,9 +840,9 @@ module Gradient # Enables a grayscale effect for images. See # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). # - # @see Imagekit::Models::Transformation#grayscale + # @see Imagekitio::Models::Transformation#grayscale module Grayscale - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRUE = true @@ -853,9 +857,9 @@ module Grayscale # [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · # [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h) # - # @see Imagekit::Models::Transformation#height + # @see Imagekitio::Models::Transformation#height module Height - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -870,9 +874,9 @@ module Height # 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). # - # @see Imagekit::Models::Transformation#page + # @see Imagekitio::Models::Transformation#page module Page - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -886,9 +890,9 @@ module Page # or oval shape. See # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). # - # @see Imagekit::Models::Transformation#radius + # @see Imagekitio::Models::Transformation#radius module Radius - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -904,9 +908,9 @@ module Radius # only the following values are supported: 0, 90, 180, 270, or 360. See # [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). # - # @see Imagekit::Models::Transformation#rotation + # @see Imagekitio::Models::Transformation#rotation module Rotation - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -921,9 +925,9 @@ module Rotation # shadow, or provide a string for a custom shadow. See # [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). # - # @see Imagekit::Models::Transformation#shadow + # @see Imagekitio::Models::Transformation#shadow module Shadow - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant const: true @@ -937,9 +941,9 @@ module Shadow # default sharpening, or provide a numeric value for custom sharpening. See # [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). # - # @see Imagekit::Models::Transformation#sharpen + # @see Imagekitio::Models::Transformation#sharpen module Sharpen - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant const: true @@ -953,9 +957,9 @@ module Sharpen # `10.5`. Arithmetic expressions are also supported. See # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). # - # @see Imagekit::Models::Transformation#start_offset + # @see Imagekitio::Models::Transformation#start_offset module StartOffset - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -970,9 +974,9 @@ module StartOffset # output image. See # [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). # - # @see Imagekit::Models::Transformation#trim + # @see Imagekitio::Models::Transformation#trim module Trim - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant const: true @@ -986,9 +990,9 @@ module Trim # 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). # - # @see Imagekit::Models::Transformation#unsharp_mask + # @see Imagekitio::Models::Transformation#unsharp_mask module UnsharpMask - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant const: true @@ -1001,9 +1005,9 @@ module UnsharpMask # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). # - # @see Imagekit::Models::Transformation#video_codec + # @see Imagekitio::Models::Transformation#video_codec module VideoCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum H264 = :h264 VP9 = :vp9 @@ -1020,9 +1024,9 @@ module VideoCodec # – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · # [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w) # - # @see Imagekit::Models::Transformation#width + # @see Imagekitio::Models::Transformation#width module Width - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -1035,9 +1039,9 @@ module 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). # - # @see Imagekit::Models::Transformation#x + # @see Imagekitio::Models::Transformation#x module X - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -1050,9 +1054,9 @@ module 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). # - # @see Imagekit::Models::Transformation#x_center + # @see Imagekitio::Models::Transformation#x_center module XCenter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -1065,9 +1069,9 @@ module 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). # - # @see Imagekit::Models::Transformation#y_ + # @see Imagekitio::Models::Transformation#y_ module Y - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float @@ -1080,9 +1084,9 @@ module 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). # - # @see Imagekit::Models::Transformation#y_center + # @see Imagekitio::Models::Transformation#y_center module YCenter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant Float diff --git a/lib/imagekit/models/transformation_position.rb b/lib/imagekitio/models/transformation_position.rb similarity index 88% rename from lib/imagekit/models/transformation_position.rb rename to lib/imagekitio/models/transformation_position.rb index e2281215..649ea41b 100644 --- a/lib/imagekit/models/transformation_position.rb +++ b/lib/imagekitio/models/transformation_position.rb @@ -1,13 +1,13 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models # 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). module TransformationPosition - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum PATH = :path QUERY = :query diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb similarity index 67% rename from lib/imagekit/models/unsafe_unwrap_webhook_event.rb rename to lib/imagekitio/models/unsafe_unwrap_webhook_event.rb index 28e1b855..3ae76efc 100644 --- a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb @@ -1,36 +1,36 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models # 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. module UnsafeUnwrapWebhookEvent - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union # 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. - variant -> { Imagekit::VideoTransformationAcceptedEvent } + variant -> { Imagekitio::VideoTransformationAcceptedEvent } # 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. - variant -> { Imagekit::VideoTransformationReadyEvent } + variant -> { Imagekitio::VideoTransformationReadyEvent } # 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. - variant -> { Imagekit::VideoTransformationErrorEvent } + variant -> { Imagekitio::VideoTransformationErrorEvent } # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. - variant -> { Imagekit::UploadPreTransformSuccessEvent } + variant -> { Imagekitio::UploadPreTransformSuccessEvent } # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. - variant -> { Imagekit::UploadPreTransformErrorEvent } + variant -> { Imagekitio::UploadPreTransformErrorEvent } # 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. - variant -> { Imagekit::UploadPostTransformSuccessEvent } + variant -> { Imagekitio::UploadPostTransformSuccessEvent } # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. - variant -> { Imagekit::UploadPostTransformErrorEvent } + variant -> { Imagekitio::UploadPostTransformErrorEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessEvent, Imagekit::Models::UploadPreTransformErrorEvent, Imagekit::Models::UploadPostTransformSuccessEvent, Imagekit::Models::UploadPostTransformErrorEvent)] + # @return [Array(Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent)] end end end diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekitio/models/unwrap_webhook_event.rb similarity index 67% rename from lib/imagekit/models/unwrap_webhook_event.rb rename to lib/imagekitio/models/unwrap_webhook_event.rb index c200c085..ebbdfd88 100644 --- a/lib/imagekit/models/unwrap_webhook_event.rb +++ b/lib/imagekitio/models/unwrap_webhook_event.rb @@ -1,36 +1,36 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models # 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. module UnwrapWebhookEvent - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union # 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. - variant -> { Imagekit::VideoTransformationAcceptedEvent } + variant -> { Imagekitio::VideoTransformationAcceptedEvent } # 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. - variant -> { Imagekit::VideoTransformationReadyEvent } + variant -> { Imagekitio::VideoTransformationReadyEvent } # 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. - variant -> { Imagekit::VideoTransformationErrorEvent } + variant -> { Imagekitio::VideoTransformationErrorEvent } # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. - variant -> { Imagekit::UploadPreTransformSuccessEvent } + variant -> { Imagekitio::UploadPreTransformSuccessEvent } # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. - variant -> { Imagekit::UploadPreTransformErrorEvent } + variant -> { Imagekitio::UploadPreTransformErrorEvent } # 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. - variant -> { Imagekit::UploadPostTransformSuccessEvent } + variant -> { Imagekitio::UploadPostTransformSuccessEvent } # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. - variant -> { Imagekit::UploadPostTransformErrorEvent } + variant -> { Imagekitio::UploadPostTransformErrorEvent } # @!method self.variants - # @return [Array(Imagekit::Models::VideoTransformationAcceptedEvent, Imagekit::Models::VideoTransformationReadyEvent, Imagekit::Models::VideoTransformationErrorEvent, Imagekit::Models::UploadPreTransformSuccessEvent, Imagekit::Models::UploadPreTransformErrorEvent, Imagekit::Models::UploadPostTransformSuccessEvent, Imagekit::Models::UploadPostTransformErrorEvent)] + # @return [Array(Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent)] end end end diff --git a/lib/imagekit/models/update_file_request.rb b/lib/imagekitio/models/update_file_request.rb similarity index 66% rename from lib/imagekit/models/update_file_request.rb rename to lib/imagekitio/models/update_file_request.rb index 08fcdd07..1e030a07 100644 --- a/lib/imagekit/models/update_file_request.rb +++ b/lib/imagekitio/models/update_file_request.rb @@ -1,16 +1,16 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models # Schema for update file update request. module UpdateFileRequest - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union - variant -> { Imagekit::UpdateFileRequest::UpdateFileDetails } + variant -> { Imagekitio::UpdateFileRequest::UpdateFileDetails } - variant -> { Imagekit::UpdateFileRequest::ChangePublicationStatus } + variant -> { Imagekitio::UpdateFileRequest::ChangePublicationStatus } - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + class UpdateFileDetails < Imagekitio::Internal::Type::BaseModel # @!attribute custom_coordinates # 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. @@ -25,7 +25,7 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :customMetadata # @!attribute description @@ -38,8 +38,8 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] - optional :extensions, -> { Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem] } + # @return [Array, nil] + optional :extensions, -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem] } # @!attribute remove_ai_tags # An array of AITags associated with the file that you want to remove, e.g. @@ -53,7 +53,7 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # # @return [Array, Symbol, :all, nil] optional :remove_ai_tags, - union: -> { Imagekit::UpdateFileRequest::UpdateFileDetails::RemoveAITags }, + union: -> { Imagekitio::UpdateFileRequest::UpdateFileDetails::RemoveAITags }, api_name: :removeAITags # @!attribute tags @@ -61,7 +61,7 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # `null` to unset all tags associated with the file. # # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + optional :tags, Imagekitio::Internal::Type::ArrayOf[String], nil?: true # @!attribute webhook_url # The final status of extensions after they have completed execution will be @@ -74,7 +74,7 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UpdateFileRequest::UpdateFileDetails} for more details. + # {Imagekitio::Models::UpdateFileRequest::UpdateFileDetails} for more details. # # @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10, # @@ -82,7 +82,7 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car # @@ -99,54 +99,55 @@ class UpdateFileDetails < Imagekit::Internal::Type::BaseModel # Note: The remove operation for `AITags` executes before any of the `extensions` # are processed. # - # @see Imagekit::Models::UpdateFileRequest::UpdateFileDetails#remove_ai_tags + # @see Imagekitio::Models::UpdateFileRequest::UpdateFileDetails#remove_ai_tags module RemoveAITags - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union - variant -> { Imagekit::Models::UpdateFileRequest::UpdateFileDetails::RemoveAITags::StringArray } + variant -> { Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::RemoveAITags::StringArray } variant const: :all # @!method self.variants # @return [Array(Array, Symbol, :all)] - # @type [Imagekit::Internal::Type::Converter] - StringArray = Imagekit::Internal::Type::ArrayOf[String] + # @type [Imagekitio::Internal::Type::Converter] + StringArray = Imagekitio::Internal::Type::ArrayOf[String] end end - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + class ChangePublicationStatus < Imagekitio::Internal::Type::BaseModel # @!attribute publish # Configure the publication status of a file and its versions. # - # @return [Imagekit::Models::UpdateFileRequest::ChangePublicationStatus::Publish, nil] - optional :publish, -> { Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish } + # @return [Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish, nil] + optional :publish, -> { Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish } # @!method initialize(publish: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UpdateFileRequest::ChangePublicationStatus} for more details. + # {Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus} for more + # details. # - # @param publish [Imagekit::Models::UpdateFileRequest::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. + # @param publish [Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions. - # @see Imagekit::Models::UpdateFileRequest::ChangePublicationStatus#publish - class Publish < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus#publish + class Publish < Imagekitio::Internal::Type::BaseModel # @!attribute is_published # Set to `true` to publish the file. Set to `false` to unpublish the file. # # @return [Boolean] - required :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + required :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished # @!attribute include_file_versions # Set to `true` to publish/unpublish all versions of the file. Set to `false` to # publish/unpublish only the current version of the file. # # @return [Boolean, nil] - optional :include_file_versions, Imagekit::Internal::Type::Boolean, api_name: :includeFileVersions + optional :include_file_versions, Imagekitio::Internal::Type::Boolean, api_name: :includeFileVersions # @!method initialize(is_published:, include_file_versions: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UpdateFileRequest::ChangePublicationStatus::Publish} for more - # details. + # {Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish} for + # more details. # # Configure the publication status of a file and its versions. # @@ -157,7 +158,7 @@ class Publish < Imagekit::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(Imagekit::Models::UpdateFileRequest::UpdateFileDetails, Imagekit::Models::UpdateFileRequest::ChangePublicationStatus)] + # @return [Array(Imagekitio::Models::UpdateFileRequest::UpdateFileDetails, Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus)] end end end diff --git a/lib/imagekit/models/upload_post_transform_error_event.rb b/lib/imagekitio/models/upload_post_transform_error_event.rb similarity index 55% rename from lib/imagekit/models/upload_post_transform_error_event.rb rename to lib/imagekitio/models/upload_post_transform_error_event.rb index 31abc43b..aa5ce37d 100644 --- a/lib/imagekit/models/upload_post_transform_error_event.rb +++ b/lib/imagekitio/models/upload_post_transform_error_event.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent + class UploadPostTransformErrorEvent < Imagekitio::Models::BaseWebhookEvent # @!attribute created_at # Timestamp of when the event occurred in ISO8601 format. # @@ -11,13 +11,13 @@ class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent # @!attribute data # - # @return [Imagekit::Models::UploadPostTransformErrorEvent::Data] - required :data, -> { Imagekit::UploadPostTransformErrorEvent::Data } + # @return [Imagekitio::Models::UploadPostTransformErrorEvent::Data] + required :data, -> { Imagekitio::UploadPostTransformErrorEvent::Data } # @!attribute request # - # @return [Imagekit::Models::UploadPostTransformErrorEvent::Request] - required :request, -> { Imagekit::UploadPostTransformErrorEvent::Request } + # @return [Imagekitio::Models::UploadPostTransformErrorEvent::Request] + required :request, -> { Imagekitio::UploadPostTransformErrorEvent::Request } # @!attribute type # @@ -30,13 +30,13 @@ class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # - # @param data [Imagekit::Models::UploadPostTransformErrorEvent::Data] + # @param data [Imagekitio::Models::UploadPostTransformErrorEvent::Data] # - # @param request [Imagekit::Models::UploadPostTransformErrorEvent::Request] + # @param request [Imagekitio::Models::UploadPostTransformErrorEvent::Request] # # @param type [Symbol, :"upload.post-transform.error"] - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel # @!attribute file_id # Unique identifier of the originally uploaded file. # @@ -57,8 +57,8 @@ class Data < Imagekit::Internal::Type::BaseModel # @!attribute transformation # - # @return [Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation] - required :transformation, -> { Imagekit::UploadPostTransformErrorEvent::Data::Transformation } + # @return [Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation] + required :transformation, -> { Imagekitio::UploadPostTransformErrorEvent::Data::Transformation } # @!attribute url # URL of the attempted post-transformation. @@ -73,22 +73,22 @@ class Data < Imagekit::Internal::Type::BaseModel # # @param path [String] Path of the file. # - # @param transformation [Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation] + # @param transformation [Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation] # # @param url [String] URL of the attempted post-transformation. - # @see Imagekit::Models::UploadPostTransformErrorEvent::Data#transformation - class Transformation < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UploadPostTransformErrorEvent::Data#transformation + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute error # - # @return [Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation::Error] - required :error, -> { Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error } + # @return [Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation::Error] + required :error, -> { Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error } # @!method initialize(error:) - # @param error [Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation::Error] + # @param error [Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation::Error] - # @see Imagekit::Models::UploadPostTransformErrorEvent::Data::Transformation#error - class Error < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation#error + class Error < Imagekitio::Internal::Type::BaseModel # @!attribute reason # Reason for the post-transformation failure. # @@ -101,11 +101,11 @@ class Error < Imagekit::Internal::Type::BaseModel end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel # @!attribute transformation # - # @return [Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation] - required :transformation, -> { Imagekit::UploadPostTransformErrorEvent::Request::Transformation } + # @return [Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation] + required :transformation, -> { Imagekitio::UploadPostTransformErrorEvent::Request::Transformation } # @!attribute x_request_id # Unique identifier for the originating request. @@ -114,24 +114,24 @@ class Request < Imagekit::Internal::Type::BaseModel required :x_request_id, String # @!method initialize(transformation:, x_request_id:) - # @param transformation [Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation] + # @param transformation [Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation] # # @param x_request_id [String] Unique identifier for the originating request. - # @see Imagekit::Models::UploadPostTransformErrorEvent::Request#transformation - class Transformation < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UploadPostTransformErrorEvent::Request#transformation + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of the requested post-transformation. # - # @return [Symbol, Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::Type] - required :type, enum: -> { Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type } + # @return [Symbol, Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::Type] + required :type, enum: -> { Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type } # @!attribute protocol # Only applicable if transformation type is 'abs'. Streaming protocol used. # - # @return [Symbol, Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::Protocol, nil] + # @return [Symbol, Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::Protocol, nil] optional :protocol, - enum: -> { Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol } + enum: -> { Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol } # @!attribute value # Value for the requested transformation type. @@ -140,17 +140,17 @@ class Transformation < Imagekit::Internal::Type::BaseModel optional :value, String # @!method initialize(type:, protocol: nil, value: nil) - # @param type [Symbol, Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::Type] Type of the requested post-transformation. + # @param type [Symbol, Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::Type] Type of the requested post-transformation. # - # @param protocol [Symbol, Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. + # @param protocol [Symbol, Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. # # @param value [String] Value for the requested transformation type. # Type of the requested post-transformation. # - # @see Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation#type + # @see Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRANSFORMATION = :transformation ABS = :abs @@ -163,9 +163,9 @@ module Type # Only applicable if transformation type is 'abs'. Streaming protocol used. # - # @see Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation#protocol + # @see Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation#protocol module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS = :hls DASH = :dash diff --git a/lib/imagekit/models/upload_post_transform_success_event.rb b/lib/imagekitio/models/upload_post_transform_success_event.rb similarity index 59% rename from lib/imagekit/models/upload_post_transform_success_event.rb rename to lib/imagekitio/models/upload_post_transform_success_event.rb index e181c6d2..98e85a19 100644 --- a/lib/imagekit/models/upload_post_transform_success_event.rb +++ b/lib/imagekitio/models/upload_post_transform_success_event.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent + class UploadPostTransformSuccessEvent < Imagekitio::Models::BaseWebhookEvent # @!attribute created_at # Timestamp of when the event occurred in ISO8601 format. # @@ -11,13 +11,13 @@ class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent # @!attribute data # - # @return [Imagekit::Models::UploadPostTransformSuccessEvent::Data] - required :data, -> { Imagekit::UploadPostTransformSuccessEvent::Data } + # @return [Imagekitio::Models::UploadPostTransformSuccessEvent::Data] + required :data, -> { Imagekitio::UploadPostTransformSuccessEvent::Data } # @!attribute request # - # @return [Imagekit::Models::UploadPostTransformSuccessEvent::Request] - required :request, -> { Imagekit::UploadPostTransformSuccessEvent::Request } + # @return [Imagekitio::Models::UploadPostTransformSuccessEvent::Request] + required :request, -> { Imagekitio::UploadPostTransformSuccessEvent::Request } # @!attribute type # @@ -31,13 +31,13 @@ class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # - # @param data [Imagekit::Models::UploadPostTransformSuccessEvent::Data] + # @param data [Imagekitio::Models::UploadPostTransformSuccessEvent::Data] # - # @param request [Imagekit::Models::UploadPostTransformSuccessEvent::Request] + # @param request [Imagekitio::Models::UploadPostTransformSuccessEvent::Request] # # @param type [Symbol, :"upload.post-transform.success"] - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel # @!attribute file_id # Unique identifier of the originally uploaded file. # @@ -64,11 +64,11 @@ class Data < Imagekit::Internal::Type::BaseModel # @param url [String] URL of the generated post-transformation. end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel # @!attribute transformation # - # @return [Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation] - required :transformation, -> { Imagekit::UploadPostTransformSuccessEvent::Request::Transformation } + # @return [Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation] + required :transformation, -> { Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation } # @!attribute x_request_id # Unique identifier for the originating request. @@ -77,24 +77,24 @@ class Request < Imagekit::Internal::Type::BaseModel required :x_request_id, String # @!method initialize(transformation:, x_request_id:) - # @param transformation [Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation] + # @param transformation [Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation] # # @param x_request_id [String] Unique identifier for the originating request. - # @see Imagekit::Models::UploadPostTransformSuccessEvent::Request#transformation - class Transformation < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UploadPostTransformSuccessEvent::Request#transformation + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of the requested post-transformation. # - # @return [Symbol, Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::Type] - required :type, enum: -> { Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type } + # @return [Symbol, Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::Type] + required :type, enum: -> { Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type } # @!attribute protocol # Only applicable if transformation type is 'abs'. Streaming protocol used. # - # @return [Symbol, Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::Protocol, nil] + # @return [Symbol, Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::Protocol, nil] optional :protocol, - enum: -> { Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol } + enum: -> { Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol } # @!attribute value # Value for the requested transformation type. @@ -103,17 +103,17 @@ class Transformation < Imagekit::Internal::Type::BaseModel optional :value, String # @!method initialize(type:, protocol: nil, value: nil) - # @param type [Symbol, Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::Type] Type of the requested post-transformation. + # @param type [Symbol, Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::Type] Type of the requested post-transformation. # - # @param protocol [Symbol, Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. + # @param protocol [Symbol, Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used. # # @param value [String] Value for the requested transformation type. # Type of the requested post-transformation. # - # @see Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation#type + # @see Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRANSFORMATION = :transformation ABS = :abs @@ -126,9 +126,9 @@ module Type # Only applicable if transformation type is 'abs'. Streaming protocol used. # - # @see Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation#protocol + # @see Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation#protocol module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS = :hls DASH = :dash diff --git a/lib/imagekit/models/upload_pre_transform_error_event.rb b/lib/imagekitio/models/upload_pre_transform_error_event.rb similarity index 59% rename from lib/imagekit/models/upload_pre_transform_error_event.rb rename to lib/imagekitio/models/upload_pre_transform_error_event.rb index 76eb4981..8585fb3c 100644 --- a/lib/imagekit/models/upload_pre_transform_error_event.rb +++ b/lib/imagekitio/models/upload_pre_transform_error_event.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent + class UploadPreTransformErrorEvent < Imagekitio::Models::BaseWebhookEvent # @!attribute created_at # Timestamp of when the event occurred in ISO8601 format. # @@ -11,13 +11,13 @@ class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent # @!attribute data # - # @return [Imagekit::Models::UploadPreTransformErrorEvent::Data] - required :data, -> { Imagekit::UploadPreTransformErrorEvent::Data } + # @return [Imagekitio::Models::UploadPreTransformErrorEvent::Data] + required :data, -> { Imagekitio::UploadPreTransformErrorEvent::Data } # @!attribute request # - # @return [Imagekit::Models::UploadPreTransformErrorEvent::Request] - required :request, -> { Imagekit::UploadPreTransformErrorEvent::Request } + # @return [Imagekitio::Models::UploadPreTransformErrorEvent::Request] + required :request, -> { Imagekitio::UploadPreTransformErrorEvent::Request } # @!attribute type # @@ -30,13 +30,13 @@ class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # - # @param data [Imagekit::Models::UploadPreTransformErrorEvent::Data] + # @param data [Imagekitio::Models::UploadPreTransformErrorEvent::Data] # - # @param request [Imagekit::Models::UploadPreTransformErrorEvent::Request] + # @param request [Imagekitio::Models::UploadPreTransformErrorEvent::Request] # # @param type [Symbol, :"upload.pre-transform.error"] - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel # @!attribute name # Name of the file. # @@ -51,28 +51,28 @@ class Data < Imagekit::Internal::Type::BaseModel # @!attribute transformation # - # @return [Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation] - required :transformation, -> { Imagekit::UploadPreTransformErrorEvent::Data::Transformation } + # @return [Imagekitio::Models::UploadPreTransformErrorEvent::Data::Transformation] + required :transformation, -> { Imagekitio::UploadPreTransformErrorEvent::Data::Transformation } # @!method initialize(name:, path:, transformation:) # @param name [String] Name of the file. # # @param path [String] Path of the file. # - # @param transformation [Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation] + # @param transformation [Imagekitio::Models::UploadPreTransformErrorEvent::Data::Transformation] - # @see Imagekit::Models::UploadPreTransformErrorEvent::Data#transformation - class Transformation < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UploadPreTransformErrorEvent::Data#transformation + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute error # - # @return [Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation::Error] - required :error, -> { Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error } + # @return [Imagekitio::Models::UploadPreTransformErrorEvent::Data::Transformation::Error] + required :error, -> { Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error } # @!method initialize(error:) - # @param error [Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation::Error] + # @param error [Imagekitio::Models::UploadPreTransformErrorEvent::Data::Transformation::Error] - # @see Imagekit::Models::UploadPreTransformErrorEvent::Data::Transformation#error - class Error < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UploadPreTransformErrorEvent::Data::Transformation#error + class Error < Imagekitio::Internal::Type::BaseModel # @!attribute reason # Reason for the pre-transformation failure. # @@ -85,7 +85,7 @@ class Error < Imagekit::Internal::Type::BaseModel end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel # @!attribute transformation # The requested pre-transformation string. # diff --git a/lib/imagekit/models/upload_pre_transform_success_event.rb b/lib/imagekitio/models/upload_pre_transform_success_event.rb similarity index 73% rename from lib/imagekit/models/upload_pre_transform_success_event.rb rename to lib/imagekitio/models/upload_pre_transform_success_event.rb index d8cc16e4..b2474269 100644 --- a/lib/imagekit/models/upload_pre_transform_success_event.rb +++ b/lib/imagekitio/models/upload_pre_transform_success_event.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent + class UploadPreTransformSuccessEvent < Imagekitio::Models::BaseWebhookEvent # @!attribute created_at # Timestamp of when the event occurred in ISO8601 format. # @@ -12,13 +12,13 @@ class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent # @!attribute data # Object containing details of a successful upload. # - # @return [Imagekit::Models::UploadPreTransformSuccessEvent::Data] - required :data, -> { Imagekit::UploadPreTransformSuccessEvent::Data } + # @return [Imagekitio::Models::UploadPreTransformSuccessEvent::Data] + required :data, -> { Imagekitio::UploadPreTransformSuccessEvent::Data } # @!attribute request # - # @return [Imagekit::Models::UploadPreTransformSuccessEvent::Request] - required :request, -> { Imagekit::UploadPreTransformSuccessEvent::Request } + # @return [Imagekitio::Models::UploadPreTransformSuccessEvent::Request] + required :request, -> { Imagekitio::UploadPreTransformSuccessEvent::Request } # @!attribute type # @@ -32,20 +32,20 @@ class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent # # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format. # - # @param data [Imagekit::Models::UploadPreTransformSuccessEvent::Data] Object containing details of a successful upload. + # @param data [Imagekitio::Models::UploadPreTransformSuccessEvent::Data] Object containing details of a successful upload. # - # @param request [Imagekit::Models::UploadPreTransformSuccessEvent::Request] + # @param request [Imagekitio::Models::UploadPreTransformSuccessEvent::Request] # # @param type [Symbol, :"upload.pre-transform.success"] - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel # @!attribute ai_tags # An array of tags assigned to the uploaded file by auto tagging. # - # @return [Array, nil] + # @return [Array, nil] optional :ai_tags, -> { - Imagekit::Internal::Type::ArrayOf[Imagekit::UploadPreTransformSuccessEvent::Data::AITag] + Imagekitio::Internal::Type::ArrayOf[Imagekitio::UploadPreTransformSuccessEvent::Data::AITag] }, api_name: :AITags, nil?: true @@ -80,7 +80,7 @@ class Data < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :custom_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :customMetadata # @!attribute description @@ -103,7 +103,7 @@ class Data < Imagekit::Internal::Type::BaseModel # # @return [Hash{Symbol=>Object}, nil] optional :embedded_metadata, - Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown], + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], api_name: :embeddedMetadata # @!attribute extension_status @@ -117,9 +117,9 @@ class Data < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # - # @return [Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus, nil] + # @return [Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus, nil] optional :extension_status, - -> { Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus }, + -> { Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus }, api_name: :extensionStatus # @!attribute file_id @@ -154,7 +154,7 @@ class Data < Imagekit::Internal::Type::BaseModel # field. # # @return [Boolean, nil] - optional :is_private_file, Imagekit::Internal::Type::Boolean, api_name: :isPrivateFile + optional :is_private_file, Imagekitio::Internal::Type::Boolean, api_name: :isPrivateFile # @!attribute is_published # Is the file published or in draft state. It can be either `true` or `false`. @@ -162,14 +162,14 @@ class Data < Imagekit::Internal::Type::BaseModel # field. # # @return [Boolean, nil] - optional :is_published, Imagekit::Internal::Type::Boolean, api_name: :isPublished + optional :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished # @!attribute metadata # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. # - # @return [Imagekit::Models::Metadata, nil] - optional :metadata, -> { Imagekit::Metadata } + # @return [Imagekitio::Models::Metadata, nil] + optional :metadata, -> { Imagekitio::Metadata } # @!attribute name # Name of the asset. @@ -186,10 +186,10 @@ class Data < Imagekit::Internal::Type::BaseModel # Keys are the names of the custom metadata fields; the value object has details # about the custom metadata schema. # - # @return [Hash{Symbol=>Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema}, nil] + # @return [Hash{Symbol=>Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema}, nil] optional :selected_fields_schema, -> { - Imagekit::Internal::Type::HashOf[Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] + Imagekitio::Internal::Type::HashOf[Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] }, api_name: :selectedFieldsSchema @@ -205,7 +205,7 @@ class Data < Imagekit::Internal::Type::BaseModel # field. # # @return [Array, nil] - optional :tags, Imagekit::Internal::Type::ArrayOf[String], nil?: true + optional :tags, Imagekitio::Internal::Type::ArrayOf[String], nil?: true # @!attribute thumbnail_url # In the case of an image, a small thumbnail URL. @@ -222,9 +222,9 @@ class Data < Imagekit::Internal::Type::BaseModel # @!attribute version_info # An object containing the file or file version's `id` (versionId) and `name`. # - # @return [Imagekit::Models::UploadPreTransformSuccessEvent::Data::VersionInfo, nil] + # @return [Imagekitio::Models::UploadPreTransformSuccessEvent::Data::VersionInfo, nil] optional :version_info, - -> { Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo }, + -> { Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo }, api_name: :versionInfo # @!attribute video_codec @@ -241,11 +241,11 @@ class Data < Imagekit::Internal::Type::BaseModel # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UploadPreTransformSuccessEvent::Data} for more details. + # {Imagekitio::Models::UploadPreTransformSuccessEvent::Data} for more details. # # Object containing details of a successful upload. # - # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. + # @param ai_tags [Array, nil] An array of tags assigned to the uploaded file by auto tagging. # # @param audio_codec [String] The audio codec used in the video (only for video). # @@ -261,7 +261,7 @@ class Data < Imagekit::Internal::Type::BaseModel # # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, # - # @param extension_status [Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus] Extension names with their processing status at the time of completion of the re + # @param extension_status [Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus] Extension names with their processing status at the time of completion of the re # # @param file_id [String] Unique fileId. Store this fileld in your database, as this will be used to perfo # @@ -275,11 +275,11 @@ class Data < Imagekit::Internal::Type::BaseModel # # @param is_published [Boolean] Is the file published or in draft state. It can be either `true` or `false`. Sen # - # @param metadata [Imagekit::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad + # @param metadata [Imagekitio::Models::Metadata] Legacy metadata. Send `metadata` in `responseFields` in API request to get metad # # @param name [String] Name of the asset. # - # @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa + # @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa # # @param size [Float] Size of the image file in Bytes. # @@ -289,13 +289,13 @@ class Data < Imagekit::Internal::Type::BaseModel # # @param url [String] A publicly accessible URL of the file. # - # @param version_info [Imagekit::Models::UploadPreTransformSuccessEvent::Data::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. + # @param version_info [Imagekitio::Models::UploadPreTransformSuccessEvent::Data::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`. # # @param video_codec [String] The video codec used in the video (only for video). # # @param width [Float] Width of the image in pixels (Only for Images) - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel # @!attribute confidence # Confidence score of the tag. # @@ -318,7 +318,7 @@ class AITag < Imagekit::Internal::Type::BaseModel # @!method initialize(confidence: nil, name: nil, source: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UploadPreTransformSuccessEvent::Data::AITag} for more + # {Imagekitio::Models::UploadPreTransformSuccessEvent::Data::AITag} for more # details. # # @param confidence [Float] Confidence score of the tag. @@ -328,40 +328,40 @@ class AITag < Imagekit::Internal::Type::BaseModel # @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be end - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data#extension_status - class ExtensionStatus < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data#extension_status + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel # @!attribute ai_auto_description # - # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription, nil] + # @return [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription, nil] optional :ai_auto_description, enum: -> { - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription }, api_name: :"ai-auto-description" # @!attribute aws_auto_tagging # - # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging, nil] + # @return [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging, nil] optional :aws_auto_tagging, enum: -> { - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging }, api_name: :"aws-auto-tagging" # @!attribute google_auto_tagging # - # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging, nil] + # @return [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging, nil] optional :google_auto_tagging, enum: -> { - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging }, api_name: :"google-auto-tagging" # @!attribute remove_bg # - # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg, nil] + # @return [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg, nil] optional :remove_bg, - enum: -> { Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg }, + enum: -> { Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) @@ -375,14 +375,14 @@ class ExtensionStatus < Imagekit::Internal::Type::BaseModel # # If no extension was requested, then this parameter is not returned. # - # @param ai_auto_description [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription] - # @param aws_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging] - # @param google_auto_tagging [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging] - # @param remove_bg [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg] + # @param ai_auto_description [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription] + # @param aws_auto_tagging [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging] + # @param google_auto_tagging [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging] + # @param remove_bg [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg] - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#ai_auto_description + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#ai_auto_description module AIAutoDescription - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -392,9 +392,9 @@ module AIAutoDescription # @return [Array] end - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#aws_auto_tagging + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#aws_auto_tagging module AwsAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -404,9 +404,9 @@ module AwsAutoTagging # @return [Array] end - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#google_auto_tagging + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#google_auto_tagging module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -416,9 +416,9 @@ module GoogleAutoTagging # @return [Array] end - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#remove_bg + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#remove_bg module RemoveBg - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum SUCCESS = :success PENDING = :pending @@ -429,12 +429,12 @@ module RemoveBg end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of the custom metadata field. # - # @return [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type] - required :type, enum: -> { Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type } + # @return [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type] + required :type, enum: -> { Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type } # @!attribute default_value # The default value for this custom metadata field. The value should match the @@ -443,7 +443,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # @return [String, Float, Boolean, Array, nil] optional :default_value, union: -> { - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue }, api_name: :defaultValue @@ -451,7 +451,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # Specifies if the custom metadata field is required or not. # # @return [Boolean, nil] - optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired + optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired # @!attribute max_length # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. @@ -467,7 +467,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # @return [String, Float, nil] optional :max_value, union: -> { - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue }, api_name: :maxValue @@ -485,7 +485,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # @return [String, Float, nil] optional :min_value, union: -> { - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue }, api_name: :minValue @@ -495,7 +495,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # **Path policy** feature. # # @return [Boolean, nil] - optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly + optional :read_only, Imagekitio::Internal::Type::Boolean, api_name: :readOnly # @!attribute select_options # An array of allowed values when field type is `SingleSelect` or `MultiSelect`. @@ -503,7 +503,7 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # @return [Array, nil] optional :select_options, -> { - Imagekit::Internal::Type::ArrayOf[union: Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption] + Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption] }, api_name: :selectOptions @@ -513,15 +513,15 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # # @return [Boolean, nil] optional :select_options_truncated, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Boolean, api_name: :selectOptionsTruncated # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema} + # {Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema} # for more details. # - # @param type [Symbol, Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type] Type of the custom metadata field. + # @param type [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type] Type of the custom metadata field. # # @param default_value [String, Float, Boolean, Array] The default value for this custom metadata field. The value should match the `ty # @@ -543,9 +543,9 @@ class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel # Type of the custom metadata field. # - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#type + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TEXT = :Text TEXTAREA = :Textarea @@ -562,27 +562,27 @@ module Type # The default value for this custom metadata field. The value should match the # `type` of custom metadata field. # - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#default_value + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#default_value module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # Default value should be of type array when custom metadata field type is set to `MultiSelect`. - variant -> { Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::MixedArray } + variant -> { Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::MixedArray } module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] @@ -591,10 +591,10 @@ module Mixed # @!method self.variants # @return [Array(String, Float, Boolean, Array)] - # @type [Imagekit::Internal::Type::Converter] + # @type [Imagekitio::Internal::Type::Converter] MixedArray = - Imagekit::Internal::Type::ArrayOf[union: -> { - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed }] end @@ -602,9 +602,9 @@ module Mixed # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#max_value + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#max_value module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -618,9 +618,9 @@ module MaxValue # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. # - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#min_value + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#min_value module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String @@ -631,21 +631,21 @@ module MinValue end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Float - variant Imagekit::Internal::Type::Boolean + variant Imagekitio::Internal::Type::Boolean # @!method self.variants # @return [Array(String, Float, Boolean)] end end - # @see Imagekit::Models::UploadPreTransformSuccessEvent::Data#version_info - class VersionInfo < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data#version_info + class VersionInfo < Imagekitio::Internal::Type::BaseModel # @!attribute id # Unique identifier of the file version. # @@ -667,7 +667,7 @@ class VersionInfo < Imagekit::Internal::Type::BaseModel end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel # @!attribute transformation # The requested pre-transformation string. # diff --git a/lib/imagekit/models/video_overlay.rb b/lib/imagekitio/models/video_overlay.rb similarity index 69% rename from lib/imagekit/models/video_overlay.rb rename to lib/imagekitio/models/video_overlay.rb index 3a134813..ef765102 100644 --- a/lib/imagekit/models/video_overlay.rb +++ b/lib/imagekitio/models/video_overlay.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class VideoOverlay < Imagekit::Models::BaseOverlay + class VideoOverlay < Imagekitio::Models::BaseOverlay # @!attribute input # Specifies the relative path to the video used as an overlay. # @@ -21,26 +21,26 @@ class VideoOverlay < Imagekit::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. # - # @return [Symbol, Imagekit::Models::VideoOverlay::Encoding, nil] - optional :encoding, enum: -> { Imagekit::VideoOverlay::Encoding } + # @return [Symbol, Imagekitio::Models::VideoOverlay::Encoding, nil] + optional :encoding, enum: -> { Imagekitio::VideoOverlay::Encoding } # @!attribute transformation # 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). # - # @return [Array, nil] - optional :transformation, -> { Imagekit::Internal::Type::ArrayOf[Imagekit::Transformation] } + # @return [Array, nil] + optional :transformation, -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Transformation] } # @!method initialize(input:, encoding: nil, transformation: nil, type: :video) # Some parameter documentations has been truncated, see - # {Imagekit::Models::VideoOverlay} for more details. + # {Imagekitio::Models::VideoOverlay} for more details. # # @param input [String] Specifies the relative path to the video used as an overlay. # - # @param encoding [Symbol, Imagekit::Models::VideoOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 + # @param encoding [Symbol, Imagekitio::Models::VideoOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64 # - # @param transformation [Array] Array of transformation to be applied to the overlay video. Except `streamingRes + # @param transformation [Array] Array of transformation to be applied to the overlay video. Except `streamingRes # # @param type [Symbol, :video] @@ -50,7 +50,7 @@ class VideoOverlay < Imagekit::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. module Encoding - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AUTO = :auto PLAIN = :plain diff --git a/lib/imagekit/models/video_transformation_accepted_event.rb b/lib/imagekitio/models/video_transformation_accepted_event.rb similarity index 56% rename from lib/imagekit/models/video_transformation_accepted_event.rb rename to lib/imagekitio/models/video_transformation_accepted_event.rb index 1be102a0..9cd25cae 100644 --- a/lib/imagekit/models/video_transformation_accepted_event.rb +++ b/lib/imagekitio/models/video_transformation_accepted_event.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class VideoTransformationAcceptedEvent < Imagekit::Models::BaseWebhookEvent + class VideoTransformationAcceptedEvent < Imagekitio::Models::BaseWebhookEvent # @!attribute created_at # Timestamp when the event was created in ISO8601 format. # @@ -11,14 +11,14 @@ class VideoTransformationAcceptedEvent < Imagekit::Models::BaseWebhookEvent # @!attribute data # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data] - required :data, -> { Imagekit::VideoTransformationAcceptedEvent::Data } + # @return [Imagekitio::Models::VideoTransformationAcceptedEvent::Data] + required :data, -> { Imagekitio::VideoTransformationAcceptedEvent::Data } # @!attribute request # Information about the original request that triggered the video transformation. # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Request] - required :request, -> { Imagekit::VideoTransformationAcceptedEvent::Request } + # @return [Imagekitio::Models::VideoTransformationAcceptedEvent::Request] + required :request, -> { Imagekitio::VideoTransformationAcceptedEvent::Request } # @!attribute type # @@ -32,32 +32,32 @@ class VideoTransformationAcceptedEvent < Imagekit::Models::BaseWebhookEvent # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # - # @param data [Imagekit::Models::VideoTransformationAcceptedEvent::Data] + # @param data [Imagekitio::Models::VideoTransformationAcceptedEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationAcceptedEvent::Request] Information about the original request that triggered the video transformation. + # @param request [Imagekitio::Models::VideoTransformationAcceptedEvent::Request] Information about the original request that triggered the video transformation. # # @param type [Symbol, :"video.transformation.accepted"] - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel # @!attribute asset # Information about the source video asset being transformed. # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Asset } + # @return [Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Asset] + required :asset, -> { Imagekitio::VideoTransformationAcceptedEvent::Data::Asset } # @!attribute transformation # Base information about a video transformation request. # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation } + # @return [Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation] + required :transformation, -> { Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Asset] Information about the source video asset being transformed. + # @param asset [Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Asset] Information about the source video asset being transformed. # - # @param transformation [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation] Base information about a video transformation request. + # @param transformation [Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation] Base information about a video transformation request. - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#asset - class Asset < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationAcceptedEvent::Data#asset + class Asset < Imagekitio::Internal::Type::BaseModel # @!attribute url # URL to download or access the source video file. # @@ -70,8 +70,8 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] URL to download or access the source video file. end - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data#transformation - class Transformation < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationAcceptedEvent::Data#transformation + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of video transformation: # @@ -80,25 +80,25 @@ class Transformation < Imagekit::Internal::Type::BaseModel # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type } + # @return [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type } # @!attribute options # Configuration options for video transformations. # - # @return [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options } + # @return [Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options } # @!method initialize(type:, options: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation} for + # {Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation} for # more details. # # Base information about a video transformation request. # - # @param type [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] Type of video transformation: + # @param type [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Type] Type of video transformation: # - # @param options [Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options] Configuration options for video transformations. + # @param options [Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options] Configuration options for video transformations. # Type of video transformation: # @@ -107,9 +107,9 @@ class Transformation < Imagekit::Internal::Type::BaseModel # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video # - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#type + # @see Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum VIDEO_TRANSFORMATION = :"video-transformation" GIF_TO_VIDEO = :"gif-to-video" @@ -119,28 +119,28 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation#options - class Options < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation#options + class Options < Imagekitio::Internal::Type::BaseModel # @!attribute audio_codec # Audio codec used for encoding (aac or opus). # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # Whether to automatically rotate the video based on metadata. # # @return [Boolean, nil] - optional :auto_rotate, Imagekit::Internal::Type::Boolean + optional :auto_rotate, Imagekitio::Internal::Type::Boolean # @!attribute format_ # Output format for the transformed video or thumbnail. # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format }, api_name: :format @@ -153,45 +153,45 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # Streaming protocol for adaptive bitrate streaming. # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # Array of quality representations for adaptive bitrate streaming. # # @return [Array, nil] - optional :variants, Imagekit::Internal::Type::ArrayOf[String] + optional :variants, Imagekitio::Internal::Type::ArrayOf[String] # @!attribute video_codec # Video codec used for encoding (h264, vp9, or av1). # - # @return [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) # Configuration options for video transformations. # - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). + # @param audio_codec [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). # # @param auto_rotate [Boolean] Whether to automatically rotate the video based on metadata. # - # @param format_ [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. + # @param format_ [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. # # @param quality [Integer] Quality setting for the output video. # - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. + # @param stream_protocol [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. # # @param variants [Array] Array of quality representations for adaptive bitrate streaming. # - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). + # @param video_codec [Symbol, Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). # Audio codec used for encoding (aac or opus). # - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#audio_codec + # @see Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#audio_codec module AudioCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AAC = :aac OPUS = :opus @@ -202,9 +202,9 @@ module AudioCodec # Output format for the transformed video or thumbnail. # - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#format_ + # @see Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#format_ module Format - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum MP4 = :mp4 WEBM = :webm @@ -218,9 +218,9 @@ module Format # Streaming protocol for adaptive bitrate streaming. # - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#stream_protocol + # @see Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#stream_protocol module StreamProtocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS = :HLS DASH = :DASH @@ -231,9 +231,9 @@ module StreamProtocol # Video codec used for encoding (h264, vp9, or av1). # - # @see Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#video_codec + # @see Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options#video_codec module VideoCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum H264 = :h264 VP9 = :vp9 @@ -246,7 +246,7 @@ module VideoCodec end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel # @!attribute url # Full URL of the transformation request that was submitted. # diff --git a/lib/imagekit/models/video_transformation_error_event.rb b/lib/imagekitio/models/video_transformation_error_event.rb similarity index 55% rename from lib/imagekit/models/video_transformation_error_event.rb rename to lib/imagekitio/models/video_transformation_error_event.rb index 8c357035..4d740ef5 100644 --- a/lib/imagekit/models/video_transformation_error_event.rb +++ b/lib/imagekitio/models/video_transformation_error_event.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class VideoTransformationErrorEvent < Imagekit::Models::BaseWebhookEvent + class VideoTransformationErrorEvent < Imagekitio::Models::BaseWebhookEvent # @!attribute created_at # Timestamp when the event was created in ISO8601 format. # @@ -11,14 +11,14 @@ class VideoTransformationErrorEvent < Imagekit::Models::BaseWebhookEvent # @!attribute data # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data] - required :data, -> { Imagekit::VideoTransformationErrorEvent::Data } + # @return [Imagekitio::Models::VideoTransformationErrorEvent::Data] + required :data, -> { Imagekitio::VideoTransformationErrorEvent::Data } # @!attribute request # Information about the original request that triggered the video transformation. # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Request] - required :request, -> { Imagekit::VideoTransformationErrorEvent::Request } + # @return [Imagekitio::Models::VideoTransformationErrorEvent::Request] + required :request, -> { Imagekitio::VideoTransformationErrorEvent::Request } # @!attribute type # @@ -33,31 +33,31 @@ class VideoTransformationErrorEvent < Imagekit::Models::BaseWebhookEvent # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # - # @param data [Imagekit::Models::VideoTransformationErrorEvent::Data] + # @param data [Imagekitio::Models::VideoTransformationErrorEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationErrorEvent::Request] Information about the original request that triggered the video transformation. + # @param request [Imagekitio::Models::VideoTransformationErrorEvent::Request] Information about the original request that triggered the video transformation. # # @param type [Symbol, :"video.transformation.error"] - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel # @!attribute asset # Information about the source video asset being transformed. # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationErrorEvent::Data::Asset } + # @return [Imagekitio::Models::VideoTransformationErrorEvent::Data::Asset] + required :asset, -> { Imagekitio::VideoTransformationErrorEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation } + # @return [Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation] + required :transformation, -> { Imagekitio::VideoTransformationErrorEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationErrorEvent::Data::Asset] Information about the source video asset being transformed. + # @param asset [Imagekitio::Models::VideoTransformationErrorEvent::Data::Asset] Information about the source video asset being transformed. # - # @param transformation [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation] + # @param transformation [Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationErrorEvent::Data#asset - class Asset < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data#asset + class Asset < Imagekitio::Internal::Type::BaseModel # @!attribute url # URL to download or access the source video file. # @@ -70,8 +70,8 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] URL to download or access the source video file. end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data#transformation - class Transformation < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data#transformation + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of video transformation: # @@ -80,31 +80,31 @@ class Transformation < Imagekit::Internal::Type::BaseModel # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type } + # @return [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type } # @!attribute error # Details about the transformation error. # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error, nil] - optional :error, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error } + # @return [Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error, nil] + optional :error, -> { Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error } # @!attribute options # Configuration options for video transformations. # - # @return [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options } + # @return [Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options } # @!method initialize(type:, error: nil, options: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation} for more - # details. + # {Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation} for + # more details. # - # @param type [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Type] Type of video transformation: + # @param type [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Type] Type of video transformation: # - # @param error [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error] Details about the transformation error. + # @param error [Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error] Details about the transformation error. # - # @param options [Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options] Configuration options for video transformations. + # @param options [Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options] Configuration options for video transformations. # Type of video transformation: # @@ -113,9 +113,9 @@ class Transformation < Imagekit::Internal::Type::BaseModel # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video # - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#type + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum VIDEO_TRANSFORMATION = :"video-transformation" GIF_TO_VIDEO = :"gif-to-video" @@ -125,8 +125,8 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#error - class Error < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation#error + class Error < Imagekitio::Internal::Type::BaseModel # @!attribute reason # Specific reason for the transformation failure: # @@ -134,18 +134,18 @@ class Error < Imagekit::Internal::Type::BaseModel # - `download_failed`: Could not download source video # - `internal_server_error`: Unexpected server error # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] + # @return [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] required :reason, - enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason } + enum: -> { Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason } # @!method initialize(reason:) # Some parameter documentations has been truncated, see - # {Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error} + # {Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error} # for more details. # # Details about the transformation error. # - # @param reason [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] Specific reason for the transformation failure: + # @param reason [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error::Reason] Specific reason for the transformation failure: # Specific reason for the transformation failure: # @@ -153,9 +153,9 @@ class Error < Imagekit::Internal::Type::BaseModel # - `download_failed`: Could not download source video # - `internal_server_error`: Unexpected server error # - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error#reason + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error#reason module Reason - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum ENCODING_FAILED = :encoding_failed DOWNLOAD_FAILED = :download_failed @@ -166,28 +166,28 @@ module Reason end end - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation#options - class Options < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation#options + class Options < Imagekitio::Internal::Type::BaseModel # @!attribute audio_codec # Audio codec used for encoding (aac or opus). # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # Whether to automatically rotate the video based on metadata. # # @return [Boolean, nil] - optional :auto_rotate, Imagekit::Internal::Type::Boolean + optional :auto_rotate, Imagekitio::Internal::Type::Boolean # @!attribute format_ # Output format for the transformed video or thumbnail. # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format }, api_name: :format @@ -200,45 +200,45 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # Streaming protocol for adaptive bitrate streaming. # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # Array of quality representations for adaptive bitrate streaming. # # @return [Array, nil] - optional :variants, Imagekit::Internal::Type::ArrayOf[String] + optional :variants, Imagekitio::Internal::Type::ArrayOf[String] # @!attribute video_codec # Video codec used for encoding (h264, vp9, or av1). # - # @return [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) # Configuration options for video transformations. # - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). + # @param audio_codec [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). # # @param auto_rotate [Boolean] Whether to automatically rotate the video based on metadata. # - # @param format_ [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. + # @param format_ [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. # # @param quality [Integer] Quality setting for the output video. # - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. + # @param stream_protocol [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. # # @param variants [Array] Array of quality representations for adaptive bitrate streaming. # - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). + # @param video_codec [Symbol, Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). # Audio codec used for encoding (aac or opus). # - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#audio_codec + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options#audio_codec module AudioCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AAC = :aac OPUS = :opus @@ -249,9 +249,9 @@ module AudioCodec # Output format for the transformed video or thumbnail. # - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#format_ + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options#format_ module Format - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum MP4 = :mp4 WEBM = :webm @@ -265,9 +265,9 @@ module Format # Streaming protocol for adaptive bitrate streaming. # - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#stream_protocol + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options#stream_protocol module StreamProtocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS = :HLS DASH = :DASH @@ -278,9 +278,9 @@ module StreamProtocol # Video codec used for encoding (h264, vp9, or av1). # - # @see Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options#video_codec + # @see Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options#video_codec module VideoCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum H264 = :h264 VP9 = :vp9 @@ -293,7 +293,7 @@ module VideoCodec end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel # @!attribute url # Full URL of the transformation request that was submitted. # diff --git a/lib/imagekit/models/video_transformation_ready_event.rb b/lib/imagekitio/models/video_transformation_ready_event.rb similarity index 58% rename from lib/imagekit/models/video_transformation_ready_event.rb rename to lib/imagekitio/models/video_transformation_ready_event.rb index d4053bf4..635dc13a 100644 --- a/lib/imagekit/models/video_transformation_ready_event.rb +++ b/lib/imagekitio/models/video_transformation_ready_event.rb @@ -1,8 +1,8 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Models - class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent + class VideoTransformationReadyEvent < Imagekitio::Models::BaseWebhookEvent # @!attribute created_at # Timestamp when the event was created in ISO8601 format. # @@ -11,14 +11,14 @@ class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent # @!attribute data # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data] - required :data, -> { Imagekit::VideoTransformationReadyEvent::Data } + # @return [Imagekitio::Models::VideoTransformationReadyEvent::Data] + required :data, -> { Imagekitio::VideoTransformationReadyEvent::Data } # @!attribute request # Information about the original request that triggered the video transformation. # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Request] - required :request, -> { Imagekit::VideoTransformationReadyEvent::Request } + # @return [Imagekitio::Models::VideoTransformationReadyEvent::Request] + required :request, -> { Imagekitio::VideoTransformationReadyEvent::Request } # @!attribute type # @@ -28,8 +28,8 @@ class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent # @!attribute timings # Performance metrics for the transformation process. # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Timings, nil] - optional :timings, -> { Imagekit::VideoTransformationReadyEvent::Timings } + # @return [Imagekitio::Models::VideoTransformationReadyEvent::Timings, nil] + optional :timings, -> { Imagekitio::VideoTransformationReadyEvent::Timings } # @!method initialize(created_at:, data:, request:, timings: nil, type: :"video.transformation.ready") # Triggered when video encoding is finished and the transformed resource is ready @@ -39,33 +39,33 @@ class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent # # @param created_at [Time] Timestamp when the event was created in ISO8601 format. # - # @param data [Imagekit::Models::VideoTransformationReadyEvent::Data] + # @param data [Imagekitio::Models::VideoTransformationReadyEvent::Data] # - # @param request [Imagekit::Models::VideoTransformationReadyEvent::Request] Information about the original request that triggered the video transformation. + # @param request [Imagekitio::Models::VideoTransformationReadyEvent::Request] Information about the original request that triggered the video transformation. # - # @param timings [Imagekit::Models::VideoTransformationReadyEvent::Timings] Performance metrics for the transformation process. + # @param timings [Imagekitio::Models::VideoTransformationReadyEvent::Timings] Performance metrics for the transformation process. # # @param type [Symbol, :"video.transformation.ready"] - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel # @!attribute asset # Information about the source video asset being transformed. # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] - required :asset, -> { Imagekit::VideoTransformationReadyEvent::Data::Asset } + # @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Asset] + required :asset, -> { Imagekitio::VideoTransformationReadyEvent::Data::Asset } # @!attribute transformation # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] - required :transformation, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation } + # @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation] + required :transformation, -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation } # @!method initialize(asset:, transformation:) - # @param asset [Imagekit::Models::VideoTransformationReadyEvent::Data::Asset] Information about the source video asset being transformed. + # @param asset [Imagekitio::Models::VideoTransformationReadyEvent::Data::Asset] Information about the source video asset being transformed. # - # @param transformation [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation] + # @param transformation [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation] - # @see Imagekit::Models::VideoTransformationReadyEvent::Data#asset - class Asset < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data#asset + class Asset < Imagekitio::Internal::Type::BaseModel # @!attribute url # URL to download or access the source video file. # @@ -78,8 +78,8 @@ class Asset < Imagekit::Internal::Type::BaseModel # @param url [String] URL to download or access the source video file. end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data#transformation - class Transformation < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data#transformation + class Transformation < Imagekitio::Internal::Type::BaseModel # @!attribute type # Type of video transformation: # @@ -88,31 +88,31 @@ class Transformation < Imagekit::Internal::Type::BaseModel # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] - required :type, enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type } + # @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Type] + required :type, enum: -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type } # @!attribute options # Configuration options for video transformations. # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options, nil] - optional :options, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options } + # @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options, nil] + optional :options, -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options } # @!attribute output # Information about the transformed output video. # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output, nil] - optional :output, -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output } + # @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output, nil] + optional :output, -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output } # @!method initialize(type:, options: nil, output: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation} for more - # details. + # {Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation} for + # more details. # - # @param type [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Type] Type of video transformation: + # @param type [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Type] Type of video transformation: # - # @param options [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options] Configuration options for video transformations. + # @param options [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options] Configuration options for video transformations. # - # @param output [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output] Information about the transformed output video. + # @param output [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output] Information about the transformed output video. # Type of video transformation: # @@ -121,9 +121,9 @@ class Transformation < Imagekit::Internal::Type::BaseModel # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video # - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#type + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation#type module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum VIDEO_TRANSFORMATION = :"video-transformation" GIF_TO_VIDEO = :"gif-to-video" @@ -133,28 +133,28 @@ module Type # @return [Array] end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#options - class Options < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation#options + class Options < Imagekitio::Internal::Type::BaseModel # @!attribute audio_codec # Audio codec used for encoding (aac or opus). # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec, nil] optional :audio_codec, - enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec } + enum: -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec } # @!attribute auto_rotate # Whether to automatically rotate the video based on metadata. # # @return [Boolean, nil] - optional :auto_rotate, Imagekit::Internal::Type::Boolean + optional :auto_rotate, Imagekitio::Internal::Type::Boolean # @!attribute format_ # Output format for the transformed video or thumbnail. # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format, nil] optional :format_, enum: -> { - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format }, api_name: :format @@ -167,45 +167,45 @@ class Options < Imagekit::Internal::Type::BaseModel # @!attribute stream_protocol # Streaming protocol for adaptive bitrate streaming. # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol, nil] optional :stream_protocol, - enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol } + enum: -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol } # @!attribute variants # Array of quality representations for adaptive bitrate streaming. # # @return [Array, nil] - optional :variants, Imagekit::Internal::Type::ArrayOf[String] + optional :variants, Imagekitio::Internal::Type::ArrayOf[String] # @!attribute video_codec # Video codec used for encoding (h264, vp9, or av1). # - # @return [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec, nil] + # @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec, nil] optional :video_codec, - enum: -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec } + enum: -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec } # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil) # Configuration options for video transformations. # - # @param audio_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). + # @param audio_codec [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus). # # @param auto_rotate [Boolean] Whether to automatically rotate the video based on metadata. # - # @param format_ [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. + # @param format_ [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail. # # @param quality [Integer] Quality setting for the output video. # - # @param stream_protocol [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. + # @param stream_protocol [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming. # # @param variants [Array] Array of quality representations for adaptive bitrate streaming. # - # @param video_codec [Symbol, Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). + # @param video_codec [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1). # Audio codec used for encoding (aac or opus). # - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#audio_codec + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options#audio_codec module AudioCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum AAC = :aac OPUS = :opus @@ -216,9 +216,9 @@ module AudioCodec # Output format for the transformed video or thumbnail. # - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#format_ + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options#format_ module Format - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum MP4 = :mp4 WEBM = :webm @@ -232,9 +232,9 @@ module Format # Streaming protocol for adaptive bitrate streaming. # - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#stream_protocol + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options#stream_protocol module StreamProtocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS = :HLS DASH = :DASH @@ -245,9 +245,9 @@ module StreamProtocol # Video codec used for encoding (h264, vp9, or av1). # - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options#video_codec + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options#video_codec module VideoCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum H264 = :h264 VP9 = :vp9 @@ -258,8 +258,8 @@ module VideoCodec end end - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation#output - class Output < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation#output + class Output < Imagekitio::Internal::Type::BaseModel # @!attribute url # URL to access the transformed video. # @@ -269,19 +269,19 @@ class Output < Imagekit::Internal::Type::BaseModel # @!attribute video_metadata # Metadata of the output video file. # - # @return [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, nil] + # @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, nil] optional :video_metadata, - -> { Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } + -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } # @!method initialize(url:, video_metadata: nil) # Information about the transformed output video. # # @param url [String] URL to access the transformed video. # - # @param video_metadata [Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata] Metadata of the output video file. + # @param video_metadata [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata] Metadata of the output video file. - # @see Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Output#video_metadata - class VideoMetadata < Imagekit::Internal::Type::BaseModel + # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output#video_metadata + class VideoMetadata < Imagekitio::Internal::Type::BaseModel # @!attribute bitrate # Bitrate of the output video in bits per second. # @@ -321,7 +321,7 @@ class VideoMetadata < Imagekit::Internal::Type::BaseModel end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel # @!attribute url # Full URL of the transformation request that was submitted. # @@ -350,7 +350,7 @@ class Request < Imagekit::Internal::Type::BaseModel # @param user_agent [String] User-Agent header from the original request that triggered the transformation. end - class Timings < Imagekit::Internal::Type::BaseModel + class Timings < Imagekitio::Internal::Type::BaseModel # @!attribute download_duration # Time spent downloading the source video from your origin or media library, in # milliseconds. @@ -366,7 +366,7 @@ class Timings < Imagekit::Internal::Type::BaseModel # @!method initialize(download_duration: nil, encoding_duration: nil) # Some parameter documentations has been truncated, see - # {Imagekit::Models::VideoTransformationReadyEvent::Timings} for more details. + # {Imagekitio::Models::VideoTransformationReadyEvent::Timings} for more details. # # Performance metrics for the transformation process. # diff --git a/lib/imagekitio/models/webhook_unsafe_unwrap_params.rb b/lib/imagekitio/models/webhook_unsafe_unwrap_params.rb new file mode 100644 index 00000000..a84166cc --- /dev/null +++ b/lib/imagekitio/models/webhook_unsafe_unwrap_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Webhooks#unsafe_unwrap + class WebhookUnsafeUnwrapParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/webhook_unwrap_params.rb b/lib/imagekitio/models/webhook_unwrap_params.rb new file mode 100644 index 00000000..a8b318a3 --- /dev/null +++ b/lib/imagekitio/models/webhook_unwrap_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::Webhooks#unwrap + class WebhookUnwrapParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekit/request_options.rb b/lib/imagekitio/request_options.rb similarity index 79% rename from lib/imagekit/request_options.rb rename to lib/imagekitio/request_options.rb index 2e8ffb9e..a372343e 100644 --- a/lib/imagekit/request_options.rb +++ b/lib/imagekitio/request_options.rb @@ -1,20 +1,20 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio # Specify HTTP behaviour to use for a specific request. These options supplement # or override those provided at the client level. # # When making a request, you can pass an actual {RequestOptions} instance, or # simply pass a Hash with symbol keys matching the attributes on this class. - class RequestOptions < Imagekit::Internal::Type::BaseModel + class RequestOptions < Imagekitio::Internal::Type::BaseModel # @api private # - # @param opts [Imagekit::RequestOptions, Hash{Symbol=>Object}] + # @param opts [Imagekitio::RequestOptions, Hash{Symbol=>Object}] # # @raise [ArgumentError] def self.validate!(opts) case opts - in Imagekit::RequestOptions | Hash + in Imagekitio::RequestOptions | Hash opts.to_h.each_key do |k| unless fields.include?(k) raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}") @@ -37,21 +37,21 @@ def self.validate!(opts) # `query` given at the client level. # # @return [Hash{String=>Array, String, nil}, nil] - optional :extra_query, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::ArrayOf[String]] + optional :extra_query, Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::ArrayOf[String]] # @!attribute extra_headers # Extra headers to send with the request. These are `.merged`’d into any # `extra_headers` given at the client level. # # @return [Hash{String=>String, nil}, nil] - optional :extra_headers, Imagekit::Internal::Type::HashOf[String, nil?: true] + optional :extra_headers, Imagekitio::Internal::Type::HashOf[String, nil?: true] # @!attribute extra_body # Extra data to send with the request. These are deep merged into any data # generated as part of the normal request. # # @return [Object, nil] - optional :extra_body, Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown] + optional :extra_body, Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown] # @!attribute max_retries # Maximum number of retries to attempt after a failed initial request. @@ -71,7 +71,7 @@ def self.validate!(opts) # @param values [Hash{Symbol=>Object}] define_sorbet_constant!(:OrHash) do - T.type_alias { T.any(Imagekit::RequestOptions, Imagekit::Internal::AnyHash) } + T.type_alias { T.any(Imagekitio::RequestOptions, Imagekitio::Internal::AnyHash) } end end end diff --git a/lib/imagekitio/resources/accounts.rb b/lib/imagekitio/resources/accounts.rb new file mode 100644 index 00000000..54395573 --- /dev/null +++ b/lib/imagekitio/resources/accounts.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +module Imagekitio + module Resources + class Accounts + # @return [Imagekitio::Resources::Accounts::Usage] + attr_reader :usage + + # @return [Imagekitio::Resources::Accounts::Origins] + attr_reader :origins + + # @return [Imagekitio::Resources::Accounts::URLEndpoints] + attr_reader :url_endpoints + + # @api private + # + # @param client [Imagekitio::Client] + def initialize(client:) + @client = client + @usage = Imagekitio::Resources::Accounts::Usage.new(client: client) + @origins = Imagekitio::Resources::Accounts::Origins.new(client: client) + @url_endpoints = Imagekitio::Resources::Accounts::URLEndpoints.new(client: client) + end + end + end +end diff --git a/lib/imagekitio/resources/accounts/origins.rb b/lib/imagekitio/resources/accounts/origins.rb new file mode 100644 index 00000000..c9c630ee --- /dev/null +++ b/lib/imagekitio/resources/accounts/origins.rb @@ -0,0 +1,145 @@ +# frozen_string_literal: true + +module Imagekitio + module Resources + class Accounts + class Origins + # **Note:** This API is currently in beta. + # Creates a new origin and returns the origin object. + # + # @overload create(origin_request:, request_options: {}) + # + # @param origin_request [Imagekitio::Accounts::OriginRequest] Schema for origin request resources. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekitio::Models::Accounts::OriginResponse::S3, Imagekitio::Models::Accounts::OriginResponse::S3Compatible, Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekitio::Models::Accounts::OriginResponse::WebFolder, Imagekitio::Models::Accounts::OriginResponse::WebProxy, Imagekitio::Models::Accounts::OriginResponse::Gcs, Imagekitio::Models::Accounts::OriginResponse::AzureBlob, Imagekitio::Models::Accounts::OriginResponse::AkeneoPim] + # + # @see Imagekitio::Models::Accounts::OriginCreateParams + def create(params) + parsed, options = Imagekitio::Accounts::OriginCreateParams.dump_request(params) + case parsed + in {origin_request: Hash => union, **rest} + parsed = {**rest, **union} + else + end + @client.request( + method: :post, + path: "v1/accounts/origins", + body: parsed, + model: Imagekitio::Accounts::OriginResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::Accounts::OriginUpdateParams} for more details. + # + # **Note:** This API is currently in beta. + # Updates the origin identified by `id` and returns the updated origin object. + # + # @overload update(id, origin_request:, request_options: {}) + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param origin_request [Imagekitio::Accounts::OriginRequest] Schema for origin request resources. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekitio::Models::Accounts::OriginResponse::S3, Imagekitio::Models::Accounts::OriginResponse::S3Compatible, Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekitio::Models::Accounts::OriginResponse::WebFolder, Imagekitio::Models::Accounts::OriginResponse::WebProxy, Imagekitio::Models::Accounts::OriginResponse::Gcs, Imagekitio::Models::Accounts::OriginResponse::AzureBlob, Imagekitio::Models::Accounts::OriginResponse::AkeneoPim] + # + # @see Imagekitio::Models::Accounts::OriginUpdateParams + def update(id, params) + parsed, options = Imagekitio::Accounts::OriginUpdateParams.dump_request(params) + case parsed + in {origin_request: Hash => union, **rest} + parsed = {**rest, **union} + else + end + @client.request( + method: :put, + path: ["v1/accounts/origins/%1$s", id], + body: parsed, + model: Imagekitio::Accounts::OriginResponse, + options: options + ) + end + + # **Note:** This API is currently in beta. + # Returns an array of all configured origins for the current account. + # + # @overload list(request_options: {}) + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Imagekitio::Models::Accounts::OriginListParams + def list(params = {}) + @client.request( + method: :get, + path: "v1/accounts/origins", + model: Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Accounts::OriginResponse], + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::Accounts::OriginDeleteParams} for more details. + # + # **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. + # + # @overload delete(id, request_options: {}) + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [nil] + # + # @see Imagekitio::Models::Accounts::OriginDeleteParams + def delete(id, params = {}) + @client.request( + method: :delete, + path: ["v1/accounts/origins/%1$s", id], + model: NilClass, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::Accounts::OriginGetParams} for more details. + # + # **Note:** This API is currently in beta. + # Retrieves the origin identified by `id`. + # + # @overload get(id, request_options: {}) + # + # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekitio::Models::Accounts::OriginResponse::S3, Imagekitio::Models::Accounts::OriginResponse::S3Compatible, Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekitio::Models::Accounts::OriginResponse::WebFolder, Imagekitio::Models::Accounts::OriginResponse::WebProxy, Imagekitio::Models::Accounts::OriginResponse::Gcs, Imagekitio::Models::Accounts::OriginResponse::AzureBlob, Imagekitio::Models::Accounts::OriginResponse::AkeneoPim] + # + # @see Imagekitio::Models::Accounts::OriginGetParams + def get(id, params = {}) + @client.request( + method: :get, + path: ["v1/accounts/origins/%1$s", id], + model: Imagekitio::Accounts::OriginResponse, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Imagekitio::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/imagekit/resources/accounts/url_endpoints.rb b/lib/imagekitio/resources/accounts/url_endpoints.rb similarity index 61% rename from lib/imagekit/resources/accounts/url_endpoints.rb rename to lib/imagekitio/resources/accounts/url_endpoints.rb index c94d9fe9..bcd09d19 100644 --- a/lib/imagekit/resources/accounts/url_endpoints.rb +++ b/lib/imagekitio/resources/accounts/url_endpoints.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Accounts class URLEndpoints # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointCreateParams} for more details. + # {Imagekitio::Models::Accounts::URLEndpointCreateParams} for more details. # # **Note:** This API is currently in beta. # Creates a new URL‑endpoint and returns the resulting object. @@ -18,26 +18,26 @@ class URLEndpoints # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::URLEndpointResponse] + # @return [Imagekitio::Models::Accounts::URLEndpointResponse] # - # @see Imagekit::Models::Accounts::URLEndpointCreateParams + # @see Imagekitio::Models::Accounts::URLEndpointCreateParams def create(params) - parsed, options = Imagekit::Accounts::URLEndpointCreateParams.dump_request(params) + parsed, options = Imagekitio::Accounts::URLEndpointCreateParams.dump_request(params) @client.request( method: :post, path: "v1/accounts/url-endpoints", body: parsed, - model: Imagekit::Accounts::URLEndpointResponse, + model: Imagekitio::Accounts::URLEndpointResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointUpdateParams} for more details. + # {Imagekitio::Models::Accounts::URLEndpointUpdateParams} for more details. # # **Note:** This API is currently in beta. # Updates the URL‑endpoint identified by `id` and returns the updated object. @@ -52,20 +52,20 @@ def create(params) # # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an # - # @param url_rewriter [Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekit::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. + # @param url_rewriter [Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::URLEndpointResponse] + # @return [Imagekitio::Models::Accounts::URLEndpointResponse] # - # @see Imagekit::Models::Accounts::URLEndpointUpdateParams + # @see Imagekitio::Models::Accounts::URLEndpointUpdateParams def update(id, params) - parsed, options = Imagekit::Accounts::URLEndpointUpdateParams.dump_request(params) + parsed, options = Imagekitio::Accounts::URLEndpointUpdateParams.dump_request(params) @client.request( method: :put, path: ["v1/accounts/url-endpoints/%1$s", id], body: parsed, - model: Imagekit::Accounts::URLEndpointResponse, + model: Imagekitio::Accounts::URLEndpointResponse, options: options ) end @@ -76,22 +76,22 @@ def update(id, params) # # @overload list(request_options: {}) # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # - # @see Imagekit::Models::Accounts::URLEndpointListParams + # @see Imagekitio::Models::Accounts::URLEndpointListParams def list(params = {}) @client.request( method: :get, path: "v1/accounts/url-endpoints", - model: Imagekit::Internal::Type::ArrayOf[Imagekit::Accounts::URLEndpointResponse], + model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::URLEndpointResponse], options: params[:request_options] ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointDeleteParams} for more details. + # {Imagekitio::Models::Accounts::URLEndpointDeleteParams} for more details. # # **Note:** This API is currently in beta. # Deletes the URL‑endpoint identified by `id`. You cannot delete the default @@ -101,11 +101,11 @@ def list(params = {}) # # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # - # @see Imagekit::Models::Accounts::URLEndpointDeleteParams + # @see Imagekitio::Models::Accounts::URLEndpointDeleteParams def delete(id, params = {}) @client.request( method: :delete, @@ -116,7 +116,7 @@ def delete(id, params = {}) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::URLEndpointGetParams} for more details. + # {Imagekitio::Models::Accounts::URLEndpointGetParams} for more details. # # **Note:** This API is currently in beta. # Retrieves the URL‑endpoint identified by `id`. @@ -125,23 +125,23 @@ def delete(id, params = {}) # # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::URLEndpointResponse] + # @return [Imagekitio::Models::Accounts::URLEndpointResponse] # - # @see Imagekit::Models::Accounts::URLEndpointGetParams + # @see Imagekitio::Models::Accounts::URLEndpointGetParams def get(id, params = {}) @client.request( method: :get, path: ["v1/accounts/url-endpoints/%1$s", id], - model: Imagekit::Accounts::URLEndpointResponse, + model: Imagekitio::Accounts::URLEndpointResponse, options: params[:request_options] ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/accounts/usage.rb b/lib/imagekitio/resources/accounts/usage.rb similarity index 70% rename from lib/imagekit/resources/accounts/usage.rb rename to lib/imagekitio/resources/accounts/usage.rb index ed062095..adcdbc94 100644 --- a/lib/imagekit/resources/accounts/usage.rb +++ b/lib/imagekitio/resources/accounts/usage.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Accounts class Usage # Some parameter documentations has been truncated, see - # {Imagekit::Models::Accounts::UsageGetParams} for more details. + # {Imagekitio::Models::Accounts::UsageGetParams} for more details. # # 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 @@ -18,25 +18,25 @@ class Usage # # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Accounts::UsageGetResponse] + # @return [Imagekitio::Models::Accounts::UsageGetResponse] # - # @see Imagekit::Models::Accounts::UsageGetParams + # @see Imagekitio::Models::Accounts::UsageGetParams def get(params) - parsed, options = Imagekit::Accounts::UsageGetParams.dump_request(params) + parsed, options = Imagekitio::Accounts::UsageGetParams.dump_request(params) @client.request( method: :get, path: "v1/accounts/usage", query: parsed.transform_keys(end_date: "endDate", start_date: "startDate"), - model: Imagekit::Models::Accounts::UsageGetResponse, + model: Imagekitio::Models::Accounts::UsageGetResponse, options: options ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/assets.rb b/lib/imagekitio/resources/assets.rb similarity index 61% rename from lib/imagekit/resources/assets.rb rename to lib/imagekitio/resources/assets.rb index de7abc9a..f9d64ff9 100644 --- a/lib/imagekit/resources/assets.rb +++ b/lib/imagekitio/resources/assets.rb @@ -1,10 +1,10 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Assets # Some parameter documentations has been truncated, see - # {Imagekit::Models::AssetListParams} for more details. + # {Imagekitio::Models::AssetListParams} for more details. # # 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 @@ -13,7 +13,7 @@ class Assets # # @overload list(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) # - # @param file_type [Symbol, Imagekit::Models::AssetListParams::FileType] Filter results by file type. + # @param file_type [Symbol, Imagekitio::Models::AssetListParams::FileType] Filter results by file type. # # @param limit [Integer] The maximum number of results to return in response. # @@ -23,29 +23,29 @@ class Assets # # @param skip [Integer] The number of results to skip before returning results. # - # @param sort [Symbol, Imagekit::Models::AssetListParams::Sort] Sort the results by one of the supported fields in ascending or descending order + # @param sort [Symbol, Imagekitio::Models::AssetListParams::Sort] Sort the results by one of the supported fields in ascending or descending order # - # @param type [Symbol, Imagekit::Models::AssetListParams::Type] Filter results by asset type. + # @param type [Symbol, Imagekitio::Models::AssetListParams::Type] Filter results by asset type. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # - # @see Imagekit::Models::AssetListParams + # @see Imagekitio::Models::AssetListParams def list(params = {}) - parsed, options = Imagekit::AssetListParams.dump_request(params) + parsed, options = Imagekitio::AssetListParams.dump_request(params) @client.request( method: :get, path: "v1/files", query: parsed.transform_keys(file_type: "fileType", search_query: "searchQuery"), - model: Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::AssetListResponseItem], + model: Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Models::AssetListResponseItem], options: options ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/beta.rb b/lib/imagekitio/resources/beta.rb similarity index 53% rename from lib/imagekit/resources/beta.rb rename to lib/imagekitio/resources/beta.rb index b7d7a5ea..20652dd6 100644 --- a/lib/imagekit/resources/beta.rb +++ b/lib/imagekitio/resources/beta.rb @@ -1,17 +1,17 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Beta - # @return [Imagekit::Resources::Beta::V2] + # @return [Imagekitio::Resources::Beta::V2] attr_reader :v2 # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client - @v2 = Imagekit::Resources::Beta::V2.new(client: client) + @v2 = Imagekitio::Resources::Beta::V2.new(client: client) end end end diff --git a/lib/imagekit/resources/beta/v2.rb b/lib/imagekitio/resources/beta/v2.rb similarity index 54% rename from lib/imagekit/resources/beta/v2.rb rename to lib/imagekitio/resources/beta/v2.rb index 8510456c..2176d37b 100644 --- a/lib/imagekit/resources/beta/v2.rb +++ b/lib/imagekitio/resources/beta/v2.rb @@ -1,18 +1,18 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Beta class V2 - # @return [Imagekit::Resources::Beta::V2::Files] + # @return [Imagekitio::Resources::Beta::V2::Files] attr_reader :files # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client - @files = Imagekit::Resources::Beta::V2::Files.new(client: client) + @files = Imagekitio::Resources::Beta::V2::Files.new(client: client) end end end diff --git a/lib/imagekit/resources/beta/v2/files.rb b/lib/imagekitio/resources/beta/v2/files.rb similarity index 79% rename from lib/imagekit/resources/beta/v2/files.rb rename to lib/imagekitio/resources/beta/v2/files.rb index 670d5a60..b5f5da37 100644 --- a/lib/imagekit/resources/beta/v2/files.rb +++ b/lib/imagekitio/resources/beta/v2/files.rb @@ -1,12 +1,12 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Beta class V2 class Files # Some parameter documentations has been truncated, see - # {Imagekit::Models::Beta::V2::FileUploadParams} for more details. + # {Imagekitio::Models::Beta::V2::FileUploadParams} for more details. # # The V2 API enhances security by verifying the entire payload using JWT. This API # is in beta. @@ -38,7 +38,7 @@ class Files # # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [Pathname, StringIO, IO, String, Imagekitio::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # @@ -52,7 +52,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -68,23 +68,23 @@ class Files # # @param overwrite_tags [Boolean] If the request does not have `tags`, and a file already exists at the exact loca # - # @param response_fields [Array] Array of response field keys to include in the API response body. + # @param response_fields [Array] Array of response field keys to include in the API response body. # # @param tags [Array] Set the tags while uploading the file. # - # @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. + # @param transformation [Imagekitio::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. # # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not. # # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Beta::V2::FileUploadResponse] + # @return [Imagekitio::Models::Beta::V2::FileUploadResponse] # - # @see Imagekit::Models::Beta::V2::FileUploadParams + # @see Imagekitio::Models::Beta::V2::FileUploadParams def upload(params) - parsed, options = Imagekit::Beta::V2::FileUploadParams.dump_request(params) + parsed, options = Imagekitio::Beta::V2::FileUploadParams.dump_request(params) path = @client.base_url_overridden? ? "api/v2/files/upload" : "https://upload.imagekit.io/api/v2/files/upload" @client.request( @@ -92,14 +92,14 @@ def upload(params) path: path, headers: {"content-type" => "multipart/form-data"}, body: parsed, - model: Imagekit::Models::Beta::V2::FileUploadResponse, + model: Imagekitio::Models::Beta::V2::FileUploadResponse, options: options ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/cache.rb b/lib/imagekitio/resources/cache.rb similarity index 50% rename from lib/imagekit/resources/cache.rb rename to lib/imagekitio/resources/cache.rb index 1b666377..6a152ac5 100644 --- a/lib/imagekit/resources/cache.rb +++ b/lib/imagekitio/resources/cache.rb @@ -1,17 +1,17 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Cache - # @return [Imagekit::Resources::Cache::Invalidation] + # @return [Imagekitio::Resources::Cache::Invalidation] attr_reader :invalidation # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client - @invalidation = Imagekit::Resources::Cache::Invalidation.new(client: client) + @invalidation = Imagekitio::Resources::Cache::Invalidation.new(client: client) end end end diff --git a/lib/imagekit/resources/cache/invalidation.rb b/lib/imagekitio/resources/cache/invalidation.rb similarity index 60% rename from lib/imagekit/resources/cache/invalidation.rb rename to lib/imagekitio/resources/cache/invalidation.rb index a084abea..2b33348a 100644 --- a/lib/imagekit/resources/cache/invalidation.rb +++ b/lib/imagekitio/resources/cache/invalidation.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Cache class Invalidation # Some parameter documentations has been truncated, see - # {Imagekit::Models::Cache::InvalidationCreateParams} for more details. + # {Imagekitio::Models::Cache::InvalidationCreateParams} for more details. # # 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 @@ -15,24 +15,24 @@ class Invalidation # # @param url [String] The full URL of the file to be purged. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Cache::InvalidationCreateResponse] + # @return [Imagekitio::Models::Cache::InvalidationCreateResponse] # - # @see Imagekit::Models::Cache::InvalidationCreateParams + # @see Imagekitio::Models::Cache::InvalidationCreateParams def create(params) - parsed, options = Imagekit::Cache::InvalidationCreateParams.dump_request(params) + parsed, options = Imagekitio::Cache::InvalidationCreateParams.dump_request(params) @client.request( method: :post, path: "v1/files/purge", body: parsed, - model: Imagekit::Models::Cache::InvalidationCreateResponse, + model: Imagekitio::Models::Cache::InvalidationCreateResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Cache::InvalidationGetParams} for more details. + # {Imagekitio::Models::Cache::InvalidationGetParams} for more details. # # This API returns the status of a purge cache request. # @@ -40,23 +40,23 @@ def create(params) # # @param request_id [String] Should be a valid requestId. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Cache::InvalidationGetResponse] + # @return [Imagekitio::Models::Cache::InvalidationGetResponse] # - # @see Imagekit::Models::Cache::InvalidationGetParams + # @see Imagekitio::Models::Cache::InvalidationGetParams def get(request_id, params = {}) @client.request( method: :get, path: ["v1/files/purge/%1$s", request_id], - model: Imagekit::Models::Cache::InvalidationGetResponse, + model: Imagekitio::Models::Cache::InvalidationGetResponse, options: params[:request_options] ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/custom_metadata_fields.rb b/lib/imagekitio/resources/custom_metadata_fields.rb similarity index 65% rename from lib/imagekit/resources/custom_metadata_fields.rb rename to lib/imagekitio/resources/custom_metadata_fields.rb index 3dc56680..7a811714 100644 --- a/lib/imagekit/resources/custom_metadata_fields.rb +++ b/lib/imagekitio/resources/custom_metadata_fields.rb @@ -1,10 +1,10 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class CustomMetadataFields # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldCreateParams} for more details. + # {Imagekitio::Models::CustomMetadataFieldCreateParams} for more details. # # 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 @@ -17,26 +17,26 @@ class CustomMetadataFields # # @param name [String] API name of the custom metadata field. This should be unique across all (includi # - # @param schema [Imagekit::Models::CustomMetadataFieldCreateParams::Schema] + # @param schema [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema] # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::CustomMetadataField] + # @return [Imagekitio::Models::CustomMetadataField] # - # @see Imagekit::Models::CustomMetadataFieldCreateParams + # @see Imagekitio::Models::CustomMetadataFieldCreateParams def create(params) - parsed, options = Imagekit::CustomMetadataFieldCreateParams.dump_request(params) + parsed, options = Imagekitio::CustomMetadataFieldCreateParams.dump_request(params) @client.request( method: :post, path: "v1/customMetadataFields", body: parsed, - model: Imagekit::CustomMetadataField, + model: Imagekitio::CustomMetadataField, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldUpdateParams} for more details. + # {Imagekitio::Models::CustomMetadataFieldUpdateParams} for more details. # # This API updates the label or schema of an existing custom metadata field. # @@ -46,26 +46,26 @@ def create(params) # # @param label [String] Human readable name of the custom metadata field. This should be unique across a # - # @param schema [Imagekit::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i + # @param schema [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::CustomMetadataField] + # @return [Imagekitio::Models::CustomMetadataField] # - # @see Imagekit::Models::CustomMetadataFieldUpdateParams + # @see Imagekitio::Models::CustomMetadataFieldUpdateParams def update(id, params = {}) - parsed, options = Imagekit::CustomMetadataFieldUpdateParams.dump_request(params) + parsed, options = Imagekitio::CustomMetadataFieldUpdateParams.dump_request(params) @client.request( method: :patch, path: ["v1/customMetadataFields/%1$s", id], body: parsed, - model: Imagekit::CustomMetadataField, + model: Imagekitio::CustomMetadataField, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldListParams} for more details. + # {Imagekitio::Models::CustomMetadataFieldListParams} for more details. # # 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 @@ -82,24 +82,24 @@ def update(id, params = {}) # # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # - # @see Imagekit::Models::CustomMetadataFieldListParams + # @see Imagekitio::Models::CustomMetadataFieldListParams def list(params = {}) - parsed, options = Imagekit::CustomMetadataFieldListParams.dump_request(params) + parsed, options = Imagekitio::CustomMetadataFieldListParams.dump_request(params) @client.request( method: :get, path: "v1/customMetadataFields", query: parsed.transform_keys(folder_path: "folderPath", include_deleted: "includeDeleted"), - model: Imagekit::Internal::Type::ArrayOf[Imagekit::CustomMetadataField], + model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::CustomMetadataField], options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::CustomMetadataFieldDeleteParams} for more details. + # {Imagekitio::Models::CustomMetadataFieldDeleteParams} for more details. # # 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. @@ -108,23 +108,23 @@ def list(params = {}) # # @param id [String] Should be a valid custom metadata field id. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::CustomMetadataFieldDeleteResponse] + # @return [Imagekitio::Models::CustomMetadataFieldDeleteResponse] # - # @see Imagekit::Models::CustomMetadataFieldDeleteParams + # @see Imagekitio::Models::CustomMetadataFieldDeleteParams def delete(id, params = {}) @client.request( method: :delete, path: ["v1/customMetadataFields/%1$s", id], - model: Imagekit::Models::CustomMetadataFieldDeleteResponse, + model: Imagekitio::Models::CustomMetadataFieldDeleteResponse, options: params[:request_options] ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/files.rb b/lib/imagekitio/resources/files.rb similarity index 73% rename from lib/imagekit/resources/files.rb rename to lib/imagekitio/resources/files.rb index 2ddc77ef..ab7db3a5 100644 --- a/lib/imagekit/resources/files.rb +++ b/lib/imagekitio/resources/files.rb @@ -1,19 +1,19 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Files - # @return [Imagekit::Resources::Files::Bulk] + # @return [Imagekitio::Resources::Files::Bulk] attr_reader :bulk - # @return [Imagekit::Resources::Files::Versions] + # @return [Imagekitio::Resources::Files::Versions] attr_reader :versions - # @return [Imagekit::Resources::Files::Metadata] + # @return [Imagekitio::Resources::Files::Metadata] attr_reader :metadata # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUpdateParams} for more details. + # {Imagekitio::Models::FileUpdateParams} for more details. # # This API updates the details or attributes of the current version of the file. # You can update `tags`, `customCoordinates`, `customMetadata`, publication @@ -23,15 +23,15 @@ class Files # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param update_file_request [Imagekit::UpdateFileRequest] Schema for update file update request. + # @param update_file_request [Imagekitio::UpdateFileRequest] Schema for update file update request. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FileUpdateResponse] + # @return [Imagekitio::Models::FileUpdateResponse] # - # @see Imagekit::Models::FileUpdateParams + # @see Imagekitio::Models::FileUpdateParams def update(file_id, params) - parsed, options = Imagekit::FileUpdateParams.dump_request(params) + parsed, options = Imagekitio::FileUpdateParams.dump_request(params) case parsed in {update_file_request: Hash => union, **rest} parsed = {**rest, **union} @@ -41,13 +41,13 @@ def update(file_id, params) method: :patch, path: ["v1/files/%1$s/details", file_id], body: parsed, - model: Imagekit::Models::FileUpdateResponse, + model: Imagekitio::Models::FileUpdateResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileDeleteParams} for more details. + # {Imagekitio::Models::FileDeleteParams} for more details. # # This API deletes the file and all its file versions permanently. # @@ -59,11 +59,11 @@ def update(file_id, params) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # - # @see Imagekit::Models::FileDeleteParams + # @see Imagekitio::Models::FileDeleteParams def delete(file_id, params = {}) @client.request( method: :delete, @@ -74,7 +74,7 @@ def delete(file_id, params = {}) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileCopyParams} for more details. + # {Imagekitio::Models::FileCopyParams} for more details. # # This will copy a file from one folder to another. # @@ -90,24 +90,24 @@ def delete(file_id, params = {}) # # @param include_file_versions [Boolean] Option to copy all versions of a file. By default, only the current version of t # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FileCopyResponse] + # @return [Imagekitio::Models::FileCopyResponse] # - # @see Imagekit::Models::FileCopyParams + # @see Imagekitio::Models::FileCopyParams def copy(params) - parsed, options = Imagekit::FileCopyParams.dump_request(params) + parsed, options = Imagekitio::FileCopyParams.dump_request(params) @client.request( method: :post, path: "v1/files/copy", body: parsed, - model: Imagekit::Models::FileCopyResponse, + model: Imagekitio::Models::FileCopyResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileGetParams} for more details. + # {Imagekitio::Models::FileGetParams} for more details. # # This API returns an object with details or attributes about the current version # of the file. @@ -116,22 +116,22 @@ def copy(params) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::File] + # @return [Imagekitio::Models::File] # - # @see Imagekit::Models::FileGetParams + # @see Imagekitio::Models::FileGetParams def get(file_id, params = {}) @client.request( method: :get, path: ["v1/files/%1$s/details", file_id], - model: Imagekit::File, + model: Imagekitio::File, options: params[:request_options] ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileMoveParams} for more details. + # {Imagekitio::Models::FileMoveParams} for more details. # # This will move a file and all its versions from one folder to another. # @@ -144,24 +144,24 @@ def get(file_id, params = {}) # # @param source_file_path [String] The full path of the file you want to move. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FileMoveResponse] + # @return [Imagekitio::Models::FileMoveResponse] # - # @see Imagekit::Models::FileMoveParams + # @see Imagekitio::Models::FileMoveParams def move(params) - parsed, options = Imagekit::FileMoveParams.dump_request(params) + parsed, options = Imagekitio::FileMoveParams.dump_request(params) @client.request( method: :post, path: "v1/files/move", body: parsed, - model: Imagekit::Models::FileMoveResponse, + model: Imagekitio::Models::FileMoveResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileRenameParams} for more details. + # {Imagekitio::Models::FileRenameParams} for more details. # # 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. @@ -177,24 +177,24 @@ def move(params) # # @param purge_cache [Boolean] Option to purge cache for the old file and its versions' URLs. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FileRenameResponse] + # @return [Imagekitio::Models::FileRenameResponse] # - # @see Imagekit::Models::FileRenameParams + # @see Imagekitio::Models::FileRenameParams def rename(params) - parsed, options = Imagekit::FileRenameParams.dump_request(params) + parsed, options = Imagekitio::FileRenameParams.dump_request(params) @client.request( method: :put, path: "v1/files/rename", body: parsed, - model: Imagekit::Models::FileRenameResponse, + model: Imagekitio::Models::FileRenameResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FileUploadParams} for more details. + # {Imagekitio::Models::FileUploadParams} for more details. # # 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 @@ -226,7 +226,7 @@ def rename(params) # # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) # - # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following: + # @param file [Pathname, StringIO, IO, String, Imagekitio::FilePart] The API accepts any of the following: # # @param file_name [String] The name with which the file has to be uploaded. # @@ -242,7 +242,7 @@ def rename(params) # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # @@ -260,25 +260,25 @@ def rename(params) # # @param public_key [String] Your ImageKit.io public key. This field is only required for authentication when # - # @param response_fields [Array] Array of response field keys to include in the API response body. + # @param response_fields [Array] Array of response field keys to include in the API response body. # # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a # # @param tags [Array] Set the tags while uploading the file. # - # @param transformation [Imagekit::Models::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. + # @param transformation [Imagekitio::Models::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations. # # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not. # # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FileUploadResponse] + # @return [Imagekitio::Models::FileUploadResponse] # - # @see Imagekit::Models::FileUploadParams + # @see Imagekitio::Models::FileUploadParams def upload(params) - parsed, options = Imagekit::FileUploadParams.dump_request(params) + parsed, options = Imagekitio::FileUploadParams.dump_request(params) path = @client.base_url_overridden? ? "api/v1/files/upload" : "https://upload.imagekit.io/api/v1/files/upload" @client.request( @@ -286,19 +286,19 @@ def upload(params) path: path, headers: {"content-type" => "multipart/form-data"}, body: parsed, - model: Imagekit::Models::FileUploadResponse, + model: Imagekitio::Models::FileUploadResponse, options: options ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client - @bulk = Imagekit::Resources::Files::Bulk.new(client: client) - @versions = Imagekit::Resources::Files::Versions.new(client: client) - @metadata = Imagekit::Resources::Files::Metadata.new(client: client) + @bulk = Imagekitio::Resources::Files::Bulk.new(client: client) + @versions = Imagekitio::Resources::Files::Versions.new(client: client) + @metadata = Imagekitio::Resources::Files::Metadata.new(client: client) end end end diff --git a/lib/imagekit/resources/files/bulk.rb b/lib/imagekitio/resources/files/bulk.rb similarity index 64% rename from lib/imagekit/resources/files/bulk.rb rename to lib/imagekitio/resources/files/bulk.rb index 1f09cdbe..946d7af7 100644 --- a/lib/imagekit/resources/files/bulk.rb +++ b/lib/imagekitio/resources/files/bulk.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Files class Bulk # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkDeleteParams} for more details. + # {Imagekitio::Models::Files::BulkDeleteParams} for more details. # # This API deletes multiple files and all their file versions permanently. # @@ -19,24 +19,24 @@ class Bulk # # @param file_ids [Array] An array of fileIds which you want to delete. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::BulkDeleteResponse] + # @return [Imagekitio::Models::Files::BulkDeleteResponse] # - # @see Imagekit::Models::Files::BulkDeleteParams + # @see Imagekitio::Models::Files::BulkDeleteParams def delete(params) - parsed, options = Imagekit::Files::BulkDeleteParams.dump_request(params) + parsed, options = Imagekitio::Files::BulkDeleteParams.dump_request(params) @client.request( method: :post, path: "v1/files/batch/deleteByFileIds", body: parsed, - model: Imagekit::Models::Files::BulkDeleteResponse, + model: Imagekitio::Models::Files::BulkDeleteResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkAddTagsParams} for more details. + # {Imagekitio::Models::Files::BulkAddTagsParams} for more details. # # This API adds tags to multiple files in bulk. A maximum of 50 files can be # specified at a time. @@ -47,24 +47,24 @@ def delete(params) # # @param tags [Array] An array of tags that you want to add to the files. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::BulkAddTagsResponse] + # @return [Imagekitio::Models::Files::BulkAddTagsResponse] # - # @see Imagekit::Models::Files::BulkAddTagsParams + # @see Imagekitio::Models::Files::BulkAddTagsParams def add_tags(params) - parsed, options = Imagekit::Files::BulkAddTagsParams.dump_request(params) + parsed, options = Imagekitio::Files::BulkAddTagsParams.dump_request(params) @client.request( method: :post, path: "v1/files/addTags", body: parsed, - model: Imagekit::Models::Files::BulkAddTagsResponse, + model: Imagekitio::Models::Files::BulkAddTagsResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkRemoveAITagsParams} for more details. + # {Imagekitio::Models::Files::BulkRemoveAITagsParams} for more details. # # This API removes AITags from multiple files in bulk. A maximum of 50 files can # be specified at a time. @@ -75,24 +75,24 @@ def add_tags(params) # # @param file_ids [Array] An array of fileIds from which you want to remove AITags. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::BulkRemoveAITagsResponse] + # @return [Imagekitio::Models::Files::BulkRemoveAITagsResponse] # - # @see Imagekit::Models::Files::BulkRemoveAITagsParams + # @see Imagekitio::Models::Files::BulkRemoveAITagsParams def remove_ai_tags(params) - parsed, options = Imagekit::Files::BulkRemoveAITagsParams.dump_request(params) + parsed, options = Imagekitio::Files::BulkRemoveAITagsParams.dump_request(params) @client.request( method: :post, path: "v1/files/removeAITags", body: parsed, - model: Imagekit::Models::Files::BulkRemoveAITagsResponse, + model: Imagekitio::Models::Files::BulkRemoveAITagsResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::BulkRemoveTagsParams} for more details. + # {Imagekitio::Models::Files::BulkRemoveTagsParams} for more details. # # This API removes tags from multiple files in bulk. A maximum of 50 files can be # specified at a time. @@ -103,25 +103,25 @@ def remove_ai_tags(params) # # @param tags [Array] An array of tags that you want to remove from the files. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::BulkRemoveTagsResponse] + # @return [Imagekitio::Models::Files::BulkRemoveTagsResponse] # - # @see Imagekit::Models::Files::BulkRemoveTagsParams + # @see Imagekitio::Models::Files::BulkRemoveTagsParams def remove_tags(params) - parsed, options = Imagekit::Files::BulkRemoveTagsParams.dump_request(params) + parsed, options = Imagekitio::Files::BulkRemoveTagsParams.dump_request(params) @client.request( method: :post, path: "v1/files/removeTags", body: parsed, - model: Imagekit::Models::Files::BulkRemoveTagsResponse, + model: Imagekitio::Models::Files::BulkRemoveTagsResponse, options: options ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/files/metadata.rb b/lib/imagekitio/resources/files/metadata.rb similarity index 67% rename from lib/imagekit/resources/files/metadata.rb rename to lib/imagekitio/resources/files/metadata.rb index cc941499..1e902b04 100644 --- a/lib/imagekit/resources/files/metadata.rb +++ b/lib/imagekitio/resources/files/metadata.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Files class Metadata # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::MetadataGetParams} for more details. + # {Imagekitio::Models::Files::MetadataGetParams} for more details. # # You can programmatically get image EXIF, pHash, and other metadata for uploaded # files in the ImageKit.io media library using this API. @@ -17,22 +17,22 @@ class Metadata # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Metadata] + # @return [Imagekitio::Models::Metadata] # - # @see Imagekit::Models::Files::MetadataGetParams + # @see Imagekitio::Models::Files::MetadataGetParams def get(file_id, params = {}) @client.request( method: :get, path: ["v1/files/%1$s/metadata", file_id], - model: Imagekit::Metadata, + model: Imagekitio::Metadata, options: params[:request_options] ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::MetadataGetFromURLParams} for more details. + # {Imagekitio::Models::Files::MetadataGetFromURLParams} for more details. # # Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL # using this API. @@ -41,25 +41,25 @@ def get(file_id, params = {}) # # @param url [String] Should be a valid file URL. It should be accessible using your ImageKit.io accou # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Metadata] + # @return [Imagekitio::Models::Metadata] # - # @see Imagekit::Models::Files::MetadataGetFromURLParams + # @see Imagekitio::Models::Files::MetadataGetFromURLParams def get_from_url(params) - parsed, options = Imagekit::Files::MetadataGetFromURLParams.dump_request(params) + parsed, options = Imagekitio::Files::MetadataGetFromURLParams.dump_request(params) @client.request( method: :get, path: "v1/files/metadata", query: parsed, - model: Imagekit::Metadata, + model: Imagekitio::Metadata, options: options ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/files/versions.rb b/lib/imagekitio/resources/files/versions.rb similarity index 68% rename from lib/imagekit/resources/files/versions.rb rename to lib/imagekitio/resources/files/versions.rb index dd712b77..1857b354 100644 --- a/lib/imagekit/resources/files/versions.rb +++ b/lib/imagekitio/resources/files/versions.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Files class Versions # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionListParams} for more details. + # {Imagekitio::Models::Files::VersionListParams} for more details. # # This API returns details of all versions of a file. # @@ -13,22 +13,22 @@ class Versions # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # - # @see Imagekit::Models::Files::VersionListParams + # @see Imagekitio::Models::Files::VersionListParams def list(file_id, params = {}) @client.request( method: :get, path: ["v1/files/%1$s/versions", file_id], - model: Imagekit::Internal::Type::ArrayOf[Imagekit::File], + model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::File], options: params[:request_options] ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionDeleteParams} for more details. + # {Imagekitio::Models::Files::VersionDeleteParams} for more details. # # This API deletes a non-current file version permanently. The API returns an # empty response. @@ -41,13 +41,13 @@ def list(file_id, params = {}) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Files::VersionDeleteResponse] + # @return [Imagekitio::Models::Files::VersionDeleteResponse] # - # @see Imagekit::Models::Files::VersionDeleteParams + # @see Imagekitio::Models::Files::VersionDeleteParams def delete(version_id, params) - parsed, options = Imagekit::Files::VersionDeleteParams.dump_request(params) + parsed, options = Imagekitio::Files::VersionDeleteParams.dump_request(params) file_id = parsed.delete(:file_id) do raise ArgumentError.new("missing required path argument #{_1}") @@ -55,13 +55,13 @@ def delete(version_id, params) @client.request( method: :delete, path: ["v1/files/%1$s/versions/%2$s", file_id, version_id], - model: Imagekit::Models::Files::VersionDeleteResponse, + model: Imagekitio::Models::Files::VersionDeleteResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionGetParams} for more details. + # {Imagekitio::Models::Files::VersionGetParams} for more details. # # This API returns an object with details or attributes of a file version. # @@ -71,13 +71,13 @@ def delete(version_id, params) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::File] + # @return [Imagekitio::Models::File] # - # @see Imagekit::Models::Files::VersionGetParams + # @see Imagekitio::Models::Files::VersionGetParams def get(version_id, params) - parsed, options = Imagekit::Files::VersionGetParams.dump_request(params) + parsed, options = Imagekitio::Files::VersionGetParams.dump_request(params) file_id = parsed.delete(:file_id) do raise ArgumentError.new("missing required path argument #{_1}") @@ -85,13 +85,13 @@ def get(version_id, params) @client.request( method: :get, path: ["v1/files/%1$s/versions/%2$s", file_id, version_id], - model: Imagekit::File, + model: Imagekitio::File, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::Files::VersionRestoreParams} for more details. + # {Imagekitio::Models::Files::VersionRestoreParams} for more details. # # This API restores a file version as the current file version. # @@ -101,13 +101,13 @@ def get(version_id, params) # # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::File] + # @return [Imagekitio::Models::File] # - # @see Imagekit::Models::Files::VersionRestoreParams + # @see Imagekitio::Models::Files::VersionRestoreParams def restore(version_id, params) - parsed, options = Imagekit::Files::VersionRestoreParams.dump_request(params) + parsed, options = Imagekitio::Files::VersionRestoreParams.dump_request(params) file_id = parsed.delete(:file_id) do raise ArgumentError.new("missing required path argument #{_1}") @@ -115,14 +115,14 @@ def restore(version_id, params) @client.request( method: :put, path: ["v1/files/%1$s/versions/%2$s/restore", file_id, version_id], - model: Imagekit::File, + model: Imagekitio::File, options: options ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekit/resources/folders.rb b/lib/imagekitio/resources/folders.rb similarity index 67% rename from lib/imagekit/resources/folders.rb rename to lib/imagekitio/resources/folders.rb index ad5e4b10..f9c391e6 100644 --- a/lib/imagekit/resources/folders.rb +++ b/lib/imagekitio/resources/folders.rb @@ -1,13 +1,13 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Folders - # @return [Imagekit::Resources::Folders::Job] + # @return [Imagekitio::Resources::Folders::Job] attr_reader :job # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderCreateParams} for more details. + # {Imagekitio::Models::FolderCreateParams} for more details. # # 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. @@ -18,24 +18,24 @@ class Folders # # @param parent_folder_path [String] The folder where the new folder should be created, for root use `/` else the pat # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FolderCreateResponse] + # @return [Imagekitio::Models::FolderCreateResponse] # - # @see Imagekit::Models::FolderCreateParams + # @see Imagekitio::Models::FolderCreateParams def create(params) - parsed, options = Imagekit::FolderCreateParams.dump_request(params) + parsed, options = Imagekitio::FolderCreateParams.dump_request(params) @client.request( method: :post, path: "v1/folder", body: parsed, - model: Imagekit::Models::FolderCreateResponse, + model: Imagekitio::Models::FolderCreateResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderDeleteParams} for more details. + # {Imagekitio::Models::FolderDeleteParams} for more details. # # This will delete a folder and all its contents permanently. The API returns an # empty response. @@ -44,24 +44,24 @@ def create(params) # # @param folder_path [String] Full path to the folder you want to delete. For example `/folder/to/delete/`. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FolderDeleteResponse] + # @return [Imagekitio::Models::FolderDeleteResponse] # - # @see Imagekit::Models::FolderDeleteParams + # @see Imagekitio::Models::FolderDeleteParams def delete(params) - parsed, options = Imagekit::FolderDeleteParams.dump_request(params) + parsed, options = Imagekitio::FolderDeleteParams.dump_request(params) @client.request( method: :delete, path: "v1/folder", body: parsed, - model: Imagekit::Models::FolderDeleteResponse, + model: Imagekitio::Models::FolderDeleteResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderCopyParams} for more details. + # {Imagekitio::Models::FolderCopyParams} for more details. # # 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 @@ -77,24 +77,24 @@ def delete(params) # # @param include_versions [Boolean] Option to copy all versions of files that are nested inside the selected folder. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FolderCopyResponse] + # @return [Imagekitio::Models::FolderCopyResponse] # - # @see Imagekit::Models::FolderCopyParams + # @see Imagekitio::Models::FolderCopyParams def copy(params) - parsed, options = Imagekit::FolderCopyParams.dump_request(params) + parsed, options = Imagekitio::FolderCopyParams.dump_request(params) @client.request( method: :post, path: "v1/bulkJobs/copyFolder", body: parsed, - model: Imagekit::Models::FolderCopyResponse, + model: Imagekitio::Models::FolderCopyResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderMoveParams} for more details. + # {Imagekitio::Models::FolderMoveParams} for more details. # # 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 @@ -107,24 +107,24 @@ def copy(params) # # @param source_folder_path [String] The full path to the source folder you want to move. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FolderMoveResponse] + # @return [Imagekitio::Models::FolderMoveResponse] # - # @see Imagekit::Models::FolderMoveParams + # @see Imagekitio::Models::FolderMoveParams def move(params) - parsed, options = Imagekit::FolderMoveParams.dump_request(params) + parsed, options = Imagekitio::FolderMoveParams.dump_request(params) @client.request( method: :post, path: "v1/bulkJobs/moveFolder", body: parsed, - model: Imagekit::Models::FolderMoveResponse, + model: Imagekitio::Models::FolderMoveResponse, options: options ) end # Some parameter documentations has been truncated, see - # {Imagekit::Models::FolderRenameParams} for more details. + # {Imagekitio::Models::FolderRenameParams} for more details. # # 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 @@ -138,28 +138,28 @@ def move(params) # # @param purge_cache [Boolean] Option to purge cache for the old nested files and their versions' URLs. # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::FolderRenameResponse] + # @return [Imagekitio::Models::FolderRenameResponse] # - # @see Imagekit::Models::FolderRenameParams + # @see Imagekitio::Models::FolderRenameParams def rename(params) - parsed, options = Imagekit::FolderRenameParams.dump_request(params) + parsed, options = Imagekitio::FolderRenameParams.dump_request(params) @client.request( method: :post, path: "v1/bulkJobs/renameFolder", body: parsed, - model: Imagekit::Models::FolderRenameResponse, + model: Imagekitio::Models::FolderRenameResponse, options: options ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client - @job = Imagekit::Resources::Folders::Job.new(client: client) + @job = Imagekitio::Resources::Folders::Job.new(client: client) end end end diff --git a/lib/imagekit/resources/folders/job.rb b/lib/imagekitio/resources/folders/job.rb similarity index 66% rename from lib/imagekit/resources/folders/job.rb rename to lib/imagekitio/resources/folders/job.rb index 8c900133..1a3d494f 100644 --- a/lib/imagekit/resources/folders/job.rb +++ b/lib/imagekitio/resources/folders/job.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Resources class Folders class Job # Some parameter documentations has been truncated, see - # {Imagekit::Models::Folders::JobGetParams} for more details. + # {Imagekitio::Models::Folders::JobGetParams} for more details. # # This API returns the status of a bulk job like copy and move folder operations. # @@ -13,23 +13,23 @@ class Job # # @param job_id [String] The `jobId` is returned in the response of bulk job API e.g. copy folder or move # - # @param request_options [Imagekit::RequestOptions, Hash{Symbol=>Object}, nil] + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Imagekit::Models::Folders::JobGetResponse] + # @return [Imagekitio::Models::Folders::JobGetResponse] # - # @see Imagekit::Models::Folders::JobGetParams + # @see Imagekitio::Models::Folders::JobGetParams def get(job_id, params = {}) @client.request( method: :get, path: ["v1/bulkJobs/%1$s", job_id], - model: Imagekit::Models::Folders::JobGetResponse, + model: Imagekitio::Models::Folders::JobGetResponse, options: params[:request_options] ) end # @api private # - # @param client [Imagekit::Client] + # @param client [Imagekitio::Client] def initialize(client:) @client = client end diff --git a/lib/imagekitio/resources/webhooks.rb b/lib/imagekitio/resources/webhooks.rb new file mode 100644 index 00000000..a01015e6 --- /dev/null +++ b/lib/imagekitio/resources/webhooks.rb @@ -0,0 +1,30 @@ +# frozen_string_literal: true + +module Imagekitio + module Resources + class Webhooks + # @param payload [String] The raw webhook payload as a string + # + # @return [Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent] + def unsafe_unwrap(payload) + parsed = JSON.parse(payload, symbolize_names: true) + Imagekitio::Internal::Type::Converter.coerce(Imagekitio::Models::UnsafeUnwrapWebhookEvent, parsed) + end + + # @param payload [String] The raw webhook payload as a string + # + # @return [Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent] + def unwrap(payload) + parsed = JSON.parse(payload, symbolize_names: true) + Imagekitio::Internal::Type::Converter.coerce(Imagekitio::Models::UnwrapWebhookEvent, parsed) + end + + # @api private + # + # @param client [Imagekitio::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/imagekit/version.rb b/lib/imagekitio/version.rb similarity index 75% rename from lib/imagekit/version.rb rename to lib/imagekitio/version.rb index 2350f394..1155ae5e 100644 --- a/lib/imagekit/version.rb +++ b/lib/imagekitio/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio VERSION = "0.0.1" end diff --git a/rbi/imagekit/models.rbi b/rbi/imagekit/models.rbi deleted file mode 100644 index adedf849..00000000 --- a/rbi/imagekit/models.rbi +++ /dev/null @@ -1,134 +0,0 @@ -# typed: strong - -module Imagekit - Accounts = Imagekit::Models::Accounts - - AssetListParams = Imagekit::Models::AssetListParams - - BaseOverlay = Imagekit::Models::BaseOverlay - - BaseWebhookEvent = Imagekit::Models::BaseWebhookEvent - - Beta = Imagekit::Models::Beta - - Cache = Imagekit::Models::Cache - - CustomMetadataField = Imagekit::Models::CustomMetadataField - - CustomMetadataFieldCreateParams = - Imagekit::Models::CustomMetadataFieldCreateParams - - CustomMetadataFieldDeleteParams = - Imagekit::Models::CustomMetadataFieldDeleteParams - - CustomMetadataFieldListParams = - Imagekit::Models::CustomMetadataFieldListParams - - CustomMetadataFieldUpdateParams = - Imagekit::Models::CustomMetadataFieldUpdateParams - - ExtensionItem = Imagekit::Models::ExtensionItem - - Extensions = - T.let(Imagekit::Models::Extensions, Imagekit::Internal::Type::Converter) - - File = Imagekit::Models::File - - FileCopyParams = Imagekit::Models::FileCopyParams - - FileDeleteParams = Imagekit::Models::FileDeleteParams - - FileGetParams = Imagekit::Models::FileGetParams - - FileMoveParams = Imagekit::Models::FileMoveParams - - FileRenameParams = Imagekit::Models::FileRenameParams - - Files = Imagekit::Models::Files - - FileUpdateParams = Imagekit::Models::FileUpdateParams - - FileUploadParams = Imagekit::Models::FileUploadParams - - Folder = Imagekit::Models::Folder - - FolderCopyParams = Imagekit::Models::FolderCopyParams - - FolderCreateParams = Imagekit::Models::FolderCreateParams - - FolderDeleteParams = Imagekit::Models::FolderDeleteParams - - FolderMoveParams = Imagekit::Models::FolderMoveParams - - FolderRenameParams = Imagekit::Models::FolderRenameParams - - Folders = Imagekit::Models::Folders - - GetImageAttributesOptions = Imagekit::Models::GetImageAttributesOptions - - ImageOverlay = Imagekit::Models::ImageOverlay - - Metadata = Imagekit::Models::Metadata - - Overlay = Imagekit::Models::Overlay - - OverlayPosition = Imagekit::Models::OverlayPosition - - OverlayTiming = Imagekit::Models::OverlayTiming - - ResponsiveImageAttributes = Imagekit::Models::ResponsiveImageAttributes - - SolidColorOverlay = Imagekit::Models::SolidColorOverlay - - SolidColorOverlayTransformation = - Imagekit::Models::SolidColorOverlayTransformation - - SrcOptions = Imagekit::Models::SrcOptions - - StreamingResolution = Imagekit::Models::StreamingResolution - - SubtitleOverlay = Imagekit::Models::SubtitleOverlay - - SubtitleOverlayTransformation = - Imagekit::Models::SubtitleOverlayTransformation - - TextOverlay = Imagekit::Models::TextOverlay - - TextOverlayTransformation = Imagekit::Models::TextOverlayTransformation - - Transformation = Imagekit::Models::Transformation - - TransformationPosition = Imagekit::Models::TransformationPosition - - UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent - - UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - - UpdateFileRequest = Imagekit::Models::UpdateFileRequest - - UploadPostTransformErrorEvent = - Imagekit::Models::UploadPostTransformErrorEvent - - UploadPostTransformSuccessEvent = - Imagekit::Models::UploadPostTransformSuccessEvent - - UploadPreTransformErrorEvent = Imagekit::Models::UploadPreTransformErrorEvent - - UploadPreTransformSuccessEvent = - Imagekit::Models::UploadPreTransformSuccessEvent - - VideoOverlay = Imagekit::Models::VideoOverlay - - VideoTransformationAcceptedEvent = - Imagekit::Models::VideoTransformationAcceptedEvent - - VideoTransformationErrorEvent = - Imagekit::Models::VideoTransformationErrorEvent - - VideoTransformationReadyEvent = - Imagekit::Models::VideoTransformationReadyEvent - - WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams - - WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams -end diff --git a/rbi/imagekit/models/accounts/origin_create_params.rbi b/rbi/imagekit/models/accounts/origin_create_params.rbi deleted file mode 100644 index 96e32302..00000000 --- a/rbi/imagekit/models/accounts/origin_create_params.rbi +++ /dev/null @@ -1,81 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class OriginCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginCreateParams, - Imagekit::Internal::AnyHash - ) - end - - # Schema for origin request resources. - sig do - returns( - T.any( - Imagekit::Accounts::OriginRequest::S3, - Imagekit::Accounts::OriginRequest::S3Compatible, - Imagekit::Accounts::OriginRequest::CloudinaryBackup, - Imagekit::Accounts::OriginRequest::WebFolder, - Imagekit::Accounts::OriginRequest::WebProxy, - Imagekit::Accounts::OriginRequest::Gcs, - Imagekit::Accounts::OriginRequest::AzureBlob, - Imagekit::Accounts::OriginRequest::AkeneoPim - ) - ) - end - attr_accessor :origin_request - - sig do - params( - origin_request: - T.any( - Imagekit::Accounts::OriginRequest::S3::OrHash, - Imagekit::Accounts::OriginRequest::S3Compatible::OrHash, - Imagekit::Accounts::OriginRequest::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginRequest::WebFolder::OrHash, - Imagekit::Accounts::OriginRequest::WebProxy::OrHash, - Imagekit::Accounts::OriginRequest::Gcs::OrHash, - Imagekit::Accounts::OriginRequest::AzureBlob::OrHash, - Imagekit::Accounts::OriginRequest::AkeneoPim::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Schema for origin request resources. - origin_request:, - request_options: {} - ) - end - - sig do - override.returns( - { - origin_request: - T.any( - Imagekit::Accounts::OriginRequest::S3, - Imagekit::Accounts::OriginRequest::S3Compatible, - Imagekit::Accounts::OriginRequest::CloudinaryBackup, - Imagekit::Accounts::OriginRequest::WebFolder, - Imagekit::Accounts::OriginRequest::WebProxy, - Imagekit::Accounts::OriginRequest::Gcs, - Imagekit::Accounts::OriginRequest::AzureBlob, - Imagekit::Accounts::OriginRequest::AkeneoPim - ), - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/origin_delete_params.rbi b/rbi/imagekit/models/accounts/origin_delete_params.rbi deleted file mode 100644 index 02d3f036..00000000 --- a/rbi/imagekit/models/accounts/origin_delete_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class OriginDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginDeleteParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/origin_get_params.rbi b/rbi/imagekit/models/accounts/origin_get_params.rbi deleted file mode 100644 index 6ffd3f1a..00000000 --- a/rbi/imagekit/models/accounts/origin_get_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class OriginGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginGetParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/origin_list_params.rbi b/rbi/imagekit/models/accounts/origin_list_params.rbi deleted file mode 100644 index 8179eab0..00000000 --- a/rbi/imagekit/models/accounts/origin_list_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class OriginListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginListParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/origin_list_response.rbi b/rbi/imagekit/models/accounts/origin_list_response.rbi deleted file mode 100644 index 95287046..00000000 --- a/rbi/imagekit/models/accounts/origin_list_response.rbi +++ /dev/null @@ -1,15 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - OriginListResponse = - T.let( - Imagekit::Internal::Type::ArrayOf[ - union: Imagekit::Accounts::OriginResponse - ], - Imagekit::Internal::Type::Converter - ) - end - end -end diff --git a/rbi/imagekit/models/accounts/origin_update_params.rbi b/rbi/imagekit/models/accounts/origin_update_params.rbi deleted file mode 100644 index 99f6e6f2..00000000 --- a/rbi/imagekit/models/accounts/origin_update_params.rbi +++ /dev/null @@ -1,81 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class OriginUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::OriginUpdateParams, - Imagekit::Internal::AnyHash - ) - end - - # Schema for origin request resources. - sig do - returns( - T.any( - Imagekit::Accounts::OriginRequest::S3, - Imagekit::Accounts::OriginRequest::S3Compatible, - Imagekit::Accounts::OriginRequest::CloudinaryBackup, - Imagekit::Accounts::OriginRequest::WebFolder, - Imagekit::Accounts::OriginRequest::WebProxy, - Imagekit::Accounts::OriginRequest::Gcs, - Imagekit::Accounts::OriginRequest::AzureBlob, - Imagekit::Accounts::OriginRequest::AkeneoPim - ) - ) - end - attr_accessor :origin_request - - sig do - params( - origin_request: - T.any( - Imagekit::Accounts::OriginRequest::S3::OrHash, - Imagekit::Accounts::OriginRequest::S3Compatible::OrHash, - Imagekit::Accounts::OriginRequest::CloudinaryBackup::OrHash, - Imagekit::Accounts::OriginRequest::WebFolder::OrHash, - Imagekit::Accounts::OriginRequest::WebProxy::OrHash, - Imagekit::Accounts::OriginRequest::Gcs::OrHash, - Imagekit::Accounts::OriginRequest::AzureBlob::OrHash, - Imagekit::Accounts::OriginRequest::AkeneoPim::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Schema for origin request resources. - origin_request:, - request_options: {} - ) - end - - sig do - override.returns( - { - origin_request: - T.any( - Imagekit::Accounts::OriginRequest::S3, - Imagekit::Accounts::OriginRequest::S3Compatible, - Imagekit::Accounts::OriginRequest::CloudinaryBackup, - Imagekit::Accounts::OriginRequest::WebFolder, - Imagekit::Accounts::OriginRequest::WebProxy, - Imagekit::Accounts::OriginRequest::Gcs, - Imagekit::Accounts::OriginRequest::AzureBlob, - Imagekit::Accounts::OriginRequest::AkeneoPim - ), - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi deleted file mode 100644 index 002fe2e3..00000000 --- a/rbi/imagekit/models/accounts/url_endpoint_create_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpointRequest - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointCreateParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/url_endpoint_delete_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_delete_params.rbi deleted file mode 100644 index c8952d88..00000000 --- a/rbi/imagekit/models/accounts/url_endpoint_delete_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class URLEndpointDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointDeleteParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/url_endpoint_get_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_get_params.rbi deleted file mode 100644 index 2d965592..00000000 --- a/rbi/imagekit/models/accounts/url_endpoint_get_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class URLEndpointGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointGetParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/url_endpoint_list_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_list_params.rbi deleted file mode 100644 index fbf7b441..00000000 --- a/rbi/imagekit/models/accounts/url_endpoint_list_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class URLEndpointListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointListParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi b/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi deleted file mode 100644 index d943f0ea..00000000 --- a/rbi/imagekit/models/accounts/url_endpoint_list_response.rbi +++ /dev/null @@ -1,15 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - URLEndpointListResponse = - T.let( - Imagekit::Internal::Type::ArrayOf[ - Imagekit::Accounts::URLEndpointResponse - ], - Imagekit::Internal::Type::Converter - ) - end - end -end diff --git a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi b/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi deleted file mode 100644 index 91f649a0..00000000 --- a/rbi/imagekit/models/accounts/url_endpoint_update_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Accounts - class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpointRequest - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Accounts::URLEndpointUpdateParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/asset_list_response.rbi b/rbi/imagekit/models/asset_list_response.rbi deleted file mode 100644 index 3f9f4f86..00000000 --- a/rbi/imagekit/models/asset_list_response.rbi +++ /dev/null @@ -1,28 +0,0 @@ -# typed: strong - -module Imagekit - module Models - # Object containing details of a file or file version. - module AssetListResponseItem - extend Imagekit::Internal::Type::Union - - Variants = T.type_alias { T.any(Imagekit::Folder, Imagekit::File) } - - sig do - override.returns( - T::Array[Imagekit::Models::AssetListResponseItem::Variants] - ) - end - def self.variants - end - end - - AssetListResponse = - T.let( - Imagekit::Internal::Type::ArrayOf[ - union: Imagekit::Models::AssetListResponseItem - ], - Imagekit::Internal::Type::Converter - ) - end -end diff --git a/rbi/imagekit/models/base_overlay.rbi b/rbi/imagekit/models/base_overlay.rbi deleted file mode 100644 index fc1a6eea..00000000 --- a/rbi/imagekit/models/base_overlay.rbi +++ /dev/null @@ -1,44 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class BaseOverlay < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::BaseOverlay, Imagekit::Internal::AnyHash) - end - - sig { returns(T.nilable(Imagekit::OverlayPosition)) } - attr_reader :position - - sig { params(position: Imagekit::OverlayPosition::OrHash).void } - attr_writer :position - - sig { returns(T.nilable(Imagekit::OverlayTiming)) } - attr_reader :timing - - sig { params(timing: Imagekit::OverlayTiming::OrHash).void } - attr_writer :timing - - sig do - params( - position: Imagekit::OverlayPosition::OrHash, - timing: Imagekit::OverlayTiming::OrHash - ).returns(T.attached_class) - end - def self.new(position: nil, timing: nil) - end - - sig do - override.returns( - { - position: Imagekit::OverlayPosition, - timing: Imagekit::OverlayTiming - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/cache/invalidation_get_params.rbi b/rbi/imagekit/models/cache/invalidation_get_params.rbi deleted file mode 100644 index 07375fb7..00000000 --- a/rbi/imagekit/models/cache/invalidation_get_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Cache - class InvalidationGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Cache::InvalidationGetParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/custom_metadata_field_delete_params.rbi b/rbi/imagekit/models/custom_metadata_field_delete_params.rbi deleted file mode 100644 index 677f0d13..00000000 --- a/rbi/imagekit/models/custom_metadata_field_delete_params.rbi +++ /dev/null @@ -1,30 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class CustomMetadataFieldDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::CustomMetadataFieldDeleteParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/custom_metadata_field_list_response.rbi b/rbi/imagekit/models/custom_metadata_field_list_response.rbi deleted file mode 100644 index ca0368f0..00000000 --- a/rbi/imagekit/models/custom_metadata_field_list_response.rbi +++ /dev/null @@ -1,11 +0,0 @@ -# typed: strong - -module Imagekit - module Models - CustomMetadataFieldListResponse = - T.let( - Imagekit::Internal::Type::ArrayOf[Imagekit::CustomMetadataField], - Imagekit::Internal::Type::Converter - ) - end -end diff --git a/rbi/imagekit/models/file_delete_params.rbi b/rbi/imagekit/models/file_delete_params.rbi deleted file mode 100644 index 9573cf16..00000000 --- a/rbi/imagekit/models/file_delete_params.rbi +++ /dev/null @@ -1,27 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileDeleteParams, Imagekit::Internal::AnyHash) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_get_params.rbi b/rbi/imagekit/models/file_get_params.rbi deleted file mode 100644 index f6b5b068..00000000 --- a/rbi/imagekit/models/file_get_params.rbi +++ /dev/null @@ -1,27 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileGetParams, Imagekit::Internal::AnyHash) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_move_response.rbi b/rbi/imagekit/models/file_move_response.rbi deleted file mode 100644 index d59ff9bd..00000000 --- a/rbi/imagekit/models/file_move_response.rbi +++ /dev/null @@ -1,20 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileMoveResponse < Imagekit::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Imagekit::Models::FileMoveResponse, Imagekit::Internal::AnyHash) - end - - sig { returns(T.attached_class) } - def self.new - end - - sig { override.returns({}) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/file_update_params.rbi b/rbi/imagekit/models/file_update_params.rbi deleted file mode 100644 index 908bd758..00000000 --- a/rbi/imagekit/models/file_update_params.rbi +++ /dev/null @@ -1,58 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class FileUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::FileUpdateParams, Imagekit::Internal::AnyHash) - end - - # Schema for update file update request. - sig do - returns( - T.any( - Imagekit::UpdateFileRequest::UpdateFileDetails, - Imagekit::UpdateFileRequest::ChangePublicationStatus - ) - ) - end - attr_accessor :update_file_request - - sig do - params( - update_file_request: - T.any( - Imagekit::UpdateFileRequest::UpdateFileDetails::OrHash, - Imagekit::UpdateFileRequest::ChangePublicationStatus::OrHash - ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Schema for update file update request. - update_file_request:, - request_options: {} - ) - end - - sig do - override.returns( - { - update_file_request: - T.any( - Imagekit::UpdateFileRequest::UpdateFileDetails, - Imagekit::UpdateFileRequest::ChangePublicationStatus - ), - request_options: Imagekit::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/files/metadata_get_params.rbi b/rbi/imagekit/models/files/metadata_get_params.rbi deleted file mode 100644 index af5861ac..00000000 --- a/rbi/imagekit/models/files/metadata_get_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class MetadataGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Files::MetadataGetParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/files/version_list_params.rbi b/rbi/imagekit/models/files/version_list_params.rbi deleted file mode 100644 index 496f70bb..00000000 --- a/rbi/imagekit/models/files/version_list_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - class VersionListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::Files::VersionListParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/files/version_list_response.rbi b/rbi/imagekit/models/files/version_list_response.rbi deleted file mode 100644 index 8ac552c7..00000000 --- a/rbi/imagekit/models/files/version_list_response.rbi +++ /dev/null @@ -1,13 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Files - VersionListResponse = - T.let( - Imagekit::Internal::Type::ArrayOf[Imagekit::File], - Imagekit::Internal::Type::Converter - ) - end - end -end diff --git a/rbi/imagekit/models/folders/job_get_params.rbi b/rbi/imagekit/models/folders/job_get_params.rbi deleted file mode 100644 index 5dc84db4..00000000 --- a/rbi/imagekit/models/folders/job_get_params.rbi +++ /dev/null @@ -1,29 +0,0 @@ -# typed: strong - -module Imagekit - module Models - module Folders - class JobGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::Folders::JobGetParams, Imagekit::Internal::AnyHash) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/imagekit/models/streaming_resolution.rbi b/rbi/imagekit/models/streaming_resolution.rbi deleted file mode 100644 index d64a122e..00000000 --- a/rbi/imagekit/models/streaming_resolution.rbi +++ /dev/null @@ -1,36 +0,0 @@ -# typed: strong - -module Imagekit - module Models - # Available streaming resolutions for - # [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming) - module StreamingResolution - extend Imagekit::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::StreamingResolution) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - STREAMING_RESOLUTION_240 = - T.let(:"240", Imagekit::StreamingResolution::TaggedSymbol) - STREAMING_RESOLUTION_360 = - T.let(:"360", Imagekit::StreamingResolution::TaggedSymbol) - STREAMING_RESOLUTION_480 = - T.let(:"480", Imagekit::StreamingResolution::TaggedSymbol) - STREAMING_RESOLUTION_720 = - T.let(:"720", Imagekit::StreamingResolution::TaggedSymbol) - STREAMING_RESOLUTION_1080 = - T.let(:"1080", Imagekit::StreamingResolution::TaggedSymbol) - STREAMING_RESOLUTION_1440 = - T.let(:"1440", Imagekit::StreamingResolution::TaggedSymbol) - STREAMING_RESOLUTION_2160 = - T.let(:"2160", Imagekit::StreamingResolution::TaggedSymbol) - - sig do - override.returns(T::Array[Imagekit::StreamingResolution::TaggedSymbol]) - end - def self.values - end - end - end -end diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi deleted file mode 100644 index 4dbc761c..00000000 --- a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi +++ /dev/null @@ -1,31 +0,0 @@ -# typed: strong - -module Imagekit - module Models - # 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. - module UnsafeUnwrapWebhookEvent - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent, - Imagekit::UploadPreTransformSuccessEvent, - Imagekit::UploadPreTransformErrorEvent, - Imagekit::UploadPostTransformSuccessEvent, - Imagekit::UploadPostTransformErrorEvent - ) - end - - sig do - override.returns(T::Array[Imagekit::UnsafeUnwrapWebhookEvent::Variants]) - end - def self.variants - end - end - end -end diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi deleted file mode 100644 index b94a7e27..00000000 --- a/rbi/imagekit/models/unwrap_webhook_event.rbi +++ /dev/null @@ -1,29 +0,0 @@ -# typed: strong - -module Imagekit - module Models - # 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. - module UnwrapWebhookEvent - extend Imagekit::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent, - Imagekit::UploadPreTransformSuccessEvent, - Imagekit::UploadPreTransformErrorEvent, - Imagekit::UploadPostTransformSuccessEvent, - Imagekit::UploadPostTransformErrorEvent - ) - end - - sig { override.returns(T::Array[Imagekit::UnwrapWebhookEvent::Variants]) } - def self.variants - end - end - end -end diff --git a/rbi/imagekit/models/webhook_unsafe_unwrap_params.rbi b/rbi/imagekit/models/webhook_unsafe_unwrap_params.rbi deleted file mode 100644 index 60cbea60..00000000 --- a/rbi/imagekit/models/webhook_unsafe_unwrap_params.rbi +++ /dev/null @@ -1,30 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class WebhookUnsafeUnwrapParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Imagekit::WebhookUnsafeUnwrapParams, - Imagekit::Internal::AnyHash - ) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/models/webhook_unwrap_params.rbi b/rbi/imagekit/models/webhook_unwrap_params.rbi deleted file mode 100644 index b3db3d7b..00000000 --- a/rbi/imagekit/models/webhook_unwrap_params.rbi +++ /dev/null @@ -1,27 +0,0 @@ -# typed: strong - -module Imagekit - module Models - class WebhookUnwrapParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Imagekit::WebhookUnwrapParams, Imagekit::Internal::AnyHash) - end - - sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Imagekit::RequestOptions }) } - def to_hash - end - end - end -end diff --git a/rbi/imagekit/resources/accounts.rbi b/rbi/imagekit/resources/accounts.rbi deleted file mode 100644 index 6a50dd49..00000000 --- a/rbi/imagekit/resources/accounts.rbi +++ /dev/null @@ -1,21 +0,0 @@ -# typed: strong - -module Imagekit - module Resources - class Accounts - sig { returns(Imagekit::Resources::Accounts::Usage) } - attr_reader :usage - - sig { returns(Imagekit::Resources::Accounts::Origins) } - attr_reader :origins - - sig { returns(Imagekit::Resources::Accounts::URLEndpoints) } - attr_reader :url_endpoints - - # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } - def self.new(client:) - end - end - end -end diff --git a/rbi/imagekit/resources/webhooks.rbi b/rbi/imagekit/resources/webhooks.rbi deleted file mode 100644 index 76b48078..00000000 --- a/rbi/imagekit/resources/webhooks.rbi +++ /dev/null @@ -1,50 +0,0 @@ -# typed: strong - -module Imagekit - module Resources - class Webhooks - sig do - params(payload: String).returns( - T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent, - Imagekit::UploadPreTransformSuccessEvent, - Imagekit::UploadPreTransformErrorEvent, - Imagekit::UploadPostTransformSuccessEvent, - Imagekit::UploadPostTransformErrorEvent - ) - ) - end - def unsafe_unwrap( - # The raw webhook payload as a string - payload - ) - end - - sig do - params(payload: String).returns( - T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::VideoTransformationReadyEvent, - Imagekit::VideoTransformationErrorEvent, - Imagekit::UploadPreTransformSuccessEvent, - Imagekit::UploadPreTransformErrorEvent, - Imagekit::UploadPostTransformSuccessEvent, - Imagekit::UploadPostTransformErrorEvent - ) - ) - end - def unwrap( - # The raw webhook payload as a string - payload - ) - end - - # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } - def self.new(client:) - end - end - end -end diff --git a/rbi/imagekit/client.rbi b/rbi/imagekitio/client.rbi similarity index 74% rename from rbi/imagekit/client.rbi rename to rbi/imagekitio/client.rbi index 703786c5..53478892 100644 --- a/rbi/imagekit/client.rbi +++ b/rbi/imagekitio/client.rbi @@ -1,7 +1,7 @@ # typed: strong -module Imagekit - class Client < Imagekit::Internal::Transport::BaseClient +module Imagekitio + class Client < Imagekitio::Internal::Transport::BaseClient DEFAULT_MAX_RETRIES = 2 DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float) @@ -20,28 +20,28 @@ module Imagekit sig { returns(T.nilable(String)) } attr_reader :password - sig { returns(Imagekit::Resources::CustomMetadataFields) } + sig { returns(Imagekitio::Resources::CustomMetadataFields) } attr_reader :custom_metadata_fields - sig { returns(Imagekit::Resources::Files) } + sig { returns(Imagekitio::Resources::Files) } attr_reader :files - sig { returns(Imagekit::Resources::Assets) } + sig { returns(Imagekitio::Resources::Assets) } attr_reader :assets - sig { returns(Imagekit::Resources::Cache) } + sig { returns(Imagekitio::Resources::Cache) } attr_reader :cache - sig { returns(Imagekit::Resources::Folders) } + sig { returns(Imagekitio::Resources::Folders) } attr_reader :folders - sig { returns(Imagekit::Resources::Accounts) } + sig { returns(Imagekitio::Resources::Accounts) } attr_reader :accounts - sig { returns(Imagekit::Resources::Beta) } + sig { returns(Imagekitio::Resources::Beta) } attr_reader :beta - sig { returns(Imagekit::Resources::Webhooks) } + sig { returns(Imagekitio::Resources::Webhooks) } attr_reader :webhooks # @api private @@ -79,10 +79,10 @@ module Imagekit # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]` base_url: ENV["IMAGE_KIT_BASE_URL"], # Max number of retries to attempt after a failed retryable request. - max_retries: Imagekit::Client::DEFAULT_MAX_RETRIES, - timeout: Imagekit::Client::DEFAULT_TIMEOUT_IN_SECONDS, - initial_retry_delay: Imagekit::Client::DEFAULT_INITIAL_RETRY_DELAY, - max_retry_delay: Imagekit::Client::DEFAULT_MAX_RETRY_DELAY + max_retries: Imagekitio::Client::DEFAULT_MAX_RETRIES, + timeout: Imagekitio::Client::DEFAULT_TIMEOUT_IN_SECONDS, + initial_retry_delay: Imagekitio::Client::DEFAULT_INITIAL_RETRY_DELAY, + max_retry_delay: Imagekitio::Client::DEFAULT_MAX_RETRY_DELAY ) end end diff --git a/rbi/imagekit/errors.rbi b/rbi/imagekitio/errors.rbi similarity index 82% rename from rbi/imagekit/errors.rbi rename to rbi/imagekitio/errors.rbi index c39dffaf..b7e41111 100644 --- a/rbi/imagekit/errors.rbi +++ b/rbi/imagekitio/errors.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Errors class Error < StandardError sig { returns(T.nilable(StandardError)) } attr_accessor :cause end - class ConversionError < Imagekit::Errors::Error + class ConversionError < Imagekitio::Errors::Error sig { returns(T.nilable(StandardError)) } def cause end @@ -26,7 +26,7 @@ module Imagekit end end - class APIError < Imagekit::Errors::Error + class APIError < Imagekitio::Errors::Error sig { returns(URI::Generic) } attr_accessor :url @@ -63,7 +63,7 @@ module Imagekit end end - class APIConnectionError < Imagekit::Errors::APIError + class APIConnectionError < Imagekitio::Errors::APIError sig { returns(NilClass) } attr_accessor :status @@ -94,7 +94,7 @@ module Imagekit end end - class APITimeoutError < Imagekit::Errors::APIConnectionError + class APITimeoutError < Imagekitio::Errors::APIConnectionError # @api private sig do params( @@ -119,7 +119,7 @@ module Imagekit end end - class APIStatusError < Imagekit::Errors::APIError + class APIStatusError < Imagekitio::Errors::APIError # @api private sig do params( @@ -170,35 +170,35 @@ module Imagekit end end - class BadRequestError < Imagekit::Errors::APIStatusError + class BadRequestError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 400 end - class AuthenticationError < Imagekit::Errors::APIStatusError + class AuthenticationError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 401 end - class PermissionDeniedError < Imagekit::Errors::APIStatusError + class PermissionDeniedError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 403 end - class NotFoundError < Imagekit::Errors::APIStatusError + class NotFoundError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 404 end - class ConflictError < Imagekit::Errors::APIStatusError + class ConflictError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 409 end - class UnprocessableEntityError < Imagekit::Errors::APIStatusError + class UnprocessableEntityError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 422 end - class RateLimitError < Imagekit::Errors::APIStatusError + class RateLimitError < Imagekitio::Errors::APIStatusError HTTP_STATUS = 429 end - class InternalServerError < Imagekit::Errors::APIStatusError + class InternalServerError < Imagekitio::Errors::APIStatusError HTTP_STATUS = T.let((500..), T::Range[Integer]) end end diff --git a/rbi/imagekit/file_part.rbi b/rbi/imagekitio/file_part.rbi similarity index 97% rename from rbi/imagekit/file_part.rbi rename to rbi/imagekitio/file_part.rbi index b19ed2fb..30b6ce18 100644 --- a/rbi/imagekit/file_part.rbi +++ b/rbi/imagekitio/file_part.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio class FilePart sig { returns(T.any(Pathname, StringIO, IO, String)) } attr_reader :content diff --git a/rbi/imagekit/internal.rbi b/rbi/imagekitio/internal.rbi similarity index 62% rename from rbi/imagekit/internal.rbi rename to rbi/imagekitio/internal.rbi index a32e13ca..25d559ce 100644 --- a/rbi/imagekit/internal.rbi +++ b/rbi/imagekitio/internal.rbi @@ -1,15 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Internal - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport # Due to the current WIP status of Shapes support in Sorbet, types referencing # this alias might be refined in the future. AnyHash = T.type_alias { T::Hash[Symbol, T.anything] } FileInput = - T.type_alias { T.any(Pathname, StringIO, IO, String, Imagekit::FilePart) } + T.type_alias do + T.any(Pathname, StringIO, IO, String, Imagekitio::FilePart) + end OMIT = T.let(Object.new.freeze, T.anything) end diff --git a/rbi/imagekit/internal/transport/base_client.rbi b/rbi/imagekitio/internal/transport/base_client.rbi similarity index 82% rename from rbi/imagekit/internal/transport/base_client.rbi rename to rbi/imagekitio/internal/transport/base_client.rbi index 1c4bbe6b..445a4149 100644 --- a/rbi/imagekit/internal/transport/base_client.rbi +++ b/rbi/imagekitio/internal/transport/base_client.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Transport # @api private class BaseClient - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport abstract! @@ -44,14 +44,14 @@ module Imagekit page: T.nilable( T::Class[ - Imagekit::Internal::Type::BasePage[ - Imagekit::Internal::Type::BaseModel + Imagekitio::Internal::Type::BasePage[ + Imagekitio::Internal::Type::BaseModel ] ] ), stream: T.nilable(T::Class[T.anything]), - model: T.nilable(Imagekit::Internal::Type::Converter::Input), - options: T.nilable(Imagekit::RequestOptions::OrHash) + model: T.nilable(Imagekitio::Internal::Type::Converter::Input), + options: T.nilable(Imagekitio::RequestOptions::OrHash) } end @@ -76,7 +76,8 @@ module Imagekit # @api private sig do params( - req: Imagekit::Internal::Transport::BaseClient::RequestComponents + req: + Imagekitio::Internal::Transport::BaseClient::RequestComponents ).void end def validate!(req) @@ -94,10 +95,11 @@ module Imagekit # @api private sig do params( - request: Imagekit::Internal::Transport::BaseClient::RequestInput, + request: + Imagekitio::Internal::Transport::BaseClient::RequestInput, status: Integer, response_headers: T::Hash[String, String] - ).returns(Imagekit::Internal::Transport::BaseClient::RequestInput) + ).returns(Imagekitio::Internal::Transport::BaseClient::RequestInput) end def follow_redirect(request, status:, response_headers:) end @@ -105,7 +107,7 @@ module Imagekit # @api private sig do params( - status: T.any(Integer, Imagekit::Errors::APIConnectionError), + status: T.any(Integer, Imagekitio::Errors::APIConnectionError), stream: T.nilable(T::Enumerable[String]) ).void end @@ -135,7 +137,7 @@ module Imagekit attr_reader :idempotency_header # @api private - sig { returns(Imagekit::Internal::Transport::PooledNetRequester) } + sig { returns(Imagekitio::Internal::Transport::PooledNetRequester) } attr_reader :requester # @api private @@ -185,10 +187,11 @@ module Imagekit sig do overridable .params( - req: Imagekit::Internal::Transport::BaseClient::RequestComponents, - opts: Imagekit::Internal::AnyHash + req: + Imagekitio::Internal::Transport::BaseClient::RequestComponents, + opts: Imagekitio::Internal::AnyHash ) - .returns(Imagekit::Internal::Transport::BaseClient::RequestInput) + .returns(Imagekitio::Internal::Transport::BaseClient::RequestInput) end private def build_request(req, opts) end @@ -206,7 +209,7 @@ module Imagekit # @api private sig do params( - request: Imagekit::Internal::Transport::BaseClient::RequestInput, + request: Imagekitio::Internal::Transport::BaseClient::RequestInput, redirect_count: Integer, retry_count: Integer, send_retry_header: T::Boolean @@ -223,7 +226,7 @@ module Imagekit # Execute the request specified by `req`. This is the method that all resource # methods call into. # - # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Imagekit::Internal::Type::Unknown, options: {}) + # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Imagekitio::Internal::Type::Unknown, options: {}) sig do params( method: Symbol, @@ -258,14 +261,14 @@ module Imagekit page: T.nilable( T::Class[ - Imagekit::Internal::Type::BasePage[ - Imagekit::Internal::Type::BaseModel + Imagekitio::Internal::Type::BasePage[ + Imagekitio::Internal::Type::BaseModel ] ] ), stream: T.nilable(T::Class[T.anything]), - model: T.nilable(Imagekit::Internal::Type::Converter::Input), - options: T.nilable(Imagekit::RequestOptions::OrHash) + model: T.nilable(Imagekitio::Internal::Type::Converter::Input), + options: T.nilable(Imagekitio::RequestOptions::OrHash) ).returns(T.anything) end def request( @@ -277,7 +280,7 @@ module Imagekit unwrap: nil, page: nil, stream: nil, - model: Imagekit::Internal::Type::Unknown, + model: Imagekitio::Internal::Type::Unknown, options: {} ) end diff --git a/rbi/imagekit/internal/transport/pooled_net_requester.rbi b/rbi/imagekitio/internal/transport/pooled_net_requester.rbi similarity index 83% rename from rbi/imagekit/internal/transport/pooled_net_requester.rbi rename to rbi/imagekitio/internal/transport/pooled_net_requester.rbi index f5b90254..e0c582fd 100644 --- a/rbi/imagekit/internal/transport/pooled_net_requester.rbi +++ b/rbi/imagekitio/internal/transport/pooled_net_requester.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Transport # @api private class PooledNetRequester - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport Request = T.type_alias do @@ -39,7 +39,7 @@ module Imagekit sig do params( request: - Imagekit::Internal::Transport::PooledNetRequester::Request, + Imagekitio::Internal::Transport::PooledNetRequester::Request, blk: T.proc.params(arg0: String).void ).returns([Net::HTTPGenericRequest, T.proc.void]) end @@ -61,7 +61,8 @@ module Imagekit # @api private sig do params( - request: Imagekit::Internal::Transport::PooledNetRequester::Request + request: + Imagekitio::Internal::Transport::PooledNetRequester::Request ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) end def execute(request) @@ -70,7 +71,7 @@ module Imagekit # @api private sig { params(size: Integer).returns(T.attached_class) } def self.new( - size: Imagekit::Internal::Transport::PooledNetRequester::DEFAULT_MAX_CONNECTIONS + size: Imagekitio::Internal::Transport::PooledNetRequester::DEFAULT_MAX_CONNECTIONS ) end end diff --git a/rbi/imagekit/internal/type/array_of.rbi b/rbi/imagekitio/internal/type/array_of.rbi similarity index 71% rename from rbi/imagekit/internal/type/array_of.rbi rename to rbi/imagekitio/internal/type/array_of.rbi index 4c739d92..7930d3ca 100644 --- a/rbi/imagekit/internal/type/array_of.rbi +++ b/rbi/imagekitio/internal/type/array_of.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private # # Array of items of a given type. class ArrayOf - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport abstract! @@ -18,11 +18,11 @@ module Imagekit params( type_info: T.any( - Imagekit::Internal::AnyHash, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::AnyHash, + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ), - spec: Imagekit::Internal::AnyHash + spec: Imagekitio::Internal::AnyHash ).returns(T.attached_class) end def self.[](type_info, spec = {}) @@ -45,7 +45,7 @@ module Imagekit override .params( value: T.any(T::Array[T.anything], T.anything), - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) .returns(T.any(T::Array[T.anything], T.anything)) end @@ -57,7 +57,7 @@ module Imagekit override .params( value: T.any(T::Array[T.anything], T.anything), - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) .returns(T.any(T::Array[T.anything], T.anything)) end @@ -84,11 +84,11 @@ module Imagekit params( type_info: T.any( - Imagekit::Internal::AnyHash, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::AnyHash, + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ), - spec: Imagekit::Internal::AnyHash + spec: Imagekitio::Internal::AnyHash ).void end def initialize(type_info, spec = {}) diff --git a/rbi/imagekit/internal/type/base_model.rbi b/rbi/imagekitio/internal/type/base_model.rbi similarity index 78% rename from rbi/imagekit/internal/type/base_model.rbi rename to rbi/imagekitio/internal/type/base_model.rbi index b1ae616a..c8686a20 100644 --- a/rbi/imagekit/internal/type/base_model.rbi +++ b/rbi/imagekitio/internal/type/base_model.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type class BaseModel - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport abstract! @@ -21,8 +21,8 @@ module Imagekit OrHash = T.type_alias do T.any( - Imagekit::Internal::Type::BaseModel, - Imagekit::Internal::AnyHash + Imagekitio::Internal::Type::BaseModel, + Imagekitio::Internal::AnyHash ) end @@ -41,10 +41,12 @@ module Imagekit T::Hash[ Symbol, T.all( - Imagekit::Internal::Type::BaseModel::KnownField, + Imagekitio::Internal::Type::BaseModel::KnownField, { type_fn: - T.proc.returns(Imagekit::Internal::Type::Converter::Input) + T.proc.returns( + Imagekitio::Internal::Type::Converter::Input + ) } ) ] @@ -59,8 +61,8 @@ module Imagekit T::Hash[ Symbol, T.all( - Imagekit::Internal::Type::BaseModel::KnownField, - { type: Imagekit::Internal::Type::Converter::Input } + Imagekitio::Internal::Type::BaseModel::KnownField, + { type: Imagekitio::Internal::Type::Converter::Input } ) ] ) @@ -83,22 +85,22 @@ module Imagekit enum: T.nilable( T.proc.returns( - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::Type::Converter::Input ) ), union: T.nilable( T.proc.returns( - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::Type::Converter::Input ) ), api_name: Symbol, nil?: T::Boolean }, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ), - spec: Imagekit::Internal::AnyHash + spec: Imagekitio::Internal::AnyHash ).void end private def add_field(name_sym, required:, type_info:, spec:) @@ -110,11 +112,11 @@ module Imagekit name_sym: Symbol, type_info: T.any( - Imagekit::Internal::AnyHash, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::AnyHash, + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ), - spec: Imagekit::Internal::AnyHash + spec: Imagekitio::Internal::AnyHash ).void end def required(name_sym, type_info, spec = {}) @@ -126,11 +128,11 @@ module Imagekit name_sym: Symbol, type_info: T.any( - Imagekit::Internal::AnyHash, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::AnyHash, + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ), - spec: Imagekit::Internal::AnyHash + spec: Imagekitio::Internal::AnyHash ).void end def optional(name_sym, type_info, spec = {}) @@ -175,11 +177,11 @@ module Imagekit .params( value: T.any( - Imagekit::Internal::Type::BaseModel, + Imagekitio::Internal::Type::BaseModel, T::Hash[T.anything, T.anything], T.anything ), - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) .returns(T.any(T.attached_class, T.anything)) end @@ -191,7 +193,7 @@ module Imagekit override .params( value: T.any(T.attached_class, T.anything), - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) .returns(T.any(T::Hash[T.anything, T.anything], T.anything)) end @@ -208,9 +210,9 @@ module Imagekit # @api private sig do params( - model: Imagekit::Internal::Type::BaseModel, + model: Imagekitio::Internal::Type::BaseModel, convert: T::Boolean - ).returns(Imagekit::Internal::AnyHash) + ).returns(Imagekitio::Internal::AnyHash) end def recursively_to_h(model, convert:) end @@ -234,7 +236,7 @@ module Imagekit # # This method is not recursive. The returned value is shared by the object, so it # should not be mutated. - sig { overridable.returns(Imagekit::Internal::AnyHash) } + sig { overridable.returns(Imagekitio::Internal::AnyHash) } def to_h end @@ -246,19 +248,19 @@ module Imagekit # # This method is not recursive. The returned value is shared by the object, so it # should not be mutated. - sig { overridable.returns(Imagekit::Internal::AnyHash) } + sig { overridable.returns(Imagekitio::Internal::AnyHash) } def to_hash end # In addition to the behaviour of `#to_h`, this method will recursively call # `#to_h` on nested models. - sig { overridable.returns(Imagekit::Internal::AnyHash) } + sig { overridable.returns(Imagekitio::Internal::AnyHash) } def deep_to_h end sig do params(keys: T.nilable(T::Array[Symbol])).returns( - Imagekit::Internal::AnyHash + Imagekitio::Internal::AnyHash ) end def deconstruct_keys(keys) diff --git a/rbi/imagekit/internal/type/base_page.rbi b/rbi/imagekitio/internal/type/base_page.rbi similarity index 83% rename from rbi/imagekit/internal/type/base_page.rbi rename to rbi/imagekitio/internal/type/base_page.rbi index b720ff81..6fcae4da 100644 --- a/rbi/imagekit/internal/type/base_page.rbi +++ b/rbi/imagekitio/internal/type/base_page.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -28,8 +28,8 @@ module Imagekit # @api private sig do params( - client: Imagekit::Internal::Transport::BaseClient, - req: Imagekit::Internal::Transport::BaseClient::RequestComponents, + client: Imagekitio::Internal::Transport::BaseClient, + req: Imagekitio::Internal::Transport::BaseClient::RequestComponents, headers: T::Hash[String, String], page_data: T.anything ).void diff --git a/rbi/imagekit/internal/type/boolean.rbi b/rbi/imagekitio/internal/type/boolean.rbi similarity index 81% rename from rbi/imagekit/internal/type/boolean.rbi rename to rbi/imagekitio/internal/type/boolean.rbi index fd1f5df2..e419242a 100644 --- a/rbi/imagekit/internal/type/boolean.rbi +++ b/rbi/imagekitio/internal/type/boolean.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private # # Ruby has no Boolean class; this is something for models to refer to. class Boolean - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport abstract! @@ -28,7 +28,7 @@ module Imagekit override .params( value: T.any(T::Boolean, T.anything), - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) .returns(T.any(T::Boolean, T.anything)) end @@ -40,7 +40,7 @@ module Imagekit override .params( value: T.any(T::Boolean, T.anything), - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) .returns(T.any(T::Boolean, T.anything)) end diff --git a/rbi/imagekit/internal/type/converter.rbi b/rbi/imagekitio/internal/type/converter.rbi similarity index 77% rename from rbi/imagekit/internal/type/converter.rbi rename to rbi/imagekitio/internal/type/converter.rbi index 34341635..773dabe4 100644 --- a/rbi/imagekit/internal/type/converter.rbi +++ b/rbi/imagekitio/internal/type/converter.rbi @@ -1,15 +1,15 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private module Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport Input = T.type_alias do - T.any(Imagekit::Internal::Type::Converter, T::Class[T.anything]) + T.any(Imagekitio::Internal::Type::Converter, T::Class[T.anything]) end CoerceState = @@ -34,7 +34,7 @@ module Imagekit overridable .params( value: T.anything, - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) .returns(T.anything) end @@ -46,7 +46,7 @@ module Imagekit overridable .params( value: T.anything, - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) .returns(T.anything) end @@ -72,18 +72,18 @@ module Imagekit enum: T.nilable( T.proc.returns( - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::Type::Converter::Input ) ), union: T.nilable( T.proc.returns( - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::Type::Converter::Input ) ) }, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ) ).returns(T.proc.returns(T.anything)) end @@ -103,18 +103,18 @@ module Imagekit enum: T.nilable( T.proc.returns( - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::Type::Converter::Input ) ), union: T.nilable( T.proc.returns( - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::Type::Converter::Input ) ) }, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ), spec: T.any( @@ -126,20 +126,20 @@ module Imagekit enum: T.nilable( T.proc.returns( - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::Type::Converter::Input ) ), union: T.nilable( T.proc.returns( - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::Type::Converter::Input ) ) }, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ) - ).returns(Imagekit::Internal::AnyHash) + ).returns(Imagekitio::Internal::AnyHash) end def self.meta_info(type_info, spec) end @@ -147,7 +147,7 @@ module Imagekit # @api private sig do params(translate_names: T::Boolean).returns( - Imagekit::Internal::Type::Converter::CoerceState + Imagekitio::Internal::Type::Converter::CoerceState ) end def self.new_coerce_state(translate_names: true) @@ -166,9 +166,9 @@ module Imagekit # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode sig do params( - target: Imagekit::Internal::Type::Converter::Input, + target: Imagekitio::Internal::Type::Converter::Input, value: T.anything, - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ).returns(T.anything) end def self.coerce( @@ -190,16 +190,16 @@ module Imagekit # - `no`: the value cannot be converted to the target type. # # See implementation below for more details. - state: Imagekit::Internal::Type::Converter.new_coerce_state + state: Imagekitio::Internal::Type::Converter.new_coerce_state ) end # @api private sig do params( - target: Imagekit::Internal::Type::Converter::Input, + target: Imagekitio::Internal::Type::Converter::Input, value: T.anything, - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ).returns(T.anything) end def self.dump(target, value, state: { can_retry: true }) diff --git a/rbi/imagekit/internal/type/enum.rbi b/rbi/imagekitio/internal/type/enum.rbi similarity index 87% rename from rbi/imagekit/internal/type/enum.rbi rename to rbi/imagekitio/internal/type/enum.rbi index c7b354ff..781fd8d2 100644 --- a/rbi/imagekit/internal/type/enum.rbi +++ b/rbi/imagekitio/internal/type/enum.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private @@ -16,8 +16,8 @@ module Imagekit # We can therefore convert string values to Symbols, but can't convert other # values safely. module Enum - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport # All of the valid Symbol values for this enum. sig do @@ -48,7 +48,7 @@ module Imagekit override .params( value: T.any(String, Symbol, T.anything), - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) .returns(T.any(Symbol, T.anything)) end @@ -60,7 +60,7 @@ module Imagekit override .params( value: T.any(Symbol, T.anything), - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) .returns(T.any(Symbol, T.anything)) end diff --git a/rbi/imagekit/internal/type/file_input.rbi b/rbi/imagekitio/internal/type/file_input.rbi similarity index 82% rename from rbi/imagekit/internal/type/file_input.rbi rename to rbi/imagekitio/internal/type/file_input.rbi index 1982d8a2..13bdf4cf 100644 --- a/rbi/imagekit/internal/type/file_input.rbi +++ b/rbi/imagekitio/internal/type/file_input.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private # # Either `Pathname` or `StringIO`, or `IO`, or - # `Imagekit::Internal::Type::FileInput`. + # `Imagekitio::Internal::Type::FileInput`. # # Note: when `IO` is used, all retries are disabled, since many IO` streams are # not rewindable. class FileInput - extend Imagekit::Internal::Type::Converter + extend Imagekitio::Internal::Type::Converter abstract! @@ -29,7 +29,7 @@ module Imagekit override .params( value: T.any(StringIO, String, T.anything), - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) .returns(T.any(StringIO, T.anything)) end @@ -41,7 +41,7 @@ module Imagekit override .params( value: T.any(Pathname, StringIO, IO, String, T.anything), - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) .returns(T.any(Pathname, StringIO, IO, String, T.anything)) end diff --git a/rbi/imagekit/internal/type/hash_of.rbi b/rbi/imagekitio/internal/type/hash_of.rbi similarity index 66% rename from rbi/imagekit/internal/type/hash_of.rbi rename to rbi/imagekitio/internal/type/hash_of.rbi index 0d963136..00a7d1d0 100644 --- a/rbi/imagekit/internal/type/hash_of.rbi +++ b/rbi/imagekitio/internal/type/hash_of.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private # # Hash of items of a given type. class HashOf - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport abstract! @@ -18,11 +18,11 @@ module Imagekit params( type_info: T.any( - Imagekit::Internal::AnyHash, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::AnyHash, + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ), - spec: Imagekit::Internal::AnyHash + spec: Imagekitio::Internal::AnyHash ).returns(T.attached_class) end def self.[](type_info, spec = {}) @@ -45,9 +45,9 @@ module Imagekit override .params( value: T.any(T::Hash[T.anything, T.anything], T.anything), - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) - .returns(T.any(Imagekit::Internal::AnyHash, T.anything)) + .returns(T.any(Imagekitio::Internal::AnyHash, T.anything)) end def coerce(value, state:) end @@ -57,9 +57,9 @@ module Imagekit override .params( value: T.any(T::Hash[T.anything, T.anything], T.anything), - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) - .returns(T.any(Imagekit::Internal::AnyHash, T.anything)) + .returns(T.any(Imagekitio::Internal::AnyHash, T.anything)) end def dump(value, state:) end @@ -84,11 +84,11 @@ module Imagekit params( type_info: T.any( - Imagekit::Internal::AnyHash, - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::Type::Converter::Input + Imagekitio::Internal::AnyHash, + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::Type::Converter::Input ), - spec: Imagekit::Internal::AnyHash + spec: Imagekitio::Internal::AnyHash ).void end def initialize(type_info, spec = {}) diff --git a/rbi/imagekit/internal/type/request_parameters.rbi b/rbi/imagekitio/internal/type/request_parameters.rbi similarity index 70% rename from rbi/imagekit/internal/type/request_parameters.rbi rename to rbi/imagekitio/internal/type/request_parameters.rbi index a8f7b350..4937893f 100644 --- a/rbi/imagekit/internal/type/request_parameters.rbi +++ b/rbi/imagekitio/internal/type/request_parameters.rbi @@ -1,15 +1,15 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private module RequestParameters # Options to specify HTTP behaviour for this request. - sig { returns(Imagekit::RequestOptions) } + sig { returns(Imagekitio::RequestOptions) } attr_reader :request_options - sig { params(request_options: Imagekit::RequestOptions::OrHash).void } + sig { params(request_options: Imagekitio::RequestOptions::OrHash).void } attr_writer :request_options # @api private @@ -17,7 +17,7 @@ module Imagekit # @api private sig do params(params: T.anything).returns( - [T.anything, Imagekit::Internal::AnyHash] + [T.anything, Imagekitio::Internal::AnyHash] ) end def dump_request(params) diff --git a/rbi/imagekit/internal/type/union.rbi b/rbi/imagekitio/internal/type/union.rbi similarity index 82% rename from rbi/imagekit/internal/type/union.rbi rename to rbi/imagekitio/internal/type/union.rbi index 1fd36045..149a3325 100644 --- a/rbi/imagekit/internal/type/union.rbi +++ b/rbi/imagekitio/internal/type/union.rbi @@ -1,12 +1,12 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private module Union - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport # @api private # @@ -16,8 +16,8 @@ module Imagekit T::Array[ [ T.nilable(Symbol), - T.proc.returns(Imagekit::Internal::Type::Converter::Input), - Imagekit::Internal::AnyHash + T.proc.returns(Imagekitio::Internal::Type::Converter::Input), + Imagekitio::Internal::AnyHash ] ] ) @@ -29,7 +29,7 @@ module Imagekit sig do returns( T::Array[ - [T.nilable(Symbol), T.anything, Imagekit::Internal::AnyHash] + [T.nilable(Symbol), T.anything, Imagekitio::Internal::AnyHash] ] ) end @@ -52,13 +52,13 @@ module Imagekit key: T.any( Symbol, - Imagekit::Internal::AnyHash, + Imagekitio::Internal::AnyHash, T.proc.returns(T.anything), T.anything ), spec: T.any( - Imagekit::Internal::AnyHash, + Imagekitio::Internal::AnyHash, T.proc.returns(T.anything), T.anything ) @@ -94,7 +94,7 @@ module Imagekit override .params( value: T.anything, - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) .returns(T.anything) end @@ -106,7 +106,7 @@ module Imagekit override .params( value: T.anything, - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) .returns(T.anything) end diff --git a/rbi/imagekit/internal/type/unknown.rbi b/rbi/imagekitio/internal/type/unknown.rbi similarity index 79% rename from rbi/imagekit/internal/type/unknown.rbi rename to rbi/imagekitio/internal/type/unknown.rbi index 27d7c467..404914b3 100644 --- a/rbi/imagekit/internal/type/unknown.rbi +++ b/rbi/imagekitio/internal/type/unknown.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Internal module Type # @api private # # When we don't know what to expect for the value. class Unknown - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport abstract! @@ -28,7 +28,7 @@ module Imagekit override .params( value: T.anything, - state: Imagekit::Internal::Type::Converter::CoerceState + state: Imagekitio::Internal::Type::Converter::CoerceState ) .returns(T.anything) end @@ -40,7 +40,7 @@ module Imagekit override .params( value: T.anything, - state: Imagekit::Internal::Type::Converter::DumpState + state: Imagekitio::Internal::Type::Converter::DumpState ) .returns(T.anything) end diff --git a/rbi/imagekit/internal/util.rbi b/rbi/imagekitio/internal/util.rbi similarity index 95% rename from rbi/imagekit/internal/util.rbi rename to rbi/imagekitio/internal/util.rbi index 808c028d..9fbebf93 100644 --- a/rbi/imagekit/internal/util.rbi +++ b/rbi/imagekitio/internal/util.rbi @@ -1,10 +1,10 @@ # typed: strong -module Imagekit +module Imagekitio module Internal # @api private module Util - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport # @api private sig { returns(Float) } @@ -128,7 +128,7 @@ module Imagekit params( data: T.any( - Imagekit::Internal::AnyHash, + Imagekitio::Internal::AnyHash, T::Array[T.anything], T.anything ), @@ -198,7 +198,7 @@ module Imagekit # @api private sig do params(url: T.any(URI::Generic, String)).returns( - Imagekit::Internal::Util::ParsedUri + Imagekitio::Internal::Util::ParsedUri ) end def parse_uri(url) @@ -206,7 +206,7 @@ module Imagekit # @api private sig do - params(parsed: Imagekit::Internal::Util::ParsedUri).returns( + params(parsed: Imagekitio::Internal::Util::ParsedUri).returns( URI::Generic ) end @@ -216,8 +216,8 @@ module Imagekit # @api private sig do params( - lhs: Imagekit::Internal::Util::ParsedUri, - rhs: Imagekit::Internal::Util::ParsedUri + lhs: Imagekitio::Internal::Util::ParsedUri, + rhs: Imagekitio::Internal::Util::ParsedUri ).returns(URI::Generic) end def join_parsed_uri(lhs, rhs) @@ -430,7 +430,7 @@ module Imagekit # Assumes that `lines` has been decoded with `#decode_lines`. sig do params(lines: T::Enumerable[String]).returns( - T::Enumerable[Imagekit::Internal::Util::ServerSentEvent] + T::Enumerable[Imagekitio::Internal::Util::ServerSentEvent] ) end def decode_sse(lines) @@ -473,7 +473,7 @@ module Imagekit params( type: T.any( - Imagekit::Internal::Util::SorbetRuntimeSupport, + Imagekitio::Internal::Util::SorbetRuntimeSupport, T.anything ) ).returns(T.anything) diff --git a/rbi/imagekitio/models.rbi b/rbi/imagekitio/models.rbi new file mode 100644 index 00000000..5e425cc7 --- /dev/null +++ b/rbi/imagekitio/models.rbi @@ -0,0 +1,135 @@ +# typed: strong + +module Imagekitio + Accounts = Imagekitio::Models::Accounts + + AssetListParams = Imagekitio::Models::AssetListParams + + BaseOverlay = Imagekitio::Models::BaseOverlay + + BaseWebhookEvent = Imagekitio::Models::BaseWebhookEvent + + Beta = Imagekitio::Models::Beta + + Cache = Imagekitio::Models::Cache + + CustomMetadataField = Imagekitio::Models::CustomMetadataField + + CustomMetadataFieldCreateParams = + Imagekitio::Models::CustomMetadataFieldCreateParams + + CustomMetadataFieldDeleteParams = + Imagekitio::Models::CustomMetadataFieldDeleteParams + + CustomMetadataFieldListParams = + Imagekitio::Models::CustomMetadataFieldListParams + + CustomMetadataFieldUpdateParams = + Imagekitio::Models::CustomMetadataFieldUpdateParams + + ExtensionItem = Imagekitio::Models::ExtensionItem + + Extensions = + T.let(Imagekitio::Models::Extensions, Imagekitio::Internal::Type::Converter) + + File = Imagekitio::Models::File + + FileCopyParams = Imagekitio::Models::FileCopyParams + + FileDeleteParams = Imagekitio::Models::FileDeleteParams + + FileGetParams = Imagekitio::Models::FileGetParams + + FileMoveParams = Imagekitio::Models::FileMoveParams + + FileRenameParams = Imagekitio::Models::FileRenameParams + + Files = Imagekitio::Models::Files + + FileUpdateParams = Imagekitio::Models::FileUpdateParams + + FileUploadParams = Imagekitio::Models::FileUploadParams + + Folder = Imagekitio::Models::Folder + + FolderCopyParams = Imagekitio::Models::FolderCopyParams + + FolderCreateParams = Imagekitio::Models::FolderCreateParams + + FolderDeleteParams = Imagekitio::Models::FolderDeleteParams + + FolderMoveParams = Imagekitio::Models::FolderMoveParams + + FolderRenameParams = Imagekitio::Models::FolderRenameParams + + Folders = Imagekitio::Models::Folders + + GetImageAttributesOptions = Imagekitio::Models::GetImageAttributesOptions + + ImageOverlay = Imagekitio::Models::ImageOverlay + + Metadata = Imagekitio::Models::Metadata + + Overlay = Imagekitio::Models::Overlay + + OverlayPosition = Imagekitio::Models::OverlayPosition + + OverlayTiming = Imagekitio::Models::OverlayTiming + + ResponsiveImageAttributes = Imagekitio::Models::ResponsiveImageAttributes + + SolidColorOverlay = Imagekitio::Models::SolidColorOverlay + + SolidColorOverlayTransformation = + Imagekitio::Models::SolidColorOverlayTransformation + + SrcOptions = Imagekitio::Models::SrcOptions + + StreamingResolution = Imagekitio::Models::StreamingResolution + + SubtitleOverlay = Imagekitio::Models::SubtitleOverlay + + SubtitleOverlayTransformation = + Imagekitio::Models::SubtitleOverlayTransformation + + TextOverlay = Imagekitio::Models::TextOverlay + + TextOverlayTransformation = Imagekitio::Models::TextOverlayTransformation + + Transformation = Imagekitio::Models::Transformation + + TransformationPosition = Imagekitio::Models::TransformationPosition + + UnsafeUnwrapWebhookEvent = Imagekitio::Models::UnsafeUnwrapWebhookEvent + + UnwrapWebhookEvent = Imagekitio::Models::UnwrapWebhookEvent + + UpdateFileRequest = Imagekitio::Models::UpdateFileRequest + + UploadPostTransformErrorEvent = + Imagekitio::Models::UploadPostTransformErrorEvent + + UploadPostTransformSuccessEvent = + Imagekitio::Models::UploadPostTransformSuccessEvent + + UploadPreTransformErrorEvent = + Imagekitio::Models::UploadPreTransformErrorEvent + + UploadPreTransformSuccessEvent = + Imagekitio::Models::UploadPreTransformSuccessEvent + + VideoOverlay = Imagekitio::Models::VideoOverlay + + VideoTransformationAcceptedEvent = + Imagekitio::Models::VideoTransformationAcceptedEvent + + VideoTransformationErrorEvent = + Imagekitio::Models::VideoTransformationErrorEvent + + VideoTransformationReadyEvent = + Imagekitio::Models::VideoTransformationReadyEvent + + WebhookUnsafeUnwrapParams = Imagekitio::Models::WebhookUnsafeUnwrapParams + + WebhookUnwrapParams = Imagekitio::Models::WebhookUnwrapParams +end diff --git a/rbi/imagekitio/models/accounts/origin_create_params.rbi b/rbi/imagekitio/models/accounts/origin_create_params.rbi new file mode 100644 index 00000000..f8d241a4 --- /dev/null +++ b/rbi/imagekitio/models/accounts/origin_create_params.rbi @@ -0,0 +1,81 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class OriginCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::OriginCreateParams, + Imagekitio::Internal::AnyHash + ) + end + + # Schema for origin request resources. + sig do + returns( + T.any( + Imagekitio::Accounts::OriginRequest::S3, + Imagekitio::Accounts::OriginRequest::S3Compatible, + Imagekitio::Accounts::OriginRequest::CloudinaryBackup, + Imagekitio::Accounts::OriginRequest::WebFolder, + Imagekitio::Accounts::OriginRequest::WebProxy, + Imagekitio::Accounts::OriginRequest::Gcs, + Imagekitio::Accounts::OriginRequest::AzureBlob, + Imagekitio::Accounts::OriginRequest::AkeneoPim + ) + ) + end + attr_accessor :origin_request + + sig do + params( + origin_request: + T.any( + Imagekitio::Accounts::OriginRequest::S3::OrHash, + Imagekitio::Accounts::OriginRequest::S3Compatible::OrHash, + Imagekitio::Accounts::OriginRequest::CloudinaryBackup::OrHash, + Imagekitio::Accounts::OriginRequest::WebFolder::OrHash, + Imagekitio::Accounts::OriginRequest::WebProxy::OrHash, + Imagekitio::Accounts::OriginRequest::Gcs::OrHash, + Imagekitio::Accounts::OriginRequest::AzureBlob::OrHash, + Imagekitio::Accounts::OriginRequest::AkeneoPim::OrHash + ), + request_options: Imagekitio::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for origin request resources. + origin_request:, + request_options: {} + ) + end + + sig do + override.returns( + { + origin_request: + T.any( + Imagekitio::Accounts::OriginRequest::S3, + Imagekitio::Accounts::OriginRequest::S3Compatible, + Imagekitio::Accounts::OriginRequest::CloudinaryBackup, + Imagekitio::Accounts::OriginRequest::WebFolder, + Imagekitio::Accounts::OriginRequest::WebProxy, + Imagekitio::Accounts::OriginRequest::Gcs, + Imagekitio::Accounts::OriginRequest::AzureBlob, + Imagekitio::Accounts::OriginRequest::AkeneoPim + ), + request_options: Imagekitio::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/origin_delete_params.rbi b/rbi/imagekitio/models/accounts/origin_delete_params.rbi new file mode 100644 index 00000000..c01c6212 --- /dev/null +++ b/rbi/imagekitio/models/accounts/origin_delete_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class OriginDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::OriginDeleteParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/origin_get_params.rbi b/rbi/imagekitio/models/accounts/origin_get_params.rbi new file mode 100644 index 00000000..0e37c3b0 --- /dev/null +++ b/rbi/imagekitio/models/accounts/origin_get_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class OriginGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::OriginGetParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/origin_list_params.rbi b/rbi/imagekitio/models/accounts/origin_list_params.rbi new file mode 100644 index 00000000..0a757d4f --- /dev/null +++ b/rbi/imagekitio/models/accounts/origin_list_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class OriginListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::OriginListParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/origin_list_response.rbi b/rbi/imagekitio/models/accounts/origin_list_response.rbi new file mode 100644 index 00000000..5830b885 --- /dev/null +++ b/rbi/imagekitio/models/accounts/origin_list_response.rbi @@ -0,0 +1,15 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + OriginListResponse = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + union: Imagekitio::Accounts::OriginResponse + ], + Imagekitio::Internal::Type::Converter + ) + end + end +end diff --git a/rbi/imagekit/models/accounts/origin_request.rbi b/rbi/imagekitio/models/accounts/origin_request.rbi similarity index 91% rename from rbi/imagekit/models/accounts/origin_request.rbi rename to rbi/imagekitio/models/accounts/origin_request.rbi index 3de49704..00020cf4 100644 --- a/rbi/imagekit/models/accounts/origin_request.rbi +++ b/rbi/imagekitio/models/accounts/origin_request.rbi @@ -1,32 +1,32 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Accounts # Schema for origin request resources. module OriginRequest - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::S3, - Imagekit::Accounts::OriginRequest::S3Compatible, - Imagekit::Accounts::OriginRequest::CloudinaryBackup, - Imagekit::Accounts::OriginRequest::WebFolder, - Imagekit::Accounts::OriginRequest::WebProxy, - Imagekit::Accounts::OriginRequest::Gcs, - Imagekit::Accounts::OriginRequest::AzureBlob, - Imagekit::Accounts::OriginRequest::AkeneoPim + Imagekitio::Accounts::OriginRequest::S3, + Imagekitio::Accounts::OriginRequest::S3Compatible, + Imagekitio::Accounts::OriginRequest::CloudinaryBackup, + Imagekitio::Accounts::OriginRequest::WebFolder, + Imagekitio::Accounts::OriginRequest::WebProxy, + Imagekitio::Accounts::OriginRequest::Gcs, + Imagekitio::Accounts::OriginRequest::AzureBlob, + Imagekitio::Accounts::OriginRequest::AkeneoPim ) end - class S3 < Imagekit::Internal::Type::BaseModel + class S3 < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::S3, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginRequest::S3, + Imagekitio::Internal::AnyHash ) end @@ -119,12 +119,12 @@ module Imagekit end end - class S3Compatible < Imagekit::Internal::Type::BaseModel + class S3Compatible < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::S3Compatible, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginRequest::S3Compatible, + Imagekitio::Internal::AnyHash ) end @@ -236,12 +236,12 @@ module Imagekit end end - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + class CloudinaryBackup < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::CloudinaryBackup, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginRequest::CloudinaryBackup, + Imagekitio::Internal::AnyHash ) end @@ -334,12 +334,12 @@ module Imagekit end end - class WebFolder < Imagekit::Internal::Type::BaseModel + class WebFolder < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::WebFolder, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginRequest::WebFolder, + Imagekitio::Internal::AnyHash ) end @@ -416,12 +416,12 @@ module Imagekit end end - class WebProxy < Imagekit::Internal::Type::BaseModel + class WebProxy < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::WebProxy, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginRequest::WebProxy, + Imagekitio::Internal::AnyHash ) end @@ -479,12 +479,12 @@ module Imagekit end end - class Gcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::Gcs, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginRequest::Gcs, + Imagekitio::Internal::AnyHash ) end @@ -569,12 +569,12 @@ module Imagekit end end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::AzureBlob, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginRequest::AzureBlob, + Imagekitio::Internal::AnyHash ) end @@ -659,12 +659,12 @@ module Imagekit end end - class AkeneoPim < Imagekit::Internal::Type::BaseModel + class AkeneoPim < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginRequest::AkeneoPim, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginRequest::AkeneoPim, + Imagekitio::Internal::AnyHash ) end @@ -764,7 +764,7 @@ module Imagekit sig do override.returns( - T::Array[Imagekit::Accounts::OriginRequest::Variants] + T::Array[Imagekitio::Accounts::OriginRequest::Variants] ) end def self.variants diff --git a/rbi/imagekit/models/accounts/origin_response.rbi b/rbi/imagekitio/models/accounts/origin_response.rbi similarity index 90% rename from rbi/imagekit/models/accounts/origin_response.rbi rename to rbi/imagekitio/models/accounts/origin_response.rbi index be9fc05f..d5eb1027 100644 --- a/rbi/imagekit/models/accounts/origin_response.rbi +++ b/rbi/imagekitio/models/accounts/origin_response.rbi @@ -1,32 +1,32 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Accounts # Origin object as returned by the API (sensitive fields removed). module OriginResponse - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::S3, - Imagekit::Accounts::OriginResponse::S3Compatible, - Imagekit::Accounts::OriginResponse::CloudinaryBackup, - Imagekit::Accounts::OriginResponse::WebFolder, - Imagekit::Accounts::OriginResponse::WebProxy, - Imagekit::Accounts::OriginResponse::Gcs, - Imagekit::Accounts::OriginResponse::AzureBlob, - Imagekit::Accounts::OriginResponse::AkeneoPim + Imagekitio::Accounts::OriginResponse::S3, + Imagekitio::Accounts::OriginResponse::S3Compatible, + Imagekitio::Accounts::OriginResponse::CloudinaryBackup, + Imagekitio::Accounts::OriginResponse::WebFolder, + Imagekitio::Accounts::OriginResponse::WebProxy, + Imagekitio::Accounts::OriginResponse::Gcs, + Imagekitio::Accounts::OriginResponse::AzureBlob, + Imagekitio::Accounts::OriginResponse::AkeneoPim ) end - class S3 < Imagekit::Internal::Type::BaseModel + class S3 < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::S3, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginResponse::S3, + Imagekitio::Internal::AnyHash ) end @@ -107,12 +107,12 @@ module Imagekit end end - class S3Compatible < Imagekit::Internal::Type::BaseModel + class S3Compatible < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::S3Compatible, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginResponse::S3Compatible, + Imagekitio::Internal::AnyHash ) end @@ -209,12 +209,12 @@ module Imagekit end end - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + class CloudinaryBackup < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::CloudinaryBackup, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginResponse::CloudinaryBackup, + Imagekitio::Internal::AnyHash ) end @@ -295,12 +295,12 @@ module Imagekit end end - class WebFolder < Imagekit::Internal::Type::BaseModel + class WebFolder < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::WebFolder, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginResponse::WebFolder, + Imagekitio::Internal::AnyHash ) end @@ -381,12 +381,12 @@ module Imagekit end end - class WebProxy < Imagekit::Internal::Type::BaseModel + class WebProxy < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::WebProxy, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginResponse::WebProxy, + Imagekitio::Internal::AnyHash ) end @@ -451,12 +451,12 @@ module Imagekit end end - class Gcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::Gcs, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginResponse::Gcs, + Imagekitio::Internal::AnyHash ) end @@ -539,12 +539,12 @@ module Imagekit end end - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::AzureBlob, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginResponse::AzureBlob, + Imagekitio::Internal::AnyHash ) end @@ -627,12 +627,12 @@ module Imagekit end end - class AkeneoPim < Imagekit::Internal::Type::BaseModel + class AkeneoPim < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::OriginResponse::AkeneoPim, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::OriginResponse::AkeneoPim, + Imagekitio::Internal::AnyHash ) end @@ -707,7 +707,7 @@ module Imagekit sig do override.returns( - T::Array[Imagekit::Accounts::OriginResponse::Variants] + T::Array[Imagekitio::Accounts::OriginResponse::Variants] ) end def self.variants diff --git a/rbi/imagekitio/models/accounts/origin_update_params.rbi b/rbi/imagekitio/models/accounts/origin_update_params.rbi new file mode 100644 index 00000000..276f6e66 --- /dev/null +++ b/rbi/imagekitio/models/accounts/origin_update_params.rbi @@ -0,0 +1,81 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class OriginUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::OriginUpdateParams, + Imagekitio::Internal::AnyHash + ) + end + + # Schema for origin request resources. + sig do + returns( + T.any( + Imagekitio::Accounts::OriginRequest::S3, + Imagekitio::Accounts::OriginRequest::S3Compatible, + Imagekitio::Accounts::OriginRequest::CloudinaryBackup, + Imagekitio::Accounts::OriginRequest::WebFolder, + Imagekitio::Accounts::OriginRequest::WebProxy, + Imagekitio::Accounts::OriginRequest::Gcs, + Imagekitio::Accounts::OriginRequest::AzureBlob, + Imagekitio::Accounts::OriginRequest::AkeneoPim + ) + ) + end + attr_accessor :origin_request + + sig do + params( + origin_request: + T.any( + Imagekitio::Accounts::OriginRequest::S3::OrHash, + Imagekitio::Accounts::OriginRequest::S3Compatible::OrHash, + Imagekitio::Accounts::OriginRequest::CloudinaryBackup::OrHash, + Imagekitio::Accounts::OriginRequest::WebFolder::OrHash, + Imagekitio::Accounts::OriginRequest::WebProxy::OrHash, + Imagekitio::Accounts::OriginRequest::Gcs::OrHash, + Imagekitio::Accounts::OriginRequest::AzureBlob::OrHash, + Imagekitio::Accounts::OriginRequest::AkeneoPim::OrHash + ), + request_options: Imagekitio::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for origin request resources. + origin_request:, + request_options: {} + ) + end + + sig do + override.returns( + { + origin_request: + T.any( + Imagekitio::Accounts::OriginRequest::S3, + Imagekitio::Accounts::OriginRequest::S3Compatible, + Imagekitio::Accounts::OriginRequest::CloudinaryBackup, + Imagekitio::Accounts::OriginRequest::WebFolder, + Imagekitio::Accounts::OriginRequest::WebProxy, + Imagekitio::Accounts::OriginRequest::Gcs, + Imagekitio::Accounts::OriginRequest::AzureBlob, + Imagekitio::Accounts::OriginRequest::AkeneoPim + ), + request_options: Imagekitio::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/url_endpoint_create_params.rbi b/rbi/imagekitio/models/accounts/url_endpoint_create_params.rbi new file mode 100644 index 00000000..655546c3 --- /dev/null +++ b/rbi/imagekitio/models/accounts/url_endpoint_create_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class URLEndpointCreateParams < Imagekitio::Models::Accounts::URLEndpointRequest + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::URLEndpointCreateParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/url_endpoint_delete_params.rbi b/rbi/imagekitio/models/accounts/url_endpoint_delete_params.rbi new file mode 100644 index 00000000..2872f0b2 --- /dev/null +++ b/rbi/imagekitio/models/accounts/url_endpoint_delete_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class URLEndpointDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::URLEndpointDeleteParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/url_endpoint_get_params.rbi b/rbi/imagekitio/models/accounts/url_endpoint_get_params.rbi new file mode 100644 index 00000000..b3d65268 --- /dev/null +++ b/rbi/imagekitio/models/accounts/url_endpoint_get_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class URLEndpointGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::URLEndpointGetParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/url_endpoint_list_params.rbi b/rbi/imagekitio/models/accounts/url_endpoint_list_params.rbi new file mode 100644 index 00000000..ac51f50b --- /dev/null +++ b/rbi/imagekitio/models/accounts/url_endpoint_list_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class URLEndpointListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::URLEndpointListParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/accounts/url_endpoint_list_response.rbi b/rbi/imagekitio/models/accounts/url_endpoint_list_response.rbi new file mode 100644 index 00000000..4ffb994d --- /dev/null +++ b/rbi/imagekitio/models/accounts/url_endpoint_list_response.rbi @@ -0,0 +1,15 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + URLEndpointListResponse = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + Imagekitio::Accounts::URLEndpointResponse + ], + Imagekitio::Internal::Type::Converter + ) + end + end +end diff --git a/rbi/imagekit/models/accounts/url_endpoint_request.rbi b/rbi/imagekitio/models/accounts/url_endpoint_request.rbi similarity index 70% rename from rbi/imagekit/models/accounts/url_endpoint_request.rbi rename to rbi/imagekitio/models/accounts/url_endpoint_request.rbi index f36ad090..8e42816f 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_request.rbi +++ b/rbi/imagekitio/models/accounts/url_endpoint_request.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Accounts - class URLEndpointRequest < Imagekit::Internal::Type::BaseModel + class URLEndpointRequest < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointRequest, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::URLEndpointRequest, + Imagekitio::Internal::AnyHash ) end @@ -38,9 +38,9 @@ module Imagekit returns( T.nilable( T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai ) ) ) @@ -51,9 +51,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash ) ).void end @@ -67,9 +67,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash ) ).returns(T.attached_class) end @@ -96,9 +96,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai ) } ) @@ -108,23 +108,23 @@ module Imagekit # Configuration for third-party URL rewriting. module URLRewriter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai ) end - class Cloudinary < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, + Imagekitio::Internal::AnyHash ) end @@ -160,12 +160,12 @@ module Imagekit end end - class Imgix < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix, + Imagekitio::Internal::AnyHash ) end @@ -181,12 +181,12 @@ module Imagekit end end - class Akamai < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai, + Imagekitio::Internal::AnyHash ) end @@ -205,7 +205,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Variants + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Variants ] ) end diff --git a/rbi/imagekit/models/accounts/url_endpoint_response.rbi b/rbi/imagekitio/models/accounts/url_endpoint_response.rbi similarity index 73% rename from rbi/imagekit/models/accounts/url_endpoint_response.rbi rename to rbi/imagekitio/models/accounts/url_endpoint_response.rbi index 6600ca95..96905355 100644 --- a/rbi/imagekit/models/accounts/url_endpoint_response.rbi +++ b/rbi/imagekitio/models/accounts/url_endpoint_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Accounts - class URLEndpointResponse < Imagekit::Internal::Type::BaseModel + class URLEndpointResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointResponse, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::URLEndpointResponse, + Imagekitio::Internal::AnyHash ) end @@ -31,7 +31,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Variants + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Variants ) ) end @@ -41,9 +41,9 @@ module Imagekit params( url_rewriter: T.any( - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai::OrHash + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary::OrHash, + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix::OrHash, + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai::OrHash ) ).void end @@ -64,9 +64,9 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai::OrHash + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary::OrHash, + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix::OrHash, + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai::OrHash ) ).returns(T.attached_class) end @@ -97,7 +97,7 @@ module Imagekit origins: T::Array[String], url_prefix: String, url_rewriter: - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Variants + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Variants } ) end @@ -106,23 +106,23 @@ module Imagekit # Configuration for third-party URL rewriting. module URLRewriter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix, - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix, + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai ) end - class Cloudinary < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, + Imagekitio::Internal::AnyHash ) end @@ -155,12 +155,12 @@ module Imagekit end end - class Imgix < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix, + Imagekitio::Internal::AnyHash ) end @@ -176,12 +176,12 @@ module Imagekit end end - class Akamai < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai, + Imagekitio::Internal::AnyHash ) end @@ -200,7 +200,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Variants + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Variants ] ) end diff --git a/rbi/imagekitio/models/accounts/url_endpoint_update_params.rbi b/rbi/imagekitio/models/accounts/url_endpoint_update_params.rbi new file mode 100644 index 00000000..7e23f2d1 --- /dev/null +++ b/rbi/imagekitio/models/accounts/url_endpoint_update_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Accounts + class URLEndpointUpdateParams < Imagekitio::Models::Accounts::URLEndpointRequest + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Accounts::URLEndpointUpdateParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/accounts/usage_get_params.rbi b/rbi/imagekitio/models/accounts/usage_get_params.rbi similarity index 77% rename from rbi/imagekit/models/accounts/usage_get_params.rbi rename to rbi/imagekitio/models/accounts/usage_get_params.rbi index 271e2759..563f7451 100644 --- a/rbi/imagekit/models/accounts/usage_get_params.rbi +++ b/rbi/imagekitio/models/accounts/usage_get_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Accounts - class UsageGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class UsageGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Accounts::UsageGetParams, - Imagekit::Internal::AnyHash + Imagekitio::Accounts::UsageGetParams, + Imagekitio::Internal::AnyHash ) end @@ -29,7 +29,7 @@ module Imagekit params( end_date: Date, start_date: Date, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -48,7 +48,7 @@ module Imagekit { end_date: Date, start_date: Date, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/accounts/usage_get_response.rbi b/rbi/imagekitio/models/accounts/usage_get_response.rbi similarity index 93% rename from rbi/imagekit/models/accounts/usage_get_response.rbi rename to rbi/imagekitio/models/accounts/usage_get_response.rbi index b3af7603..8e53de30 100644 --- a/rbi/imagekit/models/accounts/usage_get_response.rbi +++ b/rbi/imagekitio/models/accounts/usage_get_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Accounts - class UsageGetResponse < Imagekit::Internal::Type::BaseModel + class UsageGetResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Accounts::UsageGetResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Accounts::UsageGetResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/asset_list_params.rbi b/rbi/imagekitio/models/asset_list_params.rbi similarity index 65% rename from rbi/imagekit/models/asset_list_params.rbi rename to rbi/imagekitio/models/asset_list_params.rbi index 6e43d77a..e194dfd4 100644 --- a/rbi/imagekit/models/asset_list_params.rbi +++ b/rbi/imagekitio/models/asset_list_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class AssetListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class AssetListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::AssetListParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::AssetListParams, Imagekitio::Internal::AnyHash) end # Filter results by file type. @@ -16,11 +16,13 @@ module Imagekit # - `all` — include all file types # - `image` — include only image files # - `non-image` — include only non-image files (e.g., JS, CSS, video) - sig { returns(T.nilable(Imagekit::AssetListParams::FileType::OrSymbol)) } + sig do + returns(T.nilable(Imagekitio::AssetListParams::FileType::OrSymbol)) + end attr_reader :file_type sig do - params(file_type: Imagekit::AssetListParams::FileType::OrSymbol).void + params(file_type: Imagekitio::AssetListParams::FileType::OrSymbol).void end attr_writer :file_type @@ -71,10 +73,10 @@ module Imagekit # Sort the results by one of the supported fields in ascending or descending # order. - sig { returns(T.nilable(Imagekit::AssetListParams::Sort::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::AssetListParams::Sort::OrSymbol)) } attr_reader :sort - sig { params(sort: Imagekit::AssetListParams::Sort::OrSymbol).void } + sig { params(sort: Imagekitio::AssetListParams::Sort::OrSymbol).void } attr_writer :sort # Filter results by asset type. @@ -83,22 +85,22 @@ module Imagekit # - `file-version` — returns specific file versions # - `folder` — returns only folders # - `all` — returns both files and folders (excludes `file-version`) - sig { returns(T.nilable(Imagekit::AssetListParams::Type::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::AssetListParams::Type::OrSymbol)) } attr_reader :type - sig { params(type: Imagekit::AssetListParams::Type::OrSymbol).void } + sig { params(type: Imagekitio::AssetListParams::Type::OrSymbol).void } attr_writer :type sig do params( - file_type: Imagekit::AssetListParams::FileType::OrSymbol, + file_type: Imagekitio::AssetListParams::FileType::OrSymbol, limit: Integer, path: String, search_query: String, skip: Integer, - sort: Imagekit::AssetListParams::Sort::OrSymbol, - type: Imagekit::AssetListParams::Type::OrSymbol, - request_options: Imagekit::RequestOptions::OrHash + sort: Imagekitio::AssetListParams::Sort::OrSymbol, + type: Imagekitio::AssetListParams::Type::OrSymbol, + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -150,14 +152,14 @@ module Imagekit sig do override.returns( { - file_type: Imagekit::AssetListParams::FileType::OrSymbol, + file_type: Imagekitio::AssetListParams::FileType::OrSymbol, limit: Integer, path: String, search_query: String, skip: Integer, - sort: Imagekit::AssetListParams::Sort::OrSymbol, - type: Imagekit::AssetListParams::Type::OrSymbol, - request_options: Imagekit::RequestOptions + sort: Imagekitio::AssetListParams::Sort::OrSymbol, + type: Imagekitio::AssetListParams::Type::OrSymbol, + request_options: Imagekitio::RequestOptions } ) end @@ -170,20 +172,24 @@ module Imagekit # - `image` — include only image files # - `non-image` — include only non-image files (e.g., JS, CSS, video) module FileType - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::AssetListParams::FileType) } + T.type_alias { T.all(Symbol, Imagekitio::AssetListParams::FileType) } OrSymbol = T.type_alias { T.any(Symbol, String) } - ALL = T.let(:all, Imagekit::AssetListParams::FileType::TaggedSymbol) - IMAGE = T.let(:image, Imagekit::AssetListParams::FileType::TaggedSymbol) + ALL = T.let(:all, Imagekitio::AssetListParams::FileType::TaggedSymbol) + IMAGE = + T.let(:image, Imagekitio::AssetListParams::FileType::TaggedSymbol) NON_IMAGE = - T.let(:"non-image", Imagekit::AssetListParams::FileType::TaggedSymbol) + T.let( + :"non-image", + Imagekitio::AssetListParams::FileType::TaggedSymbol + ) sig do override.returns( - T::Array[Imagekit::AssetListParams::FileType::TaggedSymbol] + T::Array[Imagekitio::AssetListParams::FileType::TaggedSymbol] ) end def self.values @@ -193,44 +199,47 @@ module Imagekit # Sort the results by one of the supported fields in ascending or descending # order. module Sort - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::AssetListParams::Sort) } + T.type_alias { T.all(Symbol, Imagekitio::AssetListParams::Sort) } OrSymbol = T.type_alias { T.any(Symbol, String) } ASC_NAME = - T.let(:ASC_NAME, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:ASC_NAME, Imagekitio::AssetListParams::Sort::TaggedSymbol) DESC_NAME = - T.let(:DESC_NAME, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:DESC_NAME, Imagekitio::AssetListParams::Sort::TaggedSymbol) ASC_CREATED = - T.let(:ASC_CREATED, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:ASC_CREATED, Imagekitio::AssetListParams::Sort::TaggedSymbol) DESC_CREATED = - T.let(:DESC_CREATED, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:DESC_CREATED, Imagekitio::AssetListParams::Sort::TaggedSymbol) ASC_UPDATED = - T.let(:ASC_UPDATED, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:ASC_UPDATED, Imagekitio::AssetListParams::Sort::TaggedSymbol) DESC_UPDATED = - T.let(:DESC_UPDATED, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:DESC_UPDATED, Imagekitio::AssetListParams::Sort::TaggedSymbol) ASC_HEIGHT = - T.let(:ASC_HEIGHT, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:ASC_HEIGHT, Imagekitio::AssetListParams::Sort::TaggedSymbol) DESC_HEIGHT = - T.let(:DESC_HEIGHT, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:DESC_HEIGHT, Imagekitio::AssetListParams::Sort::TaggedSymbol) ASC_WIDTH = - T.let(:ASC_WIDTH, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:ASC_WIDTH, Imagekitio::AssetListParams::Sort::TaggedSymbol) DESC_WIDTH = - T.let(:DESC_WIDTH, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:DESC_WIDTH, Imagekitio::AssetListParams::Sort::TaggedSymbol) ASC_SIZE = - T.let(:ASC_SIZE, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:ASC_SIZE, Imagekitio::AssetListParams::Sort::TaggedSymbol) DESC_SIZE = - T.let(:DESC_SIZE, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:DESC_SIZE, Imagekitio::AssetListParams::Sort::TaggedSymbol) ASC_RELEVANCE = - T.let(:ASC_RELEVANCE, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let(:ASC_RELEVANCE, Imagekitio::AssetListParams::Sort::TaggedSymbol) DESC_RELEVANCE = - T.let(:DESC_RELEVANCE, Imagekit::AssetListParams::Sort::TaggedSymbol) + T.let( + :DESC_RELEVANCE, + Imagekitio::AssetListParams::Sort::TaggedSymbol + ) sig do override.returns( - T::Array[Imagekit::AssetListParams::Sort::TaggedSymbol] + T::Array[Imagekitio::AssetListParams::Sort::TaggedSymbol] ) end def self.values @@ -244,21 +253,24 @@ module Imagekit # - `folder` — returns only folders # - `all` — returns both files and folders (excludes `file-version`) module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::AssetListParams::Type) } + T.type_alias { T.all(Symbol, Imagekitio::AssetListParams::Type) } OrSymbol = T.type_alias { T.any(Symbol, String) } - FILE = T.let(:file, Imagekit::AssetListParams::Type::TaggedSymbol) + FILE = T.let(:file, Imagekitio::AssetListParams::Type::TaggedSymbol) FILE_VERSION = - T.let(:"file-version", Imagekit::AssetListParams::Type::TaggedSymbol) - FOLDER = T.let(:folder, Imagekit::AssetListParams::Type::TaggedSymbol) - ALL = T.let(:all, Imagekit::AssetListParams::Type::TaggedSymbol) + T.let( + :"file-version", + Imagekitio::AssetListParams::Type::TaggedSymbol + ) + FOLDER = T.let(:folder, Imagekitio::AssetListParams::Type::TaggedSymbol) + ALL = T.let(:all, Imagekitio::AssetListParams::Type::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::AssetListParams::Type::TaggedSymbol] + T::Array[Imagekitio::AssetListParams::Type::TaggedSymbol] ) end def self.values diff --git a/rbi/imagekitio/models/asset_list_response.rbi b/rbi/imagekitio/models/asset_list_response.rbi new file mode 100644 index 00000000..2818b745 --- /dev/null +++ b/rbi/imagekitio/models/asset_list_response.rbi @@ -0,0 +1,28 @@ +# typed: strong + +module Imagekitio + module Models + # Object containing details of a file or file version. + module AssetListResponseItem + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(Imagekitio::Folder, Imagekitio::File) } + + sig do + override.returns( + T::Array[Imagekitio::Models::AssetListResponseItem::Variants] + ) + end + def self.variants + end + end + + AssetListResponse = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + union: Imagekitio::Models::AssetListResponseItem + ], + Imagekitio::Internal::Type::Converter + ) + end +end diff --git a/rbi/imagekitio/models/base_overlay.rbi b/rbi/imagekitio/models/base_overlay.rbi new file mode 100644 index 00000000..30cca96c --- /dev/null +++ b/rbi/imagekitio/models/base_overlay.rbi @@ -0,0 +1,44 @@ +# typed: strong + +module Imagekitio + module Models + class BaseOverlay < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekitio::BaseOverlay, Imagekitio::Internal::AnyHash) + end + + sig { returns(T.nilable(Imagekitio::OverlayPosition)) } + attr_reader :position + + sig { params(position: Imagekitio::OverlayPosition::OrHash).void } + attr_writer :position + + sig { returns(T.nilable(Imagekitio::OverlayTiming)) } + attr_reader :timing + + sig { params(timing: Imagekitio::OverlayTiming::OrHash).void } + attr_writer :timing + + sig do + params( + position: Imagekitio::OverlayPosition::OrHash, + timing: Imagekitio::OverlayTiming::OrHash + ).returns(T.attached_class) + end + def self.new(position: nil, timing: nil) + end + + sig do + override.returns( + { + position: Imagekitio::OverlayPosition, + timing: Imagekitio::OverlayTiming + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/base_webhook_event.rbi b/rbi/imagekitio/models/base_webhook_event.rbi similarity index 78% rename from rbi/imagekit/models/base_webhook_event.rbi rename to rbi/imagekitio/models/base_webhook_event.rbi index 1420720c..28ad3694 100644 --- a/rbi/imagekit/models/base_webhook_event.rbi +++ b/rbi/imagekitio/models/base_webhook_event.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class BaseWebhookEvent < Imagekit::Internal::Type::BaseModel + class BaseWebhookEvent < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::BaseWebhookEvent, Imagekit::Internal::AnyHash) + T.any(Imagekitio::BaseWebhookEvent, Imagekitio::Internal::AnyHash) end # Unique identifier for the event. diff --git a/rbi/imagekit/models/beta/v2/file_upload_params.rbi b/rbi/imagekitio/models/beta/v2/file_upload_params.rbi similarity index 81% rename from rbi/imagekit/models/beta/v2/file_upload_params.rbi rename to rbi/imagekitio/models/beta/v2/file_upload_params.rbi index 91f54bd2..cb350106 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekitio/models/beta/v2/file_upload_params.rbi @@ -1,18 +1,18 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Beta module V2 - class FileUploadParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileUploadParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams, - Imagekit::Internal::AnyHash + Imagekitio::Beta::V2::FileUploadParams, + Imagekitio::Internal::AnyHash ) end @@ -25,7 +25,7 @@ module Imagekit # # When supplying a URL, the server must receive the response headers within 8 # seconds; otherwise the request fails with 400 Bad Request. - sig { returns(Imagekit::Internal::FileInput) } + sig { returns(Imagekitio::Internal::FileInput) } attr_accessor :file # The name with which the file has to be uploaded. @@ -96,9 +96,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension + Imagekitio::ExtensionItem::RemoveBg, + Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AutoTaggingExtension ) ] ) @@ -111,9 +111,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + Imagekitio::ExtensionItem::RemoveBg::OrHash, + Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ] ).void @@ -190,7 +190,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::OrSymbol ] ) ) @@ -201,7 +201,7 @@ module Imagekit params( response_fields: T::Array[ - Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::OrSymbol ] ).void end @@ -230,7 +230,7 @@ module Imagekit # You can mix and match any combination of post-processing types. sig do returns( - T.nilable(Imagekit::Beta::V2::FileUploadParams::Transformation) + T.nilable(Imagekitio::Beta::V2::FileUploadParams::Transformation) ) end attr_reader :transformation @@ -238,7 +238,7 @@ module Imagekit sig do params( transformation: - Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash + Imagekitio::Beta::V2::FileUploadParams::Transformation::OrHash ).void end attr_writer :transformation @@ -268,7 +268,7 @@ module Imagekit sig do params( - file: Imagekit::Internal::FileInput, + file: Imagekitio::Internal::FileInput, file_name: String, token: String, checks: String, @@ -278,9 +278,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + Imagekitio::ExtensionItem::RemoveBg::OrHash, + Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], folder: String, @@ -292,14 +292,14 @@ module Imagekit overwrite_tags: T::Boolean, response_fields: T::Array[ - Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], tags: T::Array[String], transformation: - Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash, + Imagekitio::Beta::V2::FileUploadParams::Transformation::OrHash, use_unique_file_name: T::Boolean, webhook_url: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -419,7 +419,7 @@ module Imagekit sig do override.returns( { - file: Imagekit::Internal::FileInput, + file: Imagekitio::Internal::FileInput, file_name: String, token: String, checks: String, @@ -429,9 +429,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension + Imagekitio::ExtensionItem::RemoveBg, + Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AutoTaggingExtension ) ], folder: String, @@ -443,14 +443,14 @@ module Imagekit overwrite_tags: T::Boolean, response_fields: T::Array[ - Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], tags: T::Array[String], transformation: - Imagekit::Beta::V2::FileUploadParams::Transformation, + Imagekitio::Beta::V2::FileUploadParams::Transformation, use_unique_file_name: T::Boolean, webhook_url: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end @@ -458,13 +458,13 @@ module Imagekit end module ResponseField - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Beta::V2::FileUploadParams::ResponseField + Imagekitio::Beta::V2::FileUploadParams::ResponseField ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -472,48 +472,48 @@ module Imagekit TAGS = T.let( :tags, - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) CUSTOM_COORDINATES = T.let( :customCoordinates, - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) IS_PRIVATE_FILE = T.let( :isPrivateFile, - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) EMBEDDED_METADATA = T.let( :embeddedMetadata, - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) IS_PUBLISHED = T.let( :isPublished, - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) CUSTOM_METADATA = T.let( :customMetadata, - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) METADATA = T.let( :metadata, - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) SELECTED_FIELDS_SCHEMA = T.let( :selectedFieldsSchema, - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::TaggedSymbol ] ) end @@ -521,12 +521,12 @@ module Imagekit end end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::Beta::V2::FileUploadParams::Transformation, + Imagekitio::Internal::AnyHash ) end @@ -538,10 +538,10 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Transformation, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs ) ] ) @@ -554,10 +554,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::OrHash + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Transformation::OrHash, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo::OrHash, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail::OrHash, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::OrHash ) ] ).void @@ -588,10 +588,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail::OrHash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::OrHash + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Transformation::OrHash, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo::OrHash, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail::OrHash, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::OrHash ) ], pre: String @@ -614,10 +614,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Transformation, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs ) ], pre: String @@ -628,24 +628,24 @@ module Imagekit end module Post - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Transformation, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs ) end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Transformation, + Imagekitio::Internal::AnyHash ) end @@ -675,12 +675,12 @@ module Imagekit end end - class GifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, - Imagekit::Internal::AnyHash + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo, + Imagekitio::Internal::AnyHash ) end @@ -713,12 +713,12 @@ module Imagekit end end - class Thumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, - Imagekit::Internal::AnyHash + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail, + Imagekitio::Internal::AnyHash ) end @@ -751,19 +751,19 @@ module Imagekit end end - class Abs < Imagekit::Internal::Type::BaseModel + class Abs < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs, - Imagekit::Internal::AnyHash + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs, + Imagekitio::Internal::AnyHash ) end # Streaming protocol to use (`hls` or `dash`). sig do returns( - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol ) end attr_accessor :protocol @@ -779,7 +779,7 @@ module Imagekit sig do params( protocol: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, value: String, type: Symbol ).returns(T.attached_class) @@ -798,7 +798,7 @@ module Imagekit override.returns( { protocol: - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, type: Symbol, value: String } @@ -809,13 +809,13 @@ module Imagekit # Streaming protocol to use (`hls` or `dash`). module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -823,18 +823,18 @@ module Imagekit HLS = T.let( :hls, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ) DASH = T.let( :dash, - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ] ) end @@ -846,7 +846,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Variants + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Variants ] ) end diff --git a/rbi/imagekit/models/beta/v2/file_upload_response.rbi b/rbi/imagekitio/models/beta/v2/file_upload_response.rbi similarity index 77% rename from rbi/imagekit/models/beta/v2/file_upload_response.rbi rename to rbi/imagekitio/models/beta/v2/file_upload_response.rbi index f05bfcb0..2c472e76 100644 --- a/rbi/imagekit/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekitio/models/beta/v2/file_upload_response.rbi @@ -1,15 +1,15 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Beta module V2 - class FileUploadResponse < Imagekit::Internal::Type::BaseModel + class FileUploadResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Beta::V2::FileUploadResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Beta::V2::FileUploadResponse, + Imagekitio::Internal::AnyHash ) end @@ -17,7 +17,9 @@ module Imagekit sig do returns( T.nilable( - T::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag] + T::Array[ + Imagekitio::Models::Beta::V2::FileUploadResponse::AITag + ] ) ) end @@ -91,7 +93,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus ) ) end @@ -100,7 +102,7 @@ module Imagekit sig do params( extension_status: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::OrHash + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::OrHash ).void end attr_writer :extension_status @@ -155,10 +157,10 @@ module Imagekit # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. - sig { returns(T.nilable(Imagekit::Metadata)) } + sig { returns(T.nilable(Imagekitio::Metadata)) } attr_reader :metadata - sig { params(metadata: Imagekit::Metadata::OrHash).void } + sig { params(metadata: Imagekitio::Metadata::OrHash).void } attr_writer :metadata # Name of the asset. @@ -180,7 +182,7 @@ module Imagekit T.nilable( T::Hash[ Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema ] ) ) @@ -192,7 +194,7 @@ module Imagekit selected_fields_schema: T::Hash[ Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::OrHash + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::OrHash ] ).void end @@ -229,7 +231,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo + Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo ) ) end @@ -238,7 +240,7 @@ module Imagekit sig do params( version_info: - Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo::OrHash + Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo::OrHash ).void end attr_writer :version_info @@ -263,7 +265,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::AITag::OrHash + Imagekitio::Models::Beta::V2::FileUploadResponse::AITag::OrHash ] ), audio_codec: String, @@ -274,26 +276,26 @@ module Imagekit duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::OrHash, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::OrHash, file_id: String, file_path: String, file_type: String, height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: Imagekit::Metadata::OrHash, + metadata: Imagekitio::Metadata::OrHash, name: String, selected_fields_schema: T::Hash[ Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::OrHash + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::OrHash ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, url: String, version_info: - Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo::OrHash, + Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo::OrHash, video_codec: String, width: Float ).returns(T.attached_class) @@ -391,7 +393,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::AITag + Imagekitio::Models::Beta::V2::FileUploadResponse::AITag ] ), audio_codec: String, @@ -402,26 +404,26 @@ module Imagekit duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus, file_id: String, file_path: String, file_type: String, height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: Imagekit::Metadata, + metadata: Imagekitio::Metadata, name: String, selected_fields_schema: T::Hash[ Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, url: String, version_info: - Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, + Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo, video_codec: String, width: Float } @@ -430,12 +432,12 @@ module Imagekit def to_hash end - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::AITag, - Imagekit::Internal::AnyHash + Imagekitio::Models::Beta::V2::FileUploadResponse::AITag, + Imagekitio::Internal::AnyHash ) end @@ -488,19 +490,19 @@ module Imagekit end end - class ExtensionStatus < Imagekit::Internal::Type::BaseModel + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, - Imagekit::Internal::AnyHash + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + Imagekitio::Internal::AnyHash ) end sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) ) end @@ -509,7 +511,7 @@ module Imagekit sig do params( ai_auto_description: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol ).void end attr_writer :ai_auto_description @@ -517,7 +519,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) ) end @@ -526,7 +528,7 @@ module Imagekit sig do params( aws_auto_tagging: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol ).void end attr_writer :aws_auto_tagging @@ -534,7 +536,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) ) end @@ -543,7 +545,7 @@ module Imagekit sig do params( google_auto_tagging: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol ).void end attr_writer :google_auto_tagging @@ -551,7 +553,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) ) end @@ -560,7 +562,7 @@ module Imagekit sig do params( remove_bg: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol ).void end attr_writer :remove_bg @@ -577,13 +579,13 @@ module Imagekit sig do params( ai_auto_description: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol, aws_auto_tagging: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, remove_bg: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol ).returns(T.attached_class) end def self.new( @@ -598,13 +600,13 @@ module Imagekit override.returns( { ai_auto_description: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, aws_auto_tagging: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, remove_bg: - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol } ) end @@ -612,13 +614,13 @@ module Imagekit end module AIAutoDescription - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -626,23 +628,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ] ) end @@ -651,13 +653,13 @@ module Imagekit end module AwsAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -665,23 +667,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ] ) end @@ -690,13 +692,13 @@ module Imagekit end module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -704,23 +706,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ] ) end @@ -729,13 +731,13 @@ module Imagekit end module RemoveBg - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -743,23 +745,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ] ) end @@ -768,19 +770,19 @@ module Imagekit end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema, - Imagekit::Internal::AnyHash + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema, + Imagekitio::Internal::AnyHash ) end # Type of the custom metadata field. sig do returns( - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) end attr_accessor :type @@ -790,7 +792,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants ) ) end @@ -799,7 +801,7 @@ module Imagekit sig do params( default_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants ).void end attr_writer :default_value @@ -824,7 +826,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants ) ) end @@ -833,7 +835,7 @@ module Imagekit sig do params( max_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants ).void end attr_writer :max_value @@ -851,7 +853,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants ) ) end @@ -860,7 +862,7 @@ module Imagekit sig do params( min_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants ).void end attr_writer :min_value @@ -879,7 +881,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ] ) ) @@ -890,7 +892,7 @@ module Imagekit params( select_options: T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ] ).void end @@ -907,20 +909,20 @@ module Imagekit sig do params( type: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::OrSymbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::OrSymbol, default_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, read_only: T::Boolean, select_options: T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ], select_options_truncated: T::Boolean ).returns(T.attached_class) @@ -961,20 +963,20 @@ module Imagekit override.returns( { type: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol, default_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, read_only: T::Boolean, select_options: T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ], select_options_truncated: T::Boolean } @@ -985,13 +987,13 @@ module Imagekit # Type of the custom metadata field. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -999,43 +1001,43 @@ module Imagekit TEXT = T.let( :Text, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) TEXTAREA = T.let( :Textarea, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) NUMBER = T.let( :Number, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) DATE = T.let( :Date, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) BOOLEAN = T.let( :Boolean, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) SINGLE_SELECT = T.let( :SingleSelect, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) MULTI_SELECT = T.let( :MultiSelect, - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ] ) end @@ -1046,7 +1048,7 @@ module Imagekit # The default value for this custom metadata field. The value should match the # `type` of custom metadata field. module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do @@ -1055,20 +1057,20 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants ] ) end module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants ] ) end @@ -1079,7 +1081,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants ] ) end @@ -1088,11 +1090,11 @@ module Imagekit MixedArray = T.let( - Imagekit::Internal::Type::ArrayOf[ + Imagekitio::Internal::Type::ArrayOf[ union: - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed ], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::Converter ) end @@ -1100,14 +1102,14 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants ] ) end @@ -1119,14 +1121,14 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants ] ) end @@ -1135,14 +1137,14 @@ module Imagekit end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ] ) end @@ -1151,12 +1153,12 @@ module Imagekit end end - class VersionInfo < Imagekit::Internal::Type::BaseModel + class VersionInfo < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, - Imagekit::Internal::AnyHash + Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/cache/invalidation_create_params.rbi b/rbi/imagekitio/models/cache/invalidation_create_params.rbi similarity index 57% rename from rbi/imagekit/models/cache/invalidation_create_params.rbi rename to rbi/imagekitio/models/cache/invalidation_create_params.rbi index bafcab6b..abf72f7c 100644 --- a/rbi/imagekit/models/cache/invalidation_create_params.rbi +++ b/rbi/imagekitio/models/cache/invalidation_create_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Cache - class InvalidationCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class InvalidationCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Cache::InvalidationCreateParams, - Imagekit::Internal::AnyHash + Imagekitio::Cache::InvalidationCreateParams, + Imagekitio::Internal::AnyHash ) end @@ -22,7 +22,7 @@ module Imagekit sig do params( url: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -34,7 +34,7 @@ module Imagekit sig do override.returns( - { url: String, request_options: Imagekit::RequestOptions } + { url: String, request_options: Imagekitio::RequestOptions } ) end def to_hash diff --git a/rbi/imagekit/models/cache/invalidation_create_response.rbi b/rbi/imagekitio/models/cache/invalidation_create_response.rbi similarity index 79% rename from rbi/imagekit/models/cache/invalidation_create_response.rbi rename to rbi/imagekitio/models/cache/invalidation_create_response.rbi index 2d6123a7..f6129934 100644 --- a/rbi/imagekit/models/cache/invalidation_create_response.rbi +++ b/rbi/imagekitio/models/cache/invalidation_create_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Cache - class InvalidationCreateResponse < Imagekit::Internal::Type::BaseModel + class InvalidationCreateResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Cache::InvalidationCreateResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Cache::InvalidationCreateResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekitio/models/cache/invalidation_get_params.rbi b/rbi/imagekitio/models/cache/invalidation_get_params.rbi new file mode 100644 index 00000000..991b116e --- /dev/null +++ b/rbi/imagekitio/models/cache/invalidation_get_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Cache + class InvalidationGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Cache::InvalidationGetParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/cache/invalidation_get_response.rbi b/rbi/imagekitio/models/cache/invalidation_get_response.rbi similarity index 61% rename from rbi/imagekit/models/cache/invalidation_get_response.rbi rename to rbi/imagekitio/models/cache/invalidation_get_response.rbi index c26651ef..171a2a7e 100644 --- a/rbi/imagekit/models/cache/invalidation_get_response.rbi +++ b/rbi/imagekitio/models/cache/invalidation_get_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Cache - class InvalidationGetResponse < Imagekit::Internal::Type::BaseModel + class InvalidationGetResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Cache::InvalidationGetResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Cache::InvalidationGetResponse, + Imagekitio::Internal::AnyHash ) end @@ -16,7 +16,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol + Imagekitio::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol ) ) end @@ -25,7 +25,7 @@ module Imagekit sig do params( status: - Imagekit::Models::Cache::InvalidationGetResponse::Status::OrSymbol + Imagekitio::Models::Cache::InvalidationGetResponse::Status::OrSymbol ).void end attr_writer :status @@ -33,7 +33,7 @@ module Imagekit sig do params( status: - Imagekit::Models::Cache::InvalidationGetResponse::Status::OrSymbol + Imagekitio::Models::Cache::InvalidationGetResponse::Status::OrSymbol ).returns(T.attached_class) end def self.new( @@ -46,7 +46,7 @@ module Imagekit override.returns( { status: - Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol + Imagekitio::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol } ) end @@ -55,13 +55,13 @@ module Imagekit # Status of the purge request. module Status - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::Cache::InvalidationGetResponse::Status + Imagekitio::Models::Cache::InvalidationGetResponse::Status ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -69,18 +69,18 @@ module Imagekit PENDING = T.let( :Pending, - Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol + Imagekitio::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol ) COMPLETED = T.let( :Completed, - Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol + Imagekitio::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol + Imagekitio::Models::Cache::InvalidationGetResponse::Status::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/custom_metadata_field.rbi b/rbi/imagekitio/models/custom_metadata_field.rbi similarity index 72% rename from rbi/imagekit/models/custom_metadata_field.rbi rename to rbi/imagekitio/models/custom_metadata_field.rbi index 10854816..d727d437 100644 --- a/rbi/imagekit/models/custom_metadata_field.rbi +++ b/rbi/imagekitio/models/custom_metadata_field.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class CustomMetadataField < Imagekit::Internal::Type::BaseModel + class CustomMetadataField < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::CustomMetadataField, Imagekit::Internal::AnyHash) + T.any(Imagekitio::CustomMetadataField, Imagekitio::Internal::AnyHash) end # Unique identifier for the custom metadata field. Use this to update the field. @@ -24,10 +24,12 @@ module Imagekit attr_accessor :name # An object that describes the rules for the custom metadata field value. - sig { returns(Imagekit::CustomMetadataField::Schema) } + sig { returns(Imagekitio::CustomMetadataField::Schema) } attr_reader :schema - sig { params(schema: Imagekit::CustomMetadataField::Schema::OrHash).void } + sig do + params(schema: Imagekitio::CustomMetadataField::Schema::OrHash).void + end attr_writer :schema # Object containing details of a custom metadata field. @@ -36,7 +38,7 @@ module Imagekit id: String, label: String, name: String, - schema: Imagekit::CustomMetadataField::Schema::OrHash + schema: Imagekitio::CustomMetadataField::Schema::OrHash ).returns(T.attached_class) end def self.new( @@ -60,25 +62,25 @@ module Imagekit id: String, label: String, name: String, - schema: Imagekit::CustomMetadataField::Schema + schema: Imagekitio::CustomMetadataField::Schema } ) end def to_hash end - class Schema < Imagekit::Internal::Type::BaseModel + class Schema < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::CustomMetadataField::Schema, - Imagekit::Internal::AnyHash + Imagekitio::CustomMetadataField::Schema, + Imagekitio::Internal::AnyHash ) end # Type of the custom metadata field. sig do - returns(Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol) + returns(Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol) end attr_accessor :type @@ -87,7 +89,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::CustomMetadataField::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataField::Schema::DefaultValue::Variants ) ) end @@ -96,7 +98,7 @@ module Imagekit sig do params( default_value: - Imagekit::CustomMetadataField::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataField::Schema::DefaultValue::Variants ).void end attr_writer :default_value @@ -120,14 +122,17 @@ module Imagekit # field, it will be a numeric value. sig do returns( - T.nilable(Imagekit::CustomMetadataField::Schema::MaxValue::Variants) + T.nilable( + Imagekitio::CustomMetadataField::Schema::MaxValue::Variants + ) ) end attr_reader :max_value sig do params( - max_value: Imagekit::CustomMetadataField::Schema::MaxValue::Variants + max_value: + Imagekitio::CustomMetadataField::Schema::MaxValue::Variants ).void end attr_writer :max_value @@ -144,14 +149,17 @@ module Imagekit # field, it will be a numeric value. sig do returns( - T.nilable(Imagekit::CustomMetadataField::Schema::MinValue::Variants) + T.nilable( + Imagekitio::CustomMetadataField::Schema::MinValue::Variants + ) ) end attr_reader :min_value sig do params( - min_value: Imagekit::CustomMetadataField::Schema::MinValue::Variants + min_value: + Imagekitio::CustomMetadataField::Schema::MinValue::Variants ).void end attr_writer :min_value @@ -161,7 +169,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::CustomMetadataField::Schema::SelectOption::Variants + Imagekitio::CustomMetadataField::Schema::SelectOption::Variants ] ) ) @@ -172,7 +180,7 @@ module Imagekit params( select_options: T::Array[ - Imagekit::CustomMetadataField::Schema::SelectOption::Variants + Imagekitio::CustomMetadataField::Schema::SelectOption::Variants ] ).void end @@ -181,19 +189,19 @@ module Imagekit # An object that describes the rules for the custom metadata field value. sig do params( - type: Imagekit::CustomMetadataField::Schema::Type::OrSymbol, + type: Imagekitio::CustomMetadataField::Schema::Type::OrSymbol, default_value: - Imagekit::CustomMetadataField::Schema::DefaultValue::Variants, + Imagekitio::CustomMetadataField::Schema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::CustomMetadataField::Schema::MaxValue::Variants, + Imagekitio::CustomMetadataField::Schema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::CustomMetadataField::Schema::MinValue::Variants, + Imagekitio::CustomMetadataField::Schema::MinValue::Variants, select_options: T::Array[ - Imagekit::CustomMetadataField::Schema::SelectOption::Variants + Imagekitio::CustomMetadataField::Schema::SelectOption::Variants ] ).returns(T.attached_class) end @@ -225,19 +233,19 @@ module Imagekit sig do override.returns( { - type: Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol, + type: Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol, default_value: - Imagekit::CustomMetadataField::Schema::DefaultValue::Variants, + Imagekitio::CustomMetadataField::Schema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::CustomMetadataField::Schema::MaxValue::Variants, + Imagekitio::CustomMetadataField::Schema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::CustomMetadataField::Schema::MinValue::Variants, + Imagekitio::CustomMetadataField::Schema::MinValue::Variants, select_options: T::Array[ - Imagekit::CustomMetadataField::Schema::SelectOption::Variants + Imagekitio::CustomMetadataField::Schema::SelectOption::Variants ] } ) @@ -247,54 +255,54 @@ module Imagekit # Type of the custom metadata field. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::CustomMetadataField::Schema::Type) + T.all(Symbol, Imagekitio::CustomMetadataField::Schema::Type) end OrSymbol = T.type_alias { T.any(Symbol, String) } TEXT = T.let( :Text, - Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol ) TEXTAREA = T.let( :Textarea, - Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol ) NUMBER = T.let( :Number, - Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol ) DATE = T.let( :Date, - Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol ) BOOLEAN = T.let( :Boolean, - Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol ) SINGLE_SELECT = T.let( :SingleSelect, - Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol ) MULTI_SELECT = T.let( :MultiSelect, - Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::CustomMetadataField::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataField::Schema::Type::TaggedSymbol ] ) end @@ -305,7 +313,7 @@ module Imagekit # The default value for this custom metadata field. Data type of default value # depends on the field type. module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do @@ -314,20 +322,20 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::CustomMetadataField::Schema::DefaultValue::Mixed::Variants + Imagekitio::CustomMetadataField::Schema::DefaultValue::Mixed::Variants ] ) end module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataField::Schema::DefaultValue::Mixed::Variants + Imagekitio::CustomMetadataField::Schema::DefaultValue::Mixed::Variants ] ) end @@ -338,7 +346,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataField::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataField::Schema::DefaultValue::Variants ] ) end @@ -347,11 +355,11 @@ module Imagekit MixedArray = T.let( - Imagekit::Internal::Type::ArrayOf[ + Imagekitio::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataField::Schema::DefaultValue::Mixed + Imagekitio::CustomMetadataField::Schema::DefaultValue::Mixed ], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::Converter ) end @@ -359,14 +367,14 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataField::Schema::MaxValue::Variants + Imagekitio::CustomMetadataField::Schema::MaxValue::Variants ] ) end @@ -378,14 +386,14 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataField::Schema::MinValue::Variants + Imagekitio::CustomMetadataField::Schema::MinValue::Variants ] ) end @@ -394,14 +402,14 @@ module Imagekit end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataField::Schema::SelectOption::Variants + Imagekitio::CustomMetadataField::Schema::SelectOption::Variants ] ) end diff --git a/rbi/imagekit/models/custom_metadata_field_create_params.rbi b/rbi/imagekitio/models/custom_metadata_field_create_params.rbi similarity index 71% rename from rbi/imagekit/models/custom_metadata_field_create_params.rbi rename to rbi/imagekitio/models/custom_metadata_field_create_params.rbi index 78abcceb..a6622776 100644 --- a/rbi/imagekit/models/custom_metadata_field_create_params.rbi +++ b/rbi/imagekitio/models/custom_metadata_field_create_params.rbi @@ -1,16 +1,16 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class CustomMetadataFieldCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class CustomMetadataFieldCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::CustomMetadataFieldCreateParams, - Imagekit::Internal::AnyHash + Imagekitio::CustomMetadataFieldCreateParams, + Imagekitio::Internal::AnyHash ) end @@ -26,12 +26,12 @@ module Imagekit sig { returns(String) } attr_accessor :name - sig { returns(Imagekit::CustomMetadataFieldCreateParams::Schema) } + sig { returns(Imagekitio::CustomMetadataFieldCreateParams::Schema) } attr_reader :schema sig do params( - schema: Imagekit::CustomMetadataFieldCreateParams::Schema::OrHash + schema: Imagekitio::CustomMetadataFieldCreateParams::Schema::OrHash ).void end attr_writer :schema @@ -40,8 +40,8 @@ module Imagekit params( label: String, name: String, - schema: Imagekit::CustomMetadataFieldCreateParams::Schema::OrHash, - request_options: Imagekit::RequestOptions::OrHash + schema: Imagekitio::CustomMetadataFieldCreateParams::Schema::OrHash, + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -63,27 +63,27 @@ module Imagekit { label: String, name: String, - schema: Imagekit::CustomMetadataFieldCreateParams::Schema, - request_options: Imagekit::RequestOptions + schema: Imagekitio::CustomMetadataFieldCreateParams::Schema, + request_options: Imagekitio::RequestOptions } ) end def to_hash end - class Schema < Imagekit::Internal::Type::BaseModel + class Schema < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::CustomMetadataFieldCreateParams::Schema, - Imagekit::Internal::AnyHash + Imagekitio::CustomMetadataFieldCreateParams::Schema, + Imagekitio::Internal::AnyHash ) end # Type of the custom metadata field. sig do returns( - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol ) end attr_accessor :type @@ -94,7 +94,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants ) ) end @@ -103,7 +103,7 @@ module Imagekit sig do params( default_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants ).void end attr_writer :default_value @@ -131,7 +131,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants ) ) end @@ -140,7 +140,7 @@ module Imagekit sig do params( max_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants ).void end attr_writer :max_value @@ -159,7 +159,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::MinValue::Variants ) ) end @@ -168,7 +168,7 @@ module Imagekit sig do params( min_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::MinValue::Variants ).void end attr_writer :min_value @@ -179,7 +179,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants ] ) ) @@ -190,7 +190,7 @@ module Imagekit params( select_options: T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants ] ).void end @@ -199,19 +199,19 @@ module Imagekit sig do params( type: - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol, + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol, default_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants, + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants, + Imagekitio::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants, + Imagekitio::CustomMetadataFieldCreateParams::Schema::MinValue::Variants, select_options: T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants ] ).returns(T.attached_class) end @@ -250,19 +250,19 @@ module Imagekit override.returns( { type: - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol, + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::OrSymbol, default_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants, + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants, + Imagekitio::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants, + Imagekitio::CustomMetadataFieldCreateParams::Schema::MinValue::Variants, select_options: T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants ] } ) @@ -272,13 +272,13 @@ module Imagekit # Type of the custom metadata field. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::CustomMetadataFieldCreateParams::Schema::Type + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -286,43 +286,43 @@ module Imagekit TEXT = T.let( :Text, - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) TEXTAREA = T.let( :Textarea, - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) NUMBER = T.let( :Number, - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) DATE = T.let( :Date, - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) BOOLEAN = T.let( :Boolean, - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) SINGLE_SELECT = T.let( :SingleSelect, - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) MULTI_SELECT = T.let( :MultiSelect, - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol + Imagekitio::CustomMetadataFieldCreateParams::Schema::Type::TaggedSymbol ] ) end @@ -334,7 +334,7 @@ module Imagekit # if `isValueRequired` property is set to `true`. The value should match the # `type` of custom metadata field. module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do @@ -343,20 +343,20 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed::Variants ] ) end module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed::Variants ] ) end @@ -367,7 +367,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Variants ] ) end @@ -376,11 +376,11 @@ module Imagekit MixedArray = T.let( - Imagekit::Internal::Type::ArrayOf[ + Imagekitio::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed + Imagekitio::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed ], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::Converter ) end @@ -388,14 +388,14 @@ module Imagekit # `Number`. For `Date` type field, set the minimum date in ISO8601 string format. # For `Number` type field, set the minimum numeric value. module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::MaxValue::Variants ] ) end @@ -407,14 +407,14 @@ module Imagekit # `Number`. For `Date` type field, set the minimum date in ISO8601 string format. # For `Number` type field, set the minimum numeric value. module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::MinValue::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::MinValue::Variants ] ) end @@ -423,14 +423,14 @@ module Imagekit end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldCreateParams::Schema::SelectOption::Variants ] ) end diff --git a/rbi/imagekitio/models/custom_metadata_field_delete_params.rbi b/rbi/imagekitio/models/custom_metadata_field_delete_params.rbi new file mode 100644 index 00000000..219ec6a4 --- /dev/null +++ b/rbi/imagekitio/models/custom_metadata_field_delete_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Imagekitio + module Models + class CustomMetadataFieldDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::CustomMetadataFieldDeleteParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekitio::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/custom_metadata_field_delete_response.rbi b/rbi/imagekitio/models/custom_metadata_field_delete_response.rbi new file mode 100644 index 00000000..d8474e8c --- /dev/null +++ b/rbi/imagekitio/models/custom_metadata_field_delete_response.rbi @@ -0,0 +1,23 @@ +# typed: strong + +module Imagekitio + module Models + class CustomMetadataFieldDeleteResponse < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::Models::CustomMetadataFieldDeleteResponse, + Imagekitio::Internal::AnyHash + ) + end + + sig { returns(T.attached_class) } + def self.new + end + + sig { override.returns({}) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_list_params.rbi b/rbi/imagekitio/models/custom_metadata_field_list_params.rbi similarity index 78% rename from rbi/imagekit/models/custom_metadata_field_list_params.rbi rename to rbi/imagekitio/models/custom_metadata_field_list_params.rbi index b4c95edf..a0a8d01f 100644 --- a/rbi/imagekit/models/custom_metadata_field_list_params.rbi +++ b/rbi/imagekitio/models/custom_metadata_field_list_params.rbi @@ -1,16 +1,16 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class CustomMetadataFieldListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::CustomMetadataFieldListParams, - Imagekit::Internal::AnyHash + Imagekitio::CustomMetadataFieldListParams, + Imagekitio::Internal::AnyHash ) end @@ -35,7 +35,7 @@ module Imagekit params( folder_path: String, include_deleted: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -55,7 +55,7 @@ module Imagekit { folder_path: String, include_deleted: T::Boolean, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekitio/models/custom_metadata_field_list_response.rbi b/rbi/imagekitio/models/custom_metadata_field_list_response.rbi new file mode 100644 index 00000000..9b831657 --- /dev/null +++ b/rbi/imagekitio/models/custom_metadata_field_list_response.rbi @@ -0,0 +1,11 @@ +# typed: strong + +module Imagekitio + module Models + CustomMetadataFieldListResponse = + T.let( + Imagekitio::Internal::Type::ArrayOf[Imagekitio::CustomMetadataField], + Imagekitio::Internal::Type::Converter + ) + end +end diff --git a/rbi/imagekit/models/custom_metadata_field_update_params.rbi b/rbi/imagekitio/models/custom_metadata_field_update_params.rbi similarity index 75% rename from rbi/imagekit/models/custom_metadata_field_update_params.rbi rename to rbi/imagekitio/models/custom_metadata_field_update_params.rbi index d94d36f6..62e96b2e 100644 --- a/rbi/imagekit/models/custom_metadata_field_update_params.rbi +++ b/rbi/imagekitio/models/custom_metadata_field_update_params.rbi @@ -1,16 +1,16 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class CustomMetadataFieldUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class CustomMetadataFieldUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::CustomMetadataFieldUpdateParams, - Imagekit::Internal::AnyHash + Imagekitio::CustomMetadataFieldUpdateParams, + Imagekitio::Internal::AnyHash ) end @@ -29,13 +29,13 @@ module Imagekit # be ignored if sent with the `schema`. The schema will be validated as per the # existing `type`. sig do - returns(T.nilable(Imagekit::CustomMetadataFieldUpdateParams::Schema)) + returns(T.nilable(Imagekitio::CustomMetadataFieldUpdateParams::Schema)) end attr_reader :schema sig do params( - schema: Imagekit::CustomMetadataFieldUpdateParams::Schema::OrHash + schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash ).void end attr_writer :schema @@ -43,8 +43,8 @@ module Imagekit sig do params( label: String, - schema: Imagekit::CustomMetadataFieldUpdateParams::Schema::OrHash, - request_options: Imagekit::RequestOptions::OrHash + schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash, + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -66,20 +66,20 @@ module Imagekit override.returns( { label: String, - schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, - request_options: Imagekit::RequestOptions + schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema, + request_options: Imagekitio::RequestOptions } ) end def to_hash end - class Schema < Imagekit::Internal::Type::BaseModel + class Schema < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::CustomMetadataFieldUpdateParams::Schema, - Imagekit::Internal::AnyHash + Imagekitio::CustomMetadataFieldUpdateParams::Schema, + Imagekitio::Internal::AnyHash ) end @@ -89,7 +89,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants ) ) end @@ -98,7 +98,7 @@ module Imagekit sig do params( default_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants ).void end attr_writer :default_value @@ -126,7 +126,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants ) ) end @@ -135,7 +135,7 @@ module Imagekit sig do params( max_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants ).void end attr_writer :max_value @@ -154,7 +154,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants ) ) end @@ -163,7 +163,7 @@ module Imagekit sig do params( min_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants ).void end attr_writer :min_value @@ -174,7 +174,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants ] ) ) @@ -185,7 +185,7 @@ module Imagekit params( select_options: T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants ] ).void end @@ -198,17 +198,17 @@ module Imagekit sig do params( default_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants, + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants, + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants, + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants, select_options: T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants ] ).returns(T.attached_class) end @@ -245,17 +245,17 @@ module Imagekit override.returns( { default_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants, + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants, + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants, + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants, select_options: T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants ] } ) @@ -267,7 +267,7 @@ module Imagekit # if `isValueRequired` property is set to `true`. The value should match the # `type` of custom metadata field. module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do @@ -276,20 +276,20 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed::Variants ] ) end module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed::Variants ] ) end @@ -300,7 +300,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants ] ) end @@ -309,11 +309,11 @@ module Imagekit MixedArray = T.let( - Imagekit::Internal::Type::ArrayOf[ + Imagekitio::Internal::Type::ArrayOf[ union: - Imagekit::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed + Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed ], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::Converter ) end @@ -321,14 +321,14 @@ module Imagekit # `Number`. For `Date` type field, set the minimum date in ISO8601 string format. # For `Number` type field, set the minimum numeric value. module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants ] ) end @@ -340,14 +340,14 @@ module Imagekit # `Number`. For `Date` type field, set the minimum date in ISO8601 string format. # For `Number` type field, set the minimum numeric value. module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants ] ) end @@ -356,14 +356,14 @@ module Imagekit end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants + Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants ] ) end diff --git a/rbi/imagekit/models/extensions.rbi b/rbi/imagekitio/models/extensions.rbi similarity index 74% rename from rbi/imagekit/models/extensions.rbi rename to rbi/imagekitio/models/extensions.rbi index 46f00ece..e93e473b 100644 --- a/rbi/imagekit/models/extensions.rbi +++ b/rbi/imagekitio/models/extensions.rbi @@ -1,25 +1,25 @@ # typed: strong -module Imagekit +module Imagekitio module Models module ExtensionItem - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension + Imagekitio::ExtensionItem::RemoveBg, + Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AutoTaggingExtension ) end - class RemoveBg < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::Internal::AnyHash + Imagekitio::ExtensionItem::RemoveBg, + Imagekitio::Internal::AnyHash ) end @@ -27,19 +27,19 @@ module Imagekit sig { returns(Symbol) } attr_accessor :name - sig { returns(T.nilable(Imagekit::ExtensionItem::RemoveBg::Options)) } + sig { returns(T.nilable(Imagekitio::ExtensionItem::RemoveBg::Options)) } attr_reader :options sig do params( - options: Imagekit::ExtensionItem::RemoveBg::Options::OrHash + options: Imagekitio::ExtensionItem::RemoveBg::Options::OrHash ).void end attr_writer :options sig do params( - options: Imagekit::ExtensionItem::RemoveBg::Options::OrHash, + options: Imagekitio::ExtensionItem::RemoveBg::Options::OrHash, name: Symbol ).returns(T.attached_class) end @@ -54,19 +54,19 @@ module Imagekit override.returns( { name: Symbol, - options: Imagekit::ExtensionItem::RemoveBg::Options + options: Imagekitio::ExtensionItem::RemoveBg::Options } ) end def to_hash end - class Options < Imagekit::Internal::Type::BaseModel + class Options < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::ExtensionItem::RemoveBg::Options, - Imagekit::Internal::AnyHash + Imagekitio::ExtensionItem::RemoveBg::Options, + Imagekitio::Internal::AnyHash ) end @@ -143,12 +143,12 @@ module Imagekit end end - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + class AutoTaggingExtension < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::ExtensionItem::AutoTaggingExtension, - Imagekit::Internal::AnyHash + Imagekitio::ExtensionItem::AutoTaggingExtension, + Imagekitio::Internal::AnyHash ) end @@ -162,7 +162,9 @@ module Imagekit # Specifies the auto-tagging extension used. sig do - returns(Imagekit::ExtensionItem::AutoTaggingExtension::Name::OrSymbol) + returns( + Imagekitio::ExtensionItem::AutoTaggingExtension::Name::OrSymbol + ) end attr_accessor :name @@ -170,7 +172,8 @@ module Imagekit params( max_tags: Integer, min_confidence: Integer, - name: Imagekit::ExtensionItem::AutoTaggingExtension::Name::OrSymbol + name: + Imagekitio::ExtensionItem::AutoTaggingExtension::Name::OrSymbol ).returns(T.attached_class) end def self.new( @@ -189,7 +192,7 @@ module Imagekit max_tags: Integer, min_confidence: Integer, name: - Imagekit::ExtensionItem::AutoTaggingExtension::Name::OrSymbol + Imagekitio::ExtensionItem::AutoTaggingExtension::Name::OrSymbol } ) end @@ -198,29 +201,32 @@ module Imagekit # Specifies the auto-tagging extension used. module Name - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::ExtensionItem::AutoTaggingExtension::Name) + T.all( + Symbol, + Imagekitio::ExtensionItem::AutoTaggingExtension::Name + ) end OrSymbol = T.type_alias { T.any(Symbol, String) } GOOGLE_AUTO_TAGGING = T.let( :"google-auto-tagging", - Imagekit::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol + Imagekitio::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol ) AWS_AUTO_TAGGING = T.let( :"aws-auto-tagging", - Imagekit::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol + Imagekitio::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol + Imagekitio::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol ] ) end @@ -229,12 +235,12 @@ module Imagekit end end - class AIAutoDescription < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::Internal::AnyHash + Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::Internal::AnyHash ) end @@ -254,15 +260,15 @@ module Imagekit end end - sig { override.returns(T::Array[Imagekit::ExtensionItem::Variants]) } + sig { override.returns(T::Array[Imagekitio::ExtensionItem::Variants]) } def self.variants end end Extensions = T.let( - Imagekit::Internal::Type::ArrayOf[union: Imagekit::ExtensionItem], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem], + Imagekitio::Internal::Type::Converter ) end end diff --git a/rbi/imagekit/models/file.rbi b/rbi/imagekitio/models/file.rbi similarity index 79% rename from rbi/imagekit/models/file.rbi rename to rbi/imagekitio/models/file.rbi index febf4c75..bc7304c4 100644 --- a/rbi/imagekit/models/file.rbi +++ b/rbi/imagekitio/models/file.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class File < Imagekit::Internal::Type::BaseModel + class File < Imagekitio::Internal::Type::BaseModel OrHash = - T.type_alias { T.any(Imagekit::File, Imagekit::Internal::AnyHash) } + T.type_alias { T.any(Imagekitio::File, Imagekitio::Internal::AnyHash) } # An array of tags assigned to the file by auto tagging. - sig { returns(T.nilable(T::Array[Imagekit::File::AITag])) } + sig { returns(T.nilable(T::Array[Imagekitio::File::AITag])) } attr_accessor :ai_tags # Date and time when the file was uploaded. The date and time is in ISO8601 @@ -112,7 +112,7 @@ module Imagekit # about the custom metadata schema. sig do returns( - T.nilable(T::Hash[Symbol, Imagekit::File::SelectedFieldsSchema]) + T.nilable(T::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema]) ) end attr_reader :selected_fields_schema @@ -120,7 +120,7 @@ module Imagekit sig do params( selected_fields_schema: - T::Hash[Symbol, Imagekit::File::SelectedFieldsSchema::OrHash] + T::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema::OrHash] ).void end attr_writer :selected_fields_schema @@ -146,10 +146,10 @@ module Imagekit attr_writer :thumbnail # Type of the asset. - sig { returns(T.nilable(Imagekit::File::Type::TaggedSymbol)) } + sig { returns(T.nilable(Imagekitio::File::Type::TaggedSymbol)) } attr_reader :type - sig { params(type: Imagekit::File::Type::OrSymbol).void } + sig { params(type: Imagekitio::File::Type::OrSymbol).void } attr_writer :type # Date and time when the file was last updated. The date and time is in ISO8601 @@ -168,10 +168,10 @@ module Imagekit attr_writer :url # An object with details of the file version. - sig { returns(T.nilable(Imagekit::File::VersionInfo)) } + sig { returns(T.nilable(Imagekitio::File::VersionInfo)) } attr_reader :version_info - sig { params(version_info: Imagekit::File::VersionInfo::OrHash).void } + sig { params(version_info: Imagekitio::File::VersionInfo::OrHash).void } attr_writer :version_info # Width of the file. @@ -184,7 +184,7 @@ module Imagekit # Object containing details of a file or file version. sig do params( - ai_tags: T.nilable(T::Array[Imagekit::File::AITag::OrHash]), + ai_tags: T.nilable(T::Array[Imagekitio::File::AITag::OrHash]), created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], @@ -199,14 +199,14 @@ module Imagekit mime: String, name: String, selected_fields_schema: - T::Hash[Symbol, Imagekit::File::SelectedFieldsSchema::OrHash], + T::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema::OrHash], size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: Imagekit::File::Type::OrSymbol, + type: Imagekitio::File::Type::OrSymbol, updated_at: Time, url: String, - version_info: Imagekit::File::VersionInfo::OrHash, + version_info: Imagekitio::File::VersionInfo::OrHash, width: Float ).returns(T.attached_class) end @@ -277,7 +277,7 @@ module Imagekit sig do override.returns( { - ai_tags: T.nilable(T::Array[Imagekit::File::AITag]), + ai_tags: T.nilable(T::Array[Imagekitio::File::AITag]), created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], @@ -292,14 +292,14 @@ module Imagekit mime: String, name: String, selected_fields_schema: - T::Hash[Symbol, Imagekit::File::SelectedFieldsSchema], + T::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema], size: Float, tags: T.nilable(T::Array[String]), thumbnail: String, - type: Imagekit::File::Type::TaggedSymbol, + type: Imagekitio::File::Type::TaggedSymbol, updated_at: Time, url: String, - version_info: Imagekit::File::VersionInfo, + version_info: Imagekitio::File::VersionInfo, width: Float } ) @@ -307,10 +307,10 @@ module Imagekit def to_hash end - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::File::AITag, Imagekit::Internal::AnyHash) + T.any(Imagekitio::File::AITag, Imagekitio::Internal::AnyHash) end # Confidence score of the tag. @@ -358,18 +358,18 @@ module Imagekit end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::File::SelectedFieldsSchema, - Imagekit::Internal::AnyHash + Imagekitio::File::SelectedFieldsSchema, + Imagekitio::Internal::AnyHash ) end # Type of the custom metadata field. sig do - returns(Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol) + returns(Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol) end attr_accessor :type @@ -378,7 +378,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Variants ) ) end @@ -387,7 +387,7 @@ module Imagekit sig do params( default_value: - Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Variants ).void end attr_writer :default_value @@ -411,14 +411,17 @@ module Imagekit # field, it will be a numeric value. sig do returns( - T.nilable(Imagekit::File::SelectedFieldsSchema::MaxValue::Variants) + T.nilable( + Imagekitio::File::SelectedFieldsSchema::MaxValue::Variants + ) ) end attr_reader :max_value sig do params( - max_value: Imagekit::File::SelectedFieldsSchema::MaxValue::Variants + max_value: + Imagekitio::File::SelectedFieldsSchema::MaxValue::Variants ).void end attr_writer :max_value @@ -435,14 +438,17 @@ module Imagekit # field, it will be a numeric value. sig do returns( - T.nilable(Imagekit::File::SelectedFieldsSchema::MinValue::Variants) + T.nilable( + Imagekitio::File::SelectedFieldsSchema::MinValue::Variants + ) ) end attr_reader :min_value sig do params( - min_value: Imagekit::File::SelectedFieldsSchema::MinValue::Variants + min_value: + Imagekitio::File::SelectedFieldsSchema::MinValue::Variants ).void end attr_writer :min_value @@ -461,7 +467,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::File::SelectedFieldsSchema::SelectOption::Variants ] ) ) @@ -472,7 +478,7 @@ module Imagekit params( select_options: T::Array[ - Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::File::SelectedFieldsSchema::SelectOption::Variants ] ).void end @@ -488,18 +494,20 @@ module Imagekit sig do params( - type: Imagekit::File::SelectedFieldsSchema::Type::OrSymbol, + type: Imagekitio::File::SelectedFieldsSchema::Type::OrSymbol, default_value: - Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants, + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, - max_value: Imagekit::File::SelectedFieldsSchema::MaxValue::Variants, + max_value: + Imagekitio::File::SelectedFieldsSchema::MaxValue::Variants, min_length: Float, - min_value: Imagekit::File::SelectedFieldsSchema::MinValue::Variants, + min_value: + Imagekitio::File::SelectedFieldsSchema::MinValue::Variants, read_only: T::Boolean, select_options: T::Array[ - Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::File::SelectedFieldsSchema::SelectOption::Variants ], select_options_truncated: T::Boolean ).returns(T.attached_class) @@ -539,20 +547,20 @@ module Imagekit sig do override.returns( { - type: Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol, + type: Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol, default_value: - Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants, + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::File::SelectedFieldsSchema::MaxValue::Variants, + Imagekitio::File::SelectedFieldsSchema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::File::SelectedFieldsSchema::MinValue::Variants, + Imagekitio::File::SelectedFieldsSchema::MinValue::Variants, read_only: T::Boolean, select_options: T::Array[ - Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::File::SelectedFieldsSchema::SelectOption::Variants ], select_options_truncated: T::Boolean } @@ -563,53 +571,55 @@ module Imagekit # Type of the custom metadata field. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::File::SelectedFieldsSchema::Type) + T.all(Symbol, Imagekitio::File::SelectedFieldsSchema::Type) end OrSymbol = T.type_alias { T.any(Symbol, String) } TEXT = T.let( :Text, - Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol ) TEXTAREA = T.let( :Textarea, - Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol ) NUMBER = T.let( :Number, - Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol ) DATE = T.let( :Date, - Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol ) BOOLEAN = T.let( :Boolean, - Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol ) SINGLE_SELECT = T.let( :SingleSelect, - Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol ) MULTI_SELECT = T.let( :MultiSelect, - Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol ) sig do override.returns( - T::Array[Imagekit::File::SelectedFieldsSchema::Type::TaggedSymbol] + T::Array[ + Imagekitio::File::SelectedFieldsSchema::Type::TaggedSymbol + ] ) end def self.values @@ -619,7 +629,7 @@ module Imagekit # The default value for this custom metadata field. The value should match the # `type` of custom metadata field. module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do @@ -628,20 +638,20 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::File::SelectedFieldsSchema::DefaultValue::Mixed::Variants + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Mixed::Variants ] ) end module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::File::SelectedFieldsSchema::DefaultValue::Mixed::Variants + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Mixed::Variants ] ) end @@ -652,7 +662,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::File::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Variants ] ) end @@ -661,10 +671,11 @@ module Imagekit MixedArray = T.let( - Imagekit::Internal::Type::ArrayOf[ - union: Imagekit::File::SelectedFieldsSchema::DefaultValue::Mixed + Imagekitio::Internal::Type::ArrayOf[ + union: + Imagekitio::File::SelectedFieldsSchema::DefaultValue::Mixed ], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::Converter ) end @@ -672,13 +683,15 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( - T::Array[Imagekit::File::SelectedFieldsSchema::MaxValue::Variants] + T::Array[ + Imagekitio::File::SelectedFieldsSchema::MaxValue::Variants + ] ) end def self.variants @@ -689,13 +702,15 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( - T::Array[Imagekit::File::SelectedFieldsSchema::MinValue::Variants] + T::Array[ + Imagekitio::File::SelectedFieldsSchema::MinValue::Variants + ] ) end def self.variants @@ -703,14 +718,14 @@ module Imagekit end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::File::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::File::SelectedFieldsSchema::SelectOption::Variants ] ) end @@ -721,24 +736,24 @@ module Imagekit # Type of the asset. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, Imagekit::File::Type) } + TaggedSymbol = T.type_alias { T.all(Symbol, Imagekitio::File::Type) } OrSymbol = T.type_alias { T.any(Symbol, String) } - FILE = T.let(:file, Imagekit::File::Type::TaggedSymbol) + FILE = T.let(:file, Imagekitio::File::Type::TaggedSymbol) FILE_VERSION = - T.let(:"file-version", Imagekit::File::Type::TaggedSymbol) + T.let(:"file-version", Imagekitio::File::Type::TaggedSymbol) - sig { override.returns(T::Array[Imagekit::File::Type::TaggedSymbol]) } + sig { override.returns(T::Array[Imagekitio::File::Type::TaggedSymbol]) } def self.values end end - class VersionInfo < Imagekit::Internal::Type::BaseModel + class VersionInfo < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::File::VersionInfo, Imagekit::Internal::AnyHash) + T.any(Imagekitio::File::VersionInfo, Imagekitio::Internal::AnyHash) end # Unique identifier of the file version. diff --git a/rbi/imagekit/models/file_copy_params.rbi b/rbi/imagekitio/models/file_copy_params.rbi similarity index 80% rename from rbi/imagekit/models/file_copy_params.rbi rename to rbi/imagekitio/models/file_copy_params.rbi index 61987f96..a8abbf1a 100644 --- a/rbi/imagekit/models/file_copy_params.rbi +++ b/rbi/imagekitio/models/file_copy_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FileCopyParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileCopyParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FileCopyParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FileCopyParams, Imagekitio::Internal::AnyHash) end # Full path to the folder you want to copy the above file into. @@ -33,7 +33,7 @@ module Imagekit destination_path: String, source_file_path: String, include_file_versions: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -55,7 +55,7 @@ module Imagekit destination_path: String, source_file_path: String, include_file_versions: T::Boolean, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/folder_create_response.rbi b/rbi/imagekitio/models/file_copy_response.rbi similarity index 59% rename from rbi/imagekit/models/folder_create_response.rbi rename to rbi/imagekitio/models/file_copy_response.rbi index f3d143f9..a1f560f1 100644 --- a/rbi/imagekit/models/folder_create_response.rbi +++ b/rbi/imagekitio/models/file_copy_response.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderCreateResponse < Imagekit::Internal::Type::BaseModel + class FileCopyResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FolderCreateResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileCopyResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekitio/models/file_delete_params.rbi b/rbi/imagekitio/models/file_delete_params.rbi new file mode 100644 index 00000000..529474d9 --- /dev/null +++ b/rbi/imagekitio/models/file_delete_params.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekitio + module Models + class FileDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekitio::FileDeleteParams, Imagekitio::Internal::AnyHash) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekitio::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/file_get_params.rbi b/rbi/imagekitio/models/file_get_params.rbi new file mode 100644 index 00000000..0e0425c5 --- /dev/null +++ b/rbi/imagekitio/models/file_get_params.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekitio + module Models + class FileGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekitio::FileGetParams, Imagekitio::Internal::AnyHash) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekitio::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_move_params.rbi b/rbi/imagekitio/models/file_move_params.rbi similarity index 69% rename from rbi/imagekit/models/file_move_params.rbi rename to rbi/imagekitio/models/file_move_params.rbi index eed54bf2..6ebb66f0 100644 --- a/rbi/imagekit/models/file_move_params.rbi +++ b/rbi/imagekitio/models/file_move_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FileMoveParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileMoveParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FileMoveParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FileMoveParams, Imagekitio::Internal::AnyHash) end # Full path to the folder you want to move the above file into. @@ -23,7 +23,7 @@ module Imagekit params( destination_path: String, source_file_path: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -40,7 +40,7 @@ module Imagekit { destination_path: String, source_file_path: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/folder_delete_response.rbi b/rbi/imagekitio/models/file_move_response.rbi similarity index 59% rename from rbi/imagekit/models/folder_delete_response.rbi rename to rbi/imagekitio/models/file_move_response.rbi index 74f9d60b..9a62f027 100644 --- a/rbi/imagekit/models/folder_delete_response.rbi +++ b/rbi/imagekitio/models/file_move_response.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderDeleteResponse < Imagekit::Internal::Type::BaseModel + class FileMoveResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FolderDeleteResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileMoveResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/file_rename_params.rbi b/rbi/imagekitio/models/file_rename_params.rbi similarity index 89% rename from rbi/imagekit/models/file_rename_params.rbi rename to rbi/imagekitio/models/file_rename_params.rbi index a69d0af0..b460cd72 100644 --- a/rbi/imagekit/models/file_rename_params.rbi +++ b/rbi/imagekitio/models/file_rename_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FileRenameParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileRenameParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FileRenameParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FileRenameParams, Imagekitio::Internal::AnyHash) end # The full path of the file you want to rename. @@ -51,7 +51,7 @@ module Imagekit file_path: String, new_file_name: String, purge_cache: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -91,7 +91,7 @@ module Imagekit file_path: String, new_file_name: String, purge_cache: T::Boolean, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/file_rename_response.rbi b/rbi/imagekitio/models/file_rename_response.rbi similarity index 80% rename from rbi/imagekit/models/file_rename_response.rbi rename to rbi/imagekitio/models/file_rename_response.rbi index 2140d23b..ec001111 100644 --- a/rbi/imagekit/models/file_rename_response.rbi +++ b/rbi/imagekitio/models/file_rename_response.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FileRenameResponse < Imagekit::Internal::Type::BaseModel + class FileRenameResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FileRenameResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileRenameResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekitio/models/file_update_params.rbi b/rbi/imagekitio/models/file_update_params.rbi new file mode 100644 index 00000000..c0d1a69c --- /dev/null +++ b/rbi/imagekitio/models/file_update_params.rbi @@ -0,0 +1,58 @@ +# typed: strong + +module Imagekitio + module Models + class FileUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekitio::FileUpdateParams, Imagekitio::Internal::AnyHash) + end + + # Schema for update file update request. + sig do + returns( + T.any( + Imagekitio::UpdateFileRequest::UpdateFileDetails, + Imagekitio::UpdateFileRequest::ChangePublicationStatus + ) + ) + end + attr_accessor :update_file_request + + sig do + params( + update_file_request: + T.any( + Imagekitio::UpdateFileRequest::UpdateFileDetails::OrHash, + Imagekitio::UpdateFileRequest::ChangePublicationStatus::OrHash + ), + request_options: Imagekitio::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Schema for update file update request. + update_file_request:, + request_options: {} + ) + end + + sig do + override.returns( + { + update_file_request: + T.any( + Imagekitio::UpdateFileRequest::UpdateFileDetails, + Imagekitio::UpdateFileRequest::ChangePublicationStatus + ), + request_options: Imagekitio::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekit/models/file_update_response.rbi b/rbi/imagekitio/models/file_update_response.rbi similarity index 54% rename from rbi/imagekit/models/file_update_response.rbi rename to rbi/imagekitio/models/file_update_response.rbi index 92dba923..3db28abe 100644 --- a/rbi/imagekit/models/file_update_response.rbi +++ b/rbi/imagekitio/models/file_update_response.rbi @@ -1,19 +1,19 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FileUpdateResponse < Imagekit::Models::File + class FileUpdateResponse < Imagekitio::Models::File OrHash = T.type_alias do T.any( - Imagekit::Models::FileUpdateResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileUpdateResponse, + Imagekitio::Internal::AnyHash ) end sig do returns( - T.nilable(Imagekit::Models::FileUpdateResponse::ExtensionStatus) + T.nilable(Imagekitio::Models::FileUpdateResponse::ExtensionStatus) ) end attr_reader :extension_status @@ -21,7 +21,7 @@ module Imagekit sig do params( extension_status: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::OrHash + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::OrHash ).void end attr_writer :extension_status @@ -30,7 +30,7 @@ module Imagekit sig do params( extension_status: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::OrHash + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::OrHash ).returns(T.attached_class) end def self.new(extension_status: nil) @@ -40,26 +40,26 @@ module Imagekit override.returns( { extension_status: - Imagekit::Models::FileUpdateResponse::ExtensionStatus + Imagekitio::Models::FileUpdateResponse::ExtensionStatus } ) end def to_hash end - class ExtensionStatus < Imagekit::Internal::Type::BaseModel + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FileUpdateResponse::ExtensionStatus, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileUpdateResponse::ExtensionStatus, + Imagekitio::Internal::AnyHash ) end sig do returns( T.nilable( - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) ) end @@ -68,7 +68,7 @@ module Imagekit sig do params( ai_auto_description: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::OrSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::OrSymbol ).void end attr_writer :ai_auto_description @@ -76,7 +76,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) ) end @@ -85,7 +85,7 @@ module Imagekit sig do params( aws_auto_tagging: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol ).void end attr_writer :aws_auto_tagging @@ -93,7 +93,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) ) end @@ -102,7 +102,7 @@ module Imagekit sig do params( google_auto_tagging: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol ).void end attr_writer :google_auto_tagging @@ -110,7 +110,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) ) end @@ -119,7 +119,7 @@ module Imagekit sig do params( remove_bg: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol ).void end attr_writer :remove_bg @@ -127,13 +127,13 @@ module Imagekit sig do params( ai_auto_description: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::OrSymbol, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::OrSymbol, aws_auto_tagging: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, remove_bg: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::OrSymbol ).returns(T.attached_class) end def self.new( @@ -148,13 +148,13 @@ module Imagekit override.returns( { ai_auto_description: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, aws_auto_tagging: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, remove_bg: - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol } ) end @@ -162,13 +162,13 @@ module Imagekit end module AIAutoDescription - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -176,23 +176,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ] ) end @@ -201,13 +201,13 @@ module Imagekit end module AwsAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -215,23 +215,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ] ) end @@ -240,13 +240,13 @@ module Imagekit end module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -254,23 +254,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ] ) end @@ -279,13 +279,13 @@ module Imagekit end module RemoveBg - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -293,23 +293,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/file_upload_params.rbi b/rbi/imagekitio/models/file_upload_params.rbi similarity index 82% rename from rbi/imagekit/models/file_upload_params.rbi rename to rbi/imagekitio/models/file_upload_params.rbi index 6d987762..064e4c37 100644 --- a/rbi/imagekit/models/file_upload_params.rbi +++ b/rbi/imagekitio/models/file_upload_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FileUploadParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileUploadParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FileUploadParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FileUploadParams, Imagekitio::Internal::AnyHash) end # The API accepts any of the following: @@ -20,7 +20,7 @@ module Imagekit # # When supplying a URL, the server must receive the response headers within 8 # seconds; otherwise the request fails with 400 Bad Request. - sig { returns(Imagekit::Internal::FileInput) } + sig { returns(Imagekitio::Internal::FileInput) } attr_accessor :file # The name with which the file has to be uploaded. The file name can contain: @@ -101,9 +101,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension + Imagekitio::ExtensionItem::RemoveBg, + Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AutoTaggingExtension ) ] ) @@ -116,9 +116,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + Imagekitio::ExtensionItem::RemoveBg::OrHash, + Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ] ).void @@ -208,7 +208,7 @@ module Imagekit sig do returns( T.nilable( - T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol] + T::Array[Imagekitio::FileUploadParams::ResponseField::OrSymbol] ) ) end @@ -217,7 +217,7 @@ module Imagekit sig do params( response_fields: - T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol] + T::Array[Imagekitio::FileUploadParams::ResponseField::OrSymbol] ).void end attr_writer :response_fields @@ -255,12 +255,12 @@ module Imagekit # in advance, so they're ready for delivery without delay. # # You can mix and match any combination of post-processing types. - sig { returns(T.nilable(Imagekit::FileUploadParams::Transformation)) } + sig { returns(T.nilable(Imagekitio::FileUploadParams::Transformation)) } attr_reader :transformation sig do params( - transformation: Imagekit::FileUploadParams::Transformation::OrHash + transformation: Imagekitio::FileUploadParams::Transformation::OrHash ).void end attr_writer :transformation @@ -290,7 +290,7 @@ module Imagekit sig do params( - file: Imagekit::Internal::FileInput, + file: Imagekitio::Internal::FileInput, file_name: String, token: String, checks: String, @@ -301,9 +301,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + Imagekitio::ExtensionItem::RemoveBg::OrHash, + Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], folder: String, @@ -315,13 +315,13 @@ module Imagekit overwrite_tags: T::Boolean, public_key: String, response_fields: - T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], + T::Array[Imagekitio::FileUploadParams::ResponseField::OrSymbol], signature: String, tags: T::Array[String], - transformation: Imagekit::FileUploadParams::Transformation::OrHash, + transformation: Imagekitio::FileUploadParams::Transformation::OrHash, use_unique_file_name: T::Boolean, webhook_url: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -462,7 +462,7 @@ module Imagekit sig do override.returns( { - file: Imagekit::Internal::FileInput, + file: Imagekitio::Internal::FileInput, file_name: String, token: String, checks: String, @@ -473,9 +473,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension + Imagekitio::ExtensionItem::RemoveBg, + Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AutoTaggingExtension ) ], folder: String, @@ -487,13 +487,13 @@ module Imagekit overwrite_tags: T::Boolean, public_key: String, response_fields: - T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], + T::Array[Imagekitio::FileUploadParams::ResponseField::OrSymbol], signature: String, tags: T::Array[String], - transformation: Imagekit::FileUploadParams::Transformation, + transformation: Imagekitio::FileUploadParams::Transformation, use_unique_file_name: T::Boolean, webhook_url: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end @@ -501,67 +501,70 @@ module Imagekit end module ResponseField - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::FileUploadParams::ResponseField) + T.all(Symbol, Imagekitio::FileUploadParams::ResponseField) end OrSymbol = T.type_alias { T.any(Symbol, String) } TAGS = - T.let(:tags, Imagekit::FileUploadParams::ResponseField::TaggedSymbol) + T.let( + :tags, + Imagekitio::FileUploadParams::ResponseField::TaggedSymbol + ) CUSTOM_COORDINATES = T.let( :customCoordinates, - Imagekit::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::FileUploadParams::ResponseField::TaggedSymbol ) IS_PRIVATE_FILE = T.let( :isPrivateFile, - Imagekit::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::FileUploadParams::ResponseField::TaggedSymbol ) EMBEDDED_METADATA = T.let( :embeddedMetadata, - Imagekit::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::FileUploadParams::ResponseField::TaggedSymbol ) IS_PUBLISHED = T.let( :isPublished, - Imagekit::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::FileUploadParams::ResponseField::TaggedSymbol ) CUSTOM_METADATA = T.let( :customMetadata, - Imagekit::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::FileUploadParams::ResponseField::TaggedSymbol ) METADATA = T.let( :metadata, - Imagekit::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::FileUploadParams::ResponseField::TaggedSymbol ) SELECTED_FIELDS_SCHEMA = T.let( :selectedFieldsSchema, - Imagekit::FileUploadParams::ResponseField::TaggedSymbol + Imagekitio::FileUploadParams::ResponseField::TaggedSymbol ) sig do override.returns( - T::Array[Imagekit::FileUploadParams::ResponseField::TaggedSymbol] + T::Array[Imagekitio::FileUploadParams::ResponseField::TaggedSymbol] ) end def self.values end end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::FileUploadParams::Transformation, + Imagekitio::Internal::AnyHash ) end @@ -573,10 +576,10 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::FileUploadParams::Transformation::Post::Transformation, - Imagekit::FileUploadParams::Transformation::Post::GifToVideo, - Imagekit::FileUploadParams::Transformation::Post::Thumbnail, - Imagekit::FileUploadParams::Transformation::Post::Abs + Imagekitio::FileUploadParams::Transformation::Post::Transformation, + Imagekitio::FileUploadParams::Transformation::Post::GifToVideo, + Imagekitio::FileUploadParams::Transformation::Post::Thumbnail, + Imagekitio::FileUploadParams::Transformation::Post::Abs ) ] ) @@ -589,10 +592,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::FileUploadParams::Transformation::Post::Transformation::OrHash, - Imagekit::FileUploadParams::Transformation::Post::GifToVideo::OrHash, - Imagekit::FileUploadParams::Transformation::Post::Thumbnail::OrHash, - Imagekit::FileUploadParams::Transformation::Post::Abs::OrHash + Imagekitio::FileUploadParams::Transformation::Post::Transformation::OrHash, + Imagekitio::FileUploadParams::Transformation::Post::GifToVideo::OrHash, + Imagekitio::FileUploadParams::Transformation::Post::Thumbnail::OrHash, + Imagekitio::FileUploadParams::Transformation::Post::Abs::OrHash ) ] ).void @@ -623,10 +626,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::FileUploadParams::Transformation::Post::Transformation::OrHash, - Imagekit::FileUploadParams::Transformation::Post::GifToVideo::OrHash, - Imagekit::FileUploadParams::Transformation::Post::Thumbnail::OrHash, - Imagekit::FileUploadParams::Transformation::Post::Abs::OrHash + Imagekitio::FileUploadParams::Transformation::Post::Transformation::OrHash, + Imagekitio::FileUploadParams::Transformation::Post::GifToVideo::OrHash, + Imagekitio::FileUploadParams::Transformation::Post::Thumbnail::OrHash, + Imagekitio::FileUploadParams::Transformation::Post::Abs::OrHash ) ], pre: String @@ -649,10 +652,10 @@ module Imagekit post: T::Array[ T.any( - Imagekit::FileUploadParams::Transformation::Post::Transformation, - Imagekit::FileUploadParams::Transformation::Post::GifToVideo, - Imagekit::FileUploadParams::Transformation::Post::Thumbnail, - Imagekit::FileUploadParams::Transformation::Post::Abs + Imagekitio::FileUploadParams::Transformation::Post::Transformation, + Imagekitio::FileUploadParams::Transformation::Post::GifToVideo, + Imagekitio::FileUploadParams::Transformation::Post::Thumbnail, + Imagekitio::FileUploadParams::Transformation::Post::Abs ) ], pre: String @@ -663,24 +666,24 @@ module Imagekit end module Post - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::Transformation, - Imagekit::FileUploadParams::Transformation::Post::GifToVideo, - Imagekit::FileUploadParams::Transformation::Post::Thumbnail, - Imagekit::FileUploadParams::Transformation::Post::Abs + Imagekitio::FileUploadParams::Transformation::Post::Transformation, + Imagekitio::FileUploadParams::Transformation::Post::GifToVideo, + Imagekitio::FileUploadParams::Transformation::Post::Thumbnail, + Imagekitio::FileUploadParams::Transformation::Post::Abs ) end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::FileUploadParams::Transformation::Post::Transformation, + Imagekitio::Internal::AnyHash ) end @@ -710,12 +713,12 @@ module Imagekit end end - class GifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::GifToVideo, - Imagekit::Internal::AnyHash + Imagekitio::FileUploadParams::Transformation::Post::GifToVideo, + Imagekitio::Internal::AnyHash ) end @@ -748,12 +751,12 @@ module Imagekit end end - class Thumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::Thumbnail, - Imagekit::Internal::AnyHash + Imagekitio::FileUploadParams::Transformation::Post::Thumbnail, + Imagekitio::Internal::AnyHash ) end @@ -786,19 +789,19 @@ module Imagekit end end - class Abs < Imagekit::Internal::Type::BaseModel + class Abs < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::FileUploadParams::Transformation::Post::Abs, - Imagekit::Internal::AnyHash + Imagekitio::FileUploadParams::Transformation::Post::Abs, + Imagekitio::Internal::AnyHash ) end # Streaming protocol to use (`hls` or `dash`). sig do returns( - Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol + Imagekitio::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol ) end attr_accessor :protocol @@ -814,7 +817,7 @@ module Imagekit sig do params( protocol: - Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, + Imagekitio::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, value: String, type: Symbol ).returns(T.attached_class) @@ -833,7 +836,7 @@ module Imagekit override.returns( { protocol: - Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, + Imagekitio::FileUploadParams::Transformation::Post::Abs::Protocol::OrSymbol, type: Symbol, value: String } @@ -844,13 +847,13 @@ module Imagekit # Streaming protocol to use (`hls` or `dash`). module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol + Imagekitio::FileUploadParams::Transformation::Post::Abs::Protocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -858,18 +861,18 @@ module Imagekit HLS = T.let( :hls, - Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol + Imagekitio::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ) DASH = T.let( :dash, - Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol + Imagekitio::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol + Imagekitio::FileUploadParams::Transformation::Post::Abs::Protocol::TaggedSymbol ] ) end @@ -881,7 +884,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::FileUploadParams::Transformation::Post::Variants + Imagekitio::FileUploadParams::Transformation::Post::Variants ] ) end diff --git a/rbi/imagekit/models/file_upload_response.rbi b/rbi/imagekitio/models/file_upload_response.rbi similarity index 76% rename from rbi/imagekit/models/file_upload_response.rbi rename to rbi/imagekitio/models/file_upload_response.rbi index c695efee..0e88ee70 100644 --- a/rbi/imagekit/models/file_upload_response.rbi +++ b/rbi/imagekitio/models/file_upload_response.rbi @@ -1,20 +1,20 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FileUploadResponse < Imagekit::Internal::Type::BaseModel + class FileUploadResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FileUploadResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileUploadResponse, + Imagekitio::Internal::AnyHash ) end # An array of tags assigned to the uploaded file by auto tagging. sig do returns( - T.nilable(T::Array[Imagekit::Models::FileUploadResponse::AITag]) + T.nilable(T::Array[Imagekitio::Models::FileUploadResponse::AITag]) ) end attr_accessor :ai_tags @@ -86,7 +86,7 @@ module Imagekit # If no extension was requested, then this parameter is not returned. sig do returns( - T.nilable(Imagekit::Models::FileUploadResponse::ExtensionStatus) + T.nilable(Imagekitio::Models::FileUploadResponse::ExtensionStatus) ) end attr_reader :extension_status @@ -94,7 +94,7 @@ module Imagekit sig do params( extension_status: - Imagekit::Models::FileUploadResponse::ExtensionStatus::OrHash + Imagekitio::Models::FileUploadResponse::ExtensionStatus::OrHash ).void end attr_writer :extension_status @@ -149,10 +149,10 @@ module Imagekit # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. - sig { returns(T.nilable(Imagekit::Metadata)) } + sig { returns(T.nilable(Imagekitio::Metadata)) } attr_reader :metadata - sig { params(metadata: Imagekit::Metadata::OrHash).void } + sig { params(metadata: Imagekitio::Metadata::OrHash).void } attr_writer :metadata # Name of the asset. @@ -174,7 +174,7 @@ module Imagekit T.nilable( T::Hash[ Symbol, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema ] ) ) @@ -186,7 +186,7 @@ module Imagekit selected_fields_schema: T::Hash[ Symbol, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::OrHash + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::OrHash ] ).void end @@ -221,14 +221,14 @@ module Imagekit # An object containing the file or file version's `id` (versionId) and `name`. sig do - returns(T.nilable(Imagekit::Models::FileUploadResponse::VersionInfo)) + returns(T.nilable(Imagekitio::Models::FileUploadResponse::VersionInfo)) end attr_reader :version_info sig do params( version_info: - Imagekit::Models::FileUploadResponse::VersionInfo::OrHash + Imagekitio::Models::FileUploadResponse::VersionInfo::OrHash ).void end attr_writer :version_info @@ -252,7 +252,7 @@ module Imagekit params( ai_tags: T.nilable( - T::Array[Imagekit::Models::FileUploadResponse::AITag::OrHash] + T::Array[Imagekitio::Models::FileUploadResponse::AITag::OrHash] ), audio_codec: String, bit_rate: Integer, @@ -262,26 +262,26 @@ module Imagekit duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::Models::FileUploadResponse::ExtensionStatus::OrHash, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::OrHash, file_id: String, file_path: String, file_type: String, height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: Imagekit::Metadata::OrHash, + metadata: Imagekitio::Metadata::OrHash, name: String, selected_fields_schema: T::Hash[ Symbol, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::OrHash + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::OrHash ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, url: String, version_info: - Imagekit::Models::FileUploadResponse::VersionInfo::OrHash, + Imagekitio::Models::FileUploadResponse::VersionInfo::OrHash, video_codec: String, width: Float ).returns(T.attached_class) @@ -377,7 +377,9 @@ module Imagekit override.returns( { ai_tags: - T.nilable(T::Array[Imagekit::Models::FileUploadResponse::AITag]), + T.nilable( + T::Array[Imagekitio::Models::FileUploadResponse::AITag] + ), audio_codec: String, bit_rate: Integer, custom_coordinates: T.nilable(String), @@ -386,25 +388,25 @@ module Imagekit duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::Models::FileUploadResponse::ExtensionStatus, + Imagekitio::Models::FileUploadResponse::ExtensionStatus, file_id: String, file_path: String, file_type: String, height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: Imagekit::Metadata, + metadata: Imagekitio::Metadata, name: String, selected_fields_schema: T::Hash[ Symbol, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, url: String, - version_info: Imagekit::Models::FileUploadResponse::VersionInfo, + version_info: Imagekitio::Models::FileUploadResponse::VersionInfo, video_codec: String, width: Float } @@ -413,12 +415,12 @@ module Imagekit def to_hash end - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FileUploadResponse::AITag, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileUploadResponse::AITag, + Imagekitio::Internal::AnyHash ) end @@ -469,19 +471,19 @@ module Imagekit end end - class ExtensionStatus < Imagekit::Internal::Type::BaseModel + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FileUploadResponse::ExtensionStatus, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileUploadResponse::ExtensionStatus, + Imagekitio::Internal::AnyHash ) end sig do returns( T.nilable( - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) ) end @@ -490,7 +492,7 @@ module Imagekit sig do params( ai_auto_description: - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol ).void end attr_writer :ai_auto_description @@ -498,7 +500,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) ) end @@ -507,7 +509,7 @@ module Imagekit sig do params( aws_auto_tagging: - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol ).void end attr_writer :aws_auto_tagging @@ -515,7 +517,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) ) end @@ -524,7 +526,7 @@ module Imagekit sig do params( google_auto_tagging: - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol ).void end attr_writer :google_auto_tagging @@ -532,7 +534,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) ) end @@ -541,7 +543,7 @@ module Imagekit sig do params( remove_bg: - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol ).void end attr_writer :remove_bg @@ -558,13 +560,13 @@ module Imagekit sig do params( ai_auto_description: - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol, aws_auto_tagging: - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::OrSymbol, remove_bg: - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg::OrSymbol ).returns(T.attached_class) end def self.new( @@ -579,13 +581,13 @@ module Imagekit override.returns( { ai_auto_description: - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, aws_auto_tagging: - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, remove_bg: - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol } ) end @@ -593,13 +595,13 @@ module Imagekit end module AIAutoDescription - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -607,23 +609,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol ] ) end @@ -632,13 +634,13 @@ module Imagekit end module AwsAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -646,23 +648,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol ] ) end @@ -671,13 +673,13 @@ module Imagekit end module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -685,23 +687,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ] ) end @@ -710,13 +712,13 @@ module Imagekit end module RemoveBg - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -724,23 +726,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg::TaggedSymbol ] ) end @@ -749,19 +751,19 @@ module Imagekit end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema, + Imagekitio::Internal::AnyHash ) end # Type of the custom metadata field. sig do returns( - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) end attr_accessor :type @@ -771,7 +773,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants ) ) end @@ -780,7 +782,7 @@ module Imagekit sig do params( default_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants ).void end attr_writer :default_value @@ -805,7 +807,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants ) ) end @@ -814,7 +816,7 @@ module Imagekit sig do params( max_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants ).void end attr_writer :max_value @@ -832,7 +834,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants ) ) end @@ -841,7 +843,7 @@ module Imagekit sig do params( min_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants ).void end attr_writer :min_value @@ -860,7 +862,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ] ) ) @@ -871,7 +873,7 @@ module Imagekit params( select_options: T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ] ).void end @@ -888,20 +890,20 @@ module Imagekit sig do params( type: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::OrSymbol, + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::OrSymbol, default_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, read_only: T::Boolean, select_options: T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ], select_options_truncated: T::Boolean ).returns(T.attached_class) @@ -942,20 +944,20 @@ module Imagekit override.returns( { type: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol, + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol, default_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants, read_only: T::Boolean, select_options: T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ], select_options_truncated: T::Boolean } @@ -966,13 +968,13 @@ module Imagekit # Type of the custom metadata field. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -980,43 +982,43 @@ module Imagekit TEXT = T.let( :Text, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) TEXTAREA = T.let( :Textarea, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) NUMBER = T.let( :Number, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) DATE = T.let( :Date, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) BOOLEAN = T.let( :Boolean, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) SINGLE_SELECT = T.let( :SingleSelect, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) MULTI_SELECT = T.let( :MultiSelect, - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol ] ) end @@ -1027,7 +1029,7 @@ module Imagekit # The default value for this custom metadata field. The value should match the # `type` of custom metadata field. module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do @@ -1036,20 +1038,20 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants ] ) end module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants ] ) end @@ -1060,7 +1062,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants ] ) end @@ -1069,11 +1071,11 @@ module Imagekit MixedArray = T.let( - Imagekit::Internal::Type::ArrayOf[ + Imagekitio::Internal::Type::ArrayOf[ union: - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed ], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::Converter ) end @@ -1081,14 +1083,14 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants ] ) end @@ -1100,14 +1102,14 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants ] ) end @@ -1116,14 +1118,14 @@ module Imagekit end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants ] ) end @@ -1132,12 +1134,12 @@ module Imagekit end end - class VersionInfo < Imagekit::Internal::Type::BaseModel + class VersionInfo < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FileUploadResponse::VersionInfo, - Imagekit::Internal::AnyHash + Imagekitio::Models::FileUploadResponse::VersionInfo, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/bulk_add_tags_params.rbi b/rbi/imagekitio/models/files/bulk_add_tags_params.rbi similarity index 70% rename from rbi/imagekit/models/files/bulk_add_tags_params.rbi rename to rbi/imagekitio/models/files/bulk_add_tags_params.rbi index 6825f8f1..837d0c0e 100644 --- a/rbi/imagekit/models/files/bulk_add_tags_params.rbi +++ b/rbi/imagekitio/models/files/bulk_add_tags_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class BulkAddTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class BulkAddTagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::BulkAddTagsParams, - Imagekit::Internal::AnyHash + Imagekitio::Files::BulkAddTagsParams, + Imagekitio::Internal::AnyHash ) end @@ -27,7 +27,7 @@ module Imagekit params( file_ids: T::Array[String], tags: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -44,7 +44,7 @@ module Imagekit { file_ids: T::Array[String], tags: T::Array[String], - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/files/bulk_add_tags_response.rbi b/rbi/imagekitio/models/files/bulk_add_tags_response.rbi similarity index 82% rename from rbi/imagekit/models/files/bulk_add_tags_response.rbi rename to rbi/imagekitio/models/files/bulk_add_tags_response.rbi index a33291a4..0907c835 100644 --- a/rbi/imagekit/models/files/bulk_add_tags_response.rbi +++ b/rbi/imagekitio/models/files/bulk_add_tags_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class BulkAddTagsResponse < Imagekit::Internal::Type::BaseModel + class BulkAddTagsResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::BulkAddTagsResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Files::BulkAddTagsResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/bulk_delete_params.rbi b/rbi/imagekitio/models/files/bulk_delete_params.rbi similarity index 63% rename from rbi/imagekit/models/files/bulk_delete_params.rbi rename to rbi/imagekitio/models/files/bulk_delete_params.rbi index 6aa1de5f..eb5cb210 100644 --- a/rbi/imagekit/models/files/bulk_delete_params.rbi +++ b/rbi/imagekitio/models/files/bulk_delete_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class BulkDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class BulkDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::BulkDeleteParams, - Imagekit::Internal::AnyHash + Imagekitio::Files::BulkDeleteParams, + Imagekitio::Internal::AnyHash ) end @@ -22,7 +22,7 @@ module Imagekit sig do params( file_ids: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -36,7 +36,7 @@ module Imagekit override.returns( { file_ids: T::Array[String], - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/files/bulk_delete_response.rbi b/rbi/imagekitio/models/files/bulk_delete_response.rbi similarity index 82% rename from rbi/imagekit/models/files/bulk_delete_response.rbi rename to rbi/imagekitio/models/files/bulk_delete_response.rbi index 28ce486e..bce23e4e 100644 --- a/rbi/imagekit/models/files/bulk_delete_response.rbi +++ b/rbi/imagekitio/models/files/bulk_delete_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class BulkDeleteResponse < Imagekit::Internal::Type::BaseModel + class BulkDeleteResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::BulkDeleteResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Files::BulkDeleteResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/bulk_remove_ai_tags_params.rbi b/rbi/imagekitio/models/files/bulk_remove_ai_tags_params.rbi similarity index 70% rename from rbi/imagekit/models/files/bulk_remove_ai_tags_params.rbi rename to rbi/imagekitio/models/files/bulk_remove_ai_tags_params.rbi index b28187ea..4b18e35b 100644 --- a/rbi/imagekit/models/files/bulk_remove_ai_tags_params.rbi +++ b/rbi/imagekitio/models/files/bulk_remove_ai_tags_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class BulkRemoveAITagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class BulkRemoveAITagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::BulkRemoveAITagsParams, - Imagekit::Internal::AnyHash + Imagekitio::Files::BulkRemoveAITagsParams, + Imagekitio::Internal::AnyHash ) end @@ -27,7 +27,7 @@ module Imagekit params( ai_tags: T::Array[String], file_ids: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -44,7 +44,7 @@ module Imagekit { ai_tags: T::Array[String], file_ids: T::Array[String], - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/files/bulk_remove_ai_tags_response.rbi b/rbi/imagekitio/models/files/bulk_remove_ai_tags_response.rbi similarity index 81% rename from rbi/imagekit/models/files/bulk_remove_ai_tags_response.rbi rename to rbi/imagekitio/models/files/bulk_remove_ai_tags_response.rbi index 404fb021..afaeeada 100644 --- a/rbi/imagekit/models/files/bulk_remove_ai_tags_response.rbi +++ b/rbi/imagekitio/models/files/bulk_remove_ai_tags_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class BulkRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + class BulkRemoveAITagsResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::BulkRemoveAITagsResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Files::BulkRemoveAITagsResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/bulk_remove_tags_params.rbi b/rbi/imagekitio/models/files/bulk_remove_tags_params.rbi similarity index 70% rename from rbi/imagekit/models/files/bulk_remove_tags_params.rbi rename to rbi/imagekitio/models/files/bulk_remove_tags_params.rbi index bbbaeebe..9fdeb011 100644 --- a/rbi/imagekit/models/files/bulk_remove_tags_params.rbi +++ b/rbi/imagekitio/models/files/bulk_remove_tags_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class BulkRemoveTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class BulkRemoveTagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::BulkRemoveTagsParams, - Imagekit::Internal::AnyHash + Imagekitio::Files::BulkRemoveTagsParams, + Imagekitio::Internal::AnyHash ) end @@ -27,7 +27,7 @@ module Imagekit params( file_ids: T::Array[String], tags: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -44,7 +44,7 @@ module Imagekit { file_ids: T::Array[String], tags: T::Array[String], - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/files/bulk_remove_tags_response.rbi b/rbi/imagekitio/models/files/bulk_remove_tags_response.rbi similarity index 82% rename from rbi/imagekit/models/files/bulk_remove_tags_response.rbi rename to rbi/imagekitio/models/files/bulk_remove_tags_response.rbi index 68d16d5d..d6c6976c 100644 --- a/rbi/imagekit/models/files/bulk_remove_tags_response.rbi +++ b/rbi/imagekitio/models/files/bulk_remove_tags_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class BulkRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + class BulkRemoveTagsResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::BulkRemoveTagsResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Files::BulkRemoveTagsResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/metadata_get_from_url_params.rbi b/rbi/imagekitio/models/files/metadata_get_from_url_params.rbi similarity index 61% rename from rbi/imagekit/models/files/metadata_get_from_url_params.rbi rename to rbi/imagekitio/models/files/metadata_get_from_url_params.rbi index b22de2f1..aa191d0c 100644 --- a/rbi/imagekit/models/files/metadata_get_from_url_params.rbi +++ b/rbi/imagekitio/models/files/metadata_get_from_url_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class MetadataGetFromURLParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class MetadataGetFromURLParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::MetadataGetFromURLParams, - Imagekit::Internal::AnyHash + Imagekitio::Files::MetadataGetFromURLParams, + Imagekitio::Internal::AnyHash ) end @@ -23,7 +23,7 @@ module Imagekit sig do params( url: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -36,7 +36,7 @@ module Imagekit sig do override.returns( - { url: String, request_options: Imagekit::RequestOptions } + { url: String, request_options: Imagekitio::RequestOptions } ) end def to_hash diff --git a/rbi/imagekitio/models/files/metadata_get_params.rbi b/rbi/imagekitio/models/files/metadata_get_params.rbi new file mode 100644 index 00000000..f0e31e56 --- /dev/null +++ b/rbi/imagekitio/models/files/metadata_get_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Files + class MetadataGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Files::MetadataGetParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/files/version_delete_params.rbi b/rbi/imagekitio/models/files/version_delete_params.rbi similarity index 52% rename from rbi/imagekit/models/files/version_delete_params.rbi rename to rbi/imagekitio/models/files/version_delete_params.rbi index ba925a21..22c464cf 100644 --- a/rbi/imagekit/models/files/version_delete_params.rbi +++ b/rbi/imagekitio/models/files/version_delete_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class VersionDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class VersionDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::VersionDeleteParams, - Imagekit::Internal::AnyHash + Imagekitio::Files::VersionDeleteParams, + Imagekitio::Internal::AnyHash ) end @@ -21,7 +21,7 @@ module Imagekit sig do params( file_id: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new(file_id:, request_options: {}) @@ -29,7 +29,7 @@ module Imagekit sig do override.returns( - { file_id: String, request_options: Imagekit::RequestOptions } + { file_id: String, request_options: Imagekitio::RequestOptions } ) end def to_hash diff --git a/rbi/imagekit/models/files/version_delete_response.rbi b/rbi/imagekitio/models/files/version_delete_response.rbi similarity index 61% rename from rbi/imagekit/models/files/version_delete_response.rbi rename to rbi/imagekitio/models/files/version_delete_response.rbi index 6d0f6ab9..5d7590c7 100644 --- a/rbi/imagekit/models/files/version_delete_response.rbi +++ b/rbi/imagekitio/models/files/version_delete_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class VersionDeleteResponse < Imagekit::Internal::Type::BaseModel + class VersionDeleteResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Files::VersionDeleteResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Files::VersionDeleteResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/files/version_get_params.rbi b/rbi/imagekitio/models/files/version_get_params.rbi similarity index 52% rename from rbi/imagekit/models/files/version_get_params.rbi rename to rbi/imagekitio/models/files/version_get_params.rbi index 107a03d0..5b63d9a3 100644 --- a/rbi/imagekit/models/files/version_get_params.rbi +++ b/rbi/imagekitio/models/files/version_get_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class VersionGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class VersionGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::VersionGetParams, - Imagekit::Internal::AnyHash + Imagekitio::Files::VersionGetParams, + Imagekitio::Internal::AnyHash ) end @@ -21,7 +21,7 @@ module Imagekit sig do params( file_id: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new(file_id:, request_options: {}) @@ -29,7 +29,7 @@ module Imagekit sig do override.returns( - { file_id: String, request_options: Imagekit::RequestOptions } + { file_id: String, request_options: Imagekitio::RequestOptions } ) end def to_hash diff --git a/rbi/imagekitio/models/files/version_list_params.rbi b/rbi/imagekitio/models/files/version_list_params.rbi new file mode 100644 index 00000000..3e3edd1b --- /dev/null +++ b/rbi/imagekitio/models/files/version_list_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Files + class VersionListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Files::VersionListParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekitio/models/files/version_list_response.rbi b/rbi/imagekitio/models/files/version_list_response.rbi new file mode 100644 index 00000000..f149f19c --- /dev/null +++ b/rbi/imagekitio/models/files/version_list_response.rbi @@ -0,0 +1,13 @@ +# typed: strong + +module Imagekitio + module Models + module Files + VersionListResponse = + T.let( + Imagekitio::Internal::Type::ArrayOf[Imagekitio::File], + Imagekitio::Internal::Type::Converter + ) + end + end +end diff --git a/rbi/imagekit/models/files/version_restore_params.rbi b/rbi/imagekitio/models/files/version_restore_params.rbi similarity index 52% rename from rbi/imagekit/models/files/version_restore_params.rbi rename to rbi/imagekitio/models/files/version_restore_params.rbi index c4b466fd..37cfd965 100644 --- a/rbi/imagekit/models/files/version_restore_params.rbi +++ b/rbi/imagekitio/models/files/version_restore_params.rbi @@ -1,17 +1,17 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Files - class VersionRestoreParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class VersionRestoreParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - Imagekit::Files::VersionRestoreParams, - Imagekit::Internal::AnyHash + Imagekitio::Files::VersionRestoreParams, + Imagekitio::Internal::AnyHash ) end @@ -21,7 +21,7 @@ module Imagekit sig do params( file_id: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new(file_id:, request_options: {}) @@ -29,7 +29,7 @@ module Imagekit sig do override.returns( - { file_id: String, request_options: Imagekit::RequestOptions } + { file_id: String, request_options: Imagekitio::RequestOptions } ) end def to_hash diff --git a/rbi/imagekit/models/folder.rbi b/rbi/imagekitio/models/folder.rbi similarity index 79% rename from rbi/imagekit/models/folder.rbi rename to rbi/imagekitio/models/folder.rbi index ae0620c3..d2b61d1c 100644 --- a/rbi/imagekit/models/folder.rbi +++ b/rbi/imagekitio/models/folder.rbi @@ -1,10 +1,12 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class Folder < Imagekit::Internal::Type::BaseModel + class Folder < Imagekitio::Internal::Type::BaseModel OrHash = - T.type_alias { T.any(Imagekit::Folder, Imagekit::Internal::AnyHash) } + T.type_alias do + T.any(Imagekitio::Folder, Imagekitio::Internal::AnyHash) + end # Date and time when the folder was created. The date and time is in ISO8601 # format. @@ -39,10 +41,10 @@ module Imagekit attr_writer :name # Type of the asset. - sig { returns(T.nilable(Imagekit::Folder::Type::TaggedSymbol)) } + sig { returns(T.nilable(Imagekitio::Folder::Type::TaggedSymbol)) } attr_reader :type - sig { params(type: Imagekit::Folder::Type::OrSymbol).void } + sig { params(type: Imagekitio::Folder::Type::OrSymbol).void } attr_writer :type # Date and time when the folder was last updated. The date and time is in ISO8601 @@ -59,7 +61,7 @@ module Imagekit folder_id: String, folder_path: String, name: String, - type: Imagekit::Folder::Type::OrSymbol, + type: Imagekitio::Folder::Type::OrSymbol, updated_at: Time ).returns(T.attached_class) end @@ -91,7 +93,7 @@ module Imagekit folder_id: String, folder_path: String, name: String, - type: Imagekit::Folder::Type::TaggedSymbol, + type: Imagekitio::Folder::Type::TaggedSymbol, updated_at: Time } ) @@ -101,14 +103,16 @@ module Imagekit # Type of the asset. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, Imagekit::Folder::Type) } + TaggedSymbol = T.type_alias { T.all(Symbol, Imagekitio::Folder::Type) } OrSymbol = T.type_alias { T.any(Symbol, String) } - FOLDER = T.let(:folder, Imagekit::Folder::Type::TaggedSymbol) + FOLDER = T.let(:folder, Imagekitio::Folder::Type::TaggedSymbol) - sig { override.returns(T::Array[Imagekit::Folder::Type::TaggedSymbol]) } + sig do + override.returns(T::Array[Imagekitio::Folder::Type::TaggedSymbol]) + end def self.values end end diff --git a/rbi/imagekit/models/folder_copy_params.rbi b/rbi/imagekitio/models/folder_copy_params.rbi similarity index 81% rename from rbi/imagekit/models/folder_copy_params.rbi rename to rbi/imagekitio/models/folder_copy_params.rbi index b73945bc..ccadd4db 100644 --- a/rbi/imagekit/models/folder_copy_params.rbi +++ b/rbi/imagekitio/models/folder_copy_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderCopyParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderCopyParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FolderCopyParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FolderCopyParams, Imagekitio::Internal::AnyHash) end # Full path to the destination folder where you want to copy the source folder @@ -34,7 +34,7 @@ module Imagekit destination_path: String, source_folder_path: String, include_versions: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -57,7 +57,7 @@ module Imagekit destination_path: String, source_folder_path: String, include_versions: T::Boolean, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/folder_copy_response.rbi b/rbi/imagekitio/models/folder_copy_response.rbi similarity index 78% rename from rbi/imagekit/models/folder_copy_response.rbi rename to rbi/imagekitio/models/folder_copy_response.rbi index f294ad91..cfaa16e7 100644 --- a/rbi/imagekit/models/folder_copy_response.rbi +++ b/rbi/imagekitio/models/folder_copy_response.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderCopyResponse < Imagekit::Internal::Type::BaseModel + class FolderCopyResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FolderCopyResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FolderCopyResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/folder_create_params.rbi b/rbi/imagekitio/models/folder_create_params.rbi similarity index 83% rename from rbi/imagekit/models/folder_create_params.rbi rename to rbi/imagekitio/models/folder_create_params.rbi index c33e9c28..494de6dc 100644 --- a/rbi/imagekit/models/folder_create_params.rbi +++ b/rbi/imagekitio/models/folder_create_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FolderCreateParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FolderCreateParams, Imagekitio::Internal::AnyHash) end # The folder will be created with this name. @@ -33,7 +33,7 @@ module Imagekit params( folder_name: String, parent_folder_path: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -60,7 +60,7 @@ module Imagekit { folder_name: String, parent_folder_path: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/custom_metadata_field_delete_response.rbi b/rbi/imagekitio/models/folder_create_response.rbi similarity index 56% rename from rbi/imagekit/models/custom_metadata_field_delete_response.rbi rename to rbi/imagekitio/models/folder_create_response.rbi index 1e9c8a3f..2060734f 100644 --- a/rbi/imagekit/models/custom_metadata_field_delete_response.rbi +++ b/rbi/imagekitio/models/folder_create_response.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class CustomMetadataFieldDeleteResponse < Imagekit::Internal::Type::BaseModel + class FolderCreateResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::CustomMetadataFieldDeleteResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FolderCreateResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/folder_delete_params.rbi b/rbi/imagekitio/models/folder_delete_params.rbi similarity index 58% rename from rbi/imagekit/models/folder_delete_params.rbi rename to rbi/imagekitio/models/folder_delete_params.rbi index 09e1c54c..db006cce 100644 --- a/rbi/imagekit/models/folder_delete_params.rbi +++ b/rbi/imagekitio/models/folder_delete_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FolderDeleteParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FolderDeleteParams, Imagekitio::Internal::AnyHash) end # Full path to the folder you want to delete. For example `/folder/to/delete/`. @@ -18,7 +18,7 @@ module Imagekit sig do params( folder_path: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -30,7 +30,7 @@ module Imagekit sig do override.returns( - { folder_path: String, request_options: Imagekit::RequestOptions } + { folder_path: String, request_options: Imagekitio::RequestOptions } ) end def to_hash diff --git a/rbi/imagekit/models/file_copy_response.rbi b/rbi/imagekitio/models/folder_delete_response.rbi similarity index 52% rename from rbi/imagekit/models/file_copy_response.rbi rename to rbi/imagekitio/models/folder_delete_response.rbi index 74ff699c..df6c1578 100644 --- a/rbi/imagekit/models/file_copy_response.rbi +++ b/rbi/imagekitio/models/folder_delete_response.rbi @@ -1,11 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FileCopyResponse < Imagekit::Internal::Type::BaseModel + class FolderDeleteResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::Models::FileCopyResponse, Imagekit::Internal::AnyHash) + T.any( + Imagekitio::Models::FolderDeleteResponse, + Imagekitio::Internal::AnyHash + ) end sig { returns(T.attached_class) } diff --git a/rbi/imagekit/models/folder_move_params.rbi b/rbi/imagekitio/models/folder_move_params.rbi similarity index 71% rename from rbi/imagekit/models/folder_move_params.rbi rename to rbi/imagekitio/models/folder_move_params.rbi index c8bb4036..ac2eb0be 100644 --- a/rbi/imagekit/models/folder_move_params.rbi +++ b/rbi/imagekitio/models/folder_move_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderMoveParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderMoveParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FolderMoveParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FolderMoveParams, Imagekitio::Internal::AnyHash) end # Full path to the destination folder where you want to move the source folder @@ -24,7 +24,7 @@ module Imagekit params( destination_path: String, source_folder_path: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -42,7 +42,7 @@ module Imagekit { destination_path: String, source_folder_path: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/folder_move_response.rbi b/rbi/imagekitio/models/folder_move_response.rbi similarity index 78% rename from rbi/imagekit/models/folder_move_response.rbi rename to rbi/imagekitio/models/folder_move_response.rbi index e19ca456..5d613bc6 100644 --- a/rbi/imagekit/models/folder_move_response.rbi +++ b/rbi/imagekitio/models/folder_move_response.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderMoveResponse < Imagekit::Internal::Type::BaseModel + class FolderMoveResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FolderMoveResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FolderMoveResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/folder_rename_params.rbi b/rbi/imagekitio/models/folder_rename_params.rbi similarity index 89% rename from rbi/imagekit/models/folder_rename_params.rbi rename to rbi/imagekitio/models/folder_rename_params.rbi index 3de0ef79..8a810ab8 100644 --- a/rbi/imagekit/models/folder_rename_params.rbi +++ b/rbi/imagekitio/models/folder_rename_params.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderRenameParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderRenameParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(Imagekit::FolderRenameParams, Imagekit::Internal::AnyHash) + T.any(Imagekitio::FolderRenameParams, Imagekitio::Internal::AnyHash) end # The full path to the folder you want to rename. @@ -49,7 +49,7 @@ module Imagekit folder_path: String, new_folder_name: String, purge_cache: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( @@ -87,7 +87,7 @@ module Imagekit folder_path: String, new_folder_name: String, purge_cache: T::Boolean, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } ) end diff --git a/rbi/imagekit/models/folder_rename_response.rbi b/rbi/imagekitio/models/folder_rename_response.rbi similarity index 78% rename from rbi/imagekit/models/folder_rename_response.rbi rename to rbi/imagekitio/models/folder_rename_response.rbi index 5fad09f4..379ef47d 100644 --- a/rbi/imagekit/models/folder_rename_response.rbi +++ b/rbi/imagekitio/models/folder_rename_response.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + class FolderRenameResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::FolderRenameResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::FolderRenameResponse, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekitio/models/folders/job_get_params.rbi b/rbi/imagekitio/models/folders/job_get_params.rbi new file mode 100644 index 00000000..35a2e840 --- /dev/null +++ b/rbi/imagekitio/models/folders/job_get_params.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Imagekitio + module Models + module Folders + class JobGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::Folders::JobGetParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig do + override.returns({ request_options: Imagekitio::RequestOptions }) + end + def to_hash + end + end + end + end +end diff --git a/rbi/imagekit/models/folders/job_get_response.rbi b/rbi/imagekitio/models/folders/job_get_response.rbi similarity index 66% rename from rbi/imagekit/models/folders/job_get_response.rbi rename to rbi/imagekitio/models/folders/job_get_response.rbi index 518392e0..275aeebd 100644 --- a/rbi/imagekit/models/folders/job_get_response.rbi +++ b/rbi/imagekitio/models/folders/job_get_response.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Models module Folders - class JobGetResponse < Imagekit::Internal::Type::BaseModel + class JobGetResponse < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Models::Folders::JobGetResponse, - Imagekit::Internal::AnyHash + Imagekitio::Models::Folders::JobGetResponse, + Imagekitio::Internal::AnyHash ) end @@ -31,7 +31,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol ) ) end @@ -39,7 +39,8 @@ module Imagekit sig do params( - status: Imagekit::Models::Folders::JobGetResponse::Status::OrSymbol + status: + Imagekitio::Models::Folders::JobGetResponse::Status::OrSymbol ).void end attr_writer :status @@ -48,7 +49,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol ) ) end @@ -56,7 +57,7 @@ module Imagekit sig do params( - type: Imagekit::Models::Folders::JobGetResponse::Type::OrSymbol + type: Imagekitio::Models::Folders::JobGetResponse::Type::OrSymbol ).void end attr_writer :type @@ -65,8 +66,9 @@ module Imagekit params( job_id: String, purge_request_id: String, - status: Imagekit::Models::Folders::JobGetResponse::Status::OrSymbol, - type: Imagekit::Models::Folders::JobGetResponse::Type::OrSymbol + status: + Imagekitio::Models::Folders::JobGetResponse::Status::OrSymbol, + type: Imagekitio::Models::Folders::JobGetResponse::Type::OrSymbol ).returns(T.attached_class) end def self.new( @@ -88,9 +90,9 @@ module Imagekit job_id: String, purge_request_id: String, status: - Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol, + Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol, type: - Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol } ) end @@ -99,29 +101,29 @@ module Imagekit # Status of the bulk job. module Status - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::Models::Folders::JobGetResponse::Status) + T.all(Symbol, Imagekitio::Models::Folders::JobGetResponse::Status) end OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let( :Pending, - Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol ) COMPLETED = T.let( :Completed, - Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Folders::JobGetResponse::Status::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol ] ) end @@ -131,34 +133,34 @@ module Imagekit # Type of the bulk job. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::Models::Folders::JobGetResponse::Type) + T.all(Symbol, Imagekitio::Models::Folders::JobGetResponse::Type) end OrSymbol = T.type_alias { T.any(Symbol, String) } COPY_FOLDER = T.let( :COPY_FOLDER, - Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol ) MOVE_FOLDER = T.let( :MOVE_FOLDER, - Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol ) RENAME_FOLDER = T.let( :RENAME_FOLDER, - Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::Models::Folders::JobGetResponse::Type::TaggedSymbol + Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/get_image_attributes_options.rbi b/rbi/imagekitio/models/get_image_attributes_options.rbi similarity index 95% rename from rbi/imagekit/models/get_image_attributes_options.rbi rename to rbi/imagekitio/models/get_image_attributes_options.rbi index dd13f060..9a170a5c 100644 --- a/rbi/imagekit/models/get_image_attributes_options.rbi +++ b/rbi/imagekitio/models/get_image_attributes_options.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class GetImageAttributesOptions < Imagekit::Models::SrcOptions + class GetImageAttributesOptions < Imagekitio::Models::SrcOptions OrHash = T.type_alias do T.any( - Imagekit::GetImageAttributesOptions, - Imagekit::Internal::AnyHash + Imagekitio::GetImageAttributesOptions, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/image_overlay.rbi b/rbi/imagekitio/models/image_overlay.rbi similarity index 72% rename from rbi/imagekit/models/image_overlay.rbi rename to rbi/imagekitio/models/image_overlay.rbi index 409aa105..fda4e3fe 100644 --- a/rbi/imagekit/models/image_overlay.rbi +++ b/rbi/imagekitio/models/image_overlay.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class ImageOverlay < Imagekit::Models::BaseOverlay + class ImageOverlay < Imagekitio::Models::BaseOverlay OrHash = T.type_alias do - T.any(Imagekit::ImageOverlay, Imagekit::Internal::AnyHash) + T.any(Imagekitio::ImageOverlay, Imagekitio::Internal::AnyHash) end # Specifies the relative path to the image used as an overlay. @@ -20,10 +20,12 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::ImageOverlay::Encoding::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::ImageOverlay::Encoding::OrSymbol)) } attr_reader :encoding - sig { params(encoding: Imagekit::ImageOverlay::Encoding::OrSymbol).void } + sig do + params(encoding: Imagekitio::ImageOverlay::Encoding::OrSymbol).void + end attr_writer :encoding # Array of transformations to be applied to the overlay image. Supported @@ -31,17 +33,17 @@ module Imagekit # [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). - sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } + sig { returns(T.nilable(T::Array[Imagekitio::Transformation])) } attr_reader :transformation - sig { params(transformation: T::Array[Imagekit::Transformation]).void } + sig { params(transformation: T::Array[Imagekitio::Transformation]).void } attr_writer :transformation sig do params( input: String, - encoding: Imagekit::ImageOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::Transformation], + encoding: Imagekitio::ImageOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekitio::Transformation], type: Symbol ).returns(T.attached_class) end @@ -69,8 +71,8 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::ImageOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::Transformation] + encoding: Imagekitio::ImageOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekitio::Transformation] } ) end @@ -83,19 +85,20 @@ module Imagekit # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. module Encoding - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::ImageOverlay::Encoding) } + T.type_alias { T.all(Symbol, Imagekitio::ImageOverlay::Encoding) } OrSymbol = T.type_alias { T.any(Symbol, String) } - AUTO = T.let(:auto, Imagekit::ImageOverlay::Encoding::TaggedSymbol) - PLAIN = T.let(:plain, Imagekit::ImageOverlay::Encoding::TaggedSymbol) - BASE64 = T.let(:base64, Imagekit::ImageOverlay::Encoding::TaggedSymbol) + AUTO = T.let(:auto, Imagekitio::ImageOverlay::Encoding::TaggedSymbol) + PLAIN = T.let(:plain, Imagekitio::ImageOverlay::Encoding::TaggedSymbol) + BASE64 = + T.let(:base64, Imagekitio::ImageOverlay::Encoding::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::ImageOverlay::Encoding::TaggedSymbol] + T::Array[Imagekitio::ImageOverlay::Encoding::TaggedSymbol] ) end def self.values diff --git a/rbi/imagekit/models/metadata.rbi b/rbi/imagekitio/models/metadata.rbi similarity index 88% rename from rbi/imagekit/models/metadata.rbi rename to rbi/imagekitio/models/metadata.rbi index 53bea104..dea32d8f 100644 --- a/rbi/imagekit/models/metadata.rbi +++ b/rbi/imagekitio/models/metadata.rbi @@ -1,10 +1,12 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class Metadata < Imagekit::Internal::Type::BaseModel + class Metadata < Imagekitio::Internal::Type::BaseModel OrHash = - T.type_alias { T.any(Imagekit::Metadata, Imagekit::Internal::AnyHash) } + T.type_alias do + T.any(Imagekitio::Metadata, Imagekitio::Internal::AnyHash) + end # The audio codec used in the video (only for video). sig { returns(T.nilable(String)) } @@ -34,10 +36,10 @@ module Imagekit sig { params(duration: Integer).void } attr_writer :duration - sig { returns(T.nilable(Imagekit::Metadata::Exif)) } + sig { returns(T.nilable(Imagekitio::Metadata::Exif)) } attr_reader :exif - sig { params(exif: Imagekit::Metadata::Exif::OrHash).void } + sig { params(exif: Imagekitio::Metadata::Exif::OrHash).void } attr_writer :exif # The format of the file (e.g., 'jpg', 'mp4'). @@ -110,7 +112,7 @@ module Imagekit bit_rate: Integer, density: Integer, duration: Integer, - exif: Imagekit::Metadata::Exif::OrHash, + exif: Imagekitio::Metadata::Exif::OrHash, format_: String, has_color_profile: T::Boolean, has_transparency: T::Boolean, @@ -160,7 +162,7 @@ module Imagekit bit_rate: Integer, density: Integer, duration: Integer, - exif: Imagekit::Metadata::Exif, + exif: Imagekitio::Metadata::Exif, format_: String, has_color_profile: T::Boolean, has_transparency: T::Boolean, @@ -176,40 +178,41 @@ module Imagekit def to_hash end - class Exif < Imagekit::Internal::Type::BaseModel + class Exif < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::Metadata::Exif, Imagekit::Internal::AnyHash) + T.any(Imagekitio::Metadata::Exif, Imagekitio::Internal::AnyHash) end # Object containing Exif details. - sig { returns(T.nilable(Imagekit::Metadata::Exif::Exif)) } + sig { returns(T.nilable(Imagekitio::Metadata::Exif::Exif)) } attr_reader :exif - sig { params(exif: Imagekit::Metadata::Exif::Exif::OrHash).void } + sig { params(exif: Imagekitio::Metadata::Exif::Exif::OrHash).void } attr_writer :exif # Object containing GPS information. - sig { returns(T.nilable(Imagekit::Metadata::Exif::Gps)) } + sig { returns(T.nilable(Imagekitio::Metadata::Exif::Gps)) } attr_reader :gps - sig { params(gps: Imagekit::Metadata::Exif::Gps::OrHash).void } + sig { params(gps: Imagekitio::Metadata::Exif::Gps::OrHash).void } attr_writer :gps # Object containing EXIF image information. - sig { returns(T.nilable(Imagekit::Metadata::Exif::Image)) } + sig { returns(T.nilable(Imagekitio::Metadata::Exif::Image)) } attr_reader :image - sig { params(image: Imagekit::Metadata::Exif::Image::OrHash).void } + sig { params(image: Imagekitio::Metadata::Exif::Image::OrHash).void } attr_writer :image # JSON object. - sig { returns(T.nilable(Imagekit::Metadata::Exif::Interoperability)) } + sig { returns(T.nilable(Imagekitio::Metadata::Exif::Interoperability)) } attr_reader :interoperability sig do params( - interoperability: Imagekit::Metadata::Exif::Interoperability::OrHash + interoperability: + Imagekitio::Metadata::Exif::Interoperability::OrHash ).void end attr_writer :interoperability @@ -221,23 +224,23 @@ module Imagekit attr_writer :makernote # Object containing Thumbnail information. - sig { returns(T.nilable(Imagekit::Metadata::Exif::Thumbnail)) } + sig { returns(T.nilable(Imagekitio::Metadata::Exif::Thumbnail)) } attr_reader :thumbnail sig do - params(thumbnail: Imagekit::Metadata::Exif::Thumbnail::OrHash).void + params(thumbnail: Imagekitio::Metadata::Exif::Thumbnail::OrHash).void end attr_writer :thumbnail sig do params( - exif: Imagekit::Metadata::Exif::Exif::OrHash, - gps: Imagekit::Metadata::Exif::Gps::OrHash, - image: Imagekit::Metadata::Exif::Image::OrHash, + exif: Imagekitio::Metadata::Exif::Exif::OrHash, + gps: Imagekitio::Metadata::Exif::Gps::OrHash, + image: Imagekitio::Metadata::Exif::Image::OrHash, interoperability: - Imagekit::Metadata::Exif::Interoperability::OrHash, + Imagekitio::Metadata::Exif::Interoperability::OrHash, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Metadata::Exif::Thumbnail::OrHash + thumbnail: Imagekitio::Metadata::Exif::Thumbnail::OrHash ).returns(T.attached_class) end def self.new( @@ -258,22 +261,25 @@ module Imagekit sig do override.returns( { - exif: Imagekit::Metadata::Exif::Exif, - gps: Imagekit::Metadata::Exif::Gps, - image: Imagekit::Metadata::Exif::Image, - interoperability: Imagekit::Metadata::Exif::Interoperability, + exif: Imagekitio::Metadata::Exif::Exif, + gps: Imagekitio::Metadata::Exif::Gps, + image: Imagekitio::Metadata::Exif::Image, + interoperability: Imagekitio::Metadata::Exif::Interoperability, makernote: T::Hash[Symbol, T.anything], - thumbnail: Imagekit::Metadata::Exif::Thumbnail + thumbnail: Imagekitio::Metadata::Exif::Thumbnail } ) end def to_hash end - class Exif < Imagekit::Internal::Type::BaseModel + class Exif < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::Metadata::Exif::Exif, Imagekit::Internal::AnyHash) + T.any( + Imagekitio::Metadata::Exif::Exif, + Imagekitio::Internal::AnyHash + ) end sig { returns(T.nilable(Float)) } @@ -529,10 +535,13 @@ module Imagekit end end - class Gps < Imagekit::Internal::Type::BaseModel + class Gps < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::Metadata::Exif::Gps, Imagekit::Internal::AnyHash) + T.any( + Imagekitio::Metadata::Exif::Gps, + Imagekitio::Internal::AnyHash + ) end sig { returns(T.nilable(T::Array[Integer])) } @@ -553,12 +562,12 @@ module Imagekit end end - class Image < Imagekit::Internal::Type::BaseModel + class Image < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Metadata::Exif::Image, - Imagekit::Internal::AnyHash + Imagekitio::Metadata::Exif::Image, + Imagekitio::Internal::AnyHash ) end @@ -680,12 +689,12 @@ module Imagekit end end - class Interoperability < Imagekit::Internal::Type::BaseModel + class Interoperability < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Metadata::Exif::Interoperability, - Imagekit::Internal::AnyHash + Imagekitio::Metadata::Exif::Interoperability, + Imagekitio::Internal::AnyHash ) end @@ -717,12 +726,12 @@ module Imagekit end end - class Thumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::Metadata::Exif::Thumbnail, - Imagekit::Internal::AnyHash + Imagekitio::Metadata::Exif::Thumbnail, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/overlay.rbi b/rbi/imagekitio/models/overlay.rbi similarity index 57% rename from rbi/imagekit/models/overlay.rbi rename to rbi/imagekitio/models/overlay.rbi index 59e0e042..379bce0f 100644 --- a/rbi/imagekit/models/overlay.rbi +++ b/rbi/imagekitio/models/overlay.rbi @@ -1,26 +1,26 @@ # typed: strong -module Imagekit +module Imagekitio module Models # 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). module Overlay - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::TextOverlay, - Imagekit::ImageOverlay, - Imagekit::VideoOverlay, - Imagekit::SubtitleOverlay, - Imagekit::SolidColorOverlay + Imagekitio::TextOverlay, + Imagekitio::ImageOverlay, + Imagekitio::VideoOverlay, + Imagekitio::SubtitleOverlay, + Imagekitio::SolidColorOverlay ) end - sig { override.returns(T::Array[Imagekit::Overlay::Variants]) } + sig { override.returns(T::Array[Imagekitio::Overlay::Variants]) } def self.variants end end diff --git a/rbi/imagekit/models/overlay_position.rbi b/rbi/imagekitio/models/overlay_position.rbi similarity index 64% rename from rbi/imagekit/models/overlay_position.rbi rename to rbi/imagekitio/models/overlay_position.rbi index 96202b12..9897e1e4 100644 --- a/rbi/imagekit/models/overlay_position.rbi +++ b/rbi/imagekitio/models/overlay_position.rbi @@ -1,19 +1,19 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class OverlayPosition < Imagekit::Internal::Type::BaseModel + class OverlayPosition < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::OverlayPosition, Imagekit::Internal::AnyHash) + T.any(Imagekitio::OverlayPosition, Imagekitio::Internal::AnyHash) end # Specifies the position of the overlay relative to the parent image or video. # Maps to `lfo` in the URL. - sig { returns(T.nilable(Imagekit::OverlayPosition::Focus::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::OverlayPosition::Focus::OrSymbol)) } attr_reader :focus - sig { params(focus: Imagekit::OverlayPosition::Focus::OrSymbol).void } + sig { params(focus: Imagekitio::OverlayPosition::Focus::OrSymbol).void } attr_writer :focus # Specifies the x-coordinate of the top-left corner of the base asset where the @@ -21,10 +21,10 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::OverlayPosition::X::Variants)) } + sig { returns(T.nilable(Imagekitio::OverlayPosition::X::Variants)) } attr_reader :x - sig { params(x: Imagekit::OverlayPosition::X::Variants).void } + sig { params(x: Imagekitio::OverlayPosition::X::Variants).void } attr_writer :x # Specifies the y-coordinate of the top-left corner of the base asset where the @@ -32,17 +32,17 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::OverlayPosition::Y::Variants)) } + sig { returns(T.nilable(Imagekitio::OverlayPosition::Y::Variants)) } attr_reader :y_ - sig { params(y_: Imagekit::OverlayPosition::Y::Variants).void } + sig { params(y_: Imagekitio::OverlayPosition::Y::Variants).void } attr_writer :y_ sig do params( - focus: Imagekit::OverlayPosition::Focus::OrSymbol, - x: Imagekit::OverlayPosition::X::Variants, - y_: Imagekit::OverlayPosition::Y::Variants + focus: Imagekitio::OverlayPosition::Focus::OrSymbol, + x: Imagekitio::OverlayPosition::X::Variants, + y_: Imagekitio::OverlayPosition::Y::Variants ).returns(T.attached_class) end def self.new( @@ -67,9 +67,9 @@ module Imagekit sig do override.returns( { - focus: Imagekit::OverlayPosition::Focus::OrSymbol, - x: Imagekit::OverlayPosition::X::Variants, - y_: Imagekit::OverlayPosition::Y::Variants + focus: Imagekitio::OverlayPosition::Focus::OrSymbol, + x: Imagekitio::OverlayPosition::X::Variants, + y_: Imagekitio::OverlayPosition::Y::Variants } ) end @@ -79,29 +79,31 @@ module Imagekit # Specifies the position of the overlay relative to the parent image or video. # Maps to `lfo` in the URL. module Focus - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::OverlayPosition::Focus) } + T.type_alias { T.all(Symbol, Imagekitio::OverlayPosition::Focus) } OrSymbol = T.type_alias { T.any(Symbol, String) } - CENTER = T.let(:center, Imagekit::OverlayPosition::Focus::TaggedSymbol) - TOP = T.let(:top, Imagekit::OverlayPosition::Focus::TaggedSymbol) - LEFT = T.let(:left, Imagekit::OverlayPosition::Focus::TaggedSymbol) - BOTTOM = T.let(:bottom, Imagekit::OverlayPosition::Focus::TaggedSymbol) - RIGHT = T.let(:right, Imagekit::OverlayPosition::Focus::TaggedSymbol) + CENTER = + T.let(:center, Imagekitio::OverlayPosition::Focus::TaggedSymbol) + TOP = T.let(:top, Imagekitio::OverlayPosition::Focus::TaggedSymbol) + LEFT = T.let(:left, Imagekitio::OverlayPosition::Focus::TaggedSymbol) + BOTTOM = + T.let(:bottom, Imagekitio::OverlayPosition::Focus::TaggedSymbol) + RIGHT = T.let(:right, Imagekitio::OverlayPosition::Focus::TaggedSymbol) TOP_LEFT = - T.let(:top_left, Imagekit::OverlayPosition::Focus::TaggedSymbol) + T.let(:top_left, Imagekitio::OverlayPosition::Focus::TaggedSymbol) TOP_RIGHT = - T.let(:top_right, Imagekit::OverlayPosition::Focus::TaggedSymbol) + T.let(:top_right, Imagekitio::OverlayPosition::Focus::TaggedSymbol) BOTTOM_LEFT = - T.let(:bottom_left, Imagekit::OverlayPosition::Focus::TaggedSymbol) + T.let(:bottom_left, Imagekitio::OverlayPosition::Focus::TaggedSymbol) BOTTOM_RIGHT = - T.let(:bottom_right, Imagekit::OverlayPosition::Focus::TaggedSymbol) + T.let(:bottom_right, Imagekitio::OverlayPosition::Focus::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::OverlayPosition::Focus::TaggedSymbol] + T::Array[Imagekitio::OverlayPosition::Focus::TaggedSymbol] ) end def self.values @@ -114,12 +116,12 @@ module Imagekit # about # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). module X - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::OverlayPosition::X::Variants]) + override.returns(T::Array[Imagekitio::OverlayPosition::X::Variants]) end def self.variants end @@ -131,12 +133,12 @@ module Imagekit # about # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). module Y - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::OverlayPosition::Y::Variants]) + override.returns(T::Array[Imagekitio::OverlayPosition::Y::Variants]) end def self.variants end diff --git a/rbi/imagekit/models/overlay_timing.rbi b/rbi/imagekitio/models/overlay_timing.rbi similarity index 75% rename from rbi/imagekit/models/overlay_timing.rbi rename to rbi/imagekitio/models/overlay_timing.rbi index 50d25cae..71901aae 100644 --- a/rbi/imagekit/models/overlay_timing.rbi +++ b/rbi/imagekitio/models/overlay_timing.rbi @@ -1,21 +1,23 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class OverlayTiming < Imagekit::Internal::Type::BaseModel + class OverlayTiming < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::OverlayTiming, Imagekit::Internal::AnyHash) + T.any(Imagekitio::OverlayTiming, Imagekitio::Internal::AnyHash) end # 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. - sig { returns(T.nilable(Imagekit::OverlayTiming::Duration::Variants)) } + sig { returns(T.nilable(Imagekitio::OverlayTiming::Duration::Variants)) } attr_reader :duration - sig { params(duration: Imagekit::OverlayTiming::Duration::Variants).void } + sig do + params(duration: Imagekitio::OverlayTiming::Duration::Variants).void + end attr_writer :duration # Specifies the end time (in seconds) for when the overlay should disappear from @@ -23,27 +25,27 @@ module Imagekit # 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. - sig { returns(T.nilable(Imagekit::OverlayTiming::End::Variants)) } + sig { returns(T.nilable(Imagekitio::OverlayTiming::End::Variants)) } attr_reader :end_ - sig { params(end_: Imagekit::OverlayTiming::End::Variants).void } + sig { params(end_: Imagekitio::OverlayTiming::End::Variants).void } attr_writer :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. - sig { returns(T.nilable(Imagekit::OverlayTiming::Start::Variants)) } + sig { returns(T.nilable(Imagekitio::OverlayTiming::Start::Variants)) } attr_reader :start - sig { params(start: Imagekit::OverlayTiming::Start::Variants).void } + sig { params(start: Imagekitio::OverlayTiming::Start::Variants).void } attr_writer :start sig do params( - duration: Imagekit::OverlayTiming::Duration::Variants, - end_: Imagekit::OverlayTiming::End::Variants, - start: Imagekit::OverlayTiming::Start::Variants + duration: Imagekitio::OverlayTiming::Duration::Variants, + end_: Imagekitio::OverlayTiming::End::Variants, + start: Imagekitio::OverlayTiming::Start::Variants ).returns(T.attached_class) end def self.new( @@ -69,9 +71,9 @@ module Imagekit sig do override.returns( { - duration: Imagekit::OverlayTiming::Duration::Variants, - end_: Imagekit::OverlayTiming::End::Variants, - start: Imagekit::OverlayTiming::Start::Variants + duration: Imagekitio::OverlayTiming::Duration::Variants, + end_: Imagekitio::OverlayTiming::End::Variants, + start: Imagekitio::OverlayTiming::Start::Variants } ) end @@ -83,13 +85,13 @@ module Imagekit # 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. module Duration - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::OverlayTiming::Duration::Variants] + T::Array[Imagekitio::OverlayTiming::Duration::Variants] ) end def self.variants @@ -102,12 +104,12 @@ module Imagekit # 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. module End - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::OverlayTiming::End::Variants]) + override.returns(T::Array[Imagekitio::OverlayTiming::End::Variants]) end def self.variants end @@ -118,12 +120,12 @@ module Imagekit # `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. module Start - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::OverlayTiming::Start::Variants]) + override.returns(T::Array[Imagekitio::OverlayTiming::Start::Variants]) end def self.variants end diff --git a/rbi/imagekit/models/responsive_image_attributes.rbi b/rbi/imagekitio/models/responsive_image_attributes.rbi similarity index 91% rename from rbi/imagekit/models/responsive_image_attributes.rbi rename to rbi/imagekitio/models/responsive_image_attributes.rbi index bb3fb6f3..91cc9b04 100644 --- a/rbi/imagekit/models/responsive_image_attributes.rbi +++ b/rbi/imagekitio/models/responsive_image_attributes.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class ResponsiveImageAttributes < Imagekit::Internal::Type::BaseModel + class ResponsiveImageAttributes < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::ResponsiveImageAttributes, - Imagekit::Internal::AnyHash + Imagekitio::ResponsiveImageAttributes, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/solid_color_overlay.rbi b/rbi/imagekitio/models/solid_color_overlay.rbi similarity index 81% rename from rbi/imagekit/models/solid_color_overlay.rbi rename to rbi/imagekitio/models/solid_color_overlay.rbi index 54cbbac7..330abba1 100644 --- a/rbi/imagekit/models/solid_color_overlay.rbi +++ b/rbi/imagekitio/models/solid_color_overlay.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class SolidColorOverlay < Imagekit::Models::BaseOverlay + class SolidColorOverlay < Imagekitio::Models::BaseOverlay OrHash = T.type_alias do - T.any(Imagekit::SolidColorOverlay, Imagekit::Internal::AnyHash) + T.any(Imagekitio::SolidColorOverlay, Imagekitio::Internal::AnyHash) end # Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA @@ -24,14 +24,16 @@ module Imagekit # and # [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay). sig do - returns(T.nilable(T::Array[Imagekit::SolidColorOverlayTransformation])) + returns( + T.nilable(T::Array[Imagekitio::SolidColorOverlayTransformation]) + ) end attr_reader :transformation sig do params( transformation: - T::Array[Imagekit::SolidColorOverlayTransformation::OrHash] + T::Array[Imagekitio::SolidColorOverlayTransformation::OrHash] ).void end attr_writer :transformation @@ -40,7 +42,7 @@ module Imagekit params( color: String, transformation: - T::Array[Imagekit::SolidColorOverlayTransformation::OrHash], + T::Array[Imagekitio::SolidColorOverlayTransformation::OrHash], type: Symbol ).returns(T.attached_class) end @@ -65,7 +67,8 @@ module Imagekit { color: String, type: Symbol, - transformation: T::Array[Imagekit::SolidColorOverlayTransformation] + transformation: + T::Array[Imagekitio::SolidColorOverlayTransformation] } ) end diff --git a/rbi/imagekit/models/solid_color_overlay_transformation.rbi b/rbi/imagekitio/models/solid_color_overlay_transformation.rbi similarity index 81% rename from rbi/imagekit/models/solid_color_overlay_transformation.rbi rename to rbi/imagekitio/models/solid_color_overlay_transformation.rbi index 698a29f6..7c62ded4 100644 --- a/rbi/imagekit/models/solid_color_overlay_transformation.rbi +++ b/rbi/imagekitio/models/solid_color_overlay_transformation.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel + class SolidColorOverlayTransformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::SolidColorOverlayTransformation, - Imagekit::Internal::AnyHash + Imagekitio::SolidColorOverlayTransformation, + Imagekitio::Internal::AnyHash ) end @@ -42,14 +42,16 @@ module Imagekit # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). sig do returns( - T.nilable(Imagekit::SolidColorOverlayTransformation::Height::Variants) + T.nilable( + Imagekitio::SolidColorOverlayTransformation::Height::Variants + ) ) end attr_reader :height sig do params( - height: Imagekit::SolidColorOverlayTransformation::Height::Variants + height: Imagekitio::SolidColorOverlayTransformation::Height::Variants ).void end attr_writer :height @@ -68,14 +70,16 @@ module Imagekit # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). sig do returns( - T.nilable(Imagekit::SolidColorOverlayTransformation::Width::Variants) + T.nilable( + Imagekitio::SolidColorOverlayTransformation::Width::Variants + ) ) end attr_reader :width sig do params( - width: Imagekit::SolidColorOverlayTransformation::Width::Variants + width: Imagekitio::SolidColorOverlayTransformation::Width::Variants ).void end attr_writer :width @@ -85,9 +89,9 @@ module Imagekit alpha: Float, background: String, gradient: T.any(T::Boolean, String), - height: Imagekit::SolidColorOverlayTransformation::Height::Variants, + height: Imagekitio::SolidColorOverlayTransformation::Height::Variants, radius: T.any(Float, Symbol), - width: Imagekit::SolidColorOverlayTransformation::Width::Variants + width: Imagekitio::SolidColorOverlayTransformation::Width::Variants ).returns(T.attached_class) end def self.new( @@ -123,9 +127,10 @@ module Imagekit alpha: Float, background: String, gradient: T.any(T::Boolean, String), - height: Imagekit::SolidColorOverlayTransformation::Height::Variants, + height: + Imagekitio::SolidColorOverlayTransformation::Height::Variants, radius: T.any(Float, Symbol), - width: Imagekit::SolidColorOverlayTransformation::Width::Variants + width: Imagekitio::SolidColorOverlayTransformation::Width::Variants } ) end @@ -137,14 +142,14 @@ module Imagekit # image. See # [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). module Gradient - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns( T::Array[ - Imagekit::SolidColorOverlayTransformation::Gradient::Variants + Imagekitio::SolidColorOverlayTransformation::Gradient::Variants ] ) end @@ -156,14 +161,14 @@ module Imagekit # arithmetic expression. Learn about # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). module Height - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( T::Array[ - Imagekit::SolidColorOverlayTransformation::Height::Variants + Imagekitio::SolidColorOverlayTransformation::Height::Variants ] ) end @@ -175,14 +180,14 @@ module Imagekit # circular or oval shape. See # [radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). module Radius - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, Symbol) } sig do override.returns( T::Array[ - Imagekit::SolidColorOverlayTransformation::Radius::Variants + Imagekitio::SolidColorOverlayTransformation::Radius::Variants ] ) end @@ -194,13 +199,15 @@ module Imagekit # arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). module Width - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::SolidColorOverlayTransformation::Width::Variants] + T::Array[ + Imagekitio::SolidColorOverlayTransformation::Width::Variants + ] ) end def self.variants diff --git a/rbi/imagekit/models/src_options.rbi b/rbi/imagekitio/models/src_options.rbi similarity index 89% rename from rbi/imagekit/models/src_options.rbi rename to rbi/imagekitio/models/src_options.rbi index 30c5cdaf..53566396 100644 --- a/rbi/imagekit/models/src_options.rbi +++ b/rbi/imagekitio/models/src_options.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class SrcOptions < Imagekit::Internal::Type::BaseModel + class SrcOptions < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::SrcOptions, Imagekit::Internal::AnyHash) + T.any(Imagekitio::SrcOptions, Imagekitio::Internal::AnyHash) end # Accepts a relative or absolute path of the resource. If a relative path is @@ -59,11 +59,13 @@ module Imagekit # 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). - sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } + sig { returns(T.nilable(T::Array[Imagekitio::Transformation])) } attr_reader :transformation sig do - params(transformation: T::Array[Imagekit::Transformation::OrHash]).void + params( + transformation: T::Array[Imagekitio::Transformation::OrHash] + ).void end attr_writer :transformation @@ -71,12 +73,12 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::TransformationPosition::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::TransformationPosition::OrSymbol)) } attr_reader :transformation_position sig do params( - transformation_position: Imagekit::TransformationPosition::OrSymbol + transformation_position: Imagekitio::TransformationPosition::OrSymbol ).void end attr_writer :transformation_position @@ -90,8 +92,8 @@ module Imagekit expires_in: Float, query_parameters: T::Hash[Symbol, String], signed: T::Boolean, - transformation: T::Array[Imagekit::Transformation::OrHash], - transformation_position: Imagekit::TransformationPosition::OrSymbol + transformation: T::Array[Imagekitio::Transformation::OrHash], + transformation_position: Imagekitio::TransformationPosition::OrSymbol ).returns(T.attached_class) end def self.new( @@ -144,8 +146,9 @@ module Imagekit expires_in: Float, query_parameters: T::Hash[Symbol, String], signed: T::Boolean, - transformation: T::Array[Imagekit::Transformation], - transformation_position: Imagekit::TransformationPosition::OrSymbol + transformation: T::Array[Imagekitio::Transformation], + transformation_position: + Imagekitio::TransformationPosition::OrSymbol } ) end diff --git a/rbi/imagekitio/models/streaming_resolution.rbi b/rbi/imagekitio/models/streaming_resolution.rbi new file mode 100644 index 00000000..0509a040 --- /dev/null +++ b/rbi/imagekitio/models/streaming_resolution.rbi @@ -0,0 +1,38 @@ +# typed: strong + +module Imagekitio + module Models + # Available streaming resolutions for + # [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming) + module StreamingResolution + extend Imagekitio::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekitio::StreamingResolution) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + STREAMING_RESOLUTION_240 = + T.let(:"240", Imagekitio::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_360 = + T.let(:"360", Imagekitio::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_480 = + T.let(:"480", Imagekitio::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_720 = + T.let(:"720", Imagekitio::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_1080 = + T.let(:"1080", Imagekitio::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_1440 = + T.let(:"1440", Imagekitio::StreamingResolution::TaggedSymbol) + STREAMING_RESOLUTION_2160 = + T.let(:"2160", Imagekitio::StreamingResolution::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekitio::StreamingResolution::TaggedSymbol] + ) + end + def self.values + end + end + end +end diff --git a/rbi/imagekit/models/subtitle_overlay.rbi b/rbi/imagekitio/models/subtitle_overlay.rbi similarity index 69% rename from rbi/imagekit/models/subtitle_overlay.rbi rename to rbi/imagekitio/models/subtitle_overlay.rbi index baa166f0..dd1cb00a 100644 --- a/rbi/imagekit/models/subtitle_overlay.rbi +++ b/rbi/imagekitio/models/subtitle_overlay.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class SubtitleOverlay < Imagekit::Models::BaseOverlay + class SubtitleOverlay < Imagekitio::Models::BaseOverlay OrHash = T.type_alias do - T.any(Imagekit::SubtitleOverlay, Imagekit::Internal::AnyHash) + T.any(Imagekitio::SubtitleOverlay, Imagekitio::Internal::AnyHash) end # Specifies the relative path to the subtitle file used as an overlay. @@ -20,25 +20,27 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::SubtitleOverlay::Encoding::OrSymbol)) } + sig do + returns(T.nilable(Imagekitio::SubtitleOverlay::Encoding::OrSymbol)) + end attr_reader :encoding sig do - params(encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol).void + params(encoding: Imagekitio::SubtitleOverlay::Encoding::OrSymbol).void end attr_writer :encoding # Control styling of the subtitle. See # [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer). sig do - returns(T.nilable(T::Array[Imagekit::SubtitleOverlayTransformation])) + returns(T.nilable(T::Array[Imagekitio::SubtitleOverlayTransformation])) end attr_reader :transformation sig do params( transformation: - T::Array[Imagekit::SubtitleOverlayTransformation::OrHash] + T::Array[Imagekitio::SubtitleOverlayTransformation::OrHash] ).void end attr_writer :transformation @@ -46,9 +48,9 @@ module Imagekit sig do params( input: String, - encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol, + encoding: Imagekitio::SubtitleOverlay::Encoding::OrSymbol, transformation: - T::Array[Imagekit::SubtitleOverlayTransformation::OrHash], + T::Array[Imagekitio::SubtitleOverlayTransformation::OrHash], type: Symbol ).returns(T.attached_class) end @@ -73,8 +75,8 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::SubtitleOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::SubtitleOverlayTransformation] + encoding: Imagekitio::SubtitleOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekitio::SubtitleOverlayTransformation] } ) end @@ -87,20 +89,21 @@ module Imagekit # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. module Encoding - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::SubtitleOverlay::Encoding) } + T.type_alias { T.all(Symbol, Imagekitio::SubtitleOverlay::Encoding) } OrSymbol = T.type_alias { T.any(Symbol, String) } - AUTO = T.let(:auto, Imagekit::SubtitleOverlay::Encoding::TaggedSymbol) - PLAIN = T.let(:plain, Imagekit::SubtitleOverlay::Encoding::TaggedSymbol) + AUTO = T.let(:auto, Imagekitio::SubtitleOverlay::Encoding::TaggedSymbol) + PLAIN = + T.let(:plain, Imagekitio::SubtitleOverlay::Encoding::TaggedSymbol) BASE64 = - T.let(:base64, Imagekit::SubtitleOverlay::Encoding::TaggedSymbol) + T.let(:base64, Imagekitio::SubtitleOverlay::Encoding::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::SubtitleOverlay::Encoding::TaggedSymbol] + T::Array[Imagekitio::SubtitleOverlay::Encoding::TaggedSymbol] ) end def self.values diff --git a/rbi/imagekit/models/subtitle_overlay_transformation.rbi b/rbi/imagekitio/models/subtitle_overlay_transformation.rbi similarity index 89% rename from rbi/imagekit/models/subtitle_overlay_transformation.rbi rename to rbi/imagekitio/models/subtitle_overlay_transformation.rbi index 3ad34a2b..1c089c52 100644 --- a/rbi/imagekit/models/subtitle_overlay_transformation.rbi +++ b/rbi/imagekitio/models/subtitle_overlay_transformation.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel + class SubtitleOverlayTransformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::SubtitleOverlayTransformation, - Imagekit::Internal::AnyHash + Imagekitio::SubtitleOverlayTransformation, + Imagekitio::Internal::AnyHash ) end @@ -82,7 +82,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + Imagekitio::SubtitleOverlayTransformation::Typography::OrSymbol ) ) end @@ -91,7 +91,7 @@ module Imagekit sig do params( typography: - Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + Imagekitio::SubtitleOverlayTransformation::Typography::OrSymbol ).void end attr_writer :typography @@ -108,7 +108,7 @@ module Imagekit font_shadow: String, font_size: Float, typography: - Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + Imagekitio::SubtitleOverlayTransformation::Typography::OrSymbol ).returns(T.attached_class) end def self.new( @@ -164,7 +164,7 @@ module Imagekit font_shadow: String, font_size: Float, typography: - Imagekit::SubtitleOverlayTransformation::Typography::OrSymbol + Imagekitio::SubtitleOverlayTransformation::Typography::OrSymbol } ) end @@ -176,34 +176,34 @@ module Imagekit # # [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) module Typography - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::SubtitleOverlayTransformation::Typography) + T.all(Symbol, Imagekitio::SubtitleOverlayTransformation::Typography) end OrSymbol = T.type_alias { T.any(Symbol, String) } B = T.let( :b, - Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + Imagekitio::SubtitleOverlayTransformation::Typography::TaggedSymbol ) I = T.let( :i, - Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + Imagekitio::SubtitleOverlayTransformation::Typography::TaggedSymbol ) B_I = T.let( :b_i, - Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + Imagekitio::SubtitleOverlayTransformation::Typography::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::SubtitleOverlayTransformation::Typography::TaggedSymbol + Imagekitio::SubtitleOverlayTransformation::Typography::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/text_overlay.rbi b/rbi/imagekitio/models/text_overlay.rbi similarity index 68% rename from rbi/imagekit/models/text_overlay.rbi rename to rbi/imagekitio/models/text_overlay.rbi index 9ee9cb98..fe635400 100644 --- a/rbi/imagekit/models/text_overlay.rbi +++ b/rbi/imagekitio/models/text_overlay.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class TextOverlay < Imagekit::Models::BaseOverlay + class TextOverlay < Imagekitio::Models::BaseOverlay OrHash = T.type_alias do - T.any(Imagekit::TextOverlay, Imagekit::Internal::AnyHash) + T.any(Imagekitio::TextOverlay, Imagekitio::Internal::AnyHash) end # Specifies the text to be displayed in the overlay. The SDK automatically handles @@ -21,20 +21,23 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::TextOverlay::Encoding::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::TextOverlay::Encoding::OrSymbol)) } attr_reader :encoding - sig { params(encoding: Imagekit::TextOverlay::Encoding::OrSymbol).void } + sig { params(encoding: Imagekitio::TextOverlay::Encoding::OrSymbol).void } attr_writer :encoding # Control styling of the text overlay. See # [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay). - sig { returns(T.nilable(T::Array[Imagekit::TextOverlayTransformation])) } + sig do + returns(T.nilable(T::Array[Imagekitio::TextOverlayTransformation])) + end attr_reader :transformation sig do params( - transformation: T::Array[Imagekit::TextOverlayTransformation::OrHash] + transformation: + T::Array[Imagekitio::TextOverlayTransformation::OrHash] ).void end attr_writer :transformation @@ -42,8 +45,9 @@ module Imagekit sig do params( text: String, - encoding: Imagekit::TextOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::TextOverlayTransformation::OrHash], + encoding: Imagekitio::TextOverlay::Encoding::OrSymbol, + transformation: + T::Array[Imagekitio::TextOverlayTransformation::OrHash], type: Symbol ).returns(T.attached_class) end @@ -69,8 +73,8 @@ module Imagekit { text: String, type: Symbol, - encoding: Imagekit::TextOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::TextOverlayTransformation] + encoding: Imagekitio::TextOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekitio::TextOverlayTransformation] } ) end @@ -83,19 +87,19 @@ module Imagekit # (`ie-{base64}`), set this parameter to `base64`. To always use plain text # (`i-{input}`), set it to `plain`. module Encoding - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::TextOverlay::Encoding) } + T.type_alias { T.all(Symbol, Imagekitio::TextOverlay::Encoding) } OrSymbol = T.type_alias { T.any(Symbol, String) } - AUTO = T.let(:auto, Imagekit::TextOverlay::Encoding::TaggedSymbol) - PLAIN = T.let(:plain, Imagekit::TextOverlay::Encoding::TaggedSymbol) - BASE64 = T.let(:base64, Imagekit::TextOverlay::Encoding::TaggedSymbol) + AUTO = T.let(:auto, Imagekitio::TextOverlay::Encoding::TaggedSymbol) + PLAIN = T.let(:plain, Imagekitio::TextOverlay::Encoding::TaggedSymbol) + BASE64 = T.let(:base64, Imagekitio::TextOverlay::Encoding::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::TextOverlay::Encoding::TaggedSymbol] + T::Array[Imagekitio::TextOverlay::Encoding::TaggedSymbol] ) end def self.values diff --git a/rbi/imagekit/models/text_overlay_transformation.rbi b/rbi/imagekitio/models/text_overlay_transformation.rbi similarity index 73% rename from rbi/imagekit/models/text_overlay_transformation.rbi rename to rbi/imagekitio/models/text_overlay_transformation.rbi index a2ea165d..bc1f85b5 100644 --- a/rbi/imagekit/models/text_overlay_transformation.rbi +++ b/rbi/imagekitio/models/text_overlay_transformation.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel + class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::TextOverlayTransformation, - Imagekit::Internal::AnyHash + Imagekitio::TextOverlayTransformation, + Imagekitio::Internal::AnyHash ) end @@ -29,12 +29,14 @@ module Imagekit # Flip the text overlay horizontally, vertically, or both. sig do - returns(T.nilable(Imagekit::TextOverlayTransformation::Flip::OrSymbol)) + returns( + T.nilable(Imagekitio::TextOverlayTransformation::Flip::OrSymbol) + ) end attr_reader :flip sig do - params(flip: Imagekit::TextOverlayTransformation::Flip::OrSymbol).void + params(flip: Imagekitio::TextOverlayTransformation::Flip::OrSymbol).void end attr_writer :flip @@ -61,14 +63,14 @@ module Imagekit # arithmetic expression. sig do returns( - T.nilable(Imagekit::TextOverlayTransformation::FontSize::Variants) + T.nilable(Imagekitio::TextOverlayTransformation::FontSize::Variants) ) end attr_reader :font_size sig do params( - font_size: Imagekit::TextOverlayTransformation::FontSize::Variants + font_size: Imagekitio::TextOverlayTransformation::FontSize::Variants ).void end attr_writer :font_size @@ -78,7 +80,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol + Imagekitio::TextOverlayTransformation::InnerAlignment::OrSymbol ) ) end @@ -87,7 +89,7 @@ module Imagekit sig do params( inner_alignment: - Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol + Imagekitio::TextOverlayTransformation::InnerAlignment::OrSymbol ).void end attr_writer :inner_alignment @@ -98,14 +100,15 @@ module Imagekit # such as `bw_mul_0.2`, or `bh_div_20`. sig do returns( - T.nilable(Imagekit::TextOverlayTransformation::LineHeight::Variants) + T.nilable(Imagekitio::TextOverlayTransformation::LineHeight::Variants) ) end attr_reader :line_height sig do params( - line_height: Imagekit::TextOverlayTransformation::LineHeight::Variants + line_height: + Imagekitio::TextOverlayTransformation::LineHeight::Variants ).void end attr_writer :line_height @@ -115,14 +118,14 @@ module Imagekit # shorthand order). Arithmetic expressions are also accepted. sig do returns( - T.nilable(Imagekit::TextOverlayTransformation::Padding::Variants) + T.nilable(Imagekitio::TextOverlayTransformation::Padding::Variants) ) end attr_reader :padding sig do params( - padding: Imagekit::TextOverlayTransformation::Padding::Variants + padding: Imagekitio::TextOverlayTransformation::Padding::Variants ).void end attr_writer :padding @@ -139,14 +142,14 @@ module Imagekit # clockwise rotation or a string prefixed with "N" for counter-clockwise rotation. sig do returns( - T.nilable(Imagekit::TextOverlayTransformation::Rotation::Variants) + T.nilable(Imagekitio::TextOverlayTransformation::Rotation::Variants) ) end attr_reader :rotation sig do params( - rotation: Imagekit::TextOverlayTransformation::Rotation::Variants + rotation: Imagekitio::TextOverlayTransformation::Rotation::Variants ).void end attr_writer :rotation @@ -167,12 +170,16 @@ module Imagekit # supported. Useful when used in conjunction with the `background`. Learn about # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). sig do - returns(T.nilable(Imagekit::TextOverlayTransformation::Width::Variants)) + returns( + T.nilable(Imagekitio::TextOverlayTransformation::Width::Variants) + ) end attr_reader :width sig do - params(width: Imagekit::TextOverlayTransformation::Width::Variants).void + params( + width: Imagekitio::TextOverlayTransformation::Width::Variants + ).void end attr_writer :width @@ -180,19 +187,19 @@ module Imagekit params( alpha: Float, background: String, - flip: Imagekit::TextOverlayTransformation::Flip::OrSymbol, + flip: Imagekitio::TextOverlayTransformation::Flip::OrSymbol, font_color: String, font_family: String, - font_size: Imagekit::TextOverlayTransformation::FontSize::Variants, + font_size: Imagekitio::TextOverlayTransformation::FontSize::Variants, inner_alignment: - Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol, + Imagekitio::TextOverlayTransformation::InnerAlignment::OrSymbol, line_height: - Imagekit::TextOverlayTransformation::LineHeight::Variants, - padding: Imagekit::TextOverlayTransformation::Padding::Variants, + Imagekitio::TextOverlayTransformation::LineHeight::Variants, + padding: Imagekitio::TextOverlayTransformation::Padding::Variants, radius: T.any(Float, Symbol), - rotation: Imagekit::TextOverlayTransformation::Rotation::Variants, + rotation: Imagekitio::TextOverlayTransformation::Rotation::Variants, typography: String, - width: Imagekit::TextOverlayTransformation::Width::Variants + width: Imagekitio::TextOverlayTransformation::Width::Variants ).returns(T.attached_class) end def self.new( @@ -253,19 +260,20 @@ module Imagekit { alpha: Float, background: String, - flip: Imagekit::TextOverlayTransformation::Flip::OrSymbol, + flip: Imagekitio::TextOverlayTransformation::Flip::OrSymbol, font_color: String, font_family: String, - font_size: Imagekit::TextOverlayTransformation::FontSize::Variants, + font_size: + Imagekitio::TextOverlayTransformation::FontSize::Variants, inner_alignment: - Imagekit::TextOverlayTransformation::InnerAlignment::OrSymbol, + Imagekitio::TextOverlayTransformation::InnerAlignment::OrSymbol, line_height: - Imagekit::TextOverlayTransformation::LineHeight::Variants, - padding: Imagekit::TextOverlayTransformation::Padding::Variants, + Imagekitio::TextOverlayTransformation::LineHeight::Variants, + padding: Imagekitio::TextOverlayTransformation::Padding::Variants, radius: T.any(Float, Symbol), - rotation: Imagekit::TextOverlayTransformation::Rotation::Variants, + rotation: Imagekitio::TextOverlayTransformation::Rotation::Variants, typography: String, - width: Imagekit::TextOverlayTransformation::Width::Variants + width: Imagekitio::TextOverlayTransformation::Width::Variants } ) end @@ -274,24 +282,24 @@ module Imagekit # Flip the text overlay horizontally, vertically, or both. module Flip - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::TextOverlayTransformation::Flip) + T.all(Symbol, Imagekitio::TextOverlayTransformation::Flip) end OrSymbol = T.type_alias { T.any(Symbol, String) } - H = T.let(:h, Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) - V = T.let(:v, Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) + H = T.let(:h, Imagekitio::TextOverlayTransformation::Flip::TaggedSymbol) + V = T.let(:v, Imagekitio::TextOverlayTransformation::Flip::TaggedSymbol) H_V = - T.let(:h_v, Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) + T.let(:h_v, Imagekitio::TextOverlayTransformation::Flip::TaggedSymbol) V_H = - T.let(:v_h, Imagekit::TextOverlayTransformation::Flip::TaggedSymbol) + T.let(:v_h, Imagekitio::TextOverlayTransformation::Flip::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::TextOverlayTransformation::Flip::TaggedSymbol] + T::Array[Imagekitio::TextOverlayTransformation::Flip::TaggedSymbol] ) end def self.values @@ -301,13 +309,13 @@ module Imagekit # Specifies the font size of the overlaid text. Accepts a numeric value or an # arithmetic expression. module FontSize - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::TextOverlayTransformation::FontSize::Variants] + T::Array[Imagekitio::TextOverlayTransformation::FontSize::Variants] ) end def self.variants @@ -317,34 +325,34 @@ module Imagekit # Specifies the inner alignment of the text when width is more than the text # length. module InnerAlignment - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, Imagekit::TextOverlayTransformation::InnerAlignment) + T.all(Symbol, Imagekitio::TextOverlayTransformation::InnerAlignment) end OrSymbol = T.type_alias { T.any(Symbol, String) } LEFT = T.let( :left, - Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + Imagekitio::TextOverlayTransformation::InnerAlignment::TaggedSymbol ) RIGHT = T.let( :right, - Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + Imagekitio::TextOverlayTransformation::InnerAlignment::TaggedSymbol ) CENTER = T.let( :center, - Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + Imagekitio::TextOverlayTransformation::InnerAlignment::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::TextOverlayTransformation::InnerAlignment::TaggedSymbol + Imagekitio::TextOverlayTransformation::InnerAlignment::TaggedSymbol ] ) end @@ -357,13 +365,15 @@ module Imagekit # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations) # such as `bw_mul_0.2`, or `bh_div_20`. module LineHeight - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::TextOverlayTransformation::LineHeight::Variants] + T::Array[ + Imagekitio::TextOverlayTransformation::LineHeight::Variants + ] ) end def self.variants @@ -374,13 +384,13 @@ module Imagekit # positive integer or multiple values separated by underscores (following CSS # shorthand order). Arithmetic expressions are also accepted. module Padding - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::TextOverlayTransformation::Padding::Variants] + T::Array[Imagekitio::TextOverlayTransformation::Padding::Variants] ) end def self.variants @@ -390,13 +400,13 @@ module Imagekit # Specifies the corner radius of the text overlay. Set to `max` to achieve a # circular or oval shape. module Radius - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, Symbol) } sig do override.returns( - T::Array[Imagekit::TextOverlayTransformation::Radius::Variants] + T::Array[Imagekitio::TextOverlayTransformation::Radius::Variants] ) end def self.variants @@ -406,13 +416,13 @@ module Imagekit # 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. module Rotation - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::TextOverlayTransformation::Rotation::Variants] + T::Array[Imagekitio::TextOverlayTransformation::Rotation::Variants] ) end def self.variants @@ -424,13 +434,13 @@ module Imagekit # supported. Useful when used in conjunction with the `background`. Learn about # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). module Width - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::TextOverlayTransformation::Width::Variants] + T::Array[Imagekitio::TextOverlayTransformation::Width::Variants] ) end def self.variants diff --git a/rbi/imagekit/models/transformation.rbi b/rbi/imagekitio/models/transformation.rbi similarity index 78% rename from rbi/imagekit/models/transformation.rbi rename to rbi/imagekitio/models/transformation.rbi index 2c0f7137..0978362b 100644 --- a/rbi/imagekit/models/transformation.rbi +++ b/rbi/imagekitio/models/transformation.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::Transformation, Imagekit::Internal::AnyHash) + T.any(Imagekitio::Transformation, Imagekitio::Internal::AnyHash) end # Uses AI to change the background. Provide a text prompt or a base64-encoded @@ -44,7 +44,7 @@ module Imagekit # [AI Background Removal](https://imagekit.io/docs/ai-transformations#imagekit-background-removal-e-bgremove). sig do returns( - T.nilable(Imagekit::Transformation::AIRemoveBackground::OrBoolean) + T.nilable(Imagekitio::Transformation::AIRemoveBackground::OrBoolean) ) end attr_reader :ai_remove_background @@ -52,7 +52,7 @@ module Imagekit sig do params( ai_remove_background: - Imagekit::Transformation::AIRemoveBackground::OrBoolean + Imagekitio::Transformation::AIRemoveBackground::OrBoolean ).void end attr_writer :ai_remove_background @@ -64,7 +64,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean + Imagekitio::Transformation::AIRemoveBackgroundExternal::OrBoolean ) ) end @@ -73,7 +73,7 @@ module Imagekit sig do params( ai_remove_background_external: - Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean + Imagekitio::Transformation::AIRemoveBackgroundExternal::OrBoolean ).void end attr_writer :ai_remove_background_external @@ -81,22 +81,30 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::AIRetouch::OrBoolean)) } + sig do + returns(T.nilable(Imagekitio::Transformation::AIRetouch::OrBoolean)) + end attr_reader :ai_retouch sig do - params(ai_retouch: Imagekit::Transformation::AIRetouch::OrBoolean).void + params( + ai_retouch: Imagekitio::Transformation::AIRetouch::OrBoolean + ).void end attr_writer :ai_retouch # Upscales images beyond their original dimensions using AI. Not supported inside # overlay. See # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). - sig { returns(T.nilable(Imagekit::Transformation::AIUpscale::OrBoolean)) } + sig do + returns(T.nilable(Imagekitio::Transformation::AIUpscale::OrBoolean)) + end attr_reader :ai_upscale sig do - params(ai_upscale: Imagekit::Transformation::AIUpscale::OrBoolean).void + params( + ai_upscale: Imagekitio::Transformation::AIUpscale::OrBoolean + ).void end attr_writer :ai_upscale @@ -106,13 +114,13 @@ module Imagekit # original image. Not supported inside overlay. See # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). sig do - returns(T.nilable(Imagekit::Transformation::AIVariation::OrBoolean)) + returns(T.nilable(Imagekitio::Transformation::AIVariation::OrBoolean)) end attr_reader :ai_variation sig do params( - ai_variation: Imagekit::Transformation::AIVariation::OrBoolean + ai_variation: Imagekitio::Transformation::AIVariation::OrBoolean ).void end attr_writer :ai_variation @@ -122,24 +130,28 @@ module Imagekit # 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). sig do - returns(T.nilable(Imagekit::Transformation::AspectRatio::Variants)) + returns(T.nilable(Imagekitio::Transformation::AspectRatio::Variants)) end attr_reader :aspect_ratio sig do params( - aspect_ratio: Imagekit::Transformation::AspectRatio::Variants + aspect_ratio: Imagekitio::Transformation::AspectRatio::Variants ).void end attr_writer :aspect_ratio # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). - sig { returns(T.nilable(Imagekit::Transformation::AudioCodec::OrSymbol)) } + sig do + returns(T.nilable(Imagekitio::Transformation::AudioCodec::OrSymbol)) + end attr_reader :audio_codec sig do - params(audio_codec: Imagekit::Transformation::AudioCodec::OrSymbol).void + params( + audio_codec: Imagekitio::Transformation::AudioCodec::OrSymbol + ).void end attr_writer :audio_codec @@ -191,32 +203,35 @@ module Imagekit # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). sig do - returns(T.nilable(Imagekit::Transformation::ContrastStretch::OrBoolean)) + returns( + T.nilable(Imagekitio::Transformation::ContrastStretch::OrBoolean) + ) end attr_reader :contrast_stretch sig do params( - contrast_stretch: Imagekit::Transformation::ContrastStretch::OrBoolean + contrast_stretch: + Imagekitio::Transformation::ContrastStretch::OrBoolean ).void end attr_writer :contrast_stretch # Crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). - sig { returns(T.nilable(Imagekit::Transformation::Crop::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::Transformation::Crop::OrSymbol)) } attr_reader :crop - sig { params(crop: Imagekit::Transformation::Crop::OrSymbol).void } + sig { params(crop: Imagekitio::Transformation::Crop::OrSymbol).void } attr_writer :crop # Additional crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). - sig { returns(T.nilable(Imagekit::Transformation::CropMode::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::Transformation::CropMode::OrSymbol)) } attr_reader :crop_mode sig do - params(crop_mode: Imagekit::Transformation::CropMode::OrSymbol).void + params(crop_mode: Imagekitio::Transformation::CropMode::OrSymbol).void end attr_writer :crop_mode @@ -242,11 +257,11 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::Duration::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::Duration::Variants)) } attr_reader :duration sig do - params(duration: Imagekit::Transformation::Duration::Variants).void + params(duration: Imagekitio::Transformation::Duration::Variants).void end attr_writer :duration @@ -254,21 +269,23 @@ module Imagekit # 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). - sig { returns(T.nilable(Imagekit::Transformation::EndOffset::Variants)) } + sig do + returns(T.nilable(Imagekitio::Transformation::EndOffset::Variants)) + end attr_reader :end_offset sig do - params(end_offset: Imagekit::Transformation::EndOffset::Variants).void + params(end_offset: Imagekitio::Transformation::EndOffset::Variants).void end attr_writer :end_offset # 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). - sig { returns(T.nilable(Imagekit::Transformation::Flip::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::Transformation::Flip::OrSymbol)) } attr_reader :flip - sig { params(flip: Imagekit::Transformation::Flip::OrSymbol).void } + sig { params(flip: Imagekitio::Transformation::Flip::OrSymbol).void } attr_writer :flip # Refines padding and cropping behavior for pad resize, maintain ratio, and @@ -292,10 +309,10 @@ module Imagekit # format parameter. See # [Image format](https://imagekit.io/docs/image-optimization#format---f) and # [Video format](https://imagekit.io/docs/video-optimization#format---f). - sig { returns(T.nilable(Imagekit::Transformation::Format::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::Transformation::Format::OrSymbol)) } attr_reader :format_ - sig { params(format_: Imagekit::Transformation::Format::OrSymbol).void } + sig { params(format_: Imagekitio::Transformation::Format::OrSymbol).void } attr_writer :format_ # Creates a linear gradient with two colors. Pass `true` for a default gradient, @@ -309,11 +326,13 @@ module Imagekit # Enables a grayscale effect for images. See # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). - sig { returns(T.nilable(Imagekit::Transformation::Grayscale::OrBoolean)) } + sig do + returns(T.nilable(Imagekitio::Transformation::Grayscale::OrBoolean)) + end attr_reader :grayscale sig do - params(grayscale: Imagekit::Transformation::Grayscale::OrBoolean).void + params(grayscale: Imagekitio::Transformation::Grayscale::OrBoolean).void end attr_writer :grayscale @@ -323,10 +342,10 @@ module Imagekit # transformation – # [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · # [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h) - sig { returns(T.nilable(Imagekit::Transformation::Height::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::Height::Variants)) } attr_reader :height - sig { params(height: Imagekit::Transformation::Height::Variants).void } + sig { params(height: Imagekitio::Transformation::Height::Variants).void } attr_writer :height # Specifies whether the output image (in JPEG or PNG) should be compressed @@ -376,20 +395,20 @@ module Imagekit # supports overlays including images, text, videos, subtitles, and solid colors. # See # [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers). - sig { returns(T.nilable(Imagekit::Overlay)) } + sig { returns(T.nilable(Imagekitio::Overlay)) } attr_reader :overlay - sig { params(overlay: Imagekit::Overlay).void } + sig { params(overlay: Imagekitio::Overlay).void } attr_writer :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). - sig { returns(T.nilable(Imagekit::Transformation::Page::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::Page::Variants)) } attr_reader :page - sig { params(page: Imagekit::Transformation::Page::Variants).void } + sig { params(page: Imagekitio::Transformation::Page::Variants).void } attr_writer :page # Specifies whether the output JPEG image should be rendered progressively. @@ -434,11 +453,11 @@ module Imagekit # `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). - sig { returns(T.nilable(Imagekit::Transformation::Rotation::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::Rotation::Variants)) } attr_reader :rotation sig do - params(rotation: Imagekit::Transformation::Rotation::Variants).void + params(rotation: Imagekitio::Transformation::Rotation::Variants).void end attr_writer :rotation @@ -465,13 +484,13 @@ module Imagekit # `10.5`. Arithmetic expressions are also supported. See # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). sig do - returns(T.nilable(Imagekit::Transformation::StartOffset::Variants)) + returns(T.nilable(Imagekitio::Transformation::StartOffset::Variants)) end attr_reader :start_offset sig do params( - start_offset: Imagekit::Transformation::StartOffset::Variants + start_offset: Imagekitio::Transformation::StartOffset::Variants ).void end attr_writer :start_offset @@ -480,14 +499,14 @@ module Imagekit # `480`, `720`, `1080`]. See # [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). sig do - returns(T.nilable(T::Array[Imagekit::StreamingResolution::OrSymbol])) + returns(T.nilable(T::Array[Imagekitio::StreamingResolution::OrSymbol])) end attr_reader :streaming_resolutions sig do params( streaming_resolutions: - T::Array[Imagekit::StreamingResolution::OrSymbol] + T::Array[Imagekitio::StreamingResolution::OrSymbol] ).void end attr_writer :streaming_resolutions @@ -513,11 +532,15 @@ module Imagekit # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). - sig { returns(T.nilable(Imagekit::Transformation::VideoCodec::OrSymbol)) } + sig do + returns(T.nilable(Imagekitio::Transformation::VideoCodec::OrSymbol)) + end attr_reader :video_codec sig do - params(video_codec: Imagekit::Transformation::VideoCodec::OrSymbol).void + params( + video_codec: Imagekitio::Transformation::VideoCodec::OrSymbol + ).void end attr_writer :video_codec @@ -526,42 +549,46 @@ module Imagekit # 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) - sig { returns(T.nilable(Imagekit::Transformation::Width::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::Width::Variants)) } attr_reader :width - sig { params(width: Imagekit::Transformation::Width::Variants).void } + sig { params(width: Imagekitio::Transformation::Width::Variants).void } attr_writer :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). - sig { returns(T.nilable(Imagekit::Transformation::X::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::X::Variants)) } attr_reader :x - sig { params(x: Imagekit::Transformation::X::Variants).void } + sig { params(x: Imagekitio::Transformation::X::Variants).void } attr_writer :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). - sig { returns(T.nilable(Imagekit::Transformation::XCenter::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::XCenter::Variants)) } attr_reader :x_center - sig { params(x_center: Imagekit::Transformation::XCenter::Variants).void } + sig do + params(x_center: Imagekitio::Transformation::XCenter::Variants).void + end attr_writer :x_center # 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). - sig { returns(T.nilable(Imagekit::Transformation::Y::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::Y::Variants)) } attr_reader :y_ - sig { params(y_: Imagekit::Transformation::Y::Variants).void } + sig { params(y_: Imagekitio::Transformation::Y::Variants).void } attr_writer :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). - sig { returns(T.nilable(Imagekit::Transformation::YCenter::Variants)) } + sig { returns(T.nilable(Imagekitio::Transformation::YCenter::Variants)) } attr_reader :y_center - sig { params(y_center: Imagekit::Transformation::YCenter::Variants).void } + sig do + params(y_center: Imagekitio::Transformation::YCenter::Variants).void + end attr_writer :y_center # Accepts a numeric value that determines how much to zoom in or out of the @@ -585,57 +612,57 @@ module Imagekit ai_drop_shadow: T.any(T::Boolean, String), ai_edit: String, ai_remove_background: - Imagekit::Transformation::AIRemoveBackground::OrBoolean, + Imagekitio::Transformation::AIRemoveBackground::OrBoolean, ai_remove_background_external: - Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean, - ai_retouch: Imagekit::Transformation::AIRetouch::OrBoolean, - ai_upscale: Imagekit::Transformation::AIUpscale::OrBoolean, - ai_variation: Imagekit::Transformation::AIVariation::OrBoolean, - aspect_ratio: Imagekit::Transformation::AspectRatio::Variants, - audio_codec: Imagekit::Transformation::AudioCodec::OrSymbol, + Imagekitio::Transformation::AIRemoveBackgroundExternal::OrBoolean, + ai_retouch: Imagekitio::Transformation::AIRetouch::OrBoolean, + ai_upscale: Imagekitio::Transformation::AIUpscale::OrBoolean, + ai_variation: Imagekitio::Transformation::AIVariation::OrBoolean, + aspect_ratio: Imagekitio::Transformation::AspectRatio::Variants, + audio_codec: Imagekitio::Transformation::AudioCodec::OrSymbol, background: String, blur: Float, border: String, color_profile: T::Boolean, contrast_stretch: - Imagekit::Transformation::ContrastStretch::OrBoolean, - crop: Imagekit::Transformation::Crop::OrSymbol, - crop_mode: Imagekit::Transformation::CropMode::OrSymbol, + Imagekitio::Transformation::ContrastStretch::OrBoolean, + crop: Imagekitio::Transformation::Crop::OrSymbol, + crop_mode: Imagekitio::Transformation::CropMode::OrSymbol, default_image: String, dpr: Float, - duration: Imagekit::Transformation::Duration::Variants, - end_offset: Imagekit::Transformation::EndOffset::Variants, - flip: Imagekit::Transformation::Flip::OrSymbol, + duration: Imagekitio::Transformation::Duration::Variants, + end_offset: Imagekitio::Transformation::EndOffset::Variants, + flip: Imagekitio::Transformation::Flip::OrSymbol, focus: String, - format_: Imagekit::Transformation::Format::OrSymbol, + format_: Imagekitio::Transformation::Format::OrSymbol, gradient: T.any(T::Boolean, String), - grayscale: Imagekit::Transformation::Grayscale::OrBoolean, - height: Imagekit::Transformation::Height::Variants, + grayscale: Imagekitio::Transformation::Grayscale::OrBoolean, + height: Imagekitio::Transformation::Height::Variants, lossless: T::Boolean, metadata: T::Boolean, named: String, opacity: Float, original: T::Boolean, - overlay: Imagekit::Overlay, - page: Imagekit::Transformation::Page::Variants, + overlay: Imagekitio::Overlay, + page: Imagekitio::Transformation::Page::Variants, progressive: T::Boolean, quality: Float, radius: T.any(Float, Symbol), raw: String, - rotation: Imagekit::Transformation::Rotation::Variants, + rotation: Imagekitio::Transformation::Rotation::Variants, shadow: T.any(T::Boolean, String), sharpen: T.any(T::Boolean, Float), - start_offset: Imagekit::Transformation::StartOffset::Variants, + start_offset: Imagekitio::Transformation::StartOffset::Variants, streaming_resolutions: - T::Array[Imagekit::StreamingResolution::OrSymbol], + T::Array[Imagekitio::StreamingResolution::OrSymbol], trim: T.any(T::Boolean, Float), unsharp_mask: T.any(T::Boolean, String), - video_codec: Imagekit::Transformation::VideoCodec::OrSymbol, - width: Imagekit::Transformation::Width::Variants, - x: Imagekit::Transformation::X::Variants, - x_center: Imagekit::Transformation::XCenter::Variants, - y_: Imagekit::Transformation::Y::Variants, - y_center: Imagekit::Transformation::YCenter::Variants, + video_codec: Imagekitio::Transformation::VideoCodec::OrSymbol, + width: Imagekitio::Transformation::Width::Variants, + x: Imagekitio::Transformation::X::Variants, + x_center: Imagekitio::Transformation::XCenter::Variants, + y_: Imagekitio::Transformation::Y::Variants, + y_center: Imagekitio::Transformation::YCenter::Variants, zoom: Float ).returns(T.attached_class) end @@ -886,57 +913,57 @@ module Imagekit ai_drop_shadow: T.any(T::Boolean, String), ai_edit: String, ai_remove_background: - Imagekit::Transformation::AIRemoveBackground::OrBoolean, + Imagekitio::Transformation::AIRemoveBackground::OrBoolean, ai_remove_background_external: - Imagekit::Transformation::AIRemoveBackgroundExternal::OrBoolean, - ai_retouch: Imagekit::Transformation::AIRetouch::OrBoolean, - ai_upscale: Imagekit::Transformation::AIUpscale::OrBoolean, - ai_variation: Imagekit::Transformation::AIVariation::OrBoolean, - aspect_ratio: Imagekit::Transformation::AspectRatio::Variants, - audio_codec: Imagekit::Transformation::AudioCodec::OrSymbol, + Imagekitio::Transformation::AIRemoveBackgroundExternal::OrBoolean, + ai_retouch: Imagekitio::Transformation::AIRetouch::OrBoolean, + ai_upscale: Imagekitio::Transformation::AIUpscale::OrBoolean, + ai_variation: Imagekitio::Transformation::AIVariation::OrBoolean, + aspect_ratio: Imagekitio::Transformation::AspectRatio::Variants, + audio_codec: Imagekitio::Transformation::AudioCodec::OrSymbol, background: String, blur: Float, border: String, color_profile: T::Boolean, contrast_stretch: - Imagekit::Transformation::ContrastStretch::OrBoolean, - crop: Imagekit::Transformation::Crop::OrSymbol, - crop_mode: Imagekit::Transformation::CropMode::OrSymbol, + Imagekitio::Transformation::ContrastStretch::OrBoolean, + crop: Imagekitio::Transformation::Crop::OrSymbol, + crop_mode: Imagekitio::Transformation::CropMode::OrSymbol, default_image: String, dpr: Float, - duration: Imagekit::Transformation::Duration::Variants, - end_offset: Imagekit::Transformation::EndOffset::Variants, - flip: Imagekit::Transformation::Flip::OrSymbol, + duration: Imagekitio::Transformation::Duration::Variants, + end_offset: Imagekitio::Transformation::EndOffset::Variants, + flip: Imagekitio::Transformation::Flip::OrSymbol, focus: String, - format_: Imagekit::Transformation::Format::OrSymbol, + format_: Imagekitio::Transformation::Format::OrSymbol, gradient: T.any(T::Boolean, String), - grayscale: Imagekit::Transformation::Grayscale::OrBoolean, - height: Imagekit::Transformation::Height::Variants, + grayscale: Imagekitio::Transformation::Grayscale::OrBoolean, + height: Imagekitio::Transformation::Height::Variants, lossless: T::Boolean, metadata: T::Boolean, named: String, opacity: Float, original: T::Boolean, - overlay: Imagekit::Overlay, - page: Imagekit::Transformation::Page::Variants, + overlay: Imagekitio::Overlay, + page: Imagekitio::Transformation::Page::Variants, progressive: T::Boolean, quality: Float, radius: T.any(Float, Symbol), raw: String, - rotation: Imagekit::Transformation::Rotation::Variants, + rotation: Imagekitio::Transformation::Rotation::Variants, shadow: T.any(T::Boolean, String), sharpen: T.any(T::Boolean, Float), - start_offset: Imagekit::Transformation::StartOffset::Variants, + start_offset: Imagekitio::Transformation::StartOffset::Variants, streaming_resolutions: - T::Array[Imagekit::StreamingResolution::OrSymbol], + T::Array[Imagekitio::StreamingResolution::OrSymbol], trim: T.any(T::Boolean, Float), unsharp_mask: T.any(T::Boolean, String), - video_codec: Imagekit::Transformation::VideoCodec::OrSymbol, - width: Imagekit::Transformation::Width::Variants, - x: Imagekit::Transformation::X::Variants, - x_center: Imagekit::Transformation::XCenter::Variants, - y_: Imagekit::Transformation::Y::Variants, - y_center: Imagekit::Transformation::YCenter::Variants, + video_codec: Imagekitio::Transformation::VideoCodec::OrSymbol, + width: Imagekitio::Transformation::Width::Variants, + x: Imagekitio::Transformation::X::Variants, + x_center: Imagekitio::Transformation::XCenter::Variants, + y_: Imagekitio::Transformation::Y::Variants, + y_center: Imagekitio::Transformation::YCenter::Variants, zoom: Float } ) @@ -951,13 +978,13 @@ module Imagekit # inside overlay. See # [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). module AIDropShadow - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns( - T::Array[Imagekit::Transformation::AIDropShadow::Variants] + T::Array[Imagekitio::Transformation::AIDropShadow::Variants] ) end def self.variants @@ -967,24 +994,24 @@ module Imagekit # 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). module AIRemoveBackground - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedBoolean = T.type_alias do - T.all(T::Boolean, Imagekit::Transformation::AIRemoveBackground) + T.all(T::Boolean, Imagekitio::Transformation::AIRemoveBackground) end OrBoolean = T.type_alias { T::Boolean } TRUE = T.let( true, - Imagekit::Transformation::AIRemoveBackground::TaggedBoolean + Imagekitio::Transformation::AIRemoveBackground::TaggedBoolean ) sig do override.returns( T::Array[ - Imagekit::Transformation::AIRemoveBackground::TaggedBoolean + Imagekitio::Transformation::AIRemoveBackground::TaggedBoolean ] ) end @@ -997,13 +1024,13 @@ module Imagekit # Supported inside overlay. See # [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). module AIRemoveBackgroundExternal - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedBoolean = T.type_alias do T.all( T::Boolean, - Imagekit::Transformation::AIRemoveBackgroundExternal + Imagekitio::Transformation::AIRemoveBackgroundExternal ) end OrBoolean = T.type_alias { T::Boolean } @@ -1011,13 +1038,13 @@ module Imagekit TRUE = T.let( true, - Imagekit::Transformation::AIRemoveBackgroundExternal::TaggedBoolean + Imagekitio::Transformation::AIRemoveBackgroundExternal::TaggedBoolean ) sig do override.returns( T::Array[ - Imagekit::Transformation::AIRemoveBackgroundExternal::TaggedBoolean + Imagekitio::Transformation::AIRemoveBackgroundExternal::TaggedBoolean ] ) end @@ -1029,19 +1056,19 @@ module Imagekit # inside overlay. See # [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). module AIRetouch - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedBoolean = T.type_alias do - T.all(T::Boolean, Imagekit::Transformation::AIRetouch) + T.all(T::Boolean, Imagekitio::Transformation::AIRetouch) end OrBoolean = T.type_alias { T::Boolean } - TRUE = T.let(true, Imagekit::Transformation::AIRetouch::TaggedBoolean) + TRUE = T.let(true, Imagekitio::Transformation::AIRetouch::TaggedBoolean) sig do override.returns( - T::Array[Imagekit::Transformation::AIRetouch::TaggedBoolean] + T::Array[Imagekitio::Transformation::AIRetouch::TaggedBoolean] ) end def self.values @@ -1052,19 +1079,19 @@ module Imagekit # overlay. See # [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). module AIUpscale - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedBoolean = T.type_alias do - T.all(T::Boolean, Imagekit::Transformation::AIUpscale) + T.all(T::Boolean, Imagekitio::Transformation::AIUpscale) end OrBoolean = T.type_alias { T::Boolean } - TRUE = T.let(true, Imagekit::Transformation::AIUpscale::TaggedBoolean) + TRUE = T.let(true, Imagekitio::Transformation::AIUpscale::TaggedBoolean) sig do override.returns( - T::Array[Imagekit::Transformation::AIUpscale::TaggedBoolean] + T::Array[Imagekitio::Transformation::AIUpscale::TaggedBoolean] ) end def self.values @@ -1077,19 +1104,20 @@ module Imagekit # original image. Not supported inside overlay. See # [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). module AIVariation - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedBoolean = T.type_alias do - T.all(T::Boolean, Imagekit::Transformation::AIVariation) + T.all(T::Boolean, Imagekitio::Transformation::AIVariation) end OrBoolean = T.type_alias { T::Boolean } - TRUE = T.let(true, Imagekit::Transformation::AIVariation::TaggedBoolean) + TRUE = + T.let(true, Imagekitio::Transformation::AIVariation::TaggedBoolean) sig do override.returns( - T::Array[Imagekit::Transformation::AIVariation::TaggedBoolean] + T::Array[Imagekitio::Transformation::AIVariation::TaggedBoolean] ) end def self.values @@ -1101,13 +1129,13 @@ module Imagekit # 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). module AspectRatio - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::Transformation::AspectRatio::Variants] + T::Array[Imagekitio::Transformation::AspectRatio::Variants] ) end def self.variants @@ -1117,19 +1145,21 @@ module Imagekit # Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See # [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). module AudioCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::Transformation::AudioCodec) } + T.type_alias { T.all(Symbol, Imagekitio::Transformation::AudioCodec) } OrSymbol = T.type_alias { T.any(Symbol, String) } - AAC = T.let(:aac, Imagekit::Transformation::AudioCodec::TaggedSymbol) - OPUS = T.let(:opus, Imagekit::Transformation::AudioCodec::TaggedSymbol) - NONE = T.let(:none, Imagekit::Transformation::AudioCodec::TaggedSymbol) + AAC = T.let(:aac, Imagekitio::Transformation::AudioCodec::TaggedSymbol) + OPUS = + T.let(:opus, Imagekitio::Transformation::AudioCodec::TaggedSymbol) + NONE = + T.let(:none, Imagekitio::Transformation::AudioCodec::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::Transformation::AudioCodec::TaggedSymbol] + T::Array[Imagekitio::Transformation::AudioCodec::TaggedSymbol] ) end def self.values @@ -1139,20 +1169,23 @@ module Imagekit # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). module ContrastStretch - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedBoolean = T.type_alias do - T.all(T::Boolean, Imagekit::Transformation::ContrastStretch) + T.all(T::Boolean, Imagekitio::Transformation::ContrastStretch) end OrBoolean = T.type_alias { T::Boolean } TRUE = - T.let(true, Imagekit::Transformation::ContrastStretch::TaggedBoolean) + T.let( + true, + Imagekitio::Transformation::ContrastStretch::TaggedBoolean + ) sig do override.returns( - T::Array[Imagekit::Transformation::ContrastStretch::TaggedBoolean] + T::Array[Imagekitio::Transformation::ContrastStretch::TaggedBoolean] ) end def self.values @@ -1162,24 +1195,24 @@ module Imagekit # Crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). module Crop - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::Transformation::Crop) } + T.type_alias { T.all(Symbol, Imagekitio::Transformation::Crop) } OrSymbol = T.type_alias { T.any(Symbol, String) } - FORCE = T.let(:force, Imagekit::Transformation::Crop::TaggedSymbol) - AT_MAX = T.let(:at_max, Imagekit::Transformation::Crop::TaggedSymbol) + FORCE = T.let(:force, Imagekitio::Transformation::Crop::TaggedSymbol) + AT_MAX = T.let(:at_max, Imagekitio::Transformation::Crop::TaggedSymbol) AT_MAX_ENLARGE = - T.let(:at_max_enlarge, Imagekit::Transformation::Crop::TaggedSymbol) + T.let(:at_max_enlarge, Imagekitio::Transformation::Crop::TaggedSymbol) AT_LEAST = - T.let(:at_least, Imagekit::Transformation::Crop::TaggedSymbol) + T.let(:at_least, Imagekitio::Transformation::Crop::TaggedSymbol) MAINTAIN_RATIO = - T.let(:maintain_ratio, Imagekit::Transformation::Crop::TaggedSymbol) + T.let(:maintain_ratio, Imagekitio::Transformation::Crop::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::Transformation::Crop::TaggedSymbol] + T::Array[Imagekitio::Transformation::Crop::TaggedSymbol] ) end def self.values @@ -1189,22 +1222,25 @@ module Imagekit # Additional crop modes for image resizing. See # [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). module CropMode - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::Transformation::CropMode) } + T.type_alias { T.all(Symbol, Imagekitio::Transformation::CropMode) } OrSymbol = T.type_alias { T.any(Symbol, String) } PAD_RESIZE = - T.let(:pad_resize, Imagekit::Transformation::CropMode::TaggedSymbol) + T.let(:pad_resize, Imagekitio::Transformation::CropMode::TaggedSymbol) EXTRACT = - T.let(:extract, Imagekit::Transformation::CropMode::TaggedSymbol) + T.let(:extract, Imagekitio::Transformation::CropMode::TaggedSymbol) PAD_EXTRACT = - T.let(:pad_extract, Imagekit::Transformation::CropMode::TaggedSymbol) + T.let( + :pad_extract, + Imagekitio::Transformation::CropMode::TaggedSymbol + ) sig do override.returns( - T::Array[Imagekit::Transformation::CropMode::TaggedSymbol] + T::Array[Imagekitio::Transformation::CropMode::TaggedSymbol] ) end def self.values @@ -1216,13 +1252,13 @@ module Imagekit # Arithmetic expressions are supported. See # [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). module Duration - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::Transformation::Duration::Variants] + T::Array[Imagekitio::Transformation::Duration::Variants] ) end def self.variants @@ -1234,13 +1270,13 @@ module Imagekit # are supported. See # [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). module EndOffset - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::Transformation::EndOffset::Variants] + T::Array[Imagekitio::Transformation::EndOffset::Variants] ) end def self.variants @@ -1251,20 +1287,20 @@ module Imagekit # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or # `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). module Flip - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::Transformation::Flip) } + T.type_alias { T.all(Symbol, Imagekitio::Transformation::Flip) } OrSymbol = T.type_alias { T.any(Symbol, String) } - H = T.let(:h, Imagekit::Transformation::Flip::TaggedSymbol) - V = T.let(:v, Imagekit::Transformation::Flip::TaggedSymbol) - H_V = T.let(:h_v, Imagekit::Transformation::Flip::TaggedSymbol) - V_H = T.let(:v_h, Imagekit::Transformation::Flip::TaggedSymbol) + H = T.let(:h, Imagekitio::Transformation::Flip::TaggedSymbol) + V = T.let(:v, Imagekitio::Transformation::Flip::TaggedSymbol) + H_V = T.let(:h_v, Imagekitio::Transformation::Flip::TaggedSymbol) + V_H = T.let(:v_h, Imagekitio::Transformation::Flip::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::Transformation::Flip::TaggedSymbol] + T::Array[Imagekitio::Transformation::Flip::TaggedSymbol] ) end def self.values @@ -1279,27 +1315,27 @@ module Imagekit # [Image format](https://imagekit.io/docs/image-optimization#format---f) and # [Video format](https://imagekit.io/docs/video-optimization#format---f). module Format - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::Transformation::Format) } + T.type_alias { T.all(Symbol, Imagekitio::Transformation::Format) } OrSymbol = T.type_alias { T.any(Symbol, String) } - AUTO = T.let(:auto, Imagekit::Transformation::Format::TaggedSymbol) - WEBP = T.let(:webp, Imagekit::Transformation::Format::TaggedSymbol) - JPG = T.let(:jpg, Imagekit::Transformation::Format::TaggedSymbol) - JPEG = T.let(:jpeg, Imagekit::Transformation::Format::TaggedSymbol) - PNG = T.let(:png, Imagekit::Transformation::Format::TaggedSymbol) - GIF = T.let(:gif, Imagekit::Transformation::Format::TaggedSymbol) - SVG = T.let(:svg, Imagekit::Transformation::Format::TaggedSymbol) - MP4 = T.let(:mp4, Imagekit::Transformation::Format::TaggedSymbol) - WEBM = T.let(:webm, Imagekit::Transformation::Format::TaggedSymbol) - AVIF = T.let(:avif, Imagekit::Transformation::Format::TaggedSymbol) - ORIG = T.let(:orig, Imagekit::Transformation::Format::TaggedSymbol) + AUTO = T.let(:auto, Imagekitio::Transformation::Format::TaggedSymbol) + WEBP = T.let(:webp, Imagekitio::Transformation::Format::TaggedSymbol) + JPG = T.let(:jpg, Imagekitio::Transformation::Format::TaggedSymbol) + JPEG = T.let(:jpeg, Imagekitio::Transformation::Format::TaggedSymbol) + PNG = T.let(:png, Imagekitio::Transformation::Format::TaggedSymbol) + GIF = T.let(:gif, Imagekitio::Transformation::Format::TaggedSymbol) + SVG = T.let(:svg, Imagekitio::Transformation::Format::TaggedSymbol) + MP4 = T.let(:mp4, Imagekitio::Transformation::Format::TaggedSymbol) + WEBM = T.let(:webm, Imagekitio::Transformation::Format::TaggedSymbol) + AVIF = T.let(:avif, Imagekitio::Transformation::Format::TaggedSymbol) + ORIG = T.let(:orig, Imagekitio::Transformation::Format::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::Transformation::Format::TaggedSymbol] + T::Array[Imagekitio::Transformation::Format::TaggedSymbol] ) end def self.values @@ -1310,13 +1346,13 @@ module Imagekit # or provide a string for a custom gradient. See # [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). module Gradient - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns( - T::Array[Imagekit::Transformation::Gradient::Variants] + T::Array[Imagekitio::Transformation::Gradient::Variants] ) end def self.variants @@ -1326,19 +1362,19 @@ module Imagekit # Enables a grayscale effect for images. See # [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). module Grayscale - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedBoolean = T.type_alias do - T.all(T::Boolean, Imagekit::Transformation::Grayscale) + T.all(T::Boolean, Imagekitio::Transformation::Grayscale) end OrBoolean = T.type_alias { T::Boolean } - TRUE = T.let(true, Imagekit::Transformation::Grayscale::TaggedBoolean) + TRUE = T.let(true, Imagekitio::Transformation::Grayscale::TaggedBoolean) sig do override.returns( - T::Array[Imagekit::Transformation::Grayscale::TaggedBoolean] + T::Array[Imagekitio::Transformation::Grayscale::TaggedBoolean] ) end def self.values @@ -1352,12 +1388,14 @@ module Imagekit # [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · # [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h) module Height - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::Transformation::Height::Variants]) + override.returns( + T::Array[Imagekitio::Transformation::Height::Variants] + ) end def self.variants end @@ -1368,12 +1406,12 @@ module Imagekit # 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). module Page - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::Transformation::Page::Variants]) + override.returns(T::Array[Imagekitio::Transformation::Page::Variants]) end def self.variants end @@ -1383,12 +1421,14 @@ module Imagekit # or oval shape. See # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). module Radius - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, Symbol) } sig do - override.returns(T::Array[Imagekit::Transformation::Radius::Variants]) + override.returns( + T::Array[Imagekitio::Transformation::Radius::Variants] + ) end def self.variants end @@ -1400,13 +1440,13 @@ module Imagekit # only the following values are supported: 0, 90, 180, 270, or 360. See # [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). module Rotation - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::Transformation::Rotation::Variants] + T::Array[Imagekitio::Transformation::Rotation::Variants] ) end def self.variants @@ -1418,12 +1458,14 @@ module Imagekit # shadow, or provide a string for a custom shadow. See # [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). module Shadow - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(T::Boolean, String) } sig do - override.returns(T::Array[Imagekit::Transformation::Shadow::Variants]) + override.returns( + T::Array[Imagekitio::Transformation::Shadow::Variants] + ) end def self.variants end @@ -1433,13 +1475,13 @@ module Imagekit # default sharpening, or provide a numeric value for custom sharpening. See # [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). module Sharpen - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(T::Boolean, Float) } sig do override.returns( - T::Array[Imagekit::Transformation::Sharpen::Variants] + T::Array[Imagekitio::Transformation::Sharpen::Variants] ) end def self.variants @@ -1450,13 +1492,13 @@ module Imagekit # `10.5`. Arithmetic expressions are also supported. See # [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). module StartOffset - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::Transformation::StartOffset::Variants] + T::Array[Imagekitio::Transformation::StartOffset::Variants] ) end def self.variants @@ -1468,12 +1510,12 @@ module Imagekit # output image. See # [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). module Trim - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(T::Boolean, Float) } sig do - override.returns(T::Array[Imagekit::Transformation::Trim::Variants]) + override.returns(T::Array[Imagekitio::Transformation::Trim::Variants]) end def self.variants end @@ -1483,13 +1525,13 @@ module Imagekit # 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). module UnsharpMask - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(T::Boolean, String) } sig do override.returns( - T::Array[Imagekit::Transformation::UnsharpMask::Variants] + T::Array[Imagekitio::Transformation::UnsharpMask::Variants] ) end def self.variants @@ -1499,20 +1541,22 @@ module Imagekit # Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See # [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). module VideoCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::Transformation::VideoCodec) } + T.type_alias { T.all(Symbol, Imagekitio::Transformation::VideoCodec) } OrSymbol = T.type_alias { T.any(Symbol, String) } - H264 = T.let(:h264, Imagekit::Transformation::VideoCodec::TaggedSymbol) - VP9 = T.let(:vp9, Imagekit::Transformation::VideoCodec::TaggedSymbol) - AV1 = T.let(:av1, Imagekit::Transformation::VideoCodec::TaggedSymbol) - NONE = T.let(:none, Imagekit::Transformation::VideoCodec::TaggedSymbol) + H264 = + T.let(:h264, Imagekitio::Transformation::VideoCodec::TaggedSymbol) + VP9 = T.let(:vp9, Imagekitio::Transformation::VideoCodec::TaggedSymbol) + AV1 = T.let(:av1, Imagekitio::Transformation::VideoCodec::TaggedSymbol) + NONE = + T.let(:none, Imagekitio::Transformation::VideoCodec::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::Transformation::VideoCodec::TaggedSymbol] + T::Array[Imagekitio::Transformation::VideoCodec::TaggedSymbol] ) end def self.values @@ -1525,12 +1569,14 @@ module Imagekit # – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · # [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w) module Width - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::Transformation::Width::Variants]) + override.returns( + T::Array[Imagekitio::Transformation::Width::Variants] + ) end def self.variants end @@ -1539,12 +1585,12 @@ module Imagekit # 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). module X - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::Transformation::X::Variants]) + override.returns(T::Array[Imagekitio::Transformation::X::Variants]) end def self.variants end @@ -1553,13 +1599,13 @@ module Imagekit # 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). module XCenter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::Transformation::XCenter::Variants] + T::Array[Imagekitio::Transformation::XCenter::Variants] ) end def self.variants @@ -1569,12 +1615,12 @@ module Imagekit # 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). module Y - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do - override.returns(T::Array[Imagekit::Transformation::Y::Variants]) + override.returns(T::Array[Imagekitio::Transformation::Y::Variants]) end def self.variants end @@ -1583,13 +1629,13 @@ module Imagekit # 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). module YCenter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(Float, String) } sig do override.returns( - T::Array[Imagekit::Transformation::YCenter::Variants] + T::Array[Imagekitio::Transformation::YCenter::Variants] ) end def self.variants diff --git a/rbi/imagekit/models/transformation_position.rbi b/rbi/imagekitio/models/transformation_position.rbi similarity index 61% rename from rbi/imagekit/models/transformation_position.rbi rename to rbi/imagekitio/models/transformation_position.rbi index 603588e6..cfcec092 100644 --- a/rbi/imagekit/models/transformation_position.rbi +++ b/rbi/imagekitio/models/transformation_position.rbi @@ -1,24 +1,24 @@ # typed: strong -module Imagekit +module Imagekitio module Models # 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). module TransformationPosition - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::TransformationPosition) } + T.type_alias { T.all(Symbol, Imagekitio::TransformationPosition) } OrSymbol = T.type_alias { T.any(Symbol, String) } - PATH = T.let(:path, Imagekit::TransformationPosition::TaggedSymbol) - QUERY = T.let(:query, Imagekit::TransformationPosition::TaggedSymbol) + PATH = T.let(:path, Imagekitio::TransformationPosition::TaggedSymbol) + QUERY = T.let(:query, Imagekitio::TransformationPosition::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::TransformationPosition::TaggedSymbol] + T::Array[Imagekitio::TransformationPosition::TaggedSymbol] ) end def self.values diff --git a/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi new file mode 100644 index 00000000..2e878626 --- /dev/null +++ b/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi @@ -0,0 +1,33 @@ +# typed: strong + +module Imagekitio + module Models + # 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. + module UnsafeUnwrapWebhookEvent + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekitio::VideoTransformationAcceptedEvent, + Imagekitio::VideoTransformationReadyEvent, + Imagekitio::VideoTransformationErrorEvent, + Imagekitio::UploadPreTransformSuccessEvent, + Imagekitio::UploadPreTransformErrorEvent, + Imagekitio::UploadPostTransformSuccessEvent, + Imagekitio::UploadPostTransformErrorEvent + ) + end + + sig do + override.returns( + T::Array[Imagekitio::UnsafeUnwrapWebhookEvent::Variants] + ) + end + def self.variants + end + end + end +end diff --git a/rbi/imagekitio/models/unwrap_webhook_event.rbi b/rbi/imagekitio/models/unwrap_webhook_event.rbi new file mode 100644 index 00000000..8dcbd0dd --- /dev/null +++ b/rbi/imagekitio/models/unwrap_webhook_event.rbi @@ -0,0 +1,31 @@ +# typed: strong + +module Imagekitio + module Models + # 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. + module UnwrapWebhookEvent + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekitio::VideoTransformationAcceptedEvent, + Imagekitio::VideoTransformationReadyEvent, + Imagekitio::VideoTransformationErrorEvent, + Imagekitio::UploadPreTransformSuccessEvent, + Imagekitio::UploadPreTransformErrorEvent, + Imagekitio::UploadPostTransformSuccessEvent, + Imagekitio::UploadPostTransformErrorEvent + ) + end + + sig do + override.returns(T::Array[Imagekitio::UnwrapWebhookEvent::Variants]) + end + def self.variants + end + end + end +end diff --git a/rbi/imagekit/models/update_file_request.rbi b/rbi/imagekitio/models/update_file_request.rbi similarity index 79% rename from rbi/imagekit/models/update_file_request.rbi rename to rbi/imagekitio/models/update_file_request.rbi index b259bf0e..3a818c9c 100644 --- a/rbi/imagekit/models/update_file_request.rbi +++ b/rbi/imagekitio/models/update_file_request.rbi @@ -1,25 +1,25 @@ # typed: strong -module Imagekit +module Imagekitio module Models # Schema for update file update request. module UpdateFileRequest - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do T.any( - Imagekit::UpdateFileRequest::UpdateFileDetails, - Imagekit::UpdateFileRequest::ChangePublicationStatus + Imagekitio::UpdateFileRequest::UpdateFileDetails, + Imagekitio::UpdateFileRequest::ChangePublicationStatus ) end - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel + class UpdateFileDetails < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UpdateFileRequest::UpdateFileDetails, - Imagekit::Internal::AnyHash + Imagekitio::UpdateFileRequest::UpdateFileDetails, + Imagekitio::Internal::AnyHash ) end @@ -51,9 +51,9 @@ module Imagekit T.nilable( T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension + Imagekitio::ExtensionItem::RemoveBg, + Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AutoTaggingExtension ) ] ) @@ -66,9 +66,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + Imagekitio::ExtensionItem::RemoveBg::OrHash, + Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ] ).void @@ -112,9 +112,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + Imagekitio::ExtensionItem::RemoveBg::OrHash, + Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], remove_ai_tags: T.any(T::Array[String], Symbol), @@ -164,9 +164,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg, - Imagekit::ExtensionItem::AIAutoDescription, - Imagekit::ExtensionItem::AutoTaggingExtension + Imagekitio::ExtensionItem::RemoveBg, + Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AutoTaggingExtension ) ], remove_ai_tags: T.any(T::Array[String], Symbol), @@ -187,14 +187,14 @@ module Imagekit # Note: The remove operation for `AITags` executes before any of the `extensions` # are processed. module RemoveAITags - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(T::Array[String], Symbol) } sig do override.returns( T::Array[ - Imagekit::UpdateFileRequest::UpdateFileDetails::RemoveAITags::Variants + Imagekitio::UpdateFileRequest::UpdateFileDetails::RemoveAITags::Variants ] ) end @@ -203,18 +203,18 @@ module Imagekit StringArray = T.let( - Imagekit::Internal::Type::ArrayOf[String], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::ArrayOf[String], + Imagekitio::Internal::Type::Converter ) end end - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel + class ChangePublicationStatus < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UpdateFileRequest::ChangePublicationStatus, - Imagekit::Internal::AnyHash + Imagekitio::UpdateFileRequest::ChangePublicationStatus, + Imagekitio::Internal::AnyHash ) end @@ -222,7 +222,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish ) ) end @@ -231,7 +231,7 @@ module Imagekit sig do params( publish: - Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish::OrHash + Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish::OrHash ).void end attr_writer :publish @@ -239,7 +239,7 @@ module Imagekit sig do params( publish: - Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish::OrHash + Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish::OrHash ).returns(T.attached_class) end def self.new( @@ -252,19 +252,19 @@ module Imagekit override.returns( { publish: - Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish + Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish } ) end def to_hash end - class Publish < Imagekit::Internal::Type::BaseModel + class Publish < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish, - Imagekit::Internal::AnyHash + Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish, + Imagekitio::Internal::AnyHash ) end @@ -306,7 +306,9 @@ module Imagekit end end - sig { override.returns(T::Array[Imagekit::UpdateFileRequest::Variants]) } + sig do + override.returns(T::Array[Imagekitio::UpdateFileRequest::Variants]) + end def self.variants end end diff --git a/rbi/imagekit/models/upload_post_transform_error_event.rbi b/rbi/imagekitio/models/upload_post_transform_error_event.rbi similarity index 63% rename from rbi/imagekit/models/upload_post_transform_error_event.rbi rename to rbi/imagekitio/models/upload_post_transform_error_event.rbi index 71aa5b20..51472bff 100644 --- a/rbi/imagekit/models/upload_post_transform_error_event.rbi +++ b/rbi/imagekitio/models/upload_post_transform_error_event.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent + class UploadPostTransformErrorEvent < Imagekitio::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorEvent, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformErrorEvent, + Imagekitio::Internal::AnyHash ) end @@ -15,20 +15,22 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::UploadPostTransformErrorEvent::Data) } + sig { returns(Imagekitio::UploadPostTransformErrorEvent::Data) } attr_reader :data sig do - params(data: Imagekit::UploadPostTransformErrorEvent::Data::OrHash).void + params( + data: Imagekitio::UploadPostTransformErrorEvent::Data::OrHash + ).void end attr_writer :data - sig { returns(Imagekit::UploadPostTransformErrorEvent::Request) } + sig { returns(Imagekitio::UploadPostTransformErrorEvent::Request) } attr_reader :request sig do params( - request: Imagekit::UploadPostTransformErrorEvent::Request::OrHash + request: Imagekitio::UploadPostTransformErrorEvent::Request::OrHash ).void end attr_writer :request @@ -41,8 +43,8 @@ module Imagekit sig do params( created_at: Time, - data: Imagekit::UploadPostTransformErrorEvent::Data::OrHash, - request: Imagekit::UploadPostTransformErrorEvent::Request::OrHash, + data: Imagekitio::UploadPostTransformErrorEvent::Data::OrHash, + request: Imagekitio::UploadPostTransformErrorEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -59,8 +61,8 @@ module Imagekit override.returns( { created_at: Time, - data: Imagekit::UploadPostTransformErrorEvent::Data, - request: Imagekit::UploadPostTransformErrorEvent::Request, + data: Imagekitio::UploadPostTransformErrorEvent::Data, + request: Imagekitio::UploadPostTransformErrorEvent::Request, type: Symbol } ) @@ -68,12 +70,12 @@ module Imagekit def to_hash end - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorEvent::Data, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformErrorEvent::Data, + Imagekitio::Internal::AnyHash ) end @@ -90,14 +92,16 @@ module Imagekit attr_accessor :path sig do - returns(Imagekit::UploadPostTransformErrorEvent::Data::Transformation) + returns( + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation + ) end attr_reader :transformation sig do params( transformation: - Imagekit::UploadPostTransformErrorEvent::Data::Transformation::OrHash + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::OrHash ).void end attr_writer :transformation @@ -112,7 +116,7 @@ module Imagekit name: String, path: String, transformation: - Imagekit::UploadPostTransformErrorEvent::Data::Transformation::OrHash, + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::OrHash, url: String ).returns(T.attached_class) end @@ -136,7 +140,7 @@ module Imagekit name: String, path: String, transformation: - Imagekit::UploadPostTransformErrorEvent::Data::Transformation, + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation, url: String } ) @@ -144,18 +148,18 @@ module Imagekit def to_hash end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorEvent::Data::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation, + Imagekitio::Internal::AnyHash ) end sig do returns( - Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error ) end attr_reader :error @@ -163,7 +167,7 @@ module Imagekit sig do params( error: - Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error::OrHash + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error::OrHash ).void end attr_writer :error @@ -171,7 +175,7 @@ module Imagekit sig do params( error: - Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error::OrHash + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error::OrHash ).returns(T.attached_class) end def self.new(error:) @@ -181,19 +185,19 @@ module Imagekit override.returns( { error: - Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error } ) end def to_hash end - class Error < Imagekit::Internal::Type::BaseModel + class Error < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error, + Imagekitio::Internal::AnyHash ) end @@ -215,18 +219,18 @@ module Imagekit end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorEvent::Request, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformErrorEvent::Request, + Imagekitio::Internal::AnyHash ) end sig do returns( - Imagekit::UploadPostTransformErrorEvent::Request::Transformation + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation ) end attr_reader :transformation @@ -234,7 +238,7 @@ module Imagekit sig do params( transformation: - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::OrHash + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::OrHash ).void end attr_writer :transformation @@ -246,7 +250,7 @@ module Imagekit sig do params( transformation: - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::OrHash, + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::OrHash, x_request_id: String ).returns(T.attached_class) end @@ -261,7 +265,7 @@ module Imagekit override.returns( { transformation: - Imagekit::UploadPostTransformErrorEvent::Request::Transformation, + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation, x_request_id: String } ) @@ -269,19 +273,19 @@ module Imagekit def to_hash end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformErrorEvent::Request::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation, + Imagekitio::Internal::AnyHash ) end # Type of the requested post-transformation. sig do returns( - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -290,7 +294,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol ) ) end @@ -299,7 +303,7 @@ module Imagekit sig do params( protocol: - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::OrSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol::OrSymbol ).void end attr_writer :protocol @@ -314,9 +318,9 @@ module Imagekit sig do params( type: - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::OrSymbol, + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type::OrSymbol, protocol: - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::OrSymbol, + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol::OrSymbol, value: String ).returns(T.attached_class) end @@ -334,9 +338,9 @@ module Imagekit override.returns( { type: - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol, + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol, protocol: - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol, + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol, value: String } ) @@ -346,13 +350,13 @@ module Imagekit # Type of the requested post-transformation. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -360,28 +364,28 @@ module Imagekit TRANSFORMATION = T.let( :transformation, - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) ABS = T.let( :abs, - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) THUMBNAIL = T.let( :thumbnail, - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type::TaggedSymbol ] ) end @@ -391,13 +395,13 @@ module Imagekit # Only applicable if transformation type is 'abs'. Streaming protocol used. module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -405,18 +409,18 @@ module Imagekit HLS = T.let( :hls, - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol ) DASH = T.let( :dash, - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/upload_post_transform_success_event.rbi b/rbi/imagekitio/models/upload_post_transform_success_event.rbi similarity index 64% rename from rbi/imagekit/models/upload_post_transform_success_event.rbi rename to rbi/imagekitio/models/upload_post_transform_success_event.rbi index c86f6212..f71b2e1d 100644 --- a/rbi/imagekit/models/upload_post_transform_success_event.rbi +++ b/rbi/imagekitio/models/upload_post_transform_success_event.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent + class UploadPostTransformSuccessEvent < Imagekitio::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformSuccessEvent, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformSuccessEvent, + Imagekitio::Internal::AnyHash ) end @@ -15,22 +15,22 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::UploadPostTransformSuccessEvent::Data) } + sig { returns(Imagekitio::UploadPostTransformSuccessEvent::Data) } attr_reader :data sig do params( - data: Imagekit::UploadPostTransformSuccessEvent::Data::OrHash + data: Imagekitio::UploadPostTransformSuccessEvent::Data::OrHash ).void end attr_writer :data - sig { returns(Imagekit::UploadPostTransformSuccessEvent::Request) } + sig { returns(Imagekitio::UploadPostTransformSuccessEvent::Request) } attr_reader :request sig do params( - request: Imagekit::UploadPostTransformSuccessEvent::Request::OrHash + request: Imagekitio::UploadPostTransformSuccessEvent::Request::OrHash ).void end attr_writer :request @@ -44,8 +44,8 @@ module Imagekit sig do params( created_at: Time, - data: Imagekit::UploadPostTransformSuccessEvent::Data::OrHash, - request: Imagekit::UploadPostTransformSuccessEvent::Request::OrHash, + data: Imagekitio::UploadPostTransformSuccessEvent::Data::OrHash, + request: Imagekitio::UploadPostTransformSuccessEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -62,8 +62,8 @@ module Imagekit override.returns( { created_at: Time, - data: Imagekit::UploadPostTransformSuccessEvent::Data, - request: Imagekit::UploadPostTransformSuccessEvent::Request, + data: Imagekitio::UploadPostTransformSuccessEvent::Data, + request: Imagekitio::UploadPostTransformSuccessEvent::Request, type: Symbol } ) @@ -71,12 +71,12 @@ module Imagekit def to_hash end - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformSuccessEvent::Data, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformSuccessEvent::Data, + Imagekitio::Internal::AnyHash ) end @@ -112,18 +112,18 @@ module Imagekit end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformSuccessEvent::Request, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformSuccessEvent::Request, + Imagekitio::Internal::AnyHash ) end sig do returns( - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation ) end attr_reader :transformation @@ -131,7 +131,7 @@ module Imagekit sig do params( transformation: - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::OrHash + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::OrHash ).void end attr_writer :transformation @@ -143,7 +143,7 @@ module Imagekit sig do params( transformation: - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::OrHash, + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::OrHash, x_request_id: String ).returns(T.attached_class) end @@ -158,7 +158,7 @@ module Imagekit override.returns( { transformation: - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation, x_request_id: String } ) @@ -166,19 +166,19 @@ module Imagekit def to_hash end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation, + Imagekitio::Internal::AnyHash ) end # Type of the requested post-transformation. sig do returns( - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -187,7 +187,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol ) ) end @@ -196,7 +196,7 @@ module Imagekit sig do params( protocol: - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::OrSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::OrSymbol ).void end attr_writer :protocol @@ -211,9 +211,9 @@ module Imagekit sig do params( type: - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::OrSymbol, + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type::OrSymbol, protocol: - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::OrSymbol, + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::OrSymbol, value: String ).returns(T.attached_class) end @@ -231,9 +231,9 @@ module Imagekit override.returns( { type: - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol, + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol, protocol: - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol, + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol, value: String } ) @@ -243,13 +243,13 @@ module Imagekit # Type of the requested post-transformation. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -257,28 +257,28 @@ module Imagekit TRANSFORMATION = T.let( :transformation, - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) ABS = T.let( :abs, - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) THUMBNAIL = T.let( :thumbnail, - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type::TaggedSymbol ] ) end @@ -288,13 +288,13 @@ module Imagekit # Only applicable if transformation type is 'abs'. Streaming protocol used. module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -302,18 +302,18 @@ module Imagekit HLS = T.let( :hls, - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol ) DASH = T.let( :dash, - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol + Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol::TaggedSymbol ] ) end diff --git a/rbi/imagekit/models/upload_pre_transform_error_event.rbi b/rbi/imagekitio/models/upload_pre_transform_error_event.rbi similarity index 65% rename from rbi/imagekit/models/upload_pre_transform_error_event.rbi rename to rbi/imagekitio/models/upload_pre_transform_error_event.rbi index d95f5534..4963a4b7 100644 --- a/rbi/imagekit/models/upload_pre_transform_error_event.rbi +++ b/rbi/imagekitio/models/upload_pre_transform_error_event.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent + class UploadPreTransformErrorEvent < Imagekitio::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorEvent, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformErrorEvent, + Imagekitio::Internal::AnyHash ) end @@ -15,20 +15,22 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::UploadPreTransformErrorEvent::Data) } + sig { returns(Imagekitio::UploadPreTransformErrorEvent::Data) } attr_reader :data sig do - params(data: Imagekit::UploadPreTransformErrorEvent::Data::OrHash).void + params( + data: Imagekitio::UploadPreTransformErrorEvent::Data::OrHash + ).void end attr_writer :data - sig { returns(Imagekit::UploadPreTransformErrorEvent::Request) } + sig { returns(Imagekitio::UploadPreTransformErrorEvent::Request) } attr_reader :request sig do params( - request: Imagekit::UploadPreTransformErrorEvent::Request::OrHash + request: Imagekitio::UploadPreTransformErrorEvent::Request::OrHash ).void end attr_writer :request @@ -41,8 +43,8 @@ module Imagekit sig do params( created_at: Time, - data: Imagekit::UploadPreTransformErrorEvent::Data::OrHash, - request: Imagekit::UploadPreTransformErrorEvent::Request::OrHash, + data: Imagekitio::UploadPreTransformErrorEvent::Data::OrHash, + request: Imagekitio::UploadPreTransformErrorEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -59,8 +61,8 @@ module Imagekit override.returns( { created_at: Time, - data: Imagekit::UploadPreTransformErrorEvent::Data, - request: Imagekit::UploadPreTransformErrorEvent::Request, + data: Imagekitio::UploadPreTransformErrorEvent::Data, + request: Imagekitio::UploadPreTransformErrorEvent::Request, type: Symbol } ) @@ -68,12 +70,12 @@ module Imagekit def to_hash end - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorEvent::Data, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformErrorEvent::Data, + Imagekitio::Internal::AnyHash ) end @@ -86,14 +88,16 @@ module Imagekit attr_accessor :path sig do - returns(Imagekit::UploadPreTransformErrorEvent::Data::Transformation) + returns( + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation + ) end attr_reader :transformation sig do params( transformation: - Imagekit::UploadPreTransformErrorEvent::Data::Transformation::OrHash + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::OrHash ).void end attr_writer :transformation @@ -103,7 +107,7 @@ module Imagekit name: String, path: String, transformation: - Imagekit::UploadPreTransformErrorEvent::Data::Transformation::OrHash + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new( @@ -121,25 +125,25 @@ module Imagekit name: String, path: String, transformation: - Imagekit::UploadPreTransformErrorEvent::Data::Transformation + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation } ) end def to_hash end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorEvent::Data::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation, + Imagekitio::Internal::AnyHash ) end sig do returns( - Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error ) end attr_reader :error @@ -147,7 +151,7 @@ module Imagekit sig do params( error: - Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error::OrHash + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error::OrHash ).void end attr_writer :error @@ -155,7 +159,7 @@ module Imagekit sig do params( error: - Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error::OrHash + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error::OrHash ).returns(T.attached_class) end def self.new(error:) @@ -165,19 +169,19 @@ module Imagekit override.returns( { error: - Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error } ) end def to_hash end - class Error < Imagekit::Internal::Type::BaseModel + class Error < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error, + Imagekitio::Internal::AnyHash ) end @@ -199,12 +203,12 @@ module Imagekit end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformErrorEvent::Request, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformErrorEvent::Request, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/upload_pre_transform_success_event.rbi b/rbi/imagekitio/models/upload_pre_transform_success_event.rbi similarity index 75% rename from rbi/imagekit/models/upload_pre_transform_success_event.rbi rename to rbi/imagekitio/models/upload_pre_transform_success_event.rbi index 59103f76..f989dd66 100644 --- a/rbi/imagekit/models/upload_pre_transform_success_event.rbi +++ b/rbi/imagekitio/models/upload_pre_transform_success_event.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent + class UploadPreTransformSuccessEvent < Imagekitio::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessEvent, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformSuccessEvent, + Imagekitio::Internal::AnyHash ) end @@ -16,22 +16,22 @@ module Imagekit attr_accessor :created_at # Object containing details of a successful upload. - sig { returns(Imagekit::UploadPreTransformSuccessEvent::Data) } + sig { returns(Imagekitio::UploadPreTransformSuccessEvent::Data) } attr_reader :data sig do params( - data: Imagekit::UploadPreTransformSuccessEvent::Data::OrHash + data: Imagekitio::UploadPreTransformSuccessEvent::Data::OrHash ).void end attr_writer :data - sig { returns(Imagekit::UploadPreTransformSuccessEvent::Request) } + sig { returns(Imagekitio::UploadPreTransformSuccessEvent::Request) } attr_reader :request sig do params( - request: Imagekit::UploadPreTransformSuccessEvent::Request::OrHash + request: Imagekitio::UploadPreTransformSuccessEvent::Request::OrHash ).void end attr_writer :request @@ -45,8 +45,8 @@ module Imagekit sig do params( created_at: Time, - data: Imagekit::UploadPreTransformSuccessEvent::Data::OrHash, - request: Imagekit::UploadPreTransformSuccessEvent::Request::OrHash, + data: Imagekitio::UploadPreTransformSuccessEvent::Data::OrHash, + request: Imagekitio::UploadPreTransformSuccessEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -64,8 +64,8 @@ module Imagekit override.returns( { created_at: Time, - data: Imagekit::UploadPreTransformSuccessEvent::Data, - request: Imagekit::UploadPreTransformSuccessEvent::Request, + data: Imagekitio::UploadPreTransformSuccessEvent::Data, + request: Imagekitio::UploadPreTransformSuccessEvent::Request, type: Symbol } ) @@ -73,12 +73,12 @@ module Imagekit def to_hash end - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessEvent::Data, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformSuccessEvent::Data, + Imagekitio::Internal::AnyHash ) end @@ -86,7 +86,7 @@ module Imagekit sig do returns( T.nilable( - T::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag] + T::Array[Imagekitio::UploadPreTransformSuccessEvent::Data::AITag] ) ) end @@ -160,7 +160,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus ) ) end @@ -169,7 +169,7 @@ module Imagekit sig do params( extension_status: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::OrHash + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::OrHash ).void end attr_writer :extension_status @@ -224,10 +224,10 @@ module Imagekit # Legacy metadata. Send `metadata` in `responseFields` in API request to get # metadata in the upload API response. - sig { returns(T.nilable(Imagekit::Metadata)) } + sig { returns(T.nilable(Imagekitio::Metadata)) } attr_reader :metadata - sig { params(metadata: Imagekit::Metadata::OrHash).void } + sig { params(metadata: Imagekitio::Metadata::OrHash).void } attr_writer :metadata # Name of the asset. @@ -249,7 +249,7 @@ module Imagekit T.nilable( T::Hash[ Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema ] ) ) @@ -261,7 +261,7 @@ module Imagekit selected_fields_schema: T::Hash[ Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::OrHash + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::OrHash ] ).void end @@ -298,7 +298,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo + Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo ) ) end @@ -307,7 +307,7 @@ module Imagekit sig do params( version_info: - Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo::OrHash + Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo::OrHash ).void end attr_writer :version_info @@ -332,7 +332,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::AITag::OrHash + Imagekitio::UploadPreTransformSuccessEvent::Data::AITag::OrHash ] ), audio_codec: String, @@ -343,26 +343,26 @@ module Imagekit duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::OrHash, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::OrHash, file_id: String, file_path: String, file_type: String, height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: Imagekit::Metadata::OrHash, + metadata: Imagekitio::Metadata::OrHash, name: String, selected_fields_schema: T::Hash[ Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::OrHash + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::OrHash ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, url: String, version_info: - Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo::OrHash, + Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo::OrHash, video_codec: String, width: Float ).returns(T.attached_class) @@ -460,7 +460,7 @@ module Imagekit ai_tags: T.nilable( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::AITag + Imagekitio::UploadPreTransformSuccessEvent::Data::AITag ] ), audio_codec: String, @@ -471,26 +471,26 @@ module Imagekit duration: Integer, embedded_metadata: T::Hash[Symbol, T.anything], extension_status: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus, file_id: String, file_path: String, file_type: String, height: Float, is_private_file: T::Boolean, is_published: T::Boolean, - metadata: Imagekit::Metadata, + metadata: Imagekitio::Metadata, name: String, selected_fields_schema: T::Hash[ Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema ], size: Float, tags: T.nilable(T::Array[String]), thumbnail_url: String, url: String, version_info: - Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, + Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo, video_codec: String, width: Float } @@ -499,12 +499,12 @@ module Imagekit def to_hash end - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessEvent::Data::AITag, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformSuccessEvent::Data::AITag, + Imagekitio::Internal::AnyHash ) end @@ -557,19 +557,19 @@ module Imagekit end end - class ExtensionStatus < Imagekit::Internal::Type::BaseModel + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus, + Imagekitio::Internal::AnyHash ) end sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol ) ) end @@ -578,7 +578,7 @@ module Imagekit sig do params( ai_auto_description: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::OrSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::OrSymbol ).void end attr_writer :ai_auto_description @@ -586,7 +586,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) ) end @@ -595,7 +595,7 @@ module Imagekit sig do params( aws_auto_tagging: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol ).void end attr_writer :aws_auto_tagging @@ -603,7 +603,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) ) end @@ -612,7 +612,7 @@ module Imagekit sig do params( google_auto_tagging: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol ).void end attr_writer :google_auto_tagging @@ -620,7 +620,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ) ) end @@ -629,7 +629,7 @@ module Imagekit sig do params( remove_bg: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::OrSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::OrSymbol ).void end attr_writer :remove_bg @@ -646,13 +646,13 @@ module Imagekit sig do params( ai_auto_description: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::OrSymbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::OrSymbol, aws_auto_tagging: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::OrSymbol, remove_bg: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::OrSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::OrSymbol ).returns(T.attached_class) end def self.new( @@ -667,13 +667,13 @@ module Imagekit override.returns( { ai_auto_description: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol, aws_auto_tagging: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol, remove_bg: - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol } ) end @@ -681,13 +681,13 @@ module Imagekit end module AIAutoDescription - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -695,23 +695,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol ] ) end @@ -720,13 +720,13 @@ module Imagekit end module AwsAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -734,23 +734,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol ] ) end @@ -759,13 +759,13 @@ module Imagekit end module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -773,23 +773,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging::TaggedSymbol ] ) end @@ -798,13 +798,13 @@ module Imagekit end module RemoveBg - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -812,23 +812,23 @@ module Imagekit SUCCESS = T.let( :success, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ) PENDING = T.let( :pending, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ) FAILED = T.let( :failed, - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg::TaggedSymbol ] ) end @@ -837,19 +837,19 @@ module Imagekit end end - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema, + Imagekitio::Internal::AnyHash ) end # Type of the custom metadata field. sig do returns( - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ) end attr_accessor :type @@ -859,7 +859,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants ) ) end @@ -868,7 +868,7 @@ module Imagekit sig do params( default_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants ).void end attr_writer :default_value @@ -893,7 +893,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants ) ) end @@ -902,7 +902,7 @@ module Imagekit sig do params( max_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants ).void end attr_writer :max_value @@ -920,7 +920,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants ) ) end @@ -929,7 +929,7 @@ module Imagekit sig do params( min_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants ).void end attr_writer :min_value @@ -948,7 +948,7 @@ module Imagekit returns( T.nilable( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants ] ) ) @@ -959,7 +959,7 @@ module Imagekit params( select_options: T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants ] ).void end @@ -976,20 +976,20 @@ module Imagekit sig do params( type: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::OrSymbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::OrSymbol, default_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants, + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants, + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants, + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants, read_only: T::Boolean, select_options: T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants ], select_options_truncated: T::Boolean ).returns(T.attached_class) @@ -1030,20 +1030,20 @@ module Imagekit override.returns( { type: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol, default_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants, + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants, is_value_required: T::Boolean, max_length: Float, max_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants, + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants, min_length: Float, min_value: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants, + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants, read_only: T::Boolean, select_options: T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants ], select_options_truncated: T::Boolean } @@ -1054,13 +1054,13 @@ module Imagekit # Type of the custom metadata field. module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1068,43 +1068,43 @@ module Imagekit TEXT = T.let( :Text, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ) TEXTAREA = T.let( :Textarea, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ) NUMBER = T.let( :Number, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ) DATE = T.let( :Date, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ) BOOLEAN = T.let( :Boolean, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ) SINGLE_SELECT = T.let( :SingleSelect, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ) MULTI_SELECT = T.let( :MultiSelect, - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type::TaggedSymbol ] ) end @@ -1115,7 +1115,7 @@ module Imagekit # The default value for this custom metadata field. The value should match the # `type` of custom metadata field. module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias do @@ -1124,20 +1124,20 @@ module Imagekit Float, T::Boolean, T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed::Variants ] ) end module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed::Variants ] ) end @@ -1148,7 +1148,7 @@ module Imagekit sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Variants ] ) end @@ -1157,11 +1157,11 @@ module Imagekit MixedArray = T.let( - Imagekit::Internal::Type::ArrayOf[ + Imagekitio::Internal::Type::ArrayOf[ union: - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed ], - Imagekit::Internal::Type::Converter + Imagekitio::Internal::Type::Converter ) end @@ -1169,14 +1169,14 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue::Variants ] ) end @@ -1188,14 +1188,14 @@ module Imagekit # `Date` type field, the value will be in ISO8601 string format. For `Number` type # field, it will be a numeric value. module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float) } sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue::Variants ] ) end @@ -1204,14 +1204,14 @@ module Imagekit end module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union Variants = T.type_alias { T.any(String, Float, T::Boolean) } sig do override.returns( T::Array[ - Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants + Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption::Variants ] ) end @@ -1220,12 +1220,12 @@ module Imagekit end end - class VersionInfo < Imagekit::Internal::Type::BaseModel + class VersionInfo < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo, + Imagekitio::Internal::AnyHash ) end @@ -1259,12 +1259,12 @@ module Imagekit end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::UploadPreTransformSuccessEvent::Request, - Imagekit::Internal::AnyHash + Imagekitio::UploadPreTransformSuccessEvent::Request, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_overlay.rbi b/rbi/imagekitio/models/video_overlay.rbi similarity index 69% rename from rbi/imagekit/models/video_overlay.rbi rename to rbi/imagekitio/models/video_overlay.rbi index 84c9aaed..14469c27 100644 --- a/rbi/imagekit/models/video_overlay.rbi +++ b/rbi/imagekitio/models/video_overlay.rbi @@ -1,11 +1,11 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class VideoOverlay < Imagekit::Models::BaseOverlay + class VideoOverlay < Imagekitio::Models::BaseOverlay OrHash = T.type_alias do - T.any(Imagekit::VideoOverlay, Imagekit::Internal::AnyHash) + T.any(Imagekitio::VideoOverlay, Imagekitio::Internal::AnyHash) end # Specifies the relative path to the video used as an overlay. @@ -20,26 +20,28 @@ module Imagekit # 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`. - sig { returns(T.nilable(Imagekit::VideoOverlay::Encoding::OrSymbol)) } + sig { returns(T.nilable(Imagekitio::VideoOverlay::Encoding::OrSymbol)) } attr_reader :encoding - sig { params(encoding: Imagekit::VideoOverlay::Encoding::OrSymbol).void } + sig do + params(encoding: Imagekitio::VideoOverlay::Encoding::OrSymbol).void + end attr_writer :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). - sig { returns(T.nilable(T::Array[Imagekit::Transformation])) } + sig { returns(T.nilable(T::Array[Imagekitio::Transformation])) } attr_reader :transformation - sig { params(transformation: T::Array[Imagekit::Transformation]).void } + sig { params(transformation: T::Array[Imagekitio::Transformation]).void } attr_writer :transformation sig do params( input: String, - encoding: Imagekit::VideoOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::Transformation], + encoding: Imagekitio::VideoOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekitio::Transformation], type: Symbol ).returns(T.attached_class) end @@ -65,8 +67,8 @@ module Imagekit { input: String, type: Symbol, - encoding: Imagekit::VideoOverlay::Encoding::OrSymbol, - transformation: T::Array[Imagekit::Transformation] + encoding: Imagekitio::VideoOverlay::Encoding::OrSymbol, + transformation: T::Array[Imagekitio::Transformation] } ) end @@ -79,19 +81,20 @@ module Imagekit # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. module Encoding - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, Imagekit::VideoOverlay::Encoding) } + T.type_alias { T.all(Symbol, Imagekitio::VideoOverlay::Encoding) } OrSymbol = T.type_alias { T.any(Symbol, String) } - AUTO = T.let(:auto, Imagekit::VideoOverlay::Encoding::TaggedSymbol) - PLAIN = T.let(:plain, Imagekit::VideoOverlay::Encoding::TaggedSymbol) - BASE64 = T.let(:base64, Imagekit::VideoOverlay::Encoding::TaggedSymbol) + AUTO = T.let(:auto, Imagekitio::VideoOverlay::Encoding::TaggedSymbol) + PLAIN = T.let(:plain, Imagekitio::VideoOverlay::Encoding::TaggedSymbol) + BASE64 = + T.let(:base64, Imagekitio::VideoOverlay::Encoding::TaggedSymbol) sig do override.returns( - T::Array[Imagekit::VideoOverlay::Encoding::TaggedSymbol] + T::Array[Imagekitio::VideoOverlay::Encoding::TaggedSymbol] ) end def self.values diff --git a/rbi/imagekit/models/video_transformation_accepted_event.rbi b/rbi/imagekitio/models/video_transformation_accepted_event.rbi similarity index 65% rename from rbi/imagekit/models/video_transformation_accepted_event.rbi rename to rbi/imagekitio/models/video_transformation_accepted_event.rbi index b6bb2056..5a5e3bda 100644 --- a/rbi/imagekit/models/video_transformation_accepted_event.rbi +++ b/rbi/imagekitio/models/video_transformation_accepted_event.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class VideoTransformationAcceptedEvent < Imagekit::Models::BaseWebhookEvent + class VideoTransformationAcceptedEvent < Imagekitio::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationAcceptedEvent, + Imagekitio::Internal::AnyHash ) end @@ -15,23 +15,23 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data) } + sig { returns(Imagekitio::VideoTransformationAcceptedEvent::Data) } attr_reader :data sig do params( - data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash + data: Imagekitio::VideoTransformationAcceptedEvent::Data::OrHash ).void end attr_writer :data # Information about the original request that triggered the video transformation. - sig { returns(Imagekit::VideoTransformationAcceptedEvent::Request) } + sig { returns(Imagekitio::VideoTransformationAcceptedEvent::Request) } attr_reader :request sig do params( - request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash + request: Imagekitio::VideoTransformationAcceptedEvent::Request::OrHash ).void end attr_writer :request @@ -45,8 +45,9 @@ module Imagekit sig do params( created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data::OrHash, - request: Imagekit::VideoTransformationAcceptedEvent::Request::OrHash, + data: Imagekitio::VideoTransformationAcceptedEvent::Data::OrHash, + request: + Imagekitio::VideoTransformationAcceptedEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -64,8 +65,8 @@ module Imagekit override.returns( { created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data, - request: Imagekit::VideoTransformationAcceptedEvent::Request, + data: Imagekitio::VideoTransformationAcceptedEvent::Data, + request: Imagekitio::VideoTransformationAcceptedEvent::Request, type: Symbol } ) @@ -73,23 +74,25 @@ module Imagekit def to_hash end - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Data, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationAcceptedEvent::Data, + Imagekitio::Internal::AnyHash ) end # Information about the source video asset being transformed. - sig { returns(Imagekit::VideoTransformationAcceptedEvent::Data::Asset) } + sig do + returns(Imagekitio::VideoTransformationAcceptedEvent::Data::Asset) + end attr_reader :asset sig do params( asset: - Imagekit::VideoTransformationAcceptedEvent::Data::Asset::OrHash + Imagekitio::VideoTransformationAcceptedEvent::Data::Asset::OrHash ).void end attr_writer :asset @@ -97,7 +100,7 @@ module Imagekit # Base information about a video transformation request. sig do returns( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation ) end attr_reader :transformation @@ -105,7 +108,7 @@ module Imagekit sig do params( transformation: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::OrHash ).void end attr_writer :transformation @@ -113,9 +116,9 @@ module Imagekit sig do params( asset: - Imagekit::VideoTransformationAcceptedEvent::Data::Asset::OrHash, + Imagekitio::VideoTransformationAcceptedEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::OrHash + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new( @@ -129,21 +132,21 @@ module Imagekit sig do override.returns( { - asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, + asset: Imagekitio::VideoTransformationAcceptedEvent::Data::Asset, transformation: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation } ) end def to_hash end - class Asset < Imagekit::Internal::Type::BaseModel + class Asset < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Data::Asset, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationAcceptedEvent::Data::Asset, + Imagekitio::Internal::AnyHash ) end @@ -164,12 +167,12 @@ module Imagekit end end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation, + Imagekitio::Internal::AnyHash ) end @@ -181,7 +184,7 @@ module Imagekit # - `video-thumbnail`: Generate thumbnail image from video sig do returns( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -190,7 +193,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options ) ) end @@ -199,7 +202,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -208,9 +211,9 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::OrSymbol, + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type::OrSymbol, options: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end def self.new( @@ -230,9 +233,9 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol, + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol, options: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options } ) end @@ -246,13 +249,13 @@ module Imagekit # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -260,23 +263,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -284,12 +287,12 @@ module Imagekit end end - class Options < Imagekit::Internal::Type::BaseModel + class Options < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options, + Imagekitio::Internal::AnyHash ) end @@ -297,7 +300,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -306,7 +309,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -322,7 +325,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -331,7 +334,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -347,7 +350,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -356,7 +359,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -372,7 +375,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -381,7 +384,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -390,16 +393,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -424,16 +427,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -442,13 +445,13 @@ module Imagekit # Audio codec used for encoding (aac or opus). module AudioCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -456,18 +459,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -477,13 +480,13 @@ module Imagekit # Output format for the transformed video or thumbnail. module Format - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -491,33 +494,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -527,13 +530,13 @@ module Imagekit # Streaming protocol for adaptive bitrate streaming. module StreamProtocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -541,18 +544,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -562,13 +565,13 @@ module Imagekit # Video codec used for encoding (h264, vp9, or av1). module VideoCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -576,23 +579,23 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) AV1 = T.let( :av1, - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -603,12 +606,12 @@ module Imagekit end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationAcceptedEvent::Request, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationAcceptedEvent::Request, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_transformation_error_event.rbi b/rbi/imagekitio/models/video_transformation_error_event.rbi similarity index 65% rename from rbi/imagekit/models/video_transformation_error_event.rbi rename to rbi/imagekitio/models/video_transformation_error_event.rbi index 3c9c19d2..19e88513 100644 --- a/rbi/imagekit/models/video_transformation_error_event.rbi +++ b/rbi/imagekitio/models/video_transformation_error_event.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class VideoTransformationErrorEvent < Imagekit::Models::BaseWebhookEvent + class VideoTransformationErrorEvent < Imagekitio::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationErrorEvent, + Imagekitio::Internal::AnyHash ) end @@ -15,21 +15,23 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationErrorEvent::Data) } + sig { returns(Imagekitio::VideoTransformationErrorEvent::Data) } attr_reader :data sig do - params(data: Imagekit::VideoTransformationErrorEvent::Data::OrHash).void + params( + data: Imagekitio::VideoTransformationErrorEvent::Data::OrHash + ).void end attr_writer :data # Information about the original request that triggered the video transformation. - sig { returns(Imagekit::VideoTransformationErrorEvent::Request) } + sig { returns(Imagekitio::VideoTransformationErrorEvent::Request) } attr_reader :request sig do params( - request: Imagekit::VideoTransformationErrorEvent::Request::OrHash + request: Imagekitio::VideoTransformationErrorEvent::Request::OrHash ).void end attr_writer :request @@ -44,8 +46,8 @@ module Imagekit sig do params( created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data::OrHash, - request: Imagekit::VideoTransformationErrorEvent::Request::OrHash, + data: Imagekitio::VideoTransformationErrorEvent::Data::OrHash, + request: Imagekitio::VideoTransformationErrorEvent::Request::OrHash, type: Symbol ).returns(T.attached_class) end @@ -63,8 +65,8 @@ module Imagekit override.returns( { created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data, - request: Imagekit::VideoTransformationErrorEvent::Request, + data: Imagekitio::VideoTransformationErrorEvent::Data, + request: Imagekitio::VideoTransformationErrorEvent::Request, type: Symbol } ) @@ -72,44 +74,48 @@ module Imagekit def to_hash end - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationErrorEvent::Data, + Imagekitio::Internal::AnyHash ) end # Information about the source video asset being transformed. - sig { returns(Imagekit::VideoTransformationErrorEvent::Data::Asset) } + sig { returns(Imagekitio::VideoTransformationErrorEvent::Data::Asset) } attr_reader :asset sig do params( - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset::OrHash + asset: + Imagekitio::VideoTransformationErrorEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do - returns(Imagekit::VideoTransformationErrorEvent::Data::Transformation) + returns( + Imagekitio::VideoTransformationErrorEvent::Data::Transformation + ) end attr_reader :transformation sig do params( transformation: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::OrHash ).void end attr_writer :transformation sig do params( - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset::OrHash, + asset: + Imagekitio::VideoTransformationErrorEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::OrHash + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new( @@ -122,21 +128,21 @@ module Imagekit sig do override.returns( { - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, + asset: Imagekitio::VideoTransformationErrorEvent::Data::Asset, transformation: - Imagekit::VideoTransformationErrorEvent::Data::Transformation + Imagekitio::VideoTransformationErrorEvent::Data::Transformation } ) end def to_hash end - class Asset < Imagekit::Internal::Type::BaseModel + class Asset < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data::Asset, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationErrorEvent::Data::Asset, + Imagekitio::Internal::AnyHash ) end @@ -157,12 +163,12 @@ module Imagekit end end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationErrorEvent::Data::Transformation, + Imagekitio::Internal::AnyHash ) end @@ -174,7 +180,7 @@ module Imagekit # - `video-thumbnail`: Generate thumbnail image from video sig do returns( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -183,7 +189,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error ) ) end @@ -192,7 +198,7 @@ module Imagekit sig do params( error: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash ).void end attr_writer :error @@ -201,7 +207,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options ) ) end @@ -210,7 +216,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -218,11 +224,11 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::OrSymbol, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type::OrSymbol, error: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::OrHash, options: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::OrHash ).returns(T.attached_class) end def self.new( @@ -244,11 +250,11 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol, error: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error, options: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options } ) end @@ -262,13 +268,13 @@ module Imagekit # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -276,23 +282,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -300,12 +306,12 @@ module Imagekit end end - class Error < Imagekit::Internal::Type::BaseModel + class Error < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error, + Imagekitio::Internal::AnyHash ) end @@ -316,7 +322,7 @@ module Imagekit # - `internal_server_error`: Unexpected server error sig do returns( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) end attr_accessor :reason @@ -325,7 +331,7 @@ module Imagekit sig do params( reason: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::OrSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::OrSymbol ).returns(T.attached_class) end def self.new( @@ -342,7 +348,7 @@ module Imagekit override.returns( { reason: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol } ) end @@ -355,13 +361,13 @@ module Imagekit # - `download_failed`: Could not download source video # - `internal_server_error`: Unexpected server error module Reason - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -369,23 +375,23 @@ module Imagekit ENCODING_FAILED = T.let( :encoding_failed, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) DOWNLOAD_FAILED = T.let( :download_failed, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) INTERNAL_SERVER_ERROR = T.let( :internal_server_error, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error::Reason::TaggedSymbol ] ) end @@ -394,12 +400,12 @@ module Imagekit end end - class Options < Imagekit::Internal::Type::BaseModel + class Options < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options, + Imagekitio::Internal::AnyHash ) end @@ -407,7 +413,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -416,7 +422,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -432,7 +438,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -441,7 +447,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -457,7 +463,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -466,7 +472,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -482,7 +488,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -491,7 +497,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -500,16 +506,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -534,16 +540,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -552,13 +558,13 @@ module Imagekit # Audio codec used for encoding (aac or opus). module AudioCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -566,18 +572,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -587,13 +593,13 @@ module Imagekit # Output format for the transformed video or thumbnail. module Format - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -601,33 +607,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -637,13 +643,13 @@ module Imagekit # Streaming protocol for adaptive bitrate streaming. module StreamProtocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -651,18 +657,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -672,13 +678,13 @@ module Imagekit # Video codec used for encoding (h264, vp9, or av1). module VideoCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -686,23 +692,23 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) AV1 = T.let( :av1, - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -713,12 +719,12 @@ module Imagekit end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationErrorEvent::Request, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationErrorEvent::Request, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekit/models/video_transformation_ready_event.rbi b/rbi/imagekitio/models/video_transformation_ready_event.rbi similarity index 67% rename from rbi/imagekit/models/video_transformation_ready_event.rbi rename to rbi/imagekitio/models/video_transformation_ready_event.rbi index 75a934d1..74927f9e 100644 --- a/rbi/imagekit/models/video_transformation_ready_event.rbi +++ b/rbi/imagekitio/models/video_transformation_ready_event.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Models - class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent + class VideoTransformationReadyEvent < Imagekitio::Models::BaseWebhookEvent OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent, + Imagekitio::Internal::AnyHash ) end @@ -15,21 +15,23 @@ module Imagekit sig { returns(Time) } attr_accessor :created_at - sig { returns(Imagekit::VideoTransformationReadyEvent::Data) } + sig { returns(Imagekitio::VideoTransformationReadyEvent::Data) } attr_reader :data sig do - params(data: Imagekit::VideoTransformationReadyEvent::Data::OrHash).void + params( + data: Imagekitio::VideoTransformationReadyEvent::Data::OrHash + ).void end attr_writer :data # Information about the original request that triggered the video transformation. - sig { returns(Imagekit::VideoTransformationReadyEvent::Request) } + sig { returns(Imagekitio::VideoTransformationReadyEvent::Request) } attr_reader :request sig do params( - request: Imagekit::VideoTransformationReadyEvent::Request::OrHash + request: Imagekitio::VideoTransformationReadyEvent::Request::OrHash ).void end attr_writer :request @@ -39,13 +41,13 @@ module Imagekit # Performance metrics for the transformation process. sig do - returns(T.nilable(Imagekit::VideoTransformationReadyEvent::Timings)) + returns(T.nilable(Imagekitio::VideoTransformationReadyEvent::Timings)) end attr_reader :timings sig do params( - timings: Imagekit::VideoTransformationReadyEvent::Timings::OrHash + timings: Imagekitio::VideoTransformationReadyEvent::Timings::OrHash ).void end attr_writer :timings @@ -57,9 +59,9 @@ module Imagekit sig do params( created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data::OrHash, - request: Imagekit::VideoTransformationReadyEvent::Request::OrHash, - timings: Imagekit::VideoTransformationReadyEvent::Timings::OrHash, + data: Imagekitio::VideoTransformationReadyEvent::Data::OrHash, + request: Imagekitio::VideoTransformationReadyEvent::Request::OrHash, + timings: Imagekitio::VideoTransformationReadyEvent::Timings::OrHash, type: Symbol ).returns(T.attached_class) end @@ -79,54 +81,58 @@ module Imagekit override.returns( { created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data, - request: Imagekit::VideoTransformationReadyEvent::Request, + data: Imagekitio::VideoTransformationReadyEvent::Data, + request: Imagekitio::VideoTransformationReadyEvent::Request, type: Symbol, - timings: Imagekit::VideoTransformationReadyEvent::Timings + timings: Imagekitio::VideoTransformationReadyEvent::Timings } ) end def to_hash end - class Data < Imagekit::Internal::Type::BaseModel + class Data < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent::Data, + Imagekitio::Internal::AnyHash ) end # Information about the source video asset being transformed. - sig { returns(Imagekit::VideoTransformationReadyEvent::Data::Asset) } + sig { returns(Imagekitio::VideoTransformationReadyEvent::Data::Asset) } attr_reader :asset sig do params( - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset::OrHash + asset: + Imagekitio::VideoTransformationReadyEvent::Data::Asset::OrHash ).void end attr_writer :asset sig do - returns(Imagekit::VideoTransformationReadyEvent::Data::Transformation) + returns( + Imagekitio::VideoTransformationReadyEvent::Data::Transformation + ) end attr_reader :transformation sig do params( transformation: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::OrHash ).void end attr_writer :transformation sig do params( - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset::OrHash, + asset: + Imagekitio::VideoTransformationReadyEvent::Data::Asset::OrHash, transformation: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::OrHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::OrHash ).returns(T.attached_class) end def self.new( @@ -139,21 +145,21 @@ module Imagekit sig do override.returns( { - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, + asset: Imagekitio::VideoTransformationReadyEvent::Data::Asset, transformation: - Imagekit::VideoTransformationReadyEvent::Data::Transformation + Imagekitio::VideoTransformationReadyEvent::Data::Transformation } ) end def to_hash end - class Asset < Imagekit::Internal::Type::BaseModel + class Asset < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Asset, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent::Data::Asset, + Imagekitio::Internal::AnyHash ) end @@ -174,12 +180,12 @@ module Imagekit end end - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Transformation, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation, + Imagekitio::Internal::AnyHash ) end @@ -191,7 +197,7 @@ module Imagekit # - `video-thumbnail`: Generate thumbnail image from video sig do returns( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) end attr_accessor :type @@ -200,7 +206,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options ) ) end @@ -209,7 +215,7 @@ module Imagekit sig do params( options: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash ).void end attr_writer :options @@ -218,7 +224,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output ) ) end @@ -227,7 +233,7 @@ module Imagekit sig do params( output: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash ).void end attr_writer :output @@ -235,11 +241,11 @@ module Imagekit sig do params( type: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::OrSymbol, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type::OrSymbol, options: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::OrHash, output: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::OrHash ).returns(T.attached_class) end def self.new( @@ -261,11 +267,11 @@ module Imagekit override.returns( { type: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol, options: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options, output: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output } ) end @@ -279,13 +285,13 @@ module Imagekit # - `gif-to-video`: Convert animated GIF to video format # - `video-thumbnail`: Generate thumbnail image from video module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -293,23 +299,23 @@ module Imagekit VIDEO_TRANSFORMATION = T.let( :"video-transformation", - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) GIF_TO_VIDEO = T.let( :"gif-to-video", - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) VIDEO_THUMBNAIL = T.let( :"video-thumbnail", - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type::TaggedSymbol ] ) end @@ -317,12 +323,12 @@ module Imagekit end end - class Options < Imagekit::Internal::Type::BaseModel + class Options < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options, + Imagekitio::Internal::AnyHash ) end @@ -330,7 +336,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) ) end @@ -339,7 +345,7 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol ).void end attr_writer :audio_codec @@ -355,7 +361,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) ) end @@ -364,7 +370,7 @@ module Imagekit sig do params( format_: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol ).void end attr_writer :format_ @@ -380,7 +386,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) ) end @@ -389,7 +395,7 @@ module Imagekit sig do params( stream_protocol: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol ).void end attr_writer :stream_protocol @@ -405,7 +411,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) ) end @@ -414,7 +420,7 @@ module Imagekit sig do params( video_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).void end attr_writer :video_codec @@ -423,16 +429,16 @@ module Imagekit sig do params( audio_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::OrSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::OrSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::OrSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::OrSymbol ).returns(T.attached_class) end def self.new( @@ -457,16 +463,16 @@ module Imagekit override.returns( { audio_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol, auto_rotate: T::Boolean, format_: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol, quality: Integer, stream_protocol: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol, variants: T::Array[String], video_codec: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol } ) end @@ -475,13 +481,13 @@ module Imagekit # Audio codec used for encoding (aac or opus). module AudioCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -489,18 +495,18 @@ module Imagekit AAC = T.let( :aac, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) OPUS = T.let( :opus, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec::TaggedSymbol ] ) end @@ -510,13 +516,13 @@ module Imagekit # Output format for the transformed video or thumbnail. module Format - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -524,33 +530,33 @@ module Imagekit MP4 = T.let( :mp4, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBM = T.let( :webm, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) JPG = T.let( :jpg, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) PNG = T.let( :png, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) WEBP = T.let( :webp, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format::TaggedSymbol ] ) end @@ -560,13 +566,13 @@ module Imagekit # Streaming protocol for adaptive bitrate streaming. module StreamProtocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -574,18 +580,18 @@ module Imagekit HLS = T.let( :HLS, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) DASH = T.let( :DASH, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol::TaggedSymbol ] ) end @@ -595,13 +601,13 @@ module Imagekit # Video codec used for encoding (h264, vp9, or av1). module VideoCodec - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TaggedSymbol = T.type_alias do T.all( Symbol, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -609,23 +615,23 @@ module Imagekit H264 = T.let( :h264, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) VP9 = T.let( :vp9, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) AV1 = T.let( :av1, - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ) sig do override.returns( T::Array[ - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec::TaggedSymbol ] ) end @@ -634,12 +640,12 @@ module Imagekit end end - class Output < Imagekit::Internal::Type::BaseModel + class Output < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output, + Imagekitio::Internal::AnyHash ) end @@ -651,7 +657,7 @@ module Imagekit sig do returns( T.nilable( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata ) ) end @@ -660,7 +666,7 @@ module Imagekit sig do params( video_metadata: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash ).void end attr_writer :video_metadata @@ -670,7 +676,7 @@ module Imagekit params( url: String, video_metadata: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -686,19 +692,19 @@ module Imagekit { url: String, video_metadata: - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata } ) end def to_hash end - class VideoMetadata < Imagekit::Internal::Type::BaseModel + class VideoMetadata < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, + Imagekitio::Internal::AnyHash ) end @@ -756,12 +762,12 @@ module Imagekit end end - class Request < Imagekit::Internal::Type::BaseModel + class Request < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Request, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent::Request, + Imagekitio::Internal::AnyHash ) end @@ -805,12 +811,12 @@ module Imagekit end end - class Timings < Imagekit::Internal::Type::BaseModel + class Timings < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - Imagekit::VideoTransformationReadyEvent::Timings, - Imagekit::Internal::AnyHash + Imagekitio::VideoTransformationReadyEvent::Timings, + Imagekitio::Internal::AnyHash ) end diff --git a/rbi/imagekitio/models/webhook_unsafe_unwrap_params.rbi b/rbi/imagekitio/models/webhook_unsafe_unwrap_params.rbi new file mode 100644 index 00000000..65b60535 --- /dev/null +++ b/rbi/imagekitio/models/webhook_unsafe_unwrap_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Imagekitio + module Models + class WebhookUnsafeUnwrapParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::WebhookUnsafeUnwrapParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekitio::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/webhook_unwrap_params.rbi b/rbi/imagekitio/models/webhook_unwrap_params.rbi new file mode 100644 index 00000000..9cecafa8 --- /dev/null +++ b/rbi/imagekitio/models/webhook_unwrap_params.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Imagekitio + module Models + class WebhookUnwrapParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Imagekitio::WebhookUnwrapParams, Imagekitio::Internal::AnyHash) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekitio::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekit/request_options.rbi b/rbi/imagekitio/request_options.rbi similarity index 84% rename from rbi/imagekit/request_options.rbi rename to rbi/imagekitio/request_options.rbi index 8f934bd4..74a6791a 100644 --- a/rbi/imagekit/request_options.rbi +++ b/rbi/imagekitio/request_options.rbi @@ -1,19 +1,19 @@ # typed: strong -module Imagekit +module Imagekitio # Specify HTTP behaviour to use for a specific request. These options supplement # or override those provided at the client level. # # When making a request, you can pass an actual {RequestOptions} instance, or # simply pass a Hash with symbol keys matching the attributes on this class. - class RequestOptions < Imagekit::Internal::Type::BaseModel + class RequestOptions < Imagekitio::Internal::Type::BaseModel OrHash = T.type_alias do - T.any(Imagekit::RequestOptions, Imagekit::Internal::AnyHash) + T.any(Imagekitio::RequestOptions, Imagekitio::Internal::AnyHash) end # @api private - sig { params(opts: Imagekit::RequestOptions::OrHash).void } + sig { params(opts: Imagekitio::RequestOptions::OrHash).void } def self.validate!(opts) end @@ -51,7 +51,7 @@ module Imagekit # Returns a new instance of RequestOptions. sig do - params(values: Imagekit::Internal::AnyHash).returns(T.attached_class) + params(values: Imagekitio::Internal::AnyHash).returns(T.attached_class) end def self.new(values = {}) end diff --git a/rbi/imagekitio/resources/accounts.rbi b/rbi/imagekitio/resources/accounts.rbi new file mode 100644 index 00000000..19a20e7f --- /dev/null +++ b/rbi/imagekitio/resources/accounts.rbi @@ -0,0 +1,21 @@ +# typed: strong + +module Imagekitio + module Resources + class Accounts + sig { returns(Imagekitio::Resources::Accounts::Usage) } + attr_reader :usage + + sig { returns(Imagekitio::Resources::Accounts::Origins) } + attr_reader :origins + + sig { returns(Imagekitio::Resources::Accounts::URLEndpoints) } + attr_reader :url_endpoints + + # @api private + sig { params(client: Imagekitio::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/resources/accounts/origins.rbi b/rbi/imagekitio/resources/accounts/origins.rbi similarity index 71% rename from rbi/imagekit/resources/accounts/origins.rbi rename to rbi/imagekitio/resources/accounts/origins.rbi index d7489d06..869a5dc5 100644 --- a/rbi/imagekit/resources/accounts/origins.rbi +++ b/rbi/imagekitio/resources/accounts/origins.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Accounts class Origins @@ -8,9 +8,9 @@ module Imagekit # Creates a new origin and returns the origin object. sig do params( - origin_request: Imagekit::Accounts::OriginRequest, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::OriginResponse::Variants) + origin_request: Imagekitio::Accounts::OriginRequest, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Accounts::OriginResponse::Variants) end def create( # Schema for origin request resources. @@ -24,9 +24,9 @@ module Imagekit sig do params( id: String, - origin_request: Imagekit::Accounts::OriginRequest, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::OriginResponse::Variants) + origin_request: Imagekitio::Accounts::OriginRequest, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Accounts::OriginResponse::Variants) end def update( # Unique identifier for the origin. This is generated by ImageKit when you create @@ -41,8 +41,8 @@ module Imagekit # **Note:** This API is currently in beta. # Returns an array of all configured origins for the current account. sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T::Array[Imagekit::Accounts::OriginResponse::Variants] + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T::Array[Imagekitio::Accounts::OriginResponse::Variants] ) end def list(request_options: {}) @@ -54,7 +54,7 @@ module Imagekit sig do params( id: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).void end def delete( @@ -70,8 +70,8 @@ module Imagekit sig do params( id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::OriginResponse::Variants) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Accounts::OriginResponse::Variants) end def get( # Unique identifier for the origin. This is generated by ImageKit when you create @@ -82,7 +82,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/accounts/url_endpoints.rbi b/rbi/imagekitio/resources/accounts/url_endpoints.rbi similarity index 75% rename from rbi/imagekit/resources/accounts/url_endpoints.rbi rename to rbi/imagekitio/resources/accounts/url_endpoints.rbi index 46a2a571..4346dbc8 100644 --- a/rbi/imagekit/resources/accounts/url_endpoints.rbi +++ b/rbi/imagekitio/resources/accounts/url_endpoints.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Accounts class URLEndpoints @@ -13,12 +13,12 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::URLEndpointResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Accounts::URLEndpointResponse) end def create( # Description of the URL endpoint. @@ -46,12 +46,12 @@ module Imagekit url_prefix: String, url_rewriter: T.any( - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash, + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash ), - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::URLEndpointResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Accounts::URLEndpointResponse) end def update( # Unique identifier for the URL-endpoint. This is generated by ImageKit when you @@ -77,8 +77,8 @@ module Imagekit # Returns an array of all URL‑endpoints configured including the default # URL-endpoint generated by ImageKit during account creation. sig do - params(request_options: Imagekit::RequestOptions::OrHash).returns( - T::Array[Imagekit::Accounts::URLEndpointResponse] + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T::Array[Imagekitio::Accounts::URLEndpointResponse] ) end def list(request_options: {}) @@ -90,7 +90,7 @@ module Imagekit sig do params( id: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).void end def delete( @@ -107,8 +107,8 @@ module Imagekit sig do params( id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Accounts::URLEndpointResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Accounts::URLEndpointResponse) end def get( # Unique identifier for the URL-endpoint. This is generated by ImageKit when you @@ -120,7 +120,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/accounts/usage.rbi b/rbi/imagekitio/resources/accounts/usage.rbi similarity index 82% rename from rbi/imagekit/resources/accounts/usage.rbi rename to rbi/imagekitio/resources/accounts/usage.rbi index 9efefba7..83fb3b2d 100644 --- a/rbi/imagekit/resources/accounts/usage.rbi +++ b/rbi/imagekitio/resources/accounts/usage.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Accounts class Usage @@ -12,8 +12,8 @@ module Imagekit params( end_date: Date, start_date: Date, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Accounts::UsageGetResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Accounts::UsageGetResponse) end def get( # Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. @@ -27,7 +27,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/assets.rbi b/rbi/imagekitio/resources/assets.rbi similarity index 85% rename from rbi/imagekit/resources/assets.rbi rename to rbi/imagekitio/resources/assets.rbi index 52e5efc0..14dda222 100644 --- a/rbi/imagekit/resources/assets.rbi +++ b/rbi/imagekitio/resources/assets.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Assets # This API can list all the uploaded files and folders in your ImageKit.io media @@ -9,15 +9,15 @@ module Imagekit # string as the value of the `searchQuery`. sig do params( - file_type: Imagekit::AssetListParams::FileType::OrSymbol, + file_type: Imagekitio::AssetListParams::FileType::OrSymbol, limit: Integer, path: String, search_query: String, skip: Integer, - sort: Imagekit::AssetListParams::Sort::OrSymbol, - type: Imagekit::AssetListParams::Type::OrSymbol, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T::Array[Imagekit::Models::AssetListResponseItem::Variants]) + sort: Imagekitio::AssetListParams::Sort::OrSymbol, + type: Imagekitio::AssetListParams::Type::OrSymbol, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(T::Array[Imagekitio::Models::AssetListResponseItem::Variants]) end def list( # Filter results by file type. @@ -66,7 +66,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/beta.rbi b/rbi/imagekitio/resources/beta.rbi similarity index 50% rename from rbi/imagekit/resources/beta.rbi rename to rbi/imagekitio/resources/beta.rbi index 6accb5af..5500afd7 100644 --- a/rbi/imagekit/resources/beta.rbi +++ b/rbi/imagekitio/resources/beta.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Beta - sig { returns(Imagekit::Resources::Beta::V2) } + sig { returns(Imagekitio::Resources::Beta::V2) } attr_reader :v2 # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/beta/v2.rbi b/rbi/imagekitio/resources/beta/v2.rbi similarity index 54% rename from rbi/imagekit/resources/beta/v2.rbi rename to rbi/imagekitio/resources/beta/v2.rbi index 829675dc..101abf70 100644 --- a/rbi/imagekit/resources/beta/v2.rbi +++ b/rbi/imagekitio/resources/beta/v2.rbi @@ -1,14 +1,14 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Beta class V2 - sig { returns(Imagekit::Resources::Beta::V2::Files) } + sig { returns(Imagekitio::Resources::Beta::V2::Files) } attr_reader :files # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/beta/v2/files.rbi b/rbi/imagekitio/resources/beta/v2/files.rbi similarity index 93% rename from rbi/imagekit/resources/beta/v2/files.rbi rename to rbi/imagekitio/resources/beta/v2/files.rbi index b78dc1c3..3991c1e0 100644 --- a/rbi/imagekit/resources/beta/v2/files.rbi +++ b/rbi/imagekitio/resources/beta/v2/files.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Beta class V2 @@ -34,7 +34,7 @@ module Imagekit # technologies. sig do params( - file: Imagekit::Internal::FileInput, + file: Imagekitio::Internal::FileInput, file_name: String, token: String, checks: String, @@ -44,9 +44,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + Imagekitio::ExtensionItem::RemoveBg::OrHash, + Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], folder: String, @@ -58,15 +58,15 @@ module Imagekit overwrite_tags: T::Boolean, response_fields: T::Array[ - Imagekit::Beta::V2::FileUploadParams::ResponseField::OrSymbol + Imagekitio::Beta::V2::FileUploadParams::ResponseField::OrSymbol ], tags: T::Array[String], transformation: - Imagekit::Beta::V2::FileUploadParams::Transformation::OrHash, + Imagekitio::Beta::V2::FileUploadParams::Transformation::OrHash, use_unique_file_name: T::Boolean, webhook_url: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Beta::V2::FileUploadResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Beta::V2::FileUploadResponse) end def upload( # The API accepts any of the following: @@ -183,7 +183,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/cache.rbi b/rbi/imagekitio/resources/cache.rbi similarity index 50% rename from rbi/imagekit/resources/cache.rbi rename to rbi/imagekitio/resources/cache.rbi index 5d9aa111..2f8a0364 100644 --- a/rbi/imagekit/resources/cache.rbi +++ b/rbi/imagekitio/resources/cache.rbi @@ -1,13 +1,13 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Cache - sig { returns(Imagekit::Resources::Cache::Invalidation) } + sig { returns(Imagekitio::Resources::Cache::Invalidation) } attr_reader :invalidation # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/cache/invalidation.rbi b/rbi/imagekitio/resources/cache/invalidation.rbi similarity index 69% rename from rbi/imagekit/resources/cache/invalidation.rbi rename to rbi/imagekitio/resources/cache/invalidation.rbi index e0aa6e8b..d3c6902c 100644 --- a/rbi/imagekit/resources/cache/invalidation.rbi +++ b/rbi/imagekitio/resources/cache/invalidation.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Cache class Invalidation @@ -10,8 +10,8 @@ module Imagekit sig do params( url: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Cache::InvalidationCreateResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Cache::InvalidationCreateResponse) end def create( # The full URL of the file to be purged. @@ -24,8 +24,8 @@ module Imagekit sig do params( request_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Cache::InvalidationGetResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Cache::InvalidationGetResponse) end def get( # Should be a valid requestId. @@ -35,7 +35,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/custom_metadata_fields.rbi b/rbi/imagekitio/resources/custom_metadata_fields.rbi similarity index 82% rename from rbi/imagekit/resources/custom_metadata_fields.rbi rename to rbi/imagekitio/resources/custom_metadata_fields.rbi index 15e89170..c3f0a4cb 100644 --- a/rbi/imagekit/resources/custom_metadata_fields.rbi +++ b/rbi/imagekitio/resources/custom_metadata_fields.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class CustomMetadataFields # This API creates a new custom metadata field. Once a custom metadata field is @@ -11,9 +11,9 @@ module Imagekit params( label: String, name: String, - schema: Imagekit::CustomMetadataFieldCreateParams::Schema::OrHash, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::CustomMetadataField) + schema: Imagekitio::CustomMetadataFieldCreateParams::Schema::OrHash, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::CustomMetadataField) end def create( # Human readable name of the custom metadata field. This should be unique across @@ -34,9 +34,9 @@ module Imagekit params( id: String, label: String, - schema: Imagekit::CustomMetadataFieldUpdateParams::Schema::OrHash, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::CustomMetadataField) + schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::CustomMetadataField) end def update( # Should be a valid custom metadata field id. @@ -67,8 +67,8 @@ module Imagekit params( folder_path: String, include_deleted: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T::Array[Imagekit::CustomMetadataField]) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(T::Array[Imagekitio::CustomMetadataField]) end def list( # The folder path (e.g., `/path/to/folder`) for which to retrieve applicable @@ -87,8 +87,8 @@ module Imagekit sig do params( id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::CustomMetadataFieldDeleteResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::CustomMetadataFieldDeleteResponse) end def delete( # Should be a valid custom metadata field id. @@ -98,7 +98,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/files.rbi b/rbi/imagekitio/resources/files.rbi similarity index 90% rename from rbi/imagekit/resources/files.rbi rename to rbi/imagekitio/resources/files.rbi index cec1cf6e..d44448c3 100644 --- a/rbi/imagekit/resources/files.rbi +++ b/rbi/imagekitio/resources/files.rbi @@ -1,15 +1,15 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Files - sig { returns(Imagekit::Resources::Files::Bulk) } + sig { returns(Imagekitio::Resources::Files::Bulk) } attr_reader :bulk - sig { returns(Imagekit::Resources::Files::Versions) } + sig { returns(Imagekitio::Resources::Files::Versions) } attr_reader :versions - sig { returns(Imagekit::Resources::Files::Metadata) } + sig { returns(Imagekitio::Resources::Files::Metadata) } attr_reader :metadata # This API updates the details or attributes of the current version of the file. @@ -18,9 +18,9 @@ module Imagekit sig do params( file_id: String, - update_file_request: Imagekit::UpdateFileRequest, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileUpdateResponse) + update_file_request: Imagekitio::UpdateFileRequest, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FileUpdateResponse) end def update( # The unique `fileId` of the uploaded file. `fileId` is returned in list and @@ -40,7 +40,7 @@ module Imagekit sig do params( file_id: String, - request_options: Imagekit::RequestOptions::OrHash + request_options: Imagekitio::RequestOptions::OrHash ).void end def delete( @@ -61,8 +61,8 @@ module Imagekit destination_path: String, source_file_path: String, include_file_versions: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileCopyResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FileCopyResponse) end def copy( # Full path to the folder you want to copy the above file into. @@ -82,8 +82,8 @@ module Imagekit sig do params( file_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::File) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::File) end def get( # The unique `fileId` of the uploaded file. `fileId` is returned in the list and @@ -101,8 +101,8 @@ module Imagekit params( destination_path: String, source_file_path: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileMoveResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FileMoveResponse) end def move( # Full path to the folder you want to move the above file into. @@ -123,8 +123,8 @@ module Imagekit file_path: String, new_file_name: String, purge_cache: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileRenameResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FileRenameResponse) end def rename( # The full path of the file you want to rename. @@ -186,7 +186,7 @@ module Imagekit # technologies. sig do params( - file: Imagekit::Internal::FileInput, + file: Imagekitio::Internal::FileInput, file_name: String, token: String, checks: String, @@ -197,9 +197,9 @@ module Imagekit extensions: T::Array[ T.any( - Imagekit::ExtensionItem::RemoveBg::OrHash, - Imagekit::ExtensionItem::AIAutoDescription::OrHash, - Imagekit::ExtensionItem::AutoTaggingExtension::OrHash + Imagekitio::ExtensionItem::RemoveBg::OrHash, + Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], folder: String, @@ -211,14 +211,14 @@ module Imagekit overwrite_tags: T::Boolean, public_key: String, response_fields: - T::Array[Imagekit::FileUploadParams::ResponseField::OrSymbol], + T::Array[Imagekitio::FileUploadParams::ResponseField::OrSymbol], signature: String, tags: T::Array[String], - transformation: Imagekit::FileUploadParams::Transformation::OrHash, + transformation: Imagekitio::FileUploadParams::Transformation::OrHash, use_unique_file_name: T::Boolean, webhook_url: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FileUploadResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FileUploadResponse) end def upload( # The API accepts any of the following: @@ -356,7 +356,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/files/bulk.rbi b/rbi/imagekitio/resources/files/bulk.rbi similarity index 78% rename from rbi/imagekit/resources/files/bulk.rbi rename to rbi/imagekitio/resources/files/bulk.rbi index 44af2dfe..90f03559 100644 --- a/rbi/imagekit/resources/files/bulk.rbi +++ b/rbi/imagekitio/resources/files/bulk.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Files class Bulk @@ -14,8 +14,8 @@ module Imagekit sig do params( file_ids: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::BulkDeleteResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Files::BulkDeleteResponse) end def delete( # An array of fileIds which you want to delete. @@ -30,8 +30,8 @@ module Imagekit params( file_ids: T::Array[String], tags: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::BulkAddTagsResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Files::BulkAddTagsResponse) end def add_tags( # An array of fileIds to which you want to add tags. @@ -48,8 +48,8 @@ module Imagekit params( ai_tags: T::Array[String], file_ids: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::BulkRemoveAITagsResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Files::BulkRemoveAITagsResponse) end def remove_ai_tags( # An array of AITags that you want to remove from the files. @@ -66,8 +66,8 @@ module Imagekit params( file_ids: T::Array[String], tags: T::Array[String], - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::BulkRemoveTagsResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Files::BulkRemoveTagsResponse) end def remove_tags( # An array of fileIds from which you want to remove tags. @@ -79,7 +79,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/files/metadata.rbi b/rbi/imagekitio/resources/files/metadata.rbi similarity index 78% rename from rbi/imagekit/resources/files/metadata.rbi rename to rbi/imagekitio/resources/files/metadata.rbi index 34ecc601..2a341ac4 100644 --- a/rbi/imagekit/resources/files/metadata.rbi +++ b/rbi/imagekitio/resources/files/metadata.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Files class Metadata @@ -12,8 +12,8 @@ module Imagekit sig do params( file_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Metadata) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Metadata) end def get( # The unique `fileId` of the uploaded file. `fileId` is returned in the list and @@ -28,8 +28,8 @@ module Imagekit sig do params( url: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Metadata) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Metadata) end def get_from_url( # Should be a valid file URL. It should be accessible using your ImageKit.io @@ -40,7 +40,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/files/versions.rbi b/rbi/imagekitio/resources/files/versions.rbi similarity index 81% rename from rbi/imagekit/resources/files/versions.rbi rename to rbi/imagekitio/resources/files/versions.rbi index c27aff5d..7b9dfbda 100644 --- a/rbi/imagekit/resources/files/versions.rbi +++ b/rbi/imagekitio/resources/files/versions.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Files class Versions @@ -8,8 +8,8 @@ module Imagekit sig do params( file_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(T::Array[Imagekit::File]) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(T::Array[Imagekitio::File]) end def list( # The unique `fileId` of the uploaded file. `fileId` is returned in list and @@ -27,8 +27,8 @@ module Imagekit params( version_id: String, file_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Files::VersionDeleteResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Files::VersionDeleteResponse) end def delete( # The unique `versionId` of the uploaded file. `versionId` is returned in list and @@ -46,8 +46,8 @@ module Imagekit params( version_id: String, file_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::File) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::File) end def get( # The unique `versionId` of the uploaded file. `versionId` is returned in list and @@ -65,8 +65,8 @@ module Imagekit params( version_id: String, file_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::File) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::File) end def restore( # The unique `versionId` of the uploaded file. `versionId` is returned in list and @@ -80,7 +80,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/folders.rbi b/rbi/imagekitio/resources/folders.rbi similarity index 87% rename from rbi/imagekit/resources/folders.rbi rename to rbi/imagekitio/resources/folders.rbi index 3fd9afd7..f5f29604 100644 --- a/rbi/imagekit/resources/folders.rbi +++ b/rbi/imagekitio/resources/folders.rbi @@ -1,9 +1,9 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Folders - sig { returns(Imagekit::Resources::Folders::Job) } + sig { returns(Imagekitio::Resources::Folders::Job) } attr_reader :job # This will create a new folder. You can specify the folder name and location of @@ -12,8 +12,8 @@ module Imagekit params( folder_name: String, parent_folder_path: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FolderCreateResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FolderCreateResponse) end def create( # The folder will be created with this name. @@ -39,8 +39,8 @@ module Imagekit sig do params( folder_path: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FolderDeleteResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FolderDeleteResponse) end def delete( # Full path to the folder you want to delete. For example `/folder/to/delete/`. @@ -59,8 +59,8 @@ module Imagekit destination_path: String, source_folder_path: String, include_versions: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FolderCopyResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FolderCopyResponse) end def copy( # Full path to the destination folder where you want to copy the source folder @@ -84,8 +84,8 @@ module Imagekit params( destination_path: String, source_folder_path: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FolderMoveResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FolderMoveResponse) end def move( # Full path to the destination folder where you want to move the source folder @@ -105,8 +105,8 @@ module Imagekit folder_path: String, new_folder_name: String, purge_cache: T::Boolean, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::FolderRenameResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::FolderRenameResponse) end def rename( # The full path to the folder you want to rename. @@ -138,7 +138,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekit/resources/folders/job.rbi b/rbi/imagekitio/resources/folders/job.rbi similarity index 70% rename from rbi/imagekit/resources/folders/job.rbi rename to rbi/imagekitio/resources/folders/job.rbi index f59139e4..8b7d01b1 100644 --- a/rbi/imagekit/resources/folders/job.rbi +++ b/rbi/imagekitio/resources/folders/job.rbi @@ -1,6 +1,6 @@ # typed: strong -module Imagekit +module Imagekitio module Resources class Folders class Job @@ -8,8 +8,8 @@ module Imagekit sig do params( job_id: String, - request_options: Imagekit::RequestOptions::OrHash - ).returns(Imagekit::Models::Folders::JobGetResponse) + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::Models::Folders::JobGetResponse) end def get( # The `jobId` is returned in the response of bulk job API e.g. copy folder or move @@ -20,7 +20,7 @@ module Imagekit end # @api private - sig { params(client: Imagekit::Client).returns(T.attached_class) } + sig { params(client: Imagekitio::Client).returns(T.attached_class) } def self.new(client:) end end diff --git a/rbi/imagekitio/resources/webhooks.rbi b/rbi/imagekitio/resources/webhooks.rbi new file mode 100644 index 00000000..0dadc535 --- /dev/null +++ b/rbi/imagekitio/resources/webhooks.rbi @@ -0,0 +1,50 @@ +# typed: strong + +module Imagekitio + module Resources + class Webhooks + sig do + params(payload: String).returns( + T.any( + Imagekitio::VideoTransformationAcceptedEvent, + Imagekitio::VideoTransformationReadyEvent, + Imagekitio::VideoTransformationErrorEvent, + Imagekitio::UploadPreTransformSuccessEvent, + Imagekitio::UploadPreTransformErrorEvent, + Imagekitio::UploadPostTransformSuccessEvent, + Imagekitio::UploadPostTransformErrorEvent + ) + ) + end + def unsafe_unwrap( + # The raw webhook payload as a string + payload + ) + end + + sig do + params(payload: String).returns( + T.any( + Imagekitio::VideoTransformationAcceptedEvent, + Imagekitio::VideoTransformationReadyEvent, + Imagekitio::VideoTransformationErrorEvent, + Imagekitio::UploadPreTransformSuccessEvent, + Imagekitio::UploadPreTransformErrorEvent, + Imagekitio::UploadPostTransformSuccessEvent, + Imagekitio::UploadPostTransformErrorEvent + ) + ) + end + def unwrap( + # The raw webhook payload as a string + payload + ) + end + + # @api private + sig { params(client: Imagekitio::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/imagekit/version.rbi b/rbi/imagekitio/version.rbi similarity index 77% rename from rbi/imagekit/version.rbi rename to rbi/imagekitio/version.rbi index dd908e9e..1db4e4b8 100644 --- a/rbi/imagekit/version.rbi +++ b/rbi/imagekitio/version.rbi @@ -1,5 +1,5 @@ # typed: strong -module Imagekit +module Imagekitio VERSION = T.let(T.unsafe(nil), String) end diff --git a/release-please-config.json b/release-please-config.json index 32536019..70a47571 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -60,7 +60,7 @@ } ], "release-type": "ruby", - "version-file": "lib/imagekit/version.rb", + "version-file": "lib/imagekitio/version.rb", "extra-files": [ { "type": "ruby-readme", diff --git a/sig/imagekit/internal/type/converter.rbs b/sig/imagekit/internal/type/converter.rbs deleted file mode 100644 index 30d3221f..00000000 --- a/sig/imagekit/internal/type/converter.rbs +++ /dev/null @@ -1,79 +0,0 @@ -module Imagekit - module Internal - module Type - module Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport - - type input = Imagekit::Internal::Type::Converter | Class - - type coerce_state = - { - translate_names: bool, - strictness: bool, - exactness: { yes: Integer, no: Integer, maybe: Integer }, - error: Class, - branched: Integer - } - - type dump_state = { can_retry: bool } - - def coerce: ( - top value, - state: Imagekit::Internal::Type::Converter::coerce_state - ) -> top - - def dump: ( - top value, - state: Imagekit::Internal::Type::Converter::dump_state - ) -> top - - def inspect: (?depth: Integer) -> String - - def self.type_info: ( - { - const: (nil | bool | Integer | Float | Symbol)?, - enum: ^-> Imagekit::Internal::Type::Converter::input?, - union: ^-> Imagekit::Internal::Type::Converter::input? - } - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input spec - ) -> (^-> top) - - def self.meta_info: ( - { - const: (nil | bool | Integer | Float | Symbol)?, - enum: ^-> Imagekit::Internal::Type::Converter::input?, - union: ^-> Imagekit::Internal::Type::Converter::input? - } - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input type_info, - { - const: (nil | bool | Integer | Float | Symbol)?, - enum: ^-> Imagekit::Internal::Type::Converter::input?, - union: ^-> Imagekit::Internal::Type::Converter::input? - } - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input spec - ) -> ::Hash[Symbol, top] - - def self.new_coerce_state: ( - ?translate_names: bool - ) -> Imagekit::Internal::Type::Converter::coerce_state - - def self.coerce: ( - Imagekit::Internal::Type::Converter::input target, - top value, - ?state: Imagekit::Internal::Type::Converter::coerce_state - ) -> top - - def self.dump: ( - Imagekit::Internal::Type::Converter::input target, - top value, - ?state: Imagekit::Internal::Type::Converter::dump_state - ) -> top - - def self.inspect: (top target, depth: Integer) -> String - end - end - end -end diff --git a/sig/imagekit/internal/type/request_parameters.rbs b/sig/imagekit/internal/type/request_parameters.rbs deleted file mode 100644 index 33e5d91c..00000000 --- a/sig/imagekit/internal/type/request_parameters.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Internal - module Type - type request_parameters = { request_options: Imagekit::request_opts } - - module RequestParameters - attr_reader request_options: Imagekit::request_opts - - def request_options=: (Imagekit::request_opts) -> Imagekit::request_opts - - module Converter - def dump_request: (top params) -> [top, ::Hash[Symbol, top]] - end - end - end - end -end diff --git a/sig/imagekit/models.rbs b/sig/imagekit/models.rbs deleted file mode 100644 index 53e1009d..00000000 --- a/sig/imagekit/models.rbs +++ /dev/null @@ -1,119 +0,0 @@ -module Imagekit - module Accounts = Imagekit::Models::Accounts - - class AssetListParams = Imagekit::Models::AssetListParams - - class BaseOverlay = Imagekit::Models::BaseOverlay - - class BaseWebhookEvent = Imagekit::Models::BaseWebhookEvent - - module Beta = Imagekit::Models::Beta - - module Cache = Imagekit::Models::Cache - - class CustomMetadataField = Imagekit::Models::CustomMetadataField - - class CustomMetadataFieldCreateParams = Imagekit::Models::CustomMetadataFieldCreateParams - - class CustomMetadataFieldDeleteParams = Imagekit::Models::CustomMetadataFieldDeleteParams - - class CustomMetadataFieldListParams = Imagekit::Models::CustomMetadataFieldListParams - - class CustomMetadataFieldUpdateParams = Imagekit::Models::CustomMetadataFieldUpdateParams - - type extension_item = Imagekit::Models::extension_item - - Extensions: Imagekit::Internal::Type::Converter - - class File = Imagekit::Models::File - - class FileCopyParams = Imagekit::Models::FileCopyParams - - class FileDeleteParams = Imagekit::Models::FileDeleteParams - - class FileGetParams = Imagekit::Models::FileGetParams - - class FileMoveParams = Imagekit::Models::FileMoveParams - - class FileRenameParams = Imagekit::Models::FileRenameParams - - module Files = Imagekit::Models::Files - - class FileUpdateParams = Imagekit::Models::FileUpdateParams - - class FileUploadParams = Imagekit::Models::FileUploadParams - - class Folder = Imagekit::Models::Folder - - class FolderCopyParams = Imagekit::Models::FolderCopyParams - - class FolderCreateParams = Imagekit::Models::FolderCreateParams - - class FolderDeleteParams = Imagekit::Models::FolderDeleteParams - - class FolderMoveParams = Imagekit::Models::FolderMoveParams - - class FolderRenameParams = Imagekit::Models::FolderRenameParams - - module Folders = Imagekit::Models::Folders - - class GetImageAttributesOptions = Imagekit::Models::GetImageAttributesOptions - - class ImageOverlay = Imagekit::Models::ImageOverlay - - class Metadata = Imagekit::Models::Metadata - - module Overlay = Imagekit::Models::Overlay - - class OverlayPosition = Imagekit::Models::OverlayPosition - - class OverlayTiming = Imagekit::Models::OverlayTiming - - class ResponsiveImageAttributes = Imagekit::Models::ResponsiveImageAttributes - - class SolidColorOverlay = Imagekit::Models::SolidColorOverlay - - class SolidColorOverlayTransformation = Imagekit::Models::SolidColorOverlayTransformation - - class SrcOptions = Imagekit::Models::SrcOptions - - module StreamingResolution = Imagekit::Models::StreamingResolution - - class SubtitleOverlay = Imagekit::Models::SubtitleOverlay - - class SubtitleOverlayTransformation = Imagekit::Models::SubtitleOverlayTransformation - - class TextOverlay = Imagekit::Models::TextOverlay - - class TextOverlayTransformation = Imagekit::Models::TextOverlayTransformation - - class Transformation = Imagekit::Models::Transformation - - module TransformationPosition = Imagekit::Models::TransformationPosition - - module UnsafeUnwrapWebhookEvent = Imagekit::Models::UnsafeUnwrapWebhookEvent - - module UnwrapWebhookEvent = Imagekit::Models::UnwrapWebhookEvent - - module UpdateFileRequest = Imagekit::Models::UpdateFileRequest - - class UploadPostTransformErrorEvent = Imagekit::Models::UploadPostTransformErrorEvent - - class UploadPostTransformSuccessEvent = Imagekit::Models::UploadPostTransformSuccessEvent - - class UploadPreTransformErrorEvent = Imagekit::Models::UploadPreTransformErrorEvent - - class UploadPreTransformSuccessEvent = Imagekit::Models::UploadPreTransformSuccessEvent - - class VideoOverlay = Imagekit::Models::VideoOverlay - - class VideoTransformationAcceptedEvent = Imagekit::Models::VideoTransformationAcceptedEvent - - class VideoTransformationErrorEvent = Imagekit::Models::VideoTransformationErrorEvent - - class VideoTransformationReadyEvent = Imagekit::Models::VideoTransformationReadyEvent - - class WebhookUnsafeUnwrapParams = Imagekit::Models::WebhookUnsafeUnwrapParams - - class WebhookUnwrapParams = Imagekit::Models::WebhookUnwrapParams -end diff --git a/sig/imagekit/models/accounts/origin_create_params.rbs b/sig/imagekit/models/accounts/origin_create_params.rbs deleted file mode 100644 index a51e6472..00000000 --- a/sig/imagekit/models/accounts/origin_create_params.rbs +++ /dev/null @@ -1,30 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_create_params = - { origin_request: Imagekit::Models::Accounts::origin_request } - & Imagekit::Internal::Type::request_parameters - - class OriginCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def origin_request: -> Imagekit::Models::Accounts::origin_request - - def origin_request=: ( - Imagekit::Models::Accounts::origin_request _ - ) -> Imagekit::Models::Accounts::origin_request - - def initialize: ( - origin_request: Imagekit::Models::Accounts::origin_request, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - origin_request: Imagekit::Models::Accounts::origin_request, - request_options: Imagekit::RequestOptions - } - end - end - end -end diff --git a/sig/imagekit/models/accounts/origin_delete_params.rbs b/sig/imagekit/models/accounts/origin_delete_params.rbs deleted file mode 100644 index da2cff14..00000000 --- a/sig/imagekit/models/accounts/origin_delete_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_delete_params = - { } & Imagekit::Internal::Type::request_parameters - - class OriginDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/accounts/origin_get_params.rbs b/sig/imagekit/models/accounts/origin_get_params.rbs deleted file mode 100644 index b80c072e..00000000 --- a/sig/imagekit/models/accounts/origin_get_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_get_params = - { } & Imagekit::Internal::Type::request_parameters - - class OriginGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/accounts/origin_list_params.rbs b/sig/imagekit/models/accounts/origin_list_params.rbs deleted file mode 100644 index ea2e0350..00000000 --- a/sig/imagekit/models/accounts/origin_list_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_list_params = - { } & Imagekit::Internal::Type::request_parameters - - class OriginListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/accounts/origin_list_response.rbs b/sig/imagekit/models/accounts/origin_list_response.rbs deleted file mode 100644 index e689073a..00000000 --- a/sig/imagekit/models/accounts/origin_list_response.rbs +++ /dev/null @@ -1,10 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_list_response = - ::Array[Imagekit::Models::Accounts::origin_response] - - OriginListResponse: Imagekit::Internal::Type::Converter - end - end -end diff --git a/sig/imagekit/models/accounts/origin_update_params.rbs b/sig/imagekit/models/accounts/origin_update_params.rbs deleted file mode 100644 index e6e08583..00000000 --- a/sig/imagekit/models/accounts/origin_update_params.rbs +++ /dev/null @@ -1,30 +0,0 @@ -module Imagekit - module Models - module Accounts - type origin_update_params = - { origin_request: Imagekit::Models::Accounts::origin_request } - & Imagekit::Internal::Type::request_parameters - - class OriginUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def origin_request: -> Imagekit::Models::Accounts::origin_request - - def origin_request=: ( - Imagekit::Models::Accounts::origin_request _ - ) -> Imagekit::Models::Accounts::origin_request - - def initialize: ( - origin_request: Imagekit::Models::Accounts::origin_request, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - origin_request: Imagekit::Models::Accounts::origin_request, - request_options: Imagekit::RequestOptions - } - end - end - end -end diff --git a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs b/sig/imagekit/models/accounts/url_endpoint_create_params.rbs deleted file mode 100644 index d657e79d..00000000 --- a/sig/imagekit/models/accounts/url_endpoint_create_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Accounts - type url_endpoint_create_params = - { } & Imagekit::Internal::Type::request_parameters - - class URLEndpointCreateParams < Imagekit::Models::Accounts::URLEndpointRequest - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/accounts/url_endpoint_delete_params.rbs b/sig/imagekit/models/accounts/url_endpoint_delete_params.rbs deleted file mode 100644 index ea88292a..00000000 --- a/sig/imagekit/models/accounts/url_endpoint_delete_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Accounts - type url_endpoint_delete_params = - { } & Imagekit::Internal::Type::request_parameters - - class URLEndpointDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/accounts/url_endpoint_get_params.rbs b/sig/imagekit/models/accounts/url_endpoint_get_params.rbs deleted file mode 100644 index f13c5bf6..00000000 --- a/sig/imagekit/models/accounts/url_endpoint_get_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Accounts - type url_endpoint_get_params = - { } & Imagekit::Internal::Type::request_parameters - - class URLEndpointGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/accounts/url_endpoint_list_params.rbs b/sig/imagekit/models/accounts/url_endpoint_list_params.rbs deleted file mode 100644 index f90a121a..00000000 --- a/sig/imagekit/models/accounts/url_endpoint_list_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Accounts - type url_endpoint_list_params = - { } & Imagekit::Internal::Type::request_parameters - - class URLEndpointListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs b/sig/imagekit/models/accounts/url_endpoint_list_response.rbs deleted file mode 100644 index 01943b07..00000000 --- a/sig/imagekit/models/accounts/url_endpoint_list_response.rbs +++ /dev/null @@ -1,10 +0,0 @@ -module Imagekit - module Models - module Accounts - type url_endpoint_list_response = - ::Array[Imagekit::Accounts::URLEndpointResponse] - - URLEndpointListResponse: Imagekit::Internal::Type::Converter - end - end -end diff --git a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs b/sig/imagekit/models/accounts/url_endpoint_update_params.rbs deleted file mode 100644 index 0989d858..00000000 --- a/sig/imagekit/models/accounts/url_endpoint_update_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Accounts - type url_endpoint_update_params = - { } & Imagekit::Internal::Type::request_parameters - - class URLEndpointUpdateParams < Imagekit::Models::Accounts::URLEndpointRequest - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/asset_list_response.rbs b/sig/imagekit/models/asset_list_response.rbs deleted file mode 100644 index f60e52fd..00000000 --- a/sig/imagekit/models/asset_list_response.rbs +++ /dev/null @@ -1,16 +0,0 @@ -module Imagekit - module Models - type asset_list_response_item = Imagekit::Folder | Imagekit::File - - module AssetListResponseItem - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::asset_list_response_item] - end - - type asset_list_response = - ::Array[Imagekit::Models::asset_list_response_item] - - AssetListResponse: Imagekit::Internal::Type::Converter - end -end diff --git a/sig/imagekit/models/base_overlay.rbs b/sig/imagekit/models/base_overlay.rbs deleted file mode 100644 index 5b012352..00000000 --- a/sig/imagekit/models/base_overlay.rbs +++ /dev/null @@ -1,26 +0,0 @@ -module Imagekit - module Models - type base_overlay = - { position: Imagekit::OverlayPosition, timing: Imagekit::OverlayTiming } - - class BaseOverlay < Imagekit::Internal::Type::BaseModel - attr_reader position: Imagekit::OverlayPosition? - - def position=: (Imagekit::OverlayPosition) -> Imagekit::OverlayPosition - - attr_reader timing: Imagekit::OverlayTiming? - - def timing=: (Imagekit::OverlayTiming) -> Imagekit::OverlayTiming - - def initialize: ( - ?position: Imagekit::OverlayPosition, - ?timing: Imagekit::OverlayTiming - ) -> void - - def to_hash: -> { - position: Imagekit::OverlayPosition, - timing: Imagekit::OverlayTiming - } - end - end -end diff --git a/sig/imagekit/models/beta/v2/file_upload_response.rbs b/sig/imagekit/models/beta/v2/file_upload_response.rbs deleted file mode 100644 index b476afd8..00000000 --- a/sig/imagekit/models/beta/v2/file_upload_response.rbs +++ /dev/null @@ -1,487 +0,0 @@ -module Imagekit - module Models - module Beta - module V2 - type file_upload_response = - { - ai_tags: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - duration: Integer, - embedded_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Metadata, - name: String, - selected_fields_schema: ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, - video_codec: String, - width: Float - } - - class FileUploadResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]? - - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader embedded_metadata: ::Hash[Symbol, top]? - - def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus? - - def extension_status=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader metadata: Imagekit::Metadata? - - def metadata=: (Imagekit::Metadata) -> Imagekit::Metadata - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema]? - - def selected_fields_schema=: ( - ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] - ) -> ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail_url: String? - - def thumbnail_url=: (String) -> String - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo? - - def version_info=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]?, - ?audio_codec: String, - ?bit_rate: Integer, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?duration: Integer, - ?embedded_metadata: ::Hash[Symbol, top], - ?extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?metadata: Imagekit::Metadata, - ?name: String, - ?selected_fields_schema: ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail_url: String, - ?url: String, - ?version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, - ?video_codec: String, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - duration: Integer, - embedded_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Metadata, - name: String, - selected_fields_schema: ::Hash[Symbol, Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo, - video_codec: String, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type extension_status = - { - ai_auto_description: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, - aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg - } - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - attr_reader ai_auto_description: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description? - - def ai_auto_description=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description - - attr_reader aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging? - - def aws_auto_tagging=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging - - attr_reader google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging? - - def google_auto_tagging=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging - - attr_reader remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg? - - def remove_bg=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg - - def initialize: ( - ?ai_auto_description: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, - ?aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, - ?google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, - ?remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg - ) -> void - - def to_hash: -> { - ai_auto_description: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, - aws_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg - } - - type ai_auto_description = :success | :pending | :failed - - module AIAutoDescription - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description] - end - - type aws_auto_tagging = :success | :pending | :failed - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging] - end - - type google_auto_tagging = :success | :pending | :failed - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging] - end - - type remove_bg = :success | :pending | :failed - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg] - end - end - - type selected_fields_schema = - { - type: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_ - - attr_reader default_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value? - - def default_value=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value? - - def max_value=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value? - - def min_value=: ( - Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value - ) -> Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value - - attr_reader read_only: bool? - - def read_only=: (bool) -> bool - - attr_reader select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] - ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] - - attr_reader select_options_truncated: bool? - - def select_options_truncated=: (bool) -> bool - - def initialize: ( - type: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, - ?default_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, - ?read_only: bool, - ?select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], - ?select_options_truncated: bool - ) -> void - - def to_hash: -> { - type: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] - end - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - end - end - end -end diff --git a/sig/imagekit/models/cache/invalidation_create_params.rbs b/sig/imagekit/models/cache/invalidation_create_params.rbs deleted file mode 100644 index 6bd7b3d4..00000000 --- a/sig/imagekit/models/cache/invalidation_create_params.rbs +++ /dev/null @@ -1,25 +0,0 @@ -module Imagekit - module Models - module Cache - type invalidation_create_params = - { url: String } & Imagekit::Internal::Type::request_parameters - - class InvalidationCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor url: String - - def initialize: ( - url: String, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - url: String, - request_options: Imagekit::RequestOptions - } - end - end - end -end diff --git a/sig/imagekit/models/cache/invalidation_get_params.rbs b/sig/imagekit/models/cache/invalidation_get_params.rbs deleted file mode 100644 index ff6bb012..00000000 --- a/sig/imagekit/models/cache/invalidation_get_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Cache - type invalidation_get_params = - { } & Imagekit::Internal::Type::request_parameters - - class InvalidationGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/cache/invalidation_get_response.rbs b/sig/imagekit/models/cache/invalidation_get_response.rbs deleted file mode 100644 index 0c937b59..00000000 --- a/sig/imagekit/models/cache/invalidation_get_response.rbs +++ /dev/null @@ -1,35 +0,0 @@ -module Imagekit - module Models - module Cache - type invalidation_get_response = - { status: Imagekit::Models::Cache::InvalidationGetResponse::status } - - class InvalidationGetResponse < Imagekit::Internal::Type::BaseModel - attr_reader status: Imagekit::Models::Cache::InvalidationGetResponse::status? - - def status=: ( - Imagekit::Models::Cache::InvalidationGetResponse::status - ) -> Imagekit::Models::Cache::InvalidationGetResponse::status - - def initialize: ( - ?status: Imagekit::Models::Cache::InvalidationGetResponse::status - ) -> void - - def to_hash: -> { - status: Imagekit::Models::Cache::InvalidationGetResponse::status - } - - type status = :Pending | :Completed - - module Status - extend Imagekit::Internal::Type::Enum - - PENDING: :Pending - COMPLETED: :Completed - - def self?.values: -> ::Array[Imagekit::Models::Cache::InvalidationGetResponse::status] - end - end - end - end -end diff --git a/sig/imagekit/models/custom_metadata_field.rbs b/sig/imagekit/models/custom_metadata_field.rbs deleted file mode 100644 index c141a507..00000000 --- a/sig/imagekit/models/custom_metadata_field.rbs +++ /dev/null @@ -1,178 +0,0 @@ -module Imagekit - module Models - type custom_metadata_field = - { - id: String, - label: String, - name: String, - schema: Imagekit::CustomMetadataField::Schema - } - - class CustomMetadataField < Imagekit::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor label: String - - attr_accessor name: String - - attr_accessor schema: Imagekit::CustomMetadataField::Schema - - def initialize: ( - id: String, - label: String, - name: String, - schema: Imagekit::CustomMetadataField::Schema - ) -> void - - def to_hash: -> { - id: String, - label: String, - name: String, - schema: Imagekit::CustomMetadataField::Schema - } - - type schema = - { - type: Imagekit::Models::CustomMetadataField::Schema::type_, - default_value: Imagekit::Models::CustomMetadataField::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataField::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataField::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] - } - - class Schema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::CustomMetadataField::Schema::type_ - - attr_reader default_value: Imagekit::Models::CustomMetadataField::Schema::default_value? - - def default_value=: ( - Imagekit::Models::CustomMetadataField::Schema::default_value - ) -> Imagekit::Models::CustomMetadataField::Schema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::CustomMetadataField::Schema::max_value? - - def max_value=: ( - Imagekit::Models::CustomMetadataField::Schema::max_value - ) -> Imagekit::Models::CustomMetadataField::Schema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::CustomMetadataField::Schema::min_value? - - def min_value=: ( - Imagekit::Models::CustomMetadataField::Schema::min_value - ) -> Imagekit::Models::CustomMetadataField::Schema::min_value - - attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] - ) -> ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] - - def initialize: ( - type: Imagekit::Models::CustomMetadataField::Schema::type_, - ?default_value: Imagekit::Models::CustomMetadataField::Schema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::CustomMetadataField::Schema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::CustomMetadataField::Schema::min_value, - ?select_options: ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] - ) -> void - - def to_hash: -> { - type: Imagekit::Models::CustomMetadataField::Schema::type_, - default_value: Imagekit::Models::CustomMetadataField::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataField::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataField::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataField::Schema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataField::Schema::select_option] - end - end - end - end -end diff --git a/sig/imagekit/models/custom_metadata_field_create_params.rbs b/sig/imagekit/models/custom_metadata_field_create_params.rbs deleted file mode 100644 index 1d4f85db..00000000 --- a/sig/imagekit/models/custom_metadata_field_create_params.rbs +++ /dev/null @@ -1,179 +0,0 @@ -module Imagekit - module Models - type custom_metadata_field_create_params = - { - label: String, - name: String, - schema: Imagekit::CustomMetadataFieldCreateParams::Schema - } - & Imagekit::Internal::Type::request_parameters - - class CustomMetadataFieldCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor label: String - - attr_accessor name: String - - attr_accessor schema: Imagekit::CustomMetadataFieldCreateParams::Schema - - def initialize: ( - label: String, - name: String, - schema: Imagekit::CustomMetadataFieldCreateParams::Schema, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - label: String, - name: String, - schema: Imagekit::CustomMetadataFieldCreateParams::Schema, - request_options: Imagekit::RequestOptions - } - - type schema = - { - type: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_, - default_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] - } - - class Schema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_ - - attr_reader default_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value? - - def default_value=: ( - Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value - ) -> Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value? - - def max_value=: ( - Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value - ) -> Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value? - - def min_value=: ( - Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value - ) -> Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value - - attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] - ) -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] - - def initialize: ( - type: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_, - ?default_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value, - ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] - ) -> void - - def to_hash: -> { - type: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_, - default_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldCreateParams::Schema::select_option] - end - end - end - end -end diff --git a/sig/imagekit/models/custom_metadata_field_delete_params.rbs b/sig/imagekit/models/custom_metadata_field_delete_params.rbs deleted file mode 100644 index 567c6c64..00000000 --- a/sig/imagekit/models/custom_metadata_field_delete_params.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type custom_metadata_field_delete_params = - { } & Imagekit::Internal::Type::request_parameters - - class CustomMetadataFieldDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end -end diff --git a/sig/imagekit/models/custom_metadata_field_list_response.rbs b/sig/imagekit/models/custom_metadata_field_list_response.rbs deleted file mode 100644 index 7aa86e95..00000000 --- a/sig/imagekit/models/custom_metadata_field_list_response.rbs +++ /dev/null @@ -1,8 +0,0 @@ -module Imagekit - module Models - type custom_metadata_field_list_response = - ::Array[Imagekit::CustomMetadataField] - - CustomMetadataFieldListResponse: Imagekit::Internal::Type::Converter - end -end diff --git a/sig/imagekit/models/custom_metadata_field_update_params.rbs b/sig/imagekit/models/custom_metadata_field_update_params.rbs deleted file mode 100644 index 9da6ca07..00000000 --- a/sig/imagekit/models/custom_metadata_field_update_params.rbs +++ /dev/null @@ -1,152 +0,0 @@ -module Imagekit - module Models - type custom_metadata_field_update_params = - { - label: String, - schema: Imagekit::CustomMetadataFieldUpdateParams::Schema - } - & Imagekit::Internal::Type::request_parameters - - class CustomMetadataFieldUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_reader label: String? - - def label=: (String) -> String - - attr_reader schema: Imagekit::CustomMetadataFieldUpdateParams::Schema? - - def schema=: ( - Imagekit::CustomMetadataFieldUpdateParams::Schema - ) -> Imagekit::CustomMetadataFieldUpdateParams::Schema - - def initialize: ( - ?label: String, - ?schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - label: String, - schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, - request_options: Imagekit::RequestOptions - } - - type schema = - { - default_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] - } - - class Schema < Imagekit::Internal::Type::BaseModel - attr_reader default_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value? - - def default_value=: ( - Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value - ) -> Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value? - - def max_value=: ( - Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value - ) -> Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value? - - def min_value=: ( - Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value - ) -> Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value - - attr_reader select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] - ) -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] - - def initialize: ( - ?default_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value, - ?select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] - ) -> void - - def to_hash: -> { - default_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value, - min_length: Float, - min_value: Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value, - select_options: ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] - } - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::CustomMetadataFieldUpdateParams::Schema::select_option] - end - end - end - end -end diff --git a/sig/imagekit/models/file_delete_params.rbs b/sig/imagekit/models/file_delete_params.rbs deleted file mode 100644 index 4cd8aaa5..00000000 --- a/sig/imagekit/models/file_delete_params.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type file_delete_params = - { } & Imagekit::Internal::Type::request_parameters - - class FileDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end -end diff --git a/sig/imagekit/models/file_get_params.rbs b/sig/imagekit/models/file_get_params.rbs deleted file mode 100644 index 1a204dfb..00000000 --- a/sig/imagekit/models/file_get_params.rbs +++ /dev/null @@ -1,14 +0,0 @@ -module Imagekit - module Models - type file_get_params = { } & Imagekit::Internal::Type::request_parameters - - class FileGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end -end diff --git a/sig/imagekit/models/file_update_params.rbs b/sig/imagekit/models/file_update_params.rbs deleted file mode 100644 index be8da6ac..00000000 --- a/sig/imagekit/models/file_update_params.rbs +++ /dev/null @@ -1,28 +0,0 @@ -module Imagekit - module Models - type file_update_params = - { update_file_request: Imagekit::Models::update_file_request } - & Imagekit::Internal::Type::request_parameters - - class FileUpdateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def update_file_request: -> Imagekit::Models::update_file_request - - def update_file_request=: ( - Imagekit::Models::update_file_request _ - ) -> Imagekit::Models::update_file_request - - def initialize: ( - update_file_request: Imagekit::Models::update_file_request, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - update_file_request: Imagekit::Models::update_file_request, - request_options: Imagekit::RequestOptions - } - end - end -end diff --git a/sig/imagekit/models/file_update_response.rbs b/sig/imagekit/models/file_update_response.rbs deleted file mode 100644 index 5a223c95..00000000 --- a/sig/imagekit/models/file_update_response.rbs +++ /dev/null @@ -1,120 +0,0 @@ -module Imagekit - module Models - type file_update_response = - { - extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus - } - - class FileUpdateResponse < Imagekit::Models::File - def extension_status: -> Imagekit::Models::FileUpdateResponse::ExtensionStatus? - - def extension_status=: ( - Imagekit::Models::FileUpdateResponse::ExtensionStatus _ - ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus - - def initialize: ( - ?extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus - ) -> void - - def to_hash: -> { - extension_status: Imagekit::Models::FileUpdateResponse::ExtensionStatus - } - - type extension_status = - { - ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, - aws_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg - } - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - attr_reader ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description? - - def ai_auto_description=: ( - Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description - ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description - - attr_reader aws_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging? - - def aws_auto_tagging=: ( - Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging - ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging - - attr_reader google_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging? - - def google_auto_tagging=: ( - Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging - ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging - - attr_reader remove_bg: Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg? - - def remove_bg=: ( - Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg - ) -> Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg - - def initialize: ( - ?ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, - ?aws_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, - ?google_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, - ?remove_bg: Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg - ) -> void - - def to_hash: -> { - ai_auto_description: Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, - aws_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg - } - - type ai_auto_description = :success | :pending | :failed - - module AIAutoDescription - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description] - end - - type aws_auto_tagging = :success | :pending | :failed - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging] - end - - type google_auto_tagging = :success | :pending | :failed - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging] - end - - type remove_bg = :success | :pending | :failed - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUpdateResponse::ExtensionStatus::remove_bg] - end - end - end - end -end diff --git a/sig/imagekit/models/file_upload_response.rbs b/sig/imagekit/models/file_upload_response.rbs deleted file mode 100644 index 7926370e..00000000 --- a/sig/imagekit/models/file_upload_response.rbs +++ /dev/null @@ -1,483 +0,0 @@ -module Imagekit - module Models - type file_upload_response = - { - ai_tags: ::Array[Imagekit::Models::FileUploadResponse::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - duration: Integer, - embedded_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Metadata, - name: String, - selected_fields_schema: ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema], - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::FileUploadResponse::VersionInfo, - video_codec: String, - width: Float - } - - class FileUploadResponse < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::Models::FileUploadResponse::AITag]? - - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader embedded_metadata: ::Hash[Symbol, top]? - - def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus? - - def extension_status=: ( - Imagekit::Models::FileUploadResponse::ExtensionStatus - ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader metadata: Imagekit::Metadata? - - def metadata=: (Imagekit::Metadata) -> Imagekit::Metadata - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema]? - - def selected_fields_schema=: ( - ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema] - ) -> ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema] - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail_url: String? - - def thumbnail_url=: (String) -> String - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::Models::FileUploadResponse::VersionInfo? - - def version_info=: ( - Imagekit::Models::FileUploadResponse::VersionInfo - ) -> Imagekit::Models::FileUploadResponse::VersionInfo - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::Models::FileUploadResponse::AITag]?, - ?audio_codec: String, - ?bit_rate: Integer, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?duration: Integer, - ?embedded_metadata: ::Hash[Symbol, top], - ?extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?metadata: Imagekit::Metadata, - ?name: String, - ?selected_fields_schema: ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema], - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail_url: String, - ?url: String, - ?version_info: Imagekit::Models::FileUploadResponse::VersionInfo, - ?video_codec: String, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::Models::FileUploadResponse::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - duration: Integer, - embedded_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Metadata, - name: String, - selected_fields_schema: ::Hash[Symbol, Imagekit::Models::FileUploadResponse::SelectedFieldsSchema], - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::Models::FileUploadResponse::VersionInfo, - video_codec: String, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type extension_status = - { - ai_auto_description: Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, - aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg - } - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - attr_reader ai_auto_description: Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description? - - def ai_auto_description=: ( - Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description - ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description - - attr_reader aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging? - - def aws_auto_tagging=: ( - Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging - ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging - - attr_reader google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging? - - def google_auto_tagging=: ( - Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging - ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging - - attr_reader remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg? - - def remove_bg=: ( - Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg - ) -> Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg - - def initialize: ( - ?ai_auto_description: Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, - ?aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, - ?google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, - ?remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg - ) -> void - - def to_hash: -> { - ai_auto_description: Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, - aws_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg - } - - type ai_auto_description = :success | :pending | :failed - - module AIAutoDescription - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::ExtensionStatus::ai_auto_description] - end - - type aws_auto_tagging = :success | :pending | :failed - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging] - end - - type google_auto_tagging = :success | :pending | :failed - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging] - end - - type remove_bg = :success | :pending | :failed - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::ExtensionStatus::remove_bg] - end - end - - type selected_fields_schema = - { - type: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_ - - attr_reader default_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value? - - def default_value=: ( - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value - ) -> Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value? - - def max_value=: ( - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value - ) -> Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value? - - def min_value=: ( - Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value - ) -> Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value - - attr_reader read_only: bool? - - def read_only=: (bool) -> bool - - attr_reader select_options: ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option] - ) -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option] - - attr_reader select_options_truncated: bool? - - def select_options_truncated=: (bool) -> bool - - def initialize: ( - type: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_, - ?default_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value, - ?read_only: bool, - ?select_options: ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option], - ?select_options_truncated: bool - ) -> void - - def to_hash: -> { - type: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema::select_option] - end - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - end -end diff --git a/sig/imagekit/models/files/bulk_delete_params.rbs b/sig/imagekit/models/files/bulk_delete_params.rbs deleted file mode 100644 index 353a3add..00000000 --- a/sig/imagekit/models/files/bulk_delete_params.rbs +++ /dev/null @@ -1,26 +0,0 @@ -module Imagekit - module Models - module Files - type bulk_delete_params = - { file_ids: ::Array[String] } - & Imagekit::Internal::Type::request_parameters - - class BulkDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor file_ids: ::Array[String] - - def initialize: ( - file_ids: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file_ids: ::Array[String], - request_options: Imagekit::RequestOptions - } - end - end - end -end diff --git a/sig/imagekit/models/files/metadata_get_from_url_params.rbs b/sig/imagekit/models/files/metadata_get_from_url_params.rbs deleted file mode 100644 index 9a87d773..00000000 --- a/sig/imagekit/models/files/metadata_get_from_url_params.rbs +++ /dev/null @@ -1,25 +0,0 @@ -module Imagekit - module Models - module Files - type metadata_get_from_url_params = - { url: String } & Imagekit::Internal::Type::request_parameters - - class MetadataGetFromURLParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor url: String - - def initialize: ( - url: String, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - url: String, - request_options: Imagekit::RequestOptions - } - end - end - end -end diff --git a/sig/imagekit/models/files/metadata_get_params.rbs b/sig/imagekit/models/files/metadata_get_params.rbs deleted file mode 100644 index 61c39d07..00000000 --- a/sig/imagekit/models/files/metadata_get_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Files - type metadata_get_params = - { } & Imagekit::Internal::Type::request_parameters - - class MetadataGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/files/version_delete_params.rbs b/sig/imagekit/models/files/version_delete_params.rbs deleted file mode 100644 index 9a480932..00000000 --- a/sig/imagekit/models/files/version_delete_params.rbs +++ /dev/null @@ -1,25 +0,0 @@ -module Imagekit - module Models - module Files - type version_delete_params = - { file_id: String } & Imagekit::Internal::Type::request_parameters - - class VersionDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor file_id: String - - def initialize: ( - file_id: String, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file_id: String, - request_options: Imagekit::RequestOptions - } - end - end - end -end diff --git a/sig/imagekit/models/files/version_get_params.rbs b/sig/imagekit/models/files/version_get_params.rbs deleted file mode 100644 index 9944b0e5..00000000 --- a/sig/imagekit/models/files/version_get_params.rbs +++ /dev/null @@ -1,25 +0,0 @@ -module Imagekit - module Models - module Files - type version_get_params = - { file_id: String } & Imagekit::Internal::Type::request_parameters - - class VersionGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor file_id: String - - def initialize: ( - file_id: String, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file_id: String, - request_options: Imagekit::RequestOptions - } - end - end - end -end diff --git a/sig/imagekit/models/files/version_list_params.rbs b/sig/imagekit/models/files/version_list_params.rbs deleted file mode 100644 index 2a67793e..00000000 --- a/sig/imagekit/models/files/version_list_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Imagekit - module Models - module Files - type version_list_params = - { } & Imagekit::Internal::Type::request_parameters - - class VersionListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/files/version_list_response.rbs b/sig/imagekit/models/files/version_list_response.rbs deleted file mode 100644 index 48c5bd45..00000000 --- a/sig/imagekit/models/files/version_list_response.rbs +++ /dev/null @@ -1,9 +0,0 @@ -module Imagekit - module Models - module Files - type version_list_response = ::Array[Imagekit::File] - - VersionListResponse: Imagekit::Internal::Type::Converter - end - end -end diff --git a/sig/imagekit/models/files/version_restore_params.rbs b/sig/imagekit/models/files/version_restore_params.rbs deleted file mode 100644 index 22ed3a7e..00000000 --- a/sig/imagekit/models/files/version_restore_params.rbs +++ /dev/null @@ -1,25 +0,0 @@ -module Imagekit - module Models - module Files - type version_restore_params = - { file_id: String } & Imagekit::Internal::Type::request_parameters - - class VersionRestoreParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor file_id: String - - def initialize: ( - file_id: String, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - file_id: String, - request_options: Imagekit::RequestOptions - } - end - end - end -end diff --git a/sig/imagekit/models/folder_delete_params.rbs b/sig/imagekit/models/folder_delete_params.rbs deleted file mode 100644 index ffc943b5..00000000 --- a/sig/imagekit/models/folder_delete_params.rbs +++ /dev/null @@ -1,23 +0,0 @@ -module Imagekit - module Models - type folder_delete_params = - { folder_path: String } & Imagekit::Internal::Type::request_parameters - - class FolderDeleteParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - attr_accessor folder_path: String - - def initialize: ( - folder_path: String, - ?request_options: Imagekit::request_opts - ) -> void - - def to_hash: -> { - folder_path: String, - request_options: Imagekit::RequestOptions - } - end - end -end diff --git a/sig/imagekit/models/folders/job_get_params.rbs b/sig/imagekit/models/folders/job_get_params.rbs deleted file mode 100644 index ea747749..00000000 --- a/sig/imagekit/models/folders/job_get_params.rbs +++ /dev/null @@ -1,16 +0,0 @@ -module Imagekit - module Models - module Folders - type job_get_params = { } & Imagekit::Internal::Type::request_parameters - - class JobGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end - end -end diff --git a/sig/imagekit/models/folders/job_get_response.rbs b/sig/imagekit/models/folders/job_get_response.rbs deleted file mode 100644 index dcda6269..00000000 --- a/sig/imagekit/models/folders/job_get_response.rbs +++ /dev/null @@ -1,72 +0,0 @@ -module Imagekit - module Models - module Folders - type job_get_response = - { - job_id: String, - purge_request_id: String, - status: Imagekit::Models::Folders::JobGetResponse::status, - type: Imagekit::Models::Folders::JobGetResponse::type_ - } - - class JobGetResponse < Imagekit::Internal::Type::BaseModel - attr_reader job_id: String? - - def job_id=: (String) -> String - - attr_reader purge_request_id: String? - - def purge_request_id=: (String) -> String - - attr_reader status: Imagekit::Models::Folders::JobGetResponse::status? - - def status=: ( - Imagekit::Models::Folders::JobGetResponse::status - ) -> Imagekit::Models::Folders::JobGetResponse::status - - attr_reader type: Imagekit::Models::Folders::JobGetResponse::type_? - - def type=: ( - Imagekit::Models::Folders::JobGetResponse::type_ - ) -> Imagekit::Models::Folders::JobGetResponse::type_ - - def initialize: ( - ?job_id: String, - ?purge_request_id: String, - ?status: Imagekit::Models::Folders::JobGetResponse::status, - ?type: Imagekit::Models::Folders::JobGetResponse::type_ - ) -> void - - def to_hash: -> { - job_id: String, - purge_request_id: String, - status: Imagekit::Models::Folders::JobGetResponse::status, - type: Imagekit::Models::Folders::JobGetResponse::type_ - } - - type status = :Pending | :Completed - - module Status - extend Imagekit::Internal::Type::Enum - - PENDING: :Pending - COMPLETED: :Completed - - def self?.values: -> ::Array[Imagekit::Models::Folders::JobGetResponse::status] - end - - type type_ = :COPY_FOLDER | :MOVE_FOLDER | :RENAME_FOLDER - - module Type - extend Imagekit::Internal::Type::Enum - - COPY_FOLDER: :COPY_FOLDER - MOVE_FOLDER: :MOVE_FOLDER - RENAME_FOLDER: :RENAME_FOLDER - - def self?.values: -> ::Array[Imagekit::Models::Folders::JobGetResponse::type_] - end - end - end - end -end diff --git a/sig/imagekit/models/image_overlay.rbs b/sig/imagekit/models/image_overlay.rbs deleted file mode 100644 index 83313253..00000000 --- a/sig/imagekit/models/image_overlay.rbs +++ /dev/null @@ -1,59 +0,0 @@ -module Imagekit - module Models - type image_overlay = - { - input: String, - type: :image, - encoding: Imagekit::Models::ImageOverlay::encoding, - transformation: ::Array[Imagekit::Transformation] - } - - class ImageOverlay < Imagekit::Models::BaseOverlay - def input: -> String - - def input=: (String _) -> String - - def `type`: -> :image - - def type=: (:image _) -> :image - - def encoding: -> Imagekit::Models::ImageOverlay::encoding? - - def encoding=: ( - Imagekit::Models::ImageOverlay::encoding _ - ) -> Imagekit::Models::ImageOverlay::encoding - - def transformation: -> ::Array[Imagekit::Transformation]? - - def transformation=: ( - ::Array[Imagekit::Transformation] _ - ) -> ::Array[Imagekit::Transformation] - - def initialize: ( - input: String, - ?encoding: Imagekit::Models::ImageOverlay::encoding, - ?transformation: ::Array[Imagekit::Transformation], - ?type: :image - ) -> void - - def to_hash: -> { - input: String, - type: :image, - encoding: Imagekit::Models::ImageOverlay::encoding, - transformation: ::Array[Imagekit::Transformation] - } - - type encoding = :auto | :plain | :base64 - - module Encoding - extend Imagekit::Internal::Type::Enum - - AUTO: :auto - PLAIN: :plain - BASE64: :base64 - - def self?.values: -> ::Array[Imagekit::Models::ImageOverlay::encoding] - end - end - end -end diff --git a/sig/imagekit/models/overlay.rbs b/sig/imagekit/models/overlay.rbs deleted file mode 100644 index 2172be0b..00000000 --- a/sig/imagekit/models/overlay.rbs +++ /dev/null @@ -1,16 +0,0 @@ -module Imagekit - module Models - type overlay = - Imagekit::TextOverlay - | Imagekit::ImageOverlay - | Imagekit::VideoOverlay - | Imagekit::SubtitleOverlay - | Imagekit::SolidColorOverlay - - module Overlay - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::overlay] - end - end -end diff --git a/sig/imagekit/models/overlay_position.rbs b/sig/imagekit/models/overlay_position.rbs deleted file mode 100644 index 8576502e..00000000 --- a/sig/imagekit/models/overlay_position.rbs +++ /dev/null @@ -1,85 +0,0 @@ -module Imagekit - module Models - type overlay_position = - { - focus: Imagekit::Models::OverlayPosition::focus, - x: Imagekit::Models::OverlayPosition::x, - y_: Imagekit::Models::OverlayPosition::y_ - } - - class OverlayPosition < Imagekit::Internal::Type::BaseModel - attr_reader focus: Imagekit::Models::OverlayPosition::focus? - - def focus=: ( - Imagekit::Models::OverlayPosition::focus - ) -> Imagekit::Models::OverlayPosition::focus - - attr_reader x: Imagekit::Models::OverlayPosition::x? - - def x=: ( - Imagekit::Models::OverlayPosition::x - ) -> Imagekit::Models::OverlayPosition::x - - attr_reader y_: Imagekit::Models::OverlayPosition::y_? - - def y_=: ( - Imagekit::Models::OverlayPosition::y_ - ) -> Imagekit::Models::OverlayPosition::y_ - - def initialize: ( - ?focus: Imagekit::Models::OverlayPosition::focus, - ?x: Imagekit::Models::OverlayPosition::x, - ?y_: Imagekit::Models::OverlayPosition::y_ - ) -> void - - def to_hash: -> { - focus: Imagekit::Models::OverlayPosition::focus, - x: Imagekit::Models::OverlayPosition::x, - y_: Imagekit::Models::OverlayPosition::y_ - } - - type focus = - :center - | :top - | :left - | :bottom - | :right - | :top_left - | :top_right - | :bottom_left - | :bottom_right - - module Focus - extend Imagekit::Internal::Type::Enum - - CENTER: :center - TOP: :top - LEFT: :left - BOTTOM: :bottom - RIGHT: :right - TOP_LEFT: :top_left - TOP_RIGHT: :top_right - BOTTOM_LEFT: :bottom_left - BOTTOM_RIGHT: :bottom_right - - def self?.values: -> ::Array[Imagekit::Models::OverlayPosition::focus] - end - - type x = Float | String - - module X - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::OverlayPosition::x] - end - - type y_ = Float | String - - module Y - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::OverlayPosition::y_] - end - end - end -end diff --git a/sig/imagekit/models/overlay_timing.rbs b/sig/imagekit/models/overlay_timing.rbs deleted file mode 100644 index 4cafca16..00000000 --- a/sig/imagekit/models/overlay_timing.rbs +++ /dev/null @@ -1,66 +0,0 @@ -module Imagekit - module Models - type overlay_timing = - { - duration: Imagekit::Models::OverlayTiming::duration, - end_: Imagekit::Models::OverlayTiming::end_, - start: Imagekit::Models::OverlayTiming::start - } - - class OverlayTiming < Imagekit::Internal::Type::BaseModel - attr_reader duration: Imagekit::Models::OverlayTiming::duration? - - def duration=: ( - Imagekit::Models::OverlayTiming::duration - ) -> Imagekit::Models::OverlayTiming::duration - - attr_reader end_: Imagekit::Models::OverlayTiming::end_? - - def end_=: ( - Imagekit::Models::OverlayTiming::end_ - ) -> Imagekit::Models::OverlayTiming::end_ - - attr_reader start: Imagekit::Models::OverlayTiming::start? - - def start=: ( - Imagekit::Models::OverlayTiming::start - ) -> Imagekit::Models::OverlayTiming::start - - def initialize: ( - ?duration: Imagekit::Models::OverlayTiming::duration, - ?end_: Imagekit::Models::OverlayTiming::end_, - ?start: Imagekit::Models::OverlayTiming::start - ) -> void - - def to_hash: -> { - duration: Imagekit::Models::OverlayTiming::duration, - end_: Imagekit::Models::OverlayTiming::end_, - start: Imagekit::Models::OverlayTiming::start - } - - type duration = Float | String - - module Duration - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::OverlayTiming::duration] - end - - type end_ = Float | String - - module End - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::OverlayTiming::end_] - end - - type start = Float | String - - module Start - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::OverlayTiming::start] - end - end - end -end diff --git a/sig/imagekit/models/solid_color_overlay.rbs b/sig/imagekit/models/solid_color_overlay.rbs deleted file mode 100644 index 1b4271e4..00000000 --- a/sig/imagekit/models/solid_color_overlay.rbs +++ /dev/null @@ -1,38 +0,0 @@ -module Imagekit - module Models - type solid_color_overlay = - { - color: String, - type: :solidColor, - transformation: ::Array[Imagekit::SolidColorOverlayTransformation] - } - - class SolidColorOverlay < Imagekit::Models::BaseOverlay - def color: -> String - - def color=: (String _) -> String - - def `type`: -> :solidColor - - def type=: (:solidColor _) -> :solidColor - - def transformation: -> ::Array[Imagekit::SolidColorOverlayTransformation]? - - def transformation=: ( - ::Array[Imagekit::SolidColorOverlayTransformation] _ - ) -> ::Array[Imagekit::SolidColorOverlayTransformation] - - def initialize: ( - color: String, - ?transformation: ::Array[Imagekit::SolidColorOverlayTransformation], - ?type: :solidColor - ) -> void - - def to_hash: -> { - color: String, - type: :solidColor, - transformation: ::Array[Imagekit::SolidColorOverlayTransformation] - } - end - end -end diff --git a/sig/imagekit/models/solid_color_overlay_transformation.rbs b/sig/imagekit/models/solid_color_overlay_transformation.rbs deleted file mode 100644 index 3e664364..00000000 --- a/sig/imagekit/models/solid_color_overlay_transformation.rbs +++ /dev/null @@ -1,97 +0,0 @@ -module Imagekit - module Models - type solid_color_overlay_transformation = - { - alpha: Float, - background: String, - gradient: Imagekit::Models::SolidColorOverlayTransformation::gradient, - height: Imagekit::Models::SolidColorOverlayTransformation::height, - radius: Imagekit::Models::SolidColorOverlayTransformation::radius, - width: Imagekit::Models::SolidColorOverlayTransformation::width - } - - class SolidColorOverlayTransformation < Imagekit::Internal::Type::BaseModel - attr_reader alpha: Float? - - def alpha=: (Float) -> Float - - attr_reader background: String? - - def background=: (String) -> String - - attr_reader gradient: Imagekit::Models::SolidColorOverlayTransformation::gradient? - - def gradient=: ( - Imagekit::Models::SolidColorOverlayTransformation::gradient - ) -> Imagekit::Models::SolidColorOverlayTransformation::gradient - - attr_reader height: Imagekit::Models::SolidColorOverlayTransformation::height? - - def height=: ( - Imagekit::Models::SolidColorOverlayTransformation::height - ) -> Imagekit::Models::SolidColorOverlayTransformation::height - - attr_reader radius: Imagekit::Models::SolidColorOverlayTransformation::radius? - - def radius=: ( - Imagekit::Models::SolidColorOverlayTransformation::radius - ) -> Imagekit::Models::SolidColorOverlayTransformation::radius - - attr_reader width: Imagekit::Models::SolidColorOverlayTransformation::width? - - def width=: ( - Imagekit::Models::SolidColorOverlayTransformation::width - ) -> Imagekit::Models::SolidColorOverlayTransformation::width - - def initialize: ( - ?alpha: Float, - ?background: String, - ?gradient: Imagekit::Models::SolidColorOverlayTransformation::gradient, - ?height: Imagekit::Models::SolidColorOverlayTransformation::height, - ?radius: Imagekit::Models::SolidColorOverlayTransformation::radius, - ?width: Imagekit::Models::SolidColorOverlayTransformation::width - ) -> void - - def to_hash: -> { - alpha: Float, - background: String, - gradient: Imagekit::Models::SolidColorOverlayTransformation::gradient, - height: Imagekit::Models::SolidColorOverlayTransformation::height, - radius: Imagekit::Models::SolidColorOverlayTransformation::radius, - width: Imagekit::Models::SolidColorOverlayTransformation::width - } - - type gradient = true | String - - module Gradient - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::gradient] - end - - type height = Float | String - - module Height - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::height] - end - - type radius = Float | :max - - module Radius - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::radius] - end - - type width = Float | String - - module Width - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::SolidColorOverlayTransformation::width] - end - end - end -end diff --git a/sig/imagekit/models/subtitle_overlay.rbs b/sig/imagekit/models/subtitle_overlay.rbs deleted file mode 100644 index ce4b25d9..00000000 --- a/sig/imagekit/models/subtitle_overlay.rbs +++ /dev/null @@ -1,59 +0,0 @@ -module Imagekit - module Models - type subtitle_overlay = - { - input: String, - type: :subtitle, - encoding: Imagekit::Models::SubtitleOverlay::encoding, - transformation: ::Array[Imagekit::SubtitleOverlayTransformation] - } - - class SubtitleOverlay < Imagekit::Models::BaseOverlay - def input: -> String - - def input=: (String _) -> String - - def `type`: -> :subtitle - - def type=: (:subtitle _) -> :subtitle - - def encoding: -> Imagekit::Models::SubtitleOverlay::encoding? - - def encoding=: ( - Imagekit::Models::SubtitleOverlay::encoding _ - ) -> Imagekit::Models::SubtitleOverlay::encoding - - def transformation: -> ::Array[Imagekit::SubtitleOverlayTransformation]? - - def transformation=: ( - ::Array[Imagekit::SubtitleOverlayTransformation] _ - ) -> ::Array[Imagekit::SubtitleOverlayTransformation] - - def initialize: ( - input: String, - ?encoding: Imagekit::Models::SubtitleOverlay::encoding, - ?transformation: ::Array[Imagekit::SubtitleOverlayTransformation], - ?type: :subtitle - ) -> void - - def to_hash: -> { - input: String, - type: :subtitle, - encoding: Imagekit::Models::SubtitleOverlay::encoding, - transformation: ::Array[Imagekit::SubtitleOverlayTransformation] - } - - type encoding = :auto | :plain | :base64 - - module Encoding - extend Imagekit::Internal::Type::Enum - - AUTO: :auto - PLAIN: :plain - BASE64: :base64 - - def self?.values: -> ::Array[Imagekit::Models::SubtitleOverlay::encoding] - end - end - end -end diff --git a/sig/imagekit/models/text_overlay.rbs b/sig/imagekit/models/text_overlay.rbs deleted file mode 100644 index ae294eef..00000000 --- a/sig/imagekit/models/text_overlay.rbs +++ /dev/null @@ -1,59 +0,0 @@ -module Imagekit - module Models - type text_overlay = - { - text: String, - type: :text, - encoding: Imagekit::Models::TextOverlay::encoding, - transformation: ::Array[Imagekit::TextOverlayTransformation] - } - - class TextOverlay < Imagekit::Models::BaseOverlay - def text: -> String - - def text=: (String _) -> String - - def `type`: -> :text - - def type=: (:text _) -> :text - - def encoding: -> Imagekit::Models::TextOverlay::encoding? - - def encoding=: ( - Imagekit::Models::TextOverlay::encoding _ - ) -> Imagekit::Models::TextOverlay::encoding - - def transformation: -> ::Array[Imagekit::TextOverlayTransformation]? - - def transformation=: ( - ::Array[Imagekit::TextOverlayTransformation] _ - ) -> ::Array[Imagekit::TextOverlayTransformation] - - def initialize: ( - text: String, - ?encoding: Imagekit::Models::TextOverlay::encoding, - ?transformation: ::Array[Imagekit::TextOverlayTransformation], - ?type: :text - ) -> void - - def to_hash: -> { - text: String, - type: :text, - encoding: Imagekit::Models::TextOverlay::encoding, - transformation: ::Array[Imagekit::TextOverlayTransformation] - } - - type encoding = :auto | :plain | :base64 - - module Encoding - extend Imagekit::Internal::Type::Enum - - AUTO: :auto - PLAIN: :plain - BASE64: :base64 - - def self?.values: -> ::Array[Imagekit::Models::TextOverlay::encoding] - end - end - end -end diff --git a/sig/imagekit/models/text_overlay_transformation.rbs b/sig/imagekit/models/text_overlay_transformation.rbs deleted file mode 100644 index db0f4c8b..00000000 --- a/sig/imagekit/models/text_overlay_transformation.rbs +++ /dev/null @@ -1,195 +0,0 @@ -module Imagekit - module Models - type text_overlay_transformation = - { - alpha: Float, - background: String, - flip: Imagekit::Models::TextOverlayTransformation::flip, - font_color: String, - font_family: String, - font_size: Imagekit::Models::TextOverlayTransformation::font_size, - inner_alignment: Imagekit::Models::TextOverlayTransformation::inner_alignment, - line_height: Imagekit::Models::TextOverlayTransformation::line_height, - padding: Imagekit::Models::TextOverlayTransformation::padding, - radius: Imagekit::Models::TextOverlayTransformation::radius, - rotation: Imagekit::Models::TextOverlayTransformation::rotation, - typography: String, - width: Imagekit::Models::TextOverlayTransformation::width - } - - class TextOverlayTransformation < Imagekit::Internal::Type::BaseModel - attr_reader alpha: Float? - - def alpha=: (Float) -> Float - - attr_reader background: String? - - def background=: (String) -> String - - attr_reader flip: Imagekit::Models::TextOverlayTransformation::flip? - - def flip=: ( - Imagekit::Models::TextOverlayTransformation::flip - ) -> Imagekit::Models::TextOverlayTransformation::flip - - attr_reader font_color: String? - - def font_color=: (String) -> String - - attr_reader font_family: String? - - def font_family=: (String) -> String - - attr_reader font_size: Imagekit::Models::TextOverlayTransformation::font_size? - - def font_size=: ( - Imagekit::Models::TextOverlayTransformation::font_size - ) -> Imagekit::Models::TextOverlayTransformation::font_size - - attr_reader inner_alignment: Imagekit::Models::TextOverlayTransformation::inner_alignment? - - def inner_alignment=: ( - Imagekit::Models::TextOverlayTransformation::inner_alignment - ) -> Imagekit::Models::TextOverlayTransformation::inner_alignment - - attr_reader line_height: Imagekit::Models::TextOverlayTransformation::line_height? - - def line_height=: ( - Imagekit::Models::TextOverlayTransformation::line_height - ) -> Imagekit::Models::TextOverlayTransformation::line_height - - attr_reader padding: Imagekit::Models::TextOverlayTransformation::padding? - - def padding=: ( - Imagekit::Models::TextOverlayTransformation::padding - ) -> Imagekit::Models::TextOverlayTransformation::padding - - attr_reader radius: Imagekit::Models::TextOverlayTransformation::radius? - - def radius=: ( - Imagekit::Models::TextOverlayTransformation::radius - ) -> Imagekit::Models::TextOverlayTransformation::radius - - attr_reader rotation: Imagekit::Models::TextOverlayTransformation::rotation? - - def rotation=: ( - Imagekit::Models::TextOverlayTransformation::rotation - ) -> Imagekit::Models::TextOverlayTransformation::rotation - - attr_reader typography: String? - - def typography=: (String) -> String - - attr_reader width: Imagekit::Models::TextOverlayTransformation::width? - - def width=: ( - Imagekit::Models::TextOverlayTransformation::width - ) -> Imagekit::Models::TextOverlayTransformation::width - - def initialize: ( - ?alpha: Float, - ?background: String, - ?flip: Imagekit::Models::TextOverlayTransformation::flip, - ?font_color: String, - ?font_family: String, - ?font_size: Imagekit::Models::TextOverlayTransformation::font_size, - ?inner_alignment: Imagekit::Models::TextOverlayTransformation::inner_alignment, - ?line_height: Imagekit::Models::TextOverlayTransformation::line_height, - ?padding: Imagekit::Models::TextOverlayTransformation::padding, - ?radius: Imagekit::Models::TextOverlayTransformation::radius, - ?rotation: Imagekit::Models::TextOverlayTransformation::rotation, - ?typography: String, - ?width: Imagekit::Models::TextOverlayTransformation::width - ) -> void - - def to_hash: -> { - alpha: Float, - background: String, - flip: Imagekit::Models::TextOverlayTransformation::flip, - font_color: String, - font_family: String, - font_size: Imagekit::Models::TextOverlayTransformation::font_size, - inner_alignment: Imagekit::Models::TextOverlayTransformation::inner_alignment, - line_height: Imagekit::Models::TextOverlayTransformation::line_height, - padding: Imagekit::Models::TextOverlayTransformation::padding, - radius: Imagekit::Models::TextOverlayTransformation::radius, - rotation: Imagekit::Models::TextOverlayTransformation::rotation, - typography: String, - width: Imagekit::Models::TextOverlayTransformation::width - } - - type flip = :h | :v | :h_v | :v_h - - module Flip - extend Imagekit::Internal::Type::Enum - - H: :h - V: :v - H_V: :h_v - V_H: :v_h - - def self?.values: -> ::Array[Imagekit::Models::TextOverlayTransformation::flip] - end - - type font_size = Float | String - - module FontSize - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::font_size] - end - - type inner_alignment = :left | :right | :center - - module InnerAlignment - extend Imagekit::Internal::Type::Enum - - LEFT: :left - RIGHT: :right - CENTER: :center - - def self?.values: -> ::Array[Imagekit::Models::TextOverlayTransformation::inner_alignment] - end - - type line_height = Float | String - - module LineHeight - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::line_height] - end - - type padding = Float | String - - module Padding - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::padding] - end - - type radius = Float | :max - - module Radius - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::radius] - end - - type rotation = Float | String - - module Rotation - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::rotation] - end - - type width = Float | String - - module Width - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::TextOverlayTransformation::width] - end - end - end -end diff --git a/sig/imagekit/models/transformation.rbs b/sig/imagekit/models/transformation.rbs deleted file mode 100644 index afbf4af0..00000000 --- a/sig/imagekit/models/transformation.rbs +++ /dev/null @@ -1,763 +0,0 @@ -module Imagekit - module Models - type transformation = - { - ai_change_background: String, - ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, - ai_edit: String, - ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, - ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, - ai_retouch: Imagekit::Models::Transformation::ai_retouch, - ai_upscale: Imagekit::Models::Transformation::ai_upscale, - ai_variation: Imagekit::Models::Transformation::ai_variation, - aspect_ratio: Imagekit::Models::Transformation::aspect_ratio, - audio_codec: Imagekit::Models::Transformation::audio_codec, - background: String, - blur: Float, - border: String, - color_profile: bool, - contrast_stretch: Imagekit::Models::Transformation::contrast_stretch, - crop: Imagekit::Models::Transformation::crop, - crop_mode: Imagekit::Models::Transformation::crop_mode, - default_image: String, - dpr: Float, - duration: Imagekit::Models::Transformation::duration, - end_offset: Imagekit::Models::Transformation::end_offset, - flip: Imagekit::Models::Transformation::flip, - focus: String, - format_: Imagekit::Models::Transformation::format_, - gradient: Imagekit::Models::Transformation::gradient, - grayscale: Imagekit::Models::Transformation::grayscale, - height: Imagekit::Models::Transformation::height, - lossless: bool, - metadata: bool, - named: String, - opacity: Float, - original: bool, - overlay: Imagekit::Models::overlay, - page: Imagekit::Models::Transformation::page, - progressive: bool, - quality: Float, - radius: Imagekit::Models::Transformation::radius, - raw: String, - rotation: Imagekit::Models::Transformation::rotation, - shadow: Imagekit::Models::Transformation::shadow, - sharpen: Imagekit::Models::Transformation::sharpen, - start_offset: Imagekit::Models::Transformation::start_offset, - streaming_resolutions: ::Array[Imagekit::Models::streaming_resolution], - trim: Imagekit::Models::Transformation::trim, - unsharp_mask: Imagekit::Models::Transformation::unsharp_mask, - video_codec: Imagekit::Models::Transformation::video_codec, - width: Imagekit::Models::Transformation::width, - x: Imagekit::Models::Transformation::x, - x_center: Imagekit::Models::Transformation::x_center, - y_: Imagekit::Models::Transformation::y_, - y_center: Imagekit::Models::Transformation::y_center, - zoom: Float - } - - class Transformation < Imagekit::Internal::Type::BaseModel - attr_reader ai_change_background: String? - - def ai_change_background=: (String) -> String - - attr_reader ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow? - - def ai_drop_shadow=: ( - Imagekit::Models::Transformation::ai_drop_shadow - ) -> Imagekit::Models::Transformation::ai_drop_shadow - - attr_reader ai_edit: String? - - def ai_edit=: (String) -> String - - attr_reader ai_remove_background: Imagekit::Models::Transformation::ai_remove_background? - - def ai_remove_background=: ( - Imagekit::Models::Transformation::ai_remove_background - ) -> Imagekit::Models::Transformation::ai_remove_background - - attr_reader ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external? - - def ai_remove_background_external=: ( - Imagekit::Models::Transformation::ai_remove_background_external - ) -> Imagekit::Models::Transformation::ai_remove_background_external - - attr_reader ai_retouch: Imagekit::Models::Transformation::ai_retouch? - - def ai_retouch=: ( - Imagekit::Models::Transformation::ai_retouch - ) -> Imagekit::Models::Transformation::ai_retouch - - attr_reader ai_upscale: Imagekit::Models::Transformation::ai_upscale? - - def ai_upscale=: ( - Imagekit::Models::Transformation::ai_upscale - ) -> Imagekit::Models::Transformation::ai_upscale - - attr_reader ai_variation: Imagekit::Models::Transformation::ai_variation? - - def ai_variation=: ( - Imagekit::Models::Transformation::ai_variation - ) -> Imagekit::Models::Transformation::ai_variation - - attr_reader aspect_ratio: Imagekit::Models::Transformation::aspect_ratio? - - def aspect_ratio=: ( - Imagekit::Models::Transformation::aspect_ratio - ) -> Imagekit::Models::Transformation::aspect_ratio - - attr_reader audio_codec: Imagekit::Models::Transformation::audio_codec? - - def audio_codec=: ( - Imagekit::Models::Transformation::audio_codec - ) -> Imagekit::Models::Transformation::audio_codec - - attr_reader background: String? - - def background=: (String) -> String - - attr_reader blur: Float? - - def blur=: (Float) -> Float - - attr_reader border: String? - - def border=: (String) -> String - - attr_reader color_profile: bool? - - def color_profile=: (bool) -> bool - - attr_reader contrast_stretch: Imagekit::Models::Transformation::contrast_stretch? - - def contrast_stretch=: ( - Imagekit::Models::Transformation::contrast_stretch - ) -> Imagekit::Models::Transformation::contrast_stretch - - attr_reader crop: Imagekit::Models::Transformation::crop? - - def crop=: ( - Imagekit::Models::Transformation::crop - ) -> Imagekit::Models::Transformation::crop - - attr_reader crop_mode: Imagekit::Models::Transformation::crop_mode? - - def crop_mode=: ( - Imagekit::Models::Transformation::crop_mode - ) -> Imagekit::Models::Transformation::crop_mode - - attr_reader default_image: String? - - def default_image=: (String) -> String - - attr_reader dpr: Float? - - def dpr=: (Float) -> Float - - attr_reader duration: Imagekit::Models::Transformation::duration? - - def duration=: ( - Imagekit::Models::Transformation::duration - ) -> Imagekit::Models::Transformation::duration - - attr_reader end_offset: Imagekit::Models::Transformation::end_offset? - - def end_offset=: ( - Imagekit::Models::Transformation::end_offset - ) -> Imagekit::Models::Transformation::end_offset - - attr_reader flip: Imagekit::Models::Transformation::flip? - - def flip=: ( - Imagekit::Models::Transformation::flip - ) -> Imagekit::Models::Transformation::flip - - attr_reader focus: String? - - def focus=: (String) -> String - - attr_reader format_: Imagekit::Models::Transformation::format_? - - def format_=: ( - Imagekit::Models::Transformation::format_ - ) -> Imagekit::Models::Transformation::format_ - - attr_reader gradient: Imagekit::Models::Transformation::gradient? - - def gradient=: ( - Imagekit::Models::Transformation::gradient - ) -> Imagekit::Models::Transformation::gradient - - attr_reader grayscale: Imagekit::Models::Transformation::grayscale? - - def grayscale=: ( - Imagekit::Models::Transformation::grayscale - ) -> Imagekit::Models::Transformation::grayscale - - attr_reader height: Imagekit::Models::Transformation::height? - - def height=: ( - Imagekit::Models::Transformation::height - ) -> Imagekit::Models::Transformation::height - - attr_reader lossless: bool? - - def lossless=: (bool) -> bool - - attr_reader metadata: bool? - - def metadata=: (bool) -> bool - - attr_reader named: String? - - def named=: (String) -> String - - attr_reader opacity: Float? - - def opacity=: (Float) -> Float - - attr_reader original: bool? - - def original=: (bool) -> bool - - attr_reader overlay: Imagekit::Models::overlay? - - def overlay=: (Imagekit::Models::overlay) -> Imagekit::Models::overlay - - attr_reader page: Imagekit::Models::Transformation::page? - - def page=: ( - Imagekit::Models::Transformation::page - ) -> Imagekit::Models::Transformation::page - - attr_reader progressive: bool? - - def progressive=: (bool) -> bool - - attr_reader quality: Float? - - def quality=: (Float) -> Float - - attr_reader radius: Imagekit::Models::Transformation::radius? - - def radius=: ( - Imagekit::Models::Transformation::radius - ) -> Imagekit::Models::Transformation::radius - - attr_reader raw: String? - - def raw=: (String) -> String - - attr_reader rotation: Imagekit::Models::Transformation::rotation? - - def rotation=: ( - Imagekit::Models::Transformation::rotation - ) -> Imagekit::Models::Transformation::rotation - - attr_reader shadow: Imagekit::Models::Transformation::shadow? - - def shadow=: ( - Imagekit::Models::Transformation::shadow - ) -> Imagekit::Models::Transformation::shadow - - attr_reader sharpen: Imagekit::Models::Transformation::sharpen? - - def sharpen=: ( - Imagekit::Models::Transformation::sharpen - ) -> Imagekit::Models::Transformation::sharpen - - attr_reader start_offset: Imagekit::Models::Transformation::start_offset? - - def start_offset=: ( - Imagekit::Models::Transformation::start_offset - ) -> Imagekit::Models::Transformation::start_offset - - attr_reader streaming_resolutions: ::Array[Imagekit::Models::streaming_resolution]? - - def streaming_resolutions=: ( - ::Array[Imagekit::Models::streaming_resolution] - ) -> ::Array[Imagekit::Models::streaming_resolution] - - attr_reader trim: Imagekit::Models::Transformation::trim? - - def trim=: ( - Imagekit::Models::Transformation::trim - ) -> Imagekit::Models::Transformation::trim - - attr_reader unsharp_mask: Imagekit::Models::Transformation::unsharp_mask? - - def unsharp_mask=: ( - Imagekit::Models::Transformation::unsharp_mask - ) -> Imagekit::Models::Transformation::unsharp_mask - - attr_reader video_codec: Imagekit::Models::Transformation::video_codec? - - def video_codec=: ( - Imagekit::Models::Transformation::video_codec - ) -> Imagekit::Models::Transformation::video_codec - - attr_reader width: Imagekit::Models::Transformation::width? - - def width=: ( - Imagekit::Models::Transformation::width - ) -> Imagekit::Models::Transformation::width - - attr_reader x: Imagekit::Models::Transformation::x? - - def x=: ( - Imagekit::Models::Transformation::x - ) -> Imagekit::Models::Transformation::x - - attr_reader x_center: Imagekit::Models::Transformation::x_center? - - def x_center=: ( - Imagekit::Models::Transformation::x_center - ) -> Imagekit::Models::Transformation::x_center - - attr_reader y_: Imagekit::Models::Transformation::y_? - - def y_=: ( - Imagekit::Models::Transformation::y_ - ) -> Imagekit::Models::Transformation::y_ - - attr_reader y_center: Imagekit::Models::Transformation::y_center? - - def y_center=: ( - Imagekit::Models::Transformation::y_center - ) -> Imagekit::Models::Transformation::y_center - - attr_reader zoom: Float? - - def zoom=: (Float) -> Float - - def initialize: ( - ?ai_change_background: String, - ?ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, - ?ai_edit: String, - ?ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, - ?ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, - ?ai_retouch: Imagekit::Models::Transformation::ai_retouch, - ?ai_upscale: Imagekit::Models::Transformation::ai_upscale, - ?ai_variation: Imagekit::Models::Transformation::ai_variation, - ?aspect_ratio: Imagekit::Models::Transformation::aspect_ratio, - ?audio_codec: Imagekit::Models::Transformation::audio_codec, - ?background: String, - ?blur: Float, - ?border: String, - ?color_profile: bool, - ?contrast_stretch: Imagekit::Models::Transformation::contrast_stretch, - ?crop: Imagekit::Models::Transformation::crop, - ?crop_mode: Imagekit::Models::Transformation::crop_mode, - ?default_image: String, - ?dpr: Float, - ?duration: Imagekit::Models::Transformation::duration, - ?end_offset: Imagekit::Models::Transformation::end_offset, - ?flip: Imagekit::Models::Transformation::flip, - ?focus: String, - ?format_: Imagekit::Models::Transformation::format_, - ?gradient: Imagekit::Models::Transformation::gradient, - ?grayscale: Imagekit::Models::Transformation::grayscale, - ?height: Imagekit::Models::Transformation::height, - ?lossless: bool, - ?metadata: bool, - ?named: String, - ?opacity: Float, - ?original: bool, - ?overlay: Imagekit::Models::overlay, - ?page: Imagekit::Models::Transformation::page, - ?progressive: bool, - ?quality: Float, - ?radius: Imagekit::Models::Transformation::radius, - ?raw: String, - ?rotation: Imagekit::Models::Transformation::rotation, - ?shadow: Imagekit::Models::Transformation::shadow, - ?sharpen: Imagekit::Models::Transformation::sharpen, - ?start_offset: Imagekit::Models::Transformation::start_offset, - ?streaming_resolutions: ::Array[Imagekit::Models::streaming_resolution], - ?trim: Imagekit::Models::Transformation::trim, - ?unsharp_mask: Imagekit::Models::Transformation::unsharp_mask, - ?video_codec: Imagekit::Models::Transformation::video_codec, - ?width: Imagekit::Models::Transformation::width, - ?x: Imagekit::Models::Transformation::x, - ?x_center: Imagekit::Models::Transformation::x_center, - ?y_: Imagekit::Models::Transformation::y_, - ?y_center: Imagekit::Models::Transformation::y_center, - ?zoom: Float - ) -> void - - def to_hash: -> { - ai_change_background: String, - ai_drop_shadow: Imagekit::Models::Transformation::ai_drop_shadow, - ai_edit: String, - ai_remove_background: Imagekit::Models::Transformation::ai_remove_background, - ai_remove_background_external: Imagekit::Models::Transformation::ai_remove_background_external, - ai_retouch: Imagekit::Models::Transformation::ai_retouch, - ai_upscale: Imagekit::Models::Transformation::ai_upscale, - ai_variation: Imagekit::Models::Transformation::ai_variation, - aspect_ratio: Imagekit::Models::Transformation::aspect_ratio, - audio_codec: Imagekit::Models::Transformation::audio_codec, - background: String, - blur: Float, - border: String, - color_profile: bool, - contrast_stretch: Imagekit::Models::Transformation::contrast_stretch, - crop: Imagekit::Models::Transformation::crop, - crop_mode: Imagekit::Models::Transformation::crop_mode, - default_image: String, - dpr: Float, - duration: Imagekit::Models::Transformation::duration, - end_offset: Imagekit::Models::Transformation::end_offset, - flip: Imagekit::Models::Transformation::flip, - focus: String, - format_: Imagekit::Models::Transformation::format_, - gradient: Imagekit::Models::Transformation::gradient, - grayscale: Imagekit::Models::Transformation::grayscale, - height: Imagekit::Models::Transformation::height, - lossless: bool, - metadata: bool, - named: String, - opacity: Float, - original: bool, - overlay: Imagekit::Models::overlay, - page: Imagekit::Models::Transformation::page, - progressive: bool, - quality: Float, - radius: Imagekit::Models::Transformation::radius, - raw: String, - rotation: Imagekit::Models::Transformation::rotation, - shadow: Imagekit::Models::Transformation::shadow, - sharpen: Imagekit::Models::Transformation::sharpen, - start_offset: Imagekit::Models::Transformation::start_offset, - streaming_resolutions: ::Array[Imagekit::Models::streaming_resolution], - trim: Imagekit::Models::Transformation::trim, - unsharp_mask: Imagekit::Models::Transformation::unsharp_mask, - video_codec: Imagekit::Models::Transformation::video_codec, - width: Imagekit::Models::Transformation::width, - x: Imagekit::Models::Transformation::x, - x_center: Imagekit::Models::Transformation::x_center, - y_: Imagekit::Models::Transformation::y_, - y_center: Imagekit::Models::Transformation::y_center, - zoom: Float - } - - type ai_drop_shadow = true | String - - module AIDropShadow - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::ai_drop_shadow] - end - - type ai_remove_background = true - - module AIRemoveBackground - extend Imagekit::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_remove_background] - end - - type ai_remove_background_external = true - - module AIRemoveBackgroundExternal - extend Imagekit::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_remove_background_external] - end - - type ai_retouch = true - - module AIRetouch - extend Imagekit::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_retouch] - end - - type ai_upscale = true - - module AIUpscale - extend Imagekit::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_upscale] - end - - type ai_variation = true - - module AIVariation - extend Imagekit::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[Imagekit::Models::Transformation::ai_variation] - end - - type aspect_ratio = Float | String - - module AspectRatio - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::aspect_ratio] - end - - type audio_codec = :aac | :opus | :none - - module AudioCodec - extend Imagekit::Internal::Type::Enum - - AAC: :aac - OPUS: :opus - NONE: :none - - def self?.values: -> ::Array[Imagekit::Models::Transformation::audio_codec] - end - - type contrast_stretch = true - - module ContrastStretch - extend Imagekit::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[Imagekit::Models::Transformation::contrast_stretch] - end - - type crop = - :force | :at_max | :at_max_enlarge | :at_least | :maintain_ratio - - module Crop - extend Imagekit::Internal::Type::Enum - - FORCE: :force - AT_MAX: :at_max - AT_MAX_ENLARGE: :at_max_enlarge - AT_LEAST: :at_least - MAINTAIN_RATIO: :maintain_ratio - - def self?.values: -> ::Array[Imagekit::Models::Transformation::crop] - end - - type crop_mode = :pad_resize | :extract | :pad_extract - - module CropMode - extend Imagekit::Internal::Type::Enum - - PAD_RESIZE: :pad_resize - EXTRACT: :extract - PAD_EXTRACT: :pad_extract - - def self?.values: -> ::Array[Imagekit::Models::Transformation::crop_mode] - end - - type duration = Float | String - - module Duration - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::duration] - end - - type end_offset = Float | String - - module EndOffset - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::end_offset] - end - - type flip = :h | :v | :h_v | :v_h - - module Flip - extend Imagekit::Internal::Type::Enum - - H: :h - V: :v - H_V: :h_v - V_H: :v_h - - def self?.values: -> ::Array[Imagekit::Models::Transformation::flip] - end - - type format_ = - :auto - | :webp - | :jpg - | :jpeg - | :png - | :gif - | :svg - | :mp4 - | :webm - | :avif - | :orig - - module Format - extend Imagekit::Internal::Type::Enum - - AUTO: :auto - WEBP: :webp - JPG: :jpg - JPEG: :jpeg - PNG: :png - GIF: :gif - SVG: :svg - MP4: :mp4 - WEBM: :webm - AVIF: :avif - ORIG: :orig - - def self?.values: -> ::Array[Imagekit::Models::Transformation::format_] - end - - type gradient = true | String - - module Gradient - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::gradient] - end - - type grayscale = true - - module Grayscale - extend Imagekit::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[Imagekit::Models::Transformation::grayscale] - end - - type height = Float | String - - module Height - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::height] - end - - type page = Float | String - - module Page - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::page] - end - - type radius = Float | :max - - module Radius - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::radius] - end - - type rotation = Float | String - - module Rotation - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::rotation] - end - - type shadow = true | String - - module Shadow - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::shadow] - end - - type sharpen = true | Float - - module Sharpen - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::sharpen] - end - - type start_offset = Float | String - - module StartOffset - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::start_offset] - end - - type trim = true | Float - - module Trim - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::trim] - end - - type unsharp_mask = true | String - - module UnsharpMask - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::unsharp_mask] - end - - type video_codec = :h264 | :vp9 | :av1 | :none - - module VideoCodec - extend Imagekit::Internal::Type::Enum - - H264: :h264 - VP9: :vp9 - AV1: :av1 - NONE: :none - - def self?.values: -> ::Array[Imagekit::Models::Transformation::video_codec] - end - - type width = Float | String - - module Width - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::width] - end - - type x = Float | String - - module X - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::x] - end - - type x_center = Float | String - - module XCenter - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::x_center] - end - - type y_ = Float | String - - module Y - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::y_] - end - - type y_center = Float | String - - module YCenter - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::Transformation::y_center] - end - end - end -end diff --git a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs b/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs deleted file mode 100644 index b3cb218a..00000000 --- a/sig/imagekit/models/unsafe_unwrap_webhook_event.rbs +++ /dev/null @@ -1,18 +0,0 @@ -module Imagekit - module Models - type unsafe_unwrap_webhook_event = - Imagekit::VideoTransformationAcceptedEvent - | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent - | Imagekit::UploadPreTransformSuccessEvent - | Imagekit::UploadPreTransformErrorEvent - | Imagekit::UploadPostTransformSuccessEvent - | Imagekit::UploadPostTransformErrorEvent - - module UnsafeUnwrapWebhookEvent - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::unsafe_unwrap_webhook_event] - end - end -end diff --git a/sig/imagekit/models/unwrap_webhook_event.rbs b/sig/imagekit/models/unwrap_webhook_event.rbs deleted file mode 100644 index 8c1551ec..00000000 --- a/sig/imagekit/models/unwrap_webhook_event.rbs +++ /dev/null @@ -1,18 +0,0 @@ -module Imagekit - module Models - type unwrap_webhook_event = - Imagekit::VideoTransformationAcceptedEvent - | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent - | Imagekit::UploadPreTransformSuccessEvent - | Imagekit::UploadPreTransformErrorEvent - | Imagekit::UploadPostTransformSuccessEvent - | Imagekit::UploadPostTransformErrorEvent - - module UnwrapWebhookEvent - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::unwrap_webhook_event] - end - end -end diff --git a/sig/imagekit/models/update_file_request.rbs b/sig/imagekit/models/update_file_request.rbs deleted file mode 100644 index 68701252..00000000 --- a/sig/imagekit/models/update_file_request.rbs +++ /dev/null @@ -1,122 +0,0 @@ -module Imagekit - module Models - type update_file_request = - Imagekit::UpdateFileRequest::UpdateFileDetails - | Imagekit::UpdateFileRequest::ChangePublicationStatus - - module UpdateFileRequest - extend Imagekit::Internal::Type::Union - - type update_file_details = - { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: Imagekit::Models::extensions, - remove_ai_tags: Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String - } - - class UpdateFileDetails < Imagekit::Internal::Type::BaseModel - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader extensions: Imagekit::Models::extensions? - - def extensions=: ( - Imagekit::Models::extensions - ) -> Imagekit::Models::extensions - - attr_reader remove_ai_tags: Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags? - - def remove_ai_tags=: ( - Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags - ) -> Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags - - attr_accessor tags: ::Array[String]? - - attr_reader webhook_url: String? - - def webhook_url=: (String) -> String - - def initialize: ( - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?extensions: Imagekit::Models::extensions, - ?remove_ai_tags: Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, - ?tags: ::Array[String]?, - ?webhook_url: String - ) -> void - - def to_hash: -> { - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - extensions: Imagekit::Models::extensions, - remove_ai_tags: Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, - tags: ::Array[String]?, - webhook_url: String - } - - type remove_ai_tags = ::Array[String] | :all - - module RemoveAITags - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags] - - StringArray: Imagekit::Internal::Type::Converter - end - end - - type change_publication_status = - { - publish: Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish - } - - class ChangePublicationStatus < Imagekit::Internal::Type::BaseModel - attr_reader publish: Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish? - - def publish=: ( - Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish - ) -> Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish - - def initialize: ( - ?publish: Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish - ) -> void - - def to_hash: -> { - publish: Imagekit::UpdateFileRequest::ChangePublicationStatus::Publish - } - - type publish = { is_published: bool, include_file_versions: bool } - - class Publish < Imagekit::Internal::Type::BaseModel - attr_accessor is_published: bool - - attr_reader include_file_versions: bool? - - def include_file_versions=: (bool) -> bool - - def initialize: ( - is_published: bool, - ?include_file_versions: bool - ) -> void - - def to_hash: -> { is_published: bool, include_file_versions: bool } - end - end - - def self?.variants: -> ::Array[Imagekit::Models::update_file_request] - end - end -end diff --git a/sig/imagekit/models/upload_post_transform_error_event.rbs b/sig/imagekit/models/upload_post_transform_error_event.rbs deleted file mode 100644 index 7ef7256c..00000000 --- a/sig/imagekit/models/upload_post_transform_error_event.rbs +++ /dev/null @@ -1,192 +0,0 @@ -module Imagekit - module Models - type upload_post_transform_error_event = - { - created_at: Time, - data: Imagekit::UploadPostTransformErrorEvent::Data, - request: Imagekit::UploadPostTransformErrorEvent::Request, - type: :"upload.post-transform.error" - } - - class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent - def created_at: -> Time - - def created_at=: (Time _) -> Time - - def data: -> Imagekit::UploadPostTransformErrorEvent::Data - - def data=: ( - Imagekit::UploadPostTransformErrorEvent::Data _ - ) -> Imagekit::UploadPostTransformErrorEvent::Data - - def request: -> Imagekit::UploadPostTransformErrorEvent::Request - - def request=: ( - Imagekit::UploadPostTransformErrorEvent::Request _ - ) -> Imagekit::UploadPostTransformErrorEvent::Request - - def `type`: -> :"upload.post-transform.error" - - def type=: ( - :"upload.post-transform.error" _ - ) -> :"upload.post-transform.error" - - def initialize: ( - created_at: Time, - data: Imagekit::UploadPostTransformErrorEvent::Data, - request: Imagekit::UploadPostTransformErrorEvent::Request, - ?type: :"upload.post-transform.error" - ) -> void - - def to_hash: -> { - created_at: Time, - data: Imagekit::UploadPostTransformErrorEvent::Data, - request: Imagekit::UploadPostTransformErrorEvent::Request, - type: :"upload.post-transform.error" - } - - type data = - { - file_id: String, - name: String, - path: String, - transformation: Imagekit::UploadPostTransformErrorEvent::Data::Transformation, - url: String - } - - class Data < Imagekit::Internal::Type::BaseModel - attr_accessor file_id: String - - attr_accessor name: String - - attr_accessor path: String - - attr_accessor transformation: Imagekit::UploadPostTransformErrorEvent::Data::Transformation - - attr_accessor url: String - - def initialize: ( - file_id: String, - name: String, - path: String, - transformation: Imagekit::UploadPostTransformErrorEvent::Data::Transformation, - url: String - ) -> void - - def to_hash: -> { - file_id: String, - name: String, - path: String, - transformation: Imagekit::UploadPostTransformErrorEvent::Data::Transformation, - url: String - } - - type transformation = - { - error: Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error - } - - class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor error: Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error - - def initialize: ( - error: Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error - ) -> void - - def to_hash: -> { - error: Imagekit::UploadPostTransformErrorEvent::Data::Transformation::Error - } - - type error = { reason: String } - - class Error < Imagekit::Internal::Type::BaseModel - attr_accessor reason: String - - def initialize: (reason: String) -> void - - def to_hash: -> { reason: String } - end - end - end - - type request = - { - transformation: Imagekit::UploadPostTransformErrorEvent::Request::Transformation, - x_request_id: String - } - - class Request < Imagekit::Internal::Type::BaseModel - attr_accessor transformation: Imagekit::UploadPostTransformErrorEvent::Request::Transformation - - attr_accessor x_request_id: String - - def initialize: ( - transformation: Imagekit::UploadPostTransformErrorEvent::Request::Transformation, - x_request_id: String - ) -> void - - def to_hash: -> { - transformation: Imagekit::UploadPostTransformErrorEvent::Request::Transformation, - x_request_id: String - } - - type transformation = - { - type: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, - protocol: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, - value: String - } - - class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_ - - attr_reader protocol: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol? - - def protocol=: ( - Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol - ) -> Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol - - attr_reader value: String? - - def value=: (String) -> String - - def initialize: ( - type: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, - ?protocol: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, - ?value: String - ) -> void - - def to_hash: -> { - type: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, - protocol: Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, - value: String - } - - type type_ = :transformation | :abs | :"gif-to-video" | :thumbnail - - module Type - extend Imagekit::Internal::Type::Enum - - TRANSFORMATION: :transformation - ABS: :abs - GIF_TO_VIDEO: :"gif-to-video" - THUMBNAIL: :thumbnail - - def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::type_] - end - - type protocol = :hls | :dash - - module Protocol - extend Imagekit::Internal::Type::Enum - - HLS: :hls - DASH: :dash - - def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol] - end - end - end - end - end -end diff --git a/sig/imagekit/models/upload_post_transform_success_event.rbs b/sig/imagekit/models/upload_post_transform_success_event.rbs deleted file mode 100644 index 526a877f..00000000 --- a/sig/imagekit/models/upload_post_transform_success_event.rbs +++ /dev/null @@ -1,142 +0,0 @@ -module Imagekit - module Models - type upload_post_transform_success_event = - { - created_at: Time, - data: Imagekit::UploadPostTransformSuccessEvent::Data, - request: Imagekit::UploadPostTransformSuccessEvent::Request, - type: :"upload.post-transform.success" - } - - class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent - def created_at: -> Time - - def created_at=: (Time _) -> Time - - def data: -> Imagekit::UploadPostTransformSuccessEvent::Data - - def data=: ( - Imagekit::UploadPostTransformSuccessEvent::Data _ - ) -> Imagekit::UploadPostTransformSuccessEvent::Data - - def request: -> Imagekit::UploadPostTransformSuccessEvent::Request - - def request=: ( - Imagekit::UploadPostTransformSuccessEvent::Request _ - ) -> Imagekit::UploadPostTransformSuccessEvent::Request - - def `type`: -> :"upload.post-transform.success" - - def type=: ( - :"upload.post-transform.success" _ - ) -> :"upload.post-transform.success" - - def initialize: ( - created_at: Time, - data: Imagekit::UploadPostTransformSuccessEvent::Data, - request: Imagekit::UploadPostTransformSuccessEvent::Request, - ?type: :"upload.post-transform.success" - ) -> void - - def to_hash: -> { - created_at: Time, - data: Imagekit::UploadPostTransformSuccessEvent::Data, - request: Imagekit::UploadPostTransformSuccessEvent::Request, - type: :"upload.post-transform.success" - } - - type data = { file_id: String, name: String, url: String } - - class Data < Imagekit::Internal::Type::BaseModel - attr_accessor file_id: String - - attr_accessor name: String - - attr_accessor url: String - - def initialize: (file_id: String, name: String, url: String) -> void - - def to_hash: -> { file_id: String, name: String, url: String } - end - - type request = - { - transformation: Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, - x_request_id: String - } - - class Request < Imagekit::Internal::Type::BaseModel - attr_accessor transformation: Imagekit::UploadPostTransformSuccessEvent::Request::Transformation - - attr_accessor x_request_id: String - - def initialize: ( - transformation: Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, - x_request_id: String - ) -> void - - def to_hash: -> { - transformation: Imagekit::UploadPostTransformSuccessEvent::Request::Transformation, - x_request_id: String - } - - type transformation = - { - type: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, - protocol: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, - value: String - } - - class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_ - - attr_reader protocol: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol? - - def protocol=: ( - Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol - ) -> Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol - - attr_reader value: String? - - def value=: (String) -> String - - def initialize: ( - type: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, - ?protocol: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, - ?value: String - ) -> void - - def to_hash: -> { - type: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, - protocol: Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, - value: String - } - - type type_ = :transformation | :abs | :"gif-to-video" | :thumbnail - - module Type - extend Imagekit::Internal::Type::Enum - - TRANSFORMATION: :transformation - ABS: :abs - GIF_TO_VIDEO: :"gif-to-video" - THUMBNAIL: :thumbnail - - def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_] - end - - type protocol = :hls | :dash - - module Protocol - extend Imagekit::Internal::Type::Enum - - HLS: :hls - DASH: :dash - - def self?.values: -> ::Array[Imagekit::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol] - end - end - end - end - end -end diff --git a/sig/imagekit/models/upload_pre_transform_error_event.rbs b/sig/imagekit/models/upload_pre_transform_error_event.rbs deleted file mode 100644 index 6af7d3e6..00000000 --- a/sig/imagekit/models/upload_pre_transform_error_event.rbs +++ /dev/null @@ -1,115 +0,0 @@ -module Imagekit - module Models - type upload_pre_transform_error_event = - { - created_at: Time, - data: Imagekit::UploadPreTransformErrorEvent::Data, - request: Imagekit::UploadPreTransformErrorEvent::Request, - type: :"upload.pre-transform.error" - } - - class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent - def created_at: -> Time - - def created_at=: (Time _) -> Time - - def data: -> Imagekit::UploadPreTransformErrorEvent::Data - - def data=: ( - Imagekit::UploadPreTransformErrorEvent::Data _ - ) -> Imagekit::UploadPreTransformErrorEvent::Data - - def request: -> Imagekit::UploadPreTransformErrorEvent::Request - - def request=: ( - Imagekit::UploadPreTransformErrorEvent::Request _ - ) -> Imagekit::UploadPreTransformErrorEvent::Request - - def `type`: -> :"upload.pre-transform.error" - - def type=: ( - :"upload.pre-transform.error" _ - ) -> :"upload.pre-transform.error" - - def initialize: ( - created_at: Time, - data: Imagekit::UploadPreTransformErrorEvent::Data, - request: Imagekit::UploadPreTransformErrorEvent::Request, - ?type: :"upload.pre-transform.error" - ) -> void - - def to_hash: -> { - created_at: Time, - data: Imagekit::UploadPreTransformErrorEvent::Data, - request: Imagekit::UploadPreTransformErrorEvent::Request, - type: :"upload.pre-transform.error" - } - - type data = - { - name: String, - path: String, - transformation: Imagekit::UploadPreTransformErrorEvent::Data::Transformation - } - - class Data < Imagekit::Internal::Type::BaseModel - attr_accessor name: String - - attr_accessor path: String - - attr_accessor transformation: Imagekit::UploadPreTransformErrorEvent::Data::Transformation - - def initialize: ( - name: String, - path: String, - transformation: Imagekit::UploadPreTransformErrorEvent::Data::Transformation - ) -> void - - def to_hash: -> { - name: String, - path: String, - transformation: Imagekit::UploadPreTransformErrorEvent::Data::Transformation - } - - type transformation = - { - error: Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error - } - - class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor error: Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error - - def initialize: ( - error: Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error - ) -> void - - def to_hash: -> { - error: Imagekit::UploadPreTransformErrorEvent::Data::Transformation::Error - } - - type error = { reason: String } - - class Error < Imagekit::Internal::Type::BaseModel - attr_accessor reason: String - - def initialize: (reason: String) -> void - - def to_hash: -> { reason: String } - end - end - end - - type request = { transformation: String, x_request_id: String } - - class Request < Imagekit::Internal::Type::BaseModel - attr_accessor transformation: String - - attr_accessor x_request_id: String - - def initialize: (transformation: String, x_request_id: String) -> void - - def to_hash: -> { transformation: String, x_request_id: String } - end - end - end -end diff --git a/sig/imagekit/models/upload_pre_transform_success_event.rbs b/sig/imagekit/models/upload_pre_transform_success_event.rbs deleted file mode 100644 index 1d718a37..00000000 --- a/sig/imagekit/models/upload_pre_transform_success_event.rbs +++ /dev/null @@ -1,541 +0,0 @@ -module Imagekit - module Models - type upload_pre_transform_success_event = - { - created_at: Time, - data: Imagekit::UploadPreTransformSuccessEvent::Data, - request: Imagekit::UploadPreTransformSuccessEvent::Request, - type: :"upload.pre-transform.success" - } - - class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent - def created_at: -> Time - - def created_at=: (Time _) -> Time - - def data: -> Imagekit::UploadPreTransformSuccessEvent::Data - - def data=: ( - Imagekit::UploadPreTransformSuccessEvent::Data _ - ) -> Imagekit::UploadPreTransformSuccessEvent::Data - - def request: -> Imagekit::UploadPreTransformSuccessEvent::Request - - def request=: ( - Imagekit::UploadPreTransformSuccessEvent::Request _ - ) -> Imagekit::UploadPreTransformSuccessEvent::Request - - def `type`: -> :"upload.pre-transform.success" - - def type=: ( - :"upload.pre-transform.success" _ - ) -> :"upload.pre-transform.success" - - def initialize: ( - created_at: Time, - data: Imagekit::UploadPreTransformSuccessEvent::Data, - request: Imagekit::UploadPreTransformSuccessEvent::Request, - ?type: :"upload.pre-transform.success" - ) -> void - - def to_hash: -> { - created_at: Time, - data: Imagekit::UploadPreTransformSuccessEvent::Data, - request: Imagekit::UploadPreTransformSuccessEvent::Request, - type: :"upload.pre-transform.success" - } - - type data = - { - ai_tags: ::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - duration: Integer, - embedded_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Metadata, - name: String, - selected_fields_schema: ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, - video_codec: String, - width: Float - } - - class Data < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag]? - - attr_reader audio_codec: String? - - def audio_codec=: (String) -> String - - attr_reader bit_rate: Integer? - - def bit_rate=: (Integer) -> Integer - - attr_accessor custom_coordinates: String? - - attr_reader custom_metadata: ::Hash[Symbol, top]? - - def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader description: String? - - def description=: (String) -> String - - attr_reader duration: Integer? - - def duration=: (Integer) -> Integer - - attr_reader embedded_metadata: ::Hash[Symbol, top]? - - def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - - attr_reader extension_status: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus? - - def extension_status=: ( - Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus - ) -> Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus - - attr_reader file_id: String? - - def file_id=: (String) -> String - - attr_reader file_path: String? - - def file_path=: (String) -> String - - attr_reader file_type: String? - - def file_type=: (String) -> String - - attr_reader height: Float? - - def height=: (Float) -> Float - - attr_reader is_private_file: bool? - - def is_private_file=: (bool) -> bool - - attr_reader is_published: bool? - - def is_published=: (bool) -> bool - - attr_reader metadata: Imagekit::Metadata? - - def metadata=: (Imagekit::Metadata) -> Imagekit::Metadata - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema]? - - def selected_fields_schema=: ( - ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] - ) -> ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] - - attr_reader size: Float? - - def size=: (Float) -> Float - - attr_accessor tags: ::Array[String]? - - attr_reader thumbnail_url: String? - - def thumbnail_url=: (String) -> String - - attr_reader url: String? - - def url=: (String) -> String - - attr_reader version_info: Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo? - - def version_info=: ( - Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo - ) -> Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo - - attr_reader video_codec: String? - - def video_codec=: (String) -> String - - attr_reader width: Float? - - def width=: (Float) -> Float - - def initialize: ( - ?ai_tags: ::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag]?, - ?audio_codec: String, - ?bit_rate: Integer, - ?custom_coordinates: String?, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?duration: Integer, - ?embedded_metadata: ::Hash[Symbol, top], - ?extension_status: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, - ?file_id: String, - ?file_path: String, - ?file_type: String, - ?height: Float, - ?is_private_file: bool, - ?is_published: bool, - ?metadata: Imagekit::Metadata, - ?name: String, - ?selected_fields_schema: ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], - ?size: Float, - ?tags: ::Array[String]?, - ?thumbnail_url: String, - ?url: String, - ?version_info: Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, - ?video_codec: String, - ?width: Float - ) -> void - - def to_hash: -> { - ai_tags: ::Array[Imagekit::UploadPreTransformSuccessEvent::Data::AITag]?, - audio_codec: String, - bit_rate: Integer, - custom_coordinates: String?, - custom_metadata: ::Hash[Symbol, top], - description: String, - duration: Integer, - embedded_metadata: ::Hash[Symbol, top], - extension_status: Imagekit::UploadPreTransformSuccessEvent::Data::ExtensionStatus, - file_id: String, - file_path: String, - file_type: String, - height: Float, - is_private_file: bool, - is_published: bool, - metadata: Imagekit::Metadata, - name: String, - selected_fields_schema: ::Hash[Symbol, Imagekit::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], - size: Float, - tags: ::Array[String]?, - thumbnail_url: String, - url: String, - version_info: Imagekit::UploadPreTransformSuccessEvent::Data::VersionInfo, - video_codec: String, - width: Float - } - - type ai_tag = { confidence: Float, name: String, source: String } - - class AITag < Imagekit::Internal::Type::BaseModel - attr_reader confidence: Float? - - def confidence=: (Float) -> Float - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader source: String? - - def source=: (String) -> String - - def initialize: ( - ?confidence: Float, - ?name: String, - ?source: String - ) -> void - - def to_hash: -> { confidence: Float, name: String, source: String } - end - - type extension_status = - { - ai_auto_description: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, - aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg - } - - class ExtensionStatus < Imagekit::Internal::Type::BaseModel - attr_reader ai_auto_description: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description? - - def ai_auto_description=: ( - Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description - ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description - - attr_reader aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging? - - def aws_auto_tagging=: ( - Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging - ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging - - attr_reader google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging? - - def google_auto_tagging=: ( - Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging - ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging - - attr_reader remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg? - - def remove_bg=: ( - Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg - ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg - - def initialize: ( - ?ai_auto_description: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, - ?aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, - ?google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, - ?remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg - ) -> void - - def to_hash: -> { - ai_auto_description: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, - aws_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, - google_auto_tagging: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, - remove_bg: Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg - } - - type ai_auto_description = :success | :pending | :failed - - module AIAutoDescription - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description] - end - - type aws_auto_tagging = :success | :pending | :failed - - module AwsAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging] - end - - type google_auto_tagging = :success | :pending | :failed - - module GoogleAutoTagging - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging] - end - - type remove_bg = :success | :pending | :failed - - module RemoveBg - extend Imagekit::Internal::Type::Enum - - SUCCESS: :success - PENDING: :pending - FAILED: :failed - - def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg] - end - end - - type selected_fields_schema = - { - type: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_ - - attr_reader default_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value? - - def default_value=: ( - Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value - ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value - - attr_reader is_value_required: bool? - - def is_value_required=: (bool) -> bool - - attr_reader max_length: Float? - - def max_length=: (Float) -> Float - - attr_reader max_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value? - - def max_value=: ( - Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value - ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value - - attr_reader min_length: Float? - - def min_length=: (Float) -> Float - - attr_reader min_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value? - - def min_value=: ( - Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value - ) -> Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value - - attr_reader read_only: bool? - - def read_only=: (bool) -> bool - - attr_reader select_options: ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option]? - - def select_options=: ( - ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] - ) -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] - - attr_reader select_options_truncated: bool? - - def select_options_truncated=: (bool) -> bool - - def initialize: ( - type: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, - ?default_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, - ?is_value_required: bool, - ?max_length: Float, - ?max_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, - ?min_length: Float, - ?min_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, - ?read_only: bool, - ?select_options: ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], - ?select_options_truncated: bool - ) -> void - - def to_hash: -> { - type: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, - is_value_required: bool, - max_length: Float, - max_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, - min_length: Float, - min_value: Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, - read_only: bool, - select_options: ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], - select_options_truncated: bool - } - - type type_ = - :Text - | :Textarea - | :Number - | :Date - | :Boolean - | :SingleSelect - | :MultiSelect - - module Type - extend Imagekit::Internal::Type::Enum - - TEXT: :Text - TEXTAREA: :Textarea - NUMBER: :Number - DATE: :Date - BOOLEAN: :Boolean - SINGLE_SELECT: :SingleSelect - MULTI_SELECT: :MultiSelect - - def self?.values: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_] - end - - type default_value = - String - | Float - | bool - | ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::mixed] - - module DefaultValue - extend Imagekit::Internal::Type::Union - - type mixed = String | Float | bool - - module Mixed - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::mixed] - end - - def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value] - - MixedArray: Imagekit::Internal::Type::Converter - end - - type max_value = String | Float - - module MaxValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value] - end - - type min_value = String | Float - - module MinValue - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value] - end - - type select_option = String | Float | bool - - module SelectOption - extend Imagekit::Internal::Type::Union - - def self?.variants: -> ::Array[Imagekit::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] - end - end - - type version_info = { id: String, name: String } - - class VersionInfo < Imagekit::Internal::Type::BaseModel - attr_reader id: String? - - def id=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - def initialize: (?id: String, ?name: String) -> void - - def to_hash: -> { id: String, name: String } - end - end - - type request = { transformation: String, x_request_id: String } - - class Request < Imagekit::Internal::Type::BaseModel - attr_accessor transformation: String - - attr_accessor x_request_id: String - - def initialize: (transformation: String, x_request_id: String) -> void - - def to_hash: -> { transformation: String, x_request_id: String } - end - end - end -end diff --git a/sig/imagekit/models/video_overlay.rbs b/sig/imagekit/models/video_overlay.rbs deleted file mode 100644 index 1c25b201..00000000 --- a/sig/imagekit/models/video_overlay.rbs +++ /dev/null @@ -1,59 +0,0 @@ -module Imagekit - module Models - type video_overlay = - { - input: String, - type: :video, - encoding: Imagekit::Models::VideoOverlay::encoding, - transformation: ::Array[Imagekit::Transformation] - } - - class VideoOverlay < Imagekit::Models::BaseOverlay - def input: -> String - - def input=: (String _) -> String - - def `type`: -> :video - - def type=: (:video _) -> :video - - def encoding: -> Imagekit::Models::VideoOverlay::encoding? - - def encoding=: ( - Imagekit::Models::VideoOverlay::encoding _ - ) -> Imagekit::Models::VideoOverlay::encoding - - def transformation: -> ::Array[Imagekit::Transformation]? - - def transformation=: ( - ::Array[Imagekit::Transformation] _ - ) -> ::Array[Imagekit::Transformation] - - def initialize: ( - input: String, - ?encoding: Imagekit::Models::VideoOverlay::encoding, - ?transformation: ::Array[Imagekit::Transformation], - ?type: :video - ) -> void - - def to_hash: -> { - input: String, - type: :video, - encoding: Imagekit::Models::VideoOverlay::encoding, - transformation: ::Array[Imagekit::Transformation] - } - - type encoding = :auto | :plain | :base64 - - module Encoding - extend Imagekit::Internal::Type::Enum - - AUTO: :auto - PLAIN: :plain - BASE64: :base64 - - def self?.values: -> ::Array[Imagekit::Models::VideoOverlay::encoding] - end - end - end -end diff --git a/sig/imagekit/models/video_transformation_accepted_event.rbs b/sig/imagekit/models/video_transformation_accepted_event.rbs deleted file mode 100644 index f742ea55..00000000 --- a/sig/imagekit/models/video_transformation_accepted_event.rbs +++ /dev/null @@ -1,261 +0,0 @@ -module Imagekit - module Models - type video_transformation_accepted_event = - { - created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data, - request: Imagekit::VideoTransformationAcceptedEvent::Request, - type: :"video.transformation.accepted" - } - - class VideoTransformationAcceptedEvent < Imagekit::Models::BaseWebhookEvent - def created_at: -> Time - - def created_at=: (Time _) -> Time - - def data: -> Imagekit::VideoTransformationAcceptedEvent::Data - - def data=: ( - Imagekit::VideoTransformationAcceptedEvent::Data _ - ) -> Imagekit::VideoTransformationAcceptedEvent::Data - - def request: -> Imagekit::VideoTransformationAcceptedEvent::Request - - def request=: ( - Imagekit::VideoTransformationAcceptedEvent::Request _ - ) -> Imagekit::VideoTransformationAcceptedEvent::Request - - def `type`: -> :"video.transformation.accepted" - - def type=: ( - :"video.transformation.accepted" _ - ) -> :"video.transformation.accepted" - - def initialize: ( - created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data, - request: Imagekit::VideoTransformationAcceptedEvent::Request, - ?type: :"video.transformation.accepted" - ) -> void - - def to_hash: -> { - created_at: Time, - data: Imagekit::VideoTransformationAcceptedEvent::Data, - request: Imagekit::VideoTransformationAcceptedEvent::Request, - type: :"video.transformation.accepted" - } - - type data = - { - asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation - } - - class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset - - attr_accessor transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation - - def initialize: ( - asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation - ) -> void - - def to_hash: -> { - asset: Imagekit::VideoTransformationAcceptedEvent::Data::Asset, - transformation: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation - } - - type asset = { url: String } - - class Asset < Imagekit::Internal::Type::BaseModel - attr_accessor url: String - - def initialize: (url: String) -> void - - def to_hash: -> { url: String } - end - - type transformation = - { - type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options - } - - class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_ - - attr_reader options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options? - - def options=: ( - Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options - - def initialize: ( - type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, - ?options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options - ) -> void - - def to_hash: -> { - type: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationAcceptedEvent::Data::Transformation::Options - } - - type type_ = - :"video-transformation" | :"gif-to-video" | :"video-thumbnail" - - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION: :"video-transformation" - GIF_TO_VIDEO: :"gif-to-video" - VIDEO_THUMBNAIL: :"video-thumbnail" - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_] - end - - type options = - { - audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, - auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, - quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, - variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec? - - def audio_codec=: ( - Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec - - attr_reader auto_rotate: bool? - - def auto_rotate=: (bool) -> bool - - attr_reader format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_? - - def format_=: ( - Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol? - - def stream_protocol=: ( - Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol - - attr_reader variants: ::Array[String]? - - def variants=: (::Array[String]) -> ::Array[String] - - attr_reader video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec? - - def video_codec=: ( - Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec - - def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, - ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, - ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, - ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec - ) -> void - - def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, - auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, - quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, - variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec - } - - type audio_codec = :aac | :opus - - module AudioCodec - extend Imagekit::Internal::Type::Enum - - AAC: :aac - OPUS: :opus - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec] - end - - type format_ = :mp4 | :webm | :jpg | :png | :webp - - module Format - extend Imagekit::Internal::Type::Enum - - MP4: :mp4 - WEBM: :webm - JPG: :jpg - PNG: :png - WEBP: :webp - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_] - end - - type stream_protocol = :HLS | :DASH - - module StreamProtocol - extend Imagekit::Internal::Type::Enum - - HLS: :HLS - DASH: :DASH - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol] - end - - type video_codec = :h264 | :vp9 | :av1 - - module VideoCodec - extend Imagekit::Internal::Type::Enum - - H264: :h264 - VP9: :vp9 - AV1: :av1 - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec] - end - end - end - end - - type request = { url: String, x_request_id: String, user_agent: String } - - class Request < Imagekit::Internal::Type::BaseModel - attr_accessor url: String - - attr_accessor x_request_id: String - - attr_reader user_agent: String? - - def user_agent=: (String) -> String - - def initialize: ( - url: String, - x_request_id: String, - ?user_agent: String - ) -> void - - def to_hash: -> { - url: String, - x_request_id: String, - user_agent: String - } - end - end - end -end diff --git a/sig/imagekit/models/video_transformation_error_event.rbs b/sig/imagekit/models/video_transformation_error_event.rbs deleted file mode 100644 index 42a582dd..00000000 --- a/sig/imagekit/models/video_transformation_error_event.rbs +++ /dev/null @@ -1,300 +0,0 @@ -module Imagekit - module Models - type video_transformation_error_event = - { - created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data, - request: Imagekit::VideoTransformationErrorEvent::Request, - type: :"video.transformation.error" - } - - class VideoTransformationErrorEvent < Imagekit::Models::BaseWebhookEvent - def created_at: -> Time - - def created_at=: (Time _) -> Time - - def data: -> Imagekit::VideoTransformationErrorEvent::Data - - def data=: ( - Imagekit::VideoTransformationErrorEvent::Data _ - ) -> Imagekit::VideoTransformationErrorEvent::Data - - def request: -> Imagekit::VideoTransformationErrorEvent::Request - - def request=: ( - Imagekit::VideoTransformationErrorEvent::Request _ - ) -> Imagekit::VideoTransformationErrorEvent::Request - - def `type`: -> :"video.transformation.error" - - def type=: ( - :"video.transformation.error" _ - ) -> :"video.transformation.error" - - def initialize: ( - created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data, - request: Imagekit::VideoTransformationErrorEvent::Request, - ?type: :"video.transformation.error" - ) -> void - - def to_hash: -> { - created_at: Time, - data: Imagekit::VideoTransformationErrorEvent::Data, - request: Imagekit::VideoTransformationErrorEvent::Request, - type: :"video.transformation.error" - } - - type data = - { - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation - } - - class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationErrorEvent::Data::Asset - - attr_accessor transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation - - def initialize: ( - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation - ) -> void - - def to_hash: -> { - asset: Imagekit::VideoTransformationErrorEvent::Data::Asset, - transformation: Imagekit::VideoTransformationErrorEvent::Data::Transformation - } - - type asset = { url: String } - - class Asset < Imagekit::Internal::Type::BaseModel - attr_accessor url: String - - def initialize: (url: String) -> void - - def to_hash: -> { url: String } - end - - type transformation = - { - type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, - error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, - options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options - } - - class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_ - - attr_reader error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error? - - def error=: ( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error - ) -> Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error - - attr_reader options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options? - - def options=: ( - Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options - - def initialize: ( - type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, - ?error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, - ?options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options - ) -> void - - def to_hash: -> { - type: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_, - error: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Error, - options: Imagekit::VideoTransformationErrorEvent::Data::Transformation::Options - } - - type type_ = - :"video-transformation" | :"gif-to-video" | :"video-thumbnail" - - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION: :"video-transformation" - GIF_TO_VIDEO: :"gif-to-video" - VIDEO_THUMBNAIL: :"video-thumbnail" - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::type_] - end - - type error = - { - reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason - } - - class Error < Imagekit::Internal::Type::BaseModel - attr_accessor reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason - - def initialize: ( - reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason - ) -> void - - def to_hash: -> { - reason: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason - } - - type reason = - :encoding_failed | :download_failed | :internal_server_error - - module Reason - extend Imagekit::Internal::Type::Enum - - ENCODING_FAILED: :encoding_failed - DOWNLOAD_FAILED: :download_failed - INTERNAL_SERVER_ERROR: :internal_server_error - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason] - end - end - - type options = - { - audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, - auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, - quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, - variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec? - - def audio_codec=: ( - Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec - - attr_reader auto_rotate: bool? - - def auto_rotate=: (bool) -> bool - - attr_reader format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_? - - def format_=: ( - Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol? - - def stream_protocol=: ( - Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol - - attr_reader variants: ::Array[String]? - - def variants=: (::Array[String]) -> ::Array[String] - - attr_reader video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec? - - def video_codec=: ( - Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec - - def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, - ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, - ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, - ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec - ) -> void - - def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, - auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, - quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, - variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec - } - - type audio_codec = :aac | :opus - - module AudioCodec - extend Imagekit::Internal::Type::Enum - - AAC: :aac - OPUS: :opus - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec] - end - - type format_ = :mp4 | :webm | :jpg | :png | :webp - - module Format - extend Imagekit::Internal::Type::Enum - - MP4: :mp4 - WEBM: :webm - JPG: :jpg - PNG: :png - WEBP: :webp - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_] - end - - type stream_protocol = :HLS | :DASH - - module StreamProtocol - extend Imagekit::Internal::Type::Enum - - HLS: :HLS - DASH: :DASH - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol] - end - - type video_codec = :h264 | :vp9 | :av1 - - module VideoCodec - extend Imagekit::Internal::Type::Enum - - H264: :h264 - VP9: :vp9 - AV1: :av1 - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec] - end - end - end - end - - type request = { url: String, x_request_id: String, user_agent: String } - - class Request < Imagekit::Internal::Type::BaseModel - attr_accessor url: String - - attr_accessor x_request_id: String - - attr_reader user_agent: String? - - def user_agent=: (String) -> String - - def initialize: ( - url: String, - x_request_id: String, - ?user_agent: String - ) -> void - - def to_hash: -> { - url: String, - x_request_id: String, - user_agent: String - } - end - end - end -end diff --git a/sig/imagekit/models/video_transformation_ready_event.rbs b/sig/imagekit/models/video_transformation_ready_event.rbs deleted file mode 100644 index 0b4478a6..00000000 --- a/sig/imagekit/models/video_transformation_ready_event.rbs +++ /dev/null @@ -1,359 +0,0 @@ -module Imagekit - module Models - type video_transformation_ready_event = - { - created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data, - request: Imagekit::VideoTransformationReadyEvent::Request, - type: :"video.transformation.ready", - timings: Imagekit::VideoTransformationReadyEvent::Timings - } - - class VideoTransformationReadyEvent < Imagekit::Models::BaseWebhookEvent - def created_at: -> Time - - def created_at=: (Time _) -> Time - - def data: -> Imagekit::VideoTransformationReadyEvent::Data - - def data=: ( - Imagekit::VideoTransformationReadyEvent::Data _ - ) -> Imagekit::VideoTransformationReadyEvent::Data - - def request: -> Imagekit::VideoTransformationReadyEvent::Request - - def request=: ( - Imagekit::VideoTransformationReadyEvent::Request _ - ) -> Imagekit::VideoTransformationReadyEvent::Request - - def `type`: -> :"video.transformation.ready" - - def type=: ( - :"video.transformation.ready" _ - ) -> :"video.transformation.ready" - - def timings: -> Imagekit::VideoTransformationReadyEvent::Timings? - - def timings=: ( - Imagekit::VideoTransformationReadyEvent::Timings _ - ) -> Imagekit::VideoTransformationReadyEvent::Timings - - def initialize: ( - created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data, - request: Imagekit::VideoTransformationReadyEvent::Request, - ?timings: Imagekit::VideoTransformationReadyEvent::Timings, - ?type: :"video.transformation.ready" - ) -> void - - def to_hash: -> { - created_at: Time, - data: Imagekit::VideoTransformationReadyEvent::Data, - request: Imagekit::VideoTransformationReadyEvent::Request, - type: :"video.transformation.ready", - timings: Imagekit::VideoTransformationReadyEvent::Timings - } - - type data = - { - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation - } - - class Data < Imagekit::Internal::Type::BaseModel - attr_accessor asset: Imagekit::VideoTransformationReadyEvent::Data::Asset - - attr_accessor transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation - - def initialize: ( - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation - ) -> void - - def to_hash: -> { - asset: Imagekit::VideoTransformationReadyEvent::Data::Asset, - transformation: Imagekit::VideoTransformationReadyEvent::Data::Transformation - } - - type asset = { url: String } - - class Asset < Imagekit::Internal::Type::BaseModel - attr_accessor url: String - - def initialize: (url: String) -> void - - def to_hash: -> { url: String } - end - - type transformation = - { - type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, - output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output - } - - class Transformation < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_ - - attr_reader options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options? - - def options=: ( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options - ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options - - attr_reader output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output? - - def output=: ( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output - ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output - - def initialize: ( - type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, - ?options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, - ?output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output - ) -> void - - def to_hash: -> { - type: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_, - options: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Options, - output: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output - } - - type type_ = - :"video-transformation" | :"gif-to-video" | :"video-thumbnail" - - module Type - extend Imagekit::Internal::Type::Enum - - VIDEO_TRANSFORMATION: :"video-transformation" - GIF_TO_VIDEO: :"gif-to-video" - VIDEO_THUMBNAIL: :"video-thumbnail" - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::type_] - end - - type options = - { - audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, - auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, - quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, - variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec - } - - class Options < Imagekit::Internal::Type::BaseModel - attr_reader audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec? - - def audio_codec=: ( - Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec - ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec - - attr_reader auto_rotate: bool? - - def auto_rotate=: (bool) -> bool - - attr_reader format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_? - - def format_=: ( - Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ - ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ - - attr_reader quality: Integer? - - def quality=: (Integer) -> Integer - - attr_reader stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol? - - def stream_protocol=: ( - Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol - ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol - - attr_reader variants: ::Array[String]? - - def variants=: (::Array[String]) -> ::Array[String] - - attr_reader video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec? - - def video_codec=: ( - Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec - ) -> Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec - - def initialize: ( - ?audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, - ?auto_rotate: bool, - ?format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, - ?quality: Integer, - ?stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, - ?variants: ::Array[String], - ?video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec - ) -> void - - def to_hash: -> { - audio_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, - auto_rotate: bool, - format_: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, - quality: Integer, - stream_protocol: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, - variants: ::Array[String], - video_codec: Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec - } - - type audio_codec = :aac | :opus - - module AudioCodec - extend Imagekit::Internal::Type::Enum - - AAC: :aac - OPUS: :opus - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec] - end - - type format_ = :mp4 | :webm | :jpg | :png | :webp - - module Format - extend Imagekit::Internal::Type::Enum - - MP4: :mp4 - WEBM: :webm - JPG: :jpg - PNG: :png - WEBP: :webp - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_] - end - - type stream_protocol = :HLS | :DASH - - module StreamProtocol - extend Imagekit::Internal::Type::Enum - - HLS: :HLS - DASH: :DASH - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol] - end - - type video_codec = :h264 | :vp9 | :av1 - - module VideoCodec - extend Imagekit::Internal::Type::Enum - - H264: :h264 - VP9: :vp9 - AV1: :av1 - - def self?.values: -> ::Array[Imagekit::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec] - end - end - - type output = - { - url: String, - video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata - } - - class Output < Imagekit::Internal::Type::BaseModel - attr_accessor url: String - - attr_reader video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata? - - def video_metadata=: ( - Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata - ) -> Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata - - def initialize: ( - url: String, - ?video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata - ) -> void - - def to_hash: -> { - url: String, - video_metadata: Imagekit::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata - } - - type video_metadata = - { - bitrate: Integer, - duration: Float, - height: Integer, - width: Integer - } - - class VideoMetadata < Imagekit::Internal::Type::BaseModel - attr_accessor bitrate: Integer - - attr_accessor duration: Float - - attr_accessor height: Integer - - attr_accessor width: Integer - - def initialize: ( - bitrate: Integer, - duration: Float, - height: Integer, - width: Integer - ) -> void - - def to_hash: -> { - bitrate: Integer, - duration: Float, - height: Integer, - width: Integer - } - end - end - end - end - - type request = { url: String, x_request_id: String, user_agent: String } - - class Request < Imagekit::Internal::Type::BaseModel - attr_accessor url: String - - attr_accessor x_request_id: String - - attr_reader user_agent: String? - - def user_agent=: (String) -> String - - def initialize: ( - url: String, - x_request_id: String, - ?user_agent: String - ) -> void - - def to_hash: -> { - url: String, - x_request_id: String, - user_agent: String - } - end - - type timings = { download_duration: Integer, encoding_duration: Integer } - - class Timings < Imagekit::Internal::Type::BaseModel - attr_reader download_duration: Integer? - - def download_duration=: (Integer) -> Integer - - attr_reader encoding_duration: Integer? - - def encoding_duration=: (Integer) -> Integer - - def initialize: ( - ?download_duration: Integer, - ?encoding_duration: Integer - ) -> void - - def to_hash: -> { - download_duration: Integer, - encoding_duration: Integer - } - end - end - end -end diff --git a/sig/imagekit/models/webhook_unsafe_unwrap_params.rbs b/sig/imagekit/models/webhook_unsafe_unwrap_params.rbs deleted file mode 100644 index 6b7b0859..00000000 --- a/sig/imagekit/models/webhook_unsafe_unwrap_params.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type webhook_unsafe_unwrap_params = - { } & Imagekit::Internal::Type::request_parameters - - class WebhookUnsafeUnwrapParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end -end diff --git a/sig/imagekit/models/webhook_unwrap_params.rbs b/sig/imagekit/models/webhook_unwrap_params.rbs deleted file mode 100644 index e321d3b5..00000000 --- a/sig/imagekit/models/webhook_unwrap_params.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Models - type webhook_unwrap_params = - { } & Imagekit::Internal::Type::request_parameters - - class WebhookUnwrapParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters - - def initialize: (?request_options: Imagekit::request_opts) -> void - - def to_hash: -> { request_options: Imagekit::RequestOptions } - end - end -end diff --git a/sig/imagekit/resources/accounts.rbs b/sig/imagekit/resources/accounts.rbs deleted file mode 100644 index dfc6188c..00000000 --- a/sig/imagekit/resources/accounts.rbs +++ /dev/null @@ -1,13 +0,0 @@ -module Imagekit - module Resources - class Accounts - attr_reader usage: Imagekit::Resources::Accounts::Usage - - attr_reader origins: Imagekit::Resources::Accounts::Origins - - attr_reader url_endpoints: Imagekit::Resources::Accounts::URLEndpoints - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/accounts/origins.rbs b/sig/imagekit/resources/accounts/origins.rbs deleted file mode 100644 index 6fe76931..00000000 --- a/sig/imagekit/resources/accounts/origins.rbs +++ /dev/null @@ -1,31 +0,0 @@ -module Imagekit - module Resources - class Accounts - class Origins - def create: ( - origin_request: Imagekit::Models::Accounts::OriginRequest, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_response - - def update: ( - String id, - origin_request: Imagekit::Models::Accounts::OriginRequest, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_response - - def list: ( - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_list_response - - def delete: (String id, ?request_options: Imagekit::request_opts) -> nil - - def get: ( - String id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::origin_response - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/accounts/url_endpoints.rbs b/sig/imagekit/resources/accounts/url_endpoints.rbs deleted file mode 100644 index b87de7ed..00000000 --- a/sig/imagekit/resources/accounts/url_endpoints.rbs +++ /dev/null @@ -1,37 +0,0 @@ -module Imagekit - module Resources - class Accounts - class URLEndpoints - def create: ( - description: String, - ?origins: ::Array[String], - ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Accounts::URLEndpointResponse - - def update: ( - String id, - description: String, - ?origins: ::Array[String], - ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Accounts::URLEndpointResponse - - def list: ( - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::url_endpoint_list_response - - def delete: (String id, ?request_options: Imagekit::request_opts) -> nil - - def get: ( - String id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Accounts::URLEndpointResponse - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/accounts/usage.rbs b/sig/imagekit/resources/accounts/usage.rbs deleted file mode 100644 index b4c781db..00000000 --- a/sig/imagekit/resources/accounts/usage.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Imagekit - module Resources - class Accounts - class Usage - def get: ( - end_date: Date, - start_date: Date, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Accounts::UsageGetResponse - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/assets.rbs b/sig/imagekit/resources/assets.rbs deleted file mode 100644 index 65ba95d1..00000000 --- a/sig/imagekit/resources/assets.rbs +++ /dev/null @@ -1,18 +0,0 @@ -module Imagekit - module Resources - class Assets - def list: ( - ?file_type: Imagekit::Models::AssetListParams::file_type, - ?limit: Integer, - ?path: String, - ?search_query: String, - ?skip: Integer, - ?sort: Imagekit::Models::AssetListParams::sort, - ?type: Imagekit::Models::AssetListParams::type_, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::asset_list_response - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/beta.rbs b/sig/imagekit/resources/beta.rbs deleted file mode 100644 index 750d302a..00000000 --- a/sig/imagekit/resources/beta.rbs +++ /dev/null @@ -1,9 +0,0 @@ -module Imagekit - module Resources - class Beta - attr_reader v2: Imagekit::Resources::Beta::V2 - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/beta/v2.rbs b/sig/imagekit/resources/beta/v2.rbs deleted file mode 100644 index 3b91ef06..00000000 --- a/sig/imagekit/resources/beta/v2.rbs +++ /dev/null @@ -1,11 +0,0 @@ -module Imagekit - module Resources - class Beta - class V2 - attr_reader files: Imagekit::Resources::Beta::V2::Files - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/cache.rbs b/sig/imagekit/resources/cache.rbs deleted file mode 100644 index e8051527..00000000 --- a/sig/imagekit/resources/cache.rbs +++ /dev/null @@ -1,9 +0,0 @@ -module Imagekit - module Resources - class Cache - attr_reader invalidation: Imagekit::Resources::Cache::Invalidation - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/cache/invalidation.rbs b/sig/imagekit/resources/cache/invalidation.rbs deleted file mode 100644 index 66bcbae0..00000000 --- a/sig/imagekit/resources/cache/invalidation.rbs +++ /dev/null @@ -1,19 +0,0 @@ -module Imagekit - module Resources - class Cache - class Invalidation - def create: ( - url: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Cache::InvalidationCreateResponse - - def get: ( - String request_id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Cache::InvalidationGetResponse - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/custom_metadata_fields.rbs b/sig/imagekit/resources/custom_metadata_fields.rbs deleted file mode 100644 index 23ba7089..00000000 --- a/sig/imagekit/resources/custom_metadata_fields.rbs +++ /dev/null @@ -1,32 +0,0 @@ -module Imagekit - module Resources - class CustomMetadataFields - def create: ( - label: String, - name: String, - schema: Imagekit::CustomMetadataFieldCreateParams::Schema, - ?request_options: Imagekit::request_opts - ) -> Imagekit::CustomMetadataField - - def update: ( - String id, - ?label: String, - ?schema: Imagekit::CustomMetadataFieldUpdateParams::Schema, - ?request_options: Imagekit::request_opts - ) -> Imagekit::CustomMetadataField - - def list: ( - ?folder_path: String, - ?include_deleted: bool, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::custom_metadata_field_list_response - - def delete: ( - String id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::CustomMetadataFieldDeleteResponse - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/files.rbs b/sig/imagekit/resources/files.rbs deleted file mode 100644 index e2c281c0..00000000 --- a/sig/imagekit/resources/files.rbs +++ /dev/null @@ -1,76 +0,0 @@ -module Imagekit - module Resources - class Files - attr_reader bulk: Imagekit::Resources::Files::Bulk - - attr_reader versions: Imagekit::Resources::Files::Versions - - attr_reader metadata: Imagekit::Resources::Files::Metadata - - def update: ( - String file_id, - update_file_request: Imagekit::Models::UpdateFileRequest, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileUpdateResponse - - def delete: ( - String file_id, - ?request_options: Imagekit::request_opts - ) -> nil - - def copy: ( - destination_path: String, - source_file_path: String, - ?include_file_versions: bool, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileCopyResponse - - def get: ( - String file_id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::File - - def move: ( - destination_path: String, - source_file_path: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileMoveResponse - - def rename: ( - file_path: String, - new_file_name: String, - ?purge_cache: bool, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileRenameResponse - - def upload: ( - file: Imagekit::Internal::file_input, - file_name: String, - ?token: String, - ?checks: String, - ?custom_coordinates: String, - ?custom_metadata: ::Hash[Symbol, top], - ?description: String, - ?expire: Integer, - ?extensions: Imagekit::Models::extensions, - ?folder: String, - ?is_private_file: bool, - ?is_published: bool, - ?overwrite_ai_tags: bool, - ?overwrite_custom_metadata: bool, - ?overwrite_file: bool, - ?overwrite_tags: bool, - ?public_key: String, - ?response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], - ?signature: String, - ?tags: ::Array[String], - ?transformation: Imagekit::FileUploadParams::Transformation, - ?use_unique_file_name: bool, - ?webhook_url: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FileUploadResponse - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/files/bulk.rbs b/sig/imagekit/resources/files/bulk.rbs deleted file mode 100644 index a8df17a8..00000000 --- a/sig/imagekit/resources/files/bulk.rbs +++ /dev/null @@ -1,32 +0,0 @@ -module Imagekit - module Resources - class Files - class Bulk - def delete: ( - file_ids: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::BulkDeleteResponse - - def add_tags: ( - file_ids: ::Array[String], - tags: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::BulkAddTagsResponse - - def remove_ai_tags: ( - ai_tags: ::Array[String], - file_ids: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::BulkRemoveAITagsResponse - - def remove_tags: ( - file_ids: ::Array[String], - tags: ::Array[String], - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::BulkRemoveTagsResponse - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/files/metadata.rbs b/sig/imagekit/resources/files/metadata.rbs deleted file mode 100644 index 4ddd61e6..00000000 --- a/sig/imagekit/resources/files/metadata.rbs +++ /dev/null @@ -1,19 +0,0 @@ -module Imagekit - module Resources - class Files - class Metadata - def get: ( - String file_id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Metadata - - def get_from_url: ( - url: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Metadata - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/files/versions.rbs b/sig/imagekit/resources/files/versions.rbs deleted file mode 100644 index 881e2c57..00000000 --- a/sig/imagekit/resources/files/versions.rbs +++ /dev/null @@ -1,32 +0,0 @@ -module Imagekit - module Resources - class Files - class Versions - def list: ( - String file_id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::version_list_response - - def delete: ( - String version_id, - file_id: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Files::VersionDeleteResponse - - def get: ( - String version_id, - file_id: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::File - - def restore: ( - String version_id, - file_id: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::File - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/folders.rbs b/sig/imagekit/resources/folders.rbs deleted file mode 100644 index f5990d9b..00000000 --- a/sig/imagekit/resources/folders.rbs +++ /dev/null @@ -1,40 +0,0 @@ -module Imagekit - module Resources - class Folders - attr_reader job: Imagekit::Resources::Folders::Job - - def create: ( - folder_name: String, - parent_folder_path: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FolderCreateResponse - - def delete: ( - folder_path: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FolderDeleteResponse - - def copy: ( - destination_path: String, - source_folder_path: String, - ?include_versions: bool, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FolderCopyResponse - - def move: ( - destination_path: String, - source_folder_path: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FolderMoveResponse - - def rename: ( - folder_path: String, - new_folder_name: String, - ?purge_cache: bool, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::FolderRenameResponse - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/resources/folders/job.rbs b/sig/imagekit/resources/folders/job.rbs deleted file mode 100644 index 81561a88..00000000 --- a/sig/imagekit/resources/folders/job.rbs +++ /dev/null @@ -1,14 +0,0 @@ -module Imagekit - module Resources - class Folders - class Job - def get: ( - String job_id, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Folders::JobGetResponse - - def initialize: (client: Imagekit::Client) -> void - end - end - end -end diff --git a/sig/imagekit/resources/webhooks.rbs b/sig/imagekit/resources/webhooks.rbs deleted file mode 100644 index ea4242dd..00000000 --- a/sig/imagekit/resources/webhooks.rbs +++ /dev/null @@ -1,27 +0,0 @@ -module Imagekit - module Resources - class Webhooks - def unsafe_unwrap: ( - String payload - ) -> (Imagekit::VideoTransformationAcceptedEvent - | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent - | Imagekit::UploadPreTransformSuccessEvent - | Imagekit::UploadPreTransformErrorEvent - | Imagekit::UploadPostTransformSuccessEvent - | Imagekit::UploadPostTransformErrorEvent) - - def unwrap: ( - String payload - ) -> (Imagekit::VideoTransformationAcceptedEvent - | Imagekit::VideoTransformationReadyEvent - | Imagekit::VideoTransformationErrorEvent - | Imagekit::UploadPreTransformSuccessEvent - | Imagekit::UploadPreTransformErrorEvent - | Imagekit::UploadPostTransformSuccessEvent - | Imagekit::UploadPostTransformErrorEvent) - - def initialize: (client: Imagekit::Client) -> void - end - end -end diff --git a/sig/imagekit/client.rbs b/sig/imagekitio/client.rbs similarity index 50% rename from sig/imagekit/client.rbs rename to sig/imagekitio/client.rbs index 754fe43e..71462b82 100644 --- a/sig/imagekit/client.rbs +++ b/sig/imagekitio/client.rbs @@ -1,5 +1,5 @@ -module Imagekit - class Client < Imagekit::Internal::Transport::BaseClient +module Imagekitio + class Client < Imagekitio::Internal::Transport::BaseClient DEFAULT_MAX_RETRIES: 2 DEFAULT_TIMEOUT_IN_SECONDS: Float @@ -12,21 +12,21 @@ module Imagekit attr_reader password: String? - attr_reader custom_metadata_fields: Imagekit::Resources::CustomMetadataFields + attr_reader custom_metadata_fields: Imagekitio::Resources::CustomMetadataFields - attr_reader files: Imagekit::Resources::Files + attr_reader files: Imagekitio::Resources::Files - attr_reader assets: Imagekit::Resources::Assets + attr_reader assets: Imagekitio::Resources::Assets - attr_reader cache: Imagekit::Resources::Cache + attr_reader cache: Imagekitio::Resources::Cache - attr_reader folders: Imagekit::Resources::Folders + attr_reader folders: Imagekitio::Resources::Folders - attr_reader accounts: Imagekit::Resources::Accounts + attr_reader accounts: Imagekitio::Resources::Accounts - attr_reader beta: Imagekit::Resources::Beta + attr_reader beta: Imagekitio::Resources::Beta - attr_reader webhooks: Imagekit::Resources::Webhooks + attr_reader webhooks: Imagekitio::Resources::Webhooks private def auth_headers: -> ::Hash[String, String] diff --git a/sig/imagekit/errors.rbs b/sig/imagekitio/errors.rbs similarity index 70% rename from sig/imagekit/errors.rbs rename to sig/imagekitio/errors.rbs index c24034f6..b5d55488 100644 --- a/sig/imagekit/errors.rbs +++ b/sig/imagekitio/errors.rbs @@ -1,10 +1,10 @@ -module Imagekit +module Imagekitio module Errors class Error < StandardError attr_accessor cause: StandardError? end - class ConversionError < Imagekit::Errors::Error + class ConversionError < Imagekitio::Errors::Error def cause: -> StandardError? def initialize: ( @@ -16,7 +16,7 @@ module Imagekit ) -> void end - class APIError < Imagekit::Errors::Error + class APIError < Imagekitio::Errors::Error attr_accessor url: URI::Generic attr_accessor status: Integer? @@ -36,7 +36,7 @@ module Imagekit ) -> void end - class APIConnectionError < Imagekit::Errors::APIError + class APIConnectionError < Imagekitio::Errors::APIError def initialize: ( url: URI::Generic, ?status: nil, @@ -48,7 +48,7 @@ module Imagekit ) -> void end - class APITimeoutError < Imagekit::Errors::APIConnectionError + class APITimeoutError < Imagekitio::Errors::APIConnectionError def initialize: ( url: URI::Generic, ?status: nil, @@ -60,7 +60,7 @@ module Imagekit ) -> void end - class APIStatusError < Imagekit::Errors::APIError + class APIStatusError < Imagekitio::Errors::APIError def self.for: ( url: URI::Generic, status: Integer, @@ -82,35 +82,35 @@ module Imagekit ) -> void end - class BadRequestError < Imagekit::Errors::APIStatusError + class BadRequestError < Imagekitio::Errors::APIStatusError HTTP_STATUS: 400 end - class AuthenticationError < Imagekit::Errors::APIStatusError + class AuthenticationError < Imagekitio::Errors::APIStatusError HTTP_STATUS: 401 end - class PermissionDeniedError < Imagekit::Errors::APIStatusError + class PermissionDeniedError < Imagekitio::Errors::APIStatusError HTTP_STATUS: 403 end - class NotFoundError < Imagekit::Errors::APIStatusError + class NotFoundError < Imagekitio::Errors::APIStatusError HTTP_STATUS: 404 end - class ConflictError < Imagekit::Errors::APIStatusError + class ConflictError < Imagekitio::Errors::APIStatusError HTTP_STATUS: 409 end - class UnprocessableEntityError < Imagekit::Errors::APIStatusError + class UnprocessableEntityError < Imagekitio::Errors::APIStatusError HTTP_STATUS: 422 end - class RateLimitError < Imagekit::Errors::APIStatusError + class RateLimitError < Imagekitio::Errors::APIStatusError HTTP_STATUS: 429 end - class InternalServerError < Imagekit::Errors::APIStatusError + class InternalServerError < Imagekitio::Errors::APIStatusError HTTP_STATUS: Range[Integer] end end diff --git a/sig/imagekit/file_part.rbs b/sig/imagekitio/file_part.rbs similarity index 95% rename from sig/imagekit/file_part.rbs rename to sig/imagekitio/file_part.rbs index 0e12e8df..323ade3a 100644 --- a/sig/imagekit/file_part.rbs +++ b/sig/imagekitio/file_part.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio class FilePart attr_reader content: Pathname | StringIO | IO | String diff --git a/sig/imagekit/internal.rbs b/sig/imagekitio/internal.rbs similarity index 54% rename from sig/imagekit/internal.rbs rename to sig/imagekitio/internal.rbs index 90664cb4..f1649f46 100644 --- a/sig/imagekit/internal.rbs +++ b/sig/imagekitio/internal.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Internal - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport - type file_input = Pathname | StringIO | IO | String | Imagekit::FilePart + type file_input = Pathname | StringIO | IO | String | Imagekitio::FilePart OMIT: Object end diff --git a/sig/imagekit/internal/transport/base_client.rbs b/sig/imagekitio/internal/transport/base_client.rbs similarity index 75% rename from sig/imagekit/internal/transport/base_client.rbs rename to sig/imagekitio/internal/transport/base_client.rbs index 420b711d..9ab9fe58 100644 --- a/sig/imagekit/internal/transport/base_client.rbs +++ b/sig/imagekitio/internal/transport/base_client.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Internal module Transport class BaseClient - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport type request_components = { @@ -19,8 +19,8 @@ module Imagekit | (^(top arg0) -> top))?, page: Class?, stream: Class?, - model: Imagekit::Internal::Type::Converter::input?, - options: Imagekit::request_opts? + model: Imagekitio::Internal::Type::Converter::input?, + options: Imagekitio::request_opts? } type request_input = { @@ -37,7 +37,7 @@ module Imagekit PLATFORM_HEADERS: ::Hash[String, String] def self.validate!: ( - Imagekit::Internal::Transport::BaseClient::request_components req + Imagekitio::Internal::Transport::BaseClient::request_components req ) -> void def self.should_retry?: ( @@ -46,13 +46,13 @@ module Imagekit ) -> bool def self.follow_redirect: ( - Imagekit::Internal::Transport::BaseClient::request_input request, + Imagekitio::Internal::Transport::BaseClient::request_input request, status: Integer, response_headers: ::Hash[String, String] - ) -> Imagekit::Internal::Transport::BaseClient::request_input + ) -> Imagekitio::Internal::Transport::BaseClient::request_input def self.reap_connection!: ( - Integer | Imagekit::Errors::APIConnectionError status, + Integer | Imagekitio::Errors::APIConnectionError status, stream: Enumerable[String]? ) -> void @@ -71,7 +71,7 @@ module Imagekit attr_reader idempotency_header: String? # @api private - attr_reader requester: Imagekit::Internal::Transport::PooledNetRequester + attr_reader requester: Imagekitio::Internal::Transport::PooledNetRequester def initialize: ( base_url: String, @@ -90,9 +90,9 @@ module Imagekit private def generate_idempotency_key: -> String private def build_request: ( - Imagekit::Internal::Transport::BaseClient::request_components req, - Imagekit::request_options opts - ) -> Imagekit::Internal::Transport::BaseClient::request_input + Imagekitio::Internal::Transport::BaseClient::request_components req, + Imagekitio::request_options opts + ) -> Imagekitio::Internal::Transport::BaseClient::request_input private def retry_delay: ( ::Hash[String, String] headers, @@ -100,7 +100,7 @@ module Imagekit ) -> Float def send_request: ( - Imagekit::Internal::Transport::BaseClient::request_input request, + Imagekitio::Internal::Transport::BaseClient::request_input request, redirect_count: Integer, retry_count: Integer, send_retry_header: bool @@ -120,8 +120,8 @@ module Imagekit | (^(top arg0) -> top))?, ?page: Class?, ?stream: Class?, - ?model: Imagekit::Internal::Type::Converter::input?, - ?options: Imagekit::request_opts? + ?model: Imagekitio::Internal::Type::Converter::input?, + ?options: Imagekitio::request_opts? ) -> top def inspect: -> String diff --git a/sig/imagekit/internal/transport/pooled_net_requester.rbs b/sig/imagekitio/internal/transport/pooled_net_requester.rbs similarity index 78% rename from sig/imagekit/internal/transport/pooled_net_requester.rbs rename to sig/imagekitio/internal/transport/pooled_net_requester.rbs index 281ecf51..6ef7c006 100644 --- a/sig/imagekit/internal/transport/pooled_net_requester.rbs +++ b/sig/imagekitio/internal/transport/pooled_net_requester.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Internal module Transport class PooledNetRequester - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport type request = { @@ -22,7 +22,7 @@ module Imagekit def self.calibrate_socket_timeout: (top conn, Float deadline) -> void def self.build_request: ( - Imagekit::Internal::Transport::PooledNetRequester::request request + Imagekitio::Internal::Transport::PooledNetRequester::request request ) { (String arg0) -> void } -> [top, (^-> void)] @@ -35,7 +35,7 @@ module Imagekit } -> void def execute: ( - Imagekit::Internal::Transport::PooledNetRequester::request request + Imagekitio::Internal::Transport::PooledNetRequester::request request ) -> [Integer, top, Enumerable[String]] def initialize: (?size: Integer) -> void diff --git a/sig/imagekit/internal/type/array_of.rbs b/sig/imagekitio/internal/type/array_of.rbs similarity index 58% rename from sig/imagekit/internal/type/array_of.rbs rename to sig/imagekitio/internal/type/array_of.rbs index 53ceaa09..8963ab2a 100644 --- a/sig/imagekit/internal/type/array_of.rbs +++ b/sig/imagekitio/internal/type/array_of.rbs @@ -1,14 +1,14 @@ -module Imagekit +module Imagekitio module Internal module Type class ArrayOf[Elem] - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport def self.[]: ( ::Hash[Symbol, top] - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input type_info, + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input type_info, ?::Hash[Symbol, top] spec ) -> instance @@ -20,12 +20,12 @@ module Imagekit def coerce: ( ::Array[top] | top value, - state: Imagekit::Internal::Type::Converter::coerce_state + state: Imagekitio::Internal::Type::Converter::coerce_state ) -> (::Array[top] | top) def dump: ( ::Array[top] | top value, - state: Imagekit::Internal::Type::Converter::dump_state + state: Imagekitio::Internal::Type::Converter::dump_state ) -> (::Array[top] | top) def to_sorbet_type: -> top @@ -36,8 +36,8 @@ module Imagekit def initialize: ( ::Hash[Symbol, top] - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input type_info, + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input type_info, ?::Hash[Symbol, top] spec ) -> void diff --git a/sig/imagekit/internal/type/base_model.rbs b/sig/imagekitio/internal/type/base_model.rbs similarity index 59% rename from sig/imagekit/internal/type/base_model.rbs rename to sig/imagekitio/internal/type/base_model.rbs index 81e90505..f56ac365 100644 --- a/sig/imagekit/internal/type/base_model.rbs +++ b/sig/imagekitio/internal/type/base_model.rbs @@ -1,48 +1,48 @@ -module Imagekit +module Imagekitio module Internal module Type class BaseModel - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport type known_field = { mode: (:coerce | :dump)?, required: bool, nilable: bool } def self.inherited: (self child) -> void - def self.known_fields: -> ::Hash[Symbol, (Imagekit::Internal::Type::BaseModel::known_field - & { type_fn: (^-> Imagekit::Internal::Type::Converter::input) })] + def self.known_fields: -> ::Hash[Symbol, (Imagekitio::Internal::Type::BaseModel::known_field + & { type_fn: (^-> Imagekitio::Internal::Type::Converter::input) })] - def self.fields: -> ::Hash[Symbol, (Imagekit::Internal::Type::BaseModel::known_field - & { type: Imagekit::Internal::Type::Converter::input })] + def self.fields: -> ::Hash[Symbol, (Imagekitio::Internal::Type::BaseModel::known_field + & { type: Imagekitio::Internal::Type::Converter::input })] private def self.add_field: ( Symbol name_sym, required: bool, type_info: { const: (nil | bool | Integer | Float | Symbol)?, - enum: ^-> Imagekit::Internal::Type::Converter::input?, - union: ^-> Imagekit::Internal::Type::Converter::input?, + enum: ^-> Imagekitio::Internal::Type::Converter::input?, + union: ^-> Imagekitio::Internal::Type::Converter::input?, api_name: Symbol } - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input, + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input, spec: ::Hash[Symbol, top] ) -> void def self.required: ( Symbol name_sym, ::Hash[Symbol, top] - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input type_info, + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input type_info, ?::Hash[Symbol, top] spec ) -> void def self.optional: ( Symbol name_sym, ::Hash[Symbol, top] - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input type_info, + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input type_info, ?::Hash[Symbol, top] spec ) -> void @@ -59,19 +59,19 @@ module Imagekit def hash: -> Integer def self.coerce: ( - Imagekit::Internal::Type::BaseModel | ::Hash[top, top] | top value, - state: Imagekit::Internal::Type::Converter::coerce_state + Imagekitio::Internal::Type::BaseModel | ::Hash[top, top] | top value, + state: Imagekitio::Internal::Type::Converter::coerce_state ) -> (instance | top) def self.dump: ( instance | top value, - state: Imagekit::Internal::Type::Converter::dump_state + state: Imagekitio::Internal::Type::Converter::dump_state ) -> (::Hash[top, top] | top) def self.to_sorbet_type: -> top def self.recursively_to_h: ( - Imagekit::Internal::Type::BaseModel model, + Imagekitio::Internal::Type::BaseModel model, convert: bool ) -> ::Hash[Symbol, top] diff --git a/sig/imagekit/internal/type/base_page.rbs b/sig/imagekitio/internal/type/base_page.rbs similarity index 71% rename from sig/imagekit/internal/type/base_page.rbs rename to sig/imagekitio/internal/type/base_page.rbs index cec13b1b..5aca2ab6 100644 --- a/sig/imagekit/internal/type/base_page.rbs +++ b/sig/imagekitio/internal/type/base_page.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Internal module Type module BasePage[Elem] @@ -13,8 +13,8 @@ module Imagekit alias enum_for to_enum def initialize: ( - client: Imagekit::Internal::Transport::BaseClient, - req: Imagekit::Internal::Transport::BaseClient::request_components, + client: Imagekitio::Internal::Transport::BaseClient, + req: Imagekitio::Internal::Transport::BaseClient::request_components, headers: ::Hash[String, String], page_data: top ) -> void diff --git a/sig/imagekit/internal/type/boolean.rbs b/sig/imagekitio/internal/type/boolean.rbs similarity index 58% rename from sig/imagekit/internal/type/boolean.rbs rename to sig/imagekitio/internal/type/boolean.rbs index 8ff7e123..99544d00 100644 --- a/sig/imagekit/internal/type/boolean.rbs +++ b/sig/imagekitio/internal/type/boolean.rbs @@ -1,9 +1,9 @@ -module Imagekit +module Imagekitio module Internal module Type class Boolean - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport def self.===: (top other) -> bool @@ -11,12 +11,12 @@ module Imagekit def self.coerce: ( bool | top value, - state: Imagekit::Internal::Type::Converter::coerce_state + state: Imagekitio::Internal::Type::Converter::coerce_state ) -> (bool | top) def self.dump: ( bool | top value, - state: Imagekit::Internal::Type::Converter::dump_state + state: Imagekitio::Internal::Type::Converter::dump_state ) -> (bool | top) def self.to_sorbet_type: -> top diff --git a/sig/imagekitio/internal/type/converter.rbs b/sig/imagekitio/internal/type/converter.rbs new file mode 100644 index 00000000..16df1d71 --- /dev/null +++ b/sig/imagekitio/internal/type/converter.rbs @@ -0,0 +1,79 @@ +module Imagekitio + module Internal + module Type + module Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport + + type input = Imagekitio::Internal::Type::Converter | Class + + type coerce_state = + { + translate_names: bool, + strictness: bool, + exactness: { yes: Integer, no: Integer, maybe: Integer }, + error: Class, + branched: Integer + } + + type dump_state = { can_retry: bool } + + def coerce: ( + top value, + state: Imagekitio::Internal::Type::Converter::coerce_state + ) -> top + + def dump: ( + top value, + state: Imagekitio::Internal::Type::Converter::dump_state + ) -> top + + def inspect: (?depth: Integer) -> String + + def self.type_info: ( + { + const: (nil | bool | Integer | Float | Symbol)?, + enum: ^-> Imagekitio::Internal::Type::Converter::input?, + union: ^-> Imagekitio::Internal::Type::Converter::input? + } + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input spec + ) -> (^-> top) + + def self.meta_info: ( + { + const: (nil | bool | Integer | Float | Symbol)?, + enum: ^-> Imagekitio::Internal::Type::Converter::input?, + union: ^-> Imagekitio::Internal::Type::Converter::input? + } + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input type_info, + { + const: (nil | bool | Integer | Float | Symbol)?, + enum: ^-> Imagekitio::Internal::Type::Converter::input?, + union: ^-> Imagekitio::Internal::Type::Converter::input? + } + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input spec + ) -> ::Hash[Symbol, top] + + def self.new_coerce_state: ( + ?translate_names: bool + ) -> Imagekitio::Internal::Type::Converter::coerce_state + + def self.coerce: ( + Imagekitio::Internal::Type::Converter::input target, + top value, + ?state: Imagekitio::Internal::Type::Converter::coerce_state + ) -> top + + def self.dump: ( + Imagekitio::Internal::Type::Converter::input target, + top value, + ?state: Imagekitio::Internal::Type::Converter::dump_state + ) -> top + + def self.inspect: (top target, depth: Integer) -> String + end + end + end +end diff --git a/sig/imagekit/internal/type/enum.rbs b/sig/imagekitio/internal/type/enum.rbs similarity index 65% rename from sig/imagekit/internal/type/enum.rbs rename to sig/imagekitio/internal/type/enum.rbs index 19825e23..4588fd85 100644 --- a/sig/imagekit/internal/type/enum.rbs +++ b/sig/imagekitio/internal/type/enum.rbs @@ -1,9 +1,9 @@ -module Imagekit +module Imagekitio module Internal module Type module Enum - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)] @@ -15,12 +15,12 @@ module Imagekit def coerce: ( String | Symbol | top value, - state: Imagekit::Internal::Type::Converter::coerce_state + state: Imagekitio::Internal::Type::Converter::coerce_state ) -> (Symbol | top) def dump: ( Symbol | top value, - state: Imagekit::Internal::Type::Converter::dump_state + state: Imagekitio::Internal::Type::Converter::dump_state ) -> (Symbol | top) def to_sorbet_type: -> top diff --git a/sig/imagekit/internal/type/file_input.rbs b/sig/imagekitio/internal/type/file_input.rbs similarity index 68% rename from sig/imagekit/internal/type/file_input.rbs rename to sig/imagekitio/internal/type/file_input.rbs index 2047a19e..b40b77da 100644 --- a/sig/imagekit/internal/type/file_input.rbs +++ b/sig/imagekitio/internal/type/file_input.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Internal module Type class FileInput - extend Imagekit::Internal::Type::Converter + extend Imagekitio::Internal::Type::Converter def self.===: (top other) -> bool @@ -10,12 +10,12 @@ module Imagekit def self.coerce: ( StringIO | String | top value, - state: Imagekit::Internal::Type::Converter::coerce_state + state: Imagekitio::Internal::Type::Converter::coerce_state ) -> (StringIO | top) def self.dump: ( Pathname | StringIO | IO | String | top value, - state: Imagekit::Internal::Type::Converter::dump_state + state: Imagekitio::Internal::Type::Converter::dump_state ) -> (Pathname | StringIO | IO | String | top) def self.to_sorbet_type: -> top diff --git a/sig/imagekit/internal/type/hash_of.rbs b/sig/imagekitio/internal/type/hash_of.rbs similarity index 59% rename from sig/imagekit/internal/type/hash_of.rbs rename to sig/imagekitio/internal/type/hash_of.rbs index 898a3566..df2f1326 100644 --- a/sig/imagekit/internal/type/hash_of.rbs +++ b/sig/imagekitio/internal/type/hash_of.rbs @@ -1,14 +1,14 @@ -module Imagekit +module Imagekitio module Internal module Type class HashOf[Elem] - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport def self.[]: ( ::Hash[Symbol, top] - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input type_info, + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input type_info, ?::Hash[Symbol, top] spec ) -> instance @@ -20,12 +20,12 @@ module Imagekit def coerce: ( ::Hash[top, top] | top value, - state: Imagekit::Internal::Type::Converter::coerce_state + state: Imagekitio::Internal::Type::Converter::coerce_state ) -> (::Hash[Symbol, top] | top) def dump: ( ::Hash[top, top] | top value, - state: Imagekit::Internal::Type::Converter::dump_state + state: Imagekitio::Internal::Type::Converter::dump_state ) -> (::Hash[Symbol, top] | top) def to_sorbet_type: -> top @@ -36,8 +36,8 @@ module Imagekit def initialize: ( ::Hash[Symbol, top] - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input type_info, + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input type_info, ?::Hash[Symbol, top] spec ) -> void diff --git a/sig/imagekitio/internal/type/request_parameters.rbs b/sig/imagekitio/internal/type/request_parameters.rbs new file mode 100644 index 00000000..c16a59fd --- /dev/null +++ b/sig/imagekitio/internal/type/request_parameters.rbs @@ -0,0 +1,19 @@ +module Imagekitio + module Internal + module Type + type request_parameters = { request_options: Imagekitio::request_opts } + + module RequestParameters + attr_reader request_options: Imagekitio::request_opts + + def request_options=: ( + Imagekitio::request_opts + ) -> Imagekitio::request_opts + + module Converter + def dump_request: (top params) -> [top, ::Hash[Symbol, top]] + end + end + end + end +end diff --git a/sig/imagekit/internal/type/union.rbs b/sig/imagekitio/internal/type/union.rbs similarity index 56% rename from sig/imagekit/internal/type/union.rbs rename to sig/imagekitio/internal/type/union.rbs index 1dcd9350..6bb475bd 100644 --- a/sig/imagekit/internal/type/union.rbs +++ b/sig/imagekitio/internal/type/union.rbs @@ -1,11 +1,11 @@ -module Imagekit +module Imagekitio module Internal module Type module Union - include Imagekit::Internal::Type::Converter - include Imagekit::Internal::Util::SorbetRuntimeSupport + include Imagekitio::Internal::Type::Converter + include Imagekitio::Internal::Util::SorbetRuntimeSupport - private def self.known_variants: -> ::Array[[Symbol?, (^-> Imagekit::Internal::Type::Converter::input), ::Hash[Symbol, top]]] + private def self.known_variants: -> ::Array[[Symbol?, (^-> Imagekitio::Internal::Type::Converter::input), ::Hash[Symbol, top]]] def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]] @@ -16,16 +16,16 @@ module Imagekit private def self.variant: ( Symbol | ::Hash[Symbol, top] - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input key, + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input key, ?::Hash[Symbol, top] - | ^-> Imagekit::Internal::Type::Converter::input - | Imagekit::Internal::Type::Converter::input spec + | ^-> Imagekitio::Internal::Type::Converter::input + | Imagekitio::Internal::Type::Converter::input spec ) -> void private def self.resolve_variant: ( top value - ) -> Imagekit::Internal::Type::Converter::input? + ) -> Imagekitio::Internal::Type::Converter::input? def ===: (top other) -> bool @@ -35,12 +35,12 @@ module Imagekit def coerce: ( top value, - state: Imagekit::Internal::Type::Converter::coerce_state + state: Imagekitio::Internal::Type::Converter::coerce_state ) -> top def dump: ( top value, - state: Imagekit::Internal::Type::Converter::dump_state + state: Imagekitio::Internal::Type::Converter::dump_state ) -> top def to_sorbet_type: -> top diff --git a/sig/imagekit/internal/type/unknown.rbs b/sig/imagekitio/internal/type/unknown.rbs similarity index 55% rename from sig/imagekit/internal/type/unknown.rbs rename to sig/imagekitio/internal/type/unknown.rbs index 79647fe7..ddab4e3e 100644 --- a/sig/imagekit/internal/type/unknown.rbs +++ b/sig/imagekitio/internal/type/unknown.rbs @@ -1,9 +1,9 @@ -module Imagekit +module Imagekitio module Internal module Type class Unknown - extend Imagekit::Internal::Type::Converter - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Type::Converter + extend Imagekitio::Internal::Util::SorbetRuntimeSupport def self.===: (top other) -> bool @@ -11,12 +11,12 @@ module Imagekit def self.coerce: ( top value, - state: Imagekit::Internal::Type::Converter::coerce_state + state: Imagekitio::Internal::Type::Converter::coerce_state ) -> top def self.dump: ( top value, - state: Imagekit::Internal::Type::Converter::dump_state + state: Imagekitio::Internal::Type::Converter::dump_state ) -> top def self.to_sorbet_type: -> top diff --git a/sig/imagekit/internal/util.rbs b/sig/imagekitio/internal/util.rbs similarity index 91% rename from sig/imagekit/internal/util.rbs rename to sig/imagekitio/internal/util.rbs index 4440cd2b..73bf10f9 100644 --- a/sig/imagekit/internal/util.rbs +++ b/sig/imagekitio/internal/util.rbs @@ -1,7 +1,7 @@ -module Imagekit +module Imagekitio module Internal module Util - extend Imagekit::Internal::Util::SorbetRuntimeSupport + extend Imagekitio::Internal::Util::SorbetRuntimeSupport def self?.monotonic_secs: -> Float @@ -66,15 +66,15 @@ module Imagekit def self?.parse_uri: ( URI::Generic | String url - ) -> Imagekit::Internal::Util::parsed_uri + ) -> Imagekitio::Internal::Util::parsed_uri def self?.unparse_uri: ( - Imagekit::Internal::Util::parsed_uri parsed + Imagekitio::Internal::Util::parsed_uri parsed ) -> URI::Generic def self?.join_parsed_uri: ( - Imagekit::Internal::Util::parsed_uri lhs, - Imagekit::Internal::Util::parsed_uri rhs + Imagekitio::Internal::Util::parsed_uri lhs, + Imagekitio::Internal::Util::parsed_uri rhs ) -> URI::Generic def self?.normalized_headers: ( @@ -160,7 +160,7 @@ module Imagekit def self?.decode_sse: ( Enumerable[String] lines - ) -> Enumerable[Imagekit::Internal::Util::server_sent_event] + ) -> Enumerable[Imagekitio::Internal::Util::server_sent_event] module SorbetRuntimeSupport class MissingSorbetRuntimeError < ::RuntimeError @@ -177,7 +177,7 @@ module Imagekit def to_sorbet_type: -> top def self.to_sorbet_type: ( - Imagekit::Internal::Util::SorbetRuntimeSupport | top `type` + Imagekitio::Internal::Util::SorbetRuntimeSupport | top `type` ) -> top end end diff --git a/sig/imagekitio/models.rbs b/sig/imagekitio/models.rbs new file mode 100644 index 00000000..2bb9e2d2 --- /dev/null +++ b/sig/imagekitio/models.rbs @@ -0,0 +1,119 @@ +module Imagekitio + module Accounts = Imagekitio::Models::Accounts + + class AssetListParams = Imagekitio::Models::AssetListParams + + class BaseOverlay = Imagekitio::Models::BaseOverlay + + class BaseWebhookEvent = Imagekitio::Models::BaseWebhookEvent + + module Beta = Imagekitio::Models::Beta + + module Cache = Imagekitio::Models::Cache + + class CustomMetadataField = Imagekitio::Models::CustomMetadataField + + class CustomMetadataFieldCreateParams = Imagekitio::Models::CustomMetadataFieldCreateParams + + class CustomMetadataFieldDeleteParams = Imagekitio::Models::CustomMetadataFieldDeleteParams + + class CustomMetadataFieldListParams = Imagekitio::Models::CustomMetadataFieldListParams + + class CustomMetadataFieldUpdateParams = Imagekitio::Models::CustomMetadataFieldUpdateParams + + type extension_item = Imagekitio::Models::extension_item + + Extensions: Imagekitio::Internal::Type::Converter + + class File = Imagekitio::Models::File + + class FileCopyParams = Imagekitio::Models::FileCopyParams + + class FileDeleteParams = Imagekitio::Models::FileDeleteParams + + class FileGetParams = Imagekitio::Models::FileGetParams + + class FileMoveParams = Imagekitio::Models::FileMoveParams + + class FileRenameParams = Imagekitio::Models::FileRenameParams + + module Files = Imagekitio::Models::Files + + class FileUpdateParams = Imagekitio::Models::FileUpdateParams + + class FileUploadParams = Imagekitio::Models::FileUploadParams + + class Folder = Imagekitio::Models::Folder + + class FolderCopyParams = Imagekitio::Models::FolderCopyParams + + class FolderCreateParams = Imagekitio::Models::FolderCreateParams + + class FolderDeleteParams = Imagekitio::Models::FolderDeleteParams + + class FolderMoveParams = Imagekitio::Models::FolderMoveParams + + class FolderRenameParams = Imagekitio::Models::FolderRenameParams + + module Folders = Imagekitio::Models::Folders + + class GetImageAttributesOptions = Imagekitio::Models::GetImageAttributesOptions + + class ImageOverlay = Imagekitio::Models::ImageOverlay + + class Metadata = Imagekitio::Models::Metadata + + module Overlay = Imagekitio::Models::Overlay + + class OverlayPosition = Imagekitio::Models::OverlayPosition + + class OverlayTiming = Imagekitio::Models::OverlayTiming + + class ResponsiveImageAttributes = Imagekitio::Models::ResponsiveImageAttributes + + class SolidColorOverlay = Imagekitio::Models::SolidColorOverlay + + class SolidColorOverlayTransformation = Imagekitio::Models::SolidColorOverlayTransformation + + class SrcOptions = Imagekitio::Models::SrcOptions + + module StreamingResolution = Imagekitio::Models::StreamingResolution + + class SubtitleOverlay = Imagekitio::Models::SubtitleOverlay + + class SubtitleOverlayTransformation = Imagekitio::Models::SubtitleOverlayTransformation + + class TextOverlay = Imagekitio::Models::TextOverlay + + class TextOverlayTransformation = Imagekitio::Models::TextOverlayTransformation + + class Transformation = Imagekitio::Models::Transformation + + module TransformationPosition = Imagekitio::Models::TransformationPosition + + module UnsafeUnwrapWebhookEvent = Imagekitio::Models::UnsafeUnwrapWebhookEvent + + module UnwrapWebhookEvent = Imagekitio::Models::UnwrapWebhookEvent + + module UpdateFileRequest = Imagekitio::Models::UpdateFileRequest + + class UploadPostTransformErrorEvent = Imagekitio::Models::UploadPostTransformErrorEvent + + class UploadPostTransformSuccessEvent = Imagekitio::Models::UploadPostTransformSuccessEvent + + class UploadPreTransformErrorEvent = Imagekitio::Models::UploadPreTransformErrorEvent + + class UploadPreTransformSuccessEvent = Imagekitio::Models::UploadPreTransformSuccessEvent + + class VideoOverlay = Imagekitio::Models::VideoOverlay + + class VideoTransformationAcceptedEvent = Imagekitio::Models::VideoTransformationAcceptedEvent + + class VideoTransformationErrorEvent = Imagekitio::Models::VideoTransformationErrorEvent + + class VideoTransformationReadyEvent = Imagekitio::Models::VideoTransformationReadyEvent + + class WebhookUnsafeUnwrapParams = Imagekitio::Models::WebhookUnsafeUnwrapParams + + class WebhookUnwrapParams = Imagekitio::Models::WebhookUnwrapParams +end diff --git a/sig/imagekitio/models/accounts/origin_create_params.rbs b/sig/imagekitio/models/accounts/origin_create_params.rbs new file mode 100644 index 00000000..92d6c6ab --- /dev/null +++ b/sig/imagekitio/models/accounts/origin_create_params.rbs @@ -0,0 +1,30 @@ +module Imagekitio + module Models + module Accounts + type origin_create_params = + { origin_request: Imagekitio::Models::Accounts::origin_request } + & Imagekitio::Internal::Type::request_parameters + + class OriginCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def origin_request: -> Imagekitio::Models::Accounts::origin_request + + def origin_request=: ( + Imagekitio::Models::Accounts::origin_request _ + ) -> Imagekitio::Models::Accounts::origin_request + + def initialize: ( + origin_request: Imagekitio::Models::Accounts::origin_request, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + origin_request: Imagekitio::Models::Accounts::origin_request, + request_options: Imagekitio::RequestOptions + } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/origin_delete_params.rbs b/sig/imagekitio/models/accounts/origin_delete_params.rbs new file mode 100644 index 00000000..ed21916b --- /dev/null +++ b/sig/imagekitio/models/accounts/origin_delete_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Accounts + type origin_delete_params = + { } & Imagekitio::Internal::Type::request_parameters + + class OriginDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/origin_get_params.rbs b/sig/imagekitio/models/accounts/origin_get_params.rbs new file mode 100644 index 00000000..7bd58a8c --- /dev/null +++ b/sig/imagekitio/models/accounts/origin_get_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Accounts + type origin_get_params = + { } & Imagekitio::Internal::Type::request_parameters + + class OriginGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/origin_list_params.rbs b/sig/imagekitio/models/accounts/origin_list_params.rbs new file mode 100644 index 00000000..a275431c --- /dev/null +++ b/sig/imagekitio/models/accounts/origin_list_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Accounts + type origin_list_params = + { } & Imagekitio::Internal::Type::request_parameters + + class OriginListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/origin_list_response.rbs b/sig/imagekitio/models/accounts/origin_list_response.rbs new file mode 100644 index 00000000..26bbafa9 --- /dev/null +++ b/sig/imagekitio/models/accounts/origin_list_response.rbs @@ -0,0 +1,10 @@ +module Imagekitio + module Models + module Accounts + type origin_list_response = + ::Array[Imagekitio::Models::Accounts::origin_response] + + OriginListResponse: Imagekitio::Internal::Type::Converter + end + end +end diff --git a/sig/imagekit/models/accounts/origin_request.rbs b/sig/imagekitio/models/accounts/origin_request.rbs similarity index 91% rename from sig/imagekit/models/accounts/origin_request.rbs rename to sig/imagekitio/models/accounts/origin_request.rbs index 2e5e7916..2a315a07 100644 --- a/sig/imagekit/models/accounts/origin_request.rbs +++ b/sig/imagekitio/models/accounts/origin_request.rbs @@ -1,18 +1,18 @@ -module Imagekit +module Imagekitio module Models module Accounts type origin_request = - Imagekit::Accounts::OriginRequest::S3 - | Imagekit::Accounts::OriginRequest::S3Compatible - | Imagekit::Accounts::OriginRequest::CloudinaryBackup - | Imagekit::Accounts::OriginRequest::WebFolder - | Imagekit::Accounts::OriginRequest::WebProxy - | Imagekit::Accounts::OriginRequest::Gcs - | Imagekit::Accounts::OriginRequest::AzureBlob - | Imagekit::Accounts::OriginRequest::AkeneoPim + Imagekitio::Accounts::OriginRequest::S3 + | Imagekitio::Accounts::OriginRequest::S3Compatible + | Imagekitio::Accounts::OriginRequest::CloudinaryBackup + | Imagekitio::Accounts::OriginRequest::WebFolder + | Imagekitio::Accounts::OriginRequest::WebProxy + | Imagekitio::Accounts::OriginRequest::Gcs + | Imagekitio::Accounts::OriginRequest::AzureBlob + | Imagekitio::Accounts::OriginRequest::AkeneoPim module OriginRequest - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union type s3 = { @@ -26,7 +26,7 @@ module Imagekit prefix: String } - class S3 < Imagekit::Internal::Type::BaseModel + class S3 < Imagekitio::Internal::Type::BaseModel attr_accessor access_key: String attr_accessor bucket: String @@ -86,7 +86,7 @@ module Imagekit :s3_force_path_style => bool } - class S3Compatible < Imagekit::Internal::Type::BaseModel + class S3Compatible < Imagekitio::Internal::Type::BaseModel attr_accessor access_key: String attr_accessor bucket: String @@ -154,7 +154,7 @@ module Imagekit prefix: String } - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + class CloudinaryBackup < Imagekitio::Internal::Type::BaseModel attr_accessor access_key: String attr_accessor bucket: String @@ -210,7 +210,7 @@ module Imagekit include_canonical_header: bool } - class WebFolder < Imagekit::Internal::Type::BaseModel + class WebFolder < Imagekitio::Internal::Type::BaseModel attr_accessor base_url: String attr_accessor name: String @@ -256,7 +256,7 @@ module Imagekit include_canonical_header: bool } - class WebProxy < Imagekit::Internal::Type::BaseModel + class WebProxy < Imagekitio::Internal::Type::BaseModel attr_accessor name: String attr_accessor type: :WEB_PROXY @@ -296,7 +296,7 @@ module Imagekit prefix: String } - class Gcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekitio::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String @@ -354,7 +354,7 @@ module Imagekit prefix: String } - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekitio::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String @@ -413,7 +413,7 @@ module Imagekit include_canonical_header: bool } - class AkeneoPim < Imagekit::Internal::Type::BaseModel + class AkeneoPim < Imagekitio::Internal::Type::BaseModel attr_accessor base_url: String attr_accessor client_id: String @@ -461,7 +461,7 @@ module Imagekit } end - def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_request] + def self?.variants: -> ::Array[Imagekitio::Models::Accounts::origin_request] end end end diff --git a/sig/imagekit/models/accounts/origin_response.rbs b/sig/imagekitio/models/accounts/origin_response.rbs similarity index 90% rename from sig/imagekit/models/accounts/origin_response.rbs rename to sig/imagekitio/models/accounts/origin_response.rbs index bca52d65..b6dbf227 100644 --- a/sig/imagekit/models/accounts/origin_response.rbs +++ b/sig/imagekitio/models/accounts/origin_response.rbs @@ -1,18 +1,18 @@ -module Imagekit +module Imagekitio module Models module Accounts type origin_response = - Imagekit::Accounts::OriginResponse::S3 - | Imagekit::Accounts::OriginResponse::S3Compatible - | Imagekit::Accounts::OriginResponse::CloudinaryBackup - | Imagekit::Accounts::OriginResponse::WebFolder - | Imagekit::Accounts::OriginResponse::WebProxy - | Imagekit::Accounts::OriginResponse::Gcs - | Imagekit::Accounts::OriginResponse::AzureBlob - | Imagekit::Accounts::OriginResponse::AkeneoPim + Imagekitio::Accounts::OriginResponse::S3 + | Imagekitio::Accounts::OriginResponse::S3Compatible + | Imagekitio::Accounts::OriginResponse::CloudinaryBackup + | Imagekitio::Accounts::OriginResponse::WebFolder + | Imagekitio::Accounts::OriginResponse::WebProxy + | Imagekitio::Accounts::OriginResponse::Gcs + | Imagekitio::Accounts::OriginResponse::AzureBlob + | Imagekitio::Accounts::OriginResponse::AkeneoPim module OriginResponse - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union type s3 = { @@ -25,7 +25,7 @@ module Imagekit base_url_for_canonical_header: String } - class S3 < Imagekit::Internal::Type::BaseModel + class S3 < Imagekitio::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor include_canonical_header: bool @@ -76,7 +76,7 @@ module Imagekit base_url_for_canonical_header: String } - class S3Compatible < Imagekit::Internal::Type::BaseModel + class S3Compatible < Imagekitio::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor endpoint: String @@ -133,7 +133,7 @@ module Imagekit base_url_for_canonical_header: String } - class CloudinaryBackup < Imagekit::Internal::Type::BaseModel + class CloudinaryBackup < Imagekitio::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor include_canonical_header: bool @@ -182,7 +182,7 @@ module Imagekit base_url_for_canonical_header: String } - class WebFolder < Imagekit::Internal::Type::BaseModel + class WebFolder < Imagekitio::Internal::Type::BaseModel attr_accessor base_url: String attr_accessor forward_host_header_to_origin: bool @@ -229,7 +229,7 @@ module Imagekit base_url_for_canonical_header: String } - class WebProxy < Imagekit::Internal::Type::BaseModel + class WebProxy < Imagekitio::Internal::Type::BaseModel attr_accessor include_canonical_header: bool attr_accessor name: String @@ -271,7 +271,7 @@ module Imagekit base_url_for_canonical_header: String } - class Gcs < Imagekit::Internal::Type::BaseModel + class Gcs < Imagekitio::Internal::Type::BaseModel attr_accessor bucket: String attr_accessor client_email: String @@ -325,7 +325,7 @@ module Imagekit base_url_for_canonical_header: String } - class AzureBlob < Imagekit::Internal::Type::BaseModel + class AzureBlob < Imagekitio::Internal::Type::BaseModel attr_accessor account_name: String attr_accessor container: String @@ -377,7 +377,7 @@ module Imagekit base_url_for_canonical_header: String } - class AkeneoPim < Imagekit::Internal::Type::BaseModel + class AkeneoPim < Imagekitio::Internal::Type::BaseModel attr_accessor base_url: String attr_accessor include_canonical_header: bool @@ -411,7 +411,7 @@ module Imagekit } end - def self?.variants: -> ::Array[Imagekit::Models::Accounts::origin_response] + def self?.variants: -> ::Array[Imagekitio::Models::Accounts::origin_response] end end end diff --git a/sig/imagekitio/models/accounts/origin_update_params.rbs b/sig/imagekitio/models/accounts/origin_update_params.rbs new file mode 100644 index 00000000..ebbc257b --- /dev/null +++ b/sig/imagekitio/models/accounts/origin_update_params.rbs @@ -0,0 +1,30 @@ +module Imagekitio + module Models + module Accounts + type origin_update_params = + { origin_request: Imagekitio::Models::Accounts::origin_request } + & Imagekitio::Internal::Type::request_parameters + + class OriginUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def origin_request: -> Imagekitio::Models::Accounts::origin_request + + def origin_request=: ( + Imagekitio::Models::Accounts::origin_request _ + ) -> Imagekitio::Models::Accounts::origin_request + + def initialize: ( + origin_request: Imagekitio::Models::Accounts::origin_request, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + origin_request: Imagekitio::Models::Accounts::origin_request, + request_options: Imagekitio::RequestOptions + } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/url_endpoint_create_params.rbs b/sig/imagekitio/models/accounts/url_endpoint_create_params.rbs new file mode 100644 index 00000000..6ecd75d3 --- /dev/null +++ b/sig/imagekitio/models/accounts/url_endpoint_create_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Accounts + type url_endpoint_create_params = + { } & Imagekitio::Internal::Type::request_parameters + + class URLEndpointCreateParams < Imagekitio::Models::Accounts::URLEndpointRequest + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/url_endpoint_delete_params.rbs b/sig/imagekitio/models/accounts/url_endpoint_delete_params.rbs new file mode 100644 index 00000000..d4228eb4 --- /dev/null +++ b/sig/imagekitio/models/accounts/url_endpoint_delete_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Accounts + type url_endpoint_delete_params = + { } & Imagekitio::Internal::Type::request_parameters + + class URLEndpointDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/url_endpoint_get_params.rbs b/sig/imagekitio/models/accounts/url_endpoint_get_params.rbs new file mode 100644 index 00000000..91b94b41 --- /dev/null +++ b/sig/imagekitio/models/accounts/url_endpoint_get_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Accounts + type url_endpoint_get_params = + { } & Imagekitio::Internal::Type::request_parameters + + class URLEndpointGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/url_endpoint_list_params.rbs b/sig/imagekitio/models/accounts/url_endpoint_list_params.rbs new file mode 100644 index 00000000..2cc0e821 --- /dev/null +++ b/sig/imagekitio/models/accounts/url_endpoint_list_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Accounts + type url_endpoint_list_params = + { } & Imagekitio::Internal::Type::request_parameters + + class URLEndpointListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/accounts/url_endpoint_list_response.rbs b/sig/imagekitio/models/accounts/url_endpoint_list_response.rbs new file mode 100644 index 00000000..865283db --- /dev/null +++ b/sig/imagekitio/models/accounts/url_endpoint_list_response.rbs @@ -0,0 +1,10 @@ +module Imagekitio + module Models + module Accounts + type url_endpoint_list_response = + ::Array[Imagekitio::Accounts::URLEndpointResponse] + + URLEndpointListResponse: Imagekitio::Internal::Type::Converter + end + end +end diff --git a/sig/imagekit/models/accounts/url_endpoint_request.rbs b/sig/imagekitio/models/accounts/url_endpoint_request.rbs similarity index 60% rename from sig/imagekit/models/accounts/url_endpoint_request.rbs rename to sig/imagekitio/models/accounts/url_endpoint_request.rbs index de0983f1..e47408a2 100644 --- a/sig/imagekit/models/accounts/url_endpoint_request.rbs +++ b/sig/imagekitio/models/accounts/url_endpoint_request.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models module Accounts type url_endpoint_request = @@ -6,10 +6,10 @@ module Imagekit description: String, origins: ::Array[String], url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter + url_rewriter: Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter } - class URLEndpointRequest < Imagekit::Internal::Type::BaseModel + class URLEndpointRequest < Imagekitio::Internal::Type::BaseModel attr_accessor description: String attr_reader origins: ::Array[String]? @@ -20,38 +20,38 @@ module Imagekit def url_prefix=: (String) -> String - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter? + attr_reader url_rewriter: Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter? def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter + Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter + ) -> Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter def initialize: ( description: String, ?origins: ::Array[String], ?url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter + ?url_rewriter: Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter ) -> void def to_hash: -> { description: String, origins: ::Array[String], url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter + url_rewriter: Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter } type url_rewriter = - Imagekit::Accounts::URLEndpointRequest::URLRewriter::Cloudinary - | Imagekit::Accounts::URLEndpointRequest::URLRewriter::Imgix - | Imagekit::Accounts::URLEndpointRequest::URLRewriter::Akamai + Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary + | Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix + | Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai module URLRewriter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union type cloudinary = { type: :CLOUDINARY, preserve_asset_delivery_types: bool } - class Cloudinary < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekitio::Internal::Type::BaseModel attr_accessor type: :CLOUDINARY attr_reader preserve_asset_delivery_types: bool? @@ -71,7 +71,7 @@ module Imagekit type imgix = { type: :IMGIX } - class Imgix < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekitio::Internal::Type::BaseModel attr_accessor type: :IMGIX def initialize: (?type: :IMGIX) -> void @@ -81,7 +81,7 @@ module Imagekit type akamai = { type: :AKAMAI } - class Akamai < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekitio::Internal::Type::BaseModel attr_accessor type: :AKAMAI def initialize: (?type: :AKAMAI) -> void @@ -89,7 +89,7 @@ module Imagekit def to_hash: -> { type: :AKAMAI } end - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointRequest::url_rewriter] + def self?.variants: -> ::Array[Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter] end end end diff --git a/sig/imagekit/models/accounts/url_endpoint_response.rbs b/sig/imagekitio/models/accounts/url_endpoint_response.rbs similarity index 59% rename from sig/imagekit/models/accounts/url_endpoint_response.rbs rename to sig/imagekitio/models/accounts/url_endpoint_response.rbs index 8c2da016..8187f432 100644 --- a/sig/imagekit/models/accounts/url_endpoint_response.rbs +++ b/sig/imagekitio/models/accounts/url_endpoint_response.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models module Accounts type url_endpoint_response = @@ -7,21 +7,21 @@ module Imagekit description: String, origins: ::Array[String], url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter + url_rewriter: Imagekitio::Models::Accounts::URLEndpointResponse::url_rewriter } - class URLEndpointResponse < Imagekit::Internal::Type::BaseModel + class URLEndpointResponse < Imagekitio::Internal::Type::BaseModel attr_accessor description: String attr_accessor origins: ::Array[String] attr_accessor url_prefix: String - attr_reader url_rewriter: Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter? + attr_reader url_rewriter: Imagekitio::Models::Accounts::URLEndpointResponse::url_rewriter? def url_rewriter=: ( - Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter - ) -> Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter + Imagekitio::Models::Accounts::URLEndpointResponse::url_rewriter + ) -> Imagekitio::Models::Accounts::URLEndpointResponse::url_rewriter attr_accessor id: String @@ -30,7 +30,7 @@ module Imagekit description: String, origins: ::Array[String], url_prefix: String, - ?url_rewriter: Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter + ?url_rewriter: Imagekitio::Models::Accounts::URLEndpointResponse::url_rewriter ) -> void def to_hash: -> { @@ -38,21 +38,21 @@ module Imagekit description: String, origins: ::Array[String], url_prefix: String, - url_rewriter: Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter + url_rewriter: Imagekitio::Models::Accounts::URLEndpointResponse::url_rewriter } type url_rewriter = - Imagekit::Accounts::URLEndpointResponse::URLRewriter::Cloudinary - | Imagekit::Accounts::URLEndpointResponse::URLRewriter::Imgix - | Imagekit::Accounts::URLEndpointResponse::URLRewriter::Akamai + Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary + | Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix + | Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai module URLRewriter - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union type cloudinary = { preserve_asset_delivery_types: bool, type: :CLOUDINARY } - class Cloudinary < Imagekit::Internal::Type::BaseModel + class Cloudinary < Imagekitio::Internal::Type::BaseModel attr_accessor preserve_asset_delivery_types: bool attr_accessor type: :CLOUDINARY @@ -70,7 +70,7 @@ module Imagekit type imgix = { type: :IMGIX } - class Imgix < Imagekit::Internal::Type::BaseModel + class Imgix < Imagekitio::Internal::Type::BaseModel attr_accessor type: :IMGIX def initialize: (?type: :IMGIX) -> void @@ -80,7 +80,7 @@ module Imagekit type akamai = { type: :AKAMAI } - class Akamai < Imagekit::Internal::Type::BaseModel + class Akamai < Imagekitio::Internal::Type::BaseModel attr_accessor type: :AKAMAI def initialize: (?type: :AKAMAI) -> void @@ -88,7 +88,7 @@ module Imagekit def to_hash: -> { type: :AKAMAI } end - def self?.variants: -> ::Array[Imagekit::Models::Accounts::URLEndpointResponse::url_rewriter] + def self?.variants: -> ::Array[Imagekitio::Models::Accounts::URLEndpointResponse::url_rewriter] end end end diff --git a/sig/imagekitio/models/accounts/url_endpoint_update_params.rbs b/sig/imagekitio/models/accounts/url_endpoint_update_params.rbs new file mode 100644 index 00000000..38b6c172 --- /dev/null +++ b/sig/imagekitio/models/accounts/url_endpoint_update_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Accounts + type url_endpoint_update_params = + { } & Imagekitio::Internal::Type::request_parameters + + class URLEndpointUpdateParams < Imagekitio::Models::Accounts::URLEndpointRequest + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekit/models/accounts/usage_get_params.rbs b/sig/imagekitio/models/accounts/usage_get_params.rbs similarity index 51% rename from sig/imagekit/models/accounts/usage_get_params.rbs rename to sig/imagekitio/models/accounts/usage_get_params.rbs index b5ea8183..35640101 100644 --- a/sig/imagekit/models/accounts/usage_get_params.rbs +++ b/sig/imagekitio/models/accounts/usage_get_params.rbs @@ -1,13 +1,13 @@ -module Imagekit +module Imagekitio module Models module Accounts type usage_get_params = { end_date: Date, start_date: Date } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class UsageGetParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class UsageGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor end_date: Date @@ -16,13 +16,13 @@ module Imagekit def initialize: ( end_date: Date, start_date: Date, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { end_date: Date, start_date: Date, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/accounts/usage_get_response.rbs b/sig/imagekitio/models/accounts/usage_get_response.rbs similarity index 94% rename from sig/imagekit/models/accounts/usage_get_response.rbs rename to sig/imagekitio/models/accounts/usage_get_response.rbs index 8b11aae0..9ff7b969 100644 --- a/sig/imagekit/models/accounts/usage_get_response.rbs +++ b/sig/imagekitio/models/accounts/usage_get_response.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models module Accounts type usage_get_response = @@ -10,7 +10,7 @@ module Imagekit video_processing_units_count: Integer } - class UsageGetResponse < Imagekit::Internal::Type::BaseModel + class UsageGetResponse < Imagekitio::Internal::Type::BaseModel attr_reader bandwidth_bytes: Integer? def bandwidth_bytes=: (Integer) -> Integer diff --git a/sig/imagekit/models/asset_list_params.rbs b/sig/imagekitio/models/asset_list_params.rbs similarity index 52% rename from sig/imagekit/models/asset_list_params.rbs rename to sig/imagekitio/models/asset_list_params.rbs index 21cd33ef..348abd0e 100644 --- a/sig/imagekit/models/asset_list_params.rbs +++ b/sig/imagekitio/models/asset_list_params.rbs @@ -1,26 +1,26 @@ -module Imagekit +module Imagekitio module Models type asset_list_params = { - file_type: Imagekit::Models::AssetListParams::file_type, + file_type: Imagekitio::Models::AssetListParams::file_type, limit: Integer, path: String, search_query: String, skip: Integer, - sort: Imagekit::Models::AssetListParams::sort, - type: Imagekit::Models::AssetListParams::type_ + sort: Imagekitio::Models::AssetListParams::sort, + type: Imagekitio::Models::AssetListParams::type_ } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class AssetListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class AssetListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters - attr_reader file_type: Imagekit::Models::AssetListParams::file_type? + attr_reader file_type: Imagekitio::Models::AssetListParams::file_type? def file_type=: ( - Imagekit::Models::AssetListParams::file_type - ) -> Imagekit::Models::AssetListParams::file_type + Imagekitio::Models::AssetListParams::file_type + ) -> Imagekitio::Models::AssetListParams::file_type attr_reader limit: Integer? @@ -38,50 +38,50 @@ module Imagekit def skip=: (Integer) -> Integer - attr_reader sort: Imagekit::Models::AssetListParams::sort? + attr_reader sort: Imagekitio::Models::AssetListParams::sort? def sort=: ( - Imagekit::Models::AssetListParams::sort - ) -> Imagekit::Models::AssetListParams::sort + Imagekitio::Models::AssetListParams::sort + ) -> Imagekitio::Models::AssetListParams::sort - attr_reader type: Imagekit::Models::AssetListParams::type_? + attr_reader type: Imagekitio::Models::AssetListParams::type_? def type=: ( - Imagekit::Models::AssetListParams::type_ - ) -> Imagekit::Models::AssetListParams::type_ + Imagekitio::Models::AssetListParams::type_ + ) -> Imagekitio::Models::AssetListParams::type_ def initialize: ( - ?file_type: Imagekit::Models::AssetListParams::file_type, + ?file_type: Imagekitio::Models::AssetListParams::file_type, ?limit: Integer, ?path: String, ?search_query: String, ?skip: Integer, - ?sort: Imagekit::Models::AssetListParams::sort, - ?type: Imagekit::Models::AssetListParams::type_, - ?request_options: Imagekit::request_opts + ?sort: Imagekitio::Models::AssetListParams::sort, + ?type: Imagekitio::Models::AssetListParams::type_, + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { - file_type: Imagekit::Models::AssetListParams::file_type, + file_type: Imagekitio::Models::AssetListParams::file_type, limit: Integer, path: String, search_query: String, skip: Integer, - sort: Imagekit::Models::AssetListParams::sort, - type: Imagekit::Models::AssetListParams::type_, - request_options: Imagekit::RequestOptions + sort: Imagekitio::Models::AssetListParams::sort, + type: Imagekitio::Models::AssetListParams::type_, + request_options: Imagekitio::RequestOptions } type file_type = :all | :image | :"non-image" module FileType - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum ALL: :all IMAGE: :image NON_IMAGE: :"non-image" - def self?.values: -> ::Array[Imagekit::Models::AssetListParams::file_type] + def self?.values: -> ::Array[Imagekitio::Models::AssetListParams::file_type] end type sort = @@ -101,7 +101,7 @@ module Imagekit | :DESC_RELEVANCE module Sort - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum ASC_NAME: :ASC_NAME DESC_NAME: :DESC_NAME @@ -118,20 +118,20 @@ module Imagekit ASC_RELEVANCE: :ASC_RELEVANCE DESC_RELEVANCE: :DESC_RELEVANCE - def self?.values: -> ::Array[Imagekit::Models::AssetListParams::sort] + def self?.values: -> ::Array[Imagekitio::Models::AssetListParams::sort] end type type_ = :file | :"file-version" | :folder | :all module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum FILE: :file FILE_VERSION: :"file-version" FOLDER: :folder ALL: :all - def self?.values: -> ::Array[Imagekit::Models::AssetListParams::type_] + def self?.values: -> ::Array[Imagekitio::Models::AssetListParams::type_] end end end diff --git a/sig/imagekitio/models/asset_list_response.rbs b/sig/imagekitio/models/asset_list_response.rbs new file mode 100644 index 00000000..31964de8 --- /dev/null +++ b/sig/imagekitio/models/asset_list_response.rbs @@ -0,0 +1,16 @@ +module Imagekitio + module Models + type asset_list_response_item = Imagekitio::Folder | Imagekitio::File + + module AssetListResponseItem + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::asset_list_response_item] + end + + type asset_list_response = + ::Array[Imagekitio::Models::asset_list_response_item] + + AssetListResponse: Imagekitio::Internal::Type::Converter + end +end diff --git a/sig/imagekitio/models/base_overlay.rbs b/sig/imagekitio/models/base_overlay.rbs new file mode 100644 index 00000000..04461b00 --- /dev/null +++ b/sig/imagekitio/models/base_overlay.rbs @@ -0,0 +1,31 @@ +module Imagekitio + module Models + type base_overlay = + { + position: Imagekitio::OverlayPosition, + timing: Imagekitio::OverlayTiming + } + + class BaseOverlay < Imagekitio::Internal::Type::BaseModel + attr_reader position: Imagekitio::OverlayPosition? + + def position=: ( + Imagekitio::OverlayPosition + ) -> Imagekitio::OverlayPosition + + attr_reader timing: Imagekitio::OverlayTiming? + + def timing=: (Imagekitio::OverlayTiming) -> Imagekitio::OverlayTiming + + def initialize: ( + ?position: Imagekitio::OverlayPosition, + ?timing: Imagekitio::OverlayTiming + ) -> void + + def to_hash: -> { + position: Imagekitio::OverlayPosition, + timing: Imagekitio::OverlayTiming + } + end + end +end diff --git a/sig/imagekit/models/base_webhook_event.rbs b/sig/imagekitio/models/base_webhook_event.rbs similarity index 75% rename from sig/imagekit/models/base_webhook_event.rbs rename to sig/imagekitio/models/base_webhook_event.rbs index 287ff9cc..710a4e77 100644 --- a/sig/imagekit/models/base_webhook_event.rbs +++ b/sig/imagekitio/models/base_webhook_event.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type base_webhook_event = { id: String, type: String } - class BaseWebhookEvent < Imagekit::Internal::Type::BaseModel + class BaseWebhookEvent < Imagekitio::Internal::Type::BaseModel attr_accessor id: String attr_accessor type: String diff --git a/sig/imagekit/models/beta/v2/file_upload_params.rbs b/sig/imagekitio/models/beta/v2/file_upload_params.rbs similarity index 59% rename from sig/imagekit/models/beta/v2/file_upload_params.rbs rename to sig/imagekitio/models/beta/v2/file_upload_params.rbs index 9ae50878..a7f959ca 100644 --- a/sig/imagekit/models/beta/v2/file_upload_params.rbs +++ b/sig/imagekitio/models/beta/v2/file_upload_params.rbs @@ -1,17 +1,17 @@ -module Imagekit +module Imagekitio module Models module Beta module V2 type file_upload_params = { - file: Imagekit::Internal::file_input, + file: Imagekitio::Internal::file_input, file_name: String, token: String, checks: String, custom_coordinates: String, custom_metadata: ::Hash[Symbol, top], description: String, - extensions: Imagekit::Models::extensions, + extensions: Imagekitio::Models::extensions, folder: String, is_private_file: bool, is_published: bool, @@ -19,19 +19,19 @@ module Imagekit overwrite_custom_metadata: bool, overwrite_file: bool, overwrite_tags: bool, - response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + response_fields: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::response_field], tags: ::Array[String], - transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, + transformation: Imagekitio::Beta::V2::FileUploadParams::Transformation, use_unique_file_name: bool, webhook_url: String } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FileUploadParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileUploadParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters - attr_accessor file: Imagekit::Internal::file_input + attr_accessor file: Imagekitio::Internal::file_input attr_accessor file_name: String @@ -55,11 +55,11 @@ module Imagekit def description=: (String) -> String - attr_reader extensions: Imagekit::Models::extensions? + attr_reader extensions: Imagekitio::Models::extensions? def extensions=: ( - Imagekit::Models::extensions - ) -> Imagekit::Models::extensions + Imagekitio::Models::extensions + ) -> Imagekitio::Models::extensions attr_reader folder: String? @@ -89,21 +89,21 @@ module Imagekit def overwrite_tags=: (bool) -> bool - attr_reader response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field]? + attr_reader response_fields: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::response_field]? def response_fields=: ( - ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] - ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] + ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::response_field] + ) -> ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::response_field] attr_reader tags: ::Array[String]? def tags=: (::Array[String]) -> ::Array[String] - attr_reader transformation: Imagekit::Beta::V2::FileUploadParams::Transformation? + attr_reader transformation: Imagekitio::Beta::V2::FileUploadParams::Transformation? def transformation=: ( - Imagekit::Beta::V2::FileUploadParams::Transformation - ) -> Imagekit::Beta::V2::FileUploadParams::Transformation + Imagekitio::Beta::V2::FileUploadParams::Transformation + ) -> Imagekitio::Beta::V2::FileUploadParams::Transformation attr_reader use_unique_file_name: bool? @@ -114,14 +114,14 @@ module Imagekit def webhook_url=: (String) -> String def initialize: ( - file: Imagekit::Internal::file_input, + file: Imagekitio::Internal::file_input, file_name: String, ?token: String, ?checks: String, ?custom_coordinates: String, ?custom_metadata: ::Hash[Symbol, top], ?description: String, - ?extensions: Imagekit::Models::extensions, + ?extensions: Imagekitio::Models::extensions, ?folder: String, ?is_private_file: bool, ?is_published: bool, @@ -129,23 +129,23 @@ module Imagekit ?overwrite_custom_metadata: bool, ?overwrite_file: bool, ?overwrite_tags: bool, - ?response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + ?response_fields: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::response_field], ?tags: ::Array[String], - ?transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, + ?transformation: Imagekitio::Beta::V2::FileUploadParams::Transformation, ?use_unique_file_name: bool, ?webhook_url: String, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { - file: Imagekit::Internal::file_input, + file: Imagekitio::Internal::file_input, file_name: String, token: String, checks: String, custom_coordinates: String, custom_metadata: ::Hash[Symbol, top], description: String, - extensions: Imagekit::Models::extensions, + extensions: Imagekitio::Models::extensions, folder: String, is_private_file: bool, is_published: bool, @@ -153,12 +153,12 @@ module Imagekit overwrite_custom_metadata: bool, overwrite_file: bool, overwrite_tags: bool, - response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + response_fields: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::response_field], tags: ::Array[String], - transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, + transformation: Imagekitio::Beta::V2::FileUploadParams::Transformation, use_unique_file_name: bool, webhook_url: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } type response_field = @@ -172,7 +172,7 @@ module Imagekit | :selectedFieldsSchema module ResponseField - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TAGS: :tags CUSTOM_COORDINATES: :customCoordinates @@ -183,48 +183,48 @@ module Imagekit METADATA: :metadata SELECTED_FIELDS_SCHEMA: :selectedFieldsSchema - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field] + def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::response_field] end type transformation = { - post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post], + post: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::post], pre: String } - class Transformation < Imagekit::Internal::Type::BaseModel - attr_reader post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post]? + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_reader post: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::post]? def post=: ( - ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post] - ) -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post] + ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::post] + ) -> ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::post] attr_reader pre: String? def pre=: (String) -> String def initialize: ( - ?post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post], + ?post: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::post], ?pre: String ) -> void def to_hash: -> { - post: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post], + post: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::post], pre: String } type post = - Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Transformation - | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo - | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail - | Imagekit::Beta::V2::FileUploadParams::Transformation::Post::Abs + Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Transformation + | Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::GifToVideo + | Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Thumbnail + | Imagekitio::Beta::V2::FileUploadParams::Transformation::Post::Abs module Post - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union type transformation = { type: :transformation, value: String } - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel attr_accessor type: :transformation attr_accessor value: String @@ -236,7 +236,7 @@ module Imagekit type gif_to_video = { type: :"gif-to-video", value: String } - class GifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekitio::Internal::Type::BaseModel attr_accessor type: :"gif-to-video" attr_reader value: String? @@ -250,7 +250,7 @@ module Imagekit type thumbnail = { type: :thumbnail, value: String } - class Thumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekitio::Internal::Type::BaseModel attr_accessor type: :thumbnail attr_reader value: String? @@ -264,26 +264,26 @@ module Imagekit type abs = { - protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, + protocol: Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, type: :abs, value: String } - class Abs < Imagekit::Internal::Type::BaseModel - attr_accessor protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol + class Abs < Imagekitio::Internal::Type::BaseModel + attr_accessor protocol: Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol attr_accessor type: :abs attr_accessor value: String def initialize: ( - protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, + protocol: Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, value: String, ?type: :abs ) -> void def to_hash: -> { - protocol: Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, + protocol: Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol, type: :abs, value: String } @@ -291,16 +291,16 @@ module Imagekit type protocol = :hls | :dash module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS: :hls DASH: :dash - def self?.values: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol] + def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::Post::Abs::protocol] end end - def self?.variants: -> ::Array[Imagekit::Models::Beta::V2::FileUploadParams::Transformation::post] + def self?.variants: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::Transformation::post] end end end diff --git a/sig/imagekitio/models/beta/v2/file_upload_response.rbs b/sig/imagekitio/models/beta/v2/file_upload_response.rbs new file mode 100644 index 00000000..3a4f392d --- /dev/null +++ b/sig/imagekitio/models/beta/v2/file_upload_response.rbs @@ -0,0 +1,487 @@ +module Imagekitio + module Models + module Beta + module V2 + type file_upload_response = + { + ai_tags: ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekitio::Metadata, + name: String, + selected_fields_schema: ::Hash[Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + + class FileUploadResponse < Imagekitio::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::AITag]? + + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: ::Hash[Symbol, top]? + + def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader extension_status: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus? + + def extension_status=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader metadata: Imagekitio::Metadata? + + def metadata=: (Imagekitio::Metadata) -> Imagekitio::Metadata + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail_url: String? + + def thumbnail_url=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo? + + def version_info=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?duration: Integer, + ?embedded_metadata: ::Hash[Symbol, top], + ?extension_status: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?metadata: Imagekitio::Metadata, + ?name: String, + ?selected_fields_schema: ::Hash[Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail_url: String, + ?url: String, + ?version_info: Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo, + ?video_codec: String, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekitio::Metadata, + name: String, + selected_fields_schema: ::Hash[Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema], + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekitio::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type extension_status = + { + ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel + attr_reader ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description? + + def ai_auto_description=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description + + attr_reader aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + + def initialize: ( + ?ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, + ?aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg + } + + type ai_auto_description = :success | :pending | :failed + + module AIAutoDescription + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description] + end + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg] + end + end + + type selected_fields_schema = + { + type: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, + default_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, + ?default_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_, + default_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekitio::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::default_value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::select_option] + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekitio::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end + end + end +end diff --git a/sig/imagekitio/models/cache/invalidation_create_params.rbs b/sig/imagekitio/models/cache/invalidation_create_params.rbs new file mode 100644 index 00000000..32f5df91 --- /dev/null +++ b/sig/imagekitio/models/cache/invalidation_create_params.rbs @@ -0,0 +1,25 @@ +module Imagekitio + module Models + module Cache + type invalidation_create_params = + { url: String } & Imagekitio::Internal::Type::request_parameters + + class InvalidationCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor url: String + + def initialize: ( + url: String, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + url: String, + request_options: Imagekitio::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/cache/invalidation_create_response.rbs b/sig/imagekitio/models/cache/invalidation_create_response.rbs similarity index 76% rename from sig/imagekit/models/cache/invalidation_create_response.rbs rename to sig/imagekitio/models/cache/invalidation_create_response.rbs index 9e40cc12..c0925e61 100644 --- a/sig/imagekit/models/cache/invalidation_create_response.rbs +++ b/sig/imagekitio/models/cache/invalidation_create_response.rbs @@ -1,9 +1,9 @@ -module Imagekit +module Imagekitio module Models module Cache type invalidation_create_response = { request_id: String } - class InvalidationCreateResponse < Imagekit::Internal::Type::BaseModel + class InvalidationCreateResponse < Imagekitio::Internal::Type::BaseModel attr_reader request_id: String? def request_id=: (String) -> String diff --git a/sig/imagekitio/models/cache/invalidation_get_params.rbs b/sig/imagekitio/models/cache/invalidation_get_params.rbs new file mode 100644 index 00000000..663422da --- /dev/null +++ b/sig/imagekitio/models/cache/invalidation_get_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Cache + type invalidation_get_params = + { } & Imagekitio::Internal::Type::request_parameters + + class InvalidationGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/cache/invalidation_get_response.rbs b/sig/imagekitio/models/cache/invalidation_get_response.rbs new file mode 100644 index 00000000..9e74e972 --- /dev/null +++ b/sig/imagekitio/models/cache/invalidation_get_response.rbs @@ -0,0 +1,35 @@ +module Imagekitio + module Models + module Cache + type invalidation_get_response = + { status: Imagekitio::Models::Cache::InvalidationGetResponse::status } + + class InvalidationGetResponse < Imagekitio::Internal::Type::BaseModel + attr_reader status: Imagekitio::Models::Cache::InvalidationGetResponse::status? + + def status=: ( + Imagekitio::Models::Cache::InvalidationGetResponse::status + ) -> Imagekitio::Models::Cache::InvalidationGetResponse::status + + def initialize: ( + ?status: Imagekitio::Models::Cache::InvalidationGetResponse::status + ) -> void + + def to_hash: -> { + status: Imagekitio::Models::Cache::InvalidationGetResponse::status + } + + type status = :Pending | :Completed + + module Status + extend Imagekitio::Internal::Type::Enum + + PENDING: :Pending + COMPLETED: :Completed + + def self?.values: -> ::Array[Imagekitio::Models::Cache::InvalidationGetResponse::status] + end + end + end + end +end diff --git a/sig/imagekitio/models/custom_metadata_field.rbs b/sig/imagekitio/models/custom_metadata_field.rbs new file mode 100644 index 00000000..3c2071f5 --- /dev/null +++ b/sig/imagekitio/models/custom_metadata_field.rbs @@ -0,0 +1,178 @@ +module Imagekitio + module Models + type custom_metadata_field = + { + id: String, + label: String, + name: String, + schema: Imagekitio::CustomMetadataField::Schema + } + + class CustomMetadataField < Imagekitio::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor label: String + + attr_accessor name: String + + attr_accessor schema: Imagekitio::CustomMetadataField::Schema + + def initialize: ( + id: String, + label: String, + name: String, + schema: Imagekitio::CustomMetadataField::Schema + ) -> void + + def to_hash: -> { + id: String, + label: String, + name: String, + schema: Imagekitio::CustomMetadataField::Schema + } + + type schema = + { + type: Imagekitio::Models::CustomMetadataField::Schema::type_, + default_value: Imagekitio::Models::CustomMetadataField::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::CustomMetadataField::Schema::max_value, + min_length: Float, + min_value: Imagekitio::Models::CustomMetadataField::Schema::min_value, + select_options: ::Array[Imagekitio::Models::CustomMetadataField::Schema::select_option] + } + + class Schema < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::CustomMetadataField::Schema::type_ + + attr_reader default_value: Imagekitio::Models::CustomMetadataField::Schema::default_value? + + def default_value=: ( + Imagekitio::Models::CustomMetadataField::Schema::default_value + ) -> Imagekitio::Models::CustomMetadataField::Schema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekitio::Models::CustomMetadataField::Schema::max_value? + + def max_value=: ( + Imagekitio::Models::CustomMetadataField::Schema::max_value + ) -> Imagekitio::Models::CustomMetadataField::Schema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekitio::Models::CustomMetadataField::Schema::min_value? + + def min_value=: ( + Imagekitio::Models::CustomMetadataField::Schema::min_value + ) -> Imagekitio::Models::CustomMetadataField::Schema::min_value + + attr_reader select_options: ::Array[Imagekitio::Models::CustomMetadataField::Schema::select_option]? + + def select_options=: ( + ::Array[Imagekitio::Models::CustomMetadataField::Schema::select_option] + ) -> ::Array[Imagekitio::Models::CustomMetadataField::Schema::select_option] + + def initialize: ( + type: Imagekitio::Models::CustomMetadataField::Schema::type_, + ?default_value: Imagekitio::Models::CustomMetadataField::Schema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekitio::Models::CustomMetadataField::Schema::max_value, + ?min_length: Float, + ?min_value: Imagekitio::Models::CustomMetadataField::Schema::min_value, + ?select_options: ::Array[Imagekitio::Models::CustomMetadataField::Schema::select_option] + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::CustomMetadataField::Schema::type_, + default_value: Imagekitio::Models::CustomMetadataField::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::CustomMetadataField::Schema::max_value, + min_length: Float, + min_value: Imagekitio::Models::CustomMetadataField::Schema::min_value, + select_options: ::Array[Imagekitio::Models::CustomMetadataField::Schema::select_option] + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekitio::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekitio::Models::CustomMetadataField::Schema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekitio::Models::CustomMetadataField::Schema::DefaultValue::mixed] + + module DefaultValue + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataField::Schema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataField::Schema::default_value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataField::Schema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataField::Schema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataField::Schema::select_option] + end + end + end + end +end diff --git a/sig/imagekitio/models/custom_metadata_field_create_params.rbs b/sig/imagekitio/models/custom_metadata_field_create_params.rbs new file mode 100644 index 00000000..78f2ab99 --- /dev/null +++ b/sig/imagekitio/models/custom_metadata_field_create_params.rbs @@ -0,0 +1,179 @@ +module Imagekitio + module Models + type custom_metadata_field_create_params = + { + label: String, + name: String, + schema: Imagekitio::CustomMetadataFieldCreateParams::Schema + } + & Imagekitio::Internal::Type::request_parameters + + class CustomMetadataFieldCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor label: String + + attr_accessor name: String + + attr_accessor schema: Imagekitio::CustomMetadataFieldCreateParams::Schema + + def initialize: ( + label: String, + name: String, + schema: Imagekitio::CustomMetadataFieldCreateParams::Schema, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + label: String, + name: String, + schema: Imagekitio::CustomMetadataFieldCreateParams::Schema, + request_options: Imagekitio::RequestOptions + } + + type schema = + { + type: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::type_, + default_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::max_value, + min_length: Float, + min_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::min_value, + select_options: ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::select_option] + } + + class Schema < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::type_ + + attr_reader default_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::default_value? + + def default_value=: ( + Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::default_value + ) -> Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::max_value? + + def max_value=: ( + Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::max_value + ) -> Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::min_value? + + def min_value=: ( + Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::min_value + ) -> Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::min_value + + attr_reader select_options: ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::select_option]? + + def select_options=: ( + ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::select_option] + ) -> ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::select_option] + + def initialize: ( + type: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::type_, + ?default_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::max_value, + ?min_length: Float, + ?min_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::min_value, + ?select_options: ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::select_option] + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::type_, + default_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::max_value, + min_length: Float, + min_value: Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::min_value, + select_options: ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::select_option] + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekitio::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::mixed] + + module DefaultValue + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::default_value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::select_option] + end + end + end + end +end diff --git a/sig/imagekitio/models/custom_metadata_field_delete_params.rbs b/sig/imagekitio/models/custom_metadata_field_delete_params.rbs new file mode 100644 index 00000000..7b31c289 --- /dev/null +++ b/sig/imagekitio/models/custom_metadata_field_delete_params.rbs @@ -0,0 +1,15 @@ +module Imagekitio + module Models + type custom_metadata_field_delete_params = + { } & Imagekitio::Internal::Type::request_parameters + + class CustomMetadataFieldDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end +end diff --git a/sig/imagekit/models/custom_metadata_field_delete_response.rbs b/sig/imagekitio/models/custom_metadata_field_delete_response.rbs similarity index 59% rename from sig/imagekit/models/custom_metadata_field_delete_response.rbs rename to sig/imagekitio/models/custom_metadata_field_delete_response.rbs index 51fdebeb..16676be0 100644 --- a/sig/imagekit/models/custom_metadata_field_delete_response.rbs +++ b/sig/imagekitio/models/custom_metadata_field_delete_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type custom_metadata_field_delete_response = { } - class CustomMetadataFieldDeleteResponse < Imagekit::Internal::Type::BaseModel + class CustomMetadataFieldDeleteResponse < Imagekitio::Internal::Type::BaseModel def initialize: -> void def to_hash: -> { } diff --git a/sig/imagekit/models/custom_metadata_field_list_params.rbs b/sig/imagekitio/models/custom_metadata_field_list_params.rbs similarity index 56% rename from sig/imagekit/models/custom_metadata_field_list_params.rbs rename to sig/imagekitio/models/custom_metadata_field_list_params.rbs index c1359525..86e220d5 100644 --- a/sig/imagekit/models/custom_metadata_field_list_params.rbs +++ b/sig/imagekitio/models/custom_metadata_field_list_params.rbs @@ -1,12 +1,12 @@ -module Imagekit +module Imagekitio module Models type custom_metadata_field_list_params = { folder_path: String, include_deleted: bool } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class CustomMetadataFieldListParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class CustomMetadataFieldListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_reader folder_path: String? @@ -19,13 +19,13 @@ module Imagekit def initialize: ( ?folder_path: String, ?include_deleted: bool, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { folder_path: String, include_deleted: bool, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekitio/models/custom_metadata_field_list_response.rbs b/sig/imagekitio/models/custom_metadata_field_list_response.rbs new file mode 100644 index 00000000..08b6b60b --- /dev/null +++ b/sig/imagekitio/models/custom_metadata_field_list_response.rbs @@ -0,0 +1,8 @@ +module Imagekitio + module Models + type custom_metadata_field_list_response = + ::Array[Imagekitio::CustomMetadataField] + + CustomMetadataFieldListResponse: Imagekitio::Internal::Type::Converter + end +end diff --git a/sig/imagekitio/models/custom_metadata_field_update_params.rbs b/sig/imagekitio/models/custom_metadata_field_update_params.rbs new file mode 100644 index 00000000..0c6e9477 --- /dev/null +++ b/sig/imagekitio/models/custom_metadata_field_update_params.rbs @@ -0,0 +1,152 @@ +module Imagekitio + module Models + type custom_metadata_field_update_params = + { + label: String, + schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema + } + & Imagekitio::Internal::Type::request_parameters + + class CustomMetadataFieldUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_reader label: String? + + def label=: (String) -> String + + attr_reader schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema? + + def schema=: ( + Imagekitio::CustomMetadataFieldUpdateParams::Schema + ) -> Imagekitio::CustomMetadataFieldUpdateParams::Schema + + def initialize: ( + ?label: String, + ?schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + label: String, + schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema, + request_options: Imagekitio::RequestOptions + } + + type schema = + { + default_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::max_value, + min_length: Float, + min_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::min_value, + select_options: ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + } + + class Schema < Imagekitio::Internal::Type::BaseModel + attr_reader default_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::default_value? + + def default_value=: ( + Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::default_value + ) -> Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::max_value? + + def max_value=: ( + Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::max_value + ) -> Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::min_value? + + def min_value=: ( + Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::min_value + ) -> Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::min_value + + attr_reader select_options: ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::select_option]? + + def select_options=: ( + ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + ) -> ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + + def initialize: ( + ?default_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::max_value, + ?min_length: Float, + ?min_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::min_value, + ?select_options: ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + ) -> void + + def to_hash: -> { + default_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::max_value, + min_length: Float, + min_value: Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::min_value, + select_options: ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + } + + type default_value = + String + | Float + | bool + | ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::mixed] + + module DefaultValue + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::default_value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::select_option] + end + end + end + end +end diff --git a/sig/imagekit/models/extensions.rbs b/sig/imagekitio/models/extensions.rbs similarity index 58% rename from sig/imagekit/models/extensions.rbs rename to sig/imagekitio/models/extensions.rbs index 783d12ea..7e7e2612 100644 --- a/sig/imagekit/models/extensions.rbs +++ b/sig/imagekitio/models/extensions.rbs @@ -1,36 +1,36 @@ -module Imagekit +module Imagekitio module Models type extension_item = - Imagekit::ExtensionItem::RemoveBg - | Imagekit::ExtensionItem::AIAutoDescription - | Imagekit::ExtensionItem::AutoTaggingExtension + Imagekitio::ExtensionItem::RemoveBg + | Imagekitio::ExtensionItem::AIAutoDescription + | Imagekitio::ExtensionItem::AutoTaggingExtension module ExtensionItem - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union type remove_bg = { name: :"remove-bg", - options: Imagekit::ExtensionItem::RemoveBg::Options + options: Imagekitio::ExtensionItem::RemoveBg::Options } - class RemoveBg < Imagekit::Internal::Type::BaseModel + class RemoveBg < Imagekitio::Internal::Type::BaseModel attr_accessor name: :"remove-bg" - attr_reader options: Imagekit::ExtensionItem::RemoveBg::Options? + attr_reader options: Imagekitio::ExtensionItem::RemoveBg::Options? def options=: ( - Imagekit::ExtensionItem::RemoveBg::Options - ) -> Imagekit::ExtensionItem::RemoveBg::Options + Imagekitio::ExtensionItem::RemoveBg::Options + ) -> Imagekitio::ExtensionItem::RemoveBg::Options def initialize: ( - ?options: Imagekit::ExtensionItem::RemoveBg::Options, + ?options: Imagekitio::ExtensionItem::RemoveBg::Options, ?name: :"remove-bg" ) -> void def to_hash: -> { name: :"remove-bg", - options: Imagekit::ExtensionItem::RemoveBg::Options + options: Imagekitio::ExtensionItem::RemoveBg::Options } type options = @@ -41,7 +41,7 @@ module Imagekit semitransparency: bool } - class Options < Imagekit::Internal::Type::BaseModel + class Options < Imagekitio::Internal::Type::BaseModel attr_reader add_shadow: bool? def add_shadow=: (bool) -> bool @@ -78,43 +78,43 @@ module Imagekit { max_tags: Integer, min_confidence: Integer, - name: Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_ + name: Imagekitio::Models::ExtensionItem::AutoTaggingExtension::name_ } - class AutoTaggingExtension < Imagekit::Internal::Type::BaseModel + class AutoTaggingExtension < Imagekitio::Internal::Type::BaseModel attr_accessor max_tags: Integer attr_accessor min_confidence: Integer - attr_accessor name: Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_ + attr_accessor name: Imagekitio::Models::ExtensionItem::AutoTaggingExtension::name_ def initialize: ( max_tags: Integer, min_confidence: Integer, - name: Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_ + name: Imagekitio::Models::ExtensionItem::AutoTaggingExtension::name_ ) -> void def to_hash: -> { max_tags: Integer, min_confidence: Integer, - name: Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_ + name: Imagekitio::Models::ExtensionItem::AutoTaggingExtension::name_ } type name_ = :"google-auto-tagging" | :"aws-auto-tagging" module Name - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum GOOGLE_AUTO_TAGGING: :"google-auto-tagging" AWS_AUTO_TAGGING: :"aws-auto-tagging" - def self?.values: -> ::Array[Imagekit::Models::ExtensionItem::AutoTaggingExtension::name_] + def self?.values: -> ::Array[Imagekitio::Models::ExtensionItem::AutoTaggingExtension::name_] end end type ai_auto_description = { name: :"ai-auto-description" } - class AIAutoDescription < Imagekit::Internal::Type::BaseModel + class AIAutoDescription < Imagekitio::Internal::Type::BaseModel attr_accessor name: :"ai-auto-description" def initialize: (?name: :"ai-auto-description") -> void @@ -122,11 +122,11 @@ module Imagekit def to_hash: -> { name: :"ai-auto-description" } end - def self?.variants: -> ::Array[Imagekit::Models::extension_item] + def self?.variants: -> ::Array[Imagekitio::Models::extension_item] end - type extensions = ::Array[Imagekit::Models::extension_item] + type extensions = ::Array[Imagekitio::Models::extension_item] - Extensions: Imagekit::Internal::Type::Converter + Extensions: Imagekitio::Internal::Type::Converter end end diff --git a/sig/imagekit/models/file.rbs b/sig/imagekitio/models/file.rbs similarity index 55% rename from sig/imagekit/models/file.rbs rename to sig/imagekitio/models/file.rbs index 4758455c..c84cdb72 100644 --- a/sig/imagekit/models/file.rbs +++ b/sig/imagekitio/models/file.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type file = { - ai_tags: ::Array[Imagekit::File::AITag]?, + ai_tags: ::Array[Imagekitio::File::AITag]?, created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], @@ -16,19 +16,19 @@ module Imagekit is_published: bool, mime: String, name: String, - selected_fields_schema: ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema], + selected_fields_schema: ::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail: String, - type: Imagekit::Models::File::type_, + type: Imagekitio::Models::File::type_, updated_at: Time, url: String, - version_info: Imagekit::File::VersionInfo, + version_info: Imagekitio::File::VersionInfo, width: Float } - class File < Imagekit::Internal::Type::BaseModel - attr_accessor ai_tags: ::Array[Imagekit::File::AITag]? + class File < Imagekitio::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekitio::File::AITag]? attr_reader created_at: Time? @@ -80,11 +80,11 @@ module Imagekit def name=: (String) -> String - attr_reader selected_fields_schema: ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema]? + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema]? def selected_fields_schema=: ( - ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema] - ) -> ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema] + ::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema] attr_reader size: Float? @@ -96,11 +96,11 @@ module Imagekit def thumbnail=: (String) -> String - attr_reader type: Imagekit::Models::File::type_? + attr_reader type: Imagekitio::Models::File::type_? def type=: ( - Imagekit::Models::File::type_ - ) -> Imagekit::Models::File::type_ + Imagekitio::Models::File::type_ + ) -> Imagekitio::Models::File::type_ attr_reader updated_at: Time? @@ -110,18 +110,18 @@ module Imagekit def url=: (String) -> String - attr_reader version_info: Imagekit::File::VersionInfo? + attr_reader version_info: Imagekitio::File::VersionInfo? def version_info=: ( - Imagekit::File::VersionInfo - ) -> Imagekit::File::VersionInfo + Imagekitio::File::VersionInfo + ) -> Imagekitio::File::VersionInfo attr_reader width: Float? def width=: (Float) -> Float def initialize: ( - ?ai_tags: ::Array[Imagekit::File::AITag]?, + ?ai_tags: ::Array[Imagekitio::File::AITag]?, ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], @@ -135,19 +135,19 @@ module Imagekit ?is_published: bool, ?mime: String, ?name: String, - ?selected_fields_schema: ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema], + ?selected_fields_schema: ::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema], ?size: Float, ?tags: ::Array[String]?, ?thumbnail: String, - ?type: Imagekit::Models::File::type_, + ?type: Imagekitio::Models::File::type_, ?updated_at: Time, ?url: String, - ?version_info: Imagekit::File::VersionInfo, + ?version_info: Imagekitio::File::VersionInfo, ?width: Float ) -> void def to_hash: -> { - ai_tags: ::Array[Imagekit::File::AITag]?, + ai_tags: ::Array[Imagekitio::File::AITag]?, created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], @@ -161,20 +161,20 @@ module Imagekit is_published: bool, mime: String, name: String, - selected_fields_schema: ::Hash[Symbol, Imagekit::File::SelectedFieldsSchema], + selected_fields_schema: ::Hash[Symbol, Imagekitio::File::SelectedFieldsSchema], size: Float, tags: ::Array[String]?, thumbnail: String, - type: Imagekit::Models::File::type_, + type: Imagekitio::Models::File::type_, updated_at: Time, url: String, - version_info: Imagekit::File::VersionInfo, + version_info: Imagekitio::File::VersionInfo, width: Float } type ai_tag = { confidence: Float, name: String, source: String } - class AITag < Imagekit::Internal::Type::BaseModel + class AITag < Imagekitio::Internal::Type::BaseModel attr_reader confidence: Float? def confidence=: (Float) -> Float @@ -198,26 +198,26 @@ module Imagekit type selected_fields_schema = { - type: Imagekit::Models::File::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::File::SelectedFieldsSchema::default_value, + type: Imagekitio::Models::File::SelectedFieldsSchema::type_, + default_value: Imagekitio::Models::File::SelectedFieldsSchema::default_value, is_value_required: bool, max_length: Float, - max_value: Imagekit::Models::File::SelectedFieldsSchema::max_value, + max_value: Imagekitio::Models::File::SelectedFieldsSchema::max_value, min_length: Float, - min_value: Imagekit::Models::File::SelectedFieldsSchema::min_value, + min_value: Imagekitio::Models::File::SelectedFieldsSchema::min_value, read_only: bool, - select_options: ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option], + select_options: ::Array[Imagekitio::Models::File::SelectedFieldsSchema::select_option], select_options_truncated: bool } - class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel - attr_accessor type: Imagekit::Models::File::SelectedFieldsSchema::type_ + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::File::SelectedFieldsSchema::type_ - attr_reader default_value: Imagekit::Models::File::SelectedFieldsSchema::default_value? + attr_reader default_value: Imagekitio::Models::File::SelectedFieldsSchema::default_value? def default_value=: ( - Imagekit::Models::File::SelectedFieldsSchema::default_value - ) -> Imagekit::Models::File::SelectedFieldsSchema::default_value + Imagekitio::Models::File::SelectedFieldsSchema::default_value + ) -> Imagekitio::Models::File::SelectedFieldsSchema::default_value attr_reader is_value_required: bool? @@ -227,59 +227,59 @@ module Imagekit def max_length=: (Float) -> Float - attr_reader max_value: Imagekit::Models::File::SelectedFieldsSchema::max_value? + attr_reader max_value: Imagekitio::Models::File::SelectedFieldsSchema::max_value? def max_value=: ( - Imagekit::Models::File::SelectedFieldsSchema::max_value - ) -> Imagekit::Models::File::SelectedFieldsSchema::max_value + Imagekitio::Models::File::SelectedFieldsSchema::max_value + ) -> Imagekitio::Models::File::SelectedFieldsSchema::max_value attr_reader min_length: Float? def min_length=: (Float) -> Float - attr_reader min_value: Imagekit::Models::File::SelectedFieldsSchema::min_value? + attr_reader min_value: Imagekitio::Models::File::SelectedFieldsSchema::min_value? def min_value=: ( - Imagekit::Models::File::SelectedFieldsSchema::min_value - ) -> Imagekit::Models::File::SelectedFieldsSchema::min_value + Imagekitio::Models::File::SelectedFieldsSchema::min_value + ) -> Imagekitio::Models::File::SelectedFieldsSchema::min_value attr_reader read_only: bool? def read_only=: (bool) -> bool - attr_reader select_options: ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option]? + attr_reader select_options: ::Array[Imagekitio::Models::File::SelectedFieldsSchema::select_option]? def select_options=: ( - ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option] - ) -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option] + ::Array[Imagekitio::Models::File::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekitio::Models::File::SelectedFieldsSchema::select_option] attr_reader select_options_truncated: bool? def select_options_truncated=: (bool) -> bool def initialize: ( - type: Imagekit::Models::File::SelectedFieldsSchema::type_, - ?default_value: Imagekit::Models::File::SelectedFieldsSchema::default_value, + type: Imagekitio::Models::File::SelectedFieldsSchema::type_, + ?default_value: Imagekitio::Models::File::SelectedFieldsSchema::default_value, ?is_value_required: bool, ?max_length: Float, - ?max_value: Imagekit::Models::File::SelectedFieldsSchema::max_value, + ?max_value: Imagekitio::Models::File::SelectedFieldsSchema::max_value, ?min_length: Float, - ?min_value: Imagekit::Models::File::SelectedFieldsSchema::min_value, + ?min_value: Imagekitio::Models::File::SelectedFieldsSchema::min_value, ?read_only: bool, - ?select_options: ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option], + ?select_options: ::Array[Imagekitio::Models::File::SelectedFieldsSchema::select_option], ?select_options_truncated: bool ) -> void def to_hash: -> { - type: Imagekit::Models::File::SelectedFieldsSchema::type_, - default_value: Imagekit::Models::File::SelectedFieldsSchema::default_value, + type: Imagekitio::Models::File::SelectedFieldsSchema::type_, + default_value: Imagekitio::Models::File::SelectedFieldsSchema::default_value, is_value_required: bool, max_length: Float, - max_value: Imagekit::Models::File::SelectedFieldsSchema::max_value, + max_value: Imagekitio::Models::File::SelectedFieldsSchema::max_value, min_length: Float, - min_value: Imagekit::Models::File::SelectedFieldsSchema::min_value, + min_value: Imagekitio::Models::File::SelectedFieldsSchema::min_value, read_only: bool, - select_options: ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option], + select_options: ::Array[Imagekitio::Models::File::SelectedFieldsSchema::select_option], select_options_truncated: bool } @@ -293,7 +293,7 @@ module Imagekit | :MultiSelect module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TEXT: :Text TEXTAREA: :Textarea @@ -303,70 +303,70 @@ module Imagekit SINGLE_SELECT: :SingleSelect MULTI_SELECT: :MultiSelect - def self?.values: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::type_] + def self?.values: -> ::Array[Imagekitio::Models::File::SelectedFieldsSchema::type_] end type default_value = String | Float | bool - | ::Array[Imagekit::Models::File::SelectedFieldsSchema::DefaultValue::mixed] + | ::Array[Imagekitio::Models::File::SelectedFieldsSchema::DefaultValue::mixed] module DefaultValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union type mixed = String | Float | bool module Mixed - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::DefaultValue::mixed] + def self?.variants: -> ::Array[Imagekitio::Models::File::SelectedFieldsSchema::DefaultValue::mixed] end - def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::default_value] + def self?.variants: -> ::Array[Imagekitio::Models::File::SelectedFieldsSchema::default_value] - MixedArray: Imagekit::Internal::Type::Converter + MixedArray: Imagekitio::Internal::Type::Converter end type max_value = String | Float module MaxValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::max_value] + def self?.variants: -> ::Array[Imagekitio::Models::File::SelectedFieldsSchema::max_value] end type min_value = String | Float module MinValue - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::min_value] + def self?.variants: -> ::Array[Imagekitio::Models::File::SelectedFieldsSchema::min_value] end type select_option = String | Float | bool module SelectOption - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union - def self?.variants: -> ::Array[Imagekit::Models::File::SelectedFieldsSchema::select_option] + def self?.variants: -> ::Array[Imagekitio::Models::File::SelectedFieldsSchema::select_option] end end type type_ = :file | :"file-version" module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum FILE: :file FILE_VERSION: :"file-version" - def self?.values: -> ::Array[Imagekit::Models::File::type_] + def self?.values: -> ::Array[Imagekitio::Models::File::type_] end type version_info = { id: String, name: String } - class VersionInfo < Imagekit::Internal::Type::BaseModel + class VersionInfo < Imagekitio::Internal::Type::BaseModel attr_reader id: String? def id=: (String) -> String diff --git a/sig/imagekit/models/file_copy_params.rbs b/sig/imagekitio/models/file_copy_params.rbs similarity index 63% rename from sig/imagekit/models/file_copy_params.rbs rename to sig/imagekitio/models/file_copy_params.rbs index 46bc8a75..647d5ffb 100644 --- a/sig/imagekit/models/file_copy_params.rbs +++ b/sig/imagekitio/models/file_copy_params.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models type file_copy_params = { @@ -6,11 +6,11 @@ module Imagekit source_file_path: String, include_file_versions: bool } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FileCopyParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileCopyParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor destination_path: String @@ -24,14 +24,14 @@ module Imagekit destination_path: String, source_file_path: String, ?include_file_versions: bool, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { destination_path: String, source_file_path: String, include_file_versions: bool, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/file_copy_response.rbs b/sig/imagekitio/models/file_copy_response.rbs similarity index 60% rename from sig/imagekit/models/file_copy_response.rbs rename to sig/imagekitio/models/file_copy_response.rbs index 037e8a88..d29d11ab 100644 --- a/sig/imagekit/models/file_copy_response.rbs +++ b/sig/imagekitio/models/file_copy_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type file_copy_response = { } - class FileCopyResponse < Imagekit::Internal::Type::BaseModel + class FileCopyResponse < Imagekitio::Internal::Type::BaseModel def initialize: -> void def to_hash: -> { } diff --git a/sig/imagekitio/models/file_delete_params.rbs b/sig/imagekitio/models/file_delete_params.rbs new file mode 100644 index 00000000..1ad75710 --- /dev/null +++ b/sig/imagekitio/models/file_delete_params.rbs @@ -0,0 +1,15 @@ +module Imagekitio + module Models + type file_delete_params = + { } & Imagekitio::Internal::Type::request_parameters + + class FileDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end +end diff --git a/sig/imagekitio/models/file_get_params.rbs b/sig/imagekitio/models/file_get_params.rbs new file mode 100644 index 00000000..3ee95b01 --- /dev/null +++ b/sig/imagekitio/models/file_get_params.rbs @@ -0,0 +1,14 @@ +module Imagekitio + module Models + type file_get_params = { } & Imagekitio::Internal::Type::request_parameters + + class FileGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end +end diff --git a/sig/imagekit/models/file_move_params.rbs b/sig/imagekitio/models/file_move_params.rbs similarity index 53% rename from sig/imagekit/models/file_move_params.rbs rename to sig/imagekitio/models/file_move_params.rbs index c0d6f7f6..a53b9cce 100644 --- a/sig/imagekit/models/file_move_params.rbs +++ b/sig/imagekitio/models/file_move_params.rbs @@ -1,12 +1,12 @@ -module Imagekit +module Imagekitio module Models type file_move_params = { destination_path: String, source_file_path: String } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FileMoveParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileMoveParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor destination_path: String @@ -15,13 +15,13 @@ module Imagekit def initialize: ( destination_path: String, source_file_path: String, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { destination_path: String, source_file_path: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/file_move_response.rbs b/sig/imagekitio/models/file_move_response.rbs similarity index 60% rename from sig/imagekit/models/file_move_response.rbs rename to sig/imagekitio/models/file_move_response.rbs index 6e5e95ee..7a5c5518 100644 --- a/sig/imagekit/models/file_move_response.rbs +++ b/sig/imagekitio/models/file_move_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type file_move_response = { } - class FileMoveResponse < Imagekit::Internal::Type::BaseModel + class FileMoveResponse < Imagekitio::Internal::Type::BaseModel def initialize: -> void def to_hash: -> { } diff --git a/sig/imagekit/models/file_rename_params.rbs b/sig/imagekitio/models/file_rename_params.rbs similarity index 59% rename from sig/imagekit/models/file_rename_params.rbs rename to sig/imagekitio/models/file_rename_params.rbs index f09beefd..ab2c7a96 100644 --- a/sig/imagekit/models/file_rename_params.rbs +++ b/sig/imagekitio/models/file_rename_params.rbs @@ -1,12 +1,12 @@ -module Imagekit +module Imagekitio module Models type file_rename_params = { file_path: String, new_file_name: String, purge_cache: bool } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FileRenameParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileRenameParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor file_path: String @@ -20,14 +20,14 @@ module Imagekit file_path: String, new_file_name: String, ?purge_cache: bool, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { file_path: String, new_file_name: String, purge_cache: bool, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/file_rename_response.rbs b/sig/imagekitio/models/file_rename_response.rbs similarity index 77% rename from sig/imagekit/models/file_rename_response.rbs rename to sig/imagekitio/models/file_rename_response.rbs index f19ba301..c80dfad0 100644 --- a/sig/imagekit/models/file_rename_response.rbs +++ b/sig/imagekitio/models/file_rename_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type file_rename_response = { purge_request_id: String } - class FileRenameResponse < Imagekit::Internal::Type::BaseModel + class FileRenameResponse < Imagekitio::Internal::Type::BaseModel attr_reader purge_request_id: String? def purge_request_id=: (String) -> String diff --git a/sig/imagekitio/models/file_update_params.rbs b/sig/imagekitio/models/file_update_params.rbs new file mode 100644 index 00000000..e72f4345 --- /dev/null +++ b/sig/imagekitio/models/file_update_params.rbs @@ -0,0 +1,28 @@ +module Imagekitio + module Models + type file_update_params = + { update_file_request: Imagekitio::Models::update_file_request } + & Imagekitio::Internal::Type::request_parameters + + class FileUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def update_file_request: -> Imagekitio::Models::update_file_request + + def update_file_request=: ( + Imagekitio::Models::update_file_request _ + ) -> Imagekitio::Models::update_file_request + + def initialize: ( + update_file_request: Imagekitio::Models::update_file_request, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + update_file_request: Imagekitio::Models::update_file_request, + request_options: Imagekitio::RequestOptions + } + end + end +end diff --git a/sig/imagekitio/models/file_update_response.rbs b/sig/imagekitio/models/file_update_response.rbs new file mode 100644 index 00000000..8086d9a1 --- /dev/null +++ b/sig/imagekitio/models/file_update_response.rbs @@ -0,0 +1,120 @@ +module Imagekitio + module Models + type file_update_response = + { + extension_status: Imagekitio::Models::FileUpdateResponse::ExtensionStatus + } + + class FileUpdateResponse < Imagekitio::Models::File + def extension_status: -> Imagekitio::Models::FileUpdateResponse::ExtensionStatus? + + def extension_status=: ( + Imagekitio::Models::FileUpdateResponse::ExtensionStatus _ + ) -> Imagekitio::Models::FileUpdateResponse::ExtensionStatus + + def initialize: ( + ?extension_status: Imagekitio::Models::FileUpdateResponse::ExtensionStatus + ) -> void + + def to_hash: -> { + extension_status: Imagekitio::Models::FileUpdateResponse::ExtensionStatus + } + + type extension_status = + { + ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel + attr_reader ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description? + + def ai_auto_description=: ( + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description + ) -> Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description + + attr_reader aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging + ) -> Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging + ) -> Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg + ) -> Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg + + def initialize: ( + ?ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + ?aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg + } + + type ai_auto_description = :success | :pending | :failed + + module AIAutoDescription + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description] + end + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg] + end + end + end + end +end diff --git a/sig/imagekit/models/file_upload_params.rbs b/sig/imagekitio/models/file_upload_params.rbs similarity index 61% rename from sig/imagekit/models/file_upload_params.rbs rename to sig/imagekitio/models/file_upload_params.rbs index 4a819dc1..fc4b7bed 100644 --- a/sig/imagekit/models/file_upload_params.rbs +++ b/sig/imagekitio/models/file_upload_params.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type file_upload_params = { - file: Imagekit::Internal::file_input, + file: Imagekitio::Internal::file_input, file_name: String, token: String, checks: String, @@ -10,7 +10,7 @@ module Imagekit custom_metadata: ::Hash[Symbol, top], description: String, expire: Integer, - extensions: Imagekit::Models::extensions, + extensions: Imagekitio::Models::extensions, folder: String, is_private_file: bool, is_published: bool, @@ -19,20 +19,20 @@ module Imagekit overwrite_file: bool, overwrite_tags: bool, public_key: String, - response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + response_fields: ::Array[Imagekitio::Models::FileUploadParams::response_field], signature: String, tags: ::Array[String], - transformation: Imagekit::FileUploadParams::Transformation, + transformation: Imagekitio::FileUploadParams::Transformation, use_unique_file_name: bool, webhook_url: String } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FileUploadParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FileUploadParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters - attr_accessor file: Imagekit::Internal::file_input + attr_accessor file: Imagekitio::Internal::file_input attr_accessor file_name: String @@ -60,11 +60,11 @@ module Imagekit def expire=: (Integer) -> Integer - attr_reader extensions: Imagekit::Models::extensions? + attr_reader extensions: Imagekitio::Models::extensions? def extensions=: ( - Imagekit::Models::extensions - ) -> Imagekit::Models::extensions + Imagekitio::Models::extensions + ) -> Imagekitio::Models::extensions attr_reader folder: String? @@ -98,11 +98,11 @@ module Imagekit def public_key=: (String) -> String - attr_reader response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field]? + attr_reader response_fields: ::Array[Imagekitio::Models::FileUploadParams::response_field]? def response_fields=: ( - ::Array[Imagekit::Models::FileUploadParams::response_field] - ) -> ::Array[Imagekit::Models::FileUploadParams::response_field] + ::Array[Imagekitio::Models::FileUploadParams::response_field] + ) -> ::Array[Imagekitio::Models::FileUploadParams::response_field] attr_reader signature: String? @@ -112,11 +112,11 @@ module Imagekit def tags=: (::Array[String]) -> ::Array[String] - attr_reader transformation: Imagekit::FileUploadParams::Transformation? + attr_reader transformation: Imagekitio::FileUploadParams::Transformation? def transformation=: ( - Imagekit::FileUploadParams::Transformation - ) -> Imagekit::FileUploadParams::Transformation + Imagekitio::FileUploadParams::Transformation + ) -> Imagekitio::FileUploadParams::Transformation attr_reader use_unique_file_name: bool? @@ -127,7 +127,7 @@ module Imagekit def webhook_url=: (String) -> String def initialize: ( - file: Imagekit::Internal::file_input, + file: Imagekitio::Internal::file_input, file_name: String, ?token: String, ?checks: String, @@ -135,7 +135,7 @@ module Imagekit ?custom_metadata: ::Hash[Symbol, top], ?description: String, ?expire: Integer, - ?extensions: Imagekit::Models::extensions, + ?extensions: Imagekitio::Models::extensions, ?folder: String, ?is_private_file: bool, ?is_published: bool, @@ -144,17 +144,17 @@ module Imagekit ?overwrite_file: bool, ?overwrite_tags: bool, ?public_key: String, - ?response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + ?response_fields: ::Array[Imagekitio::Models::FileUploadParams::response_field], ?signature: String, ?tags: ::Array[String], - ?transformation: Imagekit::FileUploadParams::Transformation, + ?transformation: Imagekitio::FileUploadParams::Transformation, ?use_unique_file_name: bool, ?webhook_url: String, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { - file: Imagekit::Internal::file_input, + file: Imagekitio::Internal::file_input, file_name: String, token: String, checks: String, @@ -162,7 +162,7 @@ module Imagekit custom_metadata: ::Hash[Symbol, top], description: String, expire: Integer, - extensions: Imagekit::Models::extensions, + extensions: Imagekitio::Models::extensions, folder: String, is_private_file: bool, is_published: bool, @@ -171,13 +171,13 @@ module Imagekit overwrite_file: bool, overwrite_tags: bool, public_key: String, - response_fields: ::Array[Imagekit::Models::FileUploadParams::response_field], + response_fields: ::Array[Imagekitio::Models::FileUploadParams::response_field], signature: String, tags: ::Array[String], - transformation: Imagekit::FileUploadParams::Transformation, + transformation: Imagekitio::FileUploadParams::Transformation, use_unique_file_name: bool, webhook_url: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } type response_field = @@ -191,7 +191,7 @@ module Imagekit | :selectedFieldsSchema module ResponseField - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TAGS: :tags CUSTOM_COORDINATES: :customCoordinates @@ -202,48 +202,48 @@ module Imagekit METADATA: :metadata SELECTED_FIELDS_SCHEMA: :selectedFieldsSchema - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::response_field] + def self?.values: -> ::Array[Imagekitio::Models::FileUploadParams::response_field] end type transformation = { - post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post], + post: ::Array[Imagekitio::Models::FileUploadParams::Transformation::post], pre: String } - class Transformation < Imagekit::Internal::Type::BaseModel - attr_reader post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post]? + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_reader post: ::Array[Imagekitio::Models::FileUploadParams::Transformation::post]? def post=: ( - ::Array[Imagekit::Models::FileUploadParams::Transformation::post] - ) -> ::Array[Imagekit::Models::FileUploadParams::Transformation::post] + ::Array[Imagekitio::Models::FileUploadParams::Transformation::post] + ) -> ::Array[Imagekitio::Models::FileUploadParams::Transformation::post] attr_reader pre: String? def pre=: (String) -> String def initialize: ( - ?post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post], + ?post: ::Array[Imagekitio::Models::FileUploadParams::Transformation::post], ?pre: String ) -> void def to_hash: -> { - post: ::Array[Imagekit::Models::FileUploadParams::Transformation::post], + post: ::Array[Imagekitio::Models::FileUploadParams::Transformation::post], pre: String } type post = - Imagekit::FileUploadParams::Transformation::Post::Transformation - | Imagekit::FileUploadParams::Transformation::Post::GifToVideo - | Imagekit::FileUploadParams::Transformation::Post::Thumbnail - | Imagekit::FileUploadParams::Transformation::Post::Abs + Imagekitio::FileUploadParams::Transformation::Post::Transformation + | Imagekitio::FileUploadParams::Transformation::Post::GifToVideo + | Imagekitio::FileUploadParams::Transformation::Post::Thumbnail + | Imagekitio::FileUploadParams::Transformation::Post::Abs module Post - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union type transformation = { type: :transformation, value: String } - class Transformation < Imagekit::Internal::Type::BaseModel + class Transformation < Imagekitio::Internal::Type::BaseModel attr_accessor type: :transformation attr_accessor value: String @@ -255,7 +255,7 @@ module Imagekit type gif_to_video = { type: :"gif-to-video", value: String } - class GifToVideo < Imagekit::Internal::Type::BaseModel + class GifToVideo < Imagekitio::Internal::Type::BaseModel attr_accessor type: :"gif-to-video" attr_reader value: String? @@ -269,7 +269,7 @@ module Imagekit type thumbnail = { type: :thumbnail, value: String } - class Thumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekitio::Internal::Type::BaseModel attr_accessor type: :thumbnail attr_reader value: String? @@ -283,26 +283,26 @@ module Imagekit type abs = { - protocol: Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol, + protocol: Imagekitio::Models::FileUploadParams::Transformation::Post::Abs::protocol, type: :abs, value: String } - class Abs < Imagekit::Internal::Type::BaseModel - attr_accessor protocol: Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol + class Abs < Imagekitio::Internal::Type::BaseModel + attr_accessor protocol: Imagekitio::Models::FileUploadParams::Transformation::Post::Abs::protocol attr_accessor type: :abs attr_accessor value: String def initialize: ( - protocol: Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol, + protocol: Imagekitio::Models::FileUploadParams::Transformation::Post::Abs::protocol, value: String, ?type: :abs ) -> void def to_hash: -> { - protocol: Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol, + protocol: Imagekitio::Models::FileUploadParams::Transformation::Post::Abs::protocol, type: :abs, value: String } @@ -310,16 +310,16 @@ module Imagekit type protocol = :hls | :dash module Protocol - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum HLS: :hls DASH: :dash - def self?.values: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::Post::Abs::protocol] + def self?.values: -> ::Array[Imagekitio::Models::FileUploadParams::Transformation::Post::Abs::protocol] end end - def self?.variants: -> ::Array[Imagekit::Models::FileUploadParams::Transformation::post] + def self?.variants: -> ::Array[Imagekitio::Models::FileUploadParams::Transformation::post] end end end diff --git a/sig/imagekitio/models/file_upload_response.rbs b/sig/imagekitio/models/file_upload_response.rbs new file mode 100644 index 00000000..b94fc139 --- /dev/null +++ b/sig/imagekitio/models/file_upload_response.rbs @@ -0,0 +1,483 @@ +module Imagekitio + module Models + type file_upload_response = + { + ai_tags: ::Array[Imagekitio::Models::FileUploadResponse::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekitio::Models::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekitio::Metadata, + name: String, + selected_fields_schema: ::Hash[Symbol, Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema], + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekitio::Models::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + + class FileUploadResponse < Imagekitio::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekitio::Models::FileUploadResponse::AITag]? + + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: ::Hash[Symbol, top]? + + def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader extension_status: Imagekitio::Models::FileUploadResponse::ExtensionStatus? + + def extension_status=: ( + Imagekitio::Models::FileUploadResponse::ExtensionStatus + ) -> Imagekitio::Models::FileUploadResponse::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader metadata: Imagekitio::Metadata? + + def metadata=: (Imagekitio::Metadata) -> Imagekitio::Metadata + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema] + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail_url: String? + + def thumbnail_url=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekitio::Models::FileUploadResponse::VersionInfo? + + def version_info=: ( + Imagekitio::Models::FileUploadResponse::VersionInfo + ) -> Imagekitio::Models::FileUploadResponse::VersionInfo + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekitio::Models::FileUploadResponse::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?duration: Integer, + ?embedded_metadata: ::Hash[Symbol, top], + ?extension_status: Imagekitio::Models::FileUploadResponse::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?metadata: Imagekitio::Metadata, + ?name: String, + ?selected_fields_schema: ::Hash[Symbol, Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema], + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail_url: String, + ?url: String, + ?version_info: Imagekitio::Models::FileUploadResponse::VersionInfo, + ?video_codec: String, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekitio::Models::FileUploadResponse::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekitio::Models::FileUploadResponse::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekitio::Metadata, + name: String, + selected_fields_schema: ::Hash[Symbol, Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema], + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekitio::Models::FileUploadResponse::VersionInfo, + video_codec: String, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekitio::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type extension_status = + { + ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel + attr_reader ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description? + + def ai_auto_description=: ( + Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description + ) -> Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description + + attr_reader aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging + ) -> Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging + ) -> Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg + ) -> Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg + + def initialize: ( + ?ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, + ?aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg + } + + type ai_auto_description = :success | :pending | :failed + + module AIAutoDescription + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description] + end + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg] + end + end + + type selected_fields_schema = + { + type: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::type_, + default_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::default_value + ) -> Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::max_value + ) -> Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::min_value + ) -> Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::type_, + ?default_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::type_, + default_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekitio::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::default_value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::select_option] + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekitio::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + end +end diff --git a/sig/imagekit/models/files/bulk_add_tags_params.rbs b/sig/imagekitio/models/files/bulk_add_tags_params.rbs similarity index 55% rename from sig/imagekit/models/files/bulk_add_tags_params.rbs rename to sig/imagekitio/models/files/bulk_add_tags_params.rbs index 756027fa..bef017c2 100644 --- a/sig/imagekit/models/files/bulk_add_tags_params.rbs +++ b/sig/imagekitio/models/files/bulk_add_tags_params.rbs @@ -1,13 +1,13 @@ -module Imagekit +module Imagekitio module Models module Files type bulk_add_tags_params = { file_ids: ::Array[String], tags: ::Array[String] } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class BulkAddTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class BulkAddTagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor file_ids: ::Array[String] @@ -16,13 +16,13 @@ module Imagekit def initialize: ( file_ids: ::Array[String], tags: ::Array[String], - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { file_ids: ::Array[String], tags: ::Array[String], - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/files/bulk_add_tags_response.rbs b/sig/imagekitio/models/files/bulk_add_tags_response.rbs similarity index 84% rename from sig/imagekit/models/files/bulk_add_tags_response.rbs rename to sig/imagekitio/models/files/bulk_add_tags_response.rbs index 7d9309bc..dd845295 100644 --- a/sig/imagekit/models/files/bulk_add_tags_response.rbs +++ b/sig/imagekitio/models/files/bulk_add_tags_response.rbs @@ -1,10 +1,10 @@ -module Imagekit +module Imagekitio module Models module Files type bulk_add_tags_response = { successfully_updated_file_ids: ::Array[String] } - class BulkAddTagsResponse < Imagekit::Internal::Type::BaseModel + class BulkAddTagsResponse < Imagekitio::Internal::Type::BaseModel attr_reader successfully_updated_file_ids: ::Array[String]? def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] diff --git a/sig/imagekitio/models/files/bulk_delete_params.rbs b/sig/imagekitio/models/files/bulk_delete_params.rbs new file mode 100644 index 00000000..8b5e7eff --- /dev/null +++ b/sig/imagekitio/models/files/bulk_delete_params.rbs @@ -0,0 +1,26 @@ +module Imagekitio + module Models + module Files + type bulk_delete_params = + { file_ids: ::Array[String] } + & Imagekitio::Internal::Type::request_parameters + + class BulkDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor file_ids: ::Array[String] + + def initialize: ( + file_ids: ::Array[String], + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + file_ids: ::Array[String], + request_options: Imagekitio::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/bulk_delete_response.rbs b/sig/imagekitio/models/files/bulk_delete_response.rbs similarity index 84% rename from sig/imagekit/models/files/bulk_delete_response.rbs rename to sig/imagekitio/models/files/bulk_delete_response.rbs index 7a5933c1..a246aa77 100644 --- a/sig/imagekit/models/files/bulk_delete_response.rbs +++ b/sig/imagekitio/models/files/bulk_delete_response.rbs @@ -1,10 +1,10 @@ -module Imagekit +module Imagekitio module Models module Files type bulk_delete_response = { successfully_deleted_file_ids: ::Array[String] } - class BulkDeleteResponse < Imagekit::Internal::Type::BaseModel + class BulkDeleteResponse < Imagekitio::Internal::Type::BaseModel attr_reader successfully_deleted_file_ids: ::Array[String]? def successfully_deleted_file_ids=: (::Array[String]) -> ::Array[String] diff --git a/sig/imagekit/models/files/bulk_remove_ai_tags_params.rbs b/sig/imagekitio/models/files/bulk_remove_ai_tags_params.rbs similarity index 55% rename from sig/imagekit/models/files/bulk_remove_ai_tags_params.rbs rename to sig/imagekitio/models/files/bulk_remove_ai_tags_params.rbs index b7d6122d..8e300597 100644 --- a/sig/imagekit/models/files/bulk_remove_ai_tags_params.rbs +++ b/sig/imagekitio/models/files/bulk_remove_ai_tags_params.rbs @@ -1,13 +1,13 @@ -module Imagekit +module Imagekitio module Models module Files type bulk_remove_ai_tags_params = { ai_tags: ::Array[String], file_ids: ::Array[String] } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class BulkRemoveAITagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class BulkRemoveAITagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor ai_tags: ::Array[String] @@ -16,13 +16,13 @@ module Imagekit def initialize: ( ai_tags: ::Array[String], file_ids: ::Array[String], - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { ai_tags: ::Array[String], file_ids: ::Array[String], - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/files/bulk_remove_ai_tags_response.rbs b/sig/imagekitio/models/files/bulk_remove_ai_tags_response.rbs similarity index 83% rename from sig/imagekit/models/files/bulk_remove_ai_tags_response.rbs rename to sig/imagekitio/models/files/bulk_remove_ai_tags_response.rbs index ffe753ea..8b7809dd 100644 --- a/sig/imagekit/models/files/bulk_remove_ai_tags_response.rbs +++ b/sig/imagekitio/models/files/bulk_remove_ai_tags_response.rbs @@ -1,10 +1,10 @@ -module Imagekit +module Imagekitio module Models module Files type bulk_remove_ai_tags_response = { successfully_updated_file_ids: ::Array[String] } - class BulkRemoveAITagsResponse < Imagekit::Internal::Type::BaseModel + class BulkRemoveAITagsResponse < Imagekitio::Internal::Type::BaseModel attr_reader successfully_updated_file_ids: ::Array[String]? def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] diff --git a/sig/imagekit/models/files/bulk_remove_tags_params.rbs b/sig/imagekitio/models/files/bulk_remove_tags_params.rbs similarity index 55% rename from sig/imagekit/models/files/bulk_remove_tags_params.rbs rename to sig/imagekitio/models/files/bulk_remove_tags_params.rbs index 020cfb2b..5e6221b2 100644 --- a/sig/imagekit/models/files/bulk_remove_tags_params.rbs +++ b/sig/imagekitio/models/files/bulk_remove_tags_params.rbs @@ -1,13 +1,13 @@ -module Imagekit +module Imagekitio module Models module Files type bulk_remove_tags_params = { file_ids: ::Array[String], tags: ::Array[String] } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class BulkRemoveTagsParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class BulkRemoveTagsParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor file_ids: ::Array[String] @@ -16,13 +16,13 @@ module Imagekit def initialize: ( file_ids: ::Array[String], tags: ::Array[String], - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { file_ids: ::Array[String], tags: ::Array[String], - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/files/bulk_remove_tags_response.rbs b/sig/imagekitio/models/files/bulk_remove_tags_response.rbs similarity index 84% rename from sig/imagekit/models/files/bulk_remove_tags_response.rbs rename to sig/imagekitio/models/files/bulk_remove_tags_response.rbs index ab915fda..bf36edda 100644 --- a/sig/imagekit/models/files/bulk_remove_tags_response.rbs +++ b/sig/imagekitio/models/files/bulk_remove_tags_response.rbs @@ -1,10 +1,10 @@ -module Imagekit +module Imagekitio module Models module Files type bulk_remove_tags_response = { successfully_updated_file_ids: ::Array[String] } - class BulkRemoveTagsResponse < Imagekit::Internal::Type::BaseModel + class BulkRemoveTagsResponse < Imagekitio::Internal::Type::BaseModel attr_reader successfully_updated_file_ids: ::Array[String]? def successfully_updated_file_ids=: (::Array[String]) -> ::Array[String] diff --git a/sig/imagekitio/models/files/metadata_get_from_url_params.rbs b/sig/imagekitio/models/files/metadata_get_from_url_params.rbs new file mode 100644 index 00000000..1380c370 --- /dev/null +++ b/sig/imagekitio/models/files/metadata_get_from_url_params.rbs @@ -0,0 +1,25 @@ +module Imagekitio + module Models + module Files + type metadata_get_from_url_params = + { url: String } & Imagekitio::Internal::Type::request_parameters + + class MetadataGetFromURLParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor url: String + + def initialize: ( + url: String, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + url: String, + request_options: Imagekitio::RequestOptions + } + end + end + end +end diff --git a/sig/imagekitio/models/files/metadata_get_params.rbs b/sig/imagekitio/models/files/metadata_get_params.rbs new file mode 100644 index 00000000..2a057118 --- /dev/null +++ b/sig/imagekitio/models/files/metadata_get_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Files + type metadata_get_params = + { } & Imagekitio::Internal::Type::request_parameters + + class MetadataGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/files/version_delete_params.rbs b/sig/imagekitio/models/files/version_delete_params.rbs new file mode 100644 index 00000000..60119658 --- /dev/null +++ b/sig/imagekitio/models/files/version_delete_params.rbs @@ -0,0 +1,25 @@ +module Imagekitio + module Models + module Files + type version_delete_params = + { file_id: String } & Imagekitio::Internal::Type::request_parameters + + class VersionDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor file_id: String + + def initialize: ( + file_id: String, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + file_id: String, + request_options: Imagekitio::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/files/version_delete_response.rbs b/sig/imagekitio/models/files/version_delete_response.rbs similarity index 64% rename from sig/imagekit/models/files/version_delete_response.rbs rename to sig/imagekitio/models/files/version_delete_response.rbs index 6c5f6681..30fdbfea 100644 --- a/sig/imagekit/models/files/version_delete_response.rbs +++ b/sig/imagekitio/models/files/version_delete_response.rbs @@ -1,9 +1,9 @@ -module Imagekit +module Imagekitio module Models module Files type version_delete_response = { } - class VersionDeleteResponse < Imagekit::Internal::Type::BaseModel + class VersionDeleteResponse < Imagekitio::Internal::Type::BaseModel def initialize: -> void def to_hash: -> { } diff --git a/sig/imagekitio/models/files/version_get_params.rbs b/sig/imagekitio/models/files/version_get_params.rbs new file mode 100644 index 00000000..1d74dfc1 --- /dev/null +++ b/sig/imagekitio/models/files/version_get_params.rbs @@ -0,0 +1,25 @@ +module Imagekitio + module Models + module Files + type version_get_params = + { file_id: String } & Imagekitio::Internal::Type::request_parameters + + class VersionGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor file_id: String + + def initialize: ( + file_id: String, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + file_id: String, + request_options: Imagekitio::RequestOptions + } + end + end + end +end diff --git a/sig/imagekitio/models/files/version_list_params.rbs b/sig/imagekitio/models/files/version_list_params.rbs new file mode 100644 index 00000000..2d054b1c --- /dev/null +++ b/sig/imagekitio/models/files/version_list_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Files + type version_list_params = + { } & Imagekitio::Internal::Type::request_parameters + + class VersionListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/files/version_list_response.rbs b/sig/imagekitio/models/files/version_list_response.rbs new file mode 100644 index 00000000..c8ac4129 --- /dev/null +++ b/sig/imagekitio/models/files/version_list_response.rbs @@ -0,0 +1,9 @@ +module Imagekitio + module Models + module Files + type version_list_response = ::Array[Imagekitio::File] + + VersionListResponse: Imagekitio::Internal::Type::Converter + end + end +end diff --git a/sig/imagekitio/models/files/version_restore_params.rbs b/sig/imagekitio/models/files/version_restore_params.rbs new file mode 100644 index 00000000..b0583cb8 --- /dev/null +++ b/sig/imagekitio/models/files/version_restore_params.rbs @@ -0,0 +1,25 @@ +module Imagekitio + module Models + module Files + type version_restore_params = + { file_id: String } & Imagekitio::Internal::Type::request_parameters + + class VersionRestoreParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor file_id: String + + def initialize: ( + file_id: String, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + file_id: String, + request_options: Imagekitio::RequestOptions + } + end + end + end +end diff --git a/sig/imagekit/models/folder.rbs b/sig/imagekitio/models/folder.rbs similarity index 67% rename from sig/imagekit/models/folder.rbs rename to sig/imagekitio/models/folder.rbs index 23c781ba..b67e65e7 100644 --- a/sig/imagekit/models/folder.rbs +++ b/sig/imagekitio/models/folder.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models type folder = { @@ -6,11 +6,11 @@ module Imagekit folder_id: String, folder_path: String, name: String, - type: Imagekit::Models::Folder::type_, + type: Imagekitio::Models::Folder::type_, updated_at: Time } - class Folder < Imagekit::Internal::Type::BaseModel + class Folder < Imagekitio::Internal::Type::BaseModel attr_reader created_at: Time? def created_at=: (Time) -> Time @@ -27,11 +27,11 @@ module Imagekit def name=: (String) -> String - attr_reader type: Imagekit::Models::Folder::type_? + attr_reader type: Imagekitio::Models::Folder::type_? def type=: ( - Imagekit::Models::Folder::type_ - ) -> Imagekit::Models::Folder::type_ + Imagekitio::Models::Folder::type_ + ) -> Imagekitio::Models::Folder::type_ attr_reader updated_at: Time? @@ -42,7 +42,7 @@ module Imagekit ?folder_id: String, ?folder_path: String, ?name: String, - ?type: Imagekit::Models::Folder::type_, + ?type: Imagekitio::Models::Folder::type_, ?updated_at: Time ) -> void @@ -51,18 +51,18 @@ module Imagekit folder_id: String, folder_path: String, name: String, - type: Imagekit::Models::Folder::type_, + type: Imagekitio::Models::Folder::type_, updated_at: Time } type type_ = :folder module Type - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum FOLDER: :folder - def self?.values: -> ::Array[Imagekit::Models::Folder::type_] + def self?.values: -> ::Array[Imagekitio::Models::Folder::type_] end end end diff --git a/sig/imagekit/models/folder_copy_params.rbs b/sig/imagekitio/models/folder_copy_params.rbs similarity index 63% rename from sig/imagekit/models/folder_copy_params.rbs rename to sig/imagekitio/models/folder_copy_params.rbs index 90f19170..aa8cbfaf 100644 --- a/sig/imagekit/models/folder_copy_params.rbs +++ b/sig/imagekitio/models/folder_copy_params.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models type folder_copy_params = { @@ -6,11 +6,11 @@ module Imagekit source_folder_path: String, include_versions: bool } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FolderCopyParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderCopyParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor destination_path: String @@ -24,14 +24,14 @@ module Imagekit destination_path: String, source_folder_path: String, ?include_versions: bool, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { destination_path: String, source_folder_path: String, include_versions: bool, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/folder_copy_response.rbs b/sig/imagekitio/models/folder_copy_response.rbs similarity index 70% rename from sig/imagekit/models/folder_copy_response.rbs rename to sig/imagekitio/models/folder_copy_response.rbs index 3baef44d..bdad7e86 100644 --- a/sig/imagekit/models/folder_copy_response.rbs +++ b/sig/imagekitio/models/folder_copy_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type folder_copy_response = { job_id: String } - class FolderCopyResponse < Imagekit::Internal::Type::BaseModel + class FolderCopyResponse < Imagekitio::Internal::Type::BaseModel attr_accessor job_id: String def initialize: (job_id: String) -> void diff --git a/sig/imagekit/models/folder_create_params.rbs b/sig/imagekitio/models/folder_create_params.rbs similarity index 52% rename from sig/imagekit/models/folder_create_params.rbs rename to sig/imagekitio/models/folder_create_params.rbs index 3dff4c00..f488c652 100644 --- a/sig/imagekit/models/folder_create_params.rbs +++ b/sig/imagekitio/models/folder_create_params.rbs @@ -1,12 +1,12 @@ -module Imagekit +module Imagekitio module Models type folder_create_params = { folder_name: String, parent_folder_path: String } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FolderCreateParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor folder_name: String @@ -15,13 +15,13 @@ module Imagekit def initialize: ( folder_name: String, parent_folder_path: String, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { folder_name: String, parent_folder_path: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/folder_create_response.rbs b/sig/imagekitio/models/folder_create_response.rbs similarity index 59% rename from sig/imagekit/models/folder_create_response.rbs rename to sig/imagekitio/models/folder_create_response.rbs index 4cc3bed8..182d8290 100644 --- a/sig/imagekit/models/folder_create_response.rbs +++ b/sig/imagekitio/models/folder_create_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type folder_create_response = { } - class FolderCreateResponse < Imagekit::Internal::Type::BaseModel + class FolderCreateResponse < Imagekitio::Internal::Type::BaseModel def initialize: -> void def to_hash: -> { } diff --git a/sig/imagekitio/models/folder_delete_params.rbs b/sig/imagekitio/models/folder_delete_params.rbs new file mode 100644 index 00000000..1e4a7f4f --- /dev/null +++ b/sig/imagekitio/models/folder_delete_params.rbs @@ -0,0 +1,23 @@ +module Imagekitio + module Models + type folder_delete_params = + { folder_path: String } & Imagekitio::Internal::Type::request_parameters + + class FolderDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor folder_path: String + + def initialize: ( + folder_path: String, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + folder_path: String, + request_options: Imagekitio::RequestOptions + } + end + end +end diff --git a/sig/imagekit/models/folder_delete_response.rbs b/sig/imagekitio/models/folder_delete_response.rbs similarity index 59% rename from sig/imagekit/models/folder_delete_response.rbs rename to sig/imagekitio/models/folder_delete_response.rbs index 9dcdda77..6a89ebc1 100644 --- a/sig/imagekit/models/folder_delete_response.rbs +++ b/sig/imagekitio/models/folder_delete_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type folder_delete_response = { } - class FolderDeleteResponse < Imagekit::Internal::Type::BaseModel + class FolderDeleteResponse < Imagekitio::Internal::Type::BaseModel def initialize: -> void def to_hash: -> { } diff --git a/sig/imagekit/models/folder_move_params.rbs b/sig/imagekitio/models/folder_move_params.rbs similarity index 53% rename from sig/imagekit/models/folder_move_params.rbs rename to sig/imagekitio/models/folder_move_params.rbs index 50d1d68a..c61c8be2 100644 --- a/sig/imagekit/models/folder_move_params.rbs +++ b/sig/imagekitio/models/folder_move_params.rbs @@ -1,12 +1,12 @@ -module Imagekit +module Imagekitio module Models type folder_move_params = { destination_path: String, source_folder_path: String } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FolderMoveParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderMoveParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor destination_path: String @@ -15,13 +15,13 @@ module Imagekit def initialize: ( destination_path: String, source_folder_path: String, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { destination_path: String, source_folder_path: String, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/folder_move_response.rbs b/sig/imagekitio/models/folder_move_response.rbs similarity index 70% rename from sig/imagekit/models/folder_move_response.rbs rename to sig/imagekitio/models/folder_move_response.rbs index dd788a3e..3d72f99f 100644 --- a/sig/imagekit/models/folder_move_response.rbs +++ b/sig/imagekitio/models/folder_move_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type folder_move_response = { job_id: String } - class FolderMoveResponse < Imagekit::Internal::Type::BaseModel + class FolderMoveResponse < Imagekitio::Internal::Type::BaseModel attr_accessor job_id: String def initialize: (job_id: String) -> void diff --git a/sig/imagekit/models/folder_rename_params.rbs b/sig/imagekitio/models/folder_rename_params.rbs similarity index 59% rename from sig/imagekit/models/folder_rename_params.rbs rename to sig/imagekitio/models/folder_rename_params.rbs index ddb509d9..8d22cd49 100644 --- a/sig/imagekit/models/folder_rename_params.rbs +++ b/sig/imagekitio/models/folder_rename_params.rbs @@ -1,12 +1,12 @@ -module Imagekit +module Imagekitio module Models type folder_rename_params = { folder_path: String, new_folder_name: String, purge_cache: bool } - & Imagekit::Internal::Type::request_parameters + & Imagekitio::Internal::Type::request_parameters - class FolderRenameParams < Imagekit::Internal::Type::BaseModel - extend Imagekit::Internal::Type::RequestParameters::Converter - include Imagekit::Internal::Type::RequestParameters + class FolderRenameParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters attr_accessor folder_path: String @@ -20,14 +20,14 @@ module Imagekit folder_path: String, new_folder_name: String, ?purge_cache: bool, - ?request_options: Imagekit::request_opts + ?request_options: Imagekitio::request_opts ) -> void def to_hash: -> { folder_path: String, new_folder_name: String, purge_cache: bool, - request_options: Imagekit::RequestOptions + request_options: Imagekitio::RequestOptions } end end diff --git a/sig/imagekit/models/folder_rename_response.rbs b/sig/imagekitio/models/folder_rename_response.rbs similarity index 70% rename from sig/imagekit/models/folder_rename_response.rbs rename to sig/imagekitio/models/folder_rename_response.rbs index 8b24b6dd..f5be1726 100644 --- a/sig/imagekit/models/folder_rename_response.rbs +++ b/sig/imagekitio/models/folder_rename_response.rbs @@ -1,8 +1,8 @@ -module Imagekit +module Imagekitio module Models type folder_rename_response = { job_id: String } - class FolderRenameResponse < Imagekit::Internal::Type::BaseModel + class FolderRenameResponse < Imagekitio::Internal::Type::BaseModel attr_accessor job_id: String def initialize: (job_id: String) -> void diff --git a/sig/imagekitio/models/folders/job_get_params.rbs b/sig/imagekitio/models/folders/job_get_params.rbs new file mode 100644 index 00000000..73de9724 --- /dev/null +++ b/sig/imagekitio/models/folders/job_get_params.rbs @@ -0,0 +1,17 @@ +module Imagekitio + module Models + module Folders + type job_get_params = + { } & Imagekitio::Internal::Type::request_parameters + + class JobGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end + end +end diff --git a/sig/imagekitio/models/folders/job_get_response.rbs b/sig/imagekitio/models/folders/job_get_response.rbs new file mode 100644 index 00000000..3b4af32d --- /dev/null +++ b/sig/imagekitio/models/folders/job_get_response.rbs @@ -0,0 +1,72 @@ +module Imagekitio + module Models + module Folders + type job_get_response = + { + job_id: String, + purge_request_id: String, + status: Imagekitio::Models::Folders::JobGetResponse::status, + type: Imagekitio::Models::Folders::JobGetResponse::type_ + } + + class JobGetResponse < Imagekitio::Internal::Type::BaseModel + attr_reader job_id: String? + + def job_id=: (String) -> String + + attr_reader purge_request_id: String? + + def purge_request_id=: (String) -> String + + attr_reader status: Imagekitio::Models::Folders::JobGetResponse::status? + + def status=: ( + Imagekitio::Models::Folders::JobGetResponse::status + ) -> Imagekitio::Models::Folders::JobGetResponse::status + + attr_reader type: Imagekitio::Models::Folders::JobGetResponse::type_? + + def type=: ( + Imagekitio::Models::Folders::JobGetResponse::type_ + ) -> Imagekitio::Models::Folders::JobGetResponse::type_ + + def initialize: ( + ?job_id: String, + ?purge_request_id: String, + ?status: Imagekitio::Models::Folders::JobGetResponse::status, + ?type: Imagekitio::Models::Folders::JobGetResponse::type_ + ) -> void + + def to_hash: -> { + job_id: String, + purge_request_id: String, + status: Imagekitio::Models::Folders::JobGetResponse::status, + type: Imagekitio::Models::Folders::JobGetResponse::type_ + } + + type status = :Pending | :Completed + + module Status + extend Imagekitio::Internal::Type::Enum + + PENDING: :Pending + COMPLETED: :Completed + + def self?.values: -> ::Array[Imagekitio::Models::Folders::JobGetResponse::status] + end + + type type_ = :COPY_FOLDER | :MOVE_FOLDER | :RENAME_FOLDER + + module Type + extend Imagekitio::Internal::Type::Enum + + COPY_FOLDER: :COPY_FOLDER + MOVE_FOLDER: :MOVE_FOLDER + RENAME_FOLDER: :RENAME_FOLDER + + def self?.values: -> ::Array[Imagekitio::Models::Folders::JobGetResponse::type_] + end + end + end + end +end diff --git a/sig/imagekit/models/get_image_attributes_options.rbs b/sig/imagekitio/models/get_image_attributes_options.rbs similarity index 91% rename from sig/imagekit/models/get_image_attributes_options.rbs rename to sig/imagekitio/models/get_image_attributes_options.rbs index 9eb6c071..20928b19 100644 --- a/sig/imagekit/models/get_image_attributes_options.rbs +++ b/sig/imagekitio/models/get_image_attributes_options.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models type get_image_attributes_options = { @@ -8,7 +8,7 @@ module Imagekit width: Float } - class GetImageAttributesOptions < Imagekit::Models::SrcOptions + class GetImageAttributesOptions < Imagekitio::Models::SrcOptions def device_breakpoints: -> ::Array[Float]? def device_breakpoints=: (::Array[Float] _) -> ::Array[Float] diff --git a/sig/imagekitio/models/image_overlay.rbs b/sig/imagekitio/models/image_overlay.rbs new file mode 100644 index 00000000..c9d3f886 --- /dev/null +++ b/sig/imagekitio/models/image_overlay.rbs @@ -0,0 +1,59 @@ +module Imagekitio + module Models + type image_overlay = + { + input: String, + type: :image, + encoding: Imagekitio::Models::ImageOverlay::encoding, + transformation: ::Array[Imagekitio::Transformation] + } + + class ImageOverlay < Imagekitio::Models::BaseOverlay + def input: -> String + + def input=: (String _) -> String + + def `type`: -> :image + + def type=: (:image _) -> :image + + def encoding: -> Imagekitio::Models::ImageOverlay::encoding? + + def encoding=: ( + Imagekitio::Models::ImageOverlay::encoding _ + ) -> Imagekitio::Models::ImageOverlay::encoding + + def transformation: -> ::Array[Imagekitio::Transformation]? + + def transformation=: ( + ::Array[Imagekitio::Transformation] _ + ) -> ::Array[Imagekitio::Transformation] + + def initialize: ( + input: String, + ?encoding: Imagekitio::Models::ImageOverlay::encoding, + ?transformation: ::Array[Imagekitio::Transformation], + ?type: :image + ) -> void + + def to_hash: -> { + input: String, + type: :image, + encoding: Imagekitio::Models::ImageOverlay::encoding, + transformation: ::Array[Imagekitio::Transformation] + } + + type encoding = :auto | :plain | :base64 + + module Encoding + extend Imagekitio::Internal::Type::Enum + + AUTO: :auto + PLAIN: :plain + BASE64: :base64 + + def self?.values: -> ::Array[Imagekitio::Models::ImageOverlay::encoding] + end + end + end +end diff --git a/sig/imagekit/models/metadata.rbs b/sig/imagekitio/models/metadata.rbs similarity index 84% rename from sig/imagekit/models/metadata.rbs rename to sig/imagekitio/models/metadata.rbs index 789a9376..082ac3ac 100644 --- a/sig/imagekit/models/metadata.rbs +++ b/sig/imagekitio/models/metadata.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models type metadata = { @@ -6,7 +6,7 @@ module Imagekit bit_rate: Integer, density: Integer, duration: Integer, - exif: Imagekit::Metadata::Exif, + exif: Imagekitio::Metadata::Exif, format_: String, has_color_profile: bool, has_transparency: bool, @@ -18,7 +18,7 @@ module Imagekit width: Integer } - class Metadata < Imagekit::Internal::Type::BaseModel + class Metadata < Imagekitio::Internal::Type::BaseModel attr_reader audio_codec: String? def audio_codec=: (String) -> String @@ -35,9 +35,9 @@ module Imagekit def duration=: (Integer) -> Integer - attr_reader exif: Imagekit::Metadata::Exif? + attr_reader exif: Imagekitio::Metadata::Exif? - def exif=: (Imagekit::Metadata::Exif) -> Imagekit::Metadata::Exif + def exif=: (Imagekitio::Metadata::Exif) -> Imagekitio::Metadata::Exif attr_reader format_: String? @@ -80,7 +80,7 @@ module Imagekit ?bit_rate: Integer, ?density: Integer, ?duration: Integer, - ?exif: Imagekit::Metadata::Exif, + ?exif: Imagekitio::Metadata::Exif, ?format_: String, ?has_color_profile: bool, ?has_transparency: bool, @@ -97,7 +97,7 @@ module Imagekit bit_rate: Integer, density: Integer, duration: Integer, - exif: Imagekit::Metadata::Exif, + exif: Imagekitio::Metadata::Exif, format_: String, has_color_profile: bool, has_transparency: bool, @@ -111,65 +111,65 @@ module Imagekit type exif = { - exif: Imagekit::Metadata::Exif::Exif, - gps: Imagekit::Metadata::Exif::Gps, - image: Imagekit::Metadata::Exif::Image, - interoperability: Imagekit::Metadata::Exif::Interoperability, + exif: Imagekitio::Metadata::Exif::Exif, + gps: Imagekitio::Metadata::Exif::Gps, + image: Imagekitio::Metadata::Exif::Image, + interoperability: Imagekitio::Metadata::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Metadata::Exif::Thumbnail + thumbnail: Imagekitio::Metadata::Exif::Thumbnail } - class Exif < Imagekit::Internal::Type::BaseModel - attr_reader exif: Imagekit::Metadata::Exif::Exif? + class Exif < Imagekitio::Internal::Type::BaseModel + attr_reader exif: Imagekitio::Metadata::Exif::Exif? def exif=: ( - Imagekit::Metadata::Exif::Exif - ) -> Imagekit::Metadata::Exif::Exif + Imagekitio::Metadata::Exif::Exif + ) -> Imagekitio::Metadata::Exif::Exif - attr_reader gps: Imagekit::Metadata::Exif::Gps? + attr_reader gps: Imagekitio::Metadata::Exif::Gps? def gps=: ( - Imagekit::Metadata::Exif::Gps - ) -> Imagekit::Metadata::Exif::Gps + Imagekitio::Metadata::Exif::Gps + ) -> Imagekitio::Metadata::Exif::Gps - attr_reader image: Imagekit::Metadata::Exif::Image? + attr_reader image: Imagekitio::Metadata::Exif::Image? def image=: ( - Imagekit::Metadata::Exif::Image - ) -> Imagekit::Metadata::Exif::Image + Imagekitio::Metadata::Exif::Image + ) -> Imagekitio::Metadata::Exif::Image - attr_reader interoperability: Imagekit::Metadata::Exif::Interoperability? + attr_reader interoperability: Imagekitio::Metadata::Exif::Interoperability? def interoperability=: ( - Imagekit::Metadata::Exif::Interoperability - ) -> Imagekit::Metadata::Exif::Interoperability + Imagekitio::Metadata::Exif::Interoperability + ) -> Imagekitio::Metadata::Exif::Interoperability attr_reader makernote: ::Hash[Symbol, top]? def makernote=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - attr_reader thumbnail: Imagekit::Metadata::Exif::Thumbnail? + attr_reader thumbnail: Imagekitio::Metadata::Exif::Thumbnail? def thumbnail=: ( - Imagekit::Metadata::Exif::Thumbnail - ) -> Imagekit::Metadata::Exif::Thumbnail + Imagekitio::Metadata::Exif::Thumbnail + ) -> Imagekitio::Metadata::Exif::Thumbnail def initialize: ( - ?exif: Imagekit::Metadata::Exif::Exif, - ?gps: Imagekit::Metadata::Exif::Gps, - ?image: Imagekit::Metadata::Exif::Image, - ?interoperability: Imagekit::Metadata::Exif::Interoperability, + ?exif: Imagekitio::Metadata::Exif::Exif, + ?gps: Imagekitio::Metadata::Exif::Gps, + ?image: Imagekitio::Metadata::Exif::Image, + ?interoperability: Imagekitio::Metadata::Exif::Interoperability, ?makernote: ::Hash[Symbol, top], - ?thumbnail: Imagekit::Metadata::Exif::Thumbnail + ?thumbnail: Imagekitio::Metadata::Exif::Thumbnail ) -> void def to_hash: -> { - exif: Imagekit::Metadata::Exif::Exif, - gps: Imagekit::Metadata::Exif::Gps, - image: Imagekit::Metadata::Exif::Image, - interoperability: Imagekit::Metadata::Exif::Interoperability, + exif: Imagekitio::Metadata::Exif::Exif, + gps: Imagekitio::Metadata::Exif::Gps, + image: Imagekitio::Metadata::Exif::Image, + interoperability: Imagekitio::Metadata::Exif::Interoperability, makernote: ::Hash[Symbol, top], - thumbnail: Imagekit::Metadata::Exif::Thumbnail + thumbnail: Imagekitio::Metadata::Exif::Thumbnail } type exif = @@ -202,7 +202,7 @@ module Imagekit white_balance: Integer } - class Exif < Imagekit::Internal::Type::BaseModel + class Exif < Imagekitio::Internal::Type::BaseModel attr_reader aperture_value: Float? def aperture_value=: (Float) -> Float @@ -368,7 +368,7 @@ module Imagekit type gps = { gps_version_id: ::Array[Integer] } - class Gps < Imagekit::Internal::Type::BaseModel + class Gps < Imagekitio::Internal::Type::BaseModel attr_reader gps_version_id: ::Array[Integer]? def gps_version_id=: (::Array[Integer]) -> ::Array[Integer] @@ -393,7 +393,7 @@ module Imagekit y_resolution: Integer } - class Image < Imagekit::Internal::Type::BaseModel + class Image < Imagekitio::Internal::Type::BaseModel attr_reader exif_offset: Integer? def exif_offset=: (Integer) -> Integer @@ -470,7 +470,7 @@ module Imagekit type interoperability = { interop_index: String, interop_version: String } - class Interoperability < Imagekit::Internal::Type::BaseModel + class Interoperability < Imagekitio::Internal::Type::BaseModel attr_reader interop_index: String? def interop_index=: (String) -> String @@ -497,7 +497,7 @@ module Imagekit y_resolution: Integer } - class Thumbnail < Imagekit::Internal::Type::BaseModel + class Thumbnail < Imagekitio::Internal::Type::BaseModel attr_reader compression: Integer? def compression=: (Integer) -> Integer diff --git a/sig/imagekitio/models/overlay.rbs b/sig/imagekitio/models/overlay.rbs new file mode 100644 index 00000000..c124fe05 --- /dev/null +++ b/sig/imagekitio/models/overlay.rbs @@ -0,0 +1,16 @@ +module Imagekitio + module Models + type overlay = + Imagekitio::TextOverlay + | Imagekitio::ImageOverlay + | Imagekitio::VideoOverlay + | Imagekitio::SubtitleOverlay + | Imagekitio::SolidColorOverlay + + module Overlay + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::overlay] + end + end +end diff --git a/sig/imagekitio/models/overlay_position.rbs b/sig/imagekitio/models/overlay_position.rbs new file mode 100644 index 00000000..e2c9c5a6 --- /dev/null +++ b/sig/imagekitio/models/overlay_position.rbs @@ -0,0 +1,85 @@ +module Imagekitio + module Models + type overlay_position = + { + focus: Imagekitio::Models::OverlayPosition::focus, + x: Imagekitio::Models::OverlayPosition::x, + y_: Imagekitio::Models::OverlayPosition::y_ + } + + class OverlayPosition < Imagekitio::Internal::Type::BaseModel + attr_reader focus: Imagekitio::Models::OverlayPosition::focus? + + def focus=: ( + Imagekitio::Models::OverlayPosition::focus + ) -> Imagekitio::Models::OverlayPosition::focus + + attr_reader x: Imagekitio::Models::OverlayPosition::x? + + def x=: ( + Imagekitio::Models::OverlayPosition::x + ) -> Imagekitio::Models::OverlayPosition::x + + attr_reader y_: Imagekitio::Models::OverlayPosition::y_? + + def y_=: ( + Imagekitio::Models::OverlayPosition::y_ + ) -> Imagekitio::Models::OverlayPosition::y_ + + def initialize: ( + ?focus: Imagekitio::Models::OverlayPosition::focus, + ?x: Imagekitio::Models::OverlayPosition::x, + ?y_: Imagekitio::Models::OverlayPosition::y_ + ) -> void + + def to_hash: -> { + focus: Imagekitio::Models::OverlayPosition::focus, + x: Imagekitio::Models::OverlayPosition::x, + y_: Imagekitio::Models::OverlayPosition::y_ + } + + type focus = + :center + | :top + | :left + | :bottom + | :right + | :top_left + | :top_right + | :bottom_left + | :bottom_right + + module Focus + extend Imagekitio::Internal::Type::Enum + + CENTER: :center + TOP: :top + LEFT: :left + BOTTOM: :bottom + RIGHT: :right + TOP_LEFT: :top_left + TOP_RIGHT: :top_right + BOTTOM_LEFT: :bottom_left + BOTTOM_RIGHT: :bottom_right + + def self?.values: -> ::Array[Imagekitio::Models::OverlayPosition::focus] + end + + type x = Float | String + + module X + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::OverlayPosition::x] + end + + type y_ = Float | String + + module Y + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::OverlayPosition::y_] + end + end + end +end diff --git a/sig/imagekitio/models/overlay_timing.rbs b/sig/imagekitio/models/overlay_timing.rbs new file mode 100644 index 00000000..4f5759de --- /dev/null +++ b/sig/imagekitio/models/overlay_timing.rbs @@ -0,0 +1,66 @@ +module Imagekitio + module Models + type overlay_timing = + { + duration: Imagekitio::Models::OverlayTiming::duration, + end_: Imagekitio::Models::OverlayTiming::end_, + start: Imagekitio::Models::OverlayTiming::start + } + + class OverlayTiming < Imagekitio::Internal::Type::BaseModel + attr_reader duration: Imagekitio::Models::OverlayTiming::duration? + + def duration=: ( + Imagekitio::Models::OverlayTiming::duration + ) -> Imagekitio::Models::OverlayTiming::duration + + attr_reader end_: Imagekitio::Models::OverlayTiming::end_? + + def end_=: ( + Imagekitio::Models::OverlayTiming::end_ + ) -> Imagekitio::Models::OverlayTiming::end_ + + attr_reader start: Imagekitio::Models::OverlayTiming::start? + + def start=: ( + Imagekitio::Models::OverlayTiming::start + ) -> Imagekitio::Models::OverlayTiming::start + + def initialize: ( + ?duration: Imagekitio::Models::OverlayTiming::duration, + ?end_: Imagekitio::Models::OverlayTiming::end_, + ?start: Imagekitio::Models::OverlayTiming::start + ) -> void + + def to_hash: -> { + duration: Imagekitio::Models::OverlayTiming::duration, + end_: Imagekitio::Models::OverlayTiming::end_, + start: Imagekitio::Models::OverlayTiming::start + } + + type duration = Float | String + + module Duration + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::OverlayTiming::duration] + end + + type end_ = Float | String + + module End + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::OverlayTiming::end_] + end + + type start = Float | String + + module Start + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::OverlayTiming::start] + end + end + end +end diff --git a/sig/imagekit/models/responsive_image_attributes.rbs b/sig/imagekitio/models/responsive_image_attributes.rbs similarity index 87% rename from sig/imagekit/models/responsive_image_attributes.rbs rename to sig/imagekitio/models/responsive_image_attributes.rbs index 45b45e85..2fe55eec 100644 --- a/sig/imagekit/models/responsive_image_attributes.rbs +++ b/sig/imagekitio/models/responsive_image_attributes.rbs @@ -1,9 +1,9 @@ -module Imagekit +module Imagekitio module Models type responsive_image_attributes = { src: String, sizes: String, src_set: String, width: Float } - class ResponsiveImageAttributes < Imagekit::Internal::Type::BaseModel + class ResponsiveImageAttributes < Imagekitio::Internal::Type::BaseModel attr_accessor src: String attr_reader sizes: String? diff --git a/sig/imagekitio/models/solid_color_overlay.rbs b/sig/imagekitio/models/solid_color_overlay.rbs new file mode 100644 index 00000000..165260f6 --- /dev/null +++ b/sig/imagekitio/models/solid_color_overlay.rbs @@ -0,0 +1,38 @@ +module Imagekitio + module Models + type solid_color_overlay = + { + color: String, + type: :solidColor, + transformation: ::Array[Imagekitio::SolidColorOverlayTransformation] + } + + class SolidColorOverlay < Imagekitio::Models::BaseOverlay + def color: -> String + + def color=: (String _) -> String + + def `type`: -> :solidColor + + def type=: (:solidColor _) -> :solidColor + + def transformation: -> ::Array[Imagekitio::SolidColorOverlayTransformation]? + + def transformation=: ( + ::Array[Imagekitio::SolidColorOverlayTransformation] _ + ) -> ::Array[Imagekitio::SolidColorOverlayTransformation] + + def initialize: ( + color: String, + ?transformation: ::Array[Imagekitio::SolidColorOverlayTransformation], + ?type: :solidColor + ) -> void + + def to_hash: -> { + color: String, + type: :solidColor, + transformation: ::Array[Imagekitio::SolidColorOverlayTransformation] + } + end + end +end diff --git a/sig/imagekitio/models/solid_color_overlay_transformation.rbs b/sig/imagekitio/models/solid_color_overlay_transformation.rbs new file mode 100644 index 00000000..a2877675 --- /dev/null +++ b/sig/imagekitio/models/solid_color_overlay_transformation.rbs @@ -0,0 +1,97 @@ +module Imagekitio + module Models + type solid_color_overlay_transformation = + { + alpha: Float, + background: String, + gradient: Imagekitio::Models::SolidColorOverlayTransformation::gradient, + height: Imagekitio::Models::SolidColorOverlayTransformation::height, + radius: Imagekitio::Models::SolidColorOverlayTransformation::radius, + width: Imagekitio::Models::SolidColorOverlayTransformation::width + } + + class SolidColorOverlayTransformation < Imagekitio::Internal::Type::BaseModel + attr_reader alpha: Float? + + def alpha=: (Float) -> Float + + attr_reader background: String? + + def background=: (String) -> String + + attr_reader gradient: Imagekitio::Models::SolidColorOverlayTransformation::gradient? + + def gradient=: ( + Imagekitio::Models::SolidColorOverlayTransformation::gradient + ) -> Imagekitio::Models::SolidColorOverlayTransformation::gradient + + attr_reader height: Imagekitio::Models::SolidColorOverlayTransformation::height? + + def height=: ( + Imagekitio::Models::SolidColorOverlayTransformation::height + ) -> Imagekitio::Models::SolidColorOverlayTransformation::height + + attr_reader radius: Imagekitio::Models::SolidColorOverlayTransformation::radius? + + def radius=: ( + Imagekitio::Models::SolidColorOverlayTransformation::radius + ) -> Imagekitio::Models::SolidColorOverlayTransformation::radius + + attr_reader width: Imagekitio::Models::SolidColorOverlayTransformation::width? + + def width=: ( + Imagekitio::Models::SolidColorOverlayTransformation::width + ) -> Imagekitio::Models::SolidColorOverlayTransformation::width + + def initialize: ( + ?alpha: Float, + ?background: String, + ?gradient: Imagekitio::Models::SolidColorOverlayTransformation::gradient, + ?height: Imagekitio::Models::SolidColorOverlayTransformation::height, + ?radius: Imagekitio::Models::SolidColorOverlayTransformation::radius, + ?width: Imagekitio::Models::SolidColorOverlayTransformation::width + ) -> void + + def to_hash: -> { + alpha: Float, + background: String, + gradient: Imagekitio::Models::SolidColorOverlayTransformation::gradient, + height: Imagekitio::Models::SolidColorOverlayTransformation::height, + radius: Imagekitio::Models::SolidColorOverlayTransformation::radius, + width: Imagekitio::Models::SolidColorOverlayTransformation::width + } + + type gradient = true | String + + module Gradient + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::SolidColorOverlayTransformation::gradient] + end + + type height = Float | String + + module Height + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::SolidColorOverlayTransformation::height] + end + + type radius = Float | :max + + module Radius + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::SolidColorOverlayTransformation::radius] + end + + type width = Float | String + + module Width + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::SolidColorOverlayTransformation::width] + end + end + end +end diff --git a/sig/imagekit/models/src_options.rbs b/sig/imagekitio/models/src_options.rbs similarity index 54% rename from sig/imagekit/models/src_options.rbs rename to sig/imagekitio/models/src_options.rbs index 185f2522..d639bf63 100644 --- a/sig/imagekit/models/src_options.rbs +++ b/sig/imagekitio/models/src_options.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models type src_options = { @@ -7,11 +7,11 @@ module Imagekit expires_in: Float, query_parameters: ::Hash[Symbol, String], signed: bool, - transformation: ::Array[Imagekit::Transformation], - transformation_position: Imagekit::Models::transformation_position + transformation: ::Array[Imagekitio::Transformation], + transformation_position: Imagekitio::Models::transformation_position } - class SrcOptions < Imagekit::Internal::Type::BaseModel + class SrcOptions < Imagekitio::Internal::Type::BaseModel attr_accessor src: String attr_accessor url_endpoint: String @@ -28,17 +28,17 @@ module Imagekit def signed=: (bool) -> bool - attr_reader transformation: ::Array[Imagekit::Transformation]? + attr_reader transformation: ::Array[Imagekitio::Transformation]? def transformation=: ( - ::Array[Imagekit::Transformation] - ) -> ::Array[Imagekit::Transformation] + ::Array[Imagekitio::Transformation] + ) -> ::Array[Imagekitio::Transformation] - attr_reader transformation_position: Imagekit::Models::transformation_position? + attr_reader transformation_position: Imagekitio::Models::transformation_position? def transformation_position=: ( - Imagekit::Models::transformation_position - ) -> Imagekit::Models::transformation_position + Imagekitio::Models::transformation_position + ) -> Imagekitio::Models::transformation_position def initialize: ( src: String, @@ -46,8 +46,8 @@ module Imagekit ?expires_in: Float, ?query_parameters: ::Hash[Symbol, String], ?signed: bool, - ?transformation: ::Array[Imagekit::Transformation], - ?transformation_position: Imagekit::Models::transformation_position + ?transformation: ::Array[Imagekitio::Transformation], + ?transformation_position: Imagekitio::Models::transformation_position ) -> void def to_hash: -> { @@ -56,8 +56,8 @@ module Imagekit expires_in: Float, query_parameters: ::Hash[Symbol, String], signed: bool, - transformation: ::Array[Imagekit::Transformation], - transformation_position: Imagekit::Models::transformation_position + transformation: ::Array[Imagekitio::Transformation], + transformation_position: Imagekitio::Models::transformation_position } end end diff --git a/sig/imagekit/models/streaming_resolution.rbs b/sig/imagekitio/models/streaming_resolution.rbs similarity index 76% rename from sig/imagekit/models/streaming_resolution.rbs rename to sig/imagekitio/models/streaming_resolution.rbs index 7892c2cf..71aa3716 100644 --- a/sig/imagekit/models/streaming_resolution.rbs +++ b/sig/imagekitio/models/streaming_resolution.rbs @@ -1,10 +1,10 @@ -module Imagekit +module Imagekitio module Models type streaming_resolution = :"240" | :"360" | :"480" | :"720" | :"1080" | :"1440" | :"2160" module StreamingResolution - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum STREAMING_RESOLUTION_240: :"240" STREAMING_RESOLUTION_360: :"360" @@ -14,7 +14,7 @@ module Imagekit STREAMING_RESOLUTION_1440: :"1440" STREAMING_RESOLUTION_2160: :"2160" - def self?.values: -> ::Array[Imagekit::Models::streaming_resolution] + def self?.values: -> ::Array[Imagekitio::Models::streaming_resolution] end end end diff --git a/sig/imagekitio/models/subtitle_overlay.rbs b/sig/imagekitio/models/subtitle_overlay.rbs new file mode 100644 index 00000000..e1a0c4a3 --- /dev/null +++ b/sig/imagekitio/models/subtitle_overlay.rbs @@ -0,0 +1,59 @@ +module Imagekitio + module Models + type subtitle_overlay = + { + input: String, + type: :subtitle, + encoding: Imagekitio::Models::SubtitleOverlay::encoding, + transformation: ::Array[Imagekitio::SubtitleOverlayTransformation] + } + + class SubtitleOverlay < Imagekitio::Models::BaseOverlay + def input: -> String + + def input=: (String _) -> String + + def `type`: -> :subtitle + + def type=: (:subtitle _) -> :subtitle + + def encoding: -> Imagekitio::Models::SubtitleOverlay::encoding? + + def encoding=: ( + Imagekitio::Models::SubtitleOverlay::encoding _ + ) -> Imagekitio::Models::SubtitleOverlay::encoding + + def transformation: -> ::Array[Imagekitio::SubtitleOverlayTransformation]? + + def transformation=: ( + ::Array[Imagekitio::SubtitleOverlayTransformation] _ + ) -> ::Array[Imagekitio::SubtitleOverlayTransformation] + + def initialize: ( + input: String, + ?encoding: Imagekitio::Models::SubtitleOverlay::encoding, + ?transformation: ::Array[Imagekitio::SubtitleOverlayTransformation], + ?type: :subtitle + ) -> void + + def to_hash: -> { + input: String, + type: :subtitle, + encoding: Imagekitio::Models::SubtitleOverlay::encoding, + transformation: ::Array[Imagekitio::SubtitleOverlayTransformation] + } + + type encoding = :auto | :plain | :base64 + + module Encoding + extend Imagekitio::Internal::Type::Enum + + AUTO: :auto + PLAIN: :plain + BASE64: :base64 + + def self?.values: -> ::Array[Imagekitio::Models::SubtitleOverlay::encoding] + end + end + end +end diff --git a/sig/imagekit/models/subtitle_overlay_transformation.rbs b/sig/imagekitio/models/subtitle_overlay_transformation.rbs similarity index 64% rename from sig/imagekit/models/subtitle_overlay_transformation.rbs rename to sig/imagekitio/models/subtitle_overlay_transformation.rbs index 21d04177..6425cb1b 100644 --- a/sig/imagekit/models/subtitle_overlay_transformation.rbs +++ b/sig/imagekitio/models/subtitle_overlay_transformation.rbs @@ -1,4 +1,4 @@ -module Imagekit +module Imagekitio module Models type subtitle_overlay_transformation = { @@ -8,10 +8,10 @@ module Imagekit font_outline: String, font_shadow: String, font_size: Float, - typography: Imagekit::Models::SubtitleOverlayTransformation::typography + typography: Imagekitio::Models::SubtitleOverlayTransformation::typography } - class SubtitleOverlayTransformation < Imagekit::Internal::Type::BaseModel + class SubtitleOverlayTransformation < Imagekitio::Internal::Type::BaseModel attr_reader background: String? def background=: (String) -> String @@ -36,11 +36,11 @@ module Imagekit def font_size=: (Float) -> Float - attr_reader typography: Imagekit::Models::SubtitleOverlayTransformation::typography? + attr_reader typography: Imagekitio::Models::SubtitleOverlayTransformation::typography? def typography=: ( - Imagekit::Models::SubtitleOverlayTransformation::typography - ) -> Imagekit::Models::SubtitleOverlayTransformation::typography + Imagekitio::Models::SubtitleOverlayTransformation::typography + ) -> Imagekitio::Models::SubtitleOverlayTransformation::typography def initialize: ( ?background: String, @@ -49,7 +49,7 @@ module Imagekit ?font_outline: String, ?font_shadow: String, ?font_size: Float, - ?typography: Imagekit::Models::SubtitleOverlayTransformation::typography + ?typography: Imagekitio::Models::SubtitleOverlayTransformation::typography ) -> void def to_hash: -> { @@ -59,19 +59,19 @@ module Imagekit font_outline: String, font_shadow: String, font_size: Float, - typography: Imagekit::Models::SubtitleOverlayTransformation::typography + typography: Imagekitio::Models::SubtitleOverlayTransformation::typography } type typography = :b | :i | :b_i module Typography - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum B: :b I: :i B_I: :b_i - def self?.values: -> ::Array[Imagekit::Models::SubtitleOverlayTransformation::typography] + def self?.values: -> ::Array[Imagekitio::Models::SubtitleOverlayTransformation::typography] end end end diff --git a/sig/imagekitio/models/text_overlay.rbs b/sig/imagekitio/models/text_overlay.rbs new file mode 100644 index 00000000..d37c727c --- /dev/null +++ b/sig/imagekitio/models/text_overlay.rbs @@ -0,0 +1,59 @@ +module Imagekitio + module Models + type text_overlay = + { + text: String, + type: :text, + encoding: Imagekitio::Models::TextOverlay::encoding, + transformation: ::Array[Imagekitio::TextOverlayTransformation] + } + + class TextOverlay < Imagekitio::Models::BaseOverlay + def text: -> String + + def text=: (String _) -> String + + def `type`: -> :text + + def type=: (:text _) -> :text + + def encoding: -> Imagekitio::Models::TextOverlay::encoding? + + def encoding=: ( + Imagekitio::Models::TextOverlay::encoding _ + ) -> Imagekitio::Models::TextOverlay::encoding + + def transformation: -> ::Array[Imagekitio::TextOverlayTransformation]? + + def transformation=: ( + ::Array[Imagekitio::TextOverlayTransformation] _ + ) -> ::Array[Imagekitio::TextOverlayTransformation] + + def initialize: ( + text: String, + ?encoding: Imagekitio::Models::TextOverlay::encoding, + ?transformation: ::Array[Imagekitio::TextOverlayTransformation], + ?type: :text + ) -> void + + def to_hash: -> { + text: String, + type: :text, + encoding: Imagekitio::Models::TextOverlay::encoding, + transformation: ::Array[Imagekitio::TextOverlayTransformation] + } + + type encoding = :auto | :plain | :base64 + + module Encoding + extend Imagekitio::Internal::Type::Enum + + AUTO: :auto + PLAIN: :plain + BASE64: :base64 + + def self?.values: -> ::Array[Imagekitio::Models::TextOverlay::encoding] + end + end + end +end diff --git a/sig/imagekitio/models/text_overlay_transformation.rbs b/sig/imagekitio/models/text_overlay_transformation.rbs new file mode 100644 index 00000000..ab827889 --- /dev/null +++ b/sig/imagekitio/models/text_overlay_transformation.rbs @@ -0,0 +1,195 @@ +module Imagekitio + module Models + type text_overlay_transformation = + { + alpha: Float, + background: String, + flip: Imagekitio::Models::TextOverlayTransformation::flip, + font_color: String, + font_family: String, + font_size: Imagekitio::Models::TextOverlayTransformation::font_size, + inner_alignment: Imagekitio::Models::TextOverlayTransformation::inner_alignment, + line_height: Imagekitio::Models::TextOverlayTransformation::line_height, + padding: Imagekitio::Models::TextOverlayTransformation::padding, + radius: Imagekitio::Models::TextOverlayTransformation::radius, + rotation: Imagekitio::Models::TextOverlayTransformation::rotation, + typography: String, + width: Imagekitio::Models::TextOverlayTransformation::width + } + + class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel + attr_reader alpha: Float? + + def alpha=: (Float) -> Float + + attr_reader background: String? + + def background=: (String) -> String + + attr_reader flip: Imagekitio::Models::TextOverlayTransformation::flip? + + def flip=: ( + Imagekitio::Models::TextOverlayTransformation::flip + ) -> Imagekitio::Models::TextOverlayTransformation::flip + + attr_reader font_color: String? + + def font_color=: (String) -> String + + attr_reader font_family: String? + + def font_family=: (String) -> String + + attr_reader font_size: Imagekitio::Models::TextOverlayTransformation::font_size? + + def font_size=: ( + Imagekitio::Models::TextOverlayTransformation::font_size + ) -> Imagekitio::Models::TextOverlayTransformation::font_size + + attr_reader inner_alignment: Imagekitio::Models::TextOverlayTransformation::inner_alignment? + + def inner_alignment=: ( + Imagekitio::Models::TextOverlayTransformation::inner_alignment + ) -> Imagekitio::Models::TextOverlayTransformation::inner_alignment + + attr_reader line_height: Imagekitio::Models::TextOverlayTransformation::line_height? + + def line_height=: ( + Imagekitio::Models::TextOverlayTransformation::line_height + ) -> Imagekitio::Models::TextOverlayTransformation::line_height + + attr_reader padding: Imagekitio::Models::TextOverlayTransformation::padding? + + def padding=: ( + Imagekitio::Models::TextOverlayTransformation::padding + ) -> Imagekitio::Models::TextOverlayTransformation::padding + + attr_reader radius: Imagekitio::Models::TextOverlayTransformation::radius? + + def radius=: ( + Imagekitio::Models::TextOverlayTransformation::radius + ) -> Imagekitio::Models::TextOverlayTransformation::radius + + attr_reader rotation: Imagekitio::Models::TextOverlayTransformation::rotation? + + def rotation=: ( + Imagekitio::Models::TextOverlayTransformation::rotation + ) -> Imagekitio::Models::TextOverlayTransformation::rotation + + attr_reader typography: String? + + def typography=: (String) -> String + + attr_reader width: Imagekitio::Models::TextOverlayTransformation::width? + + def width=: ( + Imagekitio::Models::TextOverlayTransformation::width + ) -> Imagekitio::Models::TextOverlayTransformation::width + + def initialize: ( + ?alpha: Float, + ?background: String, + ?flip: Imagekitio::Models::TextOverlayTransformation::flip, + ?font_color: String, + ?font_family: String, + ?font_size: Imagekitio::Models::TextOverlayTransformation::font_size, + ?inner_alignment: Imagekitio::Models::TextOverlayTransformation::inner_alignment, + ?line_height: Imagekitio::Models::TextOverlayTransformation::line_height, + ?padding: Imagekitio::Models::TextOverlayTransformation::padding, + ?radius: Imagekitio::Models::TextOverlayTransformation::radius, + ?rotation: Imagekitio::Models::TextOverlayTransformation::rotation, + ?typography: String, + ?width: Imagekitio::Models::TextOverlayTransformation::width + ) -> void + + def to_hash: -> { + alpha: Float, + background: String, + flip: Imagekitio::Models::TextOverlayTransformation::flip, + font_color: String, + font_family: String, + font_size: Imagekitio::Models::TextOverlayTransformation::font_size, + inner_alignment: Imagekitio::Models::TextOverlayTransformation::inner_alignment, + line_height: Imagekitio::Models::TextOverlayTransformation::line_height, + padding: Imagekitio::Models::TextOverlayTransformation::padding, + radius: Imagekitio::Models::TextOverlayTransformation::radius, + rotation: Imagekitio::Models::TextOverlayTransformation::rotation, + typography: String, + width: Imagekitio::Models::TextOverlayTransformation::width + } + + type flip = :h | :v | :h_v | :v_h + + module Flip + extend Imagekitio::Internal::Type::Enum + + H: :h + V: :v + H_V: :h_v + V_H: :v_h + + def self?.values: -> ::Array[Imagekitio::Models::TextOverlayTransformation::flip] + end + + type font_size = Float | String + + module FontSize + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::TextOverlayTransformation::font_size] + end + + type inner_alignment = :left | :right | :center + + module InnerAlignment + extend Imagekitio::Internal::Type::Enum + + LEFT: :left + RIGHT: :right + CENTER: :center + + def self?.values: -> ::Array[Imagekitio::Models::TextOverlayTransformation::inner_alignment] + end + + type line_height = Float | String + + module LineHeight + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::TextOverlayTransformation::line_height] + end + + type padding = Float | String + + module Padding + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::TextOverlayTransformation::padding] + end + + type radius = Float | :max + + module Radius + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::TextOverlayTransformation::radius] + end + + type rotation = Float | String + + module Rotation + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::TextOverlayTransformation::rotation] + end + + type width = Float | String + + module Width + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::TextOverlayTransformation::width] + end + end + end +end diff --git a/sig/imagekitio/models/transformation.rbs b/sig/imagekitio/models/transformation.rbs new file mode 100644 index 00000000..8b3f4637 --- /dev/null +++ b/sig/imagekitio/models/transformation.rbs @@ -0,0 +1,763 @@ +module Imagekitio + module Models + type transformation = + { + ai_change_background: String, + ai_drop_shadow: Imagekitio::Models::Transformation::ai_drop_shadow, + ai_edit: String, + ai_remove_background: Imagekitio::Models::Transformation::ai_remove_background, + ai_remove_background_external: Imagekitio::Models::Transformation::ai_remove_background_external, + ai_retouch: Imagekitio::Models::Transformation::ai_retouch, + ai_upscale: Imagekitio::Models::Transformation::ai_upscale, + ai_variation: Imagekitio::Models::Transformation::ai_variation, + aspect_ratio: Imagekitio::Models::Transformation::aspect_ratio, + audio_codec: Imagekitio::Models::Transformation::audio_codec, + background: String, + blur: Float, + border: String, + color_profile: bool, + contrast_stretch: Imagekitio::Models::Transformation::contrast_stretch, + crop: Imagekitio::Models::Transformation::crop, + crop_mode: Imagekitio::Models::Transformation::crop_mode, + default_image: String, + dpr: Float, + duration: Imagekitio::Models::Transformation::duration, + end_offset: Imagekitio::Models::Transformation::end_offset, + flip: Imagekitio::Models::Transformation::flip, + focus: String, + format_: Imagekitio::Models::Transformation::format_, + gradient: Imagekitio::Models::Transformation::gradient, + grayscale: Imagekitio::Models::Transformation::grayscale, + height: Imagekitio::Models::Transformation::height, + lossless: bool, + metadata: bool, + named: String, + opacity: Float, + original: bool, + overlay: Imagekitio::Models::overlay, + page: Imagekitio::Models::Transformation::page, + progressive: bool, + quality: Float, + radius: Imagekitio::Models::Transformation::radius, + raw: String, + rotation: Imagekitio::Models::Transformation::rotation, + shadow: Imagekitio::Models::Transformation::shadow, + sharpen: Imagekitio::Models::Transformation::sharpen, + start_offset: Imagekitio::Models::Transformation::start_offset, + streaming_resolutions: ::Array[Imagekitio::Models::streaming_resolution], + trim: Imagekitio::Models::Transformation::trim, + unsharp_mask: Imagekitio::Models::Transformation::unsharp_mask, + video_codec: Imagekitio::Models::Transformation::video_codec, + width: Imagekitio::Models::Transformation::width, + x: Imagekitio::Models::Transformation::x, + x_center: Imagekitio::Models::Transformation::x_center, + y_: Imagekitio::Models::Transformation::y_, + y_center: Imagekitio::Models::Transformation::y_center, + zoom: Float + } + + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_reader ai_change_background: String? + + def ai_change_background=: (String) -> String + + attr_reader ai_drop_shadow: Imagekitio::Models::Transformation::ai_drop_shadow? + + def ai_drop_shadow=: ( + Imagekitio::Models::Transformation::ai_drop_shadow + ) -> Imagekitio::Models::Transformation::ai_drop_shadow + + attr_reader ai_edit: String? + + def ai_edit=: (String) -> String + + attr_reader ai_remove_background: Imagekitio::Models::Transformation::ai_remove_background? + + def ai_remove_background=: ( + Imagekitio::Models::Transformation::ai_remove_background + ) -> Imagekitio::Models::Transformation::ai_remove_background + + attr_reader ai_remove_background_external: Imagekitio::Models::Transformation::ai_remove_background_external? + + def ai_remove_background_external=: ( + Imagekitio::Models::Transformation::ai_remove_background_external + ) -> Imagekitio::Models::Transformation::ai_remove_background_external + + attr_reader ai_retouch: Imagekitio::Models::Transformation::ai_retouch? + + def ai_retouch=: ( + Imagekitio::Models::Transformation::ai_retouch + ) -> Imagekitio::Models::Transformation::ai_retouch + + attr_reader ai_upscale: Imagekitio::Models::Transformation::ai_upscale? + + def ai_upscale=: ( + Imagekitio::Models::Transformation::ai_upscale + ) -> Imagekitio::Models::Transformation::ai_upscale + + attr_reader ai_variation: Imagekitio::Models::Transformation::ai_variation? + + def ai_variation=: ( + Imagekitio::Models::Transformation::ai_variation + ) -> Imagekitio::Models::Transformation::ai_variation + + attr_reader aspect_ratio: Imagekitio::Models::Transformation::aspect_ratio? + + def aspect_ratio=: ( + Imagekitio::Models::Transformation::aspect_ratio + ) -> Imagekitio::Models::Transformation::aspect_ratio + + attr_reader audio_codec: Imagekitio::Models::Transformation::audio_codec? + + def audio_codec=: ( + Imagekitio::Models::Transformation::audio_codec + ) -> Imagekitio::Models::Transformation::audio_codec + + attr_reader background: String? + + def background=: (String) -> String + + attr_reader blur: Float? + + def blur=: (Float) -> Float + + attr_reader border: String? + + def border=: (String) -> String + + attr_reader color_profile: bool? + + def color_profile=: (bool) -> bool + + attr_reader contrast_stretch: Imagekitio::Models::Transformation::contrast_stretch? + + def contrast_stretch=: ( + Imagekitio::Models::Transformation::contrast_stretch + ) -> Imagekitio::Models::Transformation::contrast_stretch + + attr_reader crop: Imagekitio::Models::Transformation::crop? + + def crop=: ( + Imagekitio::Models::Transformation::crop + ) -> Imagekitio::Models::Transformation::crop + + attr_reader crop_mode: Imagekitio::Models::Transformation::crop_mode? + + def crop_mode=: ( + Imagekitio::Models::Transformation::crop_mode + ) -> Imagekitio::Models::Transformation::crop_mode + + attr_reader default_image: String? + + def default_image=: (String) -> String + + attr_reader dpr: Float? + + def dpr=: (Float) -> Float + + attr_reader duration: Imagekitio::Models::Transformation::duration? + + def duration=: ( + Imagekitio::Models::Transformation::duration + ) -> Imagekitio::Models::Transformation::duration + + attr_reader end_offset: Imagekitio::Models::Transformation::end_offset? + + def end_offset=: ( + Imagekitio::Models::Transformation::end_offset + ) -> Imagekitio::Models::Transformation::end_offset + + attr_reader flip: Imagekitio::Models::Transformation::flip? + + def flip=: ( + Imagekitio::Models::Transformation::flip + ) -> Imagekitio::Models::Transformation::flip + + attr_reader focus: String? + + def focus=: (String) -> String + + attr_reader format_: Imagekitio::Models::Transformation::format_? + + def format_=: ( + Imagekitio::Models::Transformation::format_ + ) -> Imagekitio::Models::Transformation::format_ + + attr_reader gradient: Imagekitio::Models::Transformation::gradient? + + def gradient=: ( + Imagekitio::Models::Transformation::gradient + ) -> Imagekitio::Models::Transformation::gradient + + attr_reader grayscale: Imagekitio::Models::Transformation::grayscale? + + def grayscale=: ( + Imagekitio::Models::Transformation::grayscale + ) -> Imagekitio::Models::Transformation::grayscale + + attr_reader height: Imagekitio::Models::Transformation::height? + + def height=: ( + Imagekitio::Models::Transformation::height + ) -> Imagekitio::Models::Transformation::height + + attr_reader lossless: bool? + + def lossless=: (bool) -> bool + + attr_reader metadata: bool? + + def metadata=: (bool) -> bool + + attr_reader named: String? + + def named=: (String) -> String + + attr_reader opacity: Float? + + def opacity=: (Float) -> Float + + attr_reader original: bool? + + def original=: (bool) -> bool + + attr_reader overlay: Imagekitio::Models::overlay? + + def overlay=: (Imagekitio::Models::overlay) -> Imagekitio::Models::overlay + + attr_reader page: Imagekitio::Models::Transformation::page? + + def page=: ( + Imagekitio::Models::Transformation::page + ) -> Imagekitio::Models::Transformation::page + + attr_reader progressive: bool? + + def progressive=: (bool) -> bool + + attr_reader quality: Float? + + def quality=: (Float) -> Float + + attr_reader radius: Imagekitio::Models::Transformation::radius? + + def radius=: ( + Imagekitio::Models::Transformation::radius + ) -> Imagekitio::Models::Transformation::radius + + attr_reader raw: String? + + def raw=: (String) -> String + + attr_reader rotation: Imagekitio::Models::Transformation::rotation? + + def rotation=: ( + Imagekitio::Models::Transformation::rotation + ) -> Imagekitio::Models::Transformation::rotation + + attr_reader shadow: Imagekitio::Models::Transformation::shadow? + + def shadow=: ( + Imagekitio::Models::Transformation::shadow + ) -> Imagekitio::Models::Transformation::shadow + + attr_reader sharpen: Imagekitio::Models::Transformation::sharpen? + + def sharpen=: ( + Imagekitio::Models::Transformation::sharpen + ) -> Imagekitio::Models::Transformation::sharpen + + attr_reader start_offset: Imagekitio::Models::Transformation::start_offset? + + def start_offset=: ( + Imagekitio::Models::Transformation::start_offset + ) -> Imagekitio::Models::Transformation::start_offset + + attr_reader streaming_resolutions: ::Array[Imagekitio::Models::streaming_resolution]? + + def streaming_resolutions=: ( + ::Array[Imagekitio::Models::streaming_resolution] + ) -> ::Array[Imagekitio::Models::streaming_resolution] + + attr_reader trim: Imagekitio::Models::Transformation::trim? + + def trim=: ( + Imagekitio::Models::Transformation::trim + ) -> Imagekitio::Models::Transformation::trim + + attr_reader unsharp_mask: Imagekitio::Models::Transformation::unsharp_mask? + + def unsharp_mask=: ( + Imagekitio::Models::Transformation::unsharp_mask + ) -> Imagekitio::Models::Transformation::unsharp_mask + + attr_reader video_codec: Imagekitio::Models::Transformation::video_codec? + + def video_codec=: ( + Imagekitio::Models::Transformation::video_codec + ) -> Imagekitio::Models::Transformation::video_codec + + attr_reader width: Imagekitio::Models::Transformation::width? + + def width=: ( + Imagekitio::Models::Transformation::width + ) -> Imagekitio::Models::Transformation::width + + attr_reader x: Imagekitio::Models::Transformation::x? + + def x=: ( + Imagekitio::Models::Transformation::x + ) -> Imagekitio::Models::Transformation::x + + attr_reader x_center: Imagekitio::Models::Transformation::x_center? + + def x_center=: ( + Imagekitio::Models::Transformation::x_center + ) -> Imagekitio::Models::Transformation::x_center + + attr_reader y_: Imagekitio::Models::Transformation::y_? + + def y_=: ( + Imagekitio::Models::Transformation::y_ + ) -> Imagekitio::Models::Transformation::y_ + + attr_reader y_center: Imagekitio::Models::Transformation::y_center? + + def y_center=: ( + Imagekitio::Models::Transformation::y_center + ) -> Imagekitio::Models::Transformation::y_center + + attr_reader zoom: Float? + + def zoom=: (Float) -> Float + + def initialize: ( + ?ai_change_background: String, + ?ai_drop_shadow: Imagekitio::Models::Transformation::ai_drop_shadow, + ?ai_edit: String, + ?ai_remove_background: Imagekitio::Models::Transformation::ai_remove_background, + ?ai_remove_background_external: Imagekitio::Models::Transformation::ai_remove_background_external, + ?ai_retouch: Imagekitio::Models::Transformation::ai_retouch, + ?ai_upscale: Imagekitio::Models::Transformation::ai_upscale, + ?ai_variation: Imagekitio::Models::Transformation::ai_variation, + ?aspect_ratio: Imagekitio::Models::Transformation::aspect_ratio, + ?audio_codec: Imagekitio::Models::Transformation::audio_codec, + ?background: String, + ?blur: Float, + ?border: String, + ?color_profile: bool, + ?contrast_stretch: Imagekitio::Models::Transformation::contrast_stretch, + ?crop: Imagekitio::Models::Transformation::crop, + ?crop_mode: Imagekitio::Models::Transformation::crop_mode, + ?default_image: String, + ?dpr: Float, + ?duration: Imagekitio::Models::Transformation::duration, + ?end_offset: Imagekitio::Models::Transformation::end_offset, + ?flip: Imagekitio::Models::Transformation::flip, + ?focus: String, + ?format_: Imagekitio::Models::Transformation::format_, + ?gradient: Imagekitio::Models::Transformation::gradient, + ?grayscale: Imagekitio::Models::Transformation::grayscale, + ?height: Imagekitio::Models::Transformation::height, + ?lossless: bool, + ?metadata: bool, + ?named: String, + ?opacity: Float, + ?original: bool, + ?overlay: Imagekitio::Models::overlay, + ?page: Imagekitio::Models::Transformation::page, + ?progressive: bool, + ?quality: Float, + ?radius: Imagekitio::Models::Transformation::radius, + ?raw: String, + ?rotation: Imagekitio::Models::Transformation::rotation, + ?shadow: Imagekitio::Models::Transformation::shadow, + ?sharpen: Imagekitio::Models::Transformation::sharpen, + ?start_offset: Imagekitio::Models::Transformation::start_offset, + ?streaming_resolutions: ::Array[Imagekitio::Models::streaming_resolution], + ?trim: Imagekitio::Models::Transformation::trim, + ?unsharp_mask: Imagekitio::Models::Transformation::unsharp_mask, + ?video_codec: Imagekitio::Models::Transformation::video_codec, + ?width: Imagekitio::Models::Transformation::width, + ?x: Imagekitio::Models::Transformation::x, + ?x_center: Imagekitio::Models::Transformation::x_center, + ?y_: Imagekitio::Models::Transformation::y_, + ?y_center: Imagekitio::Models::Transformation::y_center, + ?zoom: Float + ) -> void + + def to_hash: -> { + ai_change_background: String, + ai_drop_shadow: Imagekitio::Models::Transformation::ai_drop_shadow, + ai_edit: String, + ai_remove_background: Imagekitio::Models::Transformation::ai_remove_background, + ai_remove_background_external: Imagekitio::Models::Transformation::ai_remove_background_external, + ai_retouch: Imagekitio::Models::Transformation::ai_retouch, + ai_upscale: Imagekitio::Models::Transformation::ai_upscale, + ai_variation: Imagekitio::Models::Transformation::ai_variation, + aspect_ratio: Imagekitio::Models::Transformation::aspect_ratio, + audio_codec: Imagekitio::Models::Transformation::audio_codec, + background: String, + blur: Float, + border: String, + color_profile: bool, + contrast_stretch: Imagekitio::Models::Transformation::contrast_stretch, + crop: Imagekitio::Models::Transformation::crop, + crop_mode: Imagekitio::Models::Transformation::crop_mode, + default_image: String, + dpr: Float, + duration: Imagekitio::Models::Transformation::duration, + end_offset: Imagekitio::Models::Transformation::end_offset, + flip: Imagekitio::Models::Transformation::flip, + focus: String, + format_: Imagekitio::Models::Transformation::format_, + gradient: Imagekitio::Models::Transformation::gradient, + grayscale: Imagekitio::Models::Transformation::grayscale, + height: Imagekitio::Models::Transformation::height, + lossless: bool, + metadata: bool, + named: String, + opacity: Float, + original: bool, + overlay: Imagekitio::Models::overlay, + page: Imagekitio::Models::Transformation::page, + progressive: bool, + quality: Float, + radius: Imagekitio::Models::Transformation::radius, + raw: String, + rotation: Imagekitio::Models::Transformation::rotation, + shadow: Imagekitio::Models::Transformation::shadow, + sharpen: Imagekitio::Models::Transformation::sharpen, + start_offset: Imagekitio::Models::Transformation::start_offset, + streaming_resolutions: ::Array[Imagekitio::Models::streaming_resolution], + trim: Imagekitio::Models::Transformation::trim, + unsharp_mask: Imagekitio::Models::Transformation::unsharp_mask, + video_codec: Imagekitio::Models::Transformation::video_codec, + width: Imagekitio::Models::Transformation::width, + x: Imagekitio::Models::Transformation::x, + x_center: Imagekitio::Models::Transformation::x_center, + y_: Imagekitio::Models::Transformation::y_, + y_center: Imagekitio::Models::Transformation::y_center, + zoom: Float + } + + type ai_drop_shadow = true | String + + module AIDropShadow + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::ai_drop_shadow] + end + + type ai_remove_background = true + + module AIRemoveBackground + extend Imagekitio::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::ai_remove_background] + end + + type ai_remove_background_external = true + + module AIRemoveBackgroundExternal + extend Imagekitio::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::ai_remove_background_external] + end + + type ai_retouch = true + + module AIRetouch + extend Imagekitio::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::ai_retouch] + end + + type ai_upscale = true + + module AIUpscale + extend Imagekitio::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::ai_upscale] + end + + type ai_variation = true + + module AIVariation + extend Imagekitio::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::ai_variation] + end + + type aspect_ratio = Float | String + + module AspectRatio + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::aspect_ratio] + end + + type audio_codec = :aac | :opus | :none + + module AudioCodec + extend Imagekitio::Internal::Type::Enum + + AAC: :aac + OPUS: :opus + NONE: :none + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::audio_codec] + end + + type contrast_stretch = true + + module ContrastStretch + extend Imagekitio::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::contrast_stretch] + end + + type crop = + :force | :at_max | :at_max_enlarge | :at_least | :maintain_ratio + + module Crop + extend Imagekitio::Internal::Type::Enum + + FORCE: :force + AT_MAX: :at_max + AT_MAX_ENLARGE: :at_max_enlarge + AT_LEAST: :at_least + MAINTAIN_RATIO: :maintain_ratio + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::crop] + end + + type crop_mode = :pad_resize | :extract | :pad_extract + + module CropMode + extend Imagekitio::Internal::Type::Enum + + PAD_RESIZE: :pad_resize + EXTRACT: :extract + PAD_EXTRACT: :pad_extract + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::crop_mode] + end + + type duration = Float | String + + module Duration + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::duration] + end + + type end_offset = Float | String + + module EndOffset + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::end_offset] + end + + type flip = :h | :v | :h_v | :v_h + + module Flip + extend Imagekitio::Internal::Type::Enum + + H: :h + V: :v + H_V: :h_v + V_H: :v_h + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::flip] + end + + type format_ = + :auto + | :webp + | :jpg + | :jpeg + | :png + | :gif + | :svg + | :mp4 + | :webm + | :avif + | :orig + + module Format + extend Imagekitio::Internal::Type::Enum + + AUTO: :auto + WEBP: :webp + JPG: :jpg + JPEG: :jpeg + PNG: :png + GIF: :gif + SVG: :svg + MP4: :mp4 + WEBM: :webm + AVIF: :avif + ORIG: :orig + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::format_] + end + + type gradient = true | String + + module Gradient + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::gradient] + end + + type grayscale = true + + module Grayscale + extend Imagekitio::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::grayscale] + end + + type height = Float | String + + module Height + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::height] + end + + type page = Float | String + + module Page + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::page] + end + + type radius = Float | :max + + module Radius + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::radius] + end + + type rotation = Float | String + + module Rotation + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::rotation] + end + + type shadow = true | String + + module Shadow + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::shadow] + end + + type sharpen = true | Float + + module Sharpen + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::sharpen] + end + + type start_offset = Float | String + + module StartOffset + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::start_offset] + end + + type trim = true | Float + + module Trim + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::trim] + end + + type unsharp_mask = true | String + + module UnsharpMask + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::unsharp_mask] + end + + type video_codec = :h264 | :vp9 | :av1 | :none + + module VideoCodec + extend Imagekitio::Internal::Type::Enum + + H264: :h264 + VP9: :vp9 + AV1: :av1 + NONE: :none + + def self?.values: -> ::Array[Imagekitio::Models::Transformation::video_codec] + end + + type width = Float | String + + module Width + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::width] + end + + type x = Float | String + + module X + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::x] + end + + type x_center = Float | String + + module XCenter + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::x_center] + end + + type y_ = Float | String + + module Y + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::y_] + end + + type y_center = Float | String + + module YCenter + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::Transformation::y_center] + end + end + end +end diff --git a/sig/imagekit/models/transformation_position.rbs b/sig/imagekitio/models/transformation_position.rbs similarity index 52% rename from sig/imagekit/models/transformation_position.rbs rename to sig/imagekitio/models/transformation_position.rbs index 60ed3513..9ba3ff1b 100644 --- a/sig/imagekit/models/transformation_position.rbs +++ b/sig/imagekitio/models/transformation_position.rbs @@ -1,14 +1,14 @@ -module Imagekit +module Imagekitio module Models type transformation_position = :path | :query module TransformationPosition - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum PATH: :path QUERY: :query - def self?.values: -> ::Array[Imagekit::Models::transformation_position] + def self?.values: -> ::Array[Imagekitio::Models::transformation_position] end end end diff --git a/sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs b/sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs new file mode 100644 index 00000000..12322bc6 --- /dev/null +++ b/sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs @@ -0,0 +1,18 @@ +module Imagekitio + module Models + type unsafe_unwrap_webhook_event = + Imagekitio::VideoTransformationAcceptedEvent + | Imagekitio::VideoTransformationReadyEvent + | Imagekitio::VideoTransformationErrorEvent + | Imagekitio::UploadPreTransformSuccessEvent + | Imagekitio::UploadPreTransformErrorEvent + | Imagekitio::UploadPostTransformSuccessEvent + | Imagekitio::UploadPostTransformErrorEvent + + module UnsafeUnwrapWebhookEvent + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::unsafe_unwrap_webhook_event] + end + end +end diff --git a/sig/imagekitio/models/unwrap_webhook_event.rbs b/sig/imagekitio/models/unwrap_webhook_event.rbs new file mode 100644 index 00000000..f6d1bbc3 --- /dev/null +++ b/sig/imagekitio/models/unwrap_webhook_event.rbs @@ -0,0 +1,18 @@ +module Imagekitio + module Models + type unwrap_webhook_event = + Imagekitio::VideoTransformationAcceptedEvent + | Imagekitio::VideoTransformationReadyEvent + | Imagekitio::VideoTransformationErrorEvent + | Imagekitio::UploadPreTransformSuccessEvent + | Imagekitio::UploadPreTransformErrorEvent + | Imagekitio::UploadPostTransformSuccessEvent + | Imagekitio::UploadPostTransformErrorEvent + + module UnwrapWebhookEvent + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::unwrap_webhook_event] + end + end +end diff --git a/sig/imagekitio/models/update_file_request.rbs b/sig/imagekitio/models/update_file_request.rbs new file mode 100644 index 00000000..59d6a827 --- /dev/null +++ b/sig/imagekitio/models/update_file_request.rbs @@ -0,0 +1,122 @@ +module Imagekitio + module Models + type update_file_request = + Imagekitio::UpdateFileRequest::UpdateFileDetails + | Imagekitio::UpdateFileRequest::ChangePublicationStatus + + module UpdateFileRequest + extend Imagekitio::Internal::Type::Union + + type update_file_details = + { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: Imagekitio::Models::extensions, + remove_ai_tags: Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String + } + + class UpdateFileDetails < Imagekitio::Internal::Type::BaseModel + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader extensions: Imagekitio::Models::extensions? + + def extensions=: ( + Imagekitio::Models::extensions + ) -> Imagekitio::Models::extensions + + attr_reader remove_ai_tags: Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags? + + def remove_ai_tags=: ( + Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags + ) -> Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags + + attr_accessor tags: ::Array[String]? + + attr_reader webhook_url: String? + + def webhook_url=: (String) -> String + + def initialize: ( + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?extensions: Imagekitio::Models::extensions, + ?remove_ai_tags: Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, + ?tags: ::Array[String]?, + ?webhook_url: String + ) -> void + + def to_hash: -> { + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + extensions: Imagekitio::Models::extensions, + remove_ai_tags: Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags, + tags: ::Array[String]?, + webhook_url: String + } + + type remove_ai_tags = ::Array[String] | :all + + module RemoveAITags + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::remove_ai_tags] + + StringArray: Imagekitio::Internal::Type::Converter + end + end + + type change_publication_status = + { + publish: Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish + } + + class ChangePublicationStatus < Imagekitio::Internal::Type::BaseModel + attr_reader publish: Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish? + + def publish=: ( + Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish + ) -> Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish + + def initialize: ( + ?publish: Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish + ) -> void + + def to_hash: -> { + publish: Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish + } + + type publish = { is_published: bool, include_file_versions: bool } + + class Publish < Imagekitio::Internal::Type::BaseModel + attr_accessor is_published: bool + + attr_reader include_file_versions: bool? + + def include_file_versions=: (bool) -> bool + + def initialize: ( + is_published: bool, + ?include_file_versions: bool + ) -> void + + def to_hash: -> { is_published: bool, include_file_versions: bool } + end + end + + def self?.variants: -> ::Array[Imagekitio::Models::update_file_request] + end + end +end diff --git a/sig/imagekitio/models/upload_post_transform_error_event.rbs b/sig/imagekitio/models/upload_post_transform_error_event.rbs new file mode 100644 index 00000000..f22bc0a2 --- /dev/null +++ b/sig/imagekitio/models/upload_post_transform_error_event.rbs @@ -0,0 +1,192 @@ +module Imagekitio + module Models + type upload_post_transform_error_event = + { + created_at: Time, + data: Imagekitio::UploadPostTransformErrorEvent::Data, + request: Imagekitio::UploadPostTransformErrorEvent::Request, + type: :"upload.post-transform.error" + } + + class UploadPostTransformErrorEvent < Imagekitio::Models::BaseWebhookEvent + def created_at: -> Time + + def created_at=: (Time _) -> Time + + def data: -> Imagekitio::UploadPostTransformErrorEvent::Data + + def data=: ( + Imagekitio::UploadPostTransformErrorEvent::Data _ + ) -> Imagekitio::UploadPostTransformErrorEvent::Data + + def request: -> Imagekitio::UploadPostTransformErrorEvent::Request + + def request=: ( + Imagekitio::UploadPostTransformErrorEvent::Request _ + ) -> Imagekitio::UploadPostTransformErrorEvent::Request + + def `type`: -> :"upload.post-transform.error" + + def type=: ( + :"upload.post-transform.error" _ + ) -> :"upload.post-transform.error" + + def initialize: ( + created_at: Time, + data: Imagekitio::UploadPostTransformErrorEvent::Data, + request: Imagekitio::UploadPostTransformErrorEvent::Request, + ?type: :"upload.post-transform.error" + ) -> void + + def to_hash: -> { + created_at: Time, + data: Imagekitio::UploadPostTransformErrorEvent::Data, + request: Imagekitio::UploadPostTransformErrorEvent::Request, + type: :"upload.post-transform.error" + } + + type data = + { + file_id: String, + name: String, + path: String, + transformation: Imagekitio::UploadPostTransformErrorEvent::Data::Transformation, + url: String + } + + class Data < Imagekitio::Internal::Type::BaseModel + attr_accessor file_id: String + + attr_accessor name: String + + attr_accessor path: String + + attr_accessor transformation: Imagekitio::UploadPostTransformErrorEvent::Data::Transformation + + attr_accessor url: String + + def initialize: ( + file_id: String, + name: String, + path: String, + transformation: Imagekitio::UploadPostTransformErrorEvent::Data::Transformation, + url: String + ) -> void + + def to_hash: -> { + file_id: String, + name: String, + path: String, + transformation: Imagekitio::UploadPostTransformErrorEvent::Data::Transformation, + url: String + } + + type transformation = + { + error: Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error + } + + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_accessor error: Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error + + def initialize: ( + error: Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error + ) -> void + + def to_hash: -> { + error: Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error + } + + type error = { reason: String } + + class Error < Imagekitio::Internal::Type::BaseModel + attr_accessor reason: String + + def initialize: (reason: String) -> void + + def to_hash: -> { reason: String } + end + end + end + + type request = + { + transformation: Imagekitio::UploadPostTransformErrorEvent::Request::Transformation, + x_request_id: String + } + + class Request < Imagekitio::Internal::Type::BaseModel + attr_accessor transformation: Imagekitio::UploadPostTransformErrorEvent::Request::Transformation + + attr_accessor x_request_id: String + + def initialize: ( + transformation: Imagekitio::UploadPostTransformErrorEvent::Request::Transformation, + x_request_id: String + ) -> void + + def to_hash: -> { + transformation: Imagekitio::UploadPostTransformErrorEvent::Request::Transformation, + x_request_id: String + } + + type transformation = + { + type: Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, + protocol: Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, + value: String + } + + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::type_ + + attr_reader protocol: Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol? + + def protocol=: ( + Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol + ) -> Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol + + attr_reader value: String? + + def value=: (String) -> String + + def initialize: ( + type: Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, + ?protocol: Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, + ?value: String + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::type_, + protocol: Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol, + value: String + } + + type type_ = :transformation | :abs | :"gif-to-video" | :thumbnail + + module Type + extend Imagekitio::Internal::Type::Enum + + TRANSFORMATION: :transformation + ABS: :abs + GIF_TO_VIDEO: :"gif-to-video" + THUMBNAIL: :thumbnail + + def self?.values: -> ::Array[Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::type_] + end + + type protocol = :hls | :dash + + module Protocol + extend Imagekitio::Internal::Type::Enum + + HLS: :hls + DASH: :dash + + def self?.values: -> ::Array[Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::protocol] + end + end + end + end + end +end diff --git a/sig/imagekitio/models/upload_post_transform_success_event.rbs b/sig/imagekitio/models/upload_post_transform_success_event.rbs new file mode 100644 index 00000000..5eb891f8 --- /dev/null +++ b/sig/imagekitio/models/upload_post_transform_success_event.rbs @@ -0,0 +1,142 @@ +module Imagekitio + module Models + type upload_post_transform_success_event = + { + created_at: Time, + data: Imagekitio::UploadPostTransformSuccessEvent::Data, + request: Imagekitio::UploadPostTransformSuccessEvent::Request, + type: :"upload.post-transform.success" + } + + class UploadPostTransformSuccessEvent < Imagekitio::Models::BaseWebhookEvent + def created_at: -> Time + + def created_at=: (Time _) -> Time + + def data: -> Imagekitio::UploadPostTransformSuccessEvent::Data + + def data=: ( + Imagekitio::UploadPostTransformSuccessEvent::Data _ + ) -> Imagekitio::UploadPostTransformSuccessEvent::Data + + def request: -> Imagekitio::UploadPostTransformSuccessEvent::Request + + def request=: ( + Imagekitio::UploadPostTransformSuccessEvent::Request _ + ) -> Imagekitio::UploadPostTransformSuccessEvent::Request + + def `type`: -> :"upload.post-transform.success" + + def type=: ( + :"upload.post-transform.success" _ + ) -> :"upload.post-transform.success" + + def initialize: ( + created_at: Time, + data: Imagekitio::UploadPostTransformSuccessEvent::Data, + request: Imagekitio::UploadPostTransformSuccessEvent::Request, + ?type: :"upload.post-transform.success" + ) -> void + + def to_hash: -> { + created_at: Time, + data: Imagekitio::UploadPostTransformSuccessEvent::Data, + request: Imagekitio::UploadPostTransformSuccessEvent::Request, + type: :"upload.post-transform.success" + } + + type data = { file_id: String, name: String, url: String } + + class Data < Imagekitio::Internal::Type::BaseModel + attr_accessor file_id: String + + attr_accessor name: String + + attr_accessor url: String + + def initialize: (file_id: String, name: String, url: String) -> void + + def to_hash: -> { file_id: String, name: String, url: String } + end + + type request = + { + transformation: Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation, + x_request_id: String + } + + class Request < Imagekitio::Internal::Type::BaseModel + attr_accessor transformation: Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation + + attr_accessor x_request_id: String + + def initialize: ( + transformation: Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation, + x_request_id: String + ) -> void + + def to_hash: -> { + transformation: Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation, + x_request_id: String + } + + type transformation = + { + type: Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, + protocol: Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, + value: String + } + + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_ + + attr_reader protocol: Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol? + + def protocol=: ( + Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol + ) -> Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol + + attr_reader value: String? + + def value=: (String) -> String + + def initialize: ( + type: Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, + ?protocol: Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, + ?value: String + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_, + protocol: Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol, + value: String + } + + type type_ = :transformation | :abs | :"gif-to-video" | :thumbnail + + module Type + extend Imagekitio::Internal::Type::Enum + + TRANSFORMATION: :transformation + ABS: :abs + GIF_TO_VIDEO: :"gif-to-video" + THUMBNAIL: :thumbnail + + def self?.values: -> ::Array[Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::type_] + end + + type protocol = :hls | :dash + + module Protocol + extend Imagekitio::Internal::Type::Enum + + HLS: :hls + DASH: :dash + + def self?.values: -> ::Array[Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::protocol] + end + end + end + end + end +end diff --git a/sig/imagekitio/models/upload_pre_transform_error_event.rbs b/sig/imagekitio/models/upload_pre_transform_error_event.rbs new file mode 100644 index 00000000..189e999e --- /dev/null +++ b/sig/imagekitio/models/upload_pre_transform_error_event.rbs @@ -0,0 +1,115 @@ +module Imagekitio + module Models + type upload_pre_transform_error_event = + { + created_at: Time, + data: Imagekitio::UploadPreTransformErrorEvent::Data, + request: Imagekitio::UploadPreTransformErrorEvent::Request, + type: :"upload.pre-transform.error" + } + + class UploadPreTransformErrorEvent < Imagekitio::Models::BaseWebhookEvent + def created_at: -> Time + + def created_at=: (Time _) -> Time + + def data: -> Imagekitio::UploadPreTransformErrorEvent::Data + + def data=: ( + Imagekitio::UploadPreTransformErrorEvent::Data _ + ) -> Imagekitio::UploadPreTransformErrorEvent::Data + + def request: -> Imagekitio::UploadPreTransformErrorEvent::Request + + def request=: ( + Imagekitio::UploadPreTransformErrorEvent::Request _ + ) -> Imagekitio::UploadPreTransformErrorEvent::Request + + def `type`: -> :"upload.pre-transform.error" + + def type=: ( + :"upload.pre-transform.error" _ + ) -> :"upload.pre-transform.error" + + def initialize: ( + created_at: Time, + data: Imagekitio::UploadPreTransformErrorEvent::Data, + request: Imagekitio::UploadPreTransformErrorEvent::Request, + ?type: :"upload.pre-transform.error" + ) -> void + + def to_hash: -> { + created_at: Time, + data: Imagekitio::UploadPreTransformErrorEvent::Data, + request: Imagekitio::UploadPreTransformErrorEvent::Request, + type: :"upload.pre-transform.error" + } + + type data = + { + name: String, + path: String, + transformation: Imagekitio::UploadPreTransformErrorEvent::Data::Transformation + } + + class Data < Imagekitio::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor path: String + + attr_accessor transformation: Imagekitio::UploadPreTransformErrorEvent::Data::Transformation + + def initialize: ( + name: String, + path: String, + transformation: Imagekitio::UploadPreTransformErrorEvent::Data::Transformation + ) -> void + + def to_hash: -> { + name: String, + path: String, + transformation: Imagekitio::UploadPreTransformErrorEvent::Data::Transformation + } + + type transformation = + { + error: Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error + } + + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_accessor error: Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error + + def initialize: ( + error: Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error + ) -> void + + def to_hash: -> { + error: Imagekitio::UploadPreTransformErrorEvent::Data::Transformation::Error + } + + type error = { reason: String } + + class Error < Imagekitio::Internal::Type::BaseModel + attr_accessor reason: String + + def initialize: (reason: String) -> void + + def to_hash: -> { reason: String } + end + end + end + + type request = { transformation: String, x_request_id: String } + + class Request < Imagekitio::Internal::Type::BaseModel + attr_accessor transformation: String + + attr_accessor x_request_id: String + + def initialize: (transformation: String, x_request_id: String) -> void + + def to_hash: -> { transformation: String, x_request_id: String } + end + end + end +end diff --git a/sig/imagekitio/models/upload_pre_transform_success_event.rbs b/sig/imagekitio/models/upload_pre_transform_success_event.rbs new file mode 100644 index 00000000..90bf4311 --- /dev/null +++ b/sig/imagekitio/models/upload_pre_transform_success_event.rbs @@ -0,0 +1,541 @@ +module Imagekitio + module Models + type upload_pre_transform_success_event = + { + created_at: Time, + data: Imagekitio::UploadPreTransformSuccessEvent::Data, + request: Imagekitio::UploadPreTransformSuccessEvent::Request, + type: :"upload.pre-transform.success" + } + + class UploadPreTransformSuccessEvent < Imagekitio::Models::BaseWebhookEvent + def created_at: -> Time + + def created_at=: (Time _) -> Time + + def data: -> Imagekitio::UploadPreTransformSuccessEvent::Data + + def data=: ( + Imagekitio::UploadPreTransformSuccessEvent::Data _ + ) -> Imagekitio::UploadPreTransformSuccessEvent::Data + + def request: -> Imagekitio::UploadPreTransformSuccessEvent::Request + + def request=: ( + Imagekitio::UploadPreTransformSuccessEvent::Request _ + ) -> Imagekitio::UploadPreTransformSuccessEvent::Request + + def `type`: -> :"upload.pre-transform.success" + + def type=: ( + :"upload.pre-transform.success" _ + ) -> :"upload.pre-transform.success" + + def initialize: ( + created_at: Time, + data: Imagekitio::UploadPreTransformSuccessEvent::Data, + request: Imagekitio::UploadPreTransformSuccessEvent::Request, + ?type: :"upload.pre-transform.success" + ) -> void + + def to_hash: -> { + created_at: Time, + data: Imagekitio::UploadPreTransformSuccessEvent::Data, + request: Imagekitio::UploadPreTransformSuccessEvent::Request, + type: :"upload.pre-transform.success" + } + + type data = + { + ai_tags: ::Array[Imagekitio::UploadPreTransformSuccessEvent::Data::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekitio::Metadata, + name: String, + selected_fields_schema: ::Hash[Symbol, Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo, + video_codec: String, + width: Float + } + + class Data < Imagekitio::Internal::Type::BaseModel + attr_accessor ai_tags: ::Array[Imagekitio::UploadPreTransformSuccessEvent::Data::AITag]? + + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + + attr_accessor custom_coordinates: String? + + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: ::Hash[Symbol, top]? + + def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader extension_status: Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus? + + def extension_status=: ( + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus + ) -> Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus + + attr_reader file_id: String? + + def file_id=: (String) -> String + + attr_reader file_path: String? + + def file_path=: (String) -> String + + attr_reader file_type: String? + + def file_type=: (String) -> String + + attr_reader height: Float? + + def height=: (Float) -> Float + + attr_reader is_private_file: bool? + + def is_private_file=: (bool) -> bool + + attr_reader is_published: bool? + + def is_published=: (bool) -> bool + + attr_reader metadata: Imagekitio::Metadata? + + def metadata=: (Imagekitio::Metadata) -> Imagekitio::Metadata + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader selected_fields_schema: ::Hash[Symbol, Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema]? + + def selected_fields_schema=: ( + ::Hash[Symbol, Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] + ) -> ::Hash[Symbol, Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema] + + attr_reader size: Float? + + def size=: (Float) -> Float + + attr_accessor tags: ::Array[String]? + + attr_reader thumbnail_url: String? + + def thumbnail_url=: (String) -> String + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader version_info: Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo? + + def version_info=: ( + Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo + ) -> Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo + + attr_reader video_codec: String? + + def video_codec=: (String) -> String + + attr_reader width: Float? + + def width=: (Float) -> Float + + def initialize: ( + ?ai_tags: ::Array[Imagekitio::UploadPreTransformSuccessEvent::Data::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, + ?custom_coordinates: String?, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?duration: Integer, + ?embedded_metadata: ::Hash[Symbol, top], + ?extension_status: Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus, + ?file_id: String, + ?file_path: String, + ?file_type: String, + ?height: Float, + ?is_private_file: bool, + ?is_published: bool, + ?metadata: Imagekitio::Metadata, + ?name: String, + ?selected_fields_schema: ::Hash[Symbol, Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], + ?size: Float, + ?tags: ::Array[String]?, + ?thumbnail_url: String, + ?url: String, + ?version_info: Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo, + ?video_codec: String, + ?width: Float + ) -> void + + def to_hash: -> { + ai_tags: ::Array[Imagekitio::UploadPreTransformSuccessEvent::Data::AITag]?, + audio_codec: String, + bit_rate: Integer, + custom_coordinates: String?, + custom_metadata: ::Hash[Symbol, top], + description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], + extension_status: Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus, + file_id: String, + file_path: String, + file_type: String, + height: Float, + is_private_file: bool, + is_published: bool, + metadata: Imagekitio::Metadata, + name: String, + selected_fields_schema: ::Hash[Symbol, Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema], + size: Float, + tags: ::Array[String]?, + thumbnail_url: String, + url: String, + version_info: Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo, + video_codec: String, + width: Float + } + + type ai_tag = { confidence: Float, name: String, source: String } + + class AITag < Imagekitio::Internal::Type::BaseModel + attr_reader confidence: Float? + + def confidence=: (Float) -> Float + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader source: String? + + def source=: (String) -> String + + def initialize: ( + ?confidence: Float, + ?name: String, + ?source: String + ) -> void + + def to_hash: -> { confidence: Float, name: String, source: String } + end + + type extension_status = + { + ai_auto_description: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg + } + + class ExtensionStatus < Imagekitio::Internal::Type::BaseModel + attr_reader ai_auto_description: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description? + + def ai_auto_description=: ( + Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description + ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description + + attr_reader aws_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging? + + def aws_auto_tagging=: ( + Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging + ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging + + attr_reader google_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging? + + def google_auto_tagging=: ( + Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging + ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging + + attr_reader remove_bg: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg? + + def remove_bg=: ( + Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg + ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg + + def initialize: ( + ?ai_auto_description: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, + ?aws_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, + ?google_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, + ?remove_bg: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg + ) -> void + + def to_hash: -> { + ai_auto_description: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, + aws_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, + google_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, + remove_bg: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg + } + + type ai_auto_description = :success | :pending | :failed + + module AIAutoDescription + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description] + end + + type aws_auto_tagging = :success | :pending | :failed + + module AwsAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging] + end + + type google_auto_tagging = :success | :pending | :failed + + module GoogleAutoTagging + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging] + end + + type remove_bg = :success | :pending | :failed + + module RemoveBg + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg] + end + end + + type selected_fields_schema = + { + type: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, + default_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_ + + attr_reader default_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value? + + def default_value=: ( + Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value + ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value + + attr_reader is_value_required: bool? + + def is_value_required=: (bool) -> bool + + attr_reader max_length: Float? + + def max_length=: (Float) -> Float + + attr_reader max_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value? + + def max_value=: ( + Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value + ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value + + attr_reader min_length: Float? + + def min_length=: (Float) -> Float + + attr_reader min_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value? + + def min_value=: ( + Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value + ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value + + attr_reader read_only: bool? + + def read_only=: (bool) -> bool + + attr_reader select_options: ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option]? + + def select_options=: ( + ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] + ) -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] + + attr_reader select_options_truncated: bool? + + def select_options_truncated=: (bool) -> bool + + def initialize: ( + type: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, + ?default_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, + ?is_value_required: bool, + ?max_length: Float, + ?max_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, + ?min_length: Float, + ?min_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, + ?read_only: bool, + ?select_options: ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], + ?select_options_truncated: bool + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_, + default_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value, + is_value_required: bool, + max_length: Float, + max_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value, + min_length: Float, + min_value: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value, + read_only: bool, + select_options: ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option], + select_options_truncated: bool + } + + type type_ = + :Text + | :Textarea + | :Number + | :Date + | :Boolean + | :SingleSelect + | :MultiSelect + + module Type + extend Imagekitio::Internal::Type::Enum + + TEXT: :Text + TEXTAREA: :Textarea + NUMBER: :Number + DATE: :Date + BOOLEAN: :Boolean + SINGLE_SELECT: :SingleSelect + MULTI_SELECT: :MultiSelect + + def self?.values: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::type_] + end + + type default_value = + String + | Float + | bool + | ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::mixed] + + module DefaultValue + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::default_value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + + type max_value = String | Float + + module MaxValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::max_value] + end + + type min_value = String | Float + + module MinValue + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::min_value] + end + + type select_option = String | Float | bool + + module SelectOption + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::select_option] + end + end + + type version_info = { id: String, name: String } + + class VersionInfo < Imagekitio::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: (?id: String, ?name: String) -> void + + def to_hash: -> { id: String, name: String } + end + end + + type request = { transformation: String, x_request_id: String } + + class Request < Imagekitio::Internal::Type::BaseModel + attr_accessor transformation: String + + attr_accessor x_request_id: String + + def initialize: (transformation: String, x_request_id: String) -> void + + def to_hash: -> { transformation: String, x_request_id: String } + end + end + end +end diff --git a/sig/imagekitio/models/video_overlay.rbs b/sig/imagekitio/models/video_overlay.rbs new file mode 100644 index 00000000..86c3ed06 --- /dev/null +++ b/sig/imagekitio/models/video_overlay.rbs @@ -0,0 +1,59 @@ +module Imagekitio + module Models + type video_overlay = + { + input: String, + type: :video, + encoding: Imagekitio::Models::VideoOverlay::encoding, + transformation: ::Array[Imagekitio::Transformation] + } + + class VideoOverlay < Imagekitio::Models::BaseOverlay + def input: -> String + + def input=: (String _) -> String + + def `type`: -> :video + + def type=: (:video _) -> :video + + def encoding: -> Imagekitio::Models::VideoOverlay::encoding? + + def encoding=: ( + Imagekitio::Models::VideoOverlay::encoding _ + ) -> Imagekitio::Models::VideoOverlay::encoding + + def transformation: -> ::Array[Imagekitio::Transformation]? + + def transformation=: ( + ::Array[Imagekitio::Transformation] _ + ) -> ::Array[Imagekitio::Transformation] + + def initialize: ( + input: String, + ?encoding: Imagekitio::Models::VideoOverlay::encoding, + ?transformation: ::Array[Imagekitio::Transformation], + ?type: :video + ) -> void + + def to_hash: -> { + input: String, + type: :video, + encoding: Imagekitio::Models::VideoOverlay::encoding, + transformation: ::Array[Imagekitio::Transformation] + } + + type encoding = :auto | :plain | :base64 + + module Encoding + extend Imagekitio::Internal::Type::Enum + + AUTO: :auto + PLAIN: :plain + BASE64: :base64 + + def self?.values: -> ::Array[Imagekitio::Models::VideoOverlay::encoding] + end + end + end +end diff --git a/sig/imagekitio/models/video_transformation_accepted_event.rbs b/sig/imagekitio/models/video_transformation_accepted_event.rbs new file mode 100644 index 00000000..c2ac8626 --- /dev/null +++ b/sig/imagekitio/models/video_transformation_accepted_event.rbs @@ -0,0 +1,261 @@ +module Imagekitio + module Models + type video_transformation_accepted_event = + { + created_at: Time, + data: Imagekitio::VideoTransformationAcceptedEvent::Data, + request: Imagekitio::VideoTransformationAcceptedEvent::Request, + type: :"video.transformation.accepted" + } + + class VideoTransformationAcceptedEvent < Imagekitio::Models::BaseWebhookEvent + def created_at: -> Time + + def created_at=: (Time _) -> Time + + def data: -> Imagekitio::VideoTransformationAcceptedEvent::Data + + def data=: ( + Imagekitio::VideoTransformationAcceptedEvent::Data _ + ) -> Imagekitio::VideoTransformationAcceptedEvent::Data + + def request: -> Imagekitio::VideoTransformationAcceptedEvent::Request + + def request=: ( + Imagekitio::VideoTransformationAcceptedEvent::Request _ + ) -> Imagekitio::VideoTransformationAcceptedEvent::Request + + def `type`: -> :"video.transformation.accepted" + + def type=: ( + :"video.transformation.accepted" _ + ) -> :"video.transformation.accepted" + + def initialize: ( + created_at: Time, + data: Imagekitio::VideoTransformationAcceptedEvent::Data, + request: Imagekitio::VideoTransformationAcceptedEvent::Request, + ?type: :"video.transformation.accepted" + ) -> void + + def to_hash: -> { + created_at: Time, + data: Imagekitio::VideoTransformationAcceptedEvent::Data, + request: Imagekitio::VideoTransformationAcceptedEvent::Request, + type: :"video.transformation.accepted" + } + + type data = + { + asset: Imagekitio::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation + } + + class Data < Imagekitio::Internal::Type::BaseModel + attr_accessor asset: Imagekitio::VideoTransformationAcceptedEvent::Data::Asset + + attr_accessor transformation: Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation + + def initialize: ( + asset: Imagekitio::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation + ) -> void + + def to_hash: -> { + asset: Imagekitio::VideoTransformationAcceptedEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation + } + + type asset = { url: String } + + class Asset < Imagekitio::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + + type transformation = + { + type: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + options: Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options + } + + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_ + + attr_reader options: Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options? + + def options=: ( + Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options + ) -> Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options + + def initialize: ( + type: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + ?options: Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_, + options: Imagekitio::VideoTransformationAcceptedEvent::Data::Transformation::Options + } + + type type_ = + :"video-transformation" | :"gif-to-video" | :"video-thumbnail" + + module Type + extend Imagekitio::Internal::Type::Enum + + VIDEO_TRANSFORMATION: :"video-transformation" + GIF_TO_VIDEO: :"gif-to-video" + VIDEO_THUMBNAIL: :"video-thumbnail" + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::type_] + end + + type options = + { + audio_codec: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + } + + class Options < Imagekitio::Internal::Type::BaseModel + attr_reader audio_codec: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec? + + def audio_codec=: ( + Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec + ) -> Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec + + attr_reader auto_rotate: bool? + + def auto_rotate=: (bool) -> bool + + attr_reader format_: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_? + + def format_=: ( + Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ + ) -> Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_ + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader stream_protocol: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol? + + def stream_protocol=: ( + Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol + + attr_reader variants: ::Array[String]? + + def variants=: (::Array[String]) -> ::Array[String] + + attr_reader video_codec: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec? + + def video_codec=: ( + Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + ) -> Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + + def initialize: ( + ?audio_codec: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, + ?auto_rotate: bool, + ?format_: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, + ?quality: Integer, + ?stream_protocol: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, + ?variants: ::Array[String], + ?video_codec: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + ) -> void + + def to_hash: -> { + audio_codec: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec + } + + type audio_codec = :aac | :opus + + module AudioCodec + extend Imagekitio::Internal::Type::Enum + + AAC: :aac + OPUS: :opus + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::audio_codec] + end + + type format_ = :mp4 | :webm | :jpg | :png | :webp + + module Format + extend Imagekitio::Internal::Type::Enum + + MP4: :mp4 + WEBM: :webm + JPG: :jpg + PNG: :png + WEBP: :webp + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::format_] + end + + type stream_protocol = :HLS | :DASH + + module StreamProtocol + extend Imagekitio::Internal::Type::Enum + + HLS: :HLS + DASH: :DASH + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::stream_protocol] + end + + type video_codec = :h264 | :vp9 | :av1 + + module VideoCodec + extend Imagekitio::Internal::Type::Enum + + H264: :h264 + VP9: :vp9 + AV1: :av1 + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationAcceptedEvent::Data::Transformation::Options::video_codec] + end + end + end + end + + type request = { url: String, x_request_id: String, user_agent: String } + + class Request < Imagekitio::Internal::Type::BaseModel + attr_accessor url: String + + attr_accessor x_request_id: String + + attr_reader user_agent: String? + + def user_agent=: (String) -> String + + def initialize: ( + url: String, + x_request_id: String, + ?user_agent: String + ) -> void + + def to_hash: -> { + url: String, + x_request_id: String, + user_agent: String + } + end + end + end +end diff --git a/sig/imagekitio/models/video_transformation_error_event.rbs b/sig/imagekitio/models/video_transformation_error_event.rbs new file mode 100644 index 00000000..f973d1a3 --- /dev/null +++ b/sig/imagekitio/models/video_transformation_error_event.rbs @@ -0,0 +1,300 @@ +module Imagekitio + module Models + type video_transformation_error_event = + { + created_at: Time, + data: Imagekitio::VideoTransformationErrorEvent::Data, + request: Imagekitio::VideoTransformationErrorEvent::Request, + type: :"video.transformation.error" + } + + class VideoTransformationErrorEvent < Imagekitio::Models::BaseWebhookEvent + def created_at: -> Time + + def created_at=: (Time _) -> Time + + def data: -> Imagekitio::VideoTransformationErrorEvent::Data + + def data=: ( + Imagekitio::VideoTransformationErrorEvent::Data _ + ) -> Imagekitio::VideoTransformationErrorEvent::Data + + def request: -> Imagekitio::VideoTransformationErrorEvent::Request + + def request=: ( + Imagekitio::VideoTransformationErrorEvent::Request _ + ) -> Imagekitio::VideoTransformationErrorEvent::Request + + def `type`: -> :"video.transformation.error" + + def type=: ( + :"video.transformation.error" _ + ) -> :"video.transformation.error" + + def initialize: ( + created_at: Time, + data: Imagekitio::VideoTransformationErrorEvent::Data, + request: Imagekitio::VideoTransformationErrorEvent::Request, + ?type: :"video.transformation.error" + ) -> void + + def to_hash: -> { + created_at: Time, + data: Imagekitio::VideoTransformationErrorEvent::Data, + request: Imagekitio::VideoTransformationErrorEvent::Request, + type: :"video.transformation.error" + } + + type data = + { + asset: Imagekitio::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationErrorEvent::Data::Transformation + } + + class Data < Imagekitio::Internal::Type::BaseModel + attr_accessor asset: Imagekitio::VideoTransformationErrorEvent::Data::Asset + + attr_accessor transformation: Imagekitio::VideoTransformationErrorEvent::Data::Transformation + + def initialize: ( + asset: Imagekitio::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationErrorEvent::Data::Transformation + ) -> void + + def to_hash: -> { + asset: Imagekitio::VideoTransformationErrorEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationErrorEvent::Data::Transformation + } + + type asset = { url: String } + + class Asset < Imagekitio::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + + type transformation = + { + type: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + error: Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error, + options: Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options + } + + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::type_ + + attr_reader error: Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error? + + def error=: ( + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error + ) -> Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error + + attr_reader options: Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options? + + def options=: ( + Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options + ) -> Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options + + def initialize: ( + type: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + ?error: Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error, + ?options: Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::type_, + error: Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Error, + options: Imagekitio::VideoTransformationErrorEvent::Data::Transformation::Options + } + + type type_ = + :"video-transformation" | :"gif-to-video" | :"video-thumbnail" + + module Type + extend Imagekitio::Internal::Type::Enum + + VIDEO_TRANSFORMATION: :"video-transformation" + GIF_TO_VIDEO: :"gif-to-video" + VIDEO_THUMBNAIL: :"video-thumbnail" + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::type_] + end + + type error = + { + reason: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason + } + + class Error < Imagekitio::Internal::Type::BaseModel + attr_accessor reason: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason + + def initialize: ( + reason: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason + ) -> void + + def to_hash: -> { + reason: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason + } + + type reason = + :encoding_failed | :download_failed | :internal_server_error + + module Reason + extend Imagekitio::Internal::Type::Enum + + ENCODING_FAILED: :encoding_failed + DOWNLOAD_FAILED: :download_failed + INTERNAL_SERVER_ERROR: :internal_server_error + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Error::reason] + end + end + + type options = + { + audio_codec: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + } + + class Options < Imagekitio::Internal::Type::BaseModel + attr_reader audio_codec: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec? + + def audio_codec=: ( + Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec + ) -> Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec + + attr_reader auto_rotate: bool? + + def auto_rotate=: (bool) -> bool + + attr_reader format_: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_? + + def format_=: ( + Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ + ) -> Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_ + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader stream_protocol: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol? + + def stream_protocol=: ( + Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol + + attr_reader variants: ::Array[String]? + + def variants=: (::Array[String]) -> ::Array[String] + + attr_reader video_codec: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec? + + def video_codec=: ( + Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + ) -> Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + + def initialize: ( + ?audio_codec: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, + ?auto_rotate: bool, + ?format_: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, + ?quality: Integer, + ?stream_protocol: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, + ?variants: ::Array[String], + ?video_codec: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + ) -> void + + def to_hash: -> { + audio_codec: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec + } + + type audio_codec = :aac | :opus + + module AudioCodec + extend Imagekitio::Internal::Type::Enum + + AAC: :aac + OPUS: :opus + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::audio_codec] + end + + type format_ = :mp4 | :webm | :jpg | :png | :webp + + module Format + extend Imagekitio::Internal::Type::Enum + + MP4: :mp4 + WEBM: :webm + JPG: :jpg + PNG: :png + WEBP: :webp + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::format_] + end + + type stream_protocol = :HLS | :DASH + + module StreamProtocol + extend Imagekitio::Internal::Type::Enum + + HLS: :HLS + DASH: :DASH + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::stream_protocol] + end + + type video_codec = :h264 | :vp9 | :av1 + + module VideoCodec + extend Imagekitio::Internal::Type::Enum + + H264: :h264 + VP9: :vp9 + AV1: :av1 + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationErrorEvent::Data::Transformation::Options::video_codec] + end + end + end + end + + type request = { url: String, x_request_id: String, user_agent: String } + + class Request < Imagekitio::Internal::Type::BaseModel + attr_accessor url: String + + attr_accessor x_request_id: String + + attr_reader user_agent: String? + + def user_agent=: (String) -> String + + def initialize: ( + url: String, + x_request_id: String, + ?user_agent: String + ) -> void + + def to_hash: -> { + url: String, + x_request_id: String, + user_agent: String + } + end + end + end +end diff --git a/sig/imagekitio/models/video_transformation_ready_event.rbs b/sig/imagekitio/models/video_transformation_ready_event.rbs new file mode 100644 index 00000000..1bf70a49 --- /dev/null +++ b/sig/imagekitio/models/video_transformation_ready_event.rbs @@ -0,0 +1,359 @@ +module Imagekitio + module Models + type video_transformation_ready_event = + { + created_at: Time, + data: Imagekitio::VideoTransformationReadyEvent::Data, + request: Imagekitio::VideoTransformationReadyEvent::Request, + type: :"video.transformation.ready", + timings: Imagekitio::VideoTransformationReadyEvent::Timings + } + + class VideoTransformationReadyEvent < Imagekitio::Models::BaseWebhookEvent + def created_at: -> Time + + def created_at=: (Time _) -> Time + + def data: -> Imagekitio::VideoTransformationReadyEvent::Data + + def data=: ( + Imagekitio::VideoTransformationReadyEvent::Data _ + ) -> Imagekitio::VideoTransformationReadyEvent::Data + + def request: -> Imagekitio::VideoTransformationReadyEvent::Request + + def request=: ( + Imagekitio::VideoTransformationReadyEvent::Request _ + ) -> Imagekitio::VideoTransformationReadyEvent::Request + + def `type`: -> :"video.transformation.ready" + + def type=: ( + :"video.transformation.ready" _ + ) -> :"video.transformation.ready" + + def timings: -> Imagekitio::VideoTransformationReadyEvent::Timings? + + def timings=: ( + Imagekitio::VideoTransformationReadyEvent::Timings _ + ) -> Imagekitio::VideoTransformationReadyEvent::Timings + + def initialize: ( + created_at: Time, + data: Imagekitio::VideoTransformationReadyEvent::Data, + request: Imagekitio::VideoTransformationReadyEvent::Request, + ?timings: Imagekitio::VideoTransformationReadyEvent::Timings, + ?type: :"video.transformation.ready" + ) -> void + + def to_hash: -> { + created_at: Time, + data: Imagekitio::VideoTransformationReadyEvent::Data, + request: Imagekitio::VideoTransformationReadyEvent::Request, + type: :"video.transformation.ready", + timings: Imagekitio::VideoTransformationReadyEvent::Timings + } + + type data = + { + asset: Imagekitio::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationReadyEvent::Data::Transformation + } + + class Data < Imagekitio::Internal::Type::BaseModel + attr_accessor asset: Imagekitio::VideoTransformationReadyEvent::Data::Asset + + attr_accessor transformation: Imagekitio::VideoTransformationReadyEvent::Data::Transformation + + def initialize: ( + asset: Imagekitio::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationReadyEvent::Data::Transformation + ) -> void + + def to_hash: -> { + asset: Imagekitio::VideoTransformationReadyEvent::Data::Asset, + transformation: Imagekitio::VideoTransformationReadyEvent::Data::Transformation + } + + type asset = { url: String } + + class Asset < Imagekitio::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + + type transformation = + { + type: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + options: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options, + output: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output + } + + class Transformation < Imagekitio::Internal::Type::BaseModel + attr_accessor type: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::type_ + + attr_reader options: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options? + + def options=: ( + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options + ) -> Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options + + attr_reader output: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output? + + def output=: ( + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output + ) -> Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output + + def initialize: ( + type: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + ?options: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options, + ?output: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output + ) -> void + + def to_hash: -> { + type: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::type_, + options: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options, + output: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output + } + + type type_ = + :"video-transformation" | :"gif-to-video" | :"video-thumbnail" + + module Type + extend Imagekitio::Internal::Type::Enum + + VIDEO_TRANSFORMATION: :"video-transformation" + GIF_TO_VIDEO: :"gif-to-video" + VIDEO_THUMBNAIL: :"video-thumbnail" + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::type_] + end + + type options = + { + audio_codec: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + } + + class Options < Imagekitio::Internal::Type::BaseModel + attr_reader audio_codec: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec? + + def audio_codec=: ( + Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec + ) -> Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec + + attr_reader auto_rotate: bool? + + def auto_rotate=: (bool) -> bool + + attr_reader format_: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_? + + def format_=: ( + Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ + ) -> Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_ + + attr_reader quality: Integer? + + def quality=: (Integer) -> Integer + + attr_reader stream_protocol: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol? + + def stream_protocol=: ( + Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol + ) -> Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol + + attr_reader variants: ::Array[String]? + + def variants=: (::Array[String]) -> ::Array[String] + + attr_reader video_codec: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec? + + def video_codec=: ( + Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + ) -> Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + + def initialize: ( + ?audio_codec: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, + ?auto_rotate: bool, + ?format_: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, + ?quality: Integer, + ?stream_protocol: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, + ?variants: ::Array[String], + ?video_codec: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + ) -> void + + def to_hash: -> { + audio_codec: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec, + auto_rotate: bool, + format_: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_, + quality: Integer, + stream_protocol: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol, + variants: ::Array[String], + video_codec: Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec + } + + type audio_codec = :aac | :opus + + module AudioCodec + extend Imagekitio::Internal::Type::Enum + + AAC: :aac + OPUS: :opus + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::audio_codec] + end + + type format_ = :mp4 | :webm | :jpg | :png | :webp + + module Format + extend Imagekitio::Internal::Type::Enum + + MP4: :mp4 + WEBM: :webm + JPG: :jpg + PNG: :png + WEBP: :webp + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::format_] + end + + type stream_protocol = :HLS | :DASH + + module StreamProtocol + extend Imagekitio::Internal::Type::Enum + + HLS: :HLS + DASH: :DASH + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::stream_protocol] + end + + type video_codec = :h264 | :vp9 | :av1 + + module VideoCodec + extend Imagekitio::Internal::Type::Enum + + H264: :h264 + VP9: :vp9 + AV1: :av1 + + def self?.values: -> ::Array[Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::video_codec] + end + end + + type output = + { + url: String, + video_metadata: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + } + + class Output < Imagekitio::Internal::Type::BaseModel + attr_accessor url: String + + attr_reader video_metadata: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata? + + def video_metadata=: ( + Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + ) -> Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + + def initialize: ( + url: String, + ?video_metadata: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + ) -> void + + def to_hash: -> { + url: String, + video_metadata: Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata + } + + type video_metadata = + { + bitrate: Integer, + duration: Float, + height: Integer, + width: Integer + } + + class VideoMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor bitrate: Integer + + attr_accessor duration: Float + + attr_accessor height: Integer + + attr_accessor width: Integer + + def initialize: ( + bitrate: Integer, + duration: Float, + height: Integer, + width: Integer + ) -> void + + def to_hash: -> { + bitrate: Integer, + duration: Float, + height: Integer, + width: Integer + } + end + end + end + end + + type request = { url: String, x_request_id: String, user_agent: String } + + class Request < Imagekitio::Internal::Type::BaseModel + attr_accessor url: String + + attr_accessor x_request_id: String + + attr_reader user_agent: String? + + def user_agent=: (String) -> String + + def initialize: ( + url: String, + x_request_id: String, + ?user_agent: String + ) -> void + + def to_hash: -> { + url: String, + x_request_id: String, + user_agent: String + } + end + + type timings = { download_duration: Integer, encoding_duration: Integer } + + class Timings < Imagekitio::Internal::Type::BaseModel + attr_reader download_duration: Integer? + + def download_duration=: (Integer) -> Integer + + attr_reader encoding_duration: Integer? + + def encoding_duration=: (Integer) -> Integer + + def initialize: ( + ?download_duration: Integer, + ?encoding_duration: Integer + ) -> void + + def to_hash: -> { + download_duration: Integer, + encoding_duration: Integer + } + end + end + end +end diff --git a/sig/imagekitio/models/webhook_unsafe_unwrap_params.rbs b/sig/imagekitio/models/webhook_unsafe_unwrap_params.rbs new file mode 100644 index 00000000..787afc10 --- /dev/null +++ b/sig/imagekitio/models/webhook_unsafe_unwrap_params.rbs @@ -0,0 +1,15 @@ +module Imagekitio + module Models + type webhook_unsafe_unwrap_params = + { } & Imagekitio::Internal::Type::request_parameters + + class WebhookUnsafeUnwrapParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end +end diff --git a/sig/imagekitio/models/webhook_unwrap_params.rbs b/sig/imagekitio/models/webhook_unwrap_params.rbs new file mode 100644 index 00000000..a07a2d12 --- /dev/null +++ b/sig/imagekitio/models/webhook_unwrap_params.rbs @@ -0,0 +1,15 @@ +module Imagekitio + module Models + type webhook_unwrap_params = + { } & Imagekitio::Internal::Type::request_parameters + + class WebhookUnwrapParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end +end diff --git a/sig/imagekit/request_options.rbs b/sig/imagekitio/request_options.rbs similarity index 67% rename from sig/imagekit/request_options.rbs rename to sig/imagekitio/request_options.rbs index 44de316d..1f34da8f 100644 --- a/sig/imagekit/request_options.rbs +++ b/sig/imagekitio/request_options.rbs @@ -1,6 +1,8 @@ -module Imagekit +module Imagekitio type request_opts = - Imagekit::RequestOptions | Imagekit::request_options | ::Hash[Symbol, top] + Imagekitio::RequestOptions + | Imagekitio::request_options + | ::Hash[Symbol, top] type request_options = { @@ -12,8 +14,8 @@ module Imagekit timeout: Float? } - class RequestOptions < Imagekit::Internal::Type::BaseModel - def self.validate!: (Imagekit::request_opts opts) -> void + class RequestOptions < Imagekitio::Internal::Type::BaseModel + def self.validate!: (Imagekitio::request_opts opts) -> void attr_accessor idempotency_key: String? @@ -28,7 +30,7 @@ module Imagekit attr_accessor timeout: Float? def initialize: ( - ?Imagekit::request_options | ::Hash[Symbol, top] values + ?Imagekitio::request_options | ::Hash[Symbol, top] values ) -> void end end diff --git a/sig/imagekitio/resources/accounts.rbs b/sig/imagekitio/resources/accounts.rbs new file mode 100644 index 00000000..0e844846 --- /dev/null +++ b/sig/imagekitio/resources/accounts.rbs @@ -0,0 +1,13 @@ +module Imagekitio + module Resources + class Accounts + attr_reader usage: Imagekitio::Resources::Accounts::Usage + + attr_reader origins: Imagekitio::Resources::Accounts::Origins + + attr_reader url_endpoints: Imagekitio::Resources::Accounts::URLEndpoints + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/sig/imagekitio/resources/accounts/origins.rbs b/sig/imagekitio/resources/accounts/origins.rbs new file mode 100644 index 00000000..11b28b8b --- /dev/null +++ b/sig/imagekitio/resources/accounts/origins.rbs @@ -0,0 +1,34 @@ +module Imagekitio + module Resources + class Accounts + class Origins + def create: ( + origin_request: Imagekitio::Models::Accounts::OriginRequest, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Accounts::origin_response + + def update: ( + String id, + origin_request: Imagekitio::Models::Accounts::OriginRequest, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Accounts::origin_response + + def list: ( + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Accounts::origin_list_response + + def delete: ( + String id, + ?request_options: Imagekitio::request_opts + ) -> nil + + def get: ( + String id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Accounts::origin_response + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekitio/resources/accounts/url_endpoints.rbs b/sig/imagekitio/resources/accounts/url_endpoints.rbs new file mode 100644 index 00000000..6c87a690 --- /dev/null +++ b/sig/imagekitio/resources/accounts/url_endpoints.rbs @@ -0,0 +1,40 @@ +module Imagekitio + module Resources + class Accounts + class URLEndpoints + def create: ( + description: String, + ?origins: ::Array[String], + ?url_prefix: String, + ?url_rewriter: Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Accounts::URLEndpointResponse + + def update: ( + String id, + description: String, + ?origins: ::Array[String], + ?url_prefix: String, + ?url_rewriter: Imagekitio::Models::Accounts::URLEndpointRequest::url_rewriter, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Accounts::URLEndpointResponse + + def list: ( + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Accounts::url_endpoint_list_response + + def delete: ( + String id, + ?request_options: Imagekitio::request_opts + ) -> nil + + def get: ( + String id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Accounts::URLEndpointResponse + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekitio/resources/accounts/usage.rbs b/sig/imagekitio/resources/accounts/usage.rbs new file mode 100644 index 00000000..3917760c --- /dev/null +++ b/sig/imagekitio/resources/accounts/usage.rbs @@ -0,0 +1,15 @@ +module Imagekitio + module Resources + class Accounts + class Usage + def get: ( + end_date: Date, + start_date: Date, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Accounts::UsageGetResponse + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekitio/resources/assets.rbs b/sig/imagekitio/resources/assets.rbs new file mode 100644 index 00000000..3561b9cb --- /dev/null +++ b/sig/imagekitio/resources/assets.rbs @@ -0,0 +1,18 @@ +module Imagekitio + module Resources + class Assets + def list: ( + ?file_type: Imagekitio::Models::AssetListParams::file_type, + ?limit: Integer, + ?path: String, + ?search_query: String, + ?skip: Integer, + ?sort: Imagekitio::Models::AssetListParams::sort, + ?type: Imagekitio::Models::AssetListParams::type_, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::asset_list_response + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/sig/imagekitio/resources/beta.rbs b/sig/imagekitio/resources/beta.rbs new file mode 100644 index 00000000..4a1485f9 --- /dev/null +++ b/sig/imagekitio/resources/beta.rbs @@ -0,0 +1,9 @@ +module Imagekitio + module Resources + class Beta + attr_reader v2: Imagekitio::Resources::Beta::V2 + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/sig/imagekitio/resources/beta/v2.rbs b/sig/imagekitio/resources/beta/v2.rbs new file mode 100644 index 00000000..d66806c7 --- /dev/null +++ b/sig/imagekitio/resources/beta/v2.rbs @@ -0,0 +1,11 @@ +module Imagekitio + module Resources + class Beta + class V2 + attr_reader files: Imagekitio::Resources::Beta::V2::Files + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekit/resources/beta/v2/files.rbs b/sig/imagekitio/resources/beta/v2/files.rbs similarity index 58% rename from sig/imagekit/resources/beta/v2/files.rbs rename to sig/imagekitio/resources/beta/v2/files.rbs index a2d266ae..2df59535 100644 --- a/sig/imagekit/resources/beta/v2/files.rbs +++ b/sig/imagekitio/resources/beta/v2/files.rbs @@ -1,17 +1,17 @@ -module Imagekit +module Imagekitio module Resources class Beta class V2 class Files def upload: ( - file: Imagekit::Internal::file_input, + file: Imagekitio::Internal::file_input, file_name: String, ?token: String, ?checks: String, ?custom_coordinates: String, ?custom_metadata: ::Hash[Symbol, top], ?description: String, - ?extensions: Imagekit::Models::extensions, + ?extensions: Imagekitio::Models::extensions, ?folder: String, ?is_private_file: bool, ?is_published: bool, @@ -19,15 +19,15 @@ module Imagekit ?overwrite_custom_metadata: bool, ?overwrite_file: bool, ?overwrite_tags: bool, - ?response_fields: ::Array[Imagekit::Models::Beta::V2::FileUploadParams::response_field], + ?response_fields: ::Array[Imagekitio::Models::Beta::V2::FileUploadParams::response_field], ?tags: ::Array[String], - ?transformation: Imagekit::Beta::V2::FileUploadParams::Transformation, + ?transformation: Imagekitio::Beta::V2::FileUploadParams::Transformation, ?use_unique_file_name: bool, ?webhook_url: String, - ?request_options: Imagekit::request_opts - ) -> Imagekit::Models::Beta::V2::FileUploadResponse + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse - def initialize: (client: Imagekit::Client) -> void + def initialize: (client: Imagekitio::Client) -> void end end end diff --git a/sig/imagekitio/resources/cache.rbs b/sig/imagekitio/resources/cache.rbs new file mode 100644 index 00000000..002e5e99 --- /dev/null +++ b/sig/imagekitio/resources/cache.rbs @@ -0,0 +1,9 @@ +module Imagekitio + module Resources + class Cache + attr_reader invalidation: Imagekitio::Resources::Cache::Invalidation + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/sig/imagekitio/resources/cache/invalidation.rbs b/sig/imagekitio/resources/cache/invalidation.rbs new file mode 100644 index 00000000..5e8ef9a0 --- /dev/null +++ b/sig/imagekitio/resources/cache/invalidation.rbs @@ -0,0 +1,19 @@ +module Imagekitio + module Resources + class Cache + class Invalidation + def create: ( + url: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Cache::InvalidationCreateResponse + + def get: ( + String request_id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Cache::InvalidationGetResponse + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekitio/resources/custom_metadata_fields.rbs b/sig/imagekitio/resources/custom_metadata_fields.rbs new file mode 100644 index 00000000..f4f8e326 --- /dev/null +++ b/sig/imagekitio/resources/custom_metadata_fields.rbs @@ -0,0 +1,32 @@ +module Imagekitio + module Resources + class CustomMetadataFields + def create: ( + label: String, + name: String, + schema: Imagekitio::CustomMetadataFieldCreateParams::Schema, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::CustomMetadataField + + def update: ( + String id, + ?label: String, + ?schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::CustomMetadataField + + def list: ( + ?folder_path: String, + ?include_deleted: bool, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::custom_metadata_field_list_response + + def delete: ( + String id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::CustomMetadataFieldDeleteResponse + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/sig/imagekitio/resources/files.rbs b/sig/imagekitio/resources/files.rbs new file mode 100644 index 00000000..0b08f98e --- /dev/null +++ b/sig/imagekitio/resources/files.rbs @@ -0,0 +1,76 @@ +module Imagekitio + module Resources + class Files + attr_reader bulk: Imagekitio::Resources::Files::Bulk + + attr_reader versions: Imagekitio::Resources::Files::Versions + + attr_reader metadata: Imagekitio::Resources::Files::Metadata + + def update: ( + String file_id, + update_file_request: Imagekitio::Models::UpdateFileRequest, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FileUpdateResponse + + def delete: ( + String file_id, + ?request_options: Imagekitio::request_opts + ) -> nil + + def copy: ( + destination_path: String, + source_file_path: String, + ?include_file_versions: bool, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FileCopyResponse + + def get: ( + String file_id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::File + + def move: ( + destination_path: String, + source_file_path: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FileMoveResponse + + def rename: ( + file_path: String, + new_file_name: String, + ?purge_cache: bool, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FileRenameResponse + + def upload: ( + file: Imagekitio::Internal::file_input, + file_name: String, + ?token: String, + ?checks: String, + ?custom_coordinates: String, + ?custom_metadata: ::Hash[Symbol, top], + ?description: String, + ?expire: Integer, + ?extensions: Imagekitio::Models::extensions, + ?folder: String, + ?is_private_file: bool, + ?is_published: bool, + ?overwrite_ai_tags: bool, + ?overwrite_custom_metadata: bool, + ?overwrite_file: bool, + ?overwrite_tags: bool, + ?public_key: String, + ?response_fields: ::Array[Imagekitio::Models::FileUploadParams::response_field], + ?signature: String, + ?tags: ::Array[String], + ?transformation: Imagekitio::FileUploadParams::Transformation, + ?use_unique_file_name: bool, + ?webhook_url: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FileUploadResponse + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/sig/imagekitio/resources/files/bulk.rbs b/sig/imagekitio/resources/files/bulk.rbs new file mode 100644 index 00000000..cb80b1e3 --- /dev/null +++ b/sig/imagekitio/resources/files/bulk.rbs @@ -0,0 +1,32 @@ +module Imagekitio + module Resources + class Files + class Bulk + def delete: ( + file_ids: ::Array[String], + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Files::BulkDeleteResponse + + def add_tags: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Files::BulkAddTagsResponse + + def remove_ai_tags: ( + ai_tags: ::Array[String], + file_ids: ::Array[String], + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Files::BulkRemoveAITagsResponse + + def remove_tags: ( + file_ids: ::Array[String], + tags: ::Array[String], + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Files::BulkRemoveTagsResponse + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekitio/resources/files/metadata.rbs b/sig/imagekitio/resources/files/metadata.rbs new file mode 100644 index 00000000..1a647bc7 --- /dev/null +++ b/sig/imagekitio/resources/files/metadata.rbs @@ -0,0 +1,19 @@ +module Imagekitio + module Resources + class Files + class Metadata + def get: ( + String file_id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Metadata + + def get_from_url: ( + url: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Metadata + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekitio/resources/files/versions.rbs b/sig/imagekitio/resources/files/versions.rbs new file mode 100644 index 00000000..3e981983 --- /dev/null +++ b/sig/imagekitio/resources/files/versions.rbs @@ -0,0 +1,32 @@ +module Imagekitio + module Resources + class Files + class Versions + def list: ( + String file_id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Files::version_list_response + + def delete: ( + String version_id, + file_id: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Files::VersionDeleteResponse + + def get: ( + String version_id, + file_id: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::File + + def restore: ( + String version_id, + file_id: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::File + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekitio/resources/folders.rbs b/sig/imagekitio/resources/folders.rbs new file mode 100644 index 00000000..7ba23637 --- /dev/null +++ b/sig/imagekitio/resources/folders.rbs @@ -0,0 +1,40 @@ +module Imagekitio + module Resources + class Folders + attr_reader job: Imagekitio::Resources::Folders::Job + + def create: ( + folder_name: String, + parent_folder_path: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FolderCreateResponse + + def delete: ( + folder_path: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FolderDeleteResponse + + def copy: ( + destination_path: String, + source_folder_path: String, + ?include_versions: bool, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FolderCopyResponse + + def move: ( + destination_path: String, + source_folder_path: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FolderMoveResponse + + def rename: ( + folder_path: String, + new_folder_name: String, + ?purge_cache: bool, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::FolderRenameResponse + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/sig/imagekitio/resources/folders/job.rbs b/sig/imagekitio/resources/folders/job.rbs new file mode 100644 index 00000000..8ba37f21 --- /dev/null +++ b/sig/imagekitio/resources/folders/job.rbs @@ -0,0 +1,14 @@ +module Imagekitio + module Resources + class Folders + class Job + def get: ( + String job_id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::Folders::JobGetResponse + + def initialize: (client: Imagekitio::Client) -> void + end + end + end +end diff --git a/sig/imagekitio/resources/webhooks.rbs b/sig/imagekitio/resources/webhooks.rbs new file mode 100644 index 00000000..9cd2215b --- /dev/null +++ b/sig/imagekitio/resources/webhooks.rbs @@ -0,0 +1,27 @@ +module Imagekitio + module Resources + class Webhooks + def unsafe_unwrap: ( + String payload + ) -> (Imagekitio::VideoTransformationAcceptedEvent + | Imagekitio::VideoTransformationReadyEvent + | Imagekitio::VideoTransformationErrorEvent + | Imagekitio::UploadPreTransformSuccessEvent + | Imagekitio::UploadPreTransformErrorEvent + | Imagekitio::UploadPostTransformSuccessEvent + | Imagekitio::UploadPostTransformErrorEvent) + + def unwrap: ( + String payload + ) -> (Imagekitio::VideoTransformationAcceptedEvent + | Imagekitio::VideoTransformationReadyEvent + | Imagekitio::VideoTransformationErrorEvent + | Imagekitio::UploadPreTransformSuccessEvent + | Imagekitio::UploadPreTransformErrorEvent + | Imagekitio::UploadPostTransformSuccessEvent + | Imagekitio::UploadPostTransformErrorEvent) + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/sig/imagekit/version.rbs b/sig/imagekitio/version.rbs similarity index 55% rename from sig/imagekit/version.rbs rename to sig/imagekitio/version.rbs index 56afb0ab..62f8859a 100644 --- a/sig/imagekit/version.rbs +++ b/sig/imagekitio/version.rbs @@ -1,3 +1,3 @@ -module Imagekit +module Imagekitio VERSION: String end diff --git a/test/imagekit/internal/sorbet_runtime_support_test.rb b/test/imagekit/internal/sorbet_runtime_support_test.rb deleted file mode 100644 index 4075f247..00000000 --- a/test/imagekit/internal/sorbet_runtime_support_test.rb +++ /dev/null @@ -1,52 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::SorbetRuntimeSupportTest < Minitest::Test - extend Minitest::Serial - - i_suck_and_my_tests_are_order_dependent! - - module E - extend Imagekit::Internal::Type::Enum - - define_sorbet_constant!(:TaggedSymbol) { 1 } - end - - module U - extend Imagekit::Internal::Type::Union - - define_sorbet_constant!(:Variants) { 2 } - end - - class M < Imagekit::Internal::Type::BaseModel - define_sorbet_constant!(:OrHash) { 3 } - end - - def test_nil_aliases - err = Imagekit::Internal::Util::SorbetRuntimeSupport::MissingSorbetRuntimeError - - assert_raises(err) { Imagekit::Internal::AnyHash } - assert_raises(err) { Imagekit::Internal::FileInput } - assert_raises(err) { Imagekit::Internal::Type::Converter::Input } - assert_raises(err) { Imagekit::Internal::Type::Converter::CoerceState } - assert_raises(err) { Imagekit::Internal::Type::Converter::DumpState } - assert_raises(err) { Imagekit::Internal::Type::BaseModel::KnownField } - assert_raises(err) { Imagekit::Internal::Util::ParsedUri } - assert_raises(err) { Imagekit::Internal::Util::ServerSentEvent } - assert_raises(err) { Imagekit::Internal::Transport::BaseClient::RequestComponents } - assert_raises(err) { Imagekit::Internal::Transport::BaseClient::RequestInput } - assert_raises(err) { Imagekit::Internal::Transport::PooledNetRequester::Request } - assert_raises(err) { E::TaggedSymbol } - assert_raises(err) { U::Variants } - assert_raises(err) { M::OrHash } - end - - def test_stubbed_aliases - Kernel.instance_eval { const_set(:T, nil) } - - assert_equal(1, E::TaggedSymbol) - assert_equal(2, U::Variants) - assert_equal(3, M::OrHash) - end -end diff --git a/test/imagekit/resources/accounts_test.rb b/test/imagekit/resources/accounts_test.rb deleted file mode 100644 index 73ea1f30..00000000 --- a/test/imagekit/resources/accounts_test.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::Resources::AccountsTest < Imagekit::Test::ResourceTest -end diff --git a/test/imagekit/resources/beta/v2/files_test.rb b/test/imagekit/resources/beta/v2/files_test.rb deleted file mode 100644 index 7600203a..00000000 --- a/test/imagekit/resources/beta/v2/files_test.rb +++ /dev/null @@ -1,45 +0,0 @@ -# frozen_string_literal: true - -require_relative "../../../test_helper" - -class Imagekit::Test::Resources::Beta::V2::FilesTest < Imagekit::Test::ResourceTest - def test_upload_required_params - skip("Prism tests are disabled") - - response = @image_kit.beta.v2.files.upload(file: Pathname(__FILE__), file_name: "fileName") - - assert_pattern do - response => Imagekit::Models::Beta::V2::FileUploadResponse - end - - assert_pattern do - response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::Beta::V2::FileUploadResponse::AITag]) | nil, - audio_codec: String | nil, - bit_rate: Integer | nil, - custom_coordinates: String | nil, - custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, - description: String | nil, - duration: Integer | nil, - embedded_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, - extension_status: Imagekit::Models::Beta::V2::FileUploadResponse::ExtensionStatus | nil, - file_id: String | nil, - file_path: String | nil, - file_type: String | nil, - height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, - metadata: Imagekit::Metadata | nil, - name: String | nil, - selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema]) | nil, - size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, - thumbnail_url: String | nil, - url: String | nil, - version_info: Imagekit::Models::Beta::V2::FileUploadResponse::VersionInfo | nil, - video_codec: String | nil, - width: Float | nil - } - end - end -end diff --git a/test/imagekit/resources/beta/v2_test.rb b/test/imagekit/resources/beta/v2_test.rb deleted file mode 100644 index e35e2d0d..00000000 --- a/test/imagekit/resources/beta/v2_test.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true - -require_relative "../../test_helper" - -class Imagekit::Test::Resources::Beta::V2Test < Imagekit::Test::ResourceTest -end diff --git a/test/imagekit/resources/beta_test.rb b/test/imagekit/resources/beta_test.rb deleted file mode 100644 index 9118a6f1..00000000 --- a/test/imagekit/resources/beta_test.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::Resources::BetaTest < Imagekit::Test::ResourceTest -end diff --git a/test/imagekit/resources/cache_test.rb b/test/imagekit/resources/cache_test.rb deleted file mode 100644 index 5844ad3c..00000000 --- a/test/imagekit/resources/cache_test.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::Resources::CacheTest < Imagekit::Test::ResourceTest -end diff --git a/test/imagekit/resources/shared_test.rb b/test/imagekit/resources/shared_test.rb deleted file mode 100644 index be22f0e4..00000000 --- a/test/imagekit/resources/shared_test.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Imagekit::Test::Resources::SharedTest < Imagekit::Test::ResourceTest -end diff --git a/test/imagekit/client_test.rb b/test/imagekitio/client_test.rb similarity index 87% rename from test/imagekit/client_test.rb rename to test/imagekitio/client_test.rb index 5280fad1..617cd7ed 100644 --- a/test/imagekit/client_test.rb +++ b/test/imagekitio/client_test.rb @@ -2,7 +2,7 @@ require_relative "test_helper" -class ImagekitTest < Minitest::Test +class ImagekitioTest < Minitest::Test extend Minitest::Serial include WebMock::API @@ -29,7 +29,7 @@ def after_all def test_raises_on_missing_non_nullable_opts e = assert_raises(ArgumentError) do - Imagekit::Client.new + Imagekitio::Client.new end assert_match(/is required/, e.message) end @@ -38,13 +38,13 @@ def test_client_default_request_default_retry_attempts stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end @@ -55,14 +55,14 @@ def test_client_given_request_default_retry_attempts stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password", max_retries: 3 ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end @@ -73,13 +73,13 @@ def test_client_default_request_given_retry_attempts stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload( file: Pathname(__FILE__), file_name: "fileName", @@ -94,14 +94,14 @@ def test_client_given_request_given_retry_attempts stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password", max_retries: 3 ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload( file: Pathname(__FILE__), file_name: "fileName", @@ -120,14 +120,14 @@ def test_client_retry_after_seconds ) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password", max_retries: 1 ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end @@ -143,14 +143,14 @@ def test_client_retry_after_date ) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password", max_retries: 1 ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do Thread.current.thread_variable_set(:time_now, Time.now) image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") Thread.current.thread_variable_set(:time_now, nil) @@ -168,14 +168,14 @@ def test_client_retry_after_ms ) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password", max_retries: 1 ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end @@ -187,13 +187,13 @@ def test_retry_count_header stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") end @@ -206,13 +206,13 @@ def test_omit_retry_count_header stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload( file: Pathname(__FILE__), file_name: "fileName", @@ -229,13 +229,13 @@ def test_overwrite_retry_count_header stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 500, body: {}) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::InternalServerError) do + assert_raises(Imagekitio::Errors::InternalServerError) do image_kit.files.upload( file: Pathname(__FILE__), file_name: "fileName", @@ -258,13 +258,13 @@ def test_client_redirect_307 ) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::APIConnectionError) do + assert_raises(Imagekitio::Errors::APIConnectionError) do image_kit.files.upload( file: Pathname(__FILE__), file_name: "fileName", @@ -274,7 +274,7 @@ def test_client_redirect_307 recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first - assert_requested(:any, "http://localhost/redirected", times: Imagekit::Client::MAX_REDIRECTS) do + assert_requested(:any, "http://localhost/redirected", times: Imagekitio::Client::MAX_REDIRECTS) do assert_equal(recorded.method, _1.method) assert_equal(recorded.body, _1.body) assert_equal( @@ -296,13 +296,13 @@ def test_client_redirect_303 ) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::APIConnectionError) do + assert_raises(Imagekitio::Errors::APIConnectionError) do image_kit.files.upload( file: Pathname(__FILE__), file_name: "fileName", @@ -310,7 +310,7 @@ def test_client_redirect_303 ) end - assert_requested(:get, "http://localhost/redirected", times: Imagekit::Client::MAX_REDIRECTS) do + assert_requested(:get, "http://localhost/redirected", times: Imagekitio::Client::MAX_REDIRECTS) do headers = _1.headers.keys.map(&:downcase) refute_includes(headers, "content-type") assert_nil(_1.body) @@ -329,13 +329,13 @@ def test_client_redirect_auth_keep_same_origin ) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::APIConnectionError) do + assert_raises(Imagekitio::Errors::APIConnectionError) do image_kit.files.upload( file: Pathname(__FILE__), file_name: "fileName", @@ -347,7 +347,7 @@ def test_client_redirect_auth_keep_same_origin auth_header = recorded.headers.transform_keys(&:downcase).fetch("authorization") assert_equal("Bearer xyz", auth_header) - assert_requested(:any, "http://localhost/redirected", times: Imagekit::Client::MAX_REDIRECTS) do + assert_requested(:any, "http://localhost/redirected", times: Imagekitio::Client::MAX_REDIRECTS) do auth_header = _1.headers.transform_keys(&:downcase).fetch("authorization") assert_equal("Bearer xyz", auth_header) end @@ -365,13 +365,13 @@ def test_client_redirect_auth_strip_cross_origin ) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" ) - assert_raises(Imagekit::Errors::APIConnectionError) do + assert_raises(Imagekitio::Errors::APIConnectionError) do image_kit.files.upload( file: Pathname(__FILE__), file_name: "fileName", @@ -379,7 +379,7 @@ def test_client_redirect_auth_strip_cross_origin ) end - assert_requested(:any, "https://example.com/redirected", times: Imagekit::Client::MAX_REDIRECTS) do + assert_requested(:any, "https://example.com/redirected", times: Imagekitio::Client::MAX_REDIRECTS) do headers = _1.headers.keys.map(&:downcase) refute_includes(headers, "authorization") end @@ -389,7 +389,7 @@ def test_default_headers stub_request(:post, "http://localhost/api/v1/files/upload").to_return_json(status: 200, body: {}) image_kit = - Imagekit::Client.new( + Imagekitio::Client.new( base_url: "http://localhost", private_key: "My Private Key", password: "My Password" diff --git a/test/imagekit/file_part_test.rb b/test/imagekitio/file_part_test.rb similarity index 64% rename from test/imagekit/file_part_test.rb rename to test/imagekitio/file_part_test.rb index 15b7078c..3e026ad2 100644 --- a/test/imagekit/file_part_test.rb +++ b/test/imagekitio/file_part_test.rb @@ -2,10 +2,10 @@ require_relative "test_helper" -class Imagekit::Test::FilePartTest < Minitest::Test +class Imagekitio::Test::FilePartTest < Minitest::Test def test_to_json text = "gray" - filepart = Imagekit::FilePart.new(StringIO.new(text)) + filepart = Imagekitio::FilePart.new(StringIO.new(text)) assert_equal(text.to_json, filepart.to_json) assert_equal(text.to_yaml, filepart.to_yaml) diff --git a/test/imagekitio/internal/sorbet_runtime_support_test.rb b/test/imagekitio/internal/sorbet_runtime_support_test.rb new file mode 100644 index 00000000..fd7379d1 --- /dev/null +++ b/test/imagekitio/internal/sorbet_runtime_support_test.rb @@ -0,0 +1,52 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekitio::Test::SorbetRuntimeSupportTest < Minitest::Test + extend Minitest::Serial + + i_suck_and_my_tests_are_order_dependent! + + module E + extend Imagekitio::Internal::Type::Enum + + define_sorbet_constant!(:TaggedSymbol) { 1 } + end + + module U + extend Imagekitio::Internal::Type::Union + + define_sorbet_constant!(:Variants) { 2 } + end + + class M < Imagekitio::Internal::Type::BaseModel + define_sorbet_constant!(:OrHash) { 3 } + end + + def test_nil_aliases + err = Imagekitio::Internal::Util::SorbetRuntimeSupport::MissingSorbetRuntimeError + + assert_raises(err) { Imagekitio::Internal::AnyHash } + assert_raises(err) { Imagekitio::Internal::FileInput } + assert_raises(err) { Imagekitio::Internal::Type::Converter::Input } + assert_raises(err) { Imagekitio::Internal::Type::Converter::CoerceState } + assert_raises(err) { Imagekitio::Internal::Type::Converter::DumpState } + assert_raises(err) { Imagekitio::Internal::Type::BaseModel::KnownField } + assert_raises(err) { Imagekitio::Internal::Util::ParsedUri } + assert_raises(err) { Imagekitio::Internal::Util::ServerSentEvent } + assert_raises(err) { Imagekitio::Internal::Transport::BaseClient::RequestComponents } + assert_raises(err) { Imagekitio::Internal::Transport::BaseClient::RequestInput } + assert_raises(err) { Imagekitio::Internal::Transport::PooledNetRequester::Request } + assert_raises(err) { E::TaggedSymbol } + assert_raises(err) { U::Variants } + assert_raises(err) { M::OrHash } + end + + def test_stubbed_aliases + Kernel.instance_eval { const_set(:T, nil) } + + assert_equal(1, E::TaggedSymbol) + assert_equal(2, U::Variants) + assert_equal(3, M::OrHash) + end +end diff --git a/test/imagekit/internal/type/base_model_test.rb b/test/imagekitio/internal/type/base_model_test.rb similarity index 72% rename from test/imagekit/internal/type/base_model_test.rb rename to test/imagekitio/internal/type/base_model_test.rb index 4373043c..4f59b949 100644 --- a/test/imagekit/internal/type/base_model_test.rb +++ b/test/imagekitio/internal/type/base_model_test.rb @@ -2,27 +2,27 @@ require_relative "../../test_helper" -class Imagekit::Test::PrimitiveModelTest < Minitest::Test - A = Imagekit::Internal::Type::ArrayOf[-> { Integer }] - H = Imagekit::Internal::Type::HashOf[-> { Integer }, nil?: true] +class Imagekitio::Test::PrimitiveModelTest < Minitest::Test + A = Imagekitio::Internal::Type::ArrayOf[-> { Integer }] + H = Imagekitio::Internal::Type::HashOf[-> { Integer }, nil?: true] module E - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum end module U - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union end - class B < Imagekit::Internal::Type::BaseModel + class B < Imagekitio::Internal::Type::BaseModel optional :a, Integer optional :b, B end def test_typing converters = [ - Imagekit::Internal::Type::Unknown, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Unknown, + Imagekitio::Internal::Type::Boolean, A, H, E, @@ -32,18 +32,18 @@ def test_typing converters.each do |conv| assert_pattern do - conv => Imagekit::Internal::Type::Converter + conv => Imagekitio::Internal::Type::Converter end end end def test_coerce cases = { - [Imagekit::Internal::Type::Unknown, :a] => [{yes: 1}, :a], + [Imagekitio::Internal::Type::Unknown, :a] => [{yes: 1}, :a], [NilClass, :a] => [{maybe: 1}, nil], [NilClass, nil] => [{yes: 1}, nil], - [Imagekit::Internal::Type::Boolean, true] => [{yes: 1}, true], - [Imagekit::Internal::Type::Boolean, "true"] => [{no: 1}, "true"], + [Imagekitio::Internal::Type::Boolean, true] => [{yes: 1}, true], + [Imagekitio::Internal::Type::Boolean, "true"] => [{no: 1}, "true"], [Integer, 1] => [{yes: 1}, 1], [Integer, 1.0] => [{maybe: 1}, 1], [Integer, "1"] => [{maybe: 1}, 1], @@ -66,9 +66,9 @@ def test_coerce cases.each do |lhs, rhs| target, input = lhs exactness, expect = rhs - state = Imagekit::Internal::Type::Converter.new_coerce_state + state = Imagekitio::Internal::Type::Converter.new_coerce_state assert_pattern do - Imagekit::Internal::Type::Converter.coerce(target, input, state: state) => ^expect + Imagekitio::Internal::Type::Converter.coerce(target, input, state: state) => ^expect state.fetch(:exactness).filter { _2.nonzero? }.to_h => ^exactness end end @@ -76,7 +76,7 @@ def test_coerce def test_dump cases = { - [Imagekit::Internal::Type::Unknown, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, + [Imagekitio::Internal::Type::Unknown, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, [A, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, [H, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, [E, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, @@ -85,8 +85,8 @@ def test_dump [String, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, [:b, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, [nil, B.new(a: "one", b: B.new(a: 1.0))] => {a: "one", b: {a: 1}}, - [Imagekit::Internal::Type::Boolean, true] => true, - [Imagekit::Internal::Type::Boolean, "true"] => "true", + [Imagekitio::Internal::Type::Boolean, true] => true, + [Imagekitio::Internal::Type::Boolean, "true"] => "true", [Integer, "1"] => "1", [Float, 1] => 1, [String, "one"] => "one", @@ -94,14 +94,14 @@ def test_dump [:a, :b] => :b, [:a, "a"] => "a", [String, StringIO.new("one")] => "one", - [String, Pathname(__FILE__)] => Imagekit::FilePart + [String, Pathname(__FILE__)] => Imagekitio::FilePart } cases.each do target, input = _1 expect = _2 assert_pattern do - Imagekit::Internal::Type::Converter.dump(target, input) => ^expect + Imagekitio::Internal::Type::Converter.dump(target, input) => ^expect end end end @@ -117,8 +117,8 @@ def test_coerce_errors cases.each do |testcase, expect| target, input = testcase - state = Imagekit::Internal::Type::Converter.new_coerce_state - Imagekit::Internal::Type::Converter.coerce(target, input, state: state) + state = Imagekitio::Internal::Type::Converter.new_coerce_state + Imagekitio::Internal::Type::Converter.coerce(target, input, state: state) assert_pattern do state => {error: ^expect} end @@ -127,8 +127,8 @@ def test_coerce_errors def test_dump_retry types = [ - Imagekit::Internal::Type::Unknown, - Imagekit::Internal::Type::Boolean, + Imagekitio::Internal::Type::Unknown, + Imagekitio::Internal::Type::Boolean, A, H, E, @@ -144,7 +144,7 @@ def test_dump_retry ] types.product(cases).each do |target, input| state = {can_retry: true} - Imagekit::Internal::Type::Converter.dump(target, input, state: state) + Imagekitio::Internal::Type::Converter.dump(target, input, state: state) assert_pattern do state => {can_retry: false} @@ -154,9 +154,9 @@ def test_dump_retry end end -class Imagekit::Test::EnumModelTest < Minitest::Test +class Imagekitio::Test::EnumModelTest < Minitest::Test class E0 - include Imagekit::Internal::Type::Enum + include Imagekitio::Internal::Type::Enum attr_reader :values @@ -164,27 +164,27 @@ def initialize(*values) = (@values = values) end module E1 - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum TRUE = true end module E2 - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum ONE = 1 TWO = 2 end module E3 - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum ONE = 1.0 TWO = 2.0 end module E4 - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum ONE = :one TWO = :two @@ -219,9 +219,9 @@ def test_coerce cases.each do |lhs, rhs| target, input = lhs exactness, expect = rhs - state = Imagekit::Internal::Type::Converter.new_coerce_state + state = Imagekitio::Internal::Type::Converter.new_coerce_state assert_pattern do - Imagekit::Internal::Type::Converter.coerce(target, input, state: state) => ^expect + Imagekitio::Internal::Type::Converter.coerce(target, input, state: state) => ^expect state.fetch(:exactness).filter { _2.nonzero? }.to_h => ^exactness end end @@ -249,21 +249,21 @@ def test_dump target, input = _1 expect = _2 assert_pattern do - Imagekit::Internal::Type::Converter.dump(target, input) => ^expect + Imagekitio::Internal::Type::Converter.dump(target, input) => ^expect end end end end -class Imagekit::Test::CollectionModelTest < Minitest::Test - A1 = Imagekit::Internal::Type::ArrayOf[-> { Integer }] - H1 = Imagekit::Internal::Type::HashOf[Integer] +class Imagekitio::Test::CollectionModelTest < Minitest::Test + A1 = Imagekitio::Internal::Type::ArrayOf[-> { Integer }] + H1 = Imagekitio::Internal::Type::HashOf[Integer] - A2 = Imagekit::Internal::Type::ArrayOf[H1] - H2 = Imagekit::Internal::Type::HashOf[-> { A1 }] + A2 = Imagekitio::Internal::Type::ArrayOf[H1] + H2 = Imagekitio::Internal::Type::HashOf[-> { A1 }] - A3 = Imagekit::Internal::Type::ArrayOf[Integer, nil?: true] - H3 = Imagekit::Internal::Type::HashOf[Integer, nil?: true] + A3 = Imagekitio::Internal::Type::ArrayOf[Integer, nil?: true] + H3 = Imagekitio::Internal::Type::HashOf[Integer, nil?: true] def test_coerce cases = { @@ -293,17 +293,17 @@ def test_coerce cases.each do |lhs, rhs| target, input = lhs exactness, expect = rhs - state = Imagekit::Internal::Type::Converter.new_coerce_state + state = Imagekitio::Internal::Type::Converter.new_coerce_state assert_pattern do - Imagekit::Internal::Type::Converter.coerce(target, input, state: state) => ^expect + Imagekitio::Internal::Type::Converter.coerce(target, input, state: state) => ^expect state.fetch(:exactness).filter { _2.nonzero? }.to_h => ^exactness end end end end -class Imagekit::Test::BaseModelTest < Minitest::Test - class M1 < Imagekit::Internal::Type::BaseModel +class Imagekitio::Test::BaseModelTest < Minitest::Test + class M1 < Imagekitio::Internal::Type::BaseModel required :a, Integer end @@ -313,7 +313,7 @@ class M2 < M1 optional :c, String end - class M3 < Imagekit::Internal::Type::BaseModel + class M3 < Imagekitio::Internal::Type::BaseModel optional :c, const: :c required :d, const: :d end @@ -330,7 +330,7 @@ class M4 < M1 end end - class M5 < Imagekit::Internal::Type::BaseModel + class M5 < Imagekitio::Internal::Type::BaseModel request_only do required :c, const: :c end @@ -341,7 +341,7 @@ class M5 < Imagekit::Internal::Type::BaseModel end class M6 < M1 - required :a, Imagekit::Internal::Type::ArrayOf[M6] + required :a, Imagekitio::Internal::Type::ArrayOf[M6] optional :b, M6 end @@ -375,11 +375,11 @@ def test_coerce cases.each do |lhs, rhs| target, input = lhs exactness, expect = rhs - state = Imagekit::Internal::Type::Converter.new_coerce_state + state = Imagekitio::Internal::Type::Converter.new_coerce_state assert_pattern do - coerced = Imagekit::Internal::Type::Converter.coerce(target, input, state: state) + coerced = Imagekitio::Internal::Type::Converter.coerce(target, input, state: state) assert_equal(coerced, coerced) - if coerced.is_a?(Imagekit::Internal::Type::BaseModel) + if coerced.is_a?(Imagekitio::Internal::Type::BaseModel) coerced.to_h => ^expect else coerced => ^expect @@ -407,7 +407,7 @@ def test_dump target, input = _1 expect = _2 assert_pattern do - Imagekit::Internal::Type::Converter.dump(target, input) => ^expect + Imagekitio::Internal::Type::Converter.dump(target, input) => ^expect end end end @@ -439,7 +439,7 @@ def test_accessors tap do target.public_send(accessor) flunk - rescue Imagekit::Errors::ConversionError => e + rescue Imagekitio::Errors::ConversionError => e assert_kind_of(expect, e.cause) end else @@ -468,32 +468,32 @@ def test_inplace_modification end end -class Imagekit::Test::UnionTest < Minitest::Test +class Imagekitio::Test::UnionTest < Minitest::Test class U0 - include Imagekit::Internal::Type::Union + include Imagekitio::Internal::Type::Union def initialize(*variants) = variants.each { variant(_1) } end module U1 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant const: :a variant const: 2 end - class M1 < Imagekit::Internal::Type::BaseModel + class M1 < Imagekitio::Internal::Type::BaseModel required :t, const: :a, api_name: :type optional :c, String end - class M2 < Imagekit::Internal::Type::BaseModel + class M2 < Imagekitio::Internal::Type::BaseModel required :type, const: :b optional :c, String end module U2 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type @@ -502,7 +502,7 @@ module U2 end module U3 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type @@ -511,7 +511,7 @@ module U3 end module U4 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union discriminator :type @@ -519,30 +519,30 @@ module U4 variant :a, M1 end - class M3 < Imagekit::Internal::Type::BaseModel + class M3 < Imagekitio::Internal::Type::BaseModel optional :recur, -> { U5 } required :a, Integer end - class M4 < Imagekit::Internal::Type::BaseModel + class M4 < Imagekitio::Internal::Type::BaseModel optional :recur, -> { U5 } - required :a, Imagekit::Internal::Type::ArrayOf[-> { U5 }] + required :a, Imagekitio::Internal::Type::ArrayOf[-> { U5 }] end - class M5 < Imagekit::Internal::Type::BaseModel + class M5 < Imagekitio::Internal::Type::BaseModel optional :recur, -> { U5 } - required :b, Imagekit::Internal::Type::ArrayOf[-> { U5 }] + required :b, Imagekitio::Internal::Type::ArrayOf[-> { U5 }] end module U5 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant -> { M3 } variant -> { M4 } end module U6 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant -> { M3 } variant -> { M5 } @@ -553,7 +553,7 @@ def test_accessors tap do model.recur flunk - rescue Imagekit::Errors::ConversionError => e + rescue Imagekitio::Errors::ConversionError => e assert_kind_of(ArgumentError, e.cause) end end @@ -587,11 +587,11 @@ def test_coerce cases.each do |lhs, rhs| target, input = lhs exactness, branched, expect = rhs - state = Imagekit::Internal::Type::Converter.new_coerce_state + state = Imagekitio::Internal::Type::Converter.new_coerce_state assert_pattern do - coerced = Imagekit::Internal::Type::Converter.coerce(target, input, state: state) + coerced = Imagekitio::Internal::Type::Converter.coerce(target, input, state: state) assert_equal(coerced, coerced) - if coerced.is_a?(Imagekit::Internal::Type::BaseModel) + if coerced.is_a?(Imagekitio::Internal::Type::BaseModel) coerced.to_h => ^expect else coerced => ^expect @@ -603,9 +603,9 @@ def test_coerce end end -class Imagekit::Test::BaseModelQoLTest < Minitest::Test +class Imagekitio::Test::BaseModelQoLTest < Minitest::Test class E0 - include Imagekit::Internal::Type::Enum + include Imagekitio::Internal::Type::Enum attr_reader :values @@ -613,49 +613,49 @@ def initialize(*values) = (@values = values) end module E1 - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum A = 1 end module E2 - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum A = 1 end module E3 - extend Imagekit::Internal::Type::Enum + extend Imagekitio::Internal::Type::Enum A = 2 B = 3 end class U0 - include Imagekit::Internal::Type::Union + include Imagekitio::Internal::Type::Union def initialize(*variants) = variants.each { variant(_1) } end module U1 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Integer end module U2 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant String variant Integer end - class M1 < Imagekit::Internal::Type::BaseModel + class M1 < Imagekitio::Internal::Type::BaseModel required :a, Integer end - class M2 < Imagekit::Internal::Type::BaseModel + class M2 < Imagekitio::Internal::Type::BaseModel required :a, Integer, nil?: true end @@ -665,9 +665,9 @@ class M3 < M2 def test_equality cases = { - [Imagekit::Internal::Type::Unknown, Imagekit::Internal::Type::Unknown] => true, - [Imagekit::Internal::Type::Boolean, Imagekit::Internal::Type::Boolean] => true, - [Imagekit::Internal::Type::Unknown, Imagekit::Internal::Type::Boolean] => false, + [Imagekitio::Internal::Type::Unknown, Imagekitio::Internal::Type::Unknown] => true, + [Imagekitio::Internal::Type::Boolean, Imagekitio::Internal::Type::Boolean] => true, + [Imagekitio::Internal::Type::Unknown, Imagekitio::Internal::Type::Boolean] => false, [E0.new(:a, :b), E0.new(:a, :b)] => true, [E0.new(:a, :b), E0.new(:b, :a)] => true, [E0.new(:a, :b), E0.new(:b, :c)] => false, @@ -694,17 +694,17 @@ def test_equality end end -class Imagekit::Test::MetaInfoTest < Minitest::Test - A1 = Imagekit::Internal::Type::ArrayOf[Integer, nil?: true, doc: "dog"] - H1 = Imagekit::Internal::Type::HashOf[-> { String }, nil?: true, doc: "dawg"] +class Imagekitio::Test::MetaInfoTest < Minitest::Test + A1 = Imagekitio::Internal::Type::ArrayOf[Integer, nil?: true, doc: "dog"] + H1 = Imagekitio::Internal::Type::HashOf[-> { String }, nil?: true, doc: "dawg"] - class M1 < Imagekit::Internal::Type::BaseModel + class M1 < Imagekitio::Internal::Type::BaseModel required :a, Integer, doc: "dog" optional :b, -> { String }, nil?: true, doc: "dawg" end module U1 - extend Imagekit::Internal::Type::Union + extend Imagekitio::Internal::Type::Union variant -> { Integer }, const: 2, doc: "dog" variant -> { String }, doc: "dawg" diff --git a/test/imagekit/internal/util_test.rb b/test/imagekitio/internal/util_test.rb similarity index 70% rename from test/imagekit/internal/util_test.rb rename to test/imagekitio/internal/util_test.rb index 0f466ef0..976d5b0b 100644 --- a/test/imagekit/internal/util_test.rb +++ b/test/imagekitio/internal/util_test.rb @@ -2,47 +2,47 @@ require_relative "../test_helper" -class Imagekit::Test::UtilDataHandlingTest < Minitest::Test +class Imagekitio::Test::UtilDataHandlingTest < Minitest::Test def test_left_map assert_pattern do - Imagekit::Internal::Util.deep_merge({a: 1}, nil) => nil + Imagekitio::Internal::Util.deep_merge({a: 1}, nil) => nil end end def test_right_map assert_pattern do - Imagekit::Internal::Util.deep_merge(nil, {a: 1}) => {a: 1} + Imagekitio::Internal::Util.deep_merge(nil, {a: 1}) => {a: 1} end end def test_disjoint_maps assert_pattern do - Imagekit::Internal::Util.deep_merge({b: 2}, {a: 1}) => {a: 1, b: 2} + Imagekitio::Internal::Util.deep_merge({b: 2}, {a: 1}) => {a: 1, b: 2} end end def test_overlapping_maps assert_pattern do - Imagekit::Internal::Util.deep_merge({b: 2, c: 3}, {a: 1, c: 4}) => {a: 1, b: 2, c: 4} + Imagekitio::Internal::Util.deep_merge({b: 2, c: 3}, {a: 1, c: 4}) => {a: 1, b: 2, c: 4} end end def test_nested assert_pattern do - Imagekit::Internal::Util.deep_merge({b: {b2: 1}}, {b: {b2: 2}}) => {b: {b2: 2}} + Imagekitio::Internal::Util.deep_merge({b: {b2: 1}}, {b: {b2: 2}}) => {b: {b2: 2}} end end def test_nested_left_map assert_pattern do - Imagekit::Internal::Util.deep_merge({b: {b2: 1}}, {b: 6}) => {b: 6} + Imagekitio::Internal::Util.deep_merge({b: {b2: 1}}, {b: 6}) => {b: 6} end end def test_omission - merged = Imagekit::Internal::Util.deep_merge( + merged = Imagekitio::Internal::Util.deep_merge( {b: {b2: 1, b3: {c: 4, d: 5}}}, - {b: {b2: 1, b3: {c: Imagekit::Internal::OMIT, d: 5}}} + {b: {b2: 1, b3: {c: Imagekitio::Internal::OMIT, d: 5}}} ) assert_pattern do @@ -51,7 +51,7 @@ def test_omission end def test_concat - merged = Imagekit::Internal::Util.deep_merge( + merged = Imagekitio::Internal::Util.deep_merge( {a: {b: [1, 2]}}, {a: {b: [3, 4]}}, concat: true @@ -63,7 +63,7 @@ def test_concat end def test_concat_false - merged = Imagekit::Internal::Util.deep_merge( + merged = Imagekitio::Internal::Util.deep_merge( {a: {b: [1, 2]}}, {a: {b: [3, 4]}}, concat: false @@ -76,36 +76,36 @@ def test_concat_false def test_dig assert_pattern do - Imagekit::Internal::Util.dig(1, nil) => 1 - Imagekit::Internal::Util.dig({a: 1}, :b) => nil - Imagekit::Internal::Util.dig({a: 1}, :a) => 1 - Imagekit::Internal::Util.dig({a: {b: 1}}, [:a, :b]) => 1 + Imagekitio::Internal::Util.dig(1, nil) => 1 + Imagekitio::Internal::Util.dig({a: 1}, :b) => nil + Imagekitio::Internal::Util.dig({a: 1}, :a) => 1 + Imagekitio::Internal::Util.dig({a: {b: 1}}, [:a, :b]) => 1 - Imagekit::Internal::Util.dig([], 1) => nil - Imagekit::Internal::Util.dig([nil, [nil, 1]], [1, 1]) => 1 - Imagekit::Internal::Util.dig({a: [nil, 1]}, [:a, 1]) => 1 - Imagekit::Internal::Util.dig([], 1.0) => nil + Imagekitio::Internal::Util.dig([], 1) => nil + Imagekitio::Internal::Util.dig([nil, [nil, 1]], [1, 1]) => 1 + Imagekitio::Internal::Util.dig({a: [nil, 1]}, [:a, 1]) => 1 + Imagekitio::Internal::Util.dig([], 1.0) => nil - Imagekit::Internal::Util.dig(Object, 1) => nil - Imagekit::Internal::Util.dig([], 1.0) { 2 } => 2 - Imagekit::Internal::Util.dig([], ->(_) { 2 }) => 2 - Imagekit::Internal::Util.dig([1], -> { _1 in [1] }) => true + Imagekitio::Internal::Util.dig(Object, 1) => nil + Imagekitio::Internal::Util.dig([], 1.0) { 2 } => 2 + Imagekitio::Internal::Util.dig([], ->(_) { 2 }) => 2 + Imagekitio::Internal::Util.dig([1], -> { _1 in [1] }) => true end end end -class Imagekit::Test::UtilUriHandlingTest < Minitest::Test +class Imagekitio::Test::UtilUriHandlingTest < Minitest::Test def test_parsing %w[ http://example.com https://example.com/ https://example.com:443/example?e1=e1&e2=e2&e= ].each do |url| - parsed = Imagekit::Internal::Util.parse_uri(url) - unparsed = Imagekit::Internal::Util.unparse_uri(parsed).to_s + parsed = Imagekitio::Internal::Util.parse_uri(url) + unparsed = Imagekitio::Internal::Util.unparse_uri(parsed).to_s assert_equal(url, unparsed) - assert_equal(parsed, Imagekit::Internal::Util.parse_uri(unparsed)) + assert_equal(parsed, Imagekitio::Internal::Util.parse_uri(unparsed)) end end @@ -114,7 +114,7 @@ def test_joining [ "h://a.b/c?d=e", "h://nope/ignored", - Imagekit::Internal::Util.parse_uri("h://a.b/c?d=e") + Imagekitio::Internal::Util.parse_uri("h://a.b/c?d=e") ], [ "h://a.b/c?d=e", @@ -138,8 +138,8 @@ def test_joining cases.each do |expect, lhs, rhs| assert_equal( URI.parse(expect), - Imagekit::Internal::Util.join_parsed_uri( - Imagekit::Internal::Util.parse_uri(lhs), + Imagekitio::Internal::Util.join_parsed_uri( + Imagekitio::Internal::Util.parse_uri(lhs), rhs ) ) @@ -157,8 +157,8 @@ def test_joining_queries cases.each do |path, expected| assert_equal( URI.parse(expected), - Imagekit::Internal::Util.join_parsed_uri( - Imagekit::Internal::Util.parse_uri(base_url), + Imagekitio::Internal::Util.join_parsed_uri( + Imagekitio::Internal::Util.parse_uri(base_url), {path: path} ) ) @@ -166,7 +166,7 @@ def test_joining_queries end end -class Imagekit::Test::RegexMatchTest < Minitest::Test +class Imagekitio::Test::RegexMatchTest < Minitest::Test def test_json_content cases = { "application/json" => true, @@ -176,7 +176,7 @@ def test_json_content } cases.each do |header, verdict| assert_pattern do - Imagekit::Internal::Util::JSON_CONTENT.match?(header) => ^verdict + Imagekitio::Internal::Util::JSON_CONTENT.match?(header) => ^verdict end end end @@ -192,19 +192,19 @@ def test_jsonl_content } cases.each do |header, verdict| assert_pattern do - Imagekit::Internal::Util::JSONL_CONTENT.match?(header) => ^verdict + Imagekitio::Internal::Util::JSONL_CONTENT.match?(header) => ^verdict end end end end -class Imagekit::Test::UtilFormDataEncodingTest < Minitest::Test +class Imagekitio::Test::UtilFormDataEncodingTest < Minitest::Test class FakeCGI < CGI def initialize(headers, io) encoded = io.to_a @ctype = headers["content-type"] # rubocop:disable Lint/EmptyBlock - @io = Imagekit::Internal::Util::ReadIOAdapter.new(encoded.to_enum) {} + @io = Imagekitio::Internal::Util::ReadIOAdapter.new(encoded.to_enum) {} # rubocop:enable Lint/EmptyBlock @c_len = encoded.join.bytesize.to_s super() @@ -222,7 +222,7 @@ def env_table end def test_encoding_length - headers, = Imagekit::Internal::Util.encode_content( + headers, = Imagekitio::Internal::Util.encode_content( {"content-type" => "multipart/form-data"}, Pathname(__FILE__) ) @@ -235,19 +235,19 @@ def test_encoding_length def test_file_encode file = Pathname(__FILE__) - fileinput = Imagekit::Internal::Type::Converter.dump(Imagekit::Internal::Type::FileInput, "abc") + fileinput = Imagekitio::Internal::Type::Converter.dump(Imagekitio::Internal::Type::FileInput, "abc") headers = {"content-type" => "multipart/form-data"} cases = { "abc" => ["", "abc"], StringIO.new("abc") => ["", "abc"], fileinput => %w[upload abc], - Imagekit::FilePart.new(StringIO.new("abc")) => ["", "abc"], - file => [file.basename.to_path, /^class Imagekit/], - Imagekit::FilePart.new(file, filename: "d o g") => ["d%20o%20g", /^class Imagekit/] + Imagekitio::FilePart.new(StringIO.new("abc")) => ["", "abc"], + file => [file.basename.to_path, /^class Imagekitio/], + Imagekitio::FilePart.new(file, filename: "d o g") => ["d%20o%20g", /^class Imagekitio/] } cases.each do |body, testcase| filename, val = testcase - encoded = Imagekit::Internal::Util.encode_content(headers, body) + encoded = Imagekitio::Internal::Util.encode_content(headers, body) cgi = FakeCGI.new(*encoded) io = cgi[""] assert_pattern do @@ -264,12 +264,12 @@ def test_hash_encode {a: 2, b: nil} => {"a" => "2", "b" => "null"}, {a: 2, b: [1, 2, 3]} => {"a" => "2", "b" => "1"}, {strio: StringIO.new("a")} => {"strio" => "a"}, - {strio: Imagekit::FilePart.new("a")} => {"strio" => "a"}, - {pathname: Pathname(__FILE__)} => {"pathname" => -> { _1.read in /^class Imagekit/ }}, - {pathname: Imagekit::FilePart.new(Pathname(__FILE__))} => {"pathname" => -> { _1.read in /^class Imagekit/ }} + {strio: Imagekitio::FilePart.new("a")} => {"strio" => "a"}, + {pathname: Pathname(__FILE__)} => {"pathname" => -> { _1.read in /^class Imagekitio/ }}, + {pathname: Imagekitio::FilePart.new(Pathname(__FILE__))} => {"pathname" => -> { _1.read in /^class Imagekitio/ }} } cases.each do |body, testcase| - encoded = Imagekit::Internal::Util.encode_content(headers, body) + encoded = Imagekitio::Internal::Util.encode_content(headers, body) cgi = FakeCGI.new(*encoded) testcase.each do |key, val| assert_pattern do @@ -287,7 +287,7 @@ def test_hash_encode end end -class Imagekit::Test::UtilIOAdapterTest < Minitest::Test +class Imagekitio::Test::UtilIOAdapterTest < Minitest::Test def test_copy_read cases = { StringIO.new("abc") => "abc", @@ -296,7 +296,7 @@ def test_copy_read cases.each do |input, expected| io = StringIO.new # rubocop:disable Lint/EmptyBlock - adapter = Imagekit::Internal::Util::ReadIOAdapter.new(input) {} + adapter = Imagekitio::Internal::Util::ReadIOAdapter.new(input) {} # rubocop:enable Lint/EmptyBlock IO.copy_stream(adapter, io) assert_equal(expected, io.string) @@ -309,7 +309,7 @@ def test_copy_write StringIO.new("abc") => "abc" } cases.each do |input, expected| - enum = Imagekit::Internal::Util.writable_enum do |y| + enum = Imagekitio::Internal::Util.writable_enum do |y| IO.copy_stream(input, y) end assert_equal(expected, enum.to_a.join) @@ -317,7 +317,7 @@ def test_copy_write end end -class Imagekit::Test::UtilFusedEnumTest < Minitest::Test +class Imagekitio::Test::UtilFusedEnumTest < Minitest::Test def test_rewind_closing touched = false once = 0 @@ -333,11 +333,11 @@ def test_rewind_closing once = once.succ end - fused = Imagekit::Internal::Util.fused_enum(enum, external: true) do + fused = Imagekitio::Internal::Util.fused_enum(enum, external: true) do touched = true loop { enum.next } end - Imagekit::Internal::Util.close_fused!(fused) + Imagekitio::Internal::Util.close_fused!(fused) assert_equal(1, once) assert_equal(0, steps) @@ -352,9 +352,9 @@ def test_thread_interrupts once = once.succ end - fused_1 = Imagekit::Internal::Util.fused_enum(enum, external: true) { loop { enum.next } } - fused_2 = Imagekit::Internal::Util.chain_fused(fused_1) { fused_1.each(&_1) } - fused_3 = Imagekit::Internal::Util.chain_fused(fused_2) { fused_2.each(&_1) } + fused_1 = Imagekitio::Internal::Util.fused_enum(enum, external: true) { loop { enum.next } } + fused_2 = Imagekitio::Internal::Util.chain_fused(fused_1) { fused_1.each(&_1) } + fused_3 = Imagekitio::Internal::Util.chain_fused(fused_2) { fused_2.each(&_1) } th = ::Thread.new do que << "🐶" @@ -369,7 +369,7 @@ def test_thread_interrupts def test_closing arr = [1, 2, 3] once = 0 - fused = Imagekit::Internal::Util.fused_enum(arr.to_enum) do + fused = Imagekitio::Internal::Util.fused_enum(arr.to_enum) do once = once.succ end @@ -384,7 +384,7 @@ def test_closing def test_rewind_chain once = 0 - fused = Imagekit::Internal::Util.fused_enum([1, 2, 3].to_enum) do + fused = Imagekitio::Internal::Util.fused_enum([1, 2, 3].to_enum) do once = once.succ end .lazy @@ -401,7 +401,7 @@ def test_rewind_chain def test_external_iteration iter = [1, 2, 3].to_enum first = iter.next - fused = Imagekit::Internal::Util.fused_enum(iter, external: true) + fused = Imagekitio::Internal::Util.fused_enum(iter, external: true) assert_equal(1, first) assert_equal([2, 3], fused.to_a) @@ -409,11 +409,11 @@ def test_external_iteration def test_close_fused once = 0 - fused = Imagekit::Internal::Util.fused_enum([1, 2, 3].to_enum) do + fused = Imagekitio::Internal::Util.fused_enum([1, 2, 3].to_enum) do once = once.succ end - Imagekit::Internal::Util.close_fused!(fused) + Imagekitio::Internal::Util.close_fused!(fused) assert_equal(1, once) assert_equal([], fused.to_a) @@ -426,11 +426,11 @@ def test_closed_fused_extern_iteration taken = taken.succ _1 end - fused = Imagekit::Internal::Util.fused_enum(enum) + fused = Imagekitio::Internal::Util.fused_enum(enum) first = fused.next assert_equal(1, first) - Imagekit::Internal::Util.close_fused!(fused) + Imagekitio::Internal::Util.close_fused!(fused) assert_equal(1, taken) end @@ -442,10 +442,10 @@ def test_closed_fused_taken_count end .map(&:succ) .filter(&:odd?) - fused = Imagekit::Internal::Util.fused_enum(enum) + fused = Imagekitio::Internal::Util.fused_enum(enum) assert_equal(0, taken) - Imagekit::Internal::Util.close_fused!(fused) + Imagekitio::Internal::Util.close_fused!(fused) assert_equal(0, taken) end @@ -461,8 +461,8 @@ def test_closed_fused_extern_iter_taken_count assert_equal(2, first) assert_equal(1, taken) - fused = Imagekit::Internal::Util.fused_enum(enum) - Imagekit::Internal::Util.close_fused!(fused) + fused = Imagekitio::Internal::Util.fused_enum(enum) + Imagekitio::Internal::Util.close_fused!(fused) assert_equal(1, taken) end @@ -476,17 +476,17 @@ def test_close_fused_sse_chain .filter(&:odd?) .map(&:to_s) - fused_1 = Imagekit::Internal::Util.fused_enum(enum) - fused_2 = Imagekit::Internal::Util.decode_lines(fused_1) - fused_3 = Imagekit::Internal::Util.decode_sse(fused_2) + fused_1 = Imagekitio::Internal::Util.fused_enum(enum) + fused_2 = Imagekitio::Internal::Util.decode_lines(fused_1) + fused_3 = Imagekitio::Internal::Util.decode_sse(fused_2) assert_equal(0, taken) - Imagekit::Internal::Util.close_fused!(fused_3) + Imagekitio::Internal::Util.close_fused!(fused_3) assert_equal(0, taken) end end -class Imagekit::Test::UtilContentDecodingTest < Minitest::Test +class Imagekitio::Test::UtilContentDecodingTest < Minitest::Test def test_charset cases = { "application/json" => Encoding::BINARY, @@ -498,13 +498,13 @@ def test_charset } text = String.new.force_encoding(Encoding::BINARY) cases.each do |content_type, encoding| - Imagekit::Internal::Util.force_charset!(content_type, text: text) + Imagekitio::Internal::Util.force_charset!(content_type, text: text) assert_equal(encoding, text.encoding) end end end -class Imagekit::Test::UtilSseTest < Minitest::Test +class Imagekitio::Test::UtilSseTest < Minitest::Test def test_decode_lines cases = { %w[] => %w[], @@ -524,7 +524,7 @@ def test_decode_lines eols = %W[\n \r \r\n] cases.each do |enum, expected| eols.each do |eol| - lines = Imagekit::Internal::Util.decode_lines(enum.map { _1.gsub("\n", eol) }) + lines = Imagekitio::Internal::Util.decode_lines(enum.map { _1.gsub("\n", eol) }) assert_equal(expected.map { _1.gsub("\n", eol) }, lines.to_a, "eol=#{JSON.generate(eol)}") end end @@ -542,7 +542,7 @@ def test_mixed_decode_lines %W[\n\r] => %W[\n \r] } cases.each do |enum, expected| - lines = Imagekit::Internal::Util.decode_lines(enum) + lines = Imagekitio::Internal::Util.decode_lines(enum) assert_equal(expected, lines.to_a) end end @@ -665,7 +665,7 @@ def test_decode_sse cases.each do |name, test_cases| test_cases.each do |input, expected| - actual = Imagekit::Internal::Util.decode_sse(input).map(&:compact) + actual = Imagekitio::Internal::Util.decode_sse(input).map(&:compact) assert_equal(expected, actual, name) end end diff --git a/test/imagekit/resource_namespaces.rb b/test/imagekitio/resource_namespaces.rb similarity index 94% rename from test/imagekit/resource_namespaces.rb rename to test/imagekitio/resource_namespaces.rb index 52347d84..59132586 100644 --- a/test/imagekit/resource_namespaces.rb +++ b/test/imagekitio/resource_namespaces.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module Imagekit +module Imagekitio module Test module Resources module Accounts diff --git a/test/imagekit/resources/accounts/origins_test.rb b/test/imagekitio/resources/accounts/origins_test.rb similarity index 62% rename from test/imagekit/resources/accounts/origins_test.rb rename to test/imagekitio/resources/accounts/origins_test.rb index 87930425..49f7a48f 100644 --- a/test/imagekit/resources/accounts/origins_test.rb +++ b/test/imagekitio/resources/accounts/origins_test.rb @@ -2,7 +2,7 @@ require_relative "../../test_helper" -class Imagekit::Test::Resources::Accounts::OriginsTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::Accounts::OriginsTest < Imagekitio::Test::ResourceTest def test_create_required_params skip("Prism tests are disabled") @@ -18,19 +18,19 @@ def test_create_required_params ) assert_pattern do - response => Imagekit::Accounts::OriginResponse + response => Imagekitio::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Accounts::OriginResponse::S3 - in Imagekit::Accounts::OriginResponse::S3Compatible - in Imagekit::Accounts::OriginResponse::CloudinaryBackup - in Imagekit::Accounts::OriginResponse::WebFolder - in Imagekit::Accounts::OriginResponse::WebProxy - in Imagekit::Accounts::OriginResponse::Gcs - in Imagekit::Accounts::OriginResponse::AzureBlob - in Imagekit::Accounts::OriginResponse::AkeneoPim + in Imagekitio::Accounts::OriginResponse::S3 + in Imagekitio::Accounts::OriginResponse::S3Compatible + in Imagekitio::Accounts::OriginResponse::CloudinaryBackup + in Imagekitio::Accounts::OriginResponse::WebFolder + in Imagekitio::Accounts::OriginResponse::WebProxy + in Imagekitio::Accounts::OriginResponse::Gcs + in Imagekitio::Accounts::OriginResponse::AzureBlob + in Imagekitio::Accounts::OriginResponse::AkeneoPim end end @@ -40,7 +40,7 @@ def test_create_required_params type: :S3, id: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -50,17 +50,17 @@ def test_create_required_params id: String, bucket: String, endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, + s3_force_path_style: Imagekitio::Internal::Type::Boolean, base_url_for_canonical_header: String | nil } in { type: :CLOUDINARY_BACKUP, id: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -69,15 +69,15 @@ def test_create_required_params type: :WEB_FOLDER, id: String, base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, + forward_host_header_to_origin: Imagekitio::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } in { type: :WEB_PROXY, id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } @@ -86,7 +86,7 @@ def test_create_required_params id: String, bucket: String, client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -96,7 +96,7 @@ def test_create_required_params id: String, account_name: String, container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -105,7 +105,7 @@ def test_create_required_params type: :AKENEO_PIM, id: String, base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } @@ -129,19 +129,19 @@ def test_update_required_params ) assert_pattern do - response => Imagekit::Accounts::OriginResponse + response => Imagekitio::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Accounts::OriginResponse::S3 - in Imagekit::Accounts::OriginResponse::S3Compatible - in Imagekit::Accounts::OriginResponse::CloudinaryBackup - in Imagekit::Accounts::OriginResponse::WebFolder - in Imagekit::Accounts::OriginResponse::WebProxy - in Imagekit::Accounts::OriginResponse::Gcs - in Imagekit::Accounts::OriginResponse::AzureBlob - in Imagekit::Accounts::OriginResponse::AkeneoPim + in Imagekitio::Accounts::OriginResponse::S3 + in Imagekitio::Accounts::OriginResponse::S3Compatible + in Imagekitio::Accounts::OriginResponse::CloudinaryBackup + in Imagekitio::Accounts::OriginResponse::WebFolder + in Imagekitio::Accounts::OriginResponse::WebProxy + in Imagekitio::Accounts::OriginResponse::Gcs + in Imagekitio::Accounts::OriginResponse::AzureBlob + in Imagekitio::Accounts::OriginResponse::AkeneoPim end end @@ -151,7 +151,7 @@ def test_update_required_params type: :S3, id: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -161,17 +161,17 @@ def test_update_required_params id: String, bucket: String, endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, + s3_force_path_style: Imagekitio::Internal::Type::Boolean, base_url_for_canonical_header: String | nil } in { type: :CLOUDINARY_BACKUP, id: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -180,15 +180,15 @@ def test_update_required_params type: :WEB_FOLDER, id: String, base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, + forward_host_header_to_origin: Imagekitio::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } in { type: :WEB_PROXY, id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } @@ -197,7 +197,7 @@ def test_update_required_params id: String, bucket: String, client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -207,7 +207,7 @@ def test_update_required_params id: String, account_name: String, container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -216,7 +216,7 @@ def test_update_required_params type: :AKENEO_PIM, id: String, base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } @@ -230,7 +230,7 @@ def test_list response = @image_kit.accounts.origins.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Accounts::OriginResponse]) + response => ^(Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Accounts::OriginResponse]) end end @@ -250,19 +250,19 @@ def test_get response = @image_kit.accounts.origins.get("id") assert_pattern do - response => Imagekit::Accounts::OriginResponse + response => Imagekitio::Accounts::OriginResponse end assert_pattern do case response - in Imagekit::Accounts::OriginResponse::S3 - in Imagekit::Accounts::OriginResponse::S3Compatible - in Imagekit::Accounts::OriginResponse::CloudinaryBackup - in Imagekit::Accounts::OriginResponse::WebFolder - in Imagekit::Accounts::OriginResponse::WebProxy - in Imagekit::Accounts::OriginResponse::Gcs - in Imagekit::Accounts::OriginResponse::AzureBlob - in Imagekit::Accounts::OriginResponse::AkeneoPim + in Imagekitio::Accounts::OriginResponse::S3 + in Imagekitio::Accounts::OriginResponse::S3Compatible + in Imagekitio::Accounts::OriginResponse::CloudinaryBackup + in Imagekitio::Accounts::OriginResponse::WebFolder + in Imagekitio::Accounts::OriginResponse::WebProxy + in Imagekitio::Accounts::OriginResponse::Gcs + in Imagekitio::Accounts::OriginResponse::AzureBlob + in Imagekitio::Accounts::OriginResponse::AkeneoPim end end @@ -272,7 +272,7 @@ def test_get type: :S3, id: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -282,17 +282,17 @@ def test_get id: String, bucket: String, endpoint: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, - s3_force_path_style: Imagekit::Internal::Type::Boolean, + s3_force_path_style: Imagekitio::Internal::Type::Boolean, base_url_for_canonical_header: String | nil } in { type: :CLOUDINARY_BACKUP, id: String, bucket: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -301,15 +301,15 @@ def test_get type: :WEB_FOLDER, id: String, base_url: String, - forward_host_header_to_origin: Imagekit::Internal::Type::Boolean, - include_canonical_header: Imagekit::Internal::Type::Boolean, + forward_host_header_to_origin: Imagekitio::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } in { type: :WEB_PROXY, id: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } @@ -318,7 +318,7 @@ def test_get id: String, bucket: String, client_email: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -328,7 +328,7 @@ def test_get id: String, account_name: String, container: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, prefix: String, base_url_for_canonical_header: String | nil @@ -337,7 +337,7 @@ def test_get type: :AKENEO_PIM, id: String, base_url: String, - include_canonical_header: Imagekit::Internal::Type::Boolean, + include_canonical_header: Imagekitio::Internal::Type::Boolean, name: String, base_url_for_canonical_header: String | nil } diff --git a/test/imagekit/resources/accounts/url_endpoints_test.rb b/test/imagekitio/resources/accounts/url_endpoints_test.rb similarity index 62% rename from test/imagekit/resources/accounts/url_endpoints_test.rb rename to test/imagekitio/resources/accounts/url_endpoints_test.rb index 88895a66..fa912642 100644 --- a/test/imagekit/resources/accounts/url_endpoints_test.rb +++ b/test/imagekitio/resources/accounts/url_endpoints_test.rb @@ -2,23 +2,23 @@ require_relative "../../test_helper" -class Imagekit::Test::Resources::Accounts::URLEndpointsTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::Accounts::URLEndpointsTest < Imagekitio::Test::ResourceTest def test_create_required_params skip("Prism tests are disabled") response = @image_kit.accounts.url_endpoints.create(description: "My custom URL endpoint") assert_pattern do - response => Imagekit::Accounts::URLEndpointResponse + response => Imagekitio::Accounts::URLEndpointResponse end assert_pattern do response => { id: String, description: String, - origins: ^(Imagekit::Internal::Type::ArrayOf[String]), + origins: ^(Imagekitio::Internal::Type::ArrayOf[String]), url_prefix: String, - url_rewriter: Imagekit::Accounts::URLEndpointResponse::URLRewriter | nil + url_rewriter: Imagekitio::Accounts::URLEndpointResponse::URLRewriter | nil } end end @@ -29,16 +29,16 @@ def test_update_required_params response = @image_kit.accounts.url_endpoints.update("id", description: "My custom URL endpoint") assert_pattern do - response => Imagekit::Accounts::URLEndpointResponse + response => Imagekitio::Accounts::URLEndpointResponse end assert_pattern do response => { id: String, description: String, - origins: ^(Imagekit::Internal::Type::ArrayOf[String]), + origins: ^(Imagekitio::Internal::Type::ArrayOf[String]), url_prefix: String, - url_rewriter: Imagekit::Accounts::URLEndpointResponse::URLRewriter | nil + url_rewriter: Imagekitio::Accounts::URLEndpointResponse::URLRewriter | nil } end end @@ -49,7 +49,7 @@ def test_list response = @image_kit.accounts.url_endpoints.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Accounts::URLEndpointResponse]) + response => ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::URLEndpointResponse]) end end @@ -69,16 +69,16 @@ def test_get response = @image_kit.accounts.url_endpoints.get("id") assert_pattern do - response => Imagekit::Accounts::URLEndpointResponse + response => Imagekitio::Accounts::URLEndpointResponse end assert_pattern do response => { id: String, description: String, - origins: ^(Imagekit::Internal::Type::ArrayOf[String]), + origins: ^(Imagekitio::Internal::Type::ArrayOf[String]), url_prefix: String, - url_rewriter: Imagekit::Accounts::URLEndpointResponse::URLRewriter | nil + url_rewriter: Imagekitio::Accounts::URLEndpointResponse::URLRewriter | nil } end end diff --git a/test/imagekit/resources/accounts/usage_test.rb b/test/imagekitio/resources/accounts/usage_test.rb similarity index 79% rename from test/imagekit/resources/accounts/usage_test.rb rename to test/imagekitio/resources/accounts/usage_test.rb index 30337d45..f928f45c 100644 --- a/test/imagekit/resources/accounts/usage_test.rb +++ b/test/imagekitio/resources/accounts/usage_test.rb @@ -2,14 +2,14 @@ require_relative "../../test_helper" -class Imagekit::Test::Resources::Accounts::UsageTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::Accounts::UsageTest < Imagekitio::Test::ResourceTest def test_get_required_params skip("Prism tests are disabled") response = @image_kit.accounts.usage.get(end_date: "2019-12-27", start_date: "2019-12-27") assert_pattern do - response => Imagekit::Models::Accounts::UsageGetResponse + response => Imagekitio::Models::Accounts::UsageGetResponse end assert_pattern do diff --git a/test/imagekitio/resources/accounts_test.rb b/test/imagekitio/resources/accounts_test.rb new file mode 100644 index 00000000..c92620cf --- /dev/null +++ b/test/imagekitio/resources/accounts_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekitio::Test::Resources::AccountsTest < Imagekitio::Test::ResourceTest +end diff --git a/test/imagekit/resources/assets_test.rb b/test/imagekitio/resources/assets_test.rb similarity index 51% rename from test/imagekit/resources/assets_test.rb rename to test/imagekitio/resources/assets_test.rb index 31121c1c..f4b2148c 100644 --- a/test/imagekit/resources/assets_test.rb +++ b/test/imagekitio/resources/assets_test.rb @@ -2,14 +2,14 @@ require_relative "../test_helper" -class Imagekit::Test::Resources::AssetsTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::AssetsTest < Imagekitio::Test::ResourceTest def test_list skip("Prism tests are disabled") response = @image_kit.assets.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[union: Imagekit::Models::AssetListResponseItem]) + response => ^(Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Models::AssetListResponseItem]) end end end diff --git a/test/imagekitio/resources/beta/v2/files_test.rb b/test/imagekitio/resources/beta/v2/files_test.rb new file mode 100644 index 00000000..640bff4e --- /dev/null +++ b/test/imagekitio/resources/beta/v2/files_test.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +require_relative "../../../test_helper" + +class Imagekitio::Test::Resources::Beta::V2::FilesTest < Imagekitio::Test::ResourceTest + def test_upload_required_params + skip("Prism tests are disabled") + + response = @image_kit.beta.v2.files.upload(file: Pathname(__FILE__), file_name: "fileName") + + assert_pattern do + response => Imagekitio::Models::Beta::V2::FileUploadResponse + end + + assert_pattern do + response => { + ai_tags: ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::Models::Beta::V2::FileUploadResponse::AITag]) | nil, + audio_codec: String | nil, + bit_rate: Integer | nil, + custom_coordinates: String | nil, + custom_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, + description: String | nil, + duration: Integer | nil, + embedded_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, + extension_status: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus | nil, + file_id: String | nil, + file_path: String | nil, + file_type: String | nil, + height: Float | nil, + is_private_file: Imagekitio::Internal::Type::Boolean | nil, + is_published: Imagekitio::Internal::Type::Boolean | nil, + metadata: Imagekitio::Metadata | nil, + name: String | nil, + selected_fields_schema: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema]) | nil, + size: Float | nil, + tags: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil, + thumbnail_url: String | nil, + url: String | nil, + version_info: Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo | nil, + video_codec: String | nil, + width: Float | nil + } + end + end +end diff --git a/test/imagekitio/resources/beta/v2_test.rb b/test/imagekitio/resources/beta/v2_test.rb new file mode 100644 index 00000000..16e52867 --- /dev/null +++ b/test/imagekitio/resources/beta/v2_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class Imagekitio::Test::Resources::Beta::V2Test < Imagekitio::Test::ResourceTest +end diff --git a/test/imagekit/resources/webhooks_test.rb b/test/imagekitio/resources/beta_test.rb similarity index 56% rename from test/imagekit/resources/webhooks_test.rb rename to test/imagekitio/resources/beta_test.rb index 2b78db80..bdd0a2cd 100644 --- a/test/imagekit/resources/webhooks_test.rb +++ b/test/imagekitio/resources/beta_test.rb @@ -2,5 +2,5 @@ require_relative "../test_helper" -class Imagekit::Test::Resources::WebhooksTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::BetaTest < Imagekitio::Test::ResourceTest end diff --git a/test/imagekit/resources/cache/invalidation_test.rb b/test/imagekitio/resources/cache/invalidation_test.rb similarity index 66% rename from test/imagekit/resources/cache/invalidation_test.rb rename to test/imagekitio/resources/cache/invalidation_test.rb index e732093a..2d29a047 100644 --- a/test/imagekit/resources/cache/invalidation_test.rb +++ b/test/imagekitio/resources/cache/invalidation_test.rb @@ -2,7 +2,7 @@ require_relative "../../test_helper" -class Imagekit::Test::Resources::Cache::InvalidationTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::Cache::InvalidationTest < Imagekitio::Test::ResourceTest def test_create_required_params skip("Prism tests are disabled") @@ -10,7 +10,7 @@ def test_create_required_params @image_kit.cache.invalidation.create(url: "https://ik.imagekit.io/your_imagekit_id/default-image.jpg") assert_pattern do - response => Imagekit::Models::Cache::InvalidationCreateResponse + response => Imagekitio::Models::Cache::InvalidationCreateResponse end assert_pattern do @@ -26,12 +26,12 @@ def test_get response = @image_kit.cache.invalidation.get("requestId") assert_pattern do - response => Imagekit::Models::Cache::InvalidationGetResponse + response => Imagekitio::Models::Cache::InvalidationGetResponse end assert_pattern do response => { - status: Imagekit::Models::Cache::InvalidationGetResponse::Status | nil + status: Imagekitio::Models::Cache::InvalidationGetResponse::Status | nil } end end diff --git a/test/imagekitio/resources/cache_test.rb b/test/imagekitio/resources/cache_test.rb new file mode 100644 index 00000000..4cfa1044 --- /dev/null +++ b/test/imagekitio/resources/cache_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekitio::Test::Resources::CacheTest < Imagekitio::Test::ResourceTest +end diff --git a/test/imagekit/resources/custom_metadata_fields_test.rb b/test/imagekitio/resources/custom_metadata_fields_test.rb similarity index 69% rename from test/imagekit/resources/custom_metadata_fields_test.rb rename to test/imagekitio/resources/custom_metadata_fields_test.rb index c87be2e5..fcddba86 100644 --- a/test/imagekit/resources/custom_metadata_fields_test.rb +++ b/test/imagekitio/resources/custom_metadata_fields_test.rb @@ -2,7 +2,7 @@ require_relative "../test_helper" -class Imagekit::Test::Resources::CustomMetadataFieldsTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::CustomMetadataFieldsTest < Imagekitio::Test::ResourceTest def test_create_required_params skip("Prism tests are disabled") @@ -10,7 +10,7 @@ def test_create_required_params @image_kit.custom_metadata_fields.create(label: "price", name: "price", schema: {type: :Number}) assert_pattern do - response => Imagekit::CustomMetadataField + response => Imagekitio::CustomMetadataField end assert_pattern do @@ -18,7 +18,7 @@ def test_create_required_params id: String, label: String, name: String, - schema: Imagekit::CustomMetadataField::Schema + schema: Imagekitio::CustomMetadataField::Schema } end end @@ -29,7 +29,7 @@ def test_update response = @image_kit.custom_metadata_fields.update("id") assert_pattern do - response => Imagekit::CustomMetadataField + response => Imagekitio::CustomMetadataField end assert_pattern do @@ -37,7 +37,7 @@ def test_update id: String, label: String, name: String, - schema: Imagekit::CustomMetadataField::Schema + schema: Imagekitio::CustomMetadataField::Schema } end end @@ -48,7 +48,7 @@ def test_list response = @image_kit.custom_metadata_fields.list assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::CustomMetadataField]) + response => ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::CustomMetadataField]) end end @@ -58,7 +58,7 @@ def test_delete response = @image_kit.custom_metadata_fields.delete("id") assert_pattern do - response => Imagekit::Models::CustomMetadataFieldDeleteResponse + response => Imagekitio::Models::CustomMetadataFieldDeleteResponse end assert_pattern do diff --git a/test/imagekit/resources/files/bulk_test.rb b/test/imagekitio/resources/files/bulk_test.rb similarity index 66% rename from test/imagekit/resources/files/bulk_test.rb rename to test/imagekitio/resources/files/bulk_test.rb index dc86a12b..56991d88 100644 --- a/test/imagekit/resources/files/bulk_test.rb +++ b/test/imagekitio/resources/files/bulk_test.rb @@ -2,7 +2,7 @@ require_relative "../../test_helper" -class Imagekit::Test::Resources::Files::BulkTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::Files::BulkTest < Imagekitio::Test::ResourceTest def test_delete_required_params skip("Prism tests are disabled") @@ -10,12 +10,12 @@ def test_delete_required_params @image_kit.files.bulk.delete(file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be]) assert_pattern do - response => Imagekit::Models::Files::BulkDeleteResponse + response => Imagekitio::Models::Files::BulkDeleteResponse end assert_pattern do response => { - successfully_deleted_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + successfully_deleted_file_ids: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil } end end @@ -30,12 +30,12 @@ def test_add_tags_required_params ) assert_pattern do - response => Imagekit::Models::Files::BulkAddTagsResponse + response => Imagekitio::Models::Files::BulkAddTagsResponse end assert_pattern do response => { - successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + successfully_updated_file_ids: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil } end end @@ -50,12 +50,12 @@ def test_remove_ai_tags_required_params ) assert_pattern do - response => Imagekit::Models::Files::BulkRemoveAITagsResponse + response => Imagekitio::Models::Files::BulkRemoveAITagsResponse end assert_pattern do response => { - successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + successfully_updated_file_ids: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil } end end @@ -70,12 +70,12 @@ def test_remove_tags_required_params ) assert_pattern do - response => Imagekit::Models::Files::BulkRemoveTagsResponse + response => Imagekitio::Models::Files::BulkRemoveTagsResponse end assert_pattern do response => { - successfully_updated_file_ids: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil + successfully_updated_file_ids: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil } end end diff --git a/test/imagekit/resources/files/metadata_test.rb b/test/imagekitio/resources/files/metadata_test.rb similarity index 69% rename from test/imagekit/resources/files/metadata_test.rb rename to test/imagekitio/resources/files/metadata_test.rb index 9a60e643..ce2626ce 100644 --- a/test/imagekit/resources/files/metadata_test.rb +++ b/test/imagekitio/resources/files/metadata_test.rb @@ -2,14 +2,14 @@ require_relative "../../test_helper" -class Imagekit::Test::Resources::Files::MetadataTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::Files::MetadataTest < Imagekitio::Test::ResourceTest def test_get skip("Prism tests are disabled") response = @image_kit.files.metadata.get("fileId") assert_pattern do - response => Imagekit::Metadata + response => Imagekitio::Metadata end assert_pattern do @@ -18,10 +18,10 @@ def test_get bit_rate: Integer | nil, density: Integer | nil, duration: Integer | nil, - exif: Imagekit::Metadata::Exif | nil, + exif: Imagekitio::Metadata::Exif | nil, format_: String | nil, - has_color_profile: Imagekit::Internal::Type::Boolean | nil, - has_transparency: Imagekit::Internal::Type::Boolean | nil, + has_color_profile: Imagekitio::Internal::Type::Boolean | nil, + has_transparency: Imagekitio::Internal::Type::Boolean | nil, height: Integer | nil, p_hash: String | nil, quality: Integer | nil, @@ -38,7 +38,7 @@ def test_get_from_url_required_params response = @image_kit.files.metadata.get_from_url(url: "https://example.com") assert_pattern do - response => Imagekit::Metadata + response => Imagekitio::Metadata end assert_pattern do @@ -47,10 +47,10 @@ def test_get_from_url_required_params bit_rate: Integer | nil, density: Integer | nil, duration: Integer | nil, - exif: Imagekit::Metadata::Exif | nil, + exif: Imagekitio::Metadata::Exif | nil, format_: String | nil, - has_color_profile: Imagekit::Internal::Type::Boolean | nil, - has_transparency: Imagekit::Internal::Type::Boolean | nil, + has_color_profile: Imagekitio::Internal::Type::Boolean | nil, + has_transparency: Imagekitio::Internal::Type::Boolean | nil, height: Integer | nil, p_hash: String | nil, quality: Integer | nil, diff --git a/test/imagekit/resources/files/versions_test.rb b/test/imagekitio/resources/files/versions_test.rb similarity index 52% rename from test/imagekit/resources/files/versions_test.rb rename to test/imagekitio/resources/files/versions_test.rb index a2a71dbf..87eb6878 100644 --- a/test/imagekit/resources/files/versions_test.rb +++ b/test/imagekitio/resources/files/versions_test.rb @@ -2,14 +2,14 @@ require_relative "../../test_helper" -class Imagekit::Test::Resources::Files::VersionsTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::Files::VersionsTest < Imagekitio::Test::ResourceTest def test_list skip("Prism tests are disabled") response = @image_kit.files.versions.list("fileId") assert_pattern do - response => ^(Imagekit::Internal::Type::ArrayOf[Imagekit::File]) + response => ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::File]) end end @@ -19,7 +19,7 @@ def test_delete_required_params response = @image_kit.files.versions.delete("versionId", file_id: "fileId") assert_pattern do - response => Imagekit::Models::Files::VersionDeleteResponse + response => Imagekitio::Models::Files::VersionDeleteResponse end assert_pattern do @@ -35,33 +35,33 @@ def test_get_required_params response = @image_kit.files.versions.get("versionId", file_id: "fileId") assert_pattern do - response => Imagekit::File + response => Imagekitio::File end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::File::AITag]) | nil, + ai_tags: ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag]) | nil, created_at: Time | nil, custom_coordinates: String | nil, - custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + custom_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, description: String | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, - has_alpha: Imagekit::Internal::Type::Boolean | nil, + has_alpha: Imagekitio::Internal::Type::Boolean | nil, height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, + is_private_file: Imagekitio::Internal::Type::Boolean | nil, + is_published: Imagekitio::Internal::Type::Boolean | nil, mime: String | nil, name: String | nil, - selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::File::SelectedFieldsSchema]) | nil, + selected_fields_schema: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::File::SelectedFieldsSchema]) | nil, size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + tags: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: Imagekit::File::Type | nil, + type: Imagekitio::File::Type | nil, updated_at: Time | nil, url: String | nil, - version_info: Imagekit::File::VersionInfo | nil, + version_info: Imagekitio::File::VersionInfo | nil, width: Float | nil } end @@ -73,33 +73,33 @@ def test_restore_required_params response = @image_kit.files.versions.restore("versionId", file_id: "fileId") assert_pattern do - response => Imagekit::File + response => Imagekitio::File end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::File::AITag]) | nil, + ai_tags: ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag]) | nil, created_at: Time | nil, custom_coordinates: String | nil, - custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + custom_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, description: String | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, - has_alpha: Imagekit::Internal::Type::Boolean | nil, + has_alpha: Imagekitio::Internal::Type::Boolean | nil, height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, + is_private_file: Imagekitio::Internal::Type::Boolean | nil, + is_published: Imagekitio::Internal::Type::Boolean | nil, mime: String | nil, name: String | nil, - selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::File::SelectedFieldsSchema]) | nil, + selected_fields_schema: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::File::SelectedFieldsSchema]) | nil, size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + tags: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: Imagekit::File::Type | nil, + type: Imagekitio::File::Type | nil, updated_at: Time | nil, url: String | nil, - version_info: Imagekit::File::VersionInfo | nil, + version_info: Imagekitio::File::VersionInfo | nil, width: Float | nil } end diff --git a/test/imagekit/resources/files_test.rb b/test/imagekitio/resources/files_test.rb similarity index 57% rename from test/imagekit/resources/files_test.rb rename to test/imagekitio/resources/files_test.rb index 427b54ff..21b9d8b1 100644 --- a/test/imagekit/resources/files_test.rb +++ b/test/imagekitio/resources/files_test.rb @@ -2,14 +2,14 @@ require_relative "../test_helper" -class Imagekit::Test::Resources::FilesTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::FilesTest < Imagekitio::Test::ResourceTest def test_update skip("Prism tests are disabled") response = @image_kit.files.update("fileId") assert_pattern do - response => Imagekit::Models::FileUpdateResponse + response => Imagekitio::Models::FileUpdateResponse end end @@ -30,7 +30,7 @@ def test_copy_required_params @image_kit.files.copy(destination_path: "/folder/to/copy/into/", source_file_path: "/path/to/file.jpg") assert_pattern do - response => Imagekit::Models::FileCopyResponse + response => Imagekitio::Models::FileCopyResponse end assert_pattern do @@ -46,33 +46,33 @@ def test_get response = @image_kit.files.get("fileId") assert_pattern do - response => Imagekit::File + response => Imagekitio::File end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::File::AITag]) | nil, + ai_tags: ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag]) | nil, created_at: Time | nil, custom_coordinates: String | nil, - custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + custom_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, description: String | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, - has_alpha: Imagekit::Internal::Type::Boolean | nil, + has_alpha: Imagekitio::Internal::Type::Boolean | nil, height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, + is_private_file: Imagekitio::Internal::Type::Boolean | nil, + is_published: Imagekitio::Internal::Type::Boolean | nil, mime: String | nil, name: String | nil, - selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::File::SelectedFieldsSchema]) | nil, + selected_fields_schema: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::File::SelectedFieldsSchema]) | nil, size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + tags: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil, thumbnail: String | nil, - type: Imagekit::File::Type | nil, + type: Imagekitio::File::Type | nil, updated_at: Time | nil, url: String | nil, - version_info: Imagekit::File::VersionInfo | nil, + version_info: Imagekitio::File::VersionInfo | nil, width: Float | nil } end @@ -85,7 +85,7 @@ def test_move_required_params @image_kit.files.move(destination_path: "/folder/to/move/into/", source_file_path: "/path/to/file.jpg") assert_pattern do - response => Imagekit::Models::FileMoveResponse + response => Imagekitio::Models::FileMoveResponse end assert_pattern do @@ -101,7 +101,7 @@ def test_rename_required_params response = @image_kit.files.rename(file_path: "/path/to/file.jpg", new_file_name: "newFileName.jpg") assert_pattern do - response => Imagekit::Models::FileRenameResponse + response => Imagekitio::Models::FileRenameResponse end assert_pattern do @@ -117,34 +117,34 @@ def test_upload_required_params response = @image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") assert_pattern do - response => Imagekit::Models::FileUploadResponse + response => Imagekitio::Models::FileUploadResponse end assert_pattern do response => { - ai_tags: ^(Imagekit::Internal::Type::ArrayOf[Imagekit::Models::FileUploadResponse::AITag]) | nil, + ai_tags: ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::Models::FileUploadResponse::AITag]) | nil, audio_codec: String | nil, bit_rate: Integer | nil, custom_coordinates: String | nil, - custom_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, + custom_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, description: String | nil, duration: Integer | nil, - embedded_metadata: ^(Imagekit::Internal::Type::HashOf[Imagekit::Internal::Type::Unknown]) | nil, - extension_status: Imagekit::Models::FileUploadResponse::ExtensionStatus | nil, + embedded_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, + extension_status: Imagekitio::Models::FileUploadResponse::ExtensionStatus | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, height: Float | nil, - is_private_file: Imagekit::Internal::Type::Boolean | nil, - is_published: Imagekit::Internal::Type::Boolean | nil, - metadata: Imagekit::Metadata | nil, + is_private_file: Imagekitio::Internal::Type::Boolean | nil, + is_published: Imagekitio::Internal::Type::Boolean | nil, + metadata: Imagekitio::Metadata | nil, name: String | nil, - selected_fields_schema: ^(Imagekit::Internal::Type::HashOf[Imagekit::Models::FileUploadResponse::SelectedFieldsSchema]) | nil, + selected_fields_schema: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema]) | nil, size: Float | nil, - tags: ^(Imagekit::Internal::Type::ArrayOf[String]) | nil, + tags: ^(Imagekitio::Internal::Type::ArrayOf[String]) | nil, thumbnail_url: String | nil, url: String | nil, - version_info: Imagekit::Models::FileUploadResponse::VersionInfo | nil, + version_info: Imagekitio::Models::FileUploadResponse::VersionInfo | nil, video_codec: String | nil, width: Float | nil } diff --git a/test/imagekit/resources/folders/job_test.rb b/test/imagekitio/resources/folders/job_test.rb similarity index 54% rename from test/imagekit/resources/folders/job_test.rb rename to test/imagekitio/resources/folders/job_test.rb index 6521e30e..810a3c21 100644 --- a/test/imagekit/resources/folders/job_test.rb +++ b/test/imagekitio/resources/folders/job_test.rb @@ -2,22 +2,22 @@ require_relative "../../test_helper" -class Imagekit::Test::Resources::Folders::JobTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::Folders::JobTest < Imagekitio::Test::ResourceTest def test_get skip("Prism tests are disabled") response = @image_kit.folders.job.get("jobId") assert_pattern do - response => Imagekit::Models::Folders::JobGetResponse + response => Imagekitio::Models::Folders::JobGetResponse end assert_pattern do response => { job_id: String | nil, purge_request_id: String | nil, - status: Imagekit::Models::Folders::JobGetResponse::Status | nil, - type: Imagekit::Models::Folders::JobGetResponse::Type | nil + status: Imagekitio::Models::Folders::JobGetResponse::Status | nil, + type: Imagekitio::Models::Folders::JobGetResponse::Type | nil } end end diff --git a/test/imagekit/resources/folders_test.rb b/test/imagekitio/resources/folders_test.rb similarity index 81% rename from test/imagekit/resources/folders_test.rb rename to test/imagekitio/resources/folders_test.rb index 4e5e4e43..eb4097a4 100644 --- a/test/imagekit/resources/folders_test.rb +++ b/test/imagekitio/resources/folders_test.rb @@ -2,14 +2,14 @@ require_relative "../test_helper" -class Imagekit::Test::Resources::FoldersTest < Imagekit::Test::ResourceTest +class Imagekitio::Test::Resources::FoldersTest < Imagekitio::Test::ResourceTest def test_create_required_params skip("Prism tests are disabled") response = @image_kit.folders.create(folder_name: "summer", parent_folder_path: "/product/images/") assert_pattern do - response => Imagekit::Models::FolderCreateResponse + response => Imagekitio::Models::FolderCreateResponse end assert_pattern do @@ -25,7 +25,7 @@ def test_delete_required_params response = @image_kit.folders.delete(folder_path: "/folder/to/delete/") assert_pattern do - response => Imagekit::Models::FolderDeleteResponse + response => Imagekitio::Models::FolderDeleteResponse end assert_pattern do @@ -45,7 +45,7 @@ def test_copy_required_params ) assert_pattern do - response => Imagekit::Models::FolderCopyResponse + response => Imagekitio::Models::FolderCopyResponse end assert_pattern do @@ -65,7 +65,7 @@ def test_move_required_params ) assert_pattern do - response => Imagekit::Models::FolderMoveResponse + response => Imagekitio::Models::FolderMoveResponse end assert_pattern do @@ -81,7 +81,7 @@ def test_rename_required_params response = @image_kit.folders.rename(folder_path: "/path/of/folder", new_folder_name: "new-folder-name") assert_pattern do - response => Imagekit::Models::FolderRenameResponse + response => Imagekitio::Models::FolderRenameResponse end assert_pattern do diff --git a/test/imagekitio/resources/shared_test.rb b/test/imagekitio/resources/shared_test.rb new file mode 100644 index 00000000..b00609a9 --- /dev/null +++ b/test/imagekitio/resources/shared_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekitio::Test::Resources::SharedTest < Imagekitio::Test::ResourceTest +end diff --git a/test/imagekitio/resources/webhooks_test.rb b/test/imagekitio/resources/webhooks_test.rb new file mode 100644 index 00000000..b9735c0a --- /dev/null +++ b/test/imagekitio/resources/webhooks_test.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekitio::Test::Resources::WebhooksTest < Imagekitio::Test::ResourceTest +end diff --git a/test/imagekit/test_helper.rb b/test/imagekitio/test_helper.rb similarity index 85% rename from test/imagekit/test_helper.rb rename to test/imagekitio/test_helper.rb index 56fd104f..ec652736 100644 --- a/test/imagekit/test_helper.rb +++ b/test/imagekitio/test_helper.rb @@ -17,7 +17,7 @@ require "minitest/rg" require "webmock" -require_relative "../../lib/imagekit" +require_relative "../../lib/imagekitio" require_relative "resource_namespaces" module Kernel @@ -42,14 +42,14 @@ class << self def self.now = Thread.current.thread_variable_get(:time_now) || _now end -class Imagekit::Test::SingletonClient < Imagekit::Client +class Imagekitio::Test::SingletonClient < Imagekitio::Client include Singleton TEST_API_BASE_URL = ENV.fetch("TEST_API_BASE_URL", "http://localhost:4010") def initialize super( - base_url: Imagekit::Test::SingletonClient::TEST_API_BASE_URL, + base_url: Imagekitio::Test::SingletonClient::TEST_API_BASE_URL, private_key: "My Private Key", password: "My Password" ) @@ -70,7 +70,7 @@ class Minitest::Test prove_it! end -class Imagekit::Test::ResourceTest < Minitest::Test +class Imagekitio::Test::ResourceTest < Minitest::Test def async? return @async unless @async.nil? @async = Digest::SHA256.hexdigest(self.class.name).to_i(16).odd? @@ -78,7 +78,7 @@ def async? def before_all super - @image_kit = Imagekit::Test::SingletonClient.instance + @image_kit = Imagekitio::Test::SingletonClient.instance end def around_all = async? ? Sync { super } : super From 10f573dc51545febd6d8a62f267798f8da9deee1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 3 Nov 2025 07:28:29 +0000 Subject: [PATCH 145/178] chore(internal): version bump --- .release-please-manifest.json | 2 +- Gemfile.lock | 2 +- README.md | 2 +- lib/imagekitio/version.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 1332969b..127ac87b 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.0.1" + ".": "4.0.0" } \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 133cd37e..defa8152 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - imagekitio (0.0.1) + imagekitio (4.0.0) connection_pool GEM diff --git a/README.md b/README.md index 60d276f7..d684c81b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "imagekitio", "~> 0.0.1" +gem "imagekitio", "~> 4.0.0" ``` diff --git a/lib/imagekitio/version.rb b/lib/imagekitio/version.rb index 1155ae5e..5c1df80d 100644 --- a/lib/imagekitio/version.rb +++ b/lib/imagekitio/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Imagekitio - VERSION = "0.0.1" + VERSION = "4.0.0" end From 23e907ecbae130706de91d5dd8b81d21f39a881a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 3 Nov 2025 10:54:16 +0000 Subject: [PATCH 146/178] chore(client): send user-agent header --- lib/imagekitio/internal/transport/base_client.rb | 8 +++++++- rbi/imagekitio/internal/transport/base_client.rbi | 5 +++++ sig/imagekitio/internal/transport/base_client.rbs | 2 ++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/lib/imagekitio/internal/transport/base_client.rb b/lib/imagekitio/internal/transport/base_client.rb index 6e613d49..e9c0aea9 100644 --- a/lib/imagekitio/internal/transport/base_client.rb +++ b/lib/imagekitio/internal/transport/base_client.rb @@ -201,7 +201,8 @@ def initialize( self.class::PLATFORM_HEADERS, { "accept" => "application/json", - "content-type" => "application/json" + "content-type" => "application/json", + "user-agent" => user_agent }, headers ) @@ -219,6 +220,11 @@ def initialize( # @return [Hash{String=>String}] private def auth_headers = {} + # @api private + # + # @return [String] + private def user_agent = "#{self.class.name}/Ruby #{Imagekitio::VERSION}" + # @api private # # @return [String] diff --git a/rbi/imagekitio/internal/transport/base_client.rbi b/rbi/imagekitio/internal/transport/base_client.rbi index 445a4149..1c484249 100644 --- a/rbi/imagekitio/internal/transport/base_client.rbi +++ b/rbi/imagekitio/internal/transport/base_client.rbi @@ -178,6 +178,11 @@ module Imagekitio private def auth_headers end + # @api private + sig { returns(String) } + private def user_agent + end + # @api private sig { returns(String) } private def generate_idempotency_key diff --git a/sig/imagekitio/internal/transport/base_client.rbs b/sig/imagekitio/internal/transport/base_client.rbs index 9ab9fe58..dfaab83c 100644 --- a/sig/imagekitio/internal/transport/base_client.rbs +++ b/sig/imagekitio/internal/transport/base_client.rbs @@ -87,6 +87,8 @@ module Imagekitio private def auth_headers: -> ::Hash[String, String] + private def user_agent: -> String + private def generate_idempotency_key: -> String private def build_request: ( From 2b223070156846ef5d698b6623f25a5c28394f68 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 3 Nov 2025 21:47:19 +0000 Subject: [PATCH 147/178] chore: bump dependency version and update sorbet types --- Gemfile | 3 +- Gemfile.lock | 82 ++++++++++----------- rbi/imagekitio/internal/type/base_model.rbi | 12 ++- 3 files changed, 50 insertions(+), 47 deletions(-) diff --git a/Gemfile b/Gemfile index 0d76364b..1be178cb 100644 --- a/Gemfile +++ b/Gemfile @@ -11,8 +11,7 @@ group :development do gem "sorbet" gem "steep" gem "syntax_tree" - # TODO: using a fork for now, the prettier below has a bug - gem "syntax_tree-rbs", github: "stainless-api/syntax_tree-rbs", branch: "main" + gem "syntax_tree-rbs", github: "ruby-syntax-tree/syntax_tree-rbs", branch: "main" gem "tapioca" end diff --git a/Gemfile.lock b/Gemfile.lock index defa8152..90600690 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,6 +1,6 @@ GIT - remote: https://github.com/stainless-api/syntax_tree-rbs.git - revision: c30b50219918be7cfe3ef803a00b59d1e77fcada + remote: https://github.com/ruby-syntax-tree/syntax_tree-rbs.git + revision: f94bc3060682ffbd126e4d5086ffedc89073d626 branch: main specs: syntax_tree-rbs (1.0.0) @@ -17,14 +17,14 @@ PATH GEM remote: https://rubygems.org/ specs: - activesupport (8.0.2.1) + activesupport (8.1.1) base64 - benchmark (>= 0.3) bigdecimal concurrent-ruby (~> 1.0, >= 1.3.1) connection_pool (>= 2.2.5) drb i18n (>= 1.6, < 2) + json logger (>= 1.4.2) minitest (>= 5.1) securerandom (>= 0.3) @@ -33,22 +33,22 @@ GEM addressable (2.8.7) public_suffix (>= 2.0.2, < 7.0) ast (2.4.3) - async (2.27.3) + async (2.34.0) console (~> 1.29) fiber-annotation io-event (~> 1.11) metrics (~> 0.12) - traces (~> 0.15) + traces (~> 0.18) base64 (0.3.0) - benchmark (0.4.1) - bigdecimal (3.2.2) + benchmark (0.5.0) + bigdecimal (3.3.1) concurrent-ruby (1.3.5) - connection_pool (2.5.3) - console (1.33.0) + connection_pool (2.5.4) + console (1.34.2) fiber-annotation fiber-local (~> 1.1) json - crack (1.0.0) + crack (1.0.1) bigdecimal rexml csv (3.3.5) @@ -64,20 +64,20 @@ GEM fiber-local (1.1.0) fiber-storage fiber-storage (1.0.1) - fileutils (1.7.3) - hashdiff (1.2.0) + fileutils (1.8.0) + hashdiff (1.2.1) i18n (1.14.7) concurrent-ruby (~> 1.0) io-event (1.11.2) - json (2.13.2) + json (2.15.2) language_server-protocol (3.17.0.5) lint_roller (1.1.0) listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) logger (1.7.0) - metrics (0.13.0) - minitest (5.25.5) + metrics (0.15.0) + minitest (5.26.0) minitest-focus (1.4.0) minitest (>= 4, < 6) minitest-hooks (1.5.2) @@ -89,27 +89,27 @@ GEM mutex_m (0.3.0) netrc (0.11.0) parallel (1.27.0) - parser (3.3.9.0) + parser (3.3.10.0) ast (~> 2.4.1) racc prettier_print (1.2.1) - prism (1.4.0) + prism (1.6.0) public_suffix (6.0.2) racc (1.8.1) rainbow (3.1.1) - rake (13.3.0) + rake (13.3.1) rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rbi (0.3.6) + rbi (0.3.7) prism (~> 1.0) rbs (>= 3.4.4) - rbs (3.9.4) + rbs (3.9.5) logger redcarpet (3.6.1) - regexp_parser (2.11.2) - rexml (3.4.1) - rubocop (1.79.2) + regexp_parser (2.11.3) + rexml (3.4.4) + rubocop (1.81.7) json (~> 2.3) language_server-protocol (~> 3.17.0.2) lint_roller (~> 1.1.0) @@ -117,23 +117,23 @@ GEM parser (>= 3.3.0.2) rainbow (>= 2.2.2, < 4.0) regexp_parser (>= 2.9.3, < 3.0) - rubocop-ast (>= 1.46.0, < 2.0) + rubocop-ast (>= 1.47.1, < 2.0) ruby-progressbar (~> 1.7) unicode-display_width (>= 2.4.0, < 4.0) - rubocop-ast (1.46.0) + rubocop-ast (1.47.1) parser (>= 3.3.7.2) prism (~> 1.4) ruby-progressbar (1.13.0) securerandom (0.4.1) - sorbet (0.5.12424) - sorbet-static (= 0.5.12424) - sorbet-runtime (0.5.12424) - sorbet-static (0.5.12424-aarch64-linux) - sorbet-static (0.5.12424-universal-darwin) - sorbet-static (0.5.12424-x86_64-linux) - sorbet-static-and-runtime (0.5.12424) - sorbet (= 0.5.12424) - sorbet-runtime (= 0.5.12424) + sorbet (0.6.12690) + sorbet-static (= 0.6.12690) + sorbet-runtime (0.6.12690) + sorbet-static (0.6.12690-aarch64-linux) + sorbet-static (0.6.12690-universal-darwin) + sorbet-static (0.6.12690-x86_64-linux) + sorbet-static-and-runtime (0.6.12690) + sorbet (= 0.6.12690) + sorbet-runtime (= 0.6.12690) spoom (1.6.3) erubi (>= 1.10.0) prism (>= 0.28.0) @@ -174,14 +174,14 @@ GEM terminal-table (4.0.0) unicode-display_width (>= 1.1.1, < 4) thor (1.4.0) - traces (0.17.0) + traces (0.18.2) tzinfo (2.0.6) concurrent-ruby (~> 1.0) - unicode-display_width (3.1.5) - unicode-emoji (~> 4.0, >= 4.0.4) - unicode-emoji (4.0.4) - uri (1.0.3) - webmock (3.25.1) + unicode-display_width (3.2.0) + unicode-emoji (~> 4.1) + unicode-emoji (4.1.0) + uri (1.1.0) + webmock (3.26.1) addressable (>= 2.8.0) crack (>= 0.3.2) hashdiff (>= 0.4.0, < 2.0.0) diff --git a/rbi/imagekitio/internal/type/base_model.rbi b/rbi/imagekitio/internal/type/base_model.rbi index c8686a20..36e668fb 100644 --- a/rbi/imagekitio/internal/type/base_model.rbi +++ b/rbi/imagekitio/internal/type/base_model.rbi @@ -31,7 +31,7 @@ module Imagekitio # # Assumes superclass fields are totally defined before fields are accessed / # defined on subclasses. - sig { params(child: T.self_type).void } + sig { params(child: Imagekitio::Internal::Type::BaseModel).void } def inherited(child) end @@ -276,9 +276,13 @@ module Imagekitio # Create a new instance of a model. sig do - params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns( - T.attached_class - ) + params( + data: + T.any( + T::Hash[Symbol, T.anything], + Imagekitio::Internal::Type::BaseModel + ) + ).returns(T.attached_class) end def self.new(data = {}) end From ef4deff6f1a6ba02b11a464f7e927c36ebecf03b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 4 Nov 2025 18:00:39 +0000 Subject: [PATCH 148/178] fix: better thread safety via early initializing SSL store during HTTP client creation --- lib/imagekitio.rb | 1 + lib/imagekitio/internal/transport/pooled_net_requester.rb | 8 ++++++-- manifest.yaml | 1 + .../internal/transport/pooled_net_requester.rbi | 8 ++++++-- .../internal/transport/pooled_net_requester.rbs | 5 ++++- 5 files changed, 18 insertions(+), 5 deletions(-) diff --git a/lib/imagekitio.rb b/lib/imagekitio.rb index ea9130ba..1799d0c9 100644 --- a/lib/imagekitio.rb +++ b/lib/imagekitio.rb @@ -9,6 +9,7 @@ require "etc" require "json" require "net/http" +require "openssl" require "pathname" require "rbconfig" require "securerandom" diff --git a/lib/imagekitio/internal/transport/pooled_net_requester.rb b/lib/imagekitio/internal/transport/pooled_net_requester.rb index 11f8ed7b..3cbba9e0 100644 --- a/lib/imagekitio/internal/transport/pooled_net_requester.rb +++ b/lib/imagekitio/internal/transport/pooled_net_requester.rb @@ -16,10 +16,11 @@ class PooledNetRequester class << self # @api private # + # @param cert_store [OpenSSL::X509::Store] # @param url [URI::Generic] # # @return [Net::HTTP] - def connect(url) + def connect(cert_store:, url:) port = case [url.port, url.scheme] in [Integer, _] @@ -33,6 +34,8 @@ def connect(url) Net::HTTP.new(url.host, port).tap do _1.use_ssl = %w[https wss].include?(url.scheme) _1.max_retries = 0 + + (_1.cert_store = cert_store) if _1.use_ssl? end end @@ -102,7 +105,7 @@ def build_request(request, &blk) pool = @mutex.synchronize do @pools[origin] ||= ConnectionPool.new(size: @size) do - self.class.connect(url) + self.class.connect(cert_store: @cert_store, url: url) end end @@ -192,6 +195,7 @@ def execute(request) def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS) @mutex = Mutex.new @size = size + @cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths) @pools = {} end diff --git a/manifest.yaml b/manifest.yaml index 556686f5..7853f4ab 100644 --- a/manifest.yaml +++ b/manifest.yaml @@ -6,6 +6,7 @@ dependencies: - etc - json - net/http + - openssl - pathname - rbconfig - securerandom diff --git a/rbi/imagekitio/internal/transport/pooled_net_requester.rbi b/rbi/imagekitio/internal/transport/pooled_net_requester.rbi index e0c582fd..7f933426 100644 --- a/rbi/imagekitio/internal/transport/pooled_net_requester.rbi +++ b/rbi/imagekitio/internal/transport/pooled_net_requester.rbi @@ -26,8 +26,12 @@ module Imagekitio class << self # @api private - sig { params(url: URI::Generic).returns(Net::HTTP) } - def connect(url) + sig do + params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns( + Net::HTTP + ) + end + def connect(cert_store:, url:) end # @api private diff --git a/sig/imagekitio/internal/transport/pooled_net_requester.rbs b/sig/imagekitio/internal/transport/pooled_net_requester.rbs index 6ef7c006..801c5eb5 100644 --- a/sig/imagekitio/internal/transport/pooled_net_requester.rbs +++ b/sig/imagekitio/internal/transport/pooled_net_requester.rbs @@ -17,7 +17,10 @@ module Imagekitio DEFAULT_MAX_CONNECTIONS: Integer - def self.connect: (URI::Generic url) -> top + def self.connect: ( + cert_store: OpenSSL::X509::Store, + url: URI::Generic + ) -> top def self.calibrate_socket_timeout: (top conn, Float deadline) -> void From ed7d220ee6e0327f8ef97fb6f104b97b519efb78 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 20 Nov 2025 19:48:40 +0000 Subject: [PATCH 149/178] chore: explicitly require "base64" gem --- lib/imagekitio.rb | 1 + manifest.yaml | 1 + 2 files changed, 2 insertions(+) diff --git a/lib/imagekitio.rb b/lib/imagekitio.rb index 1799d0c9..4bc50696 100644 --- a/lib/imagekitio.rb +++ b/lib/imagekitio.rb @@ -3,6 +3,7 @@ # Standard libraries. # rubocop:disable Lint/RedundantRequireStatement require "English" +require "base64" require "cgi" require "date" require "erb" diff --git a/manifest.yaml b/manifest.yaml index 7853f4ab..a1fd74a9 100644 --- a/manifest.yaml +++ b/manifest.yaml @@ -1,5 +1,6 @@ dependencies: - English + - base64 - cgi - date - erb From 1288c8f56434f456ddc14293f16cb68000f4af9c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 13:27:46 +0000 Subject: [PATCH 150/178] chore(internal): codegen related update --- lib/imagekitio/models/unsafe_unwrap_webhook_event.rb | 2 ++ lib/imagekitio/models/unwrap_webhook_event.rb | 2 ++ 2 files changed, 4 insertions(+) diff --git a/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb b/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb index 3ae76efc..11c26bf4 100644 --- a/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb +++ b/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb @@ -8,6 +8,8 @@ module Models module UnsafeUnwrapWebhookEvent extend Imagekitio::Internal::Type::Union + discriminator :type + # 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. variant -> { Imagekitio::VideoTransformationAcceptedEvent } diff --git a/lib/imagekitio/models/unwrap_webhook_event.rb b/lib/imagekitio/models/unwrap_webhook_event.rb index ebbdfd88..c9f71bc9 100644 --- a/lib/imagekitio/models/unwrap_webhook_event.rb +++ b/lib/imagekitio/models/unwrap_webhook_event.rb @@ -8,6 +8,8 @@ module Models module UnwrapWebhookEvent extend Imagekitio::Internal::Type::Union + discriminator :type + # 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. variant -> { Imagekitio::VideoTransformationAcceptedEvent } From 9ea763f8c19743abbe4c13f07c355696bfeaf089 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 8 Dec 2025 09:58:00 +0000 Subject: [PATCH 151/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index ae3aead6..8577a4cc 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: eb4cf65a4c6b26a2901076eff5810d5d +config_hash: 10b48f323ed534664483af1952174d52 From f581e2e39b891e3c196086bdbd496ce797ad5ad3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 8 Dec 2025 12:31:32 +0000 Subject: [PATCH 152/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 8577a4cc..6dfdc12a 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: 10b48f323ed534664483af1952174d52 +config_hash: fd112bd17c0c8e9f81a50d0e15ea70d6 From 39f6cbff7d447e1f9915d83a4ac0034ddaeb5aba Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 12 Dec 2025 11:53:48 +0000 Subject: [PATCH 153/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 6dfdc12a..2e7957ed 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: fd112bd17c0c8e9f81a50d0e15ea70d6 +config_hash: 2a4d7992f6d3a0db0e9a430d513d94e6 From fa1e056ad3ffdff29f6ecd6ba51a98ff0580731b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 12 Dec 2025 11:54:57 +0000 Subject: [PATCH 154/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 2e7957ed..f03cc097 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: 2a4d7992f6d3a0db0e9a430d513d94e6 +config_hash: b4f610d4f53fe5bb17b35cf77a7521ea From 34c0691ef43f31781a8a1c94ee780a4afe2b0d0e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 12 Dec 2025 12:00:45 +0000 Subject: [PATCH 155/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index f03cc097..e75a1bc7 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: b4f610d4f53fe5bb17b35cf77a7521ea +config_hash: 71cab8223bb5610c6c7ca6e9c4cc1f89 From ff247cb58de520495acdc13982ea66db5294a84d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 21:13:03 +0000 Subject: [PATCH 156/178] fix: calling `break` out of streams should be instantaneous --- .../transport/pooled_net_requester.rb | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/lib/imagekitio/internal/transport/pooled_net_requester.rb b/lib/imagekitio/internal/transport/pooled_net_requester.rb index 3cbba9e0..fa323842 100644 --- a/lib/imagekitio/internal/transport/pooled_net_requester.rb +++ b/lib/imagekitio/internal/transport/pooled_net_requester.rb @@ -153,17 +153,19 @@ def execute(request) end self.class.calibrate_socket_timeout(conn, deadline) - conn.request(req) do |rsp| - y << [req, rsp] - break if finished - - rsp.read_body do |bytes| - y << bytes.force_encoding(Encoding::BINARY) - break if finished - - self.class.calibrate_socket_timeout(conn, deadline) + ::Kernel.catch(:jump) do + conn.request(req) do |rsp| + y << [req, rsp] + ::Kernel.throw(:jump) if finished + + rsp.read_body do |bytes| + y << bytes.force_encoding(Encoding::BINARY) + ::Kernel.throw(:jump) if finished + + self.class.calibrate_socket_timeout(conn, deadline) + end + eof = true end - eof = true end end ensure From 8809473d8587a76b3b0dd0481a27e4e983367536 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 18:48:06 +0000 Subject: [PATCH 157/178] fix: issue where json.parse errors when receiving HTTP 204 with nobody --- lib/imagekitio/internal/util.rb | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/lib/imagekitio/internal/util.rb b/lib/imagekitio/internal/util.rb index 77125eca..1dd7d346 100644 --- a/lib/imagekitio/internal/util.rb +++ b/lib/imagekitio/internal/util.rb @@ -657,7 +657,8 @@ def force_charset!(content_type, text:) def decode_content(headers, stream:, suppress_error: false) case (content_type = headers["content-type"]) in Imagekitio::Internal::Util::JSON_CONTENT - json = stream.to_a.join + return nil if (json = stream.to_a.join).empty? + begin JSON.parse(json, symbolize_names: true) rescue JSON::ParserError => e @@ -667,7 +668,11 @@ def decode_content(headers, stream:, suppress_error: false) in Imagekitio::Internal::Util::JSONL_CONTENT lines = decode_lines(stream) chain_fused(lines) do |y| - lines.each { y << JSON.parse(_1, symbolize_names: true) } + lines.each do + next if _1.empty? + + y << JSON.parse(_1, symbolize_names: true) + end end in %r{^text/event-stream} lines = decode_lines(stream) From 1a1833ac2f9e06a997f0ec708a49c6db4754c2ee Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 5 Jan 2026 04:05:42 +0000 Subject: [PATCH 158/178] chore(internal): codegen related update --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index e7a4d160..20278610 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright 2025 Image Kit + Copyright 2026 Image Kit Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. From 9a43941020f190f58bd2d034f3b2c93a46ca8720 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 5 Jan 2026 20:49:51 +0000 Subject: [PATCH 159/178] docs: prominently feature MCP server setup in root SDK readmes --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d684c81b..bdd6acf4 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ The Image Kit Ruby library provides convenient access to the Image Kit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/imagekit-developer/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem. +## MCP Server + +Use the Image Kit MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application. + +[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40imagekit%2Fapi-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBpbWFnZWtpdC9hcGktbWNwIl19) +[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40imagekit%2Fapi-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40imagekit%2Fapi-mcp%22%5D%7D) + +> Note: You may need to set environment variables in your MCP client. + ## Documentation Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/imagekitio). From 0e4c2d2b27beaaa5cc2e2efd5a2ea3119594fc70 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 9 Jan 2026 21:12:51 +0000 Subject: [PATCH 160/178] chore: move `cgi` into dependencies for ruby 4 --- Gemfile.lock | 2 ++ imagekitio.gemspec | 1 + 2 files changed, 3 insertions(+) diff --git a/Gemfile.lock b/Gemfile.lock index 90600690..4828ae3f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -12,6 +12,7 @@ PATH remote: . specs: imagekitio (4.0.0) + cgi connection_pool GEM @@ -42,6 +43,7 @@ GEM base64 (0.3.0) benchmark (0.5.0) bigdecimal (3.3.1) + cgi (0.5.1) concurrent-ruby (1.3.5) connection_pool (2.5.4) console (1.34.2) diff --git a/imagekitio.gemspec b/imagekitio.gemspec index 19e0fcef..ede1aafe 100644 --- a/imagekitio.gemspec +++ b/imagekitio.gemspec @@ -24,5 +24,6 @@ Gem::Specification.new do |s| ".ignore" ] s.extra_rdoc_files = ["README.md"] + s.add_dependency "cgi" s.add_dependency "connection_pool" end From 5100e1f09f8c19098d096aa6b2185d3667bcb312 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 15 Jan 2026 06:52:15 +0000 Subject: [PATCH 161/178] feat(api): Add saved extensions API and enhance transformation options MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added complete CRUD API endpoints for saved extensions, allowing users to save complex extension configurations and reuse them across multiple assets Fixed metadata endpoint path: /v1/files/metadata → /v1/metadata Added and improved transformation options e.g. color replace, layer modes, distort effect, gradient background etc. --- .stats.yml | 8 +- lib/imagekitio.rb | 9 + lib/imagekitio/client.rb | 4 + lib/imagekitio/internal/type/base_model.rb | 1 + lib/imagekitio/internal/type/union.rb | 28 +- lib/imagekitio/models.rb | 14 + lib/imagekitio/models/base_overlay.rb | 76 +- .../models/beta/v2/file_upload_params.rb | 4 +- lib/imagekitio/models/extension_config.rb | 674 ++++++++ lib/imagekitio/models/extensions.rb | 560 ++++++- lib/imagekitio/models/file_upload_params.rb | 4 +- lib/imagekitio/models/image_overlay.rb | 12 + lib/imagekitio/models/saved_extension.rb | 62 + .../models/saved_extension_create_params.rb | 42 + .../models/saved_extension_delete_params.rb | 14 + .../models/saved_extension_get_params.rb | 14 + .../models/saved_extension_list_params.rb | 14 + .../models/saved_extension_list_response.rb | 8 + .../models/saved_extension_update_params.rb | 42 + .../solid_color_overlay_transformation.rb | 36 +- lib/imagekitio/models/subtitle_overlay.rb | 12 + .../models/subtitle_overlay_transformation.rb | 7 +- lib/imagekitio/models/text_overlay.rb | 6 + .../models/text_overlay_transformation.rb | 54 +- lib/imagekitio/models/transformation.rb | 74 +- lib/imagekitio/models/update_file_request.rb | 4 +- lib/imagekitio/models/video_overlay.rb | 12 + lib/imagekitio/resources/beta/v2/files.rb | 2 +- lib/imagekitio/resources/files.rb | 2 +- lib/imagekitio/resources/files/metadata.rb | 2 +- lib/imagekitio/resources/saved_extensions.rb | 146 ++ rbi/imagekitio/client.rbi | 3 + rbi/imagekitio/models.rbi | 14 + rbi/imagekitio/models/base_overlay.rbi | 111 +- .../models/beta/v2/file_upload_params.rbi | 8 + rbi/imagekitio/models/extension_config.rbi | 1403 +++++++++++++++++ rbi/imagekitio/models/extensions.rbi | 1159 ++++++++++++++ rbi/imagekitio/models/file_upload_params.rbi | 8 + rbi/imagekitio/models/image_overlay.rbi | 18 + rbi/imagekitio/models/saved_extension.rbi | 114 ++ .../models/saved_extension_create_params.rbi | 85 + .../models/saved_extension_delete_params.rbi | 30 + .../models/saved_extension_get_params.rbi | 30 + .../models/saved_extension_list_params.rbi | 30 + .../models/saved_extension_list_response.rbi | 11 + .../models/saved_extension_update_params.rbi | 106 ++ .../solid_color_overlay_transformation.rbi | 51 +- rbi/imagekitio/models/subtitle_overlay.rbi | 18 + .../subtitle_overlay_transformation.rbi | 10 +- rbi/imagekitio/models/text_overlay.rbi | 9 + .../models/text_overlay_transformation.rbi | 73 +- rbi/imagekitio/models/transformation.rbi | 117 +- rbi/imagekitio/models/update_file_request.rbi | 8 + rbi/imagekitio/models/video_overlay.rbi | 18 + rbi/imagekitio/resources/beta/v2/files.rbi | 2 + rbi/imagekitio/resources/files.rbi | 2 + rbi/imagekitio/resources/saved_extensions.rbi | 114 ++ sig/imagekitio/client.rbs | 2 + sig/imagekitio/models.rbs | 14 + sig/imagekitio/models/base_overlay.rbs | 22 + sig/imagekitio/models/extension_config.rbs | 604 +++++++ sig/imagekitio/models/extensions.rbs | 489 ++++++ sig/imagekitio/models/saved_extension.rbs | 59 + .../models/saved_extension_create_params.rbs | 36 + .../models/saved_extension_delete_params.rbs | 15 + .../models/saved_extension_get_params.rbs | 15 + .../models/saved_extension_list_params.rbs | 15 + .../models/saved_extension_list_response.rbs | 7 + .../models/saved_extension_update_params.rbs | 44 + .../solid_color_overlay_transformation.rbs | 2 +- .../models/text_overlay_transformation.rbs | 2 +- sig/imagekitio/models/transformation.rbs | 16 +- sig/imagekitio/resources/saved_extensions.rbs | 33 + .../resources/saved_extensions_test.rb | 93 ++ 74 files changed, 6826 insertions(+), 141 deletions(-) create mode 100644 lib/imagekitio/models/extension_config.rb create mode 100644 lib/imagekitio/models/saved_extension.rb create mode 100644 lib/imagekitio/models/saved_extension_create_params.rb create mode 100644 lib/imagekitio/models/saved_extension_delete_params.rb create mode 100644 lib/imagekitio/models/saved_extension_get_params.rb create mode 100644 lib/imagekitio/models/saved_extension_list_params.rb create mode 100644 lib/imagekitio/models/saved_extension_list_response.rb create mode 100644 lib/imagekitio/models/saved_extension_update_params.rb create mode 100644 lib/imagekitio/resources/saved_extensions.rb create mode 100644 rbi/imagekitio/models/extension_config.rbi create mode 100644 rbi/imagekitio/models/saved_extension.rbi create mode 100644 rbi/imagekitio/models/saved_extension_create_params.rbi create mode 100644 rbi/imagekitio/models/saved_extension_delete_params.rbi create mode 100644 rbi/imagekitio/models/saved_extension_get_params.rbi create mode 100644 rbi/imagekitio/models/saved_extension_list_params.rbi create mode 100644 rbi/imagekitio/models/saved_extension_list_response.rbi create mode 100644 rbi/imagekitio/models/saved_extension_update_params.rbi create mode 100644 rbi/imagekitio/resources/saved_extensions.rbi create mode 100644 sig/imagekitio/models/extension_config.rbs create mode 100644 sig/imagekitio/models/saved_extension.rbs create mode 100644 sig/imagekitio/models/saved_extension_create_params.rbs create mode 100644 sig/imagekitio/models/saved_extension_delete_params.rbs create mode 100644 sig/imagekitio/models/saved_extension_get_params.rbs create mode 100644 sig/imagekitio/models/saved_extension_list_params.rbs create mode 100644 sig/imagekitio/models/saved_extension_list_response.rbs create mode 100644 sig/imagekitio/models/saved_extension_update_params.rbs create mode 100644 sig/imagekitio/resources/saved_extensions.rbs create mode 100644 test/imagekitio/resources/saved_extensions_test.rb diff --git a/.stats.yml b/.stats.yml index e75a1bc7..fdbd8925 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-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml -openapi_spec_hash: a9aa620376fce66532c84f9364209b0b -config_hash: 71cab8223bb5610c6c7ca6e9c4cc1f89 +configured_endpoints: 47 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-7a3257eb171467b637c8d72877f201c2e6038c71ed447a9453230b7309ce7416.yml +openapi_spec_hash: 87b000a9989ad5c9526f28d91b8a1749 +config_hash: aeb6eb949d73382270bbd8bbf2e4cf2a diff --git a/lib/imagekitio.rb b/lib/imagekitio.rb index 4bc50696..7aafe2f0 100644 --- a/lib/imagekitio.rb +++ b/lib/imagekitio.rb @@ -90,6 +90,7 @@ require_relative "imagekitio/models/custom_metadata_field_list_params" require_relative "imagekitio/models/custom_metadata_field_list_response" require_relative "imagekitio/models/custom_metadata_field_update_params" +require_relative "imagekitio/models/extension_config" require_relative "imagekitio/models/extensions" require_relative "imagekitio/models/file_copy_params" require_relative "imagekitio/models/file_copy_response" @@ -139,6 +140,13 @@ require_relative "imagekitio/models/overlay_position" require_relative "imagekitio/models/overlay_timing" require_relative "imagekitio/models/responsive_image_attributes" +require_relative "imagekitio/models/saved_extension" +require_relative "imagekitio/models/saved_extension_create_params" +require_relative "imagekitio/models/saved_extension_delete_params" +require_relative "imagekitio/models/saved_extension_get_params" +require_relative "imagekitio/models/saved_extension_list_params" +require_relative "imagekitio/models/saved_extension_list_response" +require_relative "imagekitio/models/saved_extension_update_params" require_relative "imagekitio/models/solid_color_overlay" require_relative "imagekitio/models/solid_color_overlay_transformation" require_relative "imagekitio/models/streaming_resolution" @@ -178,4 +186,5 @@ require_relative "imagekitio/resources/files/versions" require_relative "imagekitio/resources/folders" require_relative "imagekitio/resources/folders/job" +require_relative "imagekitio/resources/saved_extensions" require_relative "imagekitio/resources/webhooks" diff --git a/lib/imagekitio/client.rb b/lib/imagekitio/client.rb index 3c779088..2c3d632f 100644 --- a/lib/imagekitio/client.rb +++ b/lib/imagekitio/client.rb @@ -31,6 +31,9 @@ class Client < Imagekitio::Internal::Transport::BaseClient # @return [Imagekitio::Resources::Files] attr_reader :files + # @return [Imagekitio::Resources::SavedExtensions] + attr_reader :saved_extensions + # @return [Imagekitio::Resources::Assets] attr_reader :assets @@ -114,6 +117,7 @@ def initialize( @custom_metadata_fields = Imagekitio::Resources::CustomMetadataFields.new(client: self) @files = Imagekitio::Resources::Files.new(client: self) + @saved_extensions = Imagekitio::Resources::SavedExtensions.new(client: self) @assets = Imagekitio::Resources::Assets.new(client: self) @cache = Imagekitio::Resources::Cache.new(client: self) @folders = Imagekitio::Resources::Folders.new(client: self) diff --git a/lib/imagekitio/internal/type/base_model.rb b/lib/imagekitio/internal/type/base_model.rb index a7dd52d9..907a0f3f 100644 --- a/lib/imagekitio/internal/type/base_model.rb +++ b/lib/imagekitio/internal/type/base_model.rb @@ -440,6 +440,7 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @example # # `base_overlay` is a `Imagekitio::BaseOverlay` # base_overlay => { + # layer_mode: layer_mode, # position: position, # timing: timing # } diff --git a/lib/imagekitio/internal/type/union.rb b/lib/imagekitio/internal/type/union.rb index 47fdfd0b..bb649abc 100644 --- a/lib/imagekitio/internal/type/union.rb +++ b/lib/imagekitio/internal/type/union.rb @@ -6,16 +6,28 @@ module Type # @api private # # @example - # # `overlay` is a `Imagekitio::Overlay` - # case overlay - # when Imagekitio::TextOverlay - # # ... - # when Imagekitio::ImageOverlay - # # ... - # when Imagekitio::VideoOverlay + # # `extension_config` is a `Imagekitio::ExtensionConfig` + # case extension_config + # when Imagekitio::ExtensionConfig::RemoveBg + # puts(extension_config.name) + # when Imagekitio::ExtensionConfig::AIAutoDescription + # puts(extension_config.name) + # when Imagekitio::ExtensionConfig::AITasks + # puts(extension_config.tasks) + # else + # puts(extension_config) + # end + # + # @example + # case extension_config + # in {name: :"remove-bg", options: options} + # puts(options) + # in {name: :"ai-auto-description"} # # ... + # in {name: :"ai-tasks", tasks: tasks} + # puts(tasks) # else - # puts(overlay) + # puts(extension_config) # end module Union include Imagekitio::Internal::Type::Converter diff --git a/lib/imagekitio/models.rb b/lib/imagekitio/models.rb index 06ffc0cf..bc8f57a4 100644 --- a/lib/imagekitio/models.rb +++ b/lib/imagekitio/models.rb @@ -61,6 +61,8 @@ module Imagekitio CustomMetadataFieldUpdateParams = Imagekitio::Models::CustomMetadataFieldUpdateParams + ExtensionConfig = Imagekitio::Models::ExtensionConfig + ExtensionItem = Imagekitio::Models::ExtensionItem # @type [Imagekitio::Internal::Type::Converter] @@ -112,6 +114,18 @@ module Imagekitio ResponsiveImageAttributes = Imagekitio::Models::ResponsiveImageAttributes + SavedExtension = Imagekitio::Models::SavedExtension + + SavedExtensionCreateParams = Imagekitio::Models::SavedExtensionCreateParams + + SavedExtensionDeleteParams = Imagekitio::Models::SavedExtensionDeleteParams + + SavedExtensionGetParams = Imagekitio::Models::SavedExtensionGetParams + + SavedExtensionListParams = Imagekitio::Models::SavedExtensionListParams + + SavedExtensionUpdateParams = Imagekitio::Models::SavedExtensionUpdateParams + SolidColorOverlay = Imagekitio::Models::SolidColorOverlay SolidColorOverlayTransformation = Imagekitio::Models::SolidColorOverlayTransformation diff --git a/lib/imagekitio/models/base_overlay.rb b/lib/imagekitio/models/base_overlay.rb index d48136fb..fb895395 100644 --- a/lib/imagekitio/models/base_overlay.rb +++ b/lib/imagekitio/models/base_overlay.rb @@ -3,19 +3,89 @@ module Imagekitio module Models class BaseOverlay < Imagekitio::Internal::Type::BaseModel + # @!attribute layer_mode + # Controls how the layer blends with the base image or underlying content. Maps to + # `lm` in the URL. By default, layers completely cover the base image beneath + # them. Layer modes change this behavior: + # + # - `multiply`: Multiplies the pixel values of the layer with the base image. The + # result is always darker than the original images. This is ideal for applying + # shadows or color tints. + # - `displace`: Uses the layer as a displacement map to distort pixels in the base + # image. The red channel controls horizontal displacement, and the green channel + # controls vertical displacement. Requires `x` or `y` parameter to control + # displacement magnitude. + # - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the + # base image transparent, while transparent areas leave the base image + # unchanged. This mode functions like a hole-punch, effectively cutting the + # shape of the layer out of the underlying image. + # - `cutter`: Acts as a shape mask where only the parts of the base image that + # fall inside the opaque area of the layer are preserved. This mode functions + # like a cookie-cutter, trimming the base image to match the specific dimensions + # and shape of the layer. See + # [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes). + # + # @return [Symbol, Imagekitio::Models::BaseOverlay::LayerMode, nil] + optional :layer_mode, enum: -> { Imagekitio::BaseOverlay::LayerMode }, api_name: :layerMode + # @!attribute position + # Specifies the overlay's position relative to the parent asset. See + # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer). # # @return [Imagekitio::Models::OverlayPosition, nil] optional :position, -> { Imagekitio::OverlayPosition } # @!attribute timing + # Specifies timing information for the overlay (only applicable if the base asset + # is a video). See + # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer). # # @return [Imagekitio::Models::OverlayTiming, nil] optional :timing, -> { Imagekitio::OverlayTiming } - # @!method initialize(position: nil, timing: nil) - # @param position [Imagekitio::Models::OverlayPosition] - # @param timing [Imagekitio::Models::OverlayTiming] + # @!method initialize(layer_mode: nil, position: nil, timing: nil) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::BaseOverlay} for more details. + # + # @param layer_mode [Symbol, Imagekitio::Models::BaseOverlay::LayerMode] Controls how the layer blends with the base image or underlying content. Maps to + # + # @param position [Imagekitio::Models::OverlayPosition] Specifies the overlay's position relative to the parent asset. + # + # @param timing [Imagekitio::Models::OverlayTiming] Specifies timing information for the overlay (only applicable if the base asset + + # Controls how the layer blends with the base image or underlying content. Maps to + # `lm` in the URL. By default, layers completely cover the base image beneath + # them. Layer modes change this behavior: + # + # - `multiply`: Multiplies the pixel values of the layer with the base image. The + # result is always darker than the original images. This is ideal for applying + # shadows or color tints. + # - `displace`: Uses the layer as a displacement map to distort pixels in the base + # image. The red channel controls horizontal displacement, and the green channel + # controls vertical displacement. Requires `x` or `y` parameter to control + # displacement magnitude. + # - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the + # base image transparent, while transparent areas leave the base image + # unchanged. This mode functions like a hole-punch, effectively cutting the + # shape of the layer out of the underlying image. + # - `cutter`: Acts as a shape mask where only the parts of the base image that + # fall inside the opaque area of the layer are preserved. This mode functions + # like a cookie-cutter, trimming the base image to match the specific dimensions + # and shape of the layer. See + # [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes). + # + # @see Imagekitio::Models::BaseOverlay#layer_mode + module LayerMode + extend Imagekitio::Internal::Type::Enum + + MULTIPLY = :multiply + CUTTER = :cutter + CUTOUT = :cutout + DISPLACE = :displace + + # @!method self.values + # @return [Array] + end end end end diff --git a/lib/imagekitio/models/beta/v2/file_upload_params.rb b/lib/imagekitio/models/beta/v2/file_upload_params.rb index b1f16527..adcadbd0 100644 --- a/lib/imagekitio/models/beta/v2/file_upload_params.rb +++ b/lib/imagekitio/models/beta/v2/file_upload_params.rb @@ -87,7 +87,7 @@ class FileUploadParams < Imagekitio::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem] } # @!attribute folder @@ -224,7 +224,7 @@ class FileUploadParams < Imagekitio::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekitio/models/extension_config.rb b/lib/imagekitio/models/extension_config.rb new file mode 100644 index 00000000..5b862865 --- /dev/null +++ b/lib/imagekitio/models/extension_config.rb @@ -0,0 +1,674 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # Configuration object for an extension (base extensions only, not saved extension + # references). + module ExtensionConfig + extend Imagekitio::Internal::Type::Union + + discriminator :name + + variant :"remove-bg", -> { Imagekitio::ExtensionConfig::RemoveBg } + + variant :"ai-auto-description", -> { Imagekitio::ExtensionConfig::AIAutoDescription } + + variant :"ai-tasks", -> { Imagekitio::ExtensionConfig::AITasks } + + variant -> { Imagekitio::ExtensionConfig::AutoTaggingExtension } + + class RemoveBg < Imagekitio::Internal::Type::BaseModel + # @!attribute name + # Specifies the background removal extension. + # + # @return [Symbol, :"remove-bg"] + required :name, const: :"remove-bg" + + # @!attribute options + # + # @return [Imagekitio::Models::ExtensionConfig::RemoveBg::Options, nil] + optional :options, -> { Imagekitio::ExtensionConfig::RemoveBg::Options } + + # @!method initialize(options: nil, name: :"remove-bg") + # @param options [Imagekitio::Models::ExtensionConfig::RemoveBg::Options] + # + # @param name [Symbol, :"remove-bg"] Specifies the background removal extension. + + # @see Imagekitio::Models::ExtensionConfig::RemoveBg#options + class Options < Imagekitio::Internal::Type::BaseModel + # @!attribute add_shadow + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + # + # @return [Boolean, nil] + optional :add_shadow, Imagekitio::Internal::Type::Boolean + + # @!attribute bg_color + # 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. + # + # @return [String, nil] + optional :bg_color, String + + # @!attribute bg_image_url + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + # + # @return [String, nil] + optional :bg_image_url, String + + # @!attribute semitransparency + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + # + # @return [Boolean, nil] + optional :semitransparency, Imagekitio::Internal::Type::Boolean + + # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionConfig::RemoveBg::Options} for more details. + # + # @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin + # + # @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col + # + # @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be + # + # @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp + end + end + + class AutoTaggingExtension < Imagekitio::Internal::Type::BaseModel + # @!attribute max_tags + # Maximum number of tags to attach to the asset. + # + # @return [Integer] + required :max_tags, Integer, api_name: :maxTags + + # @!attribute min_confidence + # Minimum confidence level for tags to be considered valid. + # + # @return [Integer] + required :min_confidence, Integer, api_name: :minConfidence + + # @!attribute name + # Specifies the auto-tagging extension used. + # + # @return [Symbol, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension::Name] + required :name, enum: -> { Imagekitio::ExtensionConfig::AutoTaggingExtension::Name } + + # @!method initialize(max_tags:, min_confidence:, name:) + # @param max_tags [Integer] Maximum number of tags to attach to the asset. + # + # @param min_confidence [Integer] Minimum confidence level for tags to be considered valid. + # + # @param name [Symbol, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension::Name] Specifies the auto-tagging extension used. + + # Specifies the auto-tagging extension used. + # + # @see Imagekitio::Models::ExtensionConfig::AutoTaggingExtension#name + module Name + extend Imagekitio::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING = :"google-auto-tagging" + AWS_AUTO_TAGGING = :"aws-auto-tagging" + + # @!method self.values + # @return [Array] + end + end + + class AIAutoDescription < Imagekitio::Internal::Type::BaseModel + # @!attribute name + # Specifies the auto description extension. + # + # @return [Symbol, :"ai-auto-description"] + required :name, const: :"ai-auto-description" + + # @!method initialize(name: :"ai-auto-description") + # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. + end + + class AITasks < Imagekitio::Internal::Type::BaseModel + # @!attribute name + # Specifies the AI tasks extension for automated image analysis using AI models. + # + # @return [Symbol, :"ai-tasks"] + required :name, const: :"ai-tasks" + + # @!attribute tasks + # Array of task objects defining AI operations to perform on the asset. + # + # @return [Array] + required :tasks, + -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionConfig::AITasks::Task] } + + # @!method initialize(tasks:, name: :"ai-tasks") + # @param tasks [Array] Array of task objects defining AI operations to perform on the asset. + # + # @param name [Symbol, :"ai-tasks"] Specifies the AI tasks extension for automated image analysis using AI models. + + module Task + extend Imagekitio::Internal::Type::Union + + discriminator :type + + variant :select_tags, -> { Imagekitio::ExtensionConfig::AITasks::Task::SelectTags } + + variant :select_metadata, -> { Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata } + + variant :yes_no, -> { Imagekitio::ExtensionConfig::AITasks::Task::YesNo } + + class SelectTags < Imagekitio::Internal::Type::BaseModel + # @!attribute instruction + # The question or instruction for the AI to analyze the image. + # + # @return [String] + required :instruction, String + + # @!attribute type + # Task type that analyzes the image and adds matching tags from a vocabulary. + # + # @return [Symbol, :select_tags] + required :type, const: :select_tags + + # @!attribute vocabulary + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + # + # @return [Array] + required :vocabulary, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute max_selections + # Maximum number of tags to select from the vocabulary. + # + # @return [Integer, nil] + optional :max_selections, Integer + + # @!attribute min_selections + # Minimum number of tags to select from the vocabulary. + # + # @return [Integer, nil] + optional :min_selections, Integer + + # @!method initialize(instruction:, vocabulary:, max_selections: nil, min_selections: nil, type: :select_tags) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectTags} for more + # details. + # + # @param instruction [String] The question or instruction for the AI to analyze the image. + # + # @param vocabulary [Array] Array of possible tag values. Combined length of all strings must not exceed 500 + # + # @param max_selections [Integer] Maximum number of tags to select from the vocabulary. + # + # @param min_selections [Integer] Minimum number of tags to select from the vocabulary. + # + # @param type [Symbol, :select_tags] Task type that analyzes the image and adds matching tags from a vocabulary. + end + + class SelectMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to set. The field must exist in your account. + # + # @return [String] + required :field, String + + # @!attribute instruction + # The question or instruction for the AI to analyze the image. + # + # @return [String] + required :instruction, String + + # @!attribute type + # Task type that analyzes the image and sets a custom metadata field value from a + # vocabulary. + # + # @return [Symbol, :select_metadata] + required :type, const: :select_metadata + + # @!attribute max_selections + # Maximum number of values to select from the vocabulary. + # + # @return [Integer, nil] + optional :max_selections, Integer + + # @!attribute min_selections + # Minimum number of values to select from the vocabulary. + # + # @return [Integer, nil] + optional :min_selections, Integer + + # @!attribute vocabulary + # Array of possible values matching the custom metadata field type. + # + # @return [Array, nil] + optional :vocabulary, + -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata::Vocabulary] } + + # @!method initialize(field:, instruction:, max_selections: nil, min_selections: nil, vocabulary: nil, type: :select_metadata) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata} for more + # details. + # + # @param field [String] Name of the custom metadata field to set. The field must exist in your account. + # + # @param instruction [String] The question or instruction for the AI to analyze the image. + # + # @param max_selections [Integer] Maximum number of values to select from the vocabulary. + # + # @param min_selections [Integer] Minimum number of values to select from the vocabulary. + # + # @param vocabulary [Array] Array of possible values matching the custom metadata field type. + # + # @param type [Symbol, :select_metadata] Task type that analyzes the image and sets a custom metadata field value from a + + module Vocabulary + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + + class YesNo < Imagekitio::Internal::Type::BaseModel + # @!attribute instruction + # The yes/no question for the AI to answer about the image. + # + # @return [String] + required :instruction, String + + # @!attribute type + # Task type that asks a yes/no question and executes actions based on the answer. + # + # @return [Symbol, :yes_no] + required :type, const: :yes_no + + # @!attribute on_no + # Actions to execute if the AI answers no. + # + # @return [Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo, nil] + optional :on_no, -> { Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo } + + # @!attribute on_unknown + # Actions to execute if the AI cannot determine the answer. + # + # @return [Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown, nil] + optional :on_unknown, -> { Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown } + + # @!attribute on_yes + # Actions to execute if the AI answers yes. + # + # @return [Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes, nil] + optional :on_yes, -> { Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes } + + # @!method initialize(instruction:, on_no: nil, on_unknown: nil, on_yes: nil, type: :yes_no) + # @param instruction [String] The yes/no question for the AI to answer about the image. + # + # @param on_no [Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo] Actions to execute if the AI answers no. + # + # @param on_unknown [Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown] Actions to execute if the AI cannot determine the answer. + # + # @param on_yes [Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes] Actions to execute if the AI answers yes. + # + # @param type [Symbol, :yes_no] Task type that asks a yes/no question and executes actions based on the answer. + + # @see Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo#on_no + class OnNo < Imagekitio::Internal::Type::BaseModel + # @!attribute add_tags + # Array of tag strings to add to the asset. + # + # @return [Array, nil] + optional :add_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute remove_tags + # Array of tag strings to remove from the asset. + # + # @return [Array, nil] + optional :remove_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute set_metadata + # Array of custom metadata field updates. + # + # @return [Array, nil] + optional :set_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata] } + + # @!attribute unset_metadata + # Array of custom metadata fields to remove. + # + # @return [Array, nil] + optional :unset_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata] } + + # @!method initialize(add_tags: nil, remove_tags: nil, set_metadata: nil, unset_metadata: nil) + # Actions to execute if the AI answers no. + # + # @param add_tags [Array] Array of tag strings to add to the asset. + # + # @param remove_tags [Array] Array of tag strings to remove from the asset. + # + # @param set_metadata [Array] Array of custom metadata field updates. + # + # @param unset_metadata [Array] Array of custom metadata fields to remove. + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to set. + # + # @return [String] + required :field, String + + # @!attribute value + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @return [String, Float, Boolean, Array] + required :value, union: -> { Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value } + + # @!method initialize(field:, value:) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata} + # for more details. + # + # @param field [String] Name of the custom metadata field to set. + # + # @param value [String, Float, Boolean, Array] Value to set for the custom metadata field. The value type should match the cust + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @see Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata#value + module Value + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + variant -> { Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::MixedArray } + + module Mixed + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekitio::Internal::Type::Converter] + MixedArray = + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Mixed + }] + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to remove. + # + # @return [String] + required :field, String + + # @!method initialize(field:) + # @param field [String] Name of the custom metadata field to remove. + end + end + + # @see Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo#on_unknown + class OnUnknown < Imagekitio::Internal::Type::BaseModel + # @!attribute add_tags + # Array of tag strings to add to the asset. + # + # @return [Array, nil] + optional :add_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute remove_tags + # Array of tag strings to remove from the asset. + # + # @return [Array, nil] + optional :remove_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute set_metadata + # Array of custom metadata field updates. + # + # @return [Array, nil] + optional :set_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata] } + + # @!attribute unset_metadata + # Array of custom metadata fields to remove. + # + # @return [Array, nil] + optional :unset_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] } + + # @!method initialize(add_tags: nil, remove_tags: nil, set_metadata: nil, unset_metadata: nil) + # Actions to execute if the AI cannot determine the answer. + # + # @param add_tags [Array] Array of tag strings to add to the asset. + # + # @param remove_tags [Array] Array of tag strings to remove from the asset. + # + # @param set_metadata [Array] Array of custom metadata field updates. + # + # @param unset_metadata [Array] Array of custom metadata fields to remove. + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to set. + # + # @return [String] + required :field, String + + # @!attribute value + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @return [String, Float, Boolean, Array] + required :value, + union: -> { Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value } + + # @!method initialize(field:, value:) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata} + # for more details. + # + # @param field [String] Name of the custom metadata field to set. + # + # @param value [String, Float, Boolean, Array] Value to set for the custom metadata field. The value type should match the cust + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @see Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata#value + module Value + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + variant -> { Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::MixedArray } + + module Mixed + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekitio::Internal::Type::Converter] + MixedArray = + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Mixed + }] + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to remove. + # + # @return [String] + required :field, String + + # @!method initialize(field:) + # @param field [String] Name of the custom metadata field to remove. + end + end + + # @see Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo#on_yes + class OnYes < Imagekitio::Internal::Type::BaseModel + # @!attribute add_tags + # Array of tag strings to add to the asset. + # + # @return [Array, nil] + optional :add_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute remove_tags + # Array of tag strings to remove from the asset. + # + # @return [Array, nil] + optional :remove_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute set_metadata + # Array of custom metadata field updates. + # + # @return [Array, nil] + optional :set_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata] } + + # @!attribute unset_metadata + # Array of custom metadata fields to remove. + # + # @return [Array, nil] + optional :unset_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata] } + + # @!method initialize(add_tags: nil, remove_tags: nil, set_metadata: nil, unset_metadata: nil) + # Actions to execute if the AI answers yes. + # + # @param add_tags [Array] Array of tag strings to add to the asset. + # + # @param remove_tags [Array] Array of tag strings to remove from the asset. + # + # @param set_metadata [Array] Array of custom metadata field updates. + # + # @param unset_metadata [Array] Array of custom metadata fields to remove. + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to set. + # + # @return [String] + required :field, String + + # @!attribute value + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @return [String, Float, Boolean, Array] + required :value, + union: -> { Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value } + + # @!method initialize(field:, value:) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata} + # for more details. + # + # @param field [String] Name of the custom metadata field to set. + # + # @param value [String, Float, Boolean, Array] Value to set for the custom metadata field. The value type should match the cust + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @see Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata#value + module Value + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + variant -> { Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::MixedArray } + + module Mixed + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekitio::Internal::Type::Converter] + MixedArray = + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Mixed + }] + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to remove. + # + # @return [String] + required :field, String + + # @!method initialize(field:) + # @param field [String] Name of the custom metadata field to remove. + end + end + end + + # @!method self.variants + # @return [Array(Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectTags, Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata, Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo)] + end + end + + # @!method self.variants + # @return [Array(Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension)] + end + end +end diff --git a/lib/imagekitio/models/extensions.rb b/lib/imagekitio/models/extensions.rb index b71af518..10c21ee1 100644 --- a/lib/imagekitio/models/extensions.rb +++ b/lib/imagekitio/models/extensions.rb @@ -11,6 +11,10 @@ module ExtensionItem variant :"ai-auto-description", -> { Imagekitio::ExtensionItem::AIAutoDescription } + variant :"ai-tasks", -> { Imagekitio::ExtensionItem::AITasks } + + variant :"saved-extension", -> { Imagekitio::ExtensionItem::SavedExtension } + variant -> { Imagekitio::ExtensionItem::AutoTaggingExtension } class RemoveBg < Imagekitio::Internal::Type::BaseModel @@ -126,8 +130,562 @@ class AIAutoDescription < Imagekitio::Internal::Type::BaseModel # @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension. end + class AITasks < Imagekitio::Internal::Type::BaseModel + # @!attribute name + # Specifies the AI tasks extension for automated image analysis using AI models. + # + # @return [Symbol, :"ai-tasks"] + required :name, const: :"ai-tasks" + + # @!attribute tasks + # Array of task objects defining AI operations to perform on the asset. + # + # @return [Array] + required :tasks, + -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem::AITasks::Task] } + + # @!method initialize(tasks:, name: :"ai-tasks") + # @param tasks [Array] Array of task objects defining AI operations to perform on the asset. + # + # @param name [Symbol, :"ai-tasks"] Specifies the AI tasks extension for automated image analysis using AI models. + + module Task + extend Imagekitio::Internal::Type::Union + + discriminator :type + + variant :select_tags, -> { Imagekitio::ExtensionItem::AITasks::Task::SelectTags } + + variant :select_metadata, -> { Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata } + + variant :yes_no, -> { Imagekitio::ExtensionItem::AITasks::Task::YesNo } + + class SelectTags < Imagekitio::Internal::Type::BaseModel + # @!attribute instruction + # The question or instruction for the AI to analyze the image. + # + # @return [String] + required :instruction, String + + # @!attribute type + # Task type that analyzes the image and adds matching tags from a vocabulary. + # + # @return [Symbol, :select_tags] + required :type, const: :select_tags + + # @!attribute vocabulary + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + # + # @return [Array] + required :vocabulary, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute max_selections + # Maximum number of tags to select from the vocabulary. + # + # @return [Integer, nil] + optional :max_selections, Integer + + # @!attribute min_selections + # Minimum number of tags to select from the vocabulary. + # + # @return [Integer, nil] + optional :min_selections, Integer + + # @!method initialize(instruction:, vocabulary:, max_selections: nil, min_selections: nil, type: :select_tags) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionItem::AITasks::Task::SelectTags} for more details. + # + # @param instruction [String] The question or instruction for the AI to analyze the image. + # + # @param vocabulary [Array] Array of possible tag values. Combined length of all strings must not exceed 500 + # + # @param max_selections [Integer] Maximum number of tags to select from the vocabulary. + # + # @param min_selections [Integer] Minimum number of tags to select from the vocabulary. + # + # @param type [Symbol, :select_tags] Task type that analyzes the image and adds matching tags from a vocabulary. + end + + class SelectMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to set. The field must exist in your account. + # + # @return [String] + required :field, String + + # @!attribute instruction + # The question or instruction for the AI to analyze the image. + # + # @return [String] + required :instruction, String + + # @!attribute type + # Task type that analyzes the image and sets a custom metadata field value from a + # vocabulary. + # + # @return [Symbol, :select_metadata] + required :type, const: :select_metadata + + # @!attribute max_selections + # Maximum number of values to select from the vocabulary. + # + # @return [Integer, nil] + optional :max_selections, Integer + + # @!attribute min_selections + # Minimum number of values to select from the vocabulary. + # + # @return [Integer, nil] + optional :min_selections, Integer + + # @!attribute vocabulary + # Array of possible values matching the custom metadata field type. + # + # @return [Array, nil] + optional :vocabulary, + -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata::Vocabulary] } + + # @!method initialize(field:, instruction:, max_selections: nil, min_selections: nil, vocabulary: nil, type: :select_metadata) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata} for more + # details. + # + # @param field [String] Name of the custom metadata field to set. The field must exist in your account. + # + # @param instruction [String] The question or instruction for the AI to analyze the image. + # + # @param max_selections [Integer] Maximum number of values to select from the vocabulary. + # + # @param min_selections [Integer] Minimum number of values to select from the vocabulary. + # + # @param vocabulary [Array] Array of possible values matching the custom metadata field type. + # + # @param type [Symbol, :select_metadata] Task type that analyzes the image and sets a custom metadata field value from a + + module Vocabulary + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + end + + class YesNo < Imagekitio::Internal::Type::BaseModel + # @!attribute instruction + # The yes/no question for the AI to answer about the image. + # + # @return [String] + required :instruction, String + + # @!attribute type + # Task type that asks a yes/no question and executes actions based on the answer. + # + # @return [Symbol, :yes_no] + required :type, const: :yes_no + + # @!attribute on_no + # Actions to execute if the AI answers no. + # + # @return [Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo, nil] + optional :on_no, -> { Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo } + + # @!attribute on_unknown + # Actions to execute if the AI cannot determine the answer. + # + # @return [Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown, nil] + optional :on_unknown, -> { Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown } + + # @!attribute on_yes + # Actions to execute if the AI answers yes. + # + # @return [Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes, nil] + optional :on_yes, -> { Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes } + + # @!method initialize(instruction:, on_no: nil, on_unknown: nil, on_yes: nil, type: :yes_no) + # @param instruction [String] The yes/no question for the AI to answer about the image. + # + # @param on_no [Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo] Actions to execute if the AI answers no. + # + # @param on_unknown [Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown] Actions to execute if the AI cannot determine the answer. + # + # @param on_yes [Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes] Actions to execute if the AI answers yes. + # + # @param type [Symbol, :yes_no] Task type that asks a yes/no question and executes actions based on the answer. + + # @see Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo#on_no + class OnNo < Imagekitio::Internal::Type::BaseModel + # @!attribute add_tags + # Array of tag strings to add to the asset. + # + # @return [Array, nil] + optional :add_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute remove_tags + # Array of tag strings to remove from the asset. + # + # @return [Array, nil] + optional :remove_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute set_metadata + # Array of custom metadata field updates. + # + # @return [Array, nil] + optional :set_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata] } + + # @!attribute unset_metadata + # Array of custom metadata fields to remove. + # + # @return [Array, nil] + optional :unset_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata] } + + # @!method initialize(add_tags: nil, remove_tags: nil, set_metadata: nil, unset_metadata: nil) + # Actions to execute if the AI answers no. + # + # @param add_tags [Array] Array of tag strings to add to the asset. + # + # @param remove_tags [Array] Array of tag strings to remove from the asset. + # + # @param set_metadata [Array] Array of custom metadata field updates. + # + # @param unset_metadata [Array] Array of custom metadata fields to remove. + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to set. + # + # @return [String] + required :field, String + + # @!attribute value + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @return [String, Float, Boolean, Array] + required :value, union: -> { Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value } + + # @!method initialize(field:, value:) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata} for + # more details. + # + # @param field [String] Name of the custom metadata field to set. + # + # @param value [String, Float, Boolean, Array] Value to set for the custom metadata field. The value type should match the cust + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @see Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata#value + module Value + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + variant -> { Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::MixedArray } + + module Mixed + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekitio::Internal::Type::Converter] + MixedArray = + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Mixed + }] + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to remove. + # + # @return [String] + required :field, String + + # @!method initialize(field:) + # @param field [String] Name of the custom metadata field to remove. + end + end + + # @see Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo#on_unknown + class OnUnknown < Imagekitio::Internal::Type::BaseModel + # @!attribute add_tags + # Array of tag strings to add to the asset. + # + # @return [Array, nil] + optional :add_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute remove_tags + # Array of tag strings to remove from the asset. + # + # @return [Array, nil] + optional :remove_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute set_metadata + # Array of custom metadata field updates. + # + # @return [Array, nil] + optional :set_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata] } + + # @!attribute unset_metadata + # Array of custom metadata fields to remove. + # + # @return [Array, nil] + optional :unset_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] } + + # @!method initialize(add_tags: nil, remove_tags: nil, set_metadata: nil, unset_metadata: nil) + # Actions to execute if the AI cannot determine the answer. + # + # @param add_tags [Array] Array of tag strings to add to the asset. + # + # @param remove_tags [Array] Array of tag strings to remove from the asset. + # + # @param set_metadata [Array] Array of custom metadata field updates. + # + # @param unset_metadata [Array] Array of custom metadata fields to remove. + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to set. + # + # @return [String] + required :field, String + + # @!attribute value + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @return [String, Float, Boolean, Array] + required :value, + union: -> { Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value } + + # @!method initialize(field:, value:) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata} + # for more details. + # + # @param field [String] Name of the custom metadata field to set. + # + # @param value [String, Float, Boolean, Array] Value to set for the custom metadata field. The value type should match the cust + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @see Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata#value + module Value + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + variant -> { Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::MixedArray } + + module Mixed + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekitio::Internal::Type::Converter] + MixedArray = + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Mixed + }] + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to remove. + # + # @return [String] + required :field, String + + # @!method initialize(field:) + # @param field [String] Name of the custom metadata field to remove. + end + end + + # @see Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo#on_yes + class OnYes < Imagekitio::Internal::Type::BaseModel + # @!attribute add_tags + # Array of tag strings to add to the asset. + # + # @return [Array, nil] + optional :add_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute remove_tags + # Array of tag strings to remove from the asset. + # + # @return [Array, nil] + optional :remove_tags, Imagekitio::Internal::Type::ArrayOf[String] + + # @!attribute set_metadata + # Array of custom metadata field updates. + # + # @return [Array, nil] + optional :set_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata] } + + # @!attribute unset_metadata + # Array of custom metadata fields to remove. + # + # @return [Array, nil] + optional :unset_metadata, + -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata] } + + # @!method initialize(add_tags: nil, remove_tags: nil, set_metadata: nil, unset_metadata: nil) + # Actions to execute if the AI answers yes. + # + # @param add_tags [Array] Array of tag strings to add to the asset. + # + # @param remove_tags [Array] Array of tag strings to remove from the asset. + # + # @param set_metadata [Array] Array of custom metadata field updates. + # + # @param unset_metadata [Array] Array of custom metadata fields to remove. + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to set. + # + # @return [String] + required :field, String + + # @!attribute value + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @return [String, Float, Boolean, Array] + required :value, union: -> { Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value } + + # @!method initialize(field:, value:) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata} + # for more details. + # + # @param field [String] Name of the custom metadata field to set. + # + # @param value [String, Float, Boolean, Array] Value to set for the custom metadata field. The value type should match the cust + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + # + # @see Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata#value + module Value + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + variant -> { Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::MixedArray } + + module Mixed + extend Imagekitio::Internal::Type::Union + + variant String + + variant Float + + variant Imagekitio::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Float, Boolean)] + end + + # @!method self.variants + # @return [Array(String, Float, Boolean, Array)] + + # @type [Imagekitio::Internal::Type::Converter] + MixedArray = + Imagekitio::Internal::Type::ArrayOf[union: -> { + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Mixed + }] + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + # @!attribute field + # Name of the custom metadata field to remove. + # + # @return [String] + required :field, String + + # @!method initialize(field:) + # @param field [String] Name of the custom metadata field to remove. + end + end + end + + # @!method self.variants + # @return [Array(Imagekitio::Models::ExtensionItem::AITasks::Task::SelectTags, Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata, Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo)] + end + end + + class SavedExtension < Imagekitio::Internal::Type::BaseModel + # @!attribute id + # The unique ID of the saved extension to apply. + # + # @return [String] + required :id, String + + # @!attribute name + # Indicates this is a reference to a saved extension. + # + # @return [Symbol, :"saved-extension"] + required :name, const: :"saved-extension" + + # @!method initialize(id:, name: :"saved-extension") + # @param id [String] The unique ID of the saved extension to apply. + # + # @param name [Symbol, :"saved-extension"] Indicates this is a reference to a saved extension. + end + # @!method self.variants - # @return [Array(Imagekitio::Models::ExtensionItem::RemoveBg, Imagekitio::Models::ExtensionItem::AIAutoDescription, Imagekitio::Models::ExtensionItem::AutoTaggingExtension)] + # @return [Array(Imagekitio::Models::ExtensionItem::RemoveBg, Imagekitio::Models::ExtensionItem::AIAutoDescription, Imagekitio::Models::ExtensionItem::AITasks, Imagekitio::Models::ExtensionItem::SavedExtension, Imagekitio::Models::ExtensionItem::AutoTaggingExtension)] end # @type [Imagekitio::Internal::Type::Converter] diff --git a/lib/imagekitio/models/file_upload_params.rb b/lib/imagekitio/models/file_upload_params.rb index d9e6a855..e30764f5 100644 --- a/lib/imagekitio/models/file_upload_params.rb +++ b/lib/imagekitio/models/file_upload_params.rb @@ -94,7 +94,7 @@ class FileUploadParams < Imagekitio::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem] } # @!attribute folder @@ -255,7 +255,7 @@ class FileUploadParams < Imagekitio::Internal::Type::BaseModel # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekitio/models/image_overlay.rb b/lib/imagekitio/models/image_overlay.rb index 401b77e5..60e74062 100644 --- a/lib/imagekitio/models/image_overlay.rb +++ b/lib/imagekitio/models/image_overlay.rb @@ -21,6 +21,12 @@ class ImageOverlay < Imagekitio::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. + # # @return [Symbol, Imagekitio::Models::ImageOverlay::Encoding, nil] optional :encoding, enum: -> { Imagekitio::ImageOverlay::Encoding } @@ -51,6 +57,12 @@ class ImageOverlay < Imagekitio::Models::BaseOverlay # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. module Encoding extend Imagekitio::Internal::Type::Enum diff --git a/lib/imagekitio/models/saved_extension.rb b/lib/imagekitio/models/saved_extension.rb new file mode 100644 index 00000000..cbceaaa8 --- /dev/null +++ b/lib/imagekitio/models/saved_extension.rb @@ -0,0 +1,62 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + class SavedExtension < Imagekitio::Internal::Type::BaseModel + # @!attribute id + # Unique identifier of the saved extension. + # + # @return [String, nil] + optional :id, String + + # @!attribute config + # Configuration object for an extension (base extensions only, not saved extension + # references). + # + # @return [Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension, nil] + optional :config, union: -> { Imagekitio::ExtensionConfig } + + # @!attribute created_at + # Timestamp when the saved extension was created. + # + # @return [Time, nil] + optional :created_at, Time, api_name: :createdAt + + # @!attribute description + # Description of the saved extension. + # + # @return [String, nil] + optional :description, String + + # @!attribute name + # Name of the saved extension. + # + # @return [String, nil] + optional :name, String + + # @!attribute updated_at + # Timestamp when the saved extension was last updated. + # + # @return [Time, nil] + optional :updated_at, Time, api_name: :updatedAt + + # @!method initialize(id: nil, config: nil, created_at: nil, description: nil, name: nil, updated_at: nil) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::SavedExtension} for more details. + # + # Saved extension object containing extension configuration. + # + # @param id [String] Unique identifier of the saved extension. + # + # @param config [Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension] Configuration object for an extension (base extensions only, not saved extension + # + # @param created_at [Time] Timestamp when the saved extension was created. + # + # @param description [String] Description of the saved extension. + # + # @param name [String] Name of the saved extension. + # + # @param updated_at [Time] Timestamp when the saved extension was last updated. + end + end +end diff --git a/lib/imagekitio/models/saved_extension_create_params.rb b/lib/imagekitio/models/saved_extension_create_params.rb new file mode 100644 index 00000000..3a1c518d --- /dev/null +++ b/lib/imagekitio/models/saved_extension_create_params.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::SavedExtensions#create + class SavedExtensionCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute config + # Configuration object for an extension (base extensions only, not saved extension + # references). + # + # @return [Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension] + required :config, union: -> { Imagekitio::ExtensionConfig } + + # @!attribute description + # Description of what the saved extension does. + # + # @return [String] + required :description, String + + # @!attribute name + # Name of the saved extension. + # + # @return [String] + required :name, String + + # @!method initialize(config:, description:, name:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::SavedExtensionCreateParams} for more details. + # + # @param config [Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension] Configuration object for an extension (base extensions only, not saved extension + # + # @param description [String] Description of what the saved extension does. + # + # @param name [String] Name of the saved extension. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/saved_extension_delete_params.rb b/lib/imagekitio/models/saved_extension_delete_params.rb new file mode 100644 index 00000000..bf286678 --- /dev/null +++ b/lib/imagekitio/models/saved_extension_delete_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::SavedExtensions#delete + class SavedExtensionDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/saved_extension_get_params.rb b/lib/imagekitio/models/saved_extension_get_params.rb new file mode 100644 index 00000000..0ee0763c --- /dev/null +++ b/lib/imagekitio/models/saved_extension_get_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::SavedExtensions#get + class SavedExtensionGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/saved_extension_list_params.rb b/lib/imagekitio/models/saved_extension_list_params.rb new file mode 100644 index 00000000..da4762b4 --- /dev/null +++ b/lib/imagekitio/models/saved_extension_list_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::SavedExtensions#list + class SavedExtensionListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/saved_extension_list_response.rb b/lib/imagekitio/models/saved_extension_list_response.rb new file mode 100644 index 00000000..d6fc0288 --- /dev/null +++ b/lib/imagekitio/models/saved_extension_list_response.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @type [Imagekitio::Internal::Type::Converter] + SavedExtensionListResponse = Imagekitio::Internal::Type::ArrayOf[-> { Imagekitio::SavedExtension }] + end +end diff --git a/lib/imagekitio/models/saved_extension_update_params.rb b/lib/imagekitio/models/saved_extension_update_params.rb new file mode 100644 index 00000000..809b83e5 --- /dev/null +++ b/lib/imagekitio/models/saved_extension_update_params.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +module Imagekitio + module Models + # @see Imagekitio::Resources::SavedExtensions#update + class SavedExtensionUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + # @!attribute config + # Configuration object for an extension (base extensions only, not saved extension + # references). + # + # @return [Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension, nil] + optional :config, union: -> { Imagekitio::ExtensionConfig } + + # @!attribute description + # Updated description of the saved extension. + # + # @return [String, nil] + optional :description, String + + # @!attribute name + # Updated name of the saved extension. + # + # @return [String, nil] + optional :name, String + + # @!method initialize(config: nil, description: nil, name: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::SavedExtensionUpdateParams} for more details. + # + # @param config [Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension] Configuration object for an extension (base extensions only, not saved extension + # + # @param description [String] Updated description of the saved extension. + # + # @param name [String] Updated name of the saved extension. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/imagekitio/models/solid_color_overlay_transformation.rb b/lib/imagekitio/models/solid_color_overlay_transformation.rb index a68593b1..a39e8d69 100644 --- a/lib/imagekitio/models/solid_color_overlay_transformation.rb +++ b/lib/imagekitio/models/solid_color_overlay_transformation.rb @@ -4,8 +4,8 @@ module Imagekitio module Models class SolidColorOverlayTransformation < Imagekitio::Internal::Type::BaseModel # @!attribute alpha - # Specifies the transparency level of the solid color overlay. Accepts integers - # from `1` to `9`. + # Specifies the transparency level of the overlaid solid color layer. Supports + # integers from `1` to `9`. # # @return [Float, nil] optional :alpha, Float @@ -35,11 +35,16 @@ class SolidColorOverlayTransformation < Imagekitio::Internal::Type::BaseModel optional :height, union: -> { Imagekitio::SolidColorOverlayTransformation::Height } # @!attribute radius - # 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). + # Specifies the corner radius of the solid color overlay. # - # @return [Float, Symbol, :max, nil] + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + # + # @return [Float, Symbol, :max, String, nil] optional :radius, union: -> { Imagekitio::SolidColorOverlayTransformation::Radius } # @!attribute width @@ -54,7 +59,7 @@ class SolidColorOverlayTransformation < Imagekitio::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Imagekitio::Models::SolidColorOverlayTransformation} for more details. # - # @param alpha [Float] Specifies the transparency level of the solid color overlay. Accepts integers fr + # @param alpha [Float] Specifies the transparency level of the overlaid solid color layer. Supports int # # @param background [String] Specifies the background color of the solid color overlay. Accepts an RGB hex co # @@ -62,7 +67,7 @@ class SolidColorOverlayTransformation < Imagekitio::Internal::Type::BaseModel # # @param height [Float, String] Controls the height of the solid color overlay. Accepts a numeric value or an ar # - # @param radius [Float, Symbol, :max] Specifies the corner radius of the solid color overlay. Set to `max` for circula + # @param radius [Float, Symbol, :max, String] Specifies the corner radius of the solid color overlay. # # @param width [Float, String] Controls the width of the solid color overlay. Accepts a numeric value or an ari @@ -99,9 +104,14 @@ module Height # @return [Array(Float, String)] end - # 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). + # Specifies the corner radius of the solid color overlay. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). # # @see Imagekitio::Models::SolidColorOverlayTransformation#radius module Radius @@ -111,8 +121,10 @@ module Radius variant const: :max + variant String + # @!method self.variants - # @return [Array(Float, Symbol, :max)] + # @return [Array(Float, Symbol, :max, String)] end # Controls the width of the solid color overlay. Accepts a numeric value or an diff --git a/lib/imagekitio/models/subtitle_overlay.rb b/lib/imagekitio/models/subtitle_overlay.rb index 70694b9b..67d0c106 100644 --- a/lib/imagekitio/models/subtitle_overlay.rb +++ b/lib/imagekitio/models/subtitle_overlay.rb @@ -21,6 +21,12 @@ class SubtitleOverlay < Imagekitio::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. + # # @return [Symbol, Imagekitio::Models::SubtitleOverlay::Encoding, nil] optional :encoding, enum: -> { Imagekitio::SubtitleOverlay::Encoding } @@ -49,6 +55,12 @@ class SubtitleOverlay < Imagekitio::Models::BaseOverlay # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. module Encoding extend Imagekitio::Internal::Type::Enum diff --git a/lib/imagekitio/models/subtitle_overlay_transformation.rb b/lib/imagekitio/models/subtitle_overlay_transformation.rb index 1e06adb3..0ad4e0b3 100644 --- a/lib/imagekitio/models/subtitle_overlay_transformation.rb +++ b/lib/imagekitio/models/subtitle_overlay_transformation.rb @@ -22,8 +22,9 @@ class SubtitleOverlayTransformation < Imagekitio::Internal::Type::BaseModel optional :color, String # @!attribute font_family - # Font family for subtitles. Refer to the - # [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list). + # Sets the font family of subtitle text. Refer to the + # [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) + # in the ImageKit transformations guide. # # @return [String, nil] optional :font_family, String, api_name: :fontFamily @@ -82,7 +83,7 @@ class SubtitleOverlayTransformation < Imagekitio::Internal::Type::BaseModel # # @param color [String] Sets the font color of the subtitle text using a standard color name, an RGB col # - # @param font_family [String] Font family for subtitles. Refer to the [supported fonts](https://imagekit.io/do + # @param font_family [String] Sets the font family of subtitle text. # # @param font_outline [String] Sets the font outline of the subtitle text. # diff --git a/lib/imagekitio/models/text_overlay.rb b/lib/imagekitio/models/text_overlay.rb index 3f022e8d..5b64be82 100644 --- a/lib/imagekitio/models/text_overlay.rb +++ b/lib/imagekitio/models/text_overlay.rb @@ -22,6 +22,9 @@ class TextOverlay < Imagekitio::Models::BaseOverlay # (`ie-{base64}`), set this parameter to `base64`. To always use plain text # (`i-{input}`), set it to `plain`. # + # Regardless of the encoding method, the input text is always percent-encoded to + # ensure it is URL-safe. + # # @return [Symbol, Imagekitio::Models::TextOverlay::Encoding, nil] optional :encoding, enum: -> { Imagekitio::TextOverlay::Encoding } @@ -50,6 +53,9 @@ class TextOverlay < Imagekitio::Models::BaseOverlay # 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`. + # + # Regardless of the encoding method, the input text is always percent-encoded to + # ensure it is URL-safe. module Encoding extend Imagekitio::Internal::Type::Enum diff --git a/lib/imagekitio/models/text_overlay_transformation.rb b/lib/imagekitio/models/text_overlay_transformation.rb index 3a2f4d41..fdfb1e3b 100644 --- a/lib/imagekitio/models/text_overlay_transformation.rb +++ b/lib/imagekitio/models/text_overlay_transformation.rb @@ -18,7 +18,9 @@ class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel optional :background, String # @!attribute flip - # Flip the text overlay horizontally, vertically, or both. + # Flip/mirror the text horizontally, vertically, or in both directions. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. # # @return [Symbol, Imagekitio::Models::TextOverlayTransformation::Flip, nil] optional :flip, enum: -> { Imagekitio::TextOverlayTransformation::Flip } @@ -57,10 +59,9 @@ class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel api_name: :innerAlignment # @!attribute line_height - # 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`. + # Specifies the line height for multi-line text overlays. It will come into effect + # only if the text wraps over multiple lines. Accepts either an integer value or + # an arithmetic expression. # # @return [Float, String, nil] optional :line_height, @@ -76,10 +77,16 @@ class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel optional :padding, union: -> { Imagekitio::TextOverlayTransformation::Padding } # @!attribute radius - # Specifies the corner radius of the text overlay. Set to `max` to achieve a - # circular or oval shape. + # Specifies the corner radius: # - # @return [Float, Symbol, :max, nil] + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + # + # @return [Float, Symbol, :max, String, nil] optional :radius, union: -> { Imagekitio::TextOverlayTransformation::Radius } # @!attribute rotation @@ -116,7 +123,7 @@ class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel # # @param background [String] Specifies the background color of the text overlay. # - # @param flip [Symbol, Imagekitio::Models::TextOverlayTransformation::Flip] Flip the text overlay horizontally, vertically, or both. + # @param flip [Symbol, Imagekitio::Models::TextOverlayTransformation::Flip] Flip/mirror the text horizontally, vertically, or in both directions. # # @param font_color [String] Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `F # @@ -126,11 +133,11 @@ class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel # # @param inner_alignment [Symbol, Imagekitio::Models::TextOverlayTransformation::InnerAlignment] Specifies the inner alignment of the text when width is more than the text lengt # - # @param line_height [Float, String] Specifies the line height of the text overlay. + # @param line_height [Float, String] Specifies the line height for multi-line text overlays. It will come into effect # # @param padding [Float, String] Specifies the padding around the overlaid text. # - # @param radius [Float, Symbol, :max] Specifies the corner radius of the text overlay. + # @param radius [Float, Symbol, :max, String] Specifies the corner radius: # # @param rotation [Float, String] Specifies the rotation angle of the text overlay. # @@ -138,7 +145,9 @@ class TextOverlayTransformation < Imagekitio::Internal::Type::BaseModel # # @param width [Float, String] Specifies the maximum width (in pixels) of the overlaid text. The text wraps aut - # Flip the text overlay horizontally, vertically, or both. + # Flip/mirror the text horizontally, vertically, or in both directions. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. # # @see Imagekitio::Models::TextOverlayTransformation#flip module Flip @@ -183,10 +192,9 @@ module InnerAlignment # @return [Array] end - # 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`. + # Specifies the line height for multi-line text overlays. It will come into effect + # only if the text wraps over multiple lines. Accepts either an integer value or + # an arithmetic expression. # # @see Imagekitio::Models::TextOverlayTransformation#line_height module LineHeight @@ -216,8 +224,14 @@ module Padding # @return [Array(Float, String)] end - # Specifies the corner radius of the text overlay. Set to `max` to achieve a - # circular or oval shape. + # Specifies the corner radius: + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). # # @see Imagekitio::Models::TextOverlayTransformation#radius module Radius @@ -227,8 +241,10 @@ module Radius variant const: :max + variant String + # @!method self.variants - # @return [Array(Float, Symbol, :max)] + # @return [Array(Float, Symbol, :max, String)] end # Specifies the rotation angle of the text overlay. Accepts a numeric value for diff --git a/lib/imagekitio/models/transformation.rb b/lib/imagekitio/models/transformation.rb index 7fe5deb9..160d809b 100644 --- a/lib/imagekitio/models/transformation.rb +++ b/lib/imagekitio/models/transformation.rb @@ -104,6 +104,12 @@ class Transformation < Imagekitio::Internal::Type::BaseModel # # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See # [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). + # - Dominant color: `dominant` extracts the dominant color from the image. See + # [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). + # - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient + # using the dominant colors. Optionally specify palette size (2 or 4), e.g., + # `gradient_dominant_4`. See + # [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-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 @@ -139,6 +145,19 @@ class Transformation < Imagekitio::Internal::Type::BaseModel # @return [Boolean, nil] optional :color_profile, Imagekitio::Internal::Type::Boolean, api_name: :colorProfile + # @!attribute color_replace + # Replaces colors in the image. Supports three formats: + # + # - `toColor` - Replace dominant color with the specified color. + # - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). + # - `toColor_tolerance_fromColor` - Replace a specific color with another within + # tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., + # `red`, `blue`). See + # [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr). + # + # @return [String, nil] + optional :color_replace, String, api_name: :colorReplace + # @!attribute contrast_stretch # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). @@ -170,10 +189,25 @@ class Transformation < Imagekitio::Internal::Type::BaseModel # @return [String, nil] optional :default_image, String, api_name: :defaultImage + # @!attribute distort + # Distorts the shape of an image. Supports two modes: + # + # - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of + # the four corners starting clockwise from top-left. + # - Arc distortion: `a-degrees` curves the image upwards (positive values) or + # downwards (negative values). See + # [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort). + # + # @return [String, nil] + optional :distort, String + # @!attribute dpr # 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). + # (DPR) calculation. Also accepts arithmetic expressions. + # + # - Learn about + # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + # - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr). # # @return [Float, nil] optional :dpr, Float @@ -330,11 +364,16 @@ class Transformation < Imagekitio::Internal::Type::BaseModel optional :quality, Float # @!attribute radius - # 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). + # Specifies the corner radius for rounded corners. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). # - # @return [Float, Symbol, :max, nil] + # @return [Float, Symbol, :max, String, nil] optional :radius, union: -> { Imagekitio::Transformation::Radius } # @!attribute raw @@ -459,7 +498,7 @@ class Transformation < Imagekitio::Internal::Type::BaseModel # @return [Float, nil] optional :zoom, Float - # @!method initialize(ai_change_background: nil, ai_drop_shadow: nil, ai_edit: nil, ai_remove_background: nil, ai_remove_background_external: nil, ai_retouch: nil, ai_upscale: nil, ai_variation: nil, aspect_ratio: nil, audio_codec: nil, background: nil, blur: nil, border: nil, color_profile: nil, contrast_stretch: nil, crop: nil, crop_mode: nil, default_image: nil, dpr: nil, duration: nil, end_offset: nil, flip: nil, focus: nil, format_: nil, gradient: nil, grayscale: nil, height: nil, lossless: nil, metadata: nil, named: nil, opacity: nil, original: nil, overlay: nil, page: nil, progressive: nil, quality: nil, radius: nil, raw: nil, rotation: nil, shadow: nil, sharpen: nil, start_offset: nil, streaming_resolutions: nil, trim: nil, unsharp_mask: nil, video_codec: nil, width: nil, x: nil, x_center: nil, y_: nil, y_center: nil, zoom: nil) + # @!method initialize(ai_change_background: nil, ai_drop_shadow: nil, ai_edit: nil, ai_remove_background: nil, ai_remove_background_external: nil, ai_retouch: nil, ai_upscale: nil, ai_variation: nil, aspect_ratio: nil, audio_codec: nil, background: nil, blur: nil, border: nil, color_profile: nil, color_replace: nil, contrast_stretch: nil, crop: nil, crop_mode: nil, default_image: nil, distort: nil, dpr: nil, duration: nil, end_offset: nil, flip: nil, focus: nil, format_: nil, gradient: nil, grayscale: nil, height: nil, lossless: nil, metadata: nil, named: nil, opacity: nil, original: nil, overlay: nil, page: nil, progressive: nil, quality: nil, radius: nil, raw: nil, rotation: nil, shadow: nil, sharpen: nil, start_offset: nil, streaming_resolutions: nil, trim: nil, unsharp_mask: nil, video_codec: nil, width: nil, x: nil, x_center: nil, y_: nil, y_center: nil, zoom: nil) # Some parameter documentations has been truncated, see # {Imagekitio::Models::Transformation} for more details. # @@ -498,6 +537,8 @@ class Transformation < Imagekitio::Internal::Type::BaseModel # # @param color_profile [Boolean] Indicates whether the output image should retain the original color profile. # + # @param color_replace [String] Replaces colors in the image. Supports three formats: + # # @param contrast_stretch [Boolean, Imagekitio::Models::Transformation::ContrastStretch] Automatically enhances the contrast of an image (contrast stretch). # # @param crop [Symbol, Imagekitio::Models::Transformation::Crop] Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs @@ -506,6 +547,8 @@ class Transformation < Imagekitio::Internal::Type::BaseModel # # @param default_image [String] Specifies a fallback image if the resource is not found, e.g., a URL or file pat # + # @param distort [String] Distorts the shape of an image. Supports two modes: + # # @param dpr [Float] Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DP # # @param duration [Float, String] Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. @@ -542,7 +585,7 @@ class Transformation < Imagekitio::Internal::Type::BaseModel # # @param quality [Float] Specifies the quality of the output image for lossy formats such as JPEG, WebP, # - # @param radius [Float, Symbol, :max] Specifies the corner radius for rounded corners (e.g., 20) or `max` for circular + # @param radius [Float, Symbol, :max, String] Specifies the corner radius for rounded corners. # # @param raw [String] Pass any transformation not directly supported by the SDK. # @@ -886,9 +929,14 @@ module Page # @return [Array(Float, String)] end - # 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). + # Specifies the corner radius for rounded corners. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). # # @see Imagekitio::Models::Transformation#radius module Radius @@ -898,8 +946,10 @@ module Radius variant const: :max + variant String + # @!method self.variants - # @return [Array(Float, Symbol, :max)] + # @return [Array(Float, Symbol, :max, String)] end # Specifies the rotation angle in degrees. Positive values rotate the image diff --git a/lib/imagekitio/models/update_file_request.rb b/lib/imagekitio/models/update_file_request.rb index 1e030a07..8012e5ff 100644 --- a/lib/imagekitio/models/update_file_request.rb +++ b/lib/imagekitio/models/update_file_request.rb @@ -38,7 +38,7 @@ class UpdateFileDetails < Imagekitio::Internal::Type::BaseModel # Array of extensions to be applied to the asset. Each extension can be configured # with specific parameters based on the extension type. # - # @return [Array, nil] + # @return [Array, nil] optional :extensions, -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem] } # @!attribute remove_ai_tags @@ -82,7 +82,7 @@ class UpdateFileDetails < Imagekitio::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param remove_ai_tags [Array, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car # diff --git a/lib/imagekitio/models/video_overlay.rb b/lib/imagekitio/models/video_overlay.rb index ef765102..ebe83df7 100644 --- a/lib/imagekitio/models/video_overlay.rb +++ b/lib/imagekitio/models/video_overlay.rb @@ -21,6 +21,12 @@ class VideoOverlay < Imagekitio::Models::BaseOverlay # parameter to `base64`. To always use plain text (`i-{input}`), set it to # `plain`. # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. + # # @return [Symbol, Imagekitio::Models::VideoOverlay::Encoding, nil] optional :encoding, enum: -> { Imagekitio::VideoOverlay::Encoding } @@ -49,6 +55,12 @@ class VideoOverlay < Imagekitio::Models::BaseOverlay # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. module Encoding extend Imagekitio::Internal::Type::Enum diff --git a/lib/imagekitio/resources/beta/v2/files.rb b/lib/imagekitio/resources/beta/v2/files.rb index b5f5da37..678ca319 100644 --- a/lib/imagekitio/resources/beta/v2/files.rb +++ b/lib/imagekitio/resources/beta/v2/files.rb @@ -52,7 +52,7 @@ class Files # # @param description [String] Optional text to describe the contents of the file. # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekitio/resources/files.rb b/lib/imagekitio/resources/files.rb index ab7db3a5..7e961f4b 100644 --- a/lib/imagekitio/resources/files.rb +++ b/lib/imagekitio/resources/files.rb @@ -242,7 +242,7 @@ def rename(params) # # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki # - # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured + # @param extensions [Array] Array of extensions to be applied to the asset. Each extension can be configured # # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e # diff --git a/lib/imagekitio/resources/files/metadata.rb b/lib/imagekitio/resources/files/metadata.rb index 1e902b04..f732ab33 100644 --- a/lib/imagekitio/resources/files/metadata.rb +++ b/lib/imagekitio/resources/files/metadata.rb @@ -50,7 +50,7 @@ def get_from_url(params) parsed, options = Imagekitio::Files::MetadataGetFromURLParams.dump_request(params) @client.request( method: :get, - path: "v1/files/metadata", + path: "v1/metadata", query: parsed, model: Imagekitio::Metadata, options: options diff --git a/lib/imagekitio/resources/saved_extensions.rb b/lib/imagekitio/resources/saved_extensions.rb new file mode 100644 index 00000000..ff8e1a77 --- /dev/null +++ b/lib/imagekitio/resources/saved_extensions.rb @@ -0,0 +1,146 @@ +# frozen_string_literal: true + +module Imagekitio + module Resources + class SavedExtensions + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::SavedExtensionCreateParams} for more details. + # + # This API creates a new saved extension. Saved extensions allow you to save + # complex extension configurations (like AI tasks) and reuse them by referencing + # the ID in upload or update file APIs. + # + # **Saved extension limit** \ + # You can create a maximum of 100 saved extensions per account. + # + # @overload create(config:, description:, name:, request_options: {}) + # + # @param config [Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension] Configuration object for an extension (base extensions only, not saved extension + # + # @param description [String] Description of what the saved extension does. + # + # @param name [String] Name of the saved extension. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekitio::Models::SavedExtension] + # + # @see Imagekitio::Models::SavedExtensionCreateParams + def create(params) + parsed, options = Imagekitio::SavedExtensionCreateParams.dump_request(params) + @client.request( + method: :post, + path: "v1/saved-extensions", + body: parsed, + model: Imagekitio::SavedExtension, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::SavedExtensionUpdateParams} for more details. + # + # This API updates an existing saved extension. You can update the name, + # description, or config. + # + # @overload update(id, config: nil, description: nil, name: nil, request_options: {}) + # + # @param id [String] The unique ID of the saved extension. + # + # @param config [Imagekitio::Models::ExtensionConfig::RemoveBg, Imagekitio::Models::ExtensionConfig::AIAutoDescription, Imagekitio::Models::ExtensionConfig::AITasks, Imagekitio::Models::ExtensionConfig::AutoTaggingExtension] Configuration object for an extension (base extensions only, not saved extension + # + # @param description [String] Updated description of the saved extension. + # + # @param name [String] Updated name of the saved extension. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekitio::Models::SavedExtension] + # + # @see Imagekitio::Models::SavedExtensionUpdateParams + def update(id, params = {}) + parsed, options = Imagekitio::SavedExtensionUpdateParams.dump_request(params) + @client.request( + method: :patch, + path: ["v1/saved-extensions/%1$s", id], + body: parsed, + model: Imagekitio::SavedExtension, + options: options + ) + end + + # This API returns an array of all saved extensions for your account. Saved + # extensions allow you to save complex extension configurations and reuse them by + # referencing them by ID in upload or update file APIs. + # + # @overload list(request_options: {}) + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Imagekitio::Models::SavedExtensionListParams + def list(params = {}) + @client.request( + method: :get, + path: "v1/saved-extensions", + model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::SavedExtension], + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::SavedExtensionDeleteParams} for more details. + # + # This API deletes a saved extension permanently. + # + # @overload delete(id, request_options: {}) + # + # @param id [String] The unique ID of the saved extension. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [nil] + # + # @see Imagekitio::Models::SavedExtensionDeleteParams + def delete(id, params = {}) + @client.request( + method: :delete, + path: ["v1/saved-extensions/%1$s", id], + model: NilClass, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Imagekitio::Models::SavedExtensionGetParams} for more details. + # + # This API returns details of a specific saved extension by ID. + # + # @overload get(id, request_options: {}) + # + # @param id [String] The unique ID of the saved extension. + # + # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Imagekitio::Models::SavedExtension] + # + # @see Imagekitio::Models::SavedExtensionGetParams + def get(id, params = {}) + @client.request( + method: :get, + path: ["v1/saved-extensions/%1$s", id], + model: Imagekitio::SavedExtension, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Imagekitio::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/rbi/imagekitio/client.rbi b/rbi/imagekitio/client.rbi index 53478892..a5e5a64c 100644 --- a/rbi/imagekitio/client.rbi +++ b/rbi/imagekitio/client.rbi @@ -26,6 +26,9 @@ module Imagekitio sig { returns(Imagekitio::Resources::Files) } attr_reader :files + sig { returns(Imagekitio::Resources::SavedExtensions) } + attr_reader :saved_extensions + sig { returns(Imagekitio::Resources::Assets) } attr_reader :assets diff --git a/rbi/imagekitio/models.rbi b/rbi/imagekitio/models.rbi index 5e425cc7..0d061049 100644 --- a/rbi/imagekitio/models.rbi +++ b/rbi/imagekitio/models.rbi @@ -27,6 +27,8 @@ module Imagekitio CustomMetadataFieldUpdateParams = Imagekitio::Models::CustomMetadataFieldUpdateParams + ExtensionConfig = Imagekitio::Models::ExtensionConfig + ExtensionItem = Imagekitio::Models::ExtensionItem Extensions = @@ -78,6 +80,18 @@ module Imagekitio ResponsiveImageAttributes = Imagekitio::Models::ResponsiveImageAttributes + SavedExtension = Imagekitio::Models::SavedExtension + + SavedExtensionCreateParams = Imagekitio::Models::SavedExtensionCreateParams + + SavedExtensionDeleteParams = Imagekitio::Models::SavedExtensionDeleteParams + + SavedExtensionGetParams = Imagekitio::Models::SavedExtensionGetParams + + SavedExtensionListParams = Imagekitio::Models::SavedExtensionListParams + + SavedExtensionUpdateParams = Imagekitio::Models::SavedExtensionUpdateParams + SolidColorOverlay = Imagekitio::Models::SolidColorOverlay SolidColorOverlayTransformation = diff --git a/rbi/imagekitio/models/base_overlay.rbi b/rbi/imagekitio/models/base_overlay.rbi index 30cca96c..73e1b53a 100644 --- a/rbi/imagekitio/models/base_overlay.rbi +++ b/rbi/imagekitio/models/base_overlay.rbi @@ -8,12 +8,45 @@ module Imagekitio T.any(Imagekitio::BaseOverlay, Imagekitio::Internal::AnyHash) end + # Controls how the layer blends with the base image or underlying content. Maps to + # `lm` in the URL. By default, layers completely cover the base image beneath + # them. Layer modes change this behavior: + # + # - `multiply`: Multiplies the pixel values of the layer with the base image. The + # result is always darker than the original images. This is ideal for applying + # shadows or color tints. + # - `displace`: Uses the layer as a displacement map to distort pixels in the base + # image. The red channel controls horizontal displacement, and the green channel + # controls vertical displacement. Requires `x` or `y` parameter to control + # displacement magnitude. + # - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the + # base image transparent, while transparent areas leave the base image + # unchanged. This mode functions like a hole-punch, effectively cutting the + # shape of the layer out of the underlying image. + # - `cutter`: Acts as a shape mask where only the parts of the base image that + # fall inside the opaque area of the layer are preserved. This mode functions + # like a cookie-cutter, trimming the base image to match the specific dimensions + # and shape of the layer. See + # [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes). + sig { returns(T.nilable(Imagekitio::BaseOverlay::LayerMode::OrSymbol)) } + attr_reader :layer_mode + + sig do + params(layer_mode: Imagekitio::BaseOverlay::LayerMode::OrSymbol).void + end + attr_writer :layer_mode + + # Specifies the overlay's position relative to the parent asset. See + # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer). sig { returns(T.nilable(Imagekitio::OverlayPosition)) } attr_reader :position sig { params(position: Imagekitio::OverlayPosition::OrHash).void } attr_writer :position + # Specifies timing information for the overlay (only applicable if the base asset + # is a video). See + # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer). sig { returns(T.nilable(Imagekitio::OverlayTiming)) } attr_reader :timing @@ -22,16 +55,47 @@ module Imagekitio sig do params( + layer_mode: Imagekitio::BaseOverlay::LayerMode::OrSymbol, position: Imagekitio::OverlayPosition::OrHash, timing: Imagekitio::OverlayTiming::OrHash ).returns(T.attached_class) end - def self.new(position: nil, timing: nil) + def self.new( + # Controls how the layer blends with the base image or underlying content. Maps to + # `lm` in the URL. By default, layers completely cover the base image beneath + # them. Layer modes change this behavior: + # + # - `multiply`: Multiplies the pixel values of the layer with the base image. The + # result is always darker than the original images. This is ideal for applying + # shadows or color tints. + # - `displace`: Uses the layer as a displacement map to distort pixels in the base + # image. The red channel controls horizontal displacement, and the green channel + # controls vertical displacement. Requires `x` or `y` parameter to control + # displacement magnitude. + # - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the + # base image transparent, while transparent areas leave the base image + # unchanged. This mode functions like a hole-punch, effectively cutting the + # shape of the layer out of the underlying image. + # - `cutter`: Acts as a shape mask where only the parts of the base image that + # fall inside the opaque area of the layer are preserved. This mode functions + # like a cookie-cutter, trimming the base image to match the specific dimensions + # and shape of the layer. See + # [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes). + layer_mode: nil, + # Specifies the overlay's position relative to the parent asset. See + # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer). + position: nil, + # Specifies timing information for the overlay (only applicable if the base asset + # is a video). See + # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer). + timing: nil + ) end sig do override.returns( { + layer_mode: Imagekitio::BaseOverlay::LayerMode::OrSymbol, position: Imagekitio::OverlayPosition, timing: Imagekitio::OverlayTiming } @@ -39,6 +103,51 @@ module Imagekitio end def to_hash end + + # Controls how the layer blends with the base image or underlying content. Maps to + # `lm` in the URL. By default, layers completely cover the base image beneath + # them. Layer modes change this behavior: + # + # - `multiply`: Multiplies the pixel values of the layer with the base image. The + # result is always darker than the original images. This is ideal for applying + # shadows or color tints. + # - `displace`: Uses the layer as a displacement map to distort pixels in the base + # image. The red channel controls horizontal displacement, and the green channel + # controls vertical displacement. Requires `x` or `y` parameter to control + # displacement magnitude. + # - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the + # base image transparent, while transparent areas leave the base image + # unchanged. This mode functions like a hole-punch, effectively cutting the + # shape of the layer out of the underlying image. + # - `cutter`: Acts as a shape mask where only the parts of the base image that + # fall inside the opaque area of the layer are preserved. This mode functions + # like a cookie-cutter, trimming the base image to match the specific dimensions + # and shape of the layer. See + # [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes). + module LayerMode + extend Imagekitio::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Imagekitio::BaseOverlay::LayerMode) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + MULTIPLY = + T.let(:multiply, Imagekitio::BaseOverlay::LayerMode::TaggedSymbol) + CUTTER = + T.let(:cutter, Imagekitio::BaseOverlay::LayerMode::TaggedSymbol) + CUTOUT = + T.let(:cutout, Imagekitio::BaseOverlay::LayerMode::TaggedSymbol) + DISPLACE = + T.let(:displace, Imagekitio::BaseOverlay::LayerMode::TaggedSymbol) + + sig do + override.returns( + T::Array[Imagekitio::BaseOverlay::LayerMode::TaggedSymbol] + ) + end + def self.values + end + end end end end diff --git a/rbi/imagekitio/models/beta/v2/file_upload_params.rbi b/rbi/imagekitio/models/beta/v2/file_upload_params.rbi index cb350106..a7609249 100644 --- a/rbi/imagekitio/models/beta/v2/file_upload_params.rbi +++ b/rbi/imagekitio/models/beta/v2/file_upload_params.rbi @@ -98,6 +98,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg, Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AITasks, + Imagekitio::ExtensionItem::SavedExtension, Imagekitio::ExtensionItem::AutoTaggingExtension ) ] @@ -113,6 +115,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg::OrHash, Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AITasks::OrHash, + Imagekitio::ExtensionItem::SavedExtension::OrHash, Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ] @@ -280,6 +284,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg::OrHash, Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AITasks::OrHash, + Imagekitio::ExtensionItem::SavedExtension::OrHash, Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], @@ -431,6 +437,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg, Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AITasks, + Imagekitio::ExtensionItem::SavedExtension, Imagekitio::ExtensionItem::AutoTaggingExtension ) ], diff --git a/rbi/imagekitio/models/extension_config.rbi b/rbi/imagekitio/models/extension_config.rbi new file mode 100644 index 00000000..e83e8fe8 --- /dev/null +++ b/rbi/imagekitio/models/extension_config.rbi @@ -0,0 +1,1403 @@ +# typed: strong + +module Imagekitio + module Models + # Configuration object for an extension (base extensions only, not saved extension + # references). + module ExtensionConfig + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::RemoveBg, + Imagekitio::ExtensionConfig::AIAutoDescription, + Imagekitio::ExtensionConfig::AITasks, + Imagekitio::ExtensionConfig::AutoTaggingExtension + ) + end + + class RemoveBg < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::RemoveBg, + Imagekitio::Internal::AnyHash + ) + end + + # Specifies the background removal extension. + sig { returns(Symbol) } + attr_accessor :name + + sig do + returns(T.nilable(Imagekitio::ExtensionConfig::RemoveBg::Options)) + end + attr_reader :options + + sig do + params( + options: Imagekitio::ExtensionConfig::RemoveBg::Options::OrHash + ).void + end + attr_writer :options + + sig do + params( + options: Imagekitio::ExtensionConfig::RemoveBg::Options::OrHash, + name: Symbol + ).returns(T.attached_class) + end + def self.new( + options: nil, + # Specifies the background removal extension. + name: :"remove-bg" + ) + end + + sig do + override.returns( + { + name: Symbol, + options: Imagekitio::ExtensionConfig::RemoveBg::Options + } + ) + end + def to_hash + end + + class Options < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::RemoveBg::Options, + Imagekitio::Internal::AnyHash + ) + end + + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :add_shadow + + sig { params(add_shadow: T::Boolean).void } + attr_writer :add_shadow + + # 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. + sig { returns(T.nilable(String)) } + attr_reader :bg_color + + sig { params(bg_color: String).void } + attr_writer :bg_color + + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + sig { returns(T.nilable(String)) } + attr_reader :bg_image_url + + sig { params(bg_image_url: String).void } + attr_writer :bg_image_url + + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :semitransparency + + sig { params(semitransparency: T::Boolean).void } + attr_writer :semitransparency + + sig do + params( + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Whether to add an artificial shadow to the result. Default is false. Note: + # Adding shadows is currently only supported for car photos. + add_shadow: nil, + # 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. + bg_color: nil, + # Sets a background image from a URL. If this parameter is set, `bg_color` must be + # empty. + bg_image_url: nil, + # Allows semi-transparent regions in the result. Default is true. Note: + # Semitransparency is currently only supported for car windows. + semitransparency: nil + ) + end + + sig do + override.returns( + { + add_shadow: T::Boolean, + bg_color: String, + bg_image_url: String, + semitransparency: T::Boolean + } + ) + end + def to_hash + end + end + end + + class AutoTaggingExtension < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AutoTaggingExtension, + Imagekitio::Internal::AnyHash + ) + end + + # Maximum number of tags to attach to the asset. + sig { returns(Integer) } + attr_accessor :max_tags + + # Minimum confidence level for tags to be considered valid. + sig { returns(Integer) } + attr_accessor :min_confidence + + # Specifies the auto-tagging extension used. + sig do + returns( + Imagekitio::ExtensionConfig::AutoTaggingExtension::Name::OrSymbol + ) + end + attr_accessor :name + + sig do + params( + max_tags: Integer, + min_confidence: Integer, + name: + Imagekitio::ExtensionConfig::AutoTaggingExtension::Name::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Maximum number of tags to attach to the asset. + max_tags:, + # Minimum confidence level for tags to be considered valid. + min_confidence:, + # Specifies the auto-tagging extension used. + name: + ) + end + + sig do + override.returns( + { + max_tags: Integer, + min_confidence: Integer, + name: + Imagekitio::ExtensionConfig::AutoTaggingExtension::Name::OrSymbol + } + ) + end + def to_hash + end + + # Specifies the auto-tagging extension used. + module Name + extend Imagekitio::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekitio::ExtensionConfig::AutoTaggingExtension::Name + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE_AUTO_TAGGING = + T.let( + :"google-auto-tagging", + Imagekitio::ExtensionConfig::AutoTaggingExtension::Name::TaggedSymbol + ) + AWS_AUTO_TAGGING = + T.let( + :"aws-auto-tagging", + Imagekitio::ExtensionConfig::AutoTaggingExtension::Name::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionConfig::AutoTaggingExtension::Name::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class AIAutoDescription < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AIAutoDescription, + Imagekitio::Internal::AnyHash + ) + end + + # Specifies the auto description extension. + sig { returns(Symbol) } + attr_accessor :name + + sig { params(name: Symbol).returns(T.attached_class) } + def self.new( + # Specifies the auto description extension. + name: :"ai-auto-description" + ) + end + + sig { override.returns({ name: Symbol }) } + def to_hash + end + end + + class AITasks < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks, + Imagekitio::Internal::AnyHash + ) + end + + # Specifies the AI tasks extension for automated image analysis using AI models. + sig { returns(Symbol) } + attr_accessor :name + + # Array of task objects defining AI operations to perform on the asset. + sig do + returns( + T::Array[ + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::SelectTags, + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata, + Imagekitio::ExtensionConfig::AITasks::Task::YesNo + ) + ] + ) + end + attr_accessor :tasks + + sig do + params( + tasks: + T::Array[ + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::SelectTags::OrHash, + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata::OrHash, + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OrHash + ) + ], + name: Symbol + ).returns(T.attached_class) + end + def self.new( + # Array of task objects defining AI operations to perform on the asset. + tasks:, + # Specifies the AI tasks extension for automated image analysis using AI models. + name: :"ai-tasks" + ) + end + + sig do + override.returns( + { + name: Symbol, + tasks: + T::Array[ + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::SelectTags, + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata, + Imagekitio::ExtensionConfig::AITasks::Task::YesNo + ) + ] + } + ) + end + def to_hash + end + + module Task + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::SelectTags, + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata, + Imagekitio::ExtensionConfig::AITasks::Task::YesNo + ) + end + + class SelectTags < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::SelectTags, + Imagekitio::Internal::AnyHash + ) + end + + # The question or instruction for the AI to analyze the image. + sig { returns(String) } + attr_accessor :instruction + + # Task type that analyzes the image and adds matching tags from a vocabulary. + sig { returns(Symbol) } + attr_accessor :type + + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + sig { returns(T::Array[String]) } + attr_accessor :vocabulary + + # Maximum number of tags to select from the vocabulary. + sig { returns(T.nilable(Integer)) } + attr_reader :max_selections + + sig { params(max_selections: Integer).void } + attr_writer :max_selections + + # Minimum number of tags to select from the vocabulary. + sig { returns(T.nilable(Integer)) } + attr_reader :min_selections + + sig { params(min_selections: Integer).void } + attr_writer :min_selections + + sig do + params( + instruction: String, + vocabulary: T::Array[String], + max_selections: Integer, + min_selections: Integer, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # The question or instruction for the AI to analyze the image. + instruction:, + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + vocabulary:, + # Maximum number of tags to select from the vocabulary. + max_selections: nil, + # Minimum number of tags to select from the vocabulary. + min_selections: nil, + # Task type that analyzes the image and adds matching tags from a vocabulary. + type: :select_tags + ) + end + + sig do + override.returns( + { + instruction: String, + type: Symbol, + vocabulary: T::Array[String], + max_selections: Integer, + min_selections: Integer + } + ) + end + def to_hash + end + end + + class SelectMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to set. The field must exist in your account. + sig { returns(String) } + attr_accessor :field + + # The question or instruction for the AI to analyze the image. + sig { returns(String) } + attr_accessor :instruction + + # Task type that analyzes the image and sets a custom metadata field value from a + # vocabulary. + sig { returns(Symbol) } + attr_accessor :type + + # Maximum number of values to select from the vocabulary. + sig { returns(T.nilable(Integer)) } + attr_reader :max_selections + + sig { params(max_selections: Integer).void } + attr_writer :max_selections + + # Minimum number of values to select from the vocabulary. + sig { returns(T.nilable(Integer)) } + attr_reader :min_selections + + sig { params(min_selections: Integer).void } + attr_writer :min_selections + + # Array of possible values matching the custom metadata field type. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata::Vocabulary::Variants + ] + ) + ) + end + attr_reader :vocabulary + + sig do + params( + vocabulary: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata::Vocabulary::Variants + ] + ).void + end + attr_writer :vocabulary + + sig do + params( + field: String, + instruction: String, + max_selections: Integer, + min_selections: Integer, + vocabulary: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata::Vocabulary::Variants + ], + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Name of the custom metadata field to set. The field must exist in your account. + field:, + # The question or instruction for the AI to analyze the image. + instruction:, + # Maximum number of values to select from the vocabulary. + max_selections: nil, + # Minimum number of values to select from the vocabulary. + min_selections: nil, + # Array of possible values matching the custom metadata field type. + vocabulary: nil, + # Task type that analyzes the image and sets a custom metadata field value from a + # vocabulary. + type: :select_metadata + ) + end + + sig do + override.returns( + { + field: String, + instruction: String, + type: Symbol, + max_selections: Integer, + min_selections: Integer, + vocabulary: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata::Vocabulary::Variants + ] + } + ) + end + def to_hash + end + + module Vocabulary + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata::Vocabulary::Variants + ] + ) + end + def self.variants + end + end + end + + class YesNo < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo, + Imagekitio::Internal::AnyHash + ) + end + + # The yes/no question for the AI to answer about the image. + sig { returns(String) } + attr_accessor :instruction + + # Task type that asks a yes/no question and executes actions based on the answer. + sig { returns(Symbol) } + attr_accessor :type + + # Actions to execute if the AI answers no. + sig do + returns( + T.nilable( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo + ) + ) + end + attr_reader :on_no + + sig do + params( + on_no: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::OrHash + ).void + end + attr_writer :on_no + + # Actions to execute if the AI cannot determine the answer. + sig do + returns( + T.nilable( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown + ) + ) + end + attr_reader :on_unknown + + sig do + params( + on_unknown: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::OrHash + ).void + end + attr_writer :on_unknown + + # Actions to execute if the AI answers yes. + sig do + returns( + T.nilable( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes + ) + ) + end + attr_reader :on_yes + + sig do + params( + on_yes: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::OrHash + ).void + end + attr_writer :on_yes + + sig do + params( + instruction: String, + on_no: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::OrHash, + on_unknown: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::OrHash, + on_yes: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::OrHash, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # The yes/no question for the AI to answer about the image. + instruction:, + # Actions to execute if the AI answers no. + on_no: nil, + # Actions to execute if the AI cannot determine the answer. + on_unknown: nil, + # Actions to execute if the AI answers yes. + on_yes: nil, + # Task type that asks a yes/no question and executes actions based on the answer. + type: :yes_no + ) + end + + sig do + override.returns( + { + instruction: String, + type: Symbol, + on_no: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo, + on_unknown: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown, + on_yes: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes + } + ) + end + def to_hash + end + + class OnNo < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo, + Imagekitio::Internal::AnyHash + ) + end + + # Array of tag strings to add to the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :add_tags + + sig { params(add_tags: T::Array[String]).void } + attr_writer :add_tags + + # Array of tag strings to remove from the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :remove_tags + + sig { params(remove_tags: T::Array[String]).void } + attr_writer :remove_tags + + # Array of custom metadata field updates. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata + ] + ) + ) + end + attr_reader :set_metadata + + sig do + params( + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::OrHash + ] + ).void + end + attr_writer :set_metadata + + # Array of custom metadata fields to remove. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata + ] + ) + ) + end + attr_reader :unset_metadata + + sig do + params( + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata::OrHash + ] + ).void + end + attr_writer :unset_metadata + + # Actions to execute if the AI answers no. + sig do + params( + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::OrHash + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata::OrHash + ] + ).returns(T.attached_class) + end + def self.new( + # Array of tag strings to add to the asset. + add_tags: nil, + # Array of tag strings to remove from the asset. + remove_tags: nil, + # Array of custom metadata field updates. + set_metadata: nil, + # Array of custom metadata fields to remove. + unset_metadata: nil + ) + end + + sig do + override.returns( + { + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata + ] + } + ) + end + def to_hash + end + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to set. + sig { returns(String) } + attr_accessor :field + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + sig do + returns( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Variants + ) + end + attr_accessor :value + + sig do + params( + field: String, + value: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Variants + ).returns(T.attached_class) + end + def self.new( + # Name of the custom metadata field to set. + field:, + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + value: + ) + end + + sig do + override.returns( + { + field: String, + value: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Variants + } + ) + end + def to_hash + end + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + module Value + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + union: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Mixed + ], + Imagekitio::Internal::Type::Converter + ) + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to remove. + sig { returns(String) } + attr_accessor :field + + sig { params(field: String).returns(T.attached_class) } + def self.new( + # Name of the custom metadata field to remove. + field: + ) + end + + sig { override.returns({ field: String }) } + def to_hash + end + end + end + + class OnUnknown < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown, + Imagekitio::Internal::AnyHash + ) + end + + # Array of tag strings to add to the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :add_tags + + sig { params(add_tags: T::Array[String]).void } + attr_writer :add_tags + + # Array of tag strings to remove from the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :remove_tags + + sig { params(remove_tags: T::Array[String]).void } + attr_writer :remove_tags + + # Array of custom metadata field updates. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata + ] + ) + ) + end + attr_reader :set_metadata + + sig do + params( + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::OrHash + ] + ).void + end + attr_writer :set_metadata + + # Array of custom metadata fields to remove. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata + ] + ) + ) + end + attr_reader :unset_metadata + + sig do + params( + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata::OrHash + ] + ).void + end + attr_writer :unset_metadata + + # Actions to execute if the AI cannot determine the answer. + sig do + params( + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::OrHash + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata::OrHash + ] + ).returns(T.attached_class) + end + def self.new( + # Array of tag strings to add to the asset. + add_tags: nil, + # Array of tag strings to remove from the asset. + remove_tags: nil, + # Array of custom metadata field updates. + set_metadata: nil, + # Array of custom metadata fields to remove. + unset_metadata: nil + ) + end + + sig do + override.returns( + { + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata + ] + } + ) + end + def to_hash + end + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to set. + sig { returns(String) } + attr_accessor :field + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + sig do + returns( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Variants + ) + end + attr_accessor :value + + sig do + params( + field: String, + value: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Variants + ).returns(T.attached_class) + end + def self.new( + # Name of the custom metadata field to set. + field:, + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + value: + ) + end + + sig do + override.returns( + { + field: String, + value: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Variants + } + ) + end + def to_hash + end + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + module Value + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + union: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Mixed + ], + Imagekitio::Internal::Type::Converter + ) + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to remove. + sig { returns(String) } + attr_accessor :field + + sig { params(field: String).returns(T.attached_class) } + def self.new( + # Name of the custom metadata field to remove. + field: + ) + end + + sig { override.returns({ field: String }) } + def to_hash + end + end + end + + class OnYes < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes, + Imagekitio::Internal::AnyHash + ) + end + + # Array of tag strings to add to the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :add_tags + + sig { params(add_tags: T::Array[String]).void } + attr_writer :add_tags + + # Array of tag strings to remove from the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :remove_tags + + sig { params(remove_tags: T::Array[String]).void } + attr_writer :remove_tags + + # Array of custom metadata field updates. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata + ] + ) + ) + end + attr_reader :set_metadata + + sig do + params( + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::OrHash + ] + ).void + end + attr_writer :set_metadata + + # Array of custom metadata fields to remove. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata + ] + ) + ) + end + attr_reader :unset_metadata + + sig do + params( + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata::OrHash + ] + ).void + end + attr_writer :unset_metadata + + # Actions to execute if the AI answers yes. + sig do + params( + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::OrHash + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata::OrHash + ] + ).returns(T.attached_class) + end + def self.new( + # Array of tag strings to add to the asset. + add_tags: nil, + # Array of tag strings to remove from the asset. + remove_tags: nil, + # Array of custom metadata field updates. + set_metadata: nil, + # Array of custom metadata fields to remove. + unset_metadata: nil + ) + end + + sig do + override.returns( + { + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata + ] + } + ) + end + def to_hash + end + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to set. + sig { returns(String) } + attr_accessor :field + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + sig do + returns( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Variants + ) + end + attr_accessor :value + + sig do + params( + field: String, + value: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Variants + ).returns(T.attached_class) + end + def self.new( + # Name of the custom metadata field to set. + field:, + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + value: + ) + end + + sig do + override.returns( + { + field: String, + value: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Variants + } + ) + end + def to_hash + end + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + module Value + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + union: + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Mixed + ], + Imagekitio::Internal::Type::Converter + ) + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to remove. + sig { returns(String) } + attr_accessor :field + + sig { params(field: String).returns(T.attached_class) } + def self.new( + # Name of the custom metadata field to remove. + field: + ) + end + + sig { override.returns({ field: String }) } + def to_hash + end + end + end + end + + sig do + override.returns( + T::Array[Imagekitio::ExtensionConfig::AITasks::Task::Variants] + ) + end + def self.variants + end + end + end + + sig { override.returns(T::Array[Imagekitio::ExtensionConfig::Variants]) } + def self.variants + end + end + end +end diff --git a/rbi/imagekitio/models/extensions.rbi b/rbi/imagekitio/models/extensions.rbi index e93e473b..8940a325 100644 --- a/rbi/imagekitio/models/extensions.rbi +++ b/rbi/imagekitio/models/extensions.rbi @@ -10,6 +10,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg, Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AITasks, + Imagekitio::ExtensionItem::SavedExtension, Imagekitio::ExtensionItem::AutoTaggingExtension ) end @@ -260,6 +262,1163 @@ module Imagekitio end end + class AITasks < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks, + Imagekitio::Internal::AnyHash + ) + end + + # Specifies the AI tasks extension for automated image analysis using AI models. + sig { returns(Symbol) } + attr_accessor :name + + # Array of task objects defining AI operations to perform on the asset. + sig do + returns( + T::Array[ + T.any( + Imagekitio::ExtensionItem::AITasks::Task::SelectTags, + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata, + Imagekitio::ExtensionItem::AITasks::Task::YesNo + ) + ] + ) + end + attr_accessor :tasks + + sig do + params( + tasks: + T::Array[ + T.any( + Imagekitio::ExtensionItem::AITasks::Task::SelectTags::OrHash, + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata::OrHash, + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OrHash + ) + ], + name: Symbol + ).returns(T.attached_class) + end + def self.new( + # Array of task objects defining AI operations to perform on the asset. + tasks:, + # Specifies the AI tasks extension for automated image analysis using AI models. + name: :"ai-tasks" + ) + end + + sig do + override.returns( + { + name: Symbol, + tasks: + T::Array[ + T.any( + Imagekitio::ExtensionItem::AITasks::Task::SelectTags, + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata, + Imagekitio::ExtensionItem::AITasks::Task::YesNo + ) + ] + } + ) + end + def to_hash + end + + module Task + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::SelectTags, + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata, + Imagekitio::ExtensionItem::AITasks::Task::YesNo + ) + end + + class SelectTags < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::SelectTags, + Imagekitio::Internal::AnyHash + ) + end + + # The question or instruction for the AI to analyze the image. + sig { returns(String) } + attr_accessor :instruction + + # Task type that analyzes the image and adds matching tags from a vocabulary. + sig { returns(Symbol) } + attr_accessor :type + + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + sig { returns(T::Array[String]) } + attr_accessor :vocabulary + + # Maximum number of tags to select from the vocabulary. + sig { returns(T.nilable(Integer)) } + attr_reader :max_selections + + sig { params(max_selections: Integer).void } + attr_writer :max_selections + + # Minimum number of tags to select from the vocabulary. + sig { returns(T.nilable(Integer)) } + attr_reader :min_selections + + sig { params(min_selections: Integer).void } + attr_writer :min_selections + + sig do + params( + instruction: String, + vocabulary: T::Array[String], + max_selections: Integer, + min_selections: Integer, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # The question or instruction for the AI to analyze the image. + instruction:, + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + vocabulary:, + # Maximum number of tags to select from the vocabulary. + max_selections: nil, + # Minimum number of tags to select from the vocabulary. + min_selections: nil, + # Task type that analyzes the image and adds matching tags from a vocabulary. + type: :select_tags + ) + end + + sig do + override.returns( + { + instruction: String, + type: Symbol, + vocabulary: T::Array[String], + max_selections: Integer, + min_selections: Integer + } + ) + end + def to_hash + end + end + + class SelectMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to set. The field must exist in your account. + sig { returns(String) } + attr_accessor :field + + # The question or instruction for the AI to analyze the image. + sig { returns(String) } + attr_accessor :instruction + + # Task type that analyzes the image and sets a custom metadata field value from a + # vocabulary. + sig { returns(Symbol) } + attr_accessor :type + + # Maximum number of values to select from the vocabulary. + sig { returns(T.nilable(Integer)) } + attr_reader :max_selections + + sig { params(max_selections: Integer).void } + attr_writer :max_selections + + # Minimum number of values to select from the vocabulary. + sig { returns(T.nilable(Integer)) } + attr_reader :min_selections + + sig { params(min_selections: Integer).void } + attr_writer :min_selections + + # Array of possible values matching the custom metadata field type. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata::Vocabulary::Variants + ] + ) + ) + end + attr_reader :vocabulary + + sig do + params( + vocabulary: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata::Vocabulary::Variants + ] + ).void + end + attr_writer :vocabulary + + sig do + params( + field: String, + instruction: String, + max_selections: Integer, + min_selections: Integer, + vocabulary: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata::Vocabulary::Variants + ], + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Name of the custom metadata field to set. The field must exist in your account. + field:, + # The question or instruction for the AI to analyze the image. + instruction:, + # Maximum number of values to select from the vocabulary. + max_selections: nil, + # Minimum number of values to select from the vocabulary. + min_selections: nil, + # Array of possible values matching the custom metadata field type. + vocabulary: nil, + # Task type that analyzes the image and sets a custom metadata field value from a + # vocabulary. + type: :select_metadata + ) + end + + sig do + override.returns( + { + field: String, + instruction: String, + type: Symbol, + max_selections: Integer, + min_selections: Integer, + vocabulary: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata::Vocabulary::Variants + ] + } + ) + end + def to_hash + end + + module Vocabulary + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata::Vocabulary::Variants + ] + ) + end + def self.variants + end + end + end + + class YesNo < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo, + Imagekitio::Internal::AnyHash + ) + end + + # The yes/no question for the AI to answer about the image. + sig { returns(String) } + attr_accessor :instruction + + # Task type that asks a yes/no question and executes actions based on the answer. + sig { returns(Symbol) } + attr_accessor :type + + # Actions to execute if the AI answers no. + sig do + returns( + T.nilable(Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo) + ) + end + attr_reader :on_no + + sig do + params( + on_no: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::OrHash + ).void + end + attr_writer :on_no + + # Actions to execute if the AI cannot determine the answer. + sig do + returns( + T.nilable( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown + ) + ) + end + attr_reader :on_unknown + + sig do + params( + on_unknown: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::OrHash + ).void + end + attr_writer :on_unknown + + # Actions to execute if the AI answers yes. + sig do + returns( + T.nilable( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes + ) + ) + end + attr_reader :on_yes + + sig do + params( + on_yes: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::OrHash + ).void + end + attr_writer :on_yes + + sig do + params( + instruction: String, + on_no: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::OrHash, + on_unknown: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::OrHash, + on_yes: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::OrHash, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # The yes/no question for the AI to answer about the image. + instruction:, + # Actions to execute if the AI answers no. + on_no: nil, + # Actions to execute if the AI cannot determine the answer. + on_unknown: nil, + # Actions to execute if the AI answers yes. + on_yes: nil, + # Task type that asks a yes/no question and executes actions based on the answer. + type: :yes_no + ) + end + + sig do + override.returns( + { + instruction: String, + type: Symbol, + on_no: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo, + on_unknown: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown, + on_yes: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes + } + ) + end + def to_hash + end + + class OnNo < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo, + Imagekitio::Internal::AnyHash + ) + end + + # Array of tag strings to add to the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :add_tags + + sig { params(add_tags: T::Array[String]).void } + attr_writer :add_tags + + # Array of tag strings to remove from the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :remove_tags + + sig { params(remove_tags: T::Array[String]).void } + attr_writer :remove_tags + + # Array of custom metadata field updates. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata + ] + ) + ) + end + attr_reader :set_metadata + + sig do + params( + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::OrHash + ] + ).void + end + attr_writer :set_metadata + + # Array of custom metadata fields to remove. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata + ] + ) + ) + end + attr_reader :unset_metadata + + sig do + params( + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata::OrHash + ] + ).void + end + attr_writer :unset_metadata + + # Actions to execute if the AI answers no. + sig do + params( + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::OrHash + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata::OrHash + ] + ).returns(T.attached_class) + end + def self.new( + # Array of tag strings to add to the asset. + add_tags: nil, + # Array of tag strings to remove from the asset. + remove_tags: nil, + # Array of custom metadata field updates. + set_metadata: nil, + # Array of custom metadata fields to remove. + unset_metadata: nil + ) + end + + sig do + override.returns( + { + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata + ] + } + ) + end + def to_hash + end + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to set. + sig { returns(String) } + attr_accessor :field + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + sig do + returns( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Variants + ) + end + attr_accessor :value + + sig do + params( + field: String, + value: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Variants + ).returns(T.attached_class) + end + def self.new( + # Name of the custom metadata field to set. + field:, + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + value: + ) + end + + sig do + override.returns( + { + field: String, + value: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Variants + } + ) + end + def to_hash + end + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + module Value + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + union: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::Mixed + ], + Imagekitio::Internal::Type::Converter + ) + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to remove. + sig { returns(String) } + attr_accessor :field + + sig { params(field: String).returns(T.attached_class) } + def self.new( + # Name of the custom metadata field to remove. + field: + ) + end + + sig { override.returns({ field: String }) } + def to_hash + end + end + end + + class OnUnknown < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown, + Imagekitio::Internal::AnyHash + ) + end + + # Array of tag strings to add to the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :add_tags + + sig { params(add_tags: T::Array[String]).void } + attr_writer :add_tags + + # Array of tag strings to remove from the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :remove_tags + + sig { params(remove_tags: T::Array[String]).void } + attr_writer :remove_tags + + # Array of custom metadata field updates. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata + ] + ) + ) + end + attr_reader :set_metadata + + sig do + params( + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::OrHash + ] + ).void + end + attr_writer :set_metadata + + # Array of custom metadata fields to remove. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata + ] + ) + ) + end + attr_reader :unset_metadata + + sig do + params( + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata::OrHash + ] + ).void + end + attr_writer :unset_metadata + + # Actions to execute if the AI cannot determine the answer. + sig do + params( + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::OrHash + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata::OrHash + ] + ).returns(T.attached_class) + end + def self.new( + # Array of tag strings to add to the asset. + add_tags: nil, + # Array of tag strings to remove from the asset. + remove_tags: nil, + # Array of custom metadata field updates. + set_metadata: nil, + # Array of custom metadata fields to remove. + unset_metadata: nil + ) + end + + sig do + override.returns( + { + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata + ] + } + ) + end + def to_hash + end + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to set. + sig { returns(String) } + attr_accessor :field + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + sig do + returns( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Variants + ) + end + attr_accessor :value + + sig do + params( + field: String, + value: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Variants + ).returns(T.attached_class) + end + def self.new( + # Name of the custom metadata field to set. + field:, + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + value: + ) + end + + sig do + override.returns( + { + field: String, + value: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Variants + } + ) + end + def to_hash + end + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + module Value + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + union: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::Mixed + ], + Imagekitio::Internal::Type::Converter + ) + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to remove. + sig { returns(String) } + attr_accessor :field + + sig { params(field: String).returns(T.attached_class) } + def self.new( + # Name of the custom metadata field to remove. + field: + ) + end + + sig { override.returns({ field: String }) } + def to_hash + end + end + end + + class OnYes < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes, + Imagekitio::Internal::AnyHash + ) + end + + # Array of tag strings to add to the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :add_tags + + sig { params(add_tags: T::Array[String]).void } + attr_writer :add_tags + + # Array of tag strings to remove from the asset. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :remove_tags + + sig { params(remove_tags: T::Array[String]).void } + attr_writer :remove_tags + + # Array of custom metadata field updates. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata + ] + ) + ) + end + attr_reader :set_metadata + + sig do + params( + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::OrHash + ] + ).void + end + attr_writer :set_metadata + + # Array of custom metadata fields to remove. + sig do + returns( + T.nilable( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata + ] + ) + ) + end + attr_reader :unset_metadata + + sig do + params( + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata::OrHash + ] + ).void + end + attr_writer :unset_metadata + + # Actions to execute if the AI answers yes. + sig do + params( + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::OrHash + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata::OrHash + ] + ).returns(T.attached_class) + end + def self.new( + # Array of tag strings to add to the asset. + add_tags: nil, + # Array of tag strings to remove from the asset. + remove_tags: nil, + # Array of custom metadata field updates. + set_metadata: nil, + # Array of custom metadata fields to remove. + unset_metadata: nil + ) + end + + sig do + override.returns( + { + add_tags: T::Array[String], + remove_tags: T::Array[String], + set_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata + ], + unset_metadata: + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata + ] + } + ) + end + def to_hash + end + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to set. + sig { returns(String) } + attr_accessor :field + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + sig do + returns( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Variants + ) + end + attr_accessor :value + + sig do + params( + field: String, + value: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Variants + ).returns(T.attached_class) + end + def self.new( + # Name of the custom metadata field to set. + field:, + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + value: + ) + end + + sig do + override.returns( + { + field: String, + value: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Variants + } + ) + end + def to_hash + end + + # Value to set for the custom metadata field. The value type should match the + # custom metadata field type. + module Value + extend Imagekitio::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + Float, + T::Boolean, + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Mixed::Variants + ] + ) + end + + module Mixed + extend Imagekitio::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Float, T::Boolean) } + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Mixed::Variants + ] + ) + end + def self.variants + end + end + + sig do + override.returns( + T::Array[ + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Variants + ] + ) + end + def self.variants + end + + MixedArray = + T.let( + Imagekitio::Internal::Type::ArrayOf[ + union: + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::Mixed + ], + Imagekitio::Internal::Type::Converter + ) + end + end + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata, + Imagekitio::Internal::AnyHash + ) + end + + # Name of the custom metadata field to remove. + sig { returns(String) } + attr_accessor :field + + sig { params(field: String).returns(T.attached_class) } + def self.new( + # Name of the custom metadata field to remove. + field: + ) + end + + sig { override.returns({ field: String }) } + def to_hash + end + end + end + end + + sig do + override.returns( + T::Array[Imagekitio::ExtensionItem::AITasks::Task::Variants] + ) + end + def self.variants + end + end + end + + class SavedExtension < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Imagekitio::ExtensionItem::SavedExtension, + Imagekitio::Internal::AnyHash + ) + end + + # The unique ID of the saved extension to apply. + sig { returns(String) } + attr_accessor :id + + # Indicates this is a reference to a saved extension. + sig { returns(Symbol) } + attr_accessor :name + + sig { params(id: String, name: Symbol).returns(T.attached_class) } + def self.new( + # The unique ID of the saved extension to apply. + id:, + # Indicates this is a reference to a saved extension. + name: :"saved-extension" + ) + end + + sig { override.returns({ id: String, name: Symbol }) } + def to_hash + end + end + sig { override.returns(T::Array[Imagekitio::ExtensionItem::Variants]) } def self.variants end diff --git a/rbi/imagekitio/models/file_upload_params.rbi b/rbi/imagekitio/models/file_upload_params.rbi index 064e4c37..7e6ae63f 100644 --- a/rbi/imagekitio/models/file_upload_params.rbi +++ b/rbi/imagekitio/models/file_upload_params.rbi @@ -103,6 +103,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg, Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AITasks, + Imagekitio::ExtensionItem::SavedExtension, Imagekitio::ExtensionItem::AutoTaggingExtension ) ] @@ -118,6 +120,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg::OrHash, Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AITasks::OrHash, + Imagekitio::ExtensionItem::SavedExtension::OrHash, Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ] @@ -303,6 +307,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg::OrHash, Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AITasks::OrHash, + Imagekitio::ExtensionItem::SavedExtension::OrHash, Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], @@ -475,6 +481,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg, Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AITasks, + Imagekitio::ExtensionItem::SavedExtension, Imagekitio::ExtensionItem::AutoTaggingExtension ) ], diff --git a/rbi/imagekitio/models/image_overlay.rbi b/rbi/imagekitio/models/image_overlay.rbi index fda4e3fe..6b11207c 100644 --- a/rbi/imagekitio/models/image_overlay.rbi +++ b/rbi/imagekitio/models/image_overlay.rbi @@ -20,6 +20,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. sig { returns(T.nilable(Imagekitio::ImageOverlay::Encoding::OrSymbol)) } attr_reader :encoding @@ -55,6 +61,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. encoding: nil, # Array of transformations to be applied to the overlay image. Supported # transformations depends on the base/parent asset. See overlays on @@ -84,6 +96,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. module Encoding extend Imagekitio::Internal::Type::Enum diff --git a/rbi/imagekitio/models/saved_extension.rbi b/rbi/imagekitio/models/saved_extension.rbi new file mode 100644 index 00000000..11854815 --- /dev/null +++ b/rbi/imagekitio/models/saved_extension.rbi @@ -0,0 +1,114 @@ +# typed: strong + +module Imagekitio + module Models + class SavedExtension < Imagekitio::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Imagekitio::SavedExtension, Imagekitio::Internal::AnyHash) + end + + # Unique identifier of the saved extension. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # Configuration object for an extension (base extensions only, not saved extension + # references). + sig { returns(T.nilable(Imagekitio::ExtensionConfig::Variants)) } + attr_reader :config + + sig do + params( + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg::OrHash, + Imagekitio::ExtensionConfig::AIAutoDescription::OrHash, + Imagekitio::ExtensionConfig::AITasks::OrHash, + Imagekitio::ExtensionConfig::AutoTaggingExtension::OrHash + ) + ).void + end + attr_writer :config + + # Timestamp when the saved extension was created. + sig { returns(T.nilable(Time)) } + attr_reader :created_at + + sig { params(created_at: Time).void } + attr_writer :created_at + + # Description of the saved extension. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Name of the saved extension. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + # Timestamp when the saved extension was last updated. + sig { returns(T.nilable(Time)) } + attr_reader :updated_at + + sig { params(updated_at: Time).void } + attr_writer :updated_at + + # Saved extension object containing extension configuration. + sig do + params( + id: String, + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg::OrHash, + Imagekitio::ExtensionConfig::AIAutoDescription::OrHash, + Imagekitio::ExtensionConfig::AITasks::OrHash, + Imagekitio::ExtensionConfig::AutoTaggingExtension::OrHash + ), + created_at: Time, + description: String, + name: String, + updated_at: Time + ).returns(T.attached_class) + end + def self.new( + # Unique identifier of the saved extension. + id: nil, + # Configuration object for an extension (base extensions only, not saved extension + # references). + config: nil, + # Timestamp when the saved extension was created. + created_at: nil, + # Description of the saved extension. + description: nil, + # Name of the saved extension. + name: nil, + # Timestamp when the saved extension was last updated. + updated_at: nil + ) + end + + sig do + override.returns( + { + id: String, + config: Imagekitio::ExtensionConfig::Variants, + created_at: Time, + description: String, + name: String, + updated_at: Time + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/saved_extension_create_params.rbi b/rbi/imagekitio/models/saved_extension_create_params.rbi new file mode 100644 index 00000000..240dca64 --- /dev/null +++ b/rbi/imagekitio/models/saved_extension_create_params.rbi @@ -0,0 +1,85 @@ +# typed: strong + +module Imagekitio + module Models + class SavedExtensionCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::SavedExtensionCreateParams, + Imagekitio::Internal::AnyHash + ) + end + + # Configuration object for an extension (base extensions only, not saved extension + # references). + sig do + returns( + T.any( + Imagekitio::ExtensionConfig::RemoveBg, + Imagekitio::ExtensionConfig::AIAutoDescription, + Imagekitio::ExtensionConfig::AITasks, + Imagekitio::ExtensionConfig::AutoTaggingExtension + ) + ) + end + attr_accessor :config + + # Description of what the saved extension does. + sig { returns(String) } + attr_accessor :description + + # Name of the saved extension. + sig { returns(String) } + attr_accessor :name + + sig do + params( + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg::OrHash, + Imagekitio::ExtensionConfig::AIAutoDescription::OrHash, + Imagekitio::ExtensionConfig::AITasks::OrHash, + Imagekitio::ExtensionConfig::AutoTaggingExtension::OrHash + ), + description: String, + name: String, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Configuration object for an extension (base extensions only, not saved extension + # references). + config:, + # Description of what the saved extension does. + description:, + # Name of the saved extension. + name:, + request_options: {} + ) + end + + sig do + override.returns( + { + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg, + Imagekitio::ExtensionConfig::AIAutoDescription, + Imagekitio::ExtensionConfig::AITasks, + Imagekitio::ExtensionConfig::AutoTaggingExtension + ), + description: String, + name: String, + request_options: Imagekitio::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/saved_extension_delete_params.rbi b/rbi/imagekitio/models/saved_extension_delete_params.rbi new file mode 100644 index 00000000..b56c4d2a --- /dev/null +++ b/rbi/imagekitio/models/saved_extension_delete_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Imagekitio + module Models + class SavedExtensionDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::SavedExtensionDeleteParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekitio::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/saved_extension_get_params.rbi b/rbi/imagekitio/models/saved_extension_get_params.rbi new file mode 100644 index 00000000..9f769471 --- /dev/null +++ b/rbi/imagekitio/models/saved_extension_get_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Imagekitio + module Models + class SavedExtensionGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::SavedExtensionGetParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekitio::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/saved_extension_list_params.rbi b/rbi/imagekitio/models/saved_extension_list_params.rbi new file mode 100644 index 00000000..f113d933 --- /dev/null +++ b/rbi/imagekitio/models/saved_extension_list_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Imagekitio + module Models + class SavedExtensionListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::SavedExtensionListParams, + Imagekitio::Internal::AnyHash + ) + end + + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Imagekitio::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/saved_extension_list_response.rbi b/rbi/imagekitio/models/saved_extension_list_response.rbi new file mode 100644 index 00000000..2da98fdc --- /dev/null +++ b/rbi/imagekitio/models/saved_extension_list_response.rbi @@ -0,0 +1,11 @@ +# typed: strong + +module Imagekitio + module Models + SavedExtensionListResponse = + T.let( + Imagekitio::Internal::Type::ArrayOf[Imagekitio::SavedExtension], + Imagekitio::Internal::Type::Converter + ) + end +end diff --git a/rbi/imagekitio/models/saved_extension_update_params.rbi b/rbi/imagekitio/models/saved_extension_update_params.rbi new file mode 100644 index 00000000..fe837974 --- /dev/null +++ b/rbi/imagekitio/models/saved_extension_update_params.rbi @@ -0,0 +1,106 @@ +# typed: strong + +module Imagekitio + module Models + class SavedExtensionUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Imagekitio::SavedExtensionUpdateParams, + Imagekitio::Internal::AnyHash + ) + end + + # Configuration object for an extension (base extensions only, not saved extension + # references). + sig do + returns( + T.nilable( + T.any( + Imagekitio::ExtensionConfig::RemoveBg, + Imagekitio::ExtensionConfig::AIAutoDescription, + Imagekitio::ExtensionConfig::AITasks, + Imagekitio::ExtensionConfig::AutoTaggingExtension + ) + ) + ) + end + attr_reader :config + + sig do + params( + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg::OrHash, + Imagekitio::ExtensionConfig::AIAutoDescription::OrHash, + Imagekitio::ExtensionConfig::AITasks::OrHash, + Imagekitio::ExtensionConfig::AutoTaggingExtension::OrHash + ) + ).void + end + attr_writer :config + + # Updated description of the saved extension. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Updated name of the saved extension. + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + sig do + params( + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg::OrHash, + Imagekitio::ExtensionConfig::AIAutoDescription::OrHash, + Imagekitio::ExtensionConfig::AITasks::OrHash, + Imagekitio::ExtensionConfig::AutoTaggingExtension::OrHash + ), + description: String, + name: String, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Configuration object for an extension (base extensions only, not saved extension + # references). + config: nil, + # Updated description of the saved extension. + description: nil, + # Updated name of the saved extension. + name: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg, + Imagekitio::ExtensionConfig::AIAutoDescription, + Imagekitio::ExtensionConfig::AITasks, + Imagekitio::ExtensionConfig::AutoTaggingExtension + ), + description: String, + name: String, + request_options: Imagekitio::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/imagekitio/models/solid_color_overlay_transformation.rbi b/rbi/imagekitio/models/solid_color_overlay_transformation.rbi index 7c62ded4..6db4577a 100644 --- a/rbi/imagekitio/models/solid_color_overlay_transformation.rbi +++ b/rbi/imagekitio/models/solid_color_overlay_transformation.rbi @@ -11,8 +11,8 @@ module Imagekitio ) end - # Specifies the transparency level of the solid color overlay. Accepts integers - # from `1` to `9`. + # Specifies the transparency level of the overlaid solid color layer. Supports + # integers from `1` to `9`. sig { returns(T.nilable(Float)) } attr_reader :alpha @@ -56,13 +56,18 @@ module Imagekitio end attr_writer :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). - sig { returns(T.nilable(T.any(Float, Symbol))) } + # Specifies the corner radius of the solid color overlay. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + sig { returns(T.nilable(T.any(Float, Symbol, String))) } attr_reader :radius - sig { params(radius: T.any(Float, Symbol)).void } + sig { params(radius: T.any(Float, Symbol, String)).void } attr_writer :radius # Controls the width of the solid color overlay. Accepts a numeric value or an @@ -90,13 +95,13 @@ module Imagekitio background: String, gradient: T.any(T::Boolean, String), height: Imagekitio::SolidColorOverlayTransformation::Height::Variants, - radius: T.any(Float, Symbol), + radius: T.any(Float, Symbol, String), width: Imagekitio::SolidColorOverlayTransformation::Width::Variants ).returns(T.attached_class) end def self.new( - # Specifies the transparency level of the solid color overlay. Accepts integers - # from `1` to `9`. + # Specifies the transparency level of the overlaid solid color layer. Supports + # integers from `1` to `9`. alpha: nil, # 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. @@ -110,9 +115,14 @@ module Imagekitio # arithmetic expression. Learn about # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). height: nil, - # 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). + # Specifies the corner radius of the solid color overlay. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). radius: nil, # 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 @@ -129,7 +139,7 @@ module Imagekitio gradient: T.any(T::Boolean, String), height: Imagekitio::SolidColorOverlayTransformation::Height::Variants, - radius: T.any(Float, Symbol), + radius: T.any(Float, Symbol, String), width: Imagekitio::SolidColorOverlayTransformation::Width::Variants } ) @@ -176,13 +186,18 @@ module Imagekitio end end - # 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). + # Specifies the corner radius of the solid color overlay. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). module Radius extend Imagekitio::Internal::Type::Union - Variants = T.type_alias { T.any(Float, Symbol) } + Variants = T.type_alias { T.any(Float, Symbol, String) } sig do override.returns( diff --git a/rbi/imagekitio/models/subtitle_overlay.rbi b/rbi/imagekitio/models/subtitle_overlay.rbi index dd1cb00a..fb15246e 100644 --- a/rbi/imagekitio/models/subtitle_overlay.rbi +++ b/rbi/imagekitio/models/subtitle_overlay.rbi @@ -20,6 +20,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. sig do returns(T.nilable(Imagekitio::SubtitleOverlay::Encoding::OrSymbol)) end @@ -62,6 +68,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. encoding: nil, # Control styling of the subtitle. See # [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer). @@ -88,6 +100,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. module Encoding extend Imagekitio::Internal::Type::Enum diff --git a/rbi/imagekitio/models/subtitle_overlay_transformation.rbi b/rbi/imagekitio/models/subtitle_overlay_transformation.rbi index 1c089c52..da374e58 100644 --- a/rbi/imagekitio/models/subtitle_overlay_transformation.rbi +++ b/rbi/imagekitio/models/subtitle_overlay_transformation.rbi @@ -31,8 +31,9 @@ module Imagekitio sig { params(color: String).void } attr_writer :color - # Font family for subtitles. Refer to the - # [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list). + # Sets the font family of subtitle text. Refer to the + # [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) + # in the ImageKit transformations guide. sig { returns(T.nilable(String)) } attr_reader :font_family @@ -122,8 +123,9 @@ module Imagekitio # # [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) color: nil, - # Font family for subtitles. Refer to the - # [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list). + # Sets the font family of subtitle text. Refer to the + # [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) + # in the ImageKit transformations guide. font_family: nil, # 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 diff --git a/rbi/imagekitio/models/text_overlay.rbi b/rbi/imagekitio/models/text_overlay.rbi index fe635400..edecb8ed 100644 --- a/rbi/imagekitio/models/text_overlay.rbi +++ b/rbi/imagekitio/models/text_overlay.rbi @@ -21,6 +21,9 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method, the input text is always percent-encoded to + # ensure it is URL-safe. sig { returns(T.nilable(Imagekitio::TextOverlay::Encoding::OrSymbol)) } attr_reader :encoding @@ -60,6 +63,9 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method, the input text is always percent-encoded to + # ensure it is URL-safe. encoding: nil, # Control styling of the text overlay. See # [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay). @@ -86,6 +92,9 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method, the input text is always percent-encoded to + # ensure it is URL-safe. module Encoding extend Imagekitio::Internal::Type::Enum diff --git a/rbi/imagekitio/models/text_overlay_transformation.rbi b/rbi/imagekitio/models/text_overlay_transformation.rbi index bc1f85b5..24fcdb72 100644 --- a/rbi/imagekitio/models/text_overlay_transformation.rbi +++ b/rbi/imagekitio/models/text_overlay_transformation.rbi @@ -27,7 +27,9 @@ module Imagekitio sig { params(background: String).void } attr_writer :background - # Flip the text overlay horizontally, vertically, or both. + # Flip/mirror the text horizontally, vertically, or in both directions. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. sig do returns( T.nilable(Imagekitio::TextOverlayTransformation::Flip::OrSymbol) @@ -94,10 +96,9 @@ module Imagekitio end attr_writer :inner_alignment - # 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`. + # Specifies the line height for multi-line text overlays. It will come into effect + # only if the text wraps over multiple lines. Accepts either an integer value or + # an arithmetic expression. sig do returns( T.nilable(Imagekitio::TextOverlayTransformation::LineHeight::Variants) @@ -130,12 +131,18 @@ module Imagekitio end attr_writer :padding - # Specifies the corner radius of the text overlay. Set to `max` to achieve a - # circular or oval shape. - sig { returns(T.nilable(T.any(Float, Symbol))) } + # Specifies the corner radius: + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + sig { returns(T.nilable(T.any(Float, Symbol, String))) } attr_reader :radius - sig { params(radius: T.any(Float, Symbol)).void } + sig { params(radius: T.any(Float, Symbol, String)).void } attr_writer :radius # Specifies the rotation angle of the text overlay. Accepts a numeric value for @@ -196,7 +203,7 @@ module Imagekitio line_height: Imagekitio::TextOverlayTransformation::LineHeight::Variants, padding: Imagekitio::TextOverlayTransformation::Padding::Variants, - radius: T.any(Float, Symbol), + radius: T.any(Float, Symbol, String), rotation: Imagekitio::TextOverlayTransformation::Rotation::Variants, typography: String, width: Imagekitio::TextOverlayTransformation::Width::Variants @@ -209,7 +216,9 @@ module Imagekitio # Specifies the background color of the text overlay. Accepts an RGB hex code, an # RGBA code, or a color name. background: nil, - # Flip the text overlay horizontally, vertically, or both. + # Flip/mirror the text horizontally, vertically, or in both directions. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. flip: nil, # 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. @@ -226,17 +235,22 @@ module Imagekitio # Specifies the inner alignment of the text when width is more than the text # length. inner_alignment: nil, - # 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`. + # Specifies the line height for multi-line text overlays. It will come into effect + # only if the text wraps over multiple lines. Accepts either an integer value or + # an arithmetic expression. line_height: nil, # 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. padding: nil, - # Specifies the corner radius of the text overlay. Set to `max` to achieve a - # circular or oval shape. + # Specifies the corner radius: + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). radius: nil, # 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. @@ -270,7 +284,7 @@ module Imagekitio line_height: Imagekitio::TextOverlayTransformation::LineHeight::Variants, padding: Imagekitio::TextOverlayTransformation::Padding::Variants, - radius: T.any(Float, Symbol), + radius: T.any(Float, Symbol, String), rotation: Imagekitio::TextOverlayTransformation::Rotation::Variants, typography: String, width: Imagekitio::TextOverlayTransformation::Width::Variants @@ -280,7 +294,9 @@ module Imagekitio def to_hash end - # Flip the text overlay horizontally, vertically, or both. + # Flip/mirror the text horizontally, vertically, or in both directions. Acceptable + # values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or + # `v_h`. module Flip extend Imagekitio::Internal::Type::Enum @@ -360,10 +376,9 @@ module Imagekitio end end - # 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`. + # Specifies the line height for multi-line text overlays. It will come into effect + # only if the text wraps over multiple lines. Accepts either an integer value or + # an arithmetic expression. module LineHeight extend Imagekitio::Internal::Type::Union @@ -397,12 +412,18 @@ module Imagekitio end end - # Specifies the corner radius of the text overlay. Set to `max` to achieve a - # circular or oval shape. + # Specifies the corner radius: + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). module Radius extend Imagekitio::Internal::Type::Union - Variants = T.type_alias { T.any(Float, Symbol) } + Variants = T.type_alias { T.any(Float, Symbol, String) } sig do override.returns( diff --git a/rbi/imagekitio/models/transformation.rbi b/rbi/imagekitio/models/transformation.rbi index 0978362b..607451af 100644 --- a/rbi/imagekitio/models/transformation.rbi +++ b/rbi/imagekitio/models/transformation.rbi @@ -160,6 +160,12 @@ module Imagekitio # # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See # [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). + # - Dominant color: `dominant` extracts the dominant color from the image. See + # [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). + # - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient + # using the dominant colors. Optionally specify palette size (2 or 4), e.g., + # `gradient_dominant_4`. See + # [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-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 @@ -200,6 +206,20 @@ module Imagekitio sig { params(color_profile: T::Boolean).void } attr_writer :color_profile + # Replaces colors in the image. Supports three formats: + # + # - `toColor` - Replace dominant color with the specified color. + # - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). + # - `toColor_tolerance_fromColor` - Replace a specific color with another within + # tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., + # `red`, `blue`). See + # [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr). + sig { returns(T.nilable(String)) } + attr_reader :color_replace + + sig { params(color_replace: String).void } + attr_writer :color_replace + # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). sig do @@ -244,9 +264,25 @@ module Imagekitio sig { params(default_image: String).void } attr_writer :default_image + # Distorts the shape of an image. Supports two modes: + # + # - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of + # the four corners starting clockwise from top-left. + # - Arc distortion: `a-degrees` curves the image upwards (positive values) or + # downwards (negative values). See + # [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort). + sig { returns(T.nilable(String)) } + attr_reader :distort + + sig { params(distort: String).void } + attr_writer :distort + # 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). + # (DPR) calculation. Also accepts arithmetic expressions. + # + # - Learn about + # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + # - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr). sig { returns(T.nilable(Float)) } attr_reader :dpr @@ -431,13 +467,18 @@ module Imagekitio sig { params(quality: Float).void } attr_writer :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). - sig { returns(T.nilable(T.any(Float, Symbol))) } + # Specifies the corner radius for rounded corners. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + sig { returns(T.nilable(T.any(Float, Symbol, String))) } attr_reader :radius - sig { params(radius: T.any(Float, Symbol)).void } + sig { params(radius: T.any(Float, Symbol, String)).void } attr_writer :radius # Pass any transformation not directly supported by the SDK. This transformation @@ -624,11 +665,13 @@ module Imagekitio blur: Float, border: String, color_profile: T::Boolean, + color_replace: String, contrast_stretch: Imagekitio::Transformation::ContrastStretch::OrBoolean, crop: Imagekitio::Transformation::Crop::OrSymbol, crop_mode: Imagekitio::Transformation::CropMode::OrSymbol, default_image: String, + distort: String, dpr: Float, duration: Imagekitio::Transformation::Duration::Variants, end_offset: Imagekitio::Transformation::EndOffset::Variants, @@ -647,7 +690,7 @@ module Imagekitio page: Imagekitio::Transformation::Page::Variants, progressive: T::Boolean, quality: Float, - radius: T.any(Float, Symbol), + radius: T.any(Float, Symbol, String), raw: String, rotation: Imagekitio::Transformation::Rotation::Variants, shadow: T.any(T::Boolean, String), @@ -719,6 +762,12 @@ module Imagekitio # # - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See # [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). + # - Dominant color: `dominant` extracts the dominant color from the image. See + # [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). + # - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient + # using the dominant colors. Optionally specify palette size (2 or 4), e.g., + # `gradient_dominant_4`. See + # [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-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 @@ -739,6 +788,15 @@ module Imagekitio # Indicates whether the output image should retain the original color profile. See # [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp). color_profile: nil, + # Replaces colors in the image. Supports three formats: + # + # - `toColor` - Replace dominant color with the specified color. + # - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). + # - `toColor_tolerance_fromColor` - Replace a specific color with another within + # tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., + # `red`, `blue`). See + # [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr). + color_replace: nil, # Automatically enhances the contrast of an image (contrast stretch). See # [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). contrast_stretch: nil, @@ -752,9 +810,20 @@ module Imagekitio # path. See # [Default image](https://imagekit.io/docs/image-transformation#default-image---di). default_image: nil, + # Distorts the shape of an image. Supports two modes: + # + # - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of + # the four corners starting clockwise from top-left. + # - Arc distortion: `a-degrees` curves the image upwards (positive values) or + # downwards (negative values). See + # [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort). + distort: nil, # 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). + # (DPR) calculation. Also accepts arithmetic expressions. + # + # - Learn about + # [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + # - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr). dpr: nil, # 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. @@ -839,9 +908,14 @@ module Imagekitio # quality, while a lower value produces a smaller file size with reduced quality. # See [Quality](https://imagekit.io/docs/image-optimization#quality---q). quality: nil, - # 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). + # Specifies the corner radius for rounded corners. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). radius: nil, # Pass any transformation not directly supported by the SDK. This transformation # string is appended to the URL as provided. @@ -925,11 +999,13 @@ module Imagekitio blur: Float, border: String, color_profile: T::Boolean, + color_replace: String, contrast_stretch: Imagekitio::Transformation::ContrastStretch::OrBoolean, crop: Imagekitio::Transformation::Crop::OrSymbol, crop_mode: Imagekitio::Transformation::CropMode::OrSymbol, default_image: String, + distort: String, dpr: Float, duration: Imagekitio::Transformation::Duration::Variants, end_offset: Imagekitio::Transformation::EndOffset::Variants, @@ -948,7 +1024,7 @@ module Imagekitio page: Imagekitio::Transformation::Page::Variants, progressive: T::Boolean, quality: Float, - radius: T.any(Float, Symbol), + radius: T.any(Float, Symbol, String), raw: String, rotation: Imagekitio::Transformation::Rotation::Variants, shadow: T.any(T::Boolean, String), @@ -1417,13 +1493,18 @@ module Imagekitio end end - # 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). + # Specifies the corner radius for rounded corners. + # + # - Single value (positive integer): Applied to all corners (e.g., `20`). + # - `max`: Creates a circular or oval shape. + # - Per-corner array: Provide four underscore-separated values representing + # top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., + # `10_20_30_40`). See + # [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). module Radius extend Imagekitio::Internal::Type::Union - Variants = T.type_alias { T.any(Float, Symbol) } + Variants = T.type_alias { T.any(Float, Symbol, String) } sig do override.returns( diff --git a/rbi/imagekitio/models/update_file_request.rbi b/rbi/imagekitio/models/update_file_request.rbi index 3a818c9c..a2ad2061 100644 --- a/rbi/imagekitio/models/update_file_request.rbi +++ b/rbi/imagekitio/models/update_file_request.rbi @@ -53,6 +53,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg, Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AITasks, + Imagekitio::ExtensionItem::SavedExtension, Imagekitio::ExtensionItem::AutoTaggingExtension ) ] @@ -68,6 +70,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg::OrHash, Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AITasks::OrHash, + Imagekitio::ExtensionItem::SavedExtension::OrHash, Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ] @@ -114,6 +118,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg::OrHash, Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AITasks::OrHash, + Imagekitio::ExtensionItem::SavedExtension::OrHash, Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], @@ -166,6 +172,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg, Imagekitio::ExtensionItem::AIAutoDescription, + Imagekitio::ExtensionItem::AITasks, + Imagekitio::ExtensionItem::SavedExtension, Imagekitio::ExtensionItem::AutoTaggingExtension ) ], diff --git a/rbi/imagekitio/models/video_overlay.rbi b/rbi/imagekitio/models/video_overlay.rbi index 14469c27..5b64d5f8 100644 --- a/rbi/imagekitio/models/video_overlay.rbi +++ b/rbi/imagekitio/models/video_overlay.rbi @@ -20,6 +20,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. sig { returns(T.nilable(Imagekitio::VideoOverlay::Encoding::OrSymbol)) } attr_reader :encoding @@ -53,6 +59,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. encoding: nil, # Array of transformation to be applied to the overlay video. Except # `streamingResolutions`, all other video transformations are supported. See @@ -80,6 +92,12 @@ module Imagekitio # 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`. + # + # Regardless of the encoding method: + # + # - Leading and trailing slashes are removed. + # - Remaining slashes within the path are replaced with `@@` when using plain + # text. module Encoding extend Imagekitio::Internal::Type::Enum diff --git a/rbi/imagekitio/resources/beta/v2/files.rbi b/rbi/imagekitio/resources/beta/v2/files.rbi index 3991c1e0..1a8bba3e 100644 --- a/rbi/imagekitio/resources/beta/v2/files.rbi +++ b/rbi/imagekitio/resources/beta/v2/files.rbi @@ -46,6 +46,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg::OrHash, Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AITasks::OrHash, + Imagekitio::ExtensionItem::SavedExtension::OrHash, Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], diff --git a/rbi/imagekitio/resources/files.rbi b/rbi/imagekitio/resources/files.rbi index d44448c3..d8a7ec49 100644 --- a/rbi/imagekitio/resources/files.rbi +++ b/rbi/imagekitio/resources/files.rbi @@ -199,6 +199,8 @@ module Imagekitio T.any( Imagekitio::ExtensionItem::RemoveBg::OrHash, Imagekitio::ExtensionItem::AIAutoDescription::OrHash, + Imagekitio::ExtensionItem::AITasks::OrHash, + Imagekitio::ExtensionItem::SavedExtension::OrHash, Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash ) ], diff --git a/rbi/imagekitio/resources/saved_extensions.rbi b/rbi/imagekitio/resources/saved_extensions.rbi new file mode 100644 index 00000000..0bf359b1 --- /dev/null +++ b/rbi/imagekitio/resources/saved_extensions.rbi @@ -0,0 +1,114 @@ +# typed: strong + +module Imagekitio + module Resources + class SavedExtensions + # This API creates a new saved extension. Saved extensions allow you to save + # complex extension configurations (like AI tasks) and reuse them by referencing + # the ID in upload or update file APIs. + # + # **Saved extension limit** \ + # You can create a maximum of 100 saved extensions per account. + sig do + params( + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg::OrHash, + Imagekitio::ExtensionConfig::AIAutoDescription::OrHash, + Imagekitio::ExtensionConfig::AITasks::OrHash, + Imagekitio::ExtensionConfig::AutoTaggingExtension::OrHash + ), + description: String, + name: String, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::SavedExtension) + end + def create( + # Configuration object for an extension (base extensions only, not saved extension + # references). + config:, + # Description of what the saved extension does. + description:, + # Name of the saved extension. + name:, + request_options: {} + ) + end + + # This API updates an existing saved extension. You can update the name, + # description, or config. + sig do + params( + id: String, + config: + T.any( + Imagekitio::ExtensionConfig::RemoveBg::OrHash, + Imagekitio::ExtensionConfig::AIAutoDescription::OrHash, + Imagekitio::ExtensionConfig::AITasks::OrHash, + Imagekitio::ExtensionConfig::AutoTaggingExtension::OrHash + ), + description: String, + name: String, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::SavedExtension) + end + def update( + # The unique ID of the saved extension. + id, + # Configuration object for an extension (base extensions only, not saved extension + # references). + config: nil, + # Updated description of the saved extension. + description: nil, + # Updated name of the saved extension. + name: nil, + request_options: {} + ) + end + + # This API returns an array of all saved extensions for your account. Saved + # extensions allow you to save complex extension configurations and reuse them by + # referencing them by ID in upload or update file APIs. + sig do + params(request_options: Imagekitio::RequestOptions::OrHash).returns( + T::Array[Imagekitio::SavedExtension] + ) + end + def list(request_options: {}) + end + + # This API deletes a saved extension permanently. + sig do + params( + id: String, + request_options: Imagekitio::RequestOptions::OrHash + ).void + end + def delete( + # The unique ID of the saved extension. + id, + request_options: {} + ) + end + + # This API returns details of a specific saved extension by ID. + sig do + params( + id: String, + request_options: Imagekitio::RequestOptions::OrHash + ).returns(Imagekitio::SavedExtension) + end + def get( + # The unique ID of the saved extension. + id, + request_options: {} + ) + end + + # @api private + sig { params(client: Imagekitio::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/sig/imagekitio/client.rbs b/sig/imagekitio/client.rbs index 71462b82..da497a4a 100644 --- a/sig/imagekitio/client.rbs +++ b/sig/imagekitio/client.rbs @@ -16,6 +16,8 @@ module Imagekitio attr_reader files: Imagekitio::Resources::Files + attr_reader saved_extensions: Imagekitio::Resources::SavedExtensions + attr_reader assets: Imagekitio::Resources::Assets attr_reader cache: Imagekitio::Resources::Cache diff --git a/sig/imagekitio/models.rbs b/sig/imagekitio/models.rbs index 2bb9e2d2..37031be9 100644 --- a/sig/imagekitio/models.rbs +++ b/sig/imagekitio/models.rbs @@ -23,6 +23,8 @@ module Imagekitio type extension_item = Imagekitio::Models::extension_item + module ExtensionConfig = Imagekitio::Models::ExtensionConfig + Extensions: Imagekitio::Internal::Type::Converter class File = Imagekitio::Models::File @@ -71,6 +73,18 @@ module Imagekitio class ResponsiveImageAttributes = Imagekitio::Models::ResponsiveImageAttributes + class SavedExtension = Imagekitio::Models::SavedExtension + + class SavedExtensionCreateParams = Imagekitio::Models::SavedExtensionCreateParams + + class SavedExtensionDeleteParams = Imagekitio::Models::SavedExtensionDeleteParams + + class SavedExtensionGetParams = Imagekitio::Models::SavedExtensionGetParams + + class SavedExtensionListParams = Imagekitio::Models::SavedExtensionListParams + + class SavedExtensionUpdateParams = Imagekitio::Models::SavedExtensionUpdateParams + class SolidColorOverlay = Imagekitio::Models::SolidColorOverlay class SolidColorOverlayTransformation = Imagekitio::Models::SolidColorOverlayTransformation diff --git a/sig/imagekitio/models/base_overlay.rbs b/sig/imagekitio/models/base_overlay.rbs index 04461b00..61467103 100644 --- a/sig/imagekitio/models/base_overlay.rbs +++ b/sig/imagekitio/models/base_overlay.rbs @@ -2,11 +2,18 @@ module Imagekitio module Models type base_overlay = { + layer_mode: Imagekitio::Models::BaseOverlay::layer_mode, position: Imagekitio::OverlayPosition, timing: Imagekitio::OverlayTiming } class BaseOverlay < Imagekitio::Internal::Type::BaseModel + attr_reader layer_mode: Imagekitio::Models::BaseOverlay::layer_mode? + + def layer_mode=: ( + Imagekitio::Models::BaseOverlay::layer_mode + ) -> Imagekitio::Models::BaseOverlay::layer_mode + attr_reader position: Imagekitio::OverlayPosition? def position=: ( @@ -18,14 +25,29 @@ module Imagekitio def timing=: (Imagekitio::OverlayTiming) -> Imagekitio::OverlayTiming def initialize: ( + ?layer_mode: Imagekitio::Models::BaseOverlay::layer_mode, ?position: Imagekitio::OverlayPosition, ?timing: Imagekitio::OverlayTiming ) -> void def to_hash: -> { + layer_mode: Imagekitio::Models::BaseOverlay::layer_mode, position: Imagekitio::OverlayPosition, timing: Imagekitio::OverlayTiming } + + type layer_mode = :multiply | :cutter | :cutout | :displace + + module LayerMode + extend Imagekitio::Internal::Type::Enum + + MULTIPLY: :multiply + CUTTER: :cutter + CUTOUT: :cutout + DISPLACE: :displace + + def self?.values: -> ::Array[Imagekitio::Models::BaseOverlay::layer_mode] + end end end end diff --git a/sig/imagekitio/models/extension_config.rbs b/sig/imagekitio/models/extension_config.rbs new file mode 100644 index 00000000..6d73816f --- /dev/null +++ b/sig/imagekitio/models/extension_config.rbs @@ -0,0 +1,604 @@ +module Imagekitio + module Models + type extension_config = + Imagekitio::ExtensionConfig::RemoveBg + | Imagekitio::ExtensionConfig::AIAutoDescription + | Imagekitio::ExtensionConfig::AITasks + | Imagekitio::ExtensionConfig::AutoTaggingExtension + + module ExtensionConfig + extend Imagekitio::Internal::Type::Union + + type remove_bg = + { + name: :"remove-bg", + options: Imagekitio::ExtensionConfig::RemoveBg::Options + } + + class RemoveBg < Imagekitio::Internal::Type::BaseModel + attr_accessor name: :"remove-bg" + + attr_reader options: Imagekitio::ExtensionConfig::RemoveBg::Options? + + def options=: ( + Imagekitio::ExtensionConfig::RemoveBg::Options + ) -> Imagekitio::ExtensionConfig::RemoveBg::Options + + def initialize: ( + ?options: Imagekitio::ExtensionConfig::RemoveBg::Options, + ?name: :"remove-bg" + ) -> void + + def to_hash: -> { + name: :"remove-bg", + options: Imagekitio::ExtensionConfig::RemoveBg::Options + } + + type options = + { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + + class Options < Imagekitio::Internal::Type::BaseModel + attr_reader add_shadow: bool? + + def add_shadow=: (bool) -> bool + + attr_reader bg_color: String? + + def bg_color=: (String) -> String + + attr_reader bg_image_url: String? + + def bg_image_url=: (String) -> String + + attr_reader semitransparency: bool? + + def semitransparency=: (bool) -> bool + + def initialize: ( + ?add_shadow: bool, + ?bg_color: String, + ?bg_image_url: String, + ?semitransparency: bool + ) -> void + + def to_hash: -> { + add_shadow: bool, + bg_color: String, + bg_image_url: String, + semitransparency: bool + } + end + end + + type auto_tagging_extension = + { + max_tags: Integer, + min_confidence: Integer, + name: Imagekitio::Models::ExtensionConfig::AutoTaggingExtension::name_ + } + + class AutoTaggingExtension < Imagekitio::Internal::Type::BaseModel + attr_accessor max_tags: Integer + + attr_accessor min_confidence: Integer + + attr_accessor name: Imagekitio::Models::ExtensionConfig::AutoTaggingExtension::name_ + + def initialize: ( + max_tags: Integer, + min_confidence: Integer, + name: Imagekitio::Models::ExtensionConfig::AutoTaggingExtension::name_ + ) -> void + + def to_hash: -> { + max_tags: Integer, + min_confidence: Integer, + name: Imagekitio::Models::ExtensionConfig::AutoTaggingExtension::name_ + } + + type name_ = :"google-auto-tagging" | :"aws-auto-tagging" + + module Name + extend Imagekitio::Internal::Type::Enum + + GOOGLE_AUTO_TAGGING: :"google-auto-tagging" + AWS_AUTO_TAGGING: :"aws-auto-tagging" + + def self?.values: -> ::Array[Imagekitio::Models::ExtensionConfig::AutoTaggingExtension::name_] + end + end + + type ai_auto_description = { name: :"ai-auto-description" } + + class AIAutoDescription < Imagekitio::Internal::Type::BaseModel + attr_accessor name: :"ai-auto-description" + + def initialize: (?name: :"ai-auto-description") -> void + + def to_hash: -> { name: :"ai-auto-description" } + end + + type ai_tasks = + { + name: :"ai-tasks", + tasks: ::Array[Imagekitio::Models::ExtensionConfig::AITasks::task] + } + + class AITasks < Imagekitio::Internal::Type::BaseModel + attr_accessor name: :"ai-tasks" + + attr_accessor tasks: ::Array[Imagekitio::Models::ExtensionConfig::AITasks::task] + + def initialize: ( + tasks: ::Array[Imagekitio::Models::ExtensionConfig::AITasks::task], + ?name: :"ai-tasks" + ) -> void + + def to_hash: -> { + name: :"ai-tasks", + tasks: ::Array[Imagekitio::Models::ExtensionConfig::AITasks::task] + } + + type task = + Imagekitio::ExtensionConfig::AITasks::Task::SelectTags + | Imagekitio::ExtensionConfig::AITasks::Task::SelectMetadata + | Imagekitio::ExtensionConfig::AITasks::Task::YesNo + + module Task + extend Imagekitio::Internal::Type::Union + + type select_tags = + { + instruction: String, + type: :select_tags, + vocabulary: ::Array[String], + max_selections: Integer, + min_selections: Integer + } + + class SelectTags < Imagekitio::Internal::Type::BaseModel + attr_accessor instruction: String + + attr_accessor type: :select_tags + + attr_accessor vocabulary: ::Array[String] + + attr_reader max_selections: Integer? + + def max_selections=: (Integer) -> Integer + + attr_reader min_selections: Integer? + + def min_selections=: (Integer) -> Integer + + def initialize: ( + instruction: String, + vocabulary: ::Array[String], + ?max_selections: Integer, + ?min_selections: Integer, + ?type: :select_tags + ) -> void + + def to_hash: -> { + instruction: String, + type: :select_tags, + vocabulary: ::Array[String], + max_selections: Integer, + min_selections: Integer + } + end + + type select_metadata = + { + field: String, + instruction: String, + type: :select_metadata, + max_selections: Integer, + min_selections: Integer, + vocabulary: ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata::vocabulary] + } + + class SelectMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + attr_accessor instruction: String + + attr_accessor type: :select_metadata + + attr_reader max_selections: Integer? + + def max_selections=: (Integer) -> Integer + + attr_reader min_selections: Integer? + + def min_selections=: (Integer) -> Integer + + attr_reader vocabulary: ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata::vocabulary]? + + def vocabulary=: ( + ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata::vocabulary] + ) -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata::vocabulary] + + def initialize: ( + field: String, + instruction: String, + ?max_selections: Integer, + ?min_selections: Integer, + ?vocabulary: ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata::vocabulary], + ?type: :select_metadata + ) -> void + + def to_hash: -> { + field: String, + instruction: String, + type: :select_metadata, + max_selections: Integer, + min_selections: Integer, + vocabulary: ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata::vocabulary] + } + + type vocabulary = String | Float | bool + + module Vocabulary + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectMetadata::vocabulary] + end + end + + type yes_no = + { + instruction: String, + type: :yes_no, + on_no: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo, + on_unknown: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown, + on_yes: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes + } + + class YesNo < Imagekitio::Internal::Type::BaseModel + attr_accessor instruction: String + + attr_accessor type: :yes_no + + attr_reader on_no: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo? + + def on_no=: ( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo + ) -> Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo + + attr_reader on_unknown: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown? + + def on_unknown=: ( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown + ) -> Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown + + attr_reader on_yes: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes? + + def on_yes=: ( + Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes + ) -> Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes + + def initialize: ( + instruction: String, + ?on_no: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo, + ?on_unknown: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown, + ?on_yes: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes, + ?type: :yes_no + ) -> void + + def to_hash: -> { + instruction: String, + type: :yes_no, + on_no: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo, + on_unknown: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown, + on_yes: Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes + } + + type on_no = + { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata] + } + + class OnNo < Imagekitio::Internal::Type::BaseModel + attr_reader add_tags: ::Array[String]? + + def add_tags=: (::Array[String]) -> ::Array[String] + + attr_reader remove_tags: ::Array[String]? + + def remove_tags=: (::Array[String]) -> ::Array[String] + + attr_reader set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata]? + + def set_metadata=: ( + ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata] + ) -> ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata] + + attr_reader unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata]? + + def unset_metadata=: ( + ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata] + ) -> ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata] + + def initialize: ( + ?add_tags: ::Array[String], + ?remove_tags: ::Array[String], + ?set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata], + ?unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata] + ) -> void + + def to_hash: -> { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnNo::UnsetMetadata] + } + + type set_metadata = + { + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::value + } + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + attr_accessor value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::value + + def initialize: ( + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::value + ) -> void + + def to_hash: -> { + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::value + } + + type value = + String + | Float + | bool + | ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::mixed] + + module Value + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::Value::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnNo::SetMetadata::value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + end + + type unset_metadata = { field: String } + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + def initialize: (field: String) -> void + + def to_hash: -> { field: String } + end + end + + type on_unknown = + { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + } + + class OnUnknown < Imagekitio::Internal::Type::BaseModel + attr_reader add_tags: ::Array[String]? + + def add_tags=: (::Array[String]) -> ::Array[String] + + attr_reader remove_tags: ::Array[String]? + + def remove_tags=: (::Array[String]) -> ::Array[String] + + attr_reader set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata]? + + def set_metadata=: ( + ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata] + ) -> ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata] + + attr_reader unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata]? + + def unset_metadata=: ( + ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + ) -> ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + + def initialize: ( + ?add_tags: ::Array[String], + ?remove_tags: ::Array[String], + ?set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata], + ?unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + ) -> void + + def to_hash: -> { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + } + + type set_metadata = + { + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::value + } + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + attr_accessor value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::value + + def initialize: ( + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::value + ) -> void + + def to_hash: -> { + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::value + } + + type value = + String + | Float + | bool + | ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::mixed] + + module Value + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnUnknown::SetMetadata::value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + end + + type unset_metadata = { field: String } + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + def initialize: (field: String) -> void + + def to_hash: -> { field: String } + end + end + + type on_yes = + { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata] + } + + class OnYes < Imagekitio::Internal::Type::BaseModel + attr_reader add_tags: ::Array[String]? + + def add_tags=: (::Array[String]) -> ::Array[String] + + attr_reader remove_tags: ::Array[String]? + + def remove_tags=: (::Array[String]) -> ::Array[String] + + attr_reader set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata]? + + def set_metadata=: ( + ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata] + ) -> ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata] + + attr_reader unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata]? + + def unset_metadata=: ( + ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata] + ) -> ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata] + + def initialize: ( + ?add_tags: ::Array[String], + ?remove_tags: ::Array[String], + ?set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata], + ?unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata] + ) -> void + + def to_hash: -> { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionConfig::AITasks::Task::YesNo::OnYes::UnsetMetadata] + } + + type set_metadata = + { + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::value + } + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + attr_accessor value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::value + + def initialize: ( + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::value + ) -> void + + def to_hash: -> { + field: String, + value: Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::value + } + + type value = + String + | Float + | bool + | ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::mixed] + + module Value + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::Value::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::Task::YesNo::OnYes::SetMetadata::value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + end + + type unset_metadata = { field: String } + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + def initialize: (field: String) -> void + + def to_hash: -> { field: String } + end + end + end + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionConfig::AITasks::task] + end + end + + def self?.variants: -> ::Array[Imagekitio::Models::extension_config] + end + end +end diff --git a/sig/imagekitio/models/extensions.rbs b/sig/imagekitio/models/extensions.rbs index 7e7e2612..3356ff85 100644 --- a/sig/imagekitio/models/extensions.rbs +++ b/sig/imagekitio/models/extensions.rbs @@ -3,6 +3,8 @@ module Imagekitio type extension_item = Imagekitio::ExtensionItem::RemoveBg | Imagekitio::ExtensionItem::AIAutoDescription + | Imagekitio::ExtensionItem::AITasks + | Imagekitio::ExtensionItem::SavedExtension | Imagekitio::ExtensionItem::AutoTaggingExtension module ExtensionItem @@ -122,6 +124,493 @@ module Imagekitio def to_hash: -> { name: :"ai-auto-description" } end + type ai_tasks = + { + name: :"ai-tasks", + tasks: ::Array[Imagekitio::Models::ExtensionItem::AITasks::task] + } + + class AITasks < Imagekitio::Internal::Type::BaseModel + attr_accessor name: :"ai-tasks" + + attr_accessor tasks: ::Array[Imagekitio::Models::ExtensionItem::AITasks::task] + + def initialize: ( + tasks: ::Array[Imagekitio::Models::ExtensionItem::AITasks::task], + ?name: :"ai-tasks" + ) -> void + + def to_hash: -> { + name: :"ai-tasks", + tasks: ::Array[Imagekitio::Models::ExtensionItem::AITasks::task] + } + + type task = + Imagekitio::ExtensionItem::AITasks::Task::SelectTags + | Imagekitio::ExtensionItem::AITasks::Task::SelectMetadata + | Imagekitio::ExtensionItem::AITasks::Task::YesNo + + module Task + extend Imagekitio::Internal::Type::Union + + type select_tags = + { + instruction: String, + type: :select_tags, + vocabulary: ::Array[String], + max_selections: Integer, + min_selections: Integer + } + + class SelectTags < Imagekitio::Internal::Type::BaseModel + attr_accessor instruction: String + + attr_accessor type: :select_tags + + attr_accessor vocabulary: ::Array[String] + + attr_reader max_selections: Integer? + + def max_selections=: (Integer) -> Integer + + attr_reader min_selections: Integer? + + def min_selections=: (Integer) -> Integer + + def initialize: ( + instruction: String, + vocabulary: ::Array[String], + ?max_selections: Integer, + ?min_selections: Integer, + ?type: :select_tags + ) -> void + + def to_hash: -> { + instruction: String, + type: :select_tags, + vocabulary: ::Array[String], + max_selections: Integer, + min_selections: Integer + } + end + + type select_metadata = + { + field: String, + instruction: String, + type: :select_metadata, + max_selections: Integer, + min_selections: Integer, + vocabulary: ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata::vocabulary] + } + + class SelectMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + attr_accessor instruction: String + + attr_accessor type: :select_metadata + + attr_reader max_selections: Integer? + + def max_selections=: (Integer) -> Integer + + attr_reader min_selections: Integer? + + def min_selections=: (Integer) -> Integer + + attr_reader vocabulary: ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata::vocabulary]? + + def vocabulary=: ( + ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata::vocabulary] + ) -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata::vocabulary] + + def initialize: ( + field: String, + instruction: String, + ?max_selections: Integer, + ?min_selections: Integer, + ?vocabulary: ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata::vocabulary], + ?type: :select_metadata + ) -> void + + def to_hash: -> { + field: String, + instruction: String, + type: :select_metadata, + max_selections: Integer, + min_selections: Integer, + vocabulary: ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata::vocabulary] + } + + type vocabulary = String | Float | bool + + module Vocabulary + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::SelectMetadata::vocabulary] + end + end + + type yes_no = + { + instruction: String, + type: :yes_no, + on_no: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo, + on_unknown: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown, + on_yes: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes + } + + class YesNo < Imagekitio::Internal::Type::BaseModel + attr_accessor instruction: String + + attr_accessor type: :yes_no + + attr_reader on_no: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo? + + def on_no=: ( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo + ) -> Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo + + attr_reader on_unknown: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown? + + def on_unknown=: ( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown + ) -> Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown + + attr_reader on_yes: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes? + + def on_yes=: ( + Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes + ) -> Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes + + def initialize: ( + instruction: String, + ?on_no: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo, + ?on_unknown: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown, + ?on_yes: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes, + ?type: :yes_no + ) -> void + + def to_hash: -> { + instruction: String, + type: :yes_no, + on_no: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo, + on_unknown: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown, + on_yes: Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes + } + + type on_no = + { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata] + } + + class OnNo < Imagekitio::Internal::Type::BaseModel + attr_reader add_tags: ::Array[String]? + + def add_tags=: (::Array[String]) -> ::Array[String] + + attr_reader remove_tags: ::Array[String]? + + def remove_tags=: (::Array[String]) -> ::Array[String] + + attr_reader set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata]? + + def set_metadata=: ( + ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata] + ) -> ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata] + + attr_reader unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata]? + + def unset_metadata=: ( + ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata] + ) -> ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata] + + def initialize: ( + ?add_tags: ::Array[String], + ?remove_tags: ::Array[String], + ?set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata], + ?unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata] + ) -> void + + def to_hash: -> { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnNo::UnsetMetadata] + } + + type set_metadata = + { + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::value + } + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + attr_accessor value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::value + + def initialize: ( + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::value + ) -> void + + def to_hash: -> { + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::value + } + + type value = + String + | Float + | bool + | ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::mixed] + + module Value + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::Value::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnNo::SetMetadata::value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + end + + type unset_metadata = { field: String } + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + def initialize: (field: String) -> void + + def to_hash: -> { field: String } + end + end + + type on_unknown = + { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + } + + class OnUnknown < Imagekitio::Internal::Type::BaseModel + attr_reader add_tags: ::Array[String]? + + def add_tags=: (::Array[String]) -> ::Array[String] + + attr_reader remove_tags: ::Array[String]? + + def remove_tags=: (::Array[String]) -> ::Array[String] + + attr_reader set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata]? + + def set_metadata=: ( + ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata] + ) -> ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata] + + attr_reader unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata]? + + def unset_metadata=: ( + ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + ) -> ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + + def initialize: ( + ?add_tags: ::Array[String], + ?remove_tags: ::Array[String], + ?set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata], + ?unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + ) -> void + + def to_hash: -> { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnUnknown::UnsetMetadata] + } + + type set_metadata = + { + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::value + } + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + attr_accessor value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::value + + def initialize: ( + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::value + ) -> void + + def to_hash: -> { + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::value + } + + type value = + String + | Float + | bool + | ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::mixed] + + module Value + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::Value::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnUnknown::SetMetadata::value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + end + + type unset_metadata = { field: String } + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + def initialize: (field: String) -> void + + def to_hash: -> { field: String } + end + end + + type on_yes = + { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata] + } + + class OnYes < Imagekitio::Internal::Type::BaseModel + attr_reader add_tags: ::Array[String]? + + def add_tags=: (::Array[String]) -> ::Array[String] + + attr_reader remove_tags: ::Array[String]? + + def remove_tags=: (::Array[String]) -> ::Array[String] + + attr_reader set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata]? + + def set_metadata=: ( + ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata] + ) -> ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata] + + attr_reader unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata]? + + def unset_metadata=: ( + ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata] + ) -> ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata] + + def initialize: ( + ?add_tags: ::Array[String], + ?remove_tags: ::Array[String], + ?set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata], + ?unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata] + ) -> void + + def to_hash: -> { + add_tags: ::Array[String], + remove_tags: ::Array[String], + set_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata], + unset_metadata: ::Array[Imagekitio::ExtensionItem::AITasks::Task::YesNo::OnYes::UnsetMetadata] + } + + type set_metadata = + { + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::value + } + + class SetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + attr_accessor value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::value + + def initialize: ( + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::value + ) -> void + + def to_hash: -> { + field: String, + value: Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::value + } + + type value = + String + | Float + | bool + | ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::mixed] + + module Value + extend Imagekitio::Internal::Type::Union + + type mixed = String | Float | bool + + module Mixed + extend Imagekitio::Internal::Type::Union + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::Value::mixed] + end + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::Task::YesNo::OnYes::SetMetadata::value] + + MixedArray: Imagekitio::Internal::Type::Converter + end + end + + type unset_metadata = { field: String } + + class UnsetMetadata < Imagekitio::Internal::Type::BaseModel + attr_accessor field: String + + def initialize: (field: String) -> void + + def to_hash: -> { field: String } + end + end + end + + def self?.variants: -> ::Array[Imagekitio::Models::ExtensionItem::AITasks::task] + end + end + + type saved_extension = { id: String, name: :"saved-extension" } + + class SavedExtension < Imagekitio::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor name: :"saved-extension" + + def initialize: (id: String, ?name: :"saved-extension") -> void + + def to_hash: -> { id: String, name: :"saved-extension" } + end + def self?.variants: -> ::Array[Imagekitio::Models::extension_item] end diff --git a/sig/imagekitio/models/saved_extension.rbs b/sig/imagekitio/models/saved_extension.rbs new file mode 100644 index 00000000..ad3736bb --- /dev/null +++ b/sig/imagekitio/models/saved_extension.rbs @@ -0,0 +1,59 @@ +module Imagekitio + module Models + type saved_extension = + { + id: String, + config: Imagekitio::Models::extension_config, + created_at: Time, + description: String, + name: String, + updated_at: Time + } + + class SavedExtension < Imagekitio::Internal::Type::BaseModel + attr_reader id: String? + + def id=: (String) -> String + + attr_reader config: Imagekitio::Models::extension_config? + + def config=: ( + Imagekitio::Models::extension_config + ) -> Imagekitio::Models::extension_config + + attr_reader created_at: Time? + + def created_at=: (Time) -> Time + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader updated_at: Time? + + def updated_at=: (Time) -> Time + + def initialize: ( + ?id: String, + ?config: Imagekitio::Models::extension_config, + ?created_at: Time, + ?description: String, + ?name: String, + ?updated_at: Time + ) -> void + + def to_hash: -> { + id: String, + config: Imagekitio::Models::extension_config, + created_at: Time, + description: String, + name: String, + updated_at: Time + } + end + end +end diff --git a/sig/imagekitio/models/saved_extension_create_params.rbs b/sig/imagekitio/models/saved_extension_create_params.rbs new file mode 100644 index 00000000..6f2590a4 --- /dev/null +++ b/sig/imagekitio/models/saved_extension_create_params.rbs @@ -0,0 +1,36 @@ +module Imagekitio + module Models + type saved_extension_create_params = + { + config: Imagekitio::Models::extension_config, + description: String, + name: String + } + & Imagekitio::Internal::Type::request_parameters + + class SavedExtensionCreateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_accessor config: Imagekitio::Models::extension_config + + attr_accessor description: String + + attr_accessor name: String + + def initialize: ( + config: Imagekitio::Models::extension_config, + description: String, + name: String, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + config: Imagekitio::Models::extension_config, + description: String, + name: String, + request_options: Imagekitio::RequestOptions + } + end + end +end diff --git a/sig/imagekitio/models/saved_extension_delete_params.rbs b/sig/imagekitio/models/saved_extension_delete_params.rbs new file mode 100644 index 00000000..2c88e227 --- /dev/null +++ b/sig/imagekitio/models/saved_extension_delete_params.rbs @@ -0,0 +1,15 @@ +module Imagekitio + module Models + type saved_extension_delete_params = + { } & Imagekitio::Internal::Type::request_parameters + + class SavedExtensionDeleteParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end +end diff --git a/sig/imagekitio/models/saved_extension_get_params.rbs b/sig/imagekitio/models/saved_extension_get_params.rbs new file mode 100644 index 00000000..7a6be9b0 --- /dev/null +++ b/sig/imagekitio/models/saved_extension_get_params.rbs @@ -0,0 +1,15 @@ +module Imagekitio + module Models + type saved_extension_get_params = + { } & Imagekitio::Internal::Type::request_parameters + + class SavedExtensionGetParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end +end diff --git a/sig/imagekitio/models/saved_extension_list_params.rbs b/sig/imagekitio/models/saved_extension_list_params.rbs new file mode 100644 index 00000000..beb26b62 --- /dev/null +++ b/sig/imagekitio/models/saved_extension_list_params.rbs @@ -0,0 +1,15 @@ +module Imagekitio + module Models + type saved_extension_list_params = + { } & Imagekitio::Internal::Type::request_parameters + + class SavedExtensionListParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + def initialize: (?request_options: Imagekitio::request_opts) -> void + + def to_hash: -> { request_options: Imagekitio::RequestOptions } + end + end +end diff --git a/sig/imagekitio/models/saved_extension_list_response.rbs b/sig/imagekitio/models/saved_extension_list_response.rbs new file mode 100644 index 00000000..88fd74c7 --- /dev/null +++ b/sig/imagekitio/models/saved_extension_list_response.rbs @@ -0,0 +1,7 @@ +module Imagekitio + module Models + type saved_extension_list_response = ::Array[Imagekitio::SavedExtension] + + SavedExtensionListResponse: Imagekitio::Internal::Type::Converter + end +end diff --git a/sig/imagekitio/models/saved_extension_update_params.rbs b/sig/imagekitio/models/saved_extension_update_params.rbs new file mode 100644 index 00000000..33dfa082 --- /dev/null +++ b/sig/imagekitio/models/saved_extension_update_params.rbs @@ -0,0 +1,44 @@ +module Imagekitio + module Models + type saved_extension_update_params = + { + config: Imagekitio::Models::extension_config, + description: String, + name: String + } + & Imagekitio::Internal::Type::request_parameters + + class SavedExtensionUpdateParams < Imagekitio::Internal::Type::BaseModel + extend Imagekitio::Internal::Type::RequestParameters::Converter + include Imagekitio::Internal::Type::RequestParameters + + attr_reader config: Imagekitio::Models::extension_config? + + def config=: ( + Imagekitio::Models::extension_config + ) -> Imagekitio::Models::extension_config + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: ( + ?config: Imagekitio::Models::extension_config, + ?description: String, + ?name: String, + ?request_options: Imagekitio::request_opts + ) -> void + + def to_hash: -> { + config: Imagekitio::Models::extension_config, + description: String, + name: String, + request_options: Imagekitio::RequestOptions + } + end + end +end diff --git a/sig/imagekitio/models/solid_color_overlay_transformation.rbs b/sig/imagekitio/models/solid_color_overlay_transformation.rbs index a2877675..ffce656f 100644 --- a/sig/imagekitio/models/solid_color_overlay_transformation.rbs +++ b/sig/imagekitio/models/solid_color_overlay_transformation.rbs @@ -77,7 +77,7 @@ module Imagekitio def self?.variants: -> ::Array[Imagekitio::Models::SolidColorOverlayTransformation::height] end - type radius = Float | :max + type radius = Float | :max | String module Radius extend Imagekitio::Internal::Type::Union diff --git a/sig/imagekitio/models/text_overlay_transformation.rbs b/sig/imagekitio/models/text_overlay_transformation.rbs index ab827889..12bd97d4 100644 --- a/sig/imagekitio/models/text_overlay_transformation.rbs +++ b/sig/imagekitio/models/text_overlay_transformation.rbs @@ -167,7 +167,7 @@ module Imagekitio def self?.variants: -> ::Array[Imagekitio::Models::TextOverlayTransformation::padding] end - type radius = Float | :max + type radius = Float | :max | String module Radius extend Imagekitio::Internal::Type::Union diff --git a/sig/imagekitio/models/transformation.rbs b/sig/imagekitio/models/transformation.rbs index 8b3f4637..80be0086 100644 --- a/sig/imagekitio/models/transformation.rbs +++ b/sig/imagekitio/models/transformation.rbs @@ -16,10 +16,12 @@ module Imagekitio blur: Float, border: String, color_profile: bool, + color_replace: String, contrast_stretch: Imagekitio::Models::Transformation::contrast_stretch, crop: Imagekitio::Models::Transformation::crop, crop_mode: Imagekitio::Models::Transformation::crop_mode, default_image: String, + distort: String, dpr: Float, duration: Imagekitio::Models::Transformation::duration, end_offset: Imagekitio::Models::Transformation::end_offset, @@ -129,6 +131,10 @@ module Imagekitio def color_profile=: (bool) -> bool + attr_reader color_replace: String? + + def color_replace=: (String) -> String + attr_reader contrast_stretch: Imagekitio::Models::Transformation::contrast_stretch? def contrast_stretch=: ( @@ -151,6 +157,10 @@ module Imagekitio def default_image=: (String) -> String + attr_reader distort: String? + + def distort=: (String) -> String + attr_reader dpr: Float? def dpr=: (Float) -> Float @@ -346,10 +356,12 @@ module Imagekitio ?blur: Float, ?border: String, ?color_profile: bool, + ?color_replace: String, ?contrast_stretch: Imagekitio::Models::Transformation::contrast_stretch, ?crop: Imagekitio::Models::Transformation::crop, ?crop_mode: Imagekitio::Models::Transformation::crop_mode, ?default_image: String, + ?distort: String, ?dpr: Float, ?duration: Imagekitio::Models::Transformation::duration, ?end_offset: Imagekitio::Models::Transformation::end_offset, @@ -401,10 +413,12 @@ module Imagekitio blur: Float, border: String, color_profile: bool, + color_replace: String, contrast_stretch: Imagekitio::Models::Transformation::contrast_stretch, crop: Imagekitio::Models::Transformation::crop, crop_mode: Imagekitio::Models::Transformation::crop_mode, default_image: String, + distort: String, dpr: Float, duration: Imagekitio::Models::Transformation::duration, end_offset: Imagekitio::Models::Transformation::end_offset, @@ -650,7 +664,7 @@ module Imagekitio def self?.variants: -> ::Array[Imagekitio::Models::Transformation::page] end - type radius = Float | :max + type radius = Float | :max | String module Radius extend Imagekitio::Internal::Type::Union diff --git a/sig/imagekitio/resources/saved_extensions.rbs b/sig/imagekitio/resources/saved_extensions.rbs new file mode 100644 index 00000000..879fad08 --- /dev/null +++ b/sig/imagekitio/resources/saved_extensions.rbs @@ -0,0 +1,33 @@ +module Imagekitio + module Resources + class SavedExtensions + def create: ( + config: Imagekitio::Models::extension_config, + description: String, + name: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::SavedExtension + + def update: ( + String id, + ?config: Imagekitio::Models::extension_config, + ?description: String, + ?name: String, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::SavedExtension + + def list: ( + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::Models::saved_extension_list_response + + def delete: (String id, ?request_options: Imagekitio::request_opts) -> nil + + def get: ( + String id, + ?request_options: Imagekitio::request_opts + ) -> Imagekitio::SavedExtension + + def initialize: (client: Imagekitio::Client) -> void + end + end +end diff --git a/test/imagekitio/resources/saved_extensions_test.rb b/test/imagekitio/resources/saved_extensions_test.rb new file mode 100644 index 00000000..9ce1a47f --- /dev/null +++ b/test/imagekitio/resources/saved_extensions_test.rb @@ -0,0 +1,93 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Imagekitio::Test::Resources::SavedExtensionsTest < Imagekitio::Test::ResourceTest + def test_create_required_params + skip("Prism tests are disabled") + + response = + @image_kit.saved_extensions.create( + config: {name: :"remove-bg"}, + description: "Analyzes vehicle images for type, condition, and quality assessment", + name: "Car Quality Analysis" + ) + + assert_pattern do + response => Imagekitio::SavedExtension + end + + assert_pattern do + response => { + id: String | nil, + config: Imagekitio::ExtensionConfig | nil, + created_at: Time | nil, + description: String | nil, + name: String | nil, + updated_at: Time | nil + } + end + end + + def test_update + skip("Prism tests are disabled") + + response = @image_kit.saved_extensions.update("id") + + assert_pattern do + response => Imagekitio::SavedExtension + end + + assert_pattern do + response => { + id: String | nil, + config: Imagekitio::ExtensionConfig | nil, + created_at: Time | nil, + description: String | nil, + name: String | nil, + updated_at: Time | nil + } + end + end + + def test_list + skip("Prism tests are disabled") + + response = @image_kit.saved_extensions.list + + assert_pattern do + response => ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::SavedExtension]) + end + end + + def test_delete + skip("Prism tests are disabled") + + response = @image_kit.saved_extensions.delete("id") + + assert_pattern do + response => nil + end + end + + def test_get + skip("Prism tests are disabled") + + response = @image_kit.saved_extensions.get("id") + + assert_pattern do + response => Imagekitio::SavedExtension + end + + assert_pattern do + response => { + id: String | nil, + config: Imagekitio::ExtensionConfig | nil, + created_at: Time | nil, + description: String | nil, + name: String | nil, + updated_at: Time | nil + } + end + end +end From 53ff62e105e8b66214ef0c96fe6d287d3f980bcf Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 15 Jan 2026 10:10:05 +0000 Subject: [PATCH 162/178] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index fdbd8925..f7feecbe 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 47 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-7a3257eb171467b637c8d72877f201c2e6038c71ed447a9453230b7309ce7416.yml -openapi_spec_hash: 87b000a9989ad5c9526f28d91b8a1749 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-606f0e2a6ecb6c36557e166764d39b8f619a74904db6bb5ed8bb348ed451b337.yml +openapi_spec_hash: 1d5f5cdb3f7992a183c368ecd009316e config_hash: aeb6eb949d73382270bbd8bbf2e4cf2a From be34425ef0b58ef4e4b496111b70455129b2ca01 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 15 Jan 2026 11:21:50 +0000 Subject: [PATCH 163/178] fix: add ai-tasks property to response schemas with enum values --- .stats.yml | 4 +- .../models/beta/v2/file_upload_response.rb | 22 ++++++- lib/imagekitio/models/file_update_response.rb | 22 ++++++- lib/imagekitio/models/file_upload_response.rb | 22 ++++++- .../upload_pre_transform_success_event.rb | 22 ++++++- .../models/beta/v2/file_upload_response.rbi | 61 +++++++++++++++++++ .../models/file_update_response.rbi | 61 +++++++++++++++++++ .../models/file_upload_response.rbi | 61 +++++++++++++++++++ .../upload_pre_transform_success_event.rbi | 61 +++++++++++++++++++ .../models/beta/v2/file_upload_response.rbs | 21 +++++++ .../models/file_update_response.rbs | 21 +++++++ .../models/file_upload_response.rbs | 21 +++++++ .../upload_pre_transform_success_event.rbs | 21 +++++++ 13 files changed, 414 insertions(+), 6 deletions(-) diff --git a/.stats.yml b/.stats.yml index f7feecbe..dc3fb535 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 47 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-606f0e2a6ecb6c36557e166764d39b8f619a74904db6bb5ed8bb348ed451b337.yml -openapi_spec_hash: 1d5f5cdb3f7992a183c368ecd009316e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-c028a7584d3508f268ce5c5b824b50af88eaa140620dd03a1b35f409f510603c.yml +openapi_spec_hash: f9b780b2398a87678a13355e48cd515f config_hash: aeb6eb949d73382270bbd8bbf2e4cf2a diff --git a/lib/imagekitio/models/beta/v2/file_upload_response.rb b/lib/imagekitio/models/beta/v2/file_upload_response.rb index e9e69068..1fe9248e 100644 --- a/lib/imagekitio/models/beta/v2/file_upload_response.rb +++ b/lib/imagekitio/models/beta/v2/file_upload_response.rb @@ -299,6 +299,13 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription }, api_name: :"ai-auto-description" + # @!attribute ai_tasks + # + # @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks, nil] + optional :ai_tasks, + enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks }, + api_name: :"ai-tasks" + # @!attribute aws_auto_tagging # # @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] @@ -320,7 +327,7 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" - # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @!method initialize(ai_auto_description: nil, ai_tasks: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) # Extension names with their processing status at the time of completion of the # request. It could have one of the following status values: # @@ -332,6 +339,7 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel # If no extension was requested, then this parameter is not returned. # # @param ai_auto_description [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription] + # @param ai_tasks [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks] # @param aws_auto_tagging [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging] # @param google_auto_tagging [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] # @param remove_bg [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::RemoveBg] @@ -348,6 +356,18 @@ module AIAutoDescription # @return [Array] end + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus#ai_tasks + module AITasks + extend Imagekitio::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + # @see Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus#aws_auto_tagging module AwsAutoTagging extend Imagekitio::Internal::Type::Enum diff --git a/lib/imagekitio/models/file_update_response.rb b/lib/imagekitio/models/file_update_response.rb index 225df77b..c25d3e2c 100644 --- a/lib/imagekitio/models/file_update_response.rb +++ b/lib/imagekitio/models/file_update_response.rb @@ -24,6 +24,13 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel enum: -> { Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription }, api_name: :"ai-auto-description" + # @!attribute ai_tasks + # + # @return [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks, nil] + optional :ai_tasks, + enum: -> { Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks }, + api_name: :"ai-tasks" + # @!attribute aws_auto_tagging # # @return [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging, nil] @@ -45,8 +52,9 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel enum: -> { Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" - # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @!method initialize(ai_auto_description: nil, ai_tasks: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) # @param ai_auto_description [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription] + # @param ai_tasks [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks] # @param aws_auto_tagging [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging] # @param google_auto_tagging [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::GoogleAutoTagging] # @param remove_bg [Symbol, Imagekitio::Models::FileUpdateResponse::ExtensionStatus::RemoveBg] @@ -63,6 +71,18 @@ module AIAutoDescription # @return [Array] end + # @see Imagekitio::Models::FileUpdateResponse::ExtensionStatus#ai_tasks + module AITasks + extend Imagekitio::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + # @see Imagekitio::Models::FileUpdateResponse::ExtensionStatus#aws_auto_tagging module AwsAutoTagging extend Imagekitio::Internal::Type::Enum diff --git a/lib/imagekitio/models/file_upload_response.rb b/lib/imagekitio/models/file_upload_response.rb index d5a95f96..04f81b03 100644 --- a/lib/imagekitio/models/file_upload_response.rb +++ b/lib/imagekitio/models/file_upload_response.rb @@ -295,6 +295,13 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel enum: -> { Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription }, api_name: :"ai-auto-description" + # @!attribute ai_tasks + # + # @return [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks, nil] + optional :ai_tasks, + enum: -> { Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks }, + api_name: :"ai-tasks" + # @!attribute aws_auto_tagging # # @return [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging, nil] @@ -316,7 +323,7 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel enum: -> { Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" - # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @!method initialize(ai_auto_description: nil, ai_tasks: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) # Extension names with their processing status at the time of completion of the # request. It could have one of the following status values: # @@ -328,6 +335,7 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel # If no extension was requested, then this parameter is not returned. # # @param ai_auto_description [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription] + # @param ai_tasks [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks] # @param aws_auto_tagging [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging] # @param google_auto_tagging [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::GoogleAutoTagging] # @param remove_bg [Symbol, Imagekitio::Models::FileUploadResponse::ExtensionStatus::RemoveBg] @@ -344,6 +352,18 @@ module AIAutoDescription # @return [Array] end + # @see Imagekitio::Models::FileUploadResponse::ExtensionStatus#ai_tasks + module AITasks + extend Imagekitio::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + # @see Imagekitio::Models::FileUploadResponse::ExtensionStatus#aws_auto_tagging module AwsAutoTagging extend Imagekitio::Internal::Type::Enum diff --git a/lib/imagekitio/models/upload_pre_transform_success_event.rb b/lib/imagekitio/models/upload_pre_transform_success_event.rb index b2474269..3e6d4a65 100644 --- a/lib/imagekitio/models/upload_pre_transform_success_event.rb +++ b/lib/imagekitio/models/upload_pre_transform_success_event.rb @@ -339,6 +339,13 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel }, api_name: :"ai-auto-description" + # @!attribute ai_tasks + # + # @return [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks, nil] + optional :ai_tasks, + enum: -> { Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks }, + api_name: :"ai-tasks" + # @!attribute aws_auto_tagging # # @return [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging, nil] @@ -364,7 +371,7 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel enum: -> { Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg }, api_name: :"remove-bg" - # @!method initialize(ai_auto_description: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) + # @!method initialize(ai_auto_description: nil, ai_tasks: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil) # Extension names with their processing status at the time of completion of the # request. It could have one of the following status values: # @@ -376,6 +383,7 @@ class ExtensionStatus < Imagekitio::Internal::Type::BaseModel # If no extension was requested, then this parameter is not returned. # # @param ai_auto_description [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription] + # @param ai_tasks [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks] # @param aws_auto_tagging [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging] # @param google_auto_tagging [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::GoogleAutoTagging] # @param remove_bg [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::RemoveBg] @@ -392,6 +400,18 @@ module AIAutoDescription # @return [Array] end + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#ai_tasks + module AITasks + extend Imagekitio::Internal::Type::Enum + + SUCCESS = :success + PENDING = :pending + FAILED = :failed + + # @!method self.values + # @return [Array] + end + # @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus#aws_auto_tagging module AwsAutoTagging extend Imagekitio::Internal::Type::Enum diff --git a/rbi/imagekitio/models/beta/v2/file_upload_response.rbi b/rbi/imagekitio/models/beta/v2/file_upload_response.rbi index 2c472e76..c89e24cf 100644 --- a/rbi/imagekitio/models/beta/v2/file_upload_response.rbi +++ b/rbi/imagekitio/models/beta/v2/file_upload_response.rbi @@ -516,6 +516,23 @@ module Imagekitio end attr_writer :ai_auto_description + sig do + returns( + T.nilable( + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + ) + end + attr_reader :ai_tasks + + sig do + params( + ai_tasks: + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::OrSymbol + ).void + end + attr_writer :ai_tasks + sig do returns( T.nilable( @@ -580,6 +597,8 @@ module Imagekitio params( ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol, + ai_tasks: + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::OrSymbol, aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: @@ -590,6 +609,7 @@ module Imagekitio end def self.new( ai_auto_description: nil, + ai_tasks: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil @@ -601,6 +621,8 @@ module Imagekitio { ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, + ai_tasks: + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol, aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: @@ -652,6 +674,45 @@ module Imagekitio end end + module AITasks + extend Imagekitio::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ] + ) + end + def self.values + end + end + module AwsAutoTagging extend Imagekitio::Internal::Type::Enum diff --git a/rbi/imagekitio/models/file_update_response.rbi b/rbi/imagekitio/models/file_update_response.rbi index 3db28abe..fc4461b6 100644 --- a/rbi/imagekitio/models/file_update_response.rbi +++ b/rbi/imagekitio/models/file_update_response.rbi @@ -73,6 +73,23 @@ module Imagekitio end attr_writer :ai_auto_description + sig do + returns( + T.nilable( + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + ) + end + attr_reader :ai_tasks + + sig do + params( + ai_tasks: + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks::OrSymbol + ).void + end + attr_writer :ai_tasks + sig do returns( T.nilable( @@ -128,6 +145,8 @@ module Imagekitio params( ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::OrSymbol, + ai_tasks: + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks::OrSymbol, aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: @@ -138,6 +157,7 @@ module Imagekitio end def self.new( ai_auto_description: nil, + ai_tasks: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil @@ -149,6 +169,8 @@ module Imagekitio { ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, + ai_tasks: + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks::TaggedSymbol, aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: @@ -200,6 +222,45 @@ module Imagekitio end end + module AITasks + extend Imagekitio::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::AITasks::TaggedSymbol + ] + ) + end + def self.values + end + end + module AwsAutoTagging extend Imagekitio::Internal::Type::Enum diff --git a/rbi/imagekitio/models/file_upload_response.rbi b/rbi/imagekitio/models/file_upload_response.rbi index 0e88ee70..5db02369 100644 --- a/rbi/imagekitio/models/file_upload_response.rbi +++ b/rbi/imagekitio/models/file_upload_response.rbi @@ -497,6 +497,23 @@ module Imagekitio end attr_writer :ai_auto_description + sig do + returns( + T.nilable( + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + ) + end + attr_reader :ai_tasks + + sig do + params( + ai_tasks: + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks::OrSymbol + ).void + end + attr_writer :ai_tasks + sig do returns( T.nilable( @@ -561,6 +578,8 @@ module Imagekitio params( ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol, + ai_tasks: + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks::OrSymbol, aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: @@ -571,6 +590,7 @@ module Imagekitio end def self.new( ai_auto_description: nil, + ai_tasks: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil @@ -582,6 +602,8 @@ module Imagekitio { ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol, + ai_tasks: + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol, aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: @@ -633,6 +655,45 @@ module Imagekitio end end + module AITasks + extend Imagekitio::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekitio::Models::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol + ] + ) + end + def self.values + end + end + module AwsAutoTagging extend Imagekitio::Internal::Type::Enum diff --git a/rbi/imagekitio/models/upload_pre_transform_success_event.rbi b/rbi/imagekitio/models/upload_pre_transform_success_event.rbi index f989dd66..d20ff55f 100644 --- a/rbi/imagekitio/models/upload_pre_transform_success_event.rbi +++ b/rbi/imagekitio/models/upload_pre_transform_success_event.rbi @@ -583,6 +583,23 @@ module Imagekitio end attr_writer :ai_auto_description + sig do + returns( + T.nilable( + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks::TaggedSymbol + ) + ) + end + attr_reader :ai_tasks + + sig do + params( + ai_tasks: + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks::OrSymbol + ).void + end + attr_writer :ai_tasks + sig do returns( T.nilable( @@ -647,6 +664,8 @@ module Imagekitio params( ai_auto_description: Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::OrSymbol, + ai_tasks: + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks::OrSymbol, aws_auto_tagging: Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::OrSymbol, google_auto_tagging: @@ -657,6 +676,7 @@ module Imagekitio end def self.new( ai_auto_description: nil, + ai_tasks: nil, aws_auto_tagging: nil, google_auto_tagging: nil, remove_bg: nil @@ -668,6 +688,8 @@ module Imagekitio { ai_auto_description: Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AIAutoDescription::TaggedSymbol, + ai_tasks: + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks::TaggedSymbol, aws_auto_tagging: Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AwsAutoTagging::TaggedSymbol, google_auto_tagging: @@ -719,6 +741,45 @@ module Imagekitio end end + module AITasks + extend Imagekitio::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + SUCCESS = + T.let( + :success, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks::TaggedSymbol + ) + FAILED = + T.let( + :failed, + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Imagekitio::UploadPreTransformSuccessEvent::Data::ExtensionStatus::AITasks::TaggedSymbol + ] + ) + end + def self.values + end + end + module AwsAutoTagging extend Imagekitio::Internal::Type::Enum diff --git a/sig/imagekitio/models/beta/v2/file_upload_response.rbs b/sig/imagekitio/models/beta/v2/file_upload_response.rbs index 3a4f392d..f552c5a7 100644 --- a/sig/imagekitio/models/beta/v2/file_upload_response.rbs +++ b/sig/imagekitio/models/beta/v2/file_upload_response.rbs @@ -215,6 +215,7 @@ module Imagekitio type extension_status = { ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, + ai_tasks: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_tasks, aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg @@ -227,6 +228,12 @@ module Imagekitio Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description + attr_reader ai_tasks: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_tasks? + + def ai_tasks=: ( + Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_tasks + ) -> Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_tasks + attr_reader aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging? def aws_auto_tagging=: ( @@ -247,6 +254,7 @@ module Imagekitio def initialize: ( ?ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, + ?ai_tasks: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_tasks, ?aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, ?google_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, ?remove_bg: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg @@ -254,6 +262,7 @@ module Imagekitio def to_hash: -> { ai_auto_description: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description, + ai_tasks: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_tasks, aws_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::remove_bg @@ -271,6 +280,18 @@ module Imagekitio def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_auto_description] end + type ai_tasks = :success | :pending | :failed + + module AITasks + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::ai_tasks] + end + type aws_auto_tagging = :success | :pending | :failed module AwsAutoTagging diff --git a/sig/imagekitio/models/file_update_response.rbs b/sig/imagekitio/models/file_update_response.rbs index 8086d9a1..038cf9c5 100644 --- a/sig/imagekitio/models/file_update_response.rbs +++ b/sig/imagekitio/models/file_update_response.rbs @@ -23,6 +23,7 @@ module Imagekitio type extension_status = { ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + ai_tasks: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_tasks, aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg @@ -35,6 +36,12 @@ module Imagekitio Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description ) -> Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description + attr_reader ai_tasks: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_tasks? + + def ai_tasks=: ( + Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_tasks + ) -> Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_tasks + attr_reader aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging? def aws_auto_tagging=: ( @@ -55,6 +62,7 @@ module Imagekitio def initialize: ( ?ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + ?ai_tasks: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_tasks, ?aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, ?google_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, ?remove_bg: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg @@ -62,6 +70,7 @@ module Imagekitio def to_hash: -> { ai_auto_description: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description, + ai_tasks: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_tasks, aws_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekitio::Models::FileUpdateResponse::ExtensionStatus::remove_bg @@ -79,6 +88,18 @@ module Imagekitio def self?.values: -> ::Array[Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_auto_description] end + type ai_tasks = :success | :pending | :failed + + module AITasks + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUpdateResponse::ExtensionStatus::ai_tasks] + end + type aws_auto_tagging = :success | :pending | :failed module AwsAutoTagging diff --git a/sig/imagekitio/models/file_upload_response.rbs b/sig/imagekitio/models/file_upload_response.rbs index b94fc139..abb9c68d 100644 --- a/sig/imagekitio/models/file_upload_response.rbs +++ b/sig/imagekitio/models/file_upload_response.rbs @@ -213,6 +213,7 @@ module Imagekitio type extension_status = { ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, + ai_tasks: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_tasks, aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg @@ -225,6 +226,12 @@ module Imagekitio Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description ) -> Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description + attr_reader ai_tasks: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_tasks? + + def ai_tasks=: ( + Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_tasks + ) -> Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_tasks + attr_reader aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging? def aws_auto_tagging=: ( @@ -245,6 +252,7 @@ module Imagekitio def initialize: ( ?ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, + ?ai_tasks: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_tasks, ?aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, ?google_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, ?remove_bg: Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg @@ -252,6 +260,7 @@ module Imagekitio def to_hash: -> { ai_auto_description: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description, + ai_tasks: Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_tasks, aws_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekitio::Models::FileUploadResponse::ExtensionStatus::google_auto_tagging, remove_bg: Imagekitio::Models::FileUploadResponse::ExtensionStatus::remove_bg @@ -269,6 +278,18 @@ module Imagekitio def self?.values: -> ::Array[Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_auto_description] end + type ai_tasks = :success | :pending | :failed + + module AITasks + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::FileUploadResponse::ExtensionStatus::ai_tasks] + end + type aws_auto_tagging = :success | :pending | :failed module AwsAutoTagging diff --git a/sig/imagekitio/models/upload_pre_transform_success_event.rbs b/sig/imagekitio/models/upload_pre_transform_success_event.rbs index 90bf4311..e7de4a8d 100644 --- a/sig/imagekitio/models/upload_pre_transform_success_event.rbs +++ b/sig/imagekitio/models/upload_pre_transform_success_event.rbs @@ -258,6 +258,7 @@ module Imagekitio type extension_status = { ai_auto_description: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, + ai_tasks: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_tasks, aws_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, remove_bg: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg @@ -270,6 +271,12 @@ module Imagekitio Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description + attr_reader ai_tasks: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_tasks? + + def ai_tasks=: ( + Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_tasks + ) -> Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_tasks + attr_reader aws_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging? def aws_auto_tagging=: ( @@ -290,6 +297,7 @@ module Imagekitio def initialize: ( ?ai_auto_description: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, + ?ai_tasks: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_tasks, ?aws_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, ?google_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, ?remove_bg: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg @@ -297,6 +305,7 @@ module Imagekitio def to_hash: -> { ai_auto_description: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description, + ai_tasks: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_tasks, aws_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::aws_auto_tagging, google_auto_tagging: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::google_auto_tagging, remove_bg: Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::remove_bg @@ -314,6 +323,18 @@ module Imagekitio def self?.values: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_auto_description] end + type ai_tasks = :success | :pending | :failed + + module AITasks + extend Imagekitio::Internal::Type::Enum + + SUCCESS: :success + PENDING: :pending + FAILED: :failed + + def self?.values: -> ::Array[Imagekitio::Models::UploadPreTransformSuccessEvent::Data::ExtensionStatus::ai_tasks] + end + type aws_auto_tagging = :success | :pending | :failed module AwsAutoTagging From de760e4a1310830a34ee24ba91d4de13501308a1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 16 Jan 2026 08:43:04 +0000 Subject: [PATCH 164/178] chore(internal): version bump --- .release-please-manifest.json | 2 +- Gemfile.lock | 2 +- README.md | 2 +- lib/imagekitio/version.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 127ac87b..3b4c2d4b 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "4.0.0" + ".": "4.1.0" } \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 4828ae3f..36cf92b3 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - imagekitio (4.0.0) + imagekitio (4.1.0) cgi connection_pool diff --git a/README.md b/README.md index bdd6acf4..76e5d82d 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "imagekitio", "~> 4.0.0" +gem "imagekitio", "~> 4.1.0" ``` diff --git a/lib/imagekitio/version.rb b/lib/imagekitio/version.rb index 5c1df80d..c63ab70a 100644 --- a/lib/imagekitio/version.rb +++ b/lib/imagekitio/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Imagekitio - VERSION = "4.0.0" + VERSION = "4.1.0" end From 13a5912d2b2e7a422f9efc4f5517d568648548c1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 16 Jan 2026 18:32:34 +0000 Subject: [PATCH 165/178] chore(internal): update `actions/checkout` version --- .github/workflows/ci.yml | 4 ++-- .github/workflows/publish-gem.yml | 2 +- .github/workflows/release-doctor.yml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index adb71c87..30fd65e8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,7 +20,7 @@ jobs: if: github.event_name == 'push' || github.event.pull_request.head.repo.fork steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Set up Ruby uses: ruby/setup-ruby@v1 with: @@ -36,7 +36,7 @@ jobs: runs-on: ${{ github.repository == 'stainless-sdks/imagekit-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: github.event_name == 'push' || github.event.pull_request.head.repo.fork steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Set up Ruby uses: ruby/setup-ruby@v1 with: diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml index a3de9dee..642e1eb0 100644 --- a/.github/workflows/publish-gem.yml +++ b/.github/workflows/publish-gem.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Set up Ruby uses: ruby/setup-ruby@v1 with: diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index 9d9c1e66..26014cca 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -12,7 +12,7 @@ jobs: if: github.repository == 'imagekit-developer/imagekit-ruby' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Check release environment run: | From c93485c2382658c364def8fb78cf01017ae93edb Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 20 Jan 2026 06:11:22 +0000 Subject: [PATCH 166/178] fix: vocab field is required --- .stats.yml | 4 ++-- lib/imagekitio/models/extension_config.rb | 20 ++++++++--------- lib/imagekitio/models/extensions.rb | 20 ++++++++--------- rbi/imagekitio/models/extension_config.rbi | 25 ++++++++++++---------- rbi/imagekitio/models/extensions.rbi | 25 ++++++++++++---------- sig/imagekitio/models/extension_config.rbs | 16 ++++++++------ sig/imagekitio/models/extensions.rbs | 16 ++++++++------ 7 files changed, 68 insertions(+), 58 deletions(-) diff --git a/.stats.yml b/.stats.yml index dc3fb535..751099cf 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 47 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-c028a7584d3508f268ce5c5b824b50af88eaa140620dd03a1b35f409f510603c.yml -openapi_spec_hash: f9b780b2398a87678a13355e48cd515f +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-84f0d75048a9268981a84800b4190e3691997ce57dcfc0876f38a5b3fce6bacd.yml +openapi_spec_hash: 35607d4e850c8a60524223ff632c83bb config_hash: aeb6eb949d73382270bbd8bbf2e4cf2a diff --git a/lib/imagekitio/models/extension_config.rb b/lib/imagekitio/models/extension_config.rb index 5b862865..a8e7f03b 100644 --- a/lib/imagekitio/models/extension_config.rb +++ b/lib/imagekitio/models/extension_config.rb @@ -173,13 +173,6 @@ class SelectTags < Imagekitio::Internal::Type::BaseModel # @return [Symbol, :select_tags] required :type, const: :select_tags - # @!attribute vocabulary - # Array of possible tag values. Combined length of all strings must not exceed 500 - # characters. Cannot contain the `%` character. - # - # @return [Array] - required :vocabulary, Imagekitio::Internal::Type::ArrayOf[String] - # @!attribute max_selections # Maximum number of tags to select from the vocabulary. # @@ -192,19 +185,26 @@ class SelectTags < Imagekitio::Internal::Type::BaseModel # @return [Integer, nil] optional :min_selections, Integer - # @!method initialize(instruction:, vocabulary:, max_selections: nil, min_selections: nil, type: :select_tags) + # @!attribute vocabulary + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + # + # @return [Array, nil] + optional :vocabulary, Imagekitio::Internal::Type::ArrayOf[String] + + # @!method initialize(instruction:, max_selections: nil, min_selections: nil, vocabulary: nil, type: :select_tags) # Some parameter documentations has been truncated, see # {Imagekitio::Models::ExtensionConfig::AITasks::Task::SelectTags} for more # details. # # @param instruction [String] The question or instruction for the AI to analyze the image. # - # @param vocabulary [Array] Array of possible tag values. Combined length of all strings must not exceed 500 - # # @param max_selections [Integer] Maximum number of tags to select from the vocabulary. # # @param min_selections [Integer] Minimum number of tags to select from the vocabulary. # + # @param vocabulary [Array] Array of possible tag values. Combined length of all strings must not exceed 500 + # # @param type [Symbol, :select_tags] Task type that analyzes the image and adds matching tags from a vocabulary. end diff --git a/lib/imagekitio/models/extensions.rb b/lib/imagekitio/models/extensions.rb index 10c21ee1..387fe338 100644 --- a/lib/imagekitio/models/extensions.rb +++ b/lib/imagekitio/models/extensions.rb @@ -173,13 +173,6 @@ class SelectTags < Imagekitio::Internal::Type::BaseModel # @return [Symbol, :select_tags] required :type, const: :select_tags - # @!attribute vocabulary - # Array of possible tag values. Combined length of all strings must not exceed 500 - # characters. Cannot contain the `%` character. - # - # @return [Array] - required :vocabulary, Imagekitio::Internal::Type::ArrayOf[String] - # @!attribute max_selections # Maximum number of tags to select from the vocabulary. # @@ -192,18 +185,25 @@ class SelectTags < Imagekitio::Internal::Type::BaseModel # @return [Integer, nil] optional :min_selections, Integer - # @!method initialize(instruction:, vocabulary:, max_selections: nil, min_selections: nil, type: :select_tags) + # @!attribute vocabulary + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + # + # @return [Array, nil] + optional :vocabulary, Imagekitio::Internal::Type::ArrayOf[String] + + # @!method initialize(instruction:, max_selections: nil, min_selections: nil, vocabulary: nil, type: :select_tags) # Some parameter documentations has been truncated, see # {Imagekitio::Models::ExtensionItem::AITasks::Task::SelectTags} for more details. # # @param instruction [String] The question or instruction for the AI to analyze the image. # - # @param vocabulary [Array] Array of possible tag values. Combined length of all strings must not exceed 500 - # # @param max_selections [Integer] Maximum number of tags to select from the vocabulary. # # @param min_selections [Integer] Minimum number of tags to select from the vocabulary. # + # @param vocabulary [Array] Array of possible tag values. Combined length of all strings must not exceed 500 + # # @param type [Symbol, :select_tags] Task type that analyzes the image and adds matching tags from a vocabulary. end diff --git a/rbi/imagekitio/models/extension_config.rbi b/rbi/imagekitio/models/extension_config.rbi index e83e8fe8..3b5a3b57 100644 --- a/rbi/imagekitio/models/extension_config.rbi +++ b/rbi/imagekitio/models/extension_config.rbi @@ -360,11 +360,6 @@ module Imagekitio sig { returns(Symbol) } attr_accessor :type - # Array of possible tag values. Combined length of all strings must not exceed 500 - # characters. Cannot contain the `%` character. - sig { returns(T::Array[String]) } - attr_accessor :vocabulary - # Maximum number of tags to select from the vocabulary. sig { returns(T.nilable(Integer)) } attr_reader :max_selections @@ -379,25 +374,33 @@ module Imagekitio sig { params(min_selections: Integer).void } attr_writer :min_selections + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :vocabulary + + sig { params(vocabulary: T::Array[String]).void } + attr_writer :vocabulary + sig do params( instruction: String, - vocabulary: T::Array[String], max_selections: Integer, min_selections: Integer, + vocabulary: T::Array[String], type: Symbol ).returns(T.attached_class) end def self.new( # The question or instruction for the AI to analyze the image. instruction:, - # Array of possible tag values. Combined length of all strings must not exceed 500 - # characters. Cannot contain the `%` character. - vocabulary:, # Maximum number of tags to select from the vocabulary. max_selections: nil, # Minimum number of tags to select from the vocabulary. min_selections: nil, + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + vocabulary: nil, # Task type that analyzes the image and adds matching tags from a vocabulary. type: :select_tags ) @@ -408,9 +411,9 @@ module Imagekitio { instruction: String, type: Symbol, - vocabulary: T::Array[String], max_selections: Integer, - min_selections: Integer + min_selections: Integer, + vocabulary: T::Array[String] } ) end diff --git a/rbi/imagekitio/models/extensions.rbi b/rbi/imagekitio/models/extensions.rbi index 8940a325..bc56a557 100644 --- a/rbi/imagekitio/models/extensions.rbi +++ b/rbi/imagekitio/models/extensions.rbi @@ -357,11 +357,6 @@ module Imagekitio sig { returns(Symbol) } attr_accessor :type - # Array of possible tag values. Combined length of all strings must not exceed 500 - # characters. Cannot contain the `%` character. - sig { returns(T::Array[String]) } - attr_accessor :vocabulary - # Maximum number of tags to select from the vocabulary. sig { returns(T.nilable(Integer)) } attr_reader :max_selections @@ -376,25 +371,33 @@ module Imagekitio sig { params(min_selections: Integer).void } attr_writer :min_selections + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :vocabulary + + sig { params(vocabulary: T::Array[String]).void } + attr_writer :vocabulary + sig do params( instruction: String, - vocabulary: T::Array[String], max_selections: Integer, min_selections: Integer, + vocabulary: T::Array[String], type: Symbol ).returns(T.attached_class) end def self.new( # The question or instruction for the AI to analyze the image. instruction:, - # Array of possible tag values. Combined length of all strings must not exceed 500 - # characters. Cannot contain the `%` character. - vocabulary:, # Maximum number of tags to select from the vocabulary. max_selections: nil, # Minimum number of tags to select from the vocabulary. min_selections: nil, + # Array of possible tag values. Combined length of all strings must not exceed 500 + # characters. Cannot contain the `%` character. + vocabulary: nil, # Task type that analyzes the image and adds matching tags from a vocabulary. type: :select_tags ) @@ -405,9 +408,9 @@ module Imagekitio { instruction: String, type: Symbol, - vocabulary: T::Array[String], max_selections: Integer, - min_selections: Integer + min_selections: Integer, + vocabulary: T::Array[String] } ) end diff --git a/sig/imagekitio/models/extension_config.rbs b/sig/imagekitio/models/extension_config.rbs index 6d73816f..5e964400 100644 --- a/sig/imagekitio/models/extension_config.rbs +++ b/sig/imagekitio/models/extension_config.rbs @@ -156,9 +156,9 @@ module Imagekitio { instruction: String, type: :select_tags, - vocabulary: ::Array[String], max_selections: Integer, - min_selections: Integer + min_selections: Integer, + vocabulary: ::Array[String] } class SelectTags < Imagekitio::Internal::Type::BaseModel @@ -166,8 +166,6 @@ module Imagekitio attr_accessor type: :select_tags - attr_accessor vocabulary: ::Array[String] - attr_reader max_selections: Integer? def max_selections=: (Integer) -> Integer @@ -176,20 +174,24 @@ module Imagekitio def min_selections=: (Integer) -> Integer + attr_reader vocabulary: ::Array[String]? + + def vocabulary=: (::Array[String]) -> ::Array[String] + def initialize: ( instruction: String, - vocabulary: ::Array[String], ?max_selections: Integer, ?min_selections: Integer, + ?vocabulary: ::Array[String], ?type: :select_tags ) -> void def to_hash: -> { instruction: String, type: :select_tags, - vocabulary: ::Array[String], max_selections: Integer, - min_selections: Integer + min_selections: Integer, + vocabulary: ::Array[String] } end diff --git a/sig/imagekitio/models/extensions.rbs b/sig/imagekitio/models/extensions.rbs index 3356ff85..0a4e156b 100644 --- a/sig/imagekitio/models/extensions.rbs +++ b/sig/imagekitio/models/extensions.rbs @@ -157,9 +157,9 @@ module Imagekitio { instruction: String, type: :select_tags, - vocabulary: ::Array[String], max_selections: Integer, - min_selections: Integer + min_selections: Integer, + vocabulary: ::Array[String] } class SelectTags < Imagekitio::Internal::Type::BaseModel @@ -167,8 +167,6 @@ module Imagekitio attr_accessor type: :select_tags - attr_accessor vocabulary: ::Array[String] - attr_reader max_selections: Integer? def max_selections=: (Integer) -> Integer @@ -177,20 +175,24 @@ module Imagekitio def min_selections=: (Integer) -> Integer + attr_reader vocabulary: ::Array[String]? + + def vocabulary=: (::Array[String]) -> ::Array[String] + def initialize: ( instruction: String, - vocabulary: ::Array[String], ?max_selections: Integer, ?min_selections: Integer, + ?vocabulary: ::Array[String], ?type: :select_tags ) -> void def to_hash: -> { instruction: String, type: :select_tags, - vocabulary: ::Array[String], max_selections: Integer, - min_selections: Integer + min_selections: Integer, + vocabulary: ::Array[String] } end From 89770b9af1b2fd3bcfe149349f2814a3144dbb79 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 20 Jan 2026 06:17:05 +0000 Subject: [PATCH 167/178] chore(internal): version bump --- .release-please-manifest.json | 2 +- Gemfile.lock | 2 +- README.md | 2 +- lib/imagekitio/version.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 3b4c2d4b..3c9ae23b 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "4.1.0" + ".": "4.1.1" } \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 36cf92b3..f5412131 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - imagekitio (4.1.0) + imagekitio (4.1.1) cgi connection_pool diff --git a/README.md b/README.md index 76e5d82d..495c0f38 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "imagekitio", "~> 4.1.0" +gem "imagekitio", "~> 4.1.1" ``` diff --git a/lib/imagekitio/version.rb b/lib/imagekitio/version.rb index c63ab70a..525d87cc 100644 --- a/lib/imagekitio/version.rb +++ b/lib/imagekitio/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Imagekitio - VERSION = "4.1.0" + VERSION = "4.1.1" end From d1942d7589a00404b3163319e25e3538a8e087de Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 28 Jan 2026 07:55:09 +0000 Subject: [PATCH 168/178] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 751099cf..011cf609 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 47 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-84f0d75048a9268981a84800b4190e3691997ce57dcfc0876f38a5b3fce6bacd.yml openapi_spec_hash: 35607d4e850c8a60524223ff632c83bb -config_hash: aeb6eb949d73382270bbd8bbf2e4cf2a +config_hash: 47cb702ee2cb52c58d803ae39ade9b44 From b3188cd842b1679c54c3718eccf128d9e0bfbbb1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:36:43 +0000 Subject: [PATCH 169/178] fix(docs): fix mcp installation instructions for remote servers --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 495c0f38..a77c9a17 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ The Image Kit Ruby library provides convenient access to the Image Kit REST API Use the Image Kit MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application. -[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40imagekit%2Fapi-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBpbWFnZWtpdC9hcGktbWNwIl19) -[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40imagekit%2Fapi-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40imagekit%2Fapi-mcp%22%5D%7D) +[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40imagekit%2Fapi-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBpbWFnZWtpdC9hcGktbWNwIl0sImVudiI6eyJJTUFHRUtJVF9QUklWQVRFX0tFWSI6Ik15IFByaXZhdGUgS2V5IiwiT1BUSU9OQUxfSU1BR0VLSVRfSUdOT1JFU19USElTIjoiTXkgUGFzc3dvcmQiLCJJTUFHRUtJVF9XRUJIT09LX1NFQ1JFVCI6Ik15IFdlYmhvb2sgU2VjcmV0In19) +[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40imagekit%2Fapi-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40imagekit%2Fapi-mcp%22%5D%2C%22env%22%3A%7B%22IMAGEKIT_PRIVATE_KEY%22%3A%22My%20Private%20Key%22%2C%22OPTIONAL_IMAGEKIT_IGNORES_THIS%22%3A%22My%20Password%22%2C%22IMAGEKIT_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D) > Note: You may need to set environment variables in your MCP client. From 48e63d6f38547d21e71dedcb1707079a1a4f3a47 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 29 Jan 2026 11:52:04 +0000 Subject: [PATCH 170/178] chore(internal): version bump --- .release-please-manifest.json | 2 +- Gemfile.lock | 2 +- README.md | 2 +- lib/imagekitio/version.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 3c9ae23b..09b8c896 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "4.1.1" + ".": "4.1.2" } \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index f5412131..116d9ad5 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - imagekitio (4.1.1) + imagekitio (4.1.2) cgi connection_pool diff --git a/README.md b/README.md index a77c9a17..c3093328 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "imagekitio", "~> 4.1.1" +gem "imagekitio", "~> 4.1.2" ``` diff --git a/lib/imagekitio/version.rb b/lib/imagekitio/version.rb index 525d87cc..54c79b93 100644 --- a/lib/imagekitio/version.rb +++ b/lib/imagekitio/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Imagekitio - VERSION = "4.1.1" + VERSION = "4.1.2" end From ea9a600a47e011b467965853592afecb892b87d7 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 2 Feb 2026 03:51:41 +0000 Subject: [PATCH 171/178] fix(api): add missing embeddedMetadata and video properties to FileDetails --- .stats.yml | 4 +- lib/imagekitio/models/file.rb | 45 ++++++++++++++- rbi/imagekitio/models/file.rbi | 57 +++++++++++++++++++ sig/imagekitio/models/file.rbs | 35 ++++++++++++ .../resources/files/versions_test.rb | 10 ++++ test/imagekitio/resources/files_test.rb | 5 ++ 6 files changed, 153 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index 011cf609..db4fc3c8 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 47 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-84f0d75048a9268981a84800b4190e3691997ce57dcfc0876f38a5b3fce6bacd.yml -openapi_spec_hash: 35607d4e850c8a60524223ff632c83bb +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-f2eb530f43b355f7ddab66187e45e4ca6da195825b66ea193bbf38acd3deb055.yml +openapi_spec_hash: 2137c56fcf6ae4c09fcac2891b35f789 config_hash: 47cb702ee2cb52c58d803ae39ade9b44 diff --git a/lib/imagekitio/models/file.rb b/lib/imagekitio/models/file.rb index 5145ba57..294cff2d 100644 --- a/lib/imagekitio/models/file.rb +++ b/lib/imagekitio/models/file.rb @@ -13,6 +13,18 @@ class File < Imagekitio::Internal::Type::BaseModel api_name: :AITags, nil?: true + # @!attribute audio_codec + # The audio codec used in the video (only for video/audio). + # + # @return [String, nil] + optional :audio_codec, String, api_name: :audioCodec + + # @!attribute bit_rate + # The bit rate of the video in kbps (only for video). + # + # @return [Integer, nil] + optional :bit_rate, Integer, api_name: :bitRate + # @!attribute created_at # Date and time when the file was uploaded. The date and time is in ISO8601 # format. @@ -41,6 +53,21 @@ class File < Imagekitio::Internal::Type::BaseModel # @return [String, nil] optional :description, String + # @!attribute duration + # The duration of the video in seconds (only for video). + # + # @return [Integer, nil] + optional :duration, Integer + + # @!attribute embedded_metadata + # Consolidated embedded metadata associated with the file. It includes exif, iptc, + # and xmp data. + # + # @return [Hash{Symbol=>Object}, nil] + optional :embedded_metadata, + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], + api_name: :embeddedMetadata + # @!attribute file_id # Unique identifier of the asset. # @@ -157,13 +184,19 @@ class File < Imagekitio::Internal::Type::BaseModel # @return [Imagekitio::Models::File::VersionInfo, nil] optional :version_info, -> { Imagekitio::File::VersionInfo }, api_name: :versionInfo + # @!attribute video_codec + # The video codec used in the video (only for video). + # + # @return [String, nil] + optional :video_codec, String, api_name: :videoCodec + # @!attribute width # Width of the file. # # @return [Float, nil] optional :width, Float - # @!method initialize(ai_tags: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, width: nil) + # @!method initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, created_at: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, file_id: nil, file_path: nil, file_type: nil, has_alpha: nil, height: nil, is_private_file: nil, is_published: nil, mime: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail: nil, type: nil, updated_at: nil, url: nil, version_info: nil, video_codec: nil, width: nil) # Some parameter documentations has been truncated, see {Imagekitio::Models::File} # for more details. # @@ -171,6 +204,10 @@ class File < Imagekitio::Internal::Type::BaseModel # # @param ai_tags [Array, nil] An array of tags assigned to the file by auto tagging. # + # @param audio_codec [String] The audio codec used in the video (only for video/audio). + # + # @param bit_rate [Integer] The bit rate of the video in kbps (only for video). + # # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format # # @param custom_coordinates [String, nil] An string with custom coordinates of the file. @@ -179,6 +216,10 @@ class File < Imagekitio::Internal::Type::BaseModel # # @param description [String] Optional text to describe the contents of the file. Can be set by the user or th # + # @param duration [Integer] The duration of the video in seconds (only for video). + # + # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc, + # # @param file_id [String] Unique identifier of the asset. # # @param file_path [String] Path of the file. This is the path you would use in the URL to access the file. @@ -213,6 +254,8 @@ class File < Imagekitio::Internal::Type::BaseModel # # @param version_info [Imagekitio::Models::File::VersionInfo] An object with details of the file version. # + # @param video_codec [String] The video codec used in the video (only for video). + # # @param width [Float] Width of the file. class AITag < Imagekitio::Internal::Type::BaseModel diff --git a/rbi/imagekitio/models/file.rbi b/rbi/imagekitio/models/file.rbi index bc7304c4..95a78ea1 100644 --- a/rbi/imagekitio/models/file.rbi +++ b/rbi/imagekitio/models/file.rbi @@ -10,6 +10,20 @@ module Imagekitio sig { returns(T.nilable(T::Array[Imagekitio::File::AITag])) } attr_accessor :ai_tags + # The audio codec used in the video (only for video/audio). + sig { returns(T.nilable(String)) } + attr_reader :audio_codec + + sig { params(audio_codec: String).void } + attr_writer :audio_codec + + # The bit rate of the video in kbps (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :bit_rate + + sig { params(bit_rate: Integer).void } + attr_writer :bit_rate + # Date and time when the file was uploaded. The date and time is in ISO8601 # format. sig { returns(T.nilable(Time)) } @@ -37,6 +51,21 @@ module Imagekitio sig { params(description: String).void } attr_writer :description + # The duration of the video in seconds (only for video). + sig { returns(T.nilable(Integer)) } + attr_reader :duration + + sig { params(duration: Integer).void } + attr_writer :duration + + # Consolidated embedded metadata associated with the file. It includes exif, iptc, + # and xmp data. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :embedded_metadata + + sig { params(embedded_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :embedded_metadata + # Unique identifier of the asset. sig { returns(T.nilable(String)) } attr_reader :file_id @@ -174,6 +203,13 @@ module Imagekitio sig { params(version_info: Imagekitio::File::VersionInfo::OrHash).void } attr_writer :version_info + # The video codec used in the video (only for video). + sig { returns(T.nilable(String)) } + attr_reader :video_codec + + sig { params(video_codec: String).void } + attr_writer :video_codec + # Width of the file. sig { returns(T.nilable(Float)) } attr_reader :width @@ -185,10 +221,14 @@ module Imagekitio sig do params( ai_tags: T.nilable(T::Array[Imagekitio::File::AITag::OrHash]), + audio_codec: String, + bit_rate: Integer, created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], description: String, + duration: Integer, + embedded_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, @@ -207,12 +247,17 @@ module Imagekitio updated_at: Time, url: String, version_info: Imagekitio::File::VersionInfo::OrHash, + video_codec: String, width: Float ).returns(T.attached_class) end def self.new( # An array of tags assigned to the file by auto tagging. ai_tags: nil, + # The audio codec used in the video (only for video/audio). + audio_codec: nil, + # The bit rate of the video in kbps (only for video). + bit_rate: nil, # Date and time when the file was uploaded. The date and time is in ISO8601 # format. created_at: nil, @@ -223,6 +268,11 @@ module Imagekitio # Optional text to describe the contents of the file. Can be set by the user or # the ai-auto-description extension. description: nil, + # The duration of the video in seconds (only for video). + duration: nil, + # Consolidated embedded metadata associated with the file. It includes exif, iptc, + # and xmp data. + embedded_metadata: nil, # Unique identifier of the asset. file_id: nil, # Path of the file. This is the path you would use in the URL to access the file. @@ -269,6 +319,8 @@ module Imagekitio url: nil, # An object with details of the file version. version_info: nil, + # The video codec used in the video (only for video). + video_codec: nil, # Width of the file. width: nil ) @@ -278,10 +330,14 @@ module Imagekitio override.returns( { ai_tags: T.nilable(T::Array[Imagekitio::File::AITag]), + audio_codec: String, + bit_rate: Integer, created_at: Time, custom_coordinates: T.nilable(String), custom_metadata: T::Hash[Symbol, T.anything], description: String, + duration: Integer, + embedded_metadata: T::Hash[Symbol, T.anything], file_id: String, file_path: String, file_type: String, @@ -300,6 +356,7 @@ module Imagekitio updated_at: Time, url: String, version_info: Imagekitio::File::VersionInfo, + video_codec: String, width: Float } ) diff --git a/sig/imagekitio/models/file.rbs b/sig/imagekitio/models/file.rbs index c84cdb72..8915e785 100644 --- a/sig/imagekitio/models/file.rbs +++ b/sig/imagekitio/models/file.rbs @@ -3,10 +3,14 @@ module Imagekitio type file = { ai_tags: ::Array[Imagekitio::File::AITag]?, + audio_codec: String, + bit_rate: Integer, created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, @@ -24,12 +28,21 @@ module Imagekitio updated_at: Time, url: String, version_info: Imagekitio::File::VersionInfo, + video_codec: String, width: Float } class File < Imagekitio::Internal::Type::BaseModel attr_accessor ai_tags: ::Array[Imagekitio::File::AITag]? + attr_reader audio_codec: String? + + def audio_codec=: (String) -> String + + attr_reader bit_rate: Integer? + + def bit_rate=: (Integer) -> Integer + attr_reader created_at: Time? def created_at=: (Time) -> Time @@ -44,6 +57,14 @@ module Imagekitio def description=: (String) -> String + attr_reader duration: Integer? + + def duration=: (Integer) -> Integer + + attr_reader embedded_metadata: ::Hash[Symbol, top]? + + def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader file_id: String? def file_id=: (String) -> String @@ -116,16 +137,24 @@ module Imagekitio Imagekitio::File::VersionInfo ) -> Imagekitio::File::VersionInfo + attr_reader video_codec: String? + + def video_codec=: (String) -> String + attr_reader width: Float? def width=: (Float) -> Float def initialize: ( ?ai_tags: ::Array[Imagekitio::File::AITag]?, + ?audio_codec: String, + ?bit_rate: Integer, ?created_at: Time, ?custom_coordinates: String?, ?custom_metadata: ::Hash[Symbol, top], ?description: String, + ?duration: Integer, + ?embedded_metadata: ::Hash[Symbol, top], ?file_id: String, ?file_path: String, ?file_type: String, @@ -143,15 +172,20 @@ module Imagekitio ?updated_at: Time, ?url: String, ?version_info: Imagekitio::File::VersionInfo, + ?video_codec: String, ?width: Float ) -> void def to_hash: -> { ai_tags: ::Array[Imagekitio::File::AITag]?, + audio_codec: String, + bit_rate: Integer, created_at: Time, custom_coordinates: String?, custom_metadata: ::Hash[Symbol, top], description: String, + duration: Integer, + embedded_metadata: ::Hash[Symbol, top], file_id: String, file_path: String, file_type: String, @@ -169,6 +203,7 @@ module Imagekitio updated_at: Time, url: String, version_info: Imagekitio::File::VersionInfo, + video_codec: String, width: Float } diff --git a/test/imagekitio/resources/files/versions_test.rb b/test/imagekitio/resources/files/versions_test.rb index 87eb6878..b1d3dc4a 100644 --- a/test/imagekitio/resources/files/versions_test.rb +++ b/test/imagekitio/resources/files/versions_test.rb @@ -41,10 +41,14 @@ def test_get_required_params assert_pattern do response => { ai_tags: ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag]) | nil, + audio_codec: String | nil, + bit_rate: Integer | nil, created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, description: String | nil, + duration: Integer | nil, + embedded_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, @@ -62,6 +66,7 @@ def test_get_required_params updated_at: Time | nil, url: String | nil, version_info: Imagekitio::File::VersionInfo | nil, + video_codec: String | nil, width: Float | nil } end @@ -79,10 +84,14 @@ def test_restore_required_params assert_pattern do response => { ai_tags: ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag]) | nil, + audio_codec: String | nil, + bit_rate: Integer | nil, created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, description: String | nil, + duration: Integer | nil, + embedded_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, @@ -100,6 +109,7 @@ def test_restore_required_params updated_at: Time | nil, url: String | nil, version_info: Imagekitio::File::VersionInfo | nil, + video_codec: String | nil, width: Float | nil } end diff --git a/test/imagekitio/resources/files_test.rb b/test/imagekitio/resources/files_test.rb index 21b9d8b1..314183f3 100644 --- a/test/imagekitio/resources/files_test.rb +++ b/test/imagekitio/resources/files_test.rb @@ -52,10 +52,14 @@ def test_get assert_pattern do response => { ai_tags: ^(Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag]) | nil, + audio_codec: String | nil, + bit_rate: Integer | nil, created_at: Time | nil, custom_coordinates: String | nil, custom_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, description: String | nil, + duration: Integer | nil, + embedded_metadata: ^(Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]) | nil, file_id: String | nil, file_path: String | nil, file_type: String | nil, @@ -73,6 +77,7 @@ def test_get updated_at: Time | nil, url: String | nil, version_info: Imagekitio::File::VersionInfo | nil, + video_codec: String | nil, width: Float | nil } end From 88cc8845f56e064f4ae10272ef3ec0bfd976930a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 2 Feb 2026 04:47:52 +0000 Subject: [PATCH 172/178] feat(api): add customMetadata property to folder schema --- .stats.yml | 4 ++-- lib/imagekitio/models/folder.rb | 13 ++++++++++++- rbi/imagekitio/models/folder.rbi | 13 +++++++++++++ sig/imagekitio/models/folder.rbs | 7 +++++++ 4 files changed, 34 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index db4fc3c8..dbc39e12 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 47 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-f2eb530f43b355f7ddab66187e45e4ca6da195825b66ea193bbf38acd3deb055.yml -openapi_spec_hash: 2137c56fcf6ae4c09fcac2891b35f789 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-13fc3d7cafdea492f62eef7c1d63424d6d9d8adbff74b9f6ca6fd3fc12a36840.yml +openapi_spec_hash: a1fe6fa48207791657a1ea2d60a6dfcc config_hash: 47cb702ee2cb52c58d803ae39ade9b44 diff --git a/lib/imagekitio/models/folder.rb b/lib/imagekitio/models/folder.rb index 4494e3dc..e2d84e1e 100644 --- a/lib/imagekitio/models/folder.rb +++ b/lib/imagekitio/models/folder.rb @@ -10,6 +10,15 @@ class Folder < Imagekitio::Internal::Type::BaseModel # @return [Time, nil] optional :created_at, Time, api_name: :createdAt + # @!attribute custom_metadata + # An object with custom metadata for the folder. Returns empty object if no custom + # metadata is set. + # + # @return [Hash{Symbol=>Object}, nil] + optional :custom_metadata, + Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown], + api_name: :customMetadata + # @!attribute folder_id # Unique identifier of the asset. # @@ -44,12 +53,14 @@ class Folder < Imagekitio::Internal::Type::BaseModel # @return [Time, nil] optional :updated_at, Time, api_name: :updatedAt - # @!method initialize(created_at: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil) + # @!method initialize(created_at: nil, custom_metadata: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil) # Some parameter documentations has been truncated, see # {Imagekitio::Models::Folder} for more details. # # @param created_at [Time] Date and time when the folder was created. The date and time is in ISO8601 forma # + # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the folder. Returns empty object if no custom + # # @param folder_id [String] Unique identifier of the asset. # # @param folder_path [String] Path of the folder. This is the path you would use in the URL to access the fold diff --git a/rbi/imagekitio/models/folder.rbi b/rbi/imagekitio/models/folder.rbi index d2b61d1c..103edbb3 100644 --- a/rbi/imagekitio/models/folder.rbi +++ b/rbi/imagekitio/models/folder.rbi @@ -16,6 +16,14 @@ module Imagekitio sig { params(created_at: Time).void } attr_writer :created_at + # An object with custom metadata for the folder. Returns empty object if no custom + # metadata is set. + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :custom_metadata + + sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :custom_metadata + # Unique identifier of the asset. sig { returns(T.nilable(String)) } attr_reader :folder_id @@ -58,6 +66,7 @@ module Imagekitio sig do params( created_at: Time, + custom_metadata: T::Hash[Symbol, T.anything], folder_id: String, folder_path: String, name: String, @@ -69,6 +78,9 @@ module Imagekitio # Date and time when the folder was created. The date and time is in ISO8601 # format. created_at: nil, + # An object with custom metadata for the folder. Returns empty object if no custom + # metadata is set. + custom_metadata: nil, # Unique identifier of the asset. folder_id: nil, # Path of the folder. This is the path you would use in the URL to access the @@ -90,6 +102,7 @@ module Imagekitio override.returns( { created_at: Time, + custom_metadata: T::Hash[Symbol, T.anything], folder_id: String, folder_path: String, name: String, diff --git a/sig/imagekitio/models/folder.rbs b/sig/imagekitio/models/folder.rbs index b67e65e7..78473ae3 100644 --- a/sig/imagekitio/models/folder.rbs +++ b/sig/imagekitio/models/folder.rbs @@ -3,6 +3,7 @@ module Imagekitio type folder = { created_at: Time, + custom_metadata: ::Hash[Symbol, top], folder_id: String, folder_path: String, name: String, @@ -15,6 +16,10 @@ module Imagekitio def created_at=: (Time) -> Time + attr_reader custom_metadata: ::Hash[Symbol, top]? + + def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader folder_id: String? def folder_id=: (String) -> String @@ -39,6 +44,7 @@ module Imagekitio def initialize: ( ?created_at: Time, + ?custom_metadata: ::Hash[Symbol, top], ?folder_id: String, ?folder_path: String, ?name: String, @@ -48,6 +54,7 @@ module Imagekitio def to_hash: -> { created_at: Time, + custom_metadata: ::Hash[Symbol, top], folder_id: String, folder_path: String, name: String, From 268882124d2c1a516236de4b62c875ed7700ae7c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 2 Feb 2026 05:27:44 +0000 Subject: [PATCH 173/178] chore(internal): version bump --- .release-please-manifest.json | 2 +- Gemfile.lock | 2 +- README.md | 2 +- lib/imagekitio/version.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 09b8c896..bd7f3844 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "4.1.2" + ".": "4.2.0" } \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 116d9ad5..12efac0b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - imagekitio (4.1.2) + imagekitio (4.2.0) cgi connection_pool diff --git a/README.md b/README.md index c3093328..4168b57a 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "imagekitio", "~> 4.1.2" +gem "imagekitio", "~> 4.2.0" ``` diff --git a/lib/imagekitio/version.rb b/lib/imagekitio/version.rb index 54c79b93..abbbfc15 100644 --- a/lib/imagekitio/version.rb +++ b/lib/imagekitio/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Imagekitio - VERSION = "4.1.2" + VERSION = "4.2.0" end From 87aa9f45fc063dbcc8eef42b817d2032f7dfecb9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 2 Feb 2026 14:40:29 +0000 Subject: [PATCH 174/178] fix(client): always add content-length to post body, even when empty --- lib/imagekitio/internal/transport/pooled_net_requester.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/imagekitio/internal/transport/pooled_net_requester.rb b/lib/imagekitio/internal/transport/pooled_net_requester.rb index fa323842..dfed0d77 100644 --- a/lib/imagekitio/internal/transport/pooled_net_requester.rb +++ b/lib/imagekitio/internal/transport/pooled_net_requester.rb @@ -75,7 +75,7 @@ def build_request(request, &blk) case body in nil - nil + req["content-length"] ||= 0 unless req["transfer-encoding"] in String req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"] req.body_stream = Imagekitio::Internal::Util::ReadIOAdapter.new(body, &blk) From ef24d62c593699c7142ff01085910dda9ef8fbe8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 4 Feb 2026 01:22:22 +0000 Subject: [PATCH 175/178] chore(docs): remove www prefix --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a225d784..3388be93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,13 +43,13 @@ If you’d like to use the repository from source, you can either install from g To install via git in your `Gemfile`: ```ruby -gem "imagekitio", git: "https://www.github.com/imagekit-developer/imagekit-ruby" +gem "imagekitio", git: "https://github.com/imagekit-developer/imagekit-ruby" ``` Alternatively, reference local copy of the repo: ```bash -$ git clone -- 'https://www.github.com/imagekit-developer/imagekit-ruby' '' +$ git clone -- 'https://github.com/imagekit-developer/imagekit-ruby' '' ``` ```ruby From 49b1834d9e0c2c74f8a54053f00775682024966f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 6 Feb 2026 17:20:23 +0000 Subject: [PATCH 176/178] fix(client): loosen json header parsing --- lib/imagekitio/internal/util.rb | 2 +- rbi/imagekitio/internal/util.rbi | 2 +- test/imagekitio/internal/util_test.rb | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/imagekitio/internal/util.rb b/lib/imagekitio/internal/util.rb index 1dd7d346..6ca7b61c 100644 --- a/lib/imagekitio/internal/util.rb +++ b/lib/imagekitio/internal/util.rb @@ -485,7 +485,7 @@ def writable_enum(&blk) end # @type [Regexp] - JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)} + JSON_CONTENT = %r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)} # @type [Regexp] JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)} diff --git a/rbi/imagekitio/internal/util.rbi b/rbi/imagekitio/internal/util.rbi index 9fbebf93..2feefe0f 100644 --- a/rbi/imagekitio/internal/util.rbi +++ b/rbi/imagekitio/internal/util.rbi @@ -296,7 +296,7 @@ module Imagekitio end JSON_CONTENT = - T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp) + T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp) JSONL_CONTENT = T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp) diff --git a/test/imagekitio/internal/util_test.rb b/test/imagekitio/internal/util_test.rb index 976d5b0b..1b29975d 100644 --- a/test/imagekitio/internal/util_test.rb +++ b/test/imagekitio/internal/util_test.rb @@ -171,6 +171,8 @@ def test_json_content cases = { "application/json" => true, "application/jsonl" => false, + "application/arbitrary+json" => true, + "application/ARBITRARY+json" => true, "application/vnd.github.v3+json" => true, "application/vnd.api+json" => true } From b3a7cd33a2ae4a096e80094c82e536680b8e9159 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 19 Feb 2026 16:03:30 +0000 Subject: [PATCH 177/178] chore(internal): remove mock server code --- scripts/mock | 41 ----------------------------------------- scripts/test | 46 ---------------------------------------------- 2 files changed, 87 deletions(-) delete mode 100755 scripts/mock diff --git a/scripts/mock b/scripts/mock deleted file mode 100755 index 0b28f6ea..00000000 --- a/scripts/mock +++ /dev/null @@ -1,41 +0,0 @@ -#!/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 index e0dc1374..df8caf98 100755 --- a/scripts/test +++ b/scripts/test @@ -4,53 +4,7 @@ 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 echo "==> Running tests" bundle exec rake test "$@" From b89f2a3b35fb24ca83fed0333e8da7e348f0faca Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 19 Feb 2026 16:33:55 +0000 Subject: [PATCH 178/178] chore: update mock server docs --- CONTRIBUTING.md | 6 ------ test/imagekitio/resources/accounts/origins_test.rb | 10 +++++----- .../resources/accounts/url_endpoints_test.rb | 10 +++++----- test/imagekitio/resources/accounts/usage_test.rb | 2 +- test/imagekitio/resources/assets_test.rb | 2 +- test/imagekitio/resources/beta/v2/files_test.rb | 2 +- .../resources/cache/invalidation_test.rb | 4 ++-- .../resources/custom_metadata_fields_test.rb | 8 ++++---- test/imagekitio/resources/files/bulk_test.rb | 8 ++++---- test/imagekitio/resources/files/metadata_test.rb | 4 ++-- test/imagekitio/resources/files/versions_test.rb | 8 ++++---- test/imagekitio/resources/files_test.rb | 14 +++++++------- test/imagekitio/resources/folders/job_test.rb | 2 +- test/imagekitio/resources/folders_test.rb | 10 +++++----- test/imagekitio/resources/saved_extensions_test.rb | 10 +++++----- 15 files changed, 47 insertions(+), 53 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3388be93..021d1167 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,12 +66,6 @@ $ bundle exec rake ## Running tests -Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests. - -```bash -$ npx prism mock path/to/your/openapi.yml -``` - ```bash $ bundle exec rake test ``` diff --git a/test/imagekitio/resources/accounts/origins_test.rb b/test/imagekitio/resources/accounts/origins_test.rb index 49f7a48f..78285d1a 100644 --- a/test/imagekitio/resources/accounts/origins_test.rb +++ b/test/imagekitio/resources/accounts/origins_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Accounts::OriginsTest < Imagekitio::Test::ResourceTest def test_create_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.origins.create( @@ -114,7 +114,7 @@ def test_create_required_params end def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.origins.update( @@ -225,7 +225,7 @@ def test_update_required_params end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.origins.list @@ -235,7 +235,7 @@ def test_list end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.origins.delete("id") @@ -245,7 +245,7 @@ def test_delete end def test_get - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.origins.get("id") diff --git a/test/imagekitio/resources/accounts/url_endpoints_test.rb b/test/imagekitio/resources/accounts/url_endpoints_test.rb index fa912642..966e30b2 100644 --- a/test/imagekitio/resources/accounts/url_endpoints_test.rb +++ b/test/imagekitio/resources/accounts/url_endpoints_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Accounts::URLEndpointsTest < Imagekitio::Test::ResourceTest def test_create_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.url_endpoints.create(description: "My custom URL endpoint") @@ -24,7 +24,7 @@ def test_create_required_params end def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.url_endpoints.update("id", description: "My custom URL endpoint") @@ -44,7 +44,7 @@ def test_update_required_params end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.url_endpoints.list @@ -54,7 +54,7 @@ def test_list end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.url_endpoints.delete("id") @@ -64,7 +64,7 @@ def test_delete end def test_get - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.url_endpoints.get("id") diff --git a/test/imagekitio/resources/accounts/usage_test.rb b/test/imagekitio/resources/accounts/usage_test.rb index f928f45c..64346dd9 100644 --- a/test/imagekitio/resources/accounts/usage_test.rb +++ b/test/imagekitio/resources/accounts/usage_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Accounts::UsageTest < Imagekitio::Test::ResourceTest def test_get_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.accounts.usage.get(end_date: "2019-12-27", start_date: "2019-12-27") diff --git a/test/imagekitio/resources/assets_test.rb b/test/imagekitio/resources/assets_test.rb index f4b2148c..882e51f7 100644 --- a/test/imagekitio/resources/assets_test.rb +++ b/test/imagekitio/resources/assets_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::AssetsTest < Imagekitio::Test::ResourceTest def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.assets.list diff --git a/test/imagekitio/resources/beta/v2/files_test.rb b/test/imagekitio/resources/beta/v2/files_test.rb index 640bff4e..c2f57288 100644 --- a/test/imagekitio/resources/beta/v2/files_test.rb +++ b/test/imagekitio/resources/beta/v2/files_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Beta::V2::FilesTest < Imagekitio::Test::ResourceTest def test_upload_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.beta.v2.files.upload(file: Pathname(__FILE__), file_name: "fileName") diff --git a/test/imagekitio/resources/cache/invalidation_test.rb b/test/imagekitio/resources/cache/invalidation_test.rb index 2d29a047..dec4bfc5 100644 --- a/test/imagekitio/resources/cache/invalidation_test.rb +++ b/test/imagekitio/resources/cache/invalidation_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Cache::InvalidationTest < Imagekitio::Test::ResourceTest def test_create_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.cache.invalidation.create(url: "https://ik.imagekit.io/your_imagekit_id/default-image.jpg") @@ -21,7 +21,7 @@ def test_create_required_params end def test_get - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.cache.invalidation.get("requestId") diff --git a/test/imagekitio/resources/custom_metadata_fields_test.rb b/test/imagekitio/resources/custom_metadata_fields_test.rb index fcddba86..1d455ad6 100644 --- a/test/imagekitio/resources/custom_metadata_fields_test.rb +++ b/test/imagekitio/resources/custom_metadata_fields_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::CustomMetadataFieldsTest < Imagekitio::Test::ResourceTest def test_create_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.custom_metadata_fields.create(label: "price", name: "price", schema: {type: :Number}) @@ -24,7 +24,7 @@ def test_create_required_params end def test_update - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.custom_metadata_fields.update("id") @@ -43,7 +43,7 @@ def test_update end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.custom_metadata_fields.list @@ -53,7 +53,7 @@ def test_list end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.custom_metadata_fields.delete("id") diff --git a/test/imagekitio/resources/files/bulk_test.rb b/test/imagekitio/resources/files/bulk_test.rb index 56991d88..6699988c 100644 --- a/test/imagekitio/resources/files/bulk_test.rb +++ b/test/imagekitio/resources/files/bulk_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Files::BulkTest < Imagekitio::Test::ResourceTest def test_delete_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.bulk.delete(file_ids: %w[598821f949c0a938d57563bd 598821f949c0a938d57563be]) @@ -21,7 +21,7 @@ def test_delete_required_params end def test_add_tags_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.bulk.add_tags( @@ -41,7 +41,7 @@ def test_add_tags_required_params end def test_remove_ai_tags_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.bulk.remove_ai_tags( @@ -61,7 +61,7 @@ def test_remove_ai_tags_required_params end def test_remove_tags_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.bulk.remove_tags( diff --git a/test/imagekitio/resources/files/metadata_test.rb b/test/imagekitio/resources/files/metadata_test.rb index ce2626ce..2c48eb29 100644 --- a/test/imagekitio/resources/files/metadata_test.rb +++ b/test/imagekitio/resources/files/metadata_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Files::MetadataTest < Imagekitio::Test::ResourceTest def test_get - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.metadata.get("fileId") @@ -33,7 +33,7 @@ def test_get end def test_get_from_url_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.metadata.get_from_url(url: "https://example.com") diff --git a/test/imagekitio/resources/files/versions_test.rb b/test/imagekitio/resources/files/versions_test.rb index b1d3dc4a..3abf45a6 100644 --- a/test/imagekitio/resources/files/versions_test.rb +++ b/test/imagekitio/resources/files/versions_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Files::VersionsTest < Imagekitio::Test::ResourceTest def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.versions.list("fileId") @@ -14,7 +14,7 @@ def test_list end def test_delete_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.versions.delete("versionId", file_id: "fileId") @@ -30,7 +30,7 @@ def test_delete_required_params end def test_get_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.versions.get("versionId", file_id: "fileId") @@ -73,7 +73,7 @@ def test_get_required_params end def test_restore_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.versions.restore("versionId", file_id: "fileId") diff --git a/test/imagekitio/resources/files_test.rb b/test/imagekitio/resources/files_test.rb index 314183f3..aedd4b46 100644 --- a/test/imagekitio/resources/files_test.rb +++ b/test/imagekitio/resources/files_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::FilesTest < Imagekitio::Test::ResourceTest def test_update - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.update("fileId") @@ -14,7 +14,7 @@ def test_update end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.delete("fileId") @@ -24,7 +24,7 @@ def test_delete end def test_copy_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.copy(destination_path: "/folder/to/copy/into/", source_file_path: "/path/to/file.jpg") @@ -41,7 +41,7 @@ def test_copy_required_params end def test_get - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.get("fileId") @@ -84,7 +84,7 @@ def test_get end def test_move_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.move(destination_path: "/folder/to/move/into/", source_file_path: "/path/to/file.jpg") @@ -101,7 +101,7 @@ def test_move_required_params end def test_rename_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.rename(file_path: "/path/to/file.jpg", new_file_name: "newFileName.jpg") @@ -117,7 +117,7 @@ def test_rename_required_params end def test_upload_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName") diff --git a/test/imagekitio/resources/folders/job_test.rb b/test/imagekitio/resources/folders/job_test.rb index 810a3c21..02f46068 100644 --- a/test/imagekitio/resources/folders/job_test.rb +++ b/test/imagekitio/resources/folders/job_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::Folders::JobTest < Imagekitio::Test::ResourceTest def test_get - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.folders.job.get("jobId") diff --git a/test/imagekitio/resources/folders_test.rb b/test/imagekitio/resources/folders_test.rb index eb4097a4..ec2ee287 100644 --- a/test/imagekitio/resources/folders_test.rb +++ b/test/imagekitio/resources/folders_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::FoldersTest < Imagekitio::Test::ResourceTest def test_create_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.folders.create(folder_name: "summer", parent_folder_path: "/product/images/") @@ -20,7 +20,7 @@ def test_create_required_params end def test_delete_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.folders.delete(folder_path: "/folder/to/delete/") @@ -36,7 +36,7 @@ def test_delete_required_params end def test_copy_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.folders.copy( @@ -56,7 +56,7 @@ def test_copy_required_params end def test_move_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.folders.move( @@ -76,7 +76,7 @@ def test_move_required_params end def test_rename_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.folders.rename(folder_path: "/path/of/folder", new_folder_name: "new-folder-name") diff --git a/test/imagekitio/resources/saved_extensions_test.rb b/test/imagekitio/resources/saved_extensions_test.rb index 9ce1a47f..9102206f 100644 --- a/test/imagekitio/resources/saved_extensions_test.rb +++ b/test/imagekitio/resources/saved_extensions_test.rb @@ -4,7 +4,7 @@ class Imagekitio::Test::Resources::SavedExtensionsTest < Imagekitio::Test::ResourceTest def test_create_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.saved_extensions.create( @@ -30,7 +30,7 @@ def test_create_required_params end def test_update - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.saved_extensions.update("id") @@ -51,7 +51,7 @@ def test_update end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.saved_extensions.list @@ -61,7 +61,7 @@ def test_list end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.saved_extensions.delete("id") @@ -71,7 +71,7 @@ def test_delete end def test_get - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @image_kit.saved_extensions.get("id")